Subscriptions API
Read the subscriptions and memberships of a contact, cancel, upgrade and renew them, and change the saved payment method.
A subscription is created when a contact buys a subscription product and the order is processed. A membership is a subscription product, so every endpoint on this page applies to memberships too. See Subscriptions and memberships for the full flow.
| Property | Value |
|---|---|
| Base paths | /subscriptions for subscriptions. /products for renewal options. |
| Authentication | x-api-key header and a bearer token. Every endpoint acts on the subscriptions of the contact in the token. |
| OpenAPI documents | subscriptions.yaml, renewal-options.yaml |
This API does not create subscriptions and does not take payment. To buy, upgrade or renew a subscription, add the product to a basket with the Baskets API and check out.
The path of the list endpoint is /subscriptions/subscriptions. The first segment is the base path of the API and the second is the resource.
Endpoints
GET
/subscriptions/subscriptionsList subscriptionsPOST/subscriptions/subscription/{subscriptionId}/cancelCancel a subscriptionPOST/subscriptions/subscription/{subscriptionId}/withdrawcancelWithdraw a cancellationGET/subscriptions/subscription/{subscriptionId}/upgradeGet upgrade targetsGET/subscriptions/subscriptions/upgradeGet upgrade targets of the contactPOST/subscriptions/subscription/{subscriptionId}/update-payment-methodUpdate the payment methodPOST/subscriptions/subscriptions/update-payment-methodUpdate the payment method of several subscriptionsGET/products/renewal-optionsGet renewal options