Endpoints
Server URLs
Use the base URL for your environment as the URL prefix.
| Environment | Base URL |
|---|---|
| Production | api. |
| Test | apitest. |
Plans
These endpoints support plan management in the Recurring Billing service:
| Method | Path | Description | Details | |
|---|---|---|---|---|
POST | /rbs/v1/plans | Create a plan | Create a Plan | |
POST | /rbs/v1/plans/{id}/activate | Activate a plan | Activate a Plan | |
POST | /rbs/v1/plans/{id}/deactivate | Deactivate a plan | Deactivate a Plan | |
DELETE | /rbs/v1/plans/{id} | Delete a plan | Delete a Plan | |
PATCH | /rbs/v1/plans/{id} | Amend a plan | Amend a Plan | |
GET | /rbs/v1/plans/{id} | Retrieve a plan | Retrieve a Plan | |
GET | /rbs/v1/plans/code | Retrieve the next plan code | Retrieve a Plan Code | |
GET | /rbs/v1/plans | Retrieve a list of plans | Retrieve a List of Plans |
Subscriptions
These endpoints support subscription management in the Recurring Billing service:
| Method | Path | Description | Details | |
|---|---|---|---|---|
POST | /rbs/v1/subscriptions | Create a subscription | Create a Subscription with an Existing Plan | |
POST | /rbs/v1/subscriptions | Create a subscription | Create a Subscription with Plan Overrides | |
POST | /rbs/v1/subscriptions | Create a subscription | Create a Fully Customized Subscription | |
POST | /rbs/v1/subscriptions/follow-ons/{requestId} | Create a follow-on subscription | Create a Follow-on Subscription | |
PATCH | /rbs/v1/subscriptions/{id} | Amend a subscription | Amend a Subscription | |
POST | /rbs/v1/subscriptions/{id}/cancel | Cancel a subscription | Cancel a Subscription | |
POST | /rbs/v1/subscriptions/{id}/activate | Reactivate a subscription | Reactivate a Subscription | |
POST | /rbs/v1/subscriptions/{id}/suspend | Suspend a subscription | Suspend a Subscription | |
POST | /rbs/v1/subscriptions/{id}/payments | Skip or restore a payment | Skip or Restore a Payment | |
GET | /rbs/v1/subscriptions/{id} | Retrieve a subscription | Retrieve a Subscription | |
GET | /rbs/v1/subscriptions | Retrieve a list of subscriptions | Retrieve a List of Subscriptions | |
GET | /rbs/v1/subscriptions/{id}/payments | Retrieve a list of payments in a subscription | Retrieve a List of Payments in a Subscription | |
GET | /rbs/v1/subscriptions/follow-ons/{requestId} | Retrieve details for follow-on subscription creation | Retrieve Details for Follow-on Subscription Creation | |
GET | /rbs/v1/subscriptions/code | Retrieve the next subscription code | Retrieve the Next Subscription Code |
Was this page helpful?
Thanks for your feedback!
Last published: October 28, 2026