Subscriptions API

The Subscriptions API provides an easy way to schedule recurring payments at regular intervals. When using this API, we automatically create recurring payments for you at the interval you specified.

The Subscriptions API is not required to implement recurring payments. You can just as easily charge the recurring payments yourself on the customer using the Payments API.

For a step-by-step guide on charging your customers recurrently, please refer to Recurring payments.

Endpoints

Create subscription

POST/v2/customers/*customerId*/subscriptions

Create a subscription for a specific customer.

Get subscription

GET/v2/customers/*customerId*/subscriptions/*id*

Retrieve details of a specific subscription.

Update subscription

PATCH/v2/customers/*customerId*/subscriptions/*id*

Update a specific subscription.

Cancel subscription

DELETE/v2/customers/*customerId*/subscriptions/*id*

Cancel a specific subscription.

List subscriptions

GET/v2/customers/*customerId*/subscriptions

Retrieve a list of all subscriptions created for a specific customer.

List all subscriptions

GET/v2/subscriptions

Retrieve a list of all subscriptions.

List subscriptions payments

GET/v2/customers/*customerId*/subscriptions/*id*/payments

Retrieve a list of all payments created for a specific subscription.