Get Customer Subscriptions

GET /v2/subscription/customers

Retrieves a list of customer subscriptions with comprehensive filtering, sorting, and pagination capabilities. This endpoint returns subscription-level records that group items together, showing the subscription structure, status, pricing, and metadata. Use this for displaying subscription lists, building dashboards, or exporting subscription data at the subscription level rather than individual item details.

Query Parameters

• ~filter[_id] - Parameter for ~filter[_id]
• ~filter[tenant] - Parameter for ~filter[tenant]
• ~filter[start_date] - Parameter for ~filter[start_date]
• ~filter[end_date] - Parameter for ~filter[end_date]
• ~filter[price] - Parameter for ~filter[price]
• ~filter[items.sku] - Parameter for ~filter[items.sku]
• ~filter[agreementPrice] - Parameter for ~filter[agreementPrice]
• ~search - Parameter for ~search
• ~sort - Parameter for ~sort
• ~page - Parameter for ~page
• ~fields - Parameter for ~fields
• ~fields[] - Parameter for ~fields[]
• ~fields[items] - Parameter for ~fields[items]
• ~fields[name] - Parameter for ~fields[name]

Request Example

GET /v2/subscription/customers

Headers

• Accept - Expected response format (Example: application/json, text/csv)

Response Example

{
  "data": [
    {
      "_id": "subscription-id-1",
      "name": "Example Service",
      "description": "{\"blocks\":[{\"key\":\"a1\",\"text\":\"Overview:\",\"type\":\"unstyled\"}],\"entityMap\":{}}",
      "logo": "https://api.example.com/v1/files/product/example-tenant/product-id/logo.png",
      "edition": {
        "name": "Example Edition"
      },
      "term": {
        "duration": 25920,
        "durationMonth": 36
      },
      "billing_cycle": {
        "duration": 8640,
        "durationMonth": 12
      },
      "cancel_term": {
        "grace_period": 8640
      },
      "start_date": "2025-06-27T11:16:40.729Z",
      "creator": {
        "id": "user-id-1",
        "firstname": "Alex",
        "lastname": "Doe",
        "email": "user@example.com",
        "phone": "+4712345678",
        "fullname": "Alex Doe"
      },
      "price": 27500,
      "items": [
        {
          "id": "item-id-1",
          "amount": 1000,
          "prepaidAmount": 1000,
          "sku": "SKU-10002",
          "name": "Example Item Unlimited",
          "description": "Example feature list\nUnlimited storage per user",
          "unit": {
            "cost": 55,
            "price": 55
          },
          "price": {
            "cost": 55000,
            "discount": 27500,
            "total": 27500,
            "subtotal": 27500
          },
          "discount": 50,
          "reference": "product-ref-id-1",
          "date": {
            "start": "2025-06-20T00:00:00.000Z",
            "end": "2028-06-20T00:00:00.000Z"
          },
          "metadata": {
            "amount": {
              "min": 1,
              "max": 9999
            }
          },
          "consumption": {
            "property": "licensed_users",
            "metadata": "backup",
            "history": []
          },
          "subscription_term": 720,
          "payment_period": 8640,
          "integrations": [],
          "input": {
            "type": "numberInput",
            "name": "Number of users?"
          },
          "integration": [],
          "msp": false
        }
      ],
      "status": "active",
      "order": "order-id-1",
      "tenant": "example-tenant-id",
      "parent": {
        "account": {
          "tenant": "parent-tenant-id"
        }
      },
      "account": "account-id-1",
      "created": "2025-06-27T11:16:40.740Z",
      "updated": "2025-10-02T19:01:31.083Z",
      "__v": 0,
      "account_details": {
        "name": "Example Account"
      },
      "agreementPrice": 990000,
      "billingPrice": 330000,
      "end_date": "2028-06-27T11:16:40.729Z"
    },
    {
      "_id": "subscription-id-2",
      "name": "Example Service",
      "description": "{\"blocks\":[{\"key\":\"b1\",\"text\":\"Overview:\",\"type\":\"unstyled\"}],\"entityMap\":{}}",
      "logo": "https://api.example.com/v1/files/product/example-tenant/product-id/logo.png",
      "edition": {
        "name": "Example Edition Lite"
      },
      "term": {
        "duration": 8640,
        "durationMonth": 12
      },
      "billing_cycle": {
        "duration": 8640,
        "durationMonth": 12
      },
      "cancel_term": {
        "grace_period": 8640
      },
      "start_date": "2025-06-20T09:04:11.678Z",
      "creator": {
        "id": "user-id-1",
        "firstname": "Alex",
        "lastname": "Doe",
        "email": "user@example.com",
        "phone": "+4712345678",
        "fullname": "Alex Doe"
      },
      "price": 134.4,
      "items": [
        {
          "id": "item-id-2",
          "amount": 4,
          "prepaidAmount": 4,
          "sku": "SKU-10001",
          "name": "Example Item 80GB",
          "description": "Example feature list\nIncludes 80GB per user",
          "unit": {
            "cost": 42,
            "price": 42
          },
          "price": {
            "cost": 168,
            "discount": 33.6,
            "total": 134.4,
            "subtotal": 134.4
          },
          "discount": 20,
          "reference": "product-ref-id-2",
          "date": {
            "start": "2025-06-20T00:00:00.000Z",
            "end": "2026-06-20T00:00:00.000Z"
          },
          "metadata": {
            "amount": {
              "min": 1,
              "max": 9999
            }
          },
          "consumption": {
            "property": "protected_users",
            "metadata": "backup",
            "history": []
          },
          "subscription_term": 720,
          "payment_period": 8640,
          "integrations": [],
          "input": {
            "type": "numberInput",
            "name": "Number of users?"
          },
          "integration": [],
          "msp": false
        }
      ],
      "status": "active",
      "order": "order-id-2",
      "tenant": "example-tenant-id",
      "parent": {
        "account": {
          "tenant": "parent-tenant-id"
        }
      },
      "account": "account-id-1",
      "created": "2025-06-20T09:04:11.720Z",
      "updated": "2025-10-02T19:01:31.026Z",
      "__v": 0,
      "account_details": {
        "name": "Example Account"
      },
      "agreementPrice": 1612.8,
      "billingPrice": 1612.8,
      "end_date": "2026-06-20T09:04:11.678Z"
    }
  ],
  "metadata": {
    "total": 2,
    "page": 0,
    "perPage": 25,
    "maxPageSize": 1000
  }
}