OneBasket

List subscriptions

GET
/subscriptions/subscriptions

Returns every subscription of the contact in the bearer token. A membership is a subscription, so memberships are in this list too.

The list includes subscriptions that have ended. Read status to find the ones that are in use.

The name of each subscription is translated. Send an Accept-Language header to choose the language.

Authorization

BearerAuth ApiKeyAuth
AuthorizationBearer <token>

In: header

x-api-key<token>

In: header

Header Parameters

Accept-Language?string

The language of translated text in the response, for example en-GB. The store default is used when the header is missing or the language is not supported.

Response Body

application/json

application/problem+json

curl -X GET "https://example.com/subscriptions/subscriptions"
[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "key": "string",    "name": "string",    "status": "Trial",    "state": {      "type": "active",      "nextBillingDate": "2019-08-24T14:15:22Z"    },    "source": "string",    "createdAt": "2019-08-24T14:15:22Z",    "billingSchedule": {      "type": "recurring",      "isUserCancellable": true,      "isAdminCancellable": true,      "period": "1M",      "renewalDate": "2019-08-24T14:15:22Z"    },    "price": {      "minorUnits": 499,      "currencyCode": "GBP"    },    "isExternallyManaged": true,    "paymentMethodId": "string",    "assigneeContactId": "string",    "canManage": true  }]