List Subscriptions

Get all subscriptions associated with the merchant account

GET https://<Platform-host>/api/merchant/:merchantId/recurring-payments/subscriptions

Path Parameters

Name	Type	Description
merchant_id*	string	Platform unique merchant ID

200: OK

Field Definitions

Field Name	Types	Description
data[i].subscription_id	string	Unique subscription ID
data[i].subscription_status	string	Status - ACTIVE, CANCELLED
data[i].plan_id	string	Recurring Payment ID
data[i].plan_name	string	Recurring payment plan name
data[i].amount	string	Transaction Amount
data[i].currency_code	string	Currency set for the recurring payments. It will be in ISO Currency code format
data[i].billing_period	string	DAILY, WEEKLY, MONTHLY, YEARLY
data[i].duration	string	The number of recurring payments that will be processed in total
data[i].duration_unit	string	DAYS | WEEKS | MONTHS | YEARS
data[i].billing_start_date	timestamp	Start Date for the subscriptions
data[i].created_at	timestamp	Creation date of the subscription

Sample Request Body

curl --location --request GET '<API_HOST>/api/merchant/1cc7b594-b80f-4227-a0fa-299c4c6ce8ab/scheduled-payments/plans?page=1&limit=10' \
--header 'Authorization: Basic <API_KEY>'

Sample Response Body

{
    "data": [
    {
        "subscription_id": "1c6aa155-3917-46af-93d2-73e0d0ab2a39",
        "subscription_status": "ACTIVE"
        "plan_id": "8049a73c-2ac4-431c-b9a0-2e60acd937eb",
        "name": "Basic",
        "amount": 100,
        "currency_code": "USD",
        "billing_period": "MONTHLY",
        "duration": 2,
        "duration_unit": "MONTHS",
        "billing_start_date": "2024-10-09T00:21:07.000Z",
        "created_at": "2024-10-09T00:21:07.123Z"
    },
    {
        "subscription_id": "1020c780-e4e5-4457-a0e3-b709d7223231",
        "subscription_status": "CANCELLED"
        "plan_id": "8049a73c-2ac4-431c-b9a0-2e60acd937eb",
        "name": "Basic",
        "amount": 100,
        "currency_code": "USD",
        "billing_period": "MONTHLY",
        "duration": 2,
        "duration_unit": "MONTHS",
        "billing_start_date": "2024-10-09T00:05:09.000Z",
        "created_at": "2024-10-09T00:05:09.488Z"
    }
  ]
}