Get Subscriptions

GET /v1/order/subscription

Retrieves a list of subscriptions with optional filtering, pagination, and population of related data. This endpoint returns subscription records that include terms, billing cycles, pricing details, items, account information, and creator metadata. Use the tenant filter to scope results to a specific customer, and populate parameters to expand related objects for a complete view of each subscription.

Query Parameters

• filter[tenant] - Parameter for filter[tenant]
• ~limit - Parameter for ~limit
• ~offset - Parameter for ~offset
• ~populate[] - Parameter for ~populate[]

Request Example

GET /v1/order/subscription

Response Example 1

{
  "data": [
    {
      "edition": {
        "name": "Example Edition"
      },
      "term": {
        "duration": 25920,
        "durationMonth": 36
      },
      "billing_cycle": {
        "duration": 8640,
        "durationMonth": 12
      },
      "cancel_term": {
        "grace_period": 8640,
        "start_canceling_at": "2025-10-29T09:49:58.809Z"
      },
      "account_details": {
        "name": "Example Account"
      },
      "parent": {
        "account": {
          "tenant": "tenant-id-parent-1"
        }
      },
      "_id": "subscription-id-1",
      "id": "subscription-id-1",
      "name": "Example Backup",
      "description": "{\"blocks\":[{\"key\":\"x1\",\"text\":\"Overview:\",\"type\":\"unstyled\"}],\"entityMap\":{}}",
      "logo": "https://api.example.com/v1/files/product/demo/logo.png",
      "start_date": "2025-06-27T11:16:40.729Z",
      "creator": {
        "id": "user-id-1",
        "firstname": "Example",
        "lastname": "User",
        "email": "user@example.com",
        "phone": "4700000000",
        "fullname": "Example User"
      },
      "price": 27500,
      "items": [
        {
          "unit": { "cost": 55, "price": 55 },
          "price": { "cost": 55000, "discount": 27500, "total": 27500, "subtotal": 27500 },
          "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": [] },
          "input": { "type": "numberInput", "name": "Number of users?" },
          "id": "item-id-1",
          "amount": 1000,
          "prepaidAmount": 1000,
          "sku": "sku-10002",
          "name": "Example Service Unlimited",
          "description": "Mail, OneDrive, SharePoint, Teams. Unlimited storage per user.",
          "discount": 50,
          "reference": "reference-id-1",
          "subscription_term": 720,
          "payment_period": 8640,
          "integrations": [],
          "integration": [],
          "msp": false
        }
      ],
      "status": "in_cancellation",
      "order": "order-id-1",
      "tenant": "tenant-id-1",
      "account": "account-id-1",
      "created": "2025-06-27T11:16:40.740Z",
      "updated": "2025-10-29T09:49:58.810Z",
      "agreementPrice": 990000,
      "billingPrice": 330000,
      "end_date": "2028-06-27T11:16:40.729Z"
    },
    {
      "edition": {
        "name": "Example Edition 80GB"
      },
      "term": {
        "duration": 8640,
        "durationMonth": 12
      },
      "billing_cycle": {
        "duration": 8640,
        "durationMonth": 12
      },
      "cancel_term": {
        "grace_period": 8640,
        "start_canceling_at": "2025-10-29T09:49:58.806Z"
      },
      "account_details": {
        "name": "Example Account"
      },
      "parent": {
        "account": {
          "tenant": "tenant-id-parent-2"
        }
      },
      "_id": "subscription-id-2",
      "id": "subscription-id-2",
      "name": "Example Backup",
      "description": "{\"blocks\":[{\"key\":\"x2\",\"text\":\"Key Features:\",\"type\":\"unstyled\"}],\"entityMap\":{}}",
      "logo": "https://api.example.com/v1/files/product/demo/logo.png",
      "start_date": "2025-06-20T09:04:11.678Z",
      "creator": {
        "id": "user-id-1",
        "firstname": "Example",
        "lastname": "User",
        "email": "user@example.com",
        "phone": "4700000000",
        "fullname": "Example User"
      },
      "price": 134.4,
      "items": [
        {
          "unit": { "cost": 42, "price": 42 },
          "price": { "cost": 168, "discount": 33.6, "total": 134.4, "subtotal": 134.4 },
          "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": [] },
          "input": { "type": "numberInput", "name": "Number of users?" },
          "id": "item-id-2",
          "amount": 4,
          "prepaidAmount": 4,
          "sku": "sku-10001",
          "name": "Example Service 80GB",
          "description": "Mail, OneDrive, SharePoint, Teams. 80GB per user.",
          "discount": 20,
          "reference": "reference-id-2",
          "subscription_term": 720,
          "payment_period": 8640,
          "integrations": [],
          "integration": [],
          "msp": false
        }
      ],
      "status": "in_cancellation",
      "order": "order-id-2",
      "tenant": "tenant-id-1",
      "account": "account-id-1",
      "created": "2025-06-20T09:04:11.720Z",
      "updated": "2025-10-29T09:49:58.806Z",
      "agreementPrice": 1612.8,
      "billingPrice": 1612.8,
      "end_date": "2026-06-20T09:04:11.678Z"
    }
  ],
  "pagination": {
    "total": 4,
    "skip": 0,
    "limit": 200
  }
}

Request Example

GET /v1/order/subscription?filter[tenant]=685498954146b339e63e71b1&~limit=1

Response Example 2

{
  "data": [
    {
      "term": {
        "duration": 8640,
        "durationMonth": 12
      },
      "billing_cycle": {
        "duration": 8640,
        "durationMonth": 12
      },
      "cancel_term": {
        "grace_period": 8640
      },
      "account_details": {
        "name": "Example Account"
      },
      "parent": {
        "account": {
          "tenant": "tenant-id-1"
        }
      },
      "_id": "subscription-id-1",
      "name": "Example Platform - EUR",
      "description": "{\"blocks\":[{\"key\":\"1a2b3c\",\"text\":\"Example Platform: Empowering IT Operations\",\"type\":\"unstyled\"}]}",
      "logo": "https://api.example.io/v1/files/product/example/logo.png",
      "start_date": "2025-06-19T23:10:33.811Z",
      "creator": {
        "id": "user-id-1",
        "firstname": "Example",
        "lastname": "User",
        "email": "user@example.com",
        "phone": "4700000000",
        "fullname": "Example User"
      },
      "price": 2500,
      "items": [
        {
          "unit": {
            "cost": 250,
            "price": 2500
          },
          "price": {
            "cost": 250,
            "discount": 0,
            "total": 2500,
            "subtotal": 2500
          },
          "date": {
            "start": "2025-06-19T00:00:00.000Z",
            "end": "2026-06-19T00:00:00.000Z"
          },
          "metadata": {
            "amount": {
              "min": 1,
              "max": 1
            }
          },
          "consumption": {
            "history": []
          },
          "id": "item-id-1",
          "amount": 1,
          "prepaidAmount": 1,
          "sku": "SKU-EXAMPLE-1",
          "name": "Example Platform - Core - EUR",
          "description": "The core features of the Example Platform provide tools to automate and manage business processes such as customer management, order processing, and billing.",
          "discount": 0,
          "subscription_term": 720,
          "payment_period": 720,
          "integrations": [],
          "integration": [],
          "msp": true
        }
      ],
      "status": "active",
      "order": "order-id-1",
      "tenant": "tenant-id-1",
      "account": "account-id-1",
      "created": "2025-06-19T23:10:33.821Z",
      "updated": "2025-10-02T19:01:30.917Z",
      "agreementPrice": 30000,
      "billingPrice": 30000,
      "end_date": "2026-06-19T23:10:33.811Z",
      "id": "subscription-id-1"
    }
  ],
  "pagination": {
    "total": 1,
    "skip": 0,
    "limit": 1
  }
}