Guides API reference Dashboard Support

Catalog

Subscription plans

Shipping methods

License services

Checkout

After the sale

List subscriptions GET Get subscription options GET Get a subscription GET Update a subscription POST Remove scheduled item additions DELETE Cancel a subscription POST Extend a subscription period POST Fast forward a test subscription POST Get subscription history GET List subscription invoices GET List subscription items GET Add a subscription item POST Preview adding an item POST Get a subscription item GET Update a subscription item POST Cancel a subscription item POST Remove an item's scheduled change DELETE Preview an item change POST Get an item's billing terms GET Undo an item's scheduled cancellation POST List subscription notifications GET Retry a failed renewal payment POST Undo a scheduled cancellation POST

License requests

Customers

Webhooks and email

Notification subscriptions

Files

Money and reports

Currency conversion

Account

Countries and currencies

Events

Subscriptions

Recurring billing for a customer: renew, change items, cancel, extend.

Endpoints

get/subscriptionsList subscriptions get/subscriptions/optionsGet subscription options get/subscriptions/{subscription_id}Get a subscription post/subscriptions/{subscription_id}Update a subscription delete/subscriptions/{subscription_id}/add_at_current_period_endRemove scheduled item additions post/subscriptions/{subscription_id}/cancelCancel a subscription post/subscriptions/{subscription_id}/extendExtend a subscription period post/subscriptions/{subscription_id}/fast_forwardFast forward a test subscription get/subscriptions/{subscription_id}/historyGet subscription history get/subscriptions/{subscription_id}/invoicesList subscription invoices get/subscriptions/{subscription_id}/itemsList subscription items post/subscriptions/{subscription_id}/itemsAdd a subscription item post/subscriptions/{subscription_id}/items/previewPreview adding an item get/subscriptions/{subscription_id}/items/{item_id}Get a subscription item post/subscriptions/{subscription_id}/items/{item_id}Update a subscription item post/subscriptions/{subscription_id}/items/{item_id}/cancelCancel a subscription item delete/subscriptions/{subscription_id}/items/{item_id}/change_at_current_period_endRemove an item's scheduled change post/subscriptions/{subscription_id}/items/{item_id}/previewPreview an item change get/subscriptions/{subscription_id}/items/{item_id}/subscription_termsGet an item's billing terms post/subscriptions/{subscription_id}/items/{item_id}/uncancelUndo an item's scheduled cancellation get/subscriptions/{subscription_id}/notificationsList subscription notifications post/subscriptions/{subscription_id}/retryRetry a failed renewal payment post/subscriptions/{subscription_id}/uncancelUndo a scheduled cancellation

Guides that use it

Subscriptions

Sell a subscription with a plan and a cart, follow renewals with webhooks, change items with proration, cancel, retry failed payments and handle grace periods.

Get a refund's payment method GET

Returns the payment method the money went back to: the card, wallet or bank account of the payment, or the customer's store credit (`customer_account_balance`). Card numbers are masked. A record-only refund has no payment method, so you get an empty object `{}`. A limited token may call this for a refund it is bound to.

List subscriptions GET

Lists the subscriptions in your account, oldest first by `date_type` (default `date_created`). The list is cursor-based: use `next_page_url` or `after_item` to page forward. Secret and trusted tokens may call it. A limited token may not (`403`); a signed-in customer reads their own with `GET /customers/{customer_id}/subscriptions`.