v1

latestOpenAPI 3.0.02026-07-26355499.1 KB

Subscriptions

Get subscription details

This endpoint retrieves the details of a specific subscription by ID.

get/v3/subscriptions/{subscription_id}

Path parameters

subscription_idinteger required

Unique numeric identifier of the subscription to retrieve.

Headers

Content-Typestring required

Media type of the body sent to the API.

X-Datestring date-time required

ISO8601 Datetime with Timezone (yyyy-MM-dd'T'HH:mm:ssZ)

X-Loginstring required

Merchant X-Login API Key.

Authorizationstring required

Authorization control hash.

X-Idempotency-Keystring

Unique idempotency key for ensuring that the same request is not processed more than once.

Response

Subscription details retrieved successfully

idinteger required

Unique identifier of the subscription.

status'PENDING' | 'ACTIVE' | 'COMPLETED' | 'CANCELLED' | 'TERMINATED' required

Current status of the subscription.

start_datestring date required

Date when the subscription started or will start.

end_datestring date

Date when the subscription ended or will end.

last_renovation_datestring date

Date of the last renovation.

creation_datestring date-time required

Timestamp when the subscription was created.

subscription_plan'DAILY' | 'WEEKLY' | 'MONTHLY' | 'ANNUALLY' required

Frequency plan of the subscription.

plan_unitinteger required

The number of units for the subscription plan.

amountnumber double required

Amount charged for the subscription.

auto_renewalboolean required

Whether the subscription will automatically renew.

last_modified_datestring date-time

Timestamp when the subscription was last modified.

renewalsinteger required

The number of times the subscription has been renewed.

cancellation_datestring date nullable

The date the subscription was cancelled.

currencystring required

The currency of the subscription amount.

last_charge_datestring date

The date of the last charge attempt.

payment_methodstring

The payment method used for the subscription.

invoice_idstring

The identifier for the invoice.

error_urlstring uri

URL to redirect the user to in case of an error.

success_urlstring uri

URL to redirect the user to upon successful payment.

back_urlstring uri

URL to redirect the user back to your site.

descriptionstring

A brief description of the subscription.

countrystring required

The two-letter country code (ISO 3166-1 alpha-2).