Retrieve a subscription cycle
Retrieve a specific billing cycle for a subscription by its unique identifier.
Use this endpoint to get the details and current state of a particular billing cycle.
Request
The ID of the subscription.
The ID of the subscription cycle.
Example: "Bearer sk_1234567890ABCdefGHIjklMNOpqrSTUvwxYZ_1234567890-Ab_cdeFGHijkLMNopq"
This parameter accepts the Merchant API Secret key to authorise requests coming from the merchant's backend.
It ensures that ensures that each request is authenticated and authorised by verifying the secret key. The secret key should be included in all request headers as a Bearer token.
For more information, see: Authentication
Possible values: [2023-09-01, 2024-05-01, 2024-09-01, 2025-10-16]
Example: "2025-10-16"
The version of the Merchant API, specified in YYYY-MM-DD format.
If not specified, you will receive an error.
For more information about API versioning, see: API versions.
Response
Subscription cycle retrieved successfully
Unique identifier for the subscription cycle.
Unique identifier for the subscription.
Unique identifier for the subscription plan variation.
Unique identifier for the subscription plan phase.
Possible values: >= 1
The sequential cycle number within the subscription.
Starts at 1 for the first cycle and increments with each new billing cycle.
The unique identifier of the previous billing cycle.
This field is null for the first cycle in a subscription.
Possible values: [pending, active, finished]
The state of the subscription cycle.
| State | Description |
|---|---|
pending | The cycle has been created but has not yet started. |
active | The cycle is currently active and in progress. |
finished | The cycle has completed. |
The date and time the subscription cycle starts in ISO 8601 format.
The date and time the subscription cycle ends in ISO 8601 format.
Permanent order ID used to retrieve, capture, cancel, or refund an order after authorization.