# List subscriptions

Operation ID: `subscriptions`

Group: Accounting › Subscriptions

[Open in the interactive reference](https://docs.api.lensing.ai/lensing/v1/endpoints/subscriptions)

`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

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Api-Version` | header | string · v1 | yes | The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`. |

## 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:

| Field | Type | Required | Filter | Sort | Description |
| --- | --- | --- | --- | --- | --- |
| `id` | string | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`), Pattern (`like`) | yes | The unique identifier for the subscription. |
| `subscriptionNumber` | string \| null | no | no | no | The subscription number. Unique within the tenant. Example: 'SUB-1'. |
| `customerName` | string \| null | no | no | no | The name of the customer this subscription belongs to. See name on GET accounting/customers/:id. |
| `currency` | string | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`), Pattern (`like`) | yes | The currency of annualRecurringRevenue and monthlyRecurringRevenue. Format ISO 4217, for example 'USD'. |
| `autoRenew` | boolean \| null | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`) | yes | Whether the subscription renews automatically at the end of its term. |
| `renewalTerm` | number \| null | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`) | yes | The length of the auto-renewal term, in the subscription's term unit. |
| `renewalPriceChangePercentage` | decimal \| null | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`) | yes | The percentage by which the price changes on renewal. |
| `termType` | string | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`), Pattern (`like`) | yes | The term type of the subscription. Possible values: 'termed', 'evergreen'. |
| `subscriptionStatus` | string \| null | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`), Pattern (`like`) | yes | The status of the subscription, derived from the status of its lines. Possible values: 'pendingActivation', 'notStarted', 'active', 'pendingOrderApproval', 'canceled', 'suspended'. |
| `serviceStartDateBasis` | string \| null | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`), Pattern (`like`) | yes | How the service start date is determined. Possible values: 'fixedDate', 'serviceActivation'. |
| `serviceActivationDate` | date \| null | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`) | yes | The date service was activated. Set only when serviceStartDateBasis is 'serviceActivation'. Format YYYY-MM-DD. |
| `serviceStartDate` | date \| null | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`) | yes | The earliest service start date across the subscription's lines. Format YYYY-MM-DD. |
| `serviceEndDate` | date \| null | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`) | yes | The latest service end date across all of the subscription's lines. Format YYYY-MM-DD. Usually absent when the subscription is evergreen, but present once it is canceled or suspended. |
| `submissionDate` | date \| null | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`) | yes | The submission date of the sales order this subscription came from. Format YYYY-MM-DD. |
| `cancellationDate` | date \| null | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`) | yes | The date from which the subscription is or will be canceled. Absent when no cancellation has been recorded. Format YYYY-MM-DD. |
| `cancellationReason` | string \| null | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`), Pattern (`like`) | yes | The reason code for the cancellation. Possible values: 'noReasonGiven', 'budgetary', 'movingToCompetitors', 'lowCustomerSatisfaction', 'bankruptcy', 'acquisitionMerger'. Absent when the subscription has not been canceled. |
| `isCancellationEnabled` | boolean \| null | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`) | yes | Whether the cancellation procedure has been applied to this subscription. |
| `suspensionDate` | date \| null | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`) | yes | The date from which the subscription is or will be suspended. Absent when no suspension has been recorded. Format YYYY-MM-DD. |
| `suspensionReason` | string \| null | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`), Pattern (`like`) | yes | The reason code for the suspension. Possible values: 'unpaidBalance', 'invalidPaymentMethod'. Absent when the subscription has not been suspended. |
| `isSuspensionEnabled` | boolean \| null | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`) | yes | Whether the suspension process is enabled for this subscription. |
| `externalSubscriptionId` | string \| null | no | no | no | The subscription's identifier in an external system. Absent when none was recorded at creation. |
| `annualRecurringRevenue` | decimal \| null | no | no | yes | The annual recurring revenue, in the subscription's currency: the sum of annualRecurringRevenue across its active and suspended lines. |
| `monthlyRecurringRevenue` | decimal \| null | no | no | yes | The monthly recurring revenue, in the subscription's currency: the sum of monthlyRecurringRevenue across its active and suspended lines. |
| `totalUserCount` | decimal \| null | no | no | yes | The number of active users or seats across the subscription's active lines. |
| `prepaidBalance` | decimal \| null | no | no | yes | The prepaid balance remaining for this subscription, summed across the prepaid balances linked to it. The balance is a quantity, not a currency amount. |
| `lastModifiedDate` | date-time | no | Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`) | yes | The date and time the subscription last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |

```json
{
  "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