Sign in

v1

latestOpenAPI 3.1.02026-07-24104338.0 KB
Subscriptions

List your subscriptions

Returns your subscriptions, newest first. Use the filters to narrow by status, customerProfileId, or createdAt window.

get/api/v3/subscriptions

Query parameters

statusSubscriptionStatus[]

Repeatable. Limits the result to subscriptions in any of the given statuses.

customerProfileIdstring

Look up a subscription by the customerProfileId you supplied when creating it.

createdFrominteger

Inclusive lower bound on createdAt, Unix epoch seconds.

createdTointeger

Exclusive upper bound on createdAt, Unix epoch seconds.

pageSizeinteger

Maximum items per page. Defaults to 20, capped at 100.

cursorstring

Response

Subscriptions matching the filter.

nextCursorstring

Opaque cursor for the next page. Present only when hasMore is true.

hasMoreboolean required

Example response

{
  "items": [
    {
      "amount": {
        "amount": "29.00",
        "asset": "USD"
      },
      "startDate": 1748513400,
      "currentPeriod": {
        "start": 1748513400,
        "end": 1748513400
      },
      "nextPaymentDate": 1748513400,
      "endsAt": 1748513400,
      "cancellation": {
        "at": 1748513400
      },
      "expiration": {
        "at": 1748513400
      },
      "createdAt": 1748513400,
      "updatedAt": 1748513400
    }
  ]
}