Get Subscription

Returns one of your subscriptions with its status and next charge date.

A subscription starts in CREATING while the buyer's first checkout is processed, then becomes ACTIVE, or TRIAL
when the plan has a trial. If that first checkout fails or expires it becomes FAILED. While ACTIVE, Payment Labs
charges the buyer on nextPaymentDate; when every attempt for a billing cycle fails it becomes OVERDUE.
CANCELLED is final.

Permission: Merchant Read.

Errors

  • 404 NOT_FOUND: the subscription does not exist.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The subscription ID (R-…).

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json