---
title: "Returns a list of Subscriptions"
method: GET
path: "/subscriptions"
tags: ["Subscriptions"]
---

# Returns a list of Subscriptions

`GET /subscriptions`

Gets the Subscriptions specified in the request.

## Query parameters

- `planId` string
- `state` string
- `customerId` string
- `endingBefore` string
- `startingAfter` string
- `limit` integer

## Response `200`

200 OK

- object
  - `hasMore` boolean — Indicates whether or not there are more elements available after this set. If false this set represents the end of the list.
  - `data` Subscription[]
    - `contractBindingUntil` string, date-time — Represents the date and time when the subscription's contract expires.
    - `createdTime` string, date-time — The time when the Subscription was created
    - `updatedTime` string, date-time — The time when the Subscription was last updated.
    - `stateTransitions` SubscriptionStateTransitions
      - `activated` string, date-time, nullable
      - `activatedFree` string, date-time, nullable
      - `failed` string, date-time, nullable
      - `cancelled` string, date-time, nullable
      - `ended` string, date-time, nullable
      - `lapsed` string, date-time, nullable
    - `liveMode` boolean — Has the value true if the object exists in live mode or the value false if the object exists in test mode.
    - `id` string — The unique identifier of the Subscription.
    - `billingAgreementId` string — The billing agreement identifier that is obtained from the subscription's acquisition order.
    - `customerId` string, nullable — The Customer identifier that is obtained from the subscription's acquisition order.
    - `sourceId` string — The unique identifier of the subscription's reusable payment source.
    - `taxInclusive` boolean — If true indicates that the prices supplied are tax inclusive.
    - `currency` string, required — Three-letter ISO currency code (e.g. "USD" or "EUR").
    - `planId` string, required — The Plan identifier.
    - `applicationId` string, nullable — The identifier of the client application that created the subscription.
    - `locale` string, nullable — A locale designator that combines a two-letter ISO 639-1 language code with a ISO 3166-1 alpha-2 country code.
    - `state` 'draft' | 'activePendingInvoice' | 'active' | 'activeFree' | 'failed' | 'cancelled' | 'ended' | 'lapsed' — The state of the subscription
    - `items` SubscriptionItems[]
      - `aggregatePrice` number, double, nullable — Gets or sets the aggregate price
      - `price` number, double, nullable — Gets or sets the price
      - `metadata` Metadata — Key-value pairs used to store additional data. Value can be string, boolean or integer types.
      - `skuId` string, nullable — The identifier of the SKU.
      - `productDetails` ProductDetails
        - `id` string — The identifier of the product in the upstream system.
        - `skuGroupId` string — The identifier of the SKU group.
        - `name` string — The name of the product.
        - `description` string — The description of the product.
        - `itemBreadcrumb` string — The full path to the category where item is included. Categories should be separated by “ > “.
        - `url` string — The product url.
        - `countryOfOrigin` string — The country of origin of the product.
        - `image` string — The image of the product.
        - `weight` number, double — The weight of the product measured in the unit specified by weightUnit.
        - `weightUnit` 'oz' | 'lb' | 'g' | 'kg' — The unit of measurement applied to the weight.
        - `partNumber` string — The manufacturer's part number.
        - `partnerAccountId` string — The unique, Digital River identifier (account Id) of the partner associated with the sku.
      - `quantity` integer, nullable — Gets or sets the quantity
    - `currentPeriodStartDate` string, date-time — Represents the date and time when the subscription's current billing period began.
    - `currentPeriodEndDate` string, date-time — Represents the date and time when the subscription's current billing period ends.
    - `nextInvoiceDate` string, date-time — Represents the date and time when Digital River next opens an invoice and starts the billing process.
    - `nextReminderDate` string, date-time — Date when the next reminder event will be sent.
    - `metadata` Metadata — Key-value pairs used to store additional data. Value can be string, boolean or integer types.

## Other responses

- `400` — 400 Bad Request
- `401` — 401 Unauthorized
- `403` — 403 Forbidden
- `405` — 405 Method Not Allowed
- `406` — 406 Not Acceptable
- `408` — 408 Request Timeout
- `429` — 429 Too Many Requests
- `500` — 500 Internal Server Error
- `502` — 502 Bad Gateway Error
- `503` — 503 Service Unavailable Error
- `504` — 504 Gateway Timeout Error

---

[API](https://skmtc.net/digitalriver/apis/digital-river-api-reference.md) · [All operations](https://skmtc.net/digitalriver/apis/digital-river-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/digitalriver/digital-river-api-reference/revisions/f21981db32be/schema)