List subscriptions

Operation ID: subscriptions

Group: Accounting › Subscriptions

Open in the interactive reference

GET /accounting/subscriptions

Read-only: Reads and returns; changes nothing.

Lists subscriptions. Each subscription in the list has no customerId, entityId, or lines. For the full record, including the customer and legal entity, use GET accounting/subscriptions/:id or POST accounting/subscriptions/search.

Parameters

Query surface

• id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• currency — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• autoRenew — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• renewalTerm — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• renewalPriceChangePercentage — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• termType — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• subscriptionStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• serviceStartDateBasis — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• serviceActivationDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• serviceStartDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• serviceEndDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• submissionDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• cancellationDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• cancellationReason — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• isCancellationEnabled — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• suspensionDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• suspensionReason — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• isSuspensionEnabled — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• Orderable: id, currency, autoRenew, renewalTerm, renewalPriceChangePercentage, termType, subscriptionStatus, serviceStartDateBasis, serviceActivationDate, serviceStartDate, serviceEndDate, submissionDate, cancellationDate, cancellationReason, isCancellationEnabled, suspensionDate, suspensionReason, isSuspensionEnabled, annualRecurringRevenue, monthlyRecurringRevenue, totalUserCount, prepaidBalance, lastModifiedDate
• Selectable: id, subscriptionNumber, customerName, currency, autoRenew, renewalTerm, renewalPriceChangePercentage, termType, subscriptionStatus, serviceStartDateBasis, serviceActivationDate, serviceStartDate, serviceEndDate, submissionDate, cancellationDate, cancellationReason, isCancellationEnabled, suspensionDate, suspensionReason, isSuspensionEnabled, externalSubscriptionId, annualRecurringRevenue, monthlyRecurringRevenue, totalUserCount, prepaidBalance, lastModifiedDate
• page[size] — Page size
• page[cursor] — Opaque continuation cursor

Response

200 Success

Under data, an array of subscriptionsRow:

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "subscriptionNumber": "<subscriptionNumber>",
      "customerName": "<customerName>",
      "currency": "<currency>",
      "autoRenew": true,
      "renewalTerm": 0,
      "renewalPriceChangePercentage": "19.99",
      "termType": "<termType>",
      "subscriptionStatus": "<subscriptionStatus>",
      "serviceStartDateBasis": "<serviceStartDateBasis>",
      "serviceActivationDate": "2026-01-15",
      "serviceStartDate": "2026-01-15",
      "serviceEndDate": "2026-01-15",
      "submissionDate": "2026-01-15",
      "cancellationDate": "2026-01-15",
      "cancellationReason": "<cancellationReason>",
      "isCancellationEnabled": true,
      "suspensionDate": "2026-01-15",
      "suspensionReason": "<suspensionReason>",
      "isSuspensionEnabled": true,
      "externalSubscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "annualRecurringRevenue": "19.99",
      "monthlyRecurringRevenue": "19.99",
      "totalUserCount": "19.99",
      "prepaidBalance": "19.99",
      "lastModifiedDate": "2026-01-15T09:30:00.000Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "<nextCursor>"
  }
}

Statuses

• 400 — Invalid request or business failure
• 401 — The request carries no valid access token.
• 403 — Not authorized
• 404 — Not found
• 429 — Too many requests from this client address. The response has no body and no Retry-After header.
• 500 — Internal server error