API Reference Overview
Subscriptions v1
plans
7 endpointsGETPOSTGETPATCHPOSTPOSTPOST
List plans
/v1/billing/plansLists billing plans.
Create plan
/v1/billing/plansCreates a plan that defines pricing and billing cycle details for subscriptions.
Show plan details
/v1/billing/plans/{id}Shows details for a plan, by ID.
Update plan
/v1/billing/plans/{id}Updates a plan with the `CREATED` or `ACTIVE` status.
Activate plan
/v1/billing/plans/{id}/activateActivates a plan, by ID.
Deactivate plan
/v1/billing/plans/{id}/deactivateDeactivates a plan, by ID.
Update pricing
/v1/billing/plans/{id}/update-pricing-schemesUpdates pricing for a plan.
subscriptions
10 endpointsGETPOSTGETPATCHPOSTPOSTPOSTPOSTPOSTGET
List subscriptions
/v1/billing/subscriptionsList all subscriptions for merchant account.
Create subscription
/v1/billing/subscriptionsCreates a subscription.
Show subscription details
/v1/billing/subscriptions/{id}Shows details for a subscription, by ID.
Update subscription
/v1/billing/subscriptions/{id}Updates a subscription which could be in ACTIVE or SUSPENDED status.
Revise plan or quantity of subscription
/v1/billing/subscriptions/{id}/reviseUpdates the quantity of the product or service in a subscription.
Suspend subscription
/v1/billing/subscriptions/{id}/suspendSuspends the subscription.
Cancel subscription
/v1/billing/subscriptions/{id}/cancelCancels the subscription.
Activate subscription
/v1/billing/subscriptions/{id}/activateActivates the subscription.
Capture authorized payment on subscription
/v1/billing/subscriptions/{id}/captureCaptures an authorized payment from the subscriber on the subscription.
List transactions for subscription
/v1/billing/subscriptions/{id}/transactionsLists transactions for a subscription.