Skip to main content
GET
Retrieve Subscription List

Notes

There is no request payload required for this API. Simply ensure that the correct authentication details (API key, etc.) are included in the request headers.

Key Points

Retrieve Subscription Data

  • The Subscription List API helps merchants track the status of all subscriptions plans, including active, cancelled, or expired subscriptions.

Subscription Data - Each subscription record includes

  • Subscription ID
  • Plan Name and Description
  • Current Status (active, expired, or canceled)
  • Start Date and End Date
  • Cycle Interval and Next Billing Date
  • Trial and Discount Information (if applicable).

Authorizations

Authorization
string
header
required

API Key for Authorization. Format: 'Basic YOUR_API_KEY_HERE'

x-api-key
string
header
required

API Key specific to x-api-key.

Response

200 - application/json

A successful response containing subscription details.

success
boolean

Indicates whether the transaction was successful.

Example:

true

status_code
integer

The HTTP status code of the response.

Example:

200

is_live
boolean

Indicates if the transaction is live or a test transaction.

Example:

false

subscription_details
object[]

A list of subscription details.