Subscription Module APIs
The Subscription APIs provide you with tools to manage your Subscription plans and the linked Subscriptions, which you could use as required by your flows.
You would find in the next sections, detailed specifications and examples for each API, as well as further information covering the status workflow and the error handling.
Hierarchical overview of the endpoints
subscriptions{subscriptionId}: Specific subscription resource.billing-cycles: Billing cycles associated with the subscription.{billingCycleId}: Specific billing cycle within the subscription.transactions: Transactions associated with the billing cycle.{transactionId}: Specific transaction within the billing cycle.
manual-retries: Manual retries in the billing cycle.{retryId}: Specific retry within the billing cycle.
plans{SubscriptionPlanId}: Specific subscription plan within the plans.{createdAtLte&createdAtGte&page&pageSize}: Specific time and date, page and page size within the plans.
API Methods
| Method | Description |
|---|---|
GET {BaseUrl}/subscriptions | Get all subscriptions |
GET {BaseUrl}/subscriptions/{subscriptionId} | Get a specific subscription |
GET {BaseUrl}/plans/{subscriptionPlanId} | Get a specific subscription plan |
GET {BaseUrl}/plans/{createdAtLte&createdAtGte&page&pageSize} | Get all subscription plans |
GET {BaseUrl}/subscriptions/{subscriptionId}/billing-cycles | Get all billing cycles for a subscription |
GET {BaseUrl}/subscriptions/{subscriptionId}/billing-cycles/{billingCycleId}/ | Get a billing cycle |
GET {BaseUrl}/subscriptions/{subscriptionId}/billing-cycles/{billingCycleId}/transactions | Get transactions for a billing cycle |
GET {BaseUrl}/subscriptions/{subscriptionId}/billing-cycles/{billingCycleId}/transactions/{transactionId} | Get a specific transaction from a billing cycle |
GET {BaseUrl}/subscriptions/{subscriptionId}/billing-cycles/{billingCycleId}/manual-retries/{retryId} | Check a specific retry within the billing cycle |
POST {BaseUrl}/subscriptions | Create a new subscription |
POST {BaseUrl}/plans | Create a new subscription plan |
POST {BaseUrl}/subscriptions/{subscriptionId}/billing-cycles/{billingCycleId}/manual-retries | Retry a specific billing cycle |
PATCH {BaseUrl}/subscriptions/{SubscriptionId} | Update an existing subscription |
PATCH {BaseUrl}/plans/{SubscriptionPlanId} | Update an existing subscription plan |
DELETE {BaseUrl}/subscriptions/{subscriptionId} | Delete a subscription |
DELETE {BaseUrl}/plans/{subscriptionPlanId} | Delete a subscription plan |