Retrieve a subscription
Returns the full details of a specific subscription, including its line items, billing schedule, and current status.
Headers
string The Bearer token for authentication.
string The user agent of the request. Must contain at least two identifiers separated by a space.
string The content type of the request.
Parameters
string The ID of the subscription to retrieve.
Response Body
application/jsonboolean Indicates that the request was successful.
object The subscription details.
string The ID of the subscription.
object The customer details.
string The ID of the customer.
string The name of the customer.
string The email of the customer.
object Customer billing details.
string Address line 1.
string Address line 2.
string City.
string State.
string Zip code.
string Country code in ISO 3166-1 alpha-2 format.
object Customer shipping details schema.
string Full name of the customer.
string Phone number of the customer. (e.g. +597-8123456)
string Address line 1.
string Address line 2.
string City.
string State.
string Zip code.
string Country code in ISO 3166-1 alpha-2 format.
object The payment method details.
string The ID of the payment method.
string The type of the payment method.
creditswalletstring The payment method provider name.
string Status of the subscription.
pendingexpiredtrialactivesuspendedcancelledstring The currency of the subscription.
boolean Whether the subscription should auto-renew.
number The billing interval in days.
date-time The start date of the billing period.
date-time The end date of the billing period.
date-time The date and time the subscription was last renewed.
date-time The date and time the subscription will be renewed next.
date-time The date and time the subscription was cancelled.
date-time The date and time the subscription was created.
array The line items of the subscription.
string The ID of the subscription item.
string The title of the subscription item.
number The quantity of the subscription item.
object The option the subscription item is associated with.
string The ID of the option.
string The ID of the plan the option belongs to.
boolean Whether the option is available.
float The unit price of the option.
date-time The date and time the subscription item was created.