List Plans

This API allows partners to retrieve details of a recurring payment plan given its ID.

Get all fee schedules for a particular merchant

GET https://<PayEngine-host>/api/merchant/:merchantId/recurring-payments/plans

Request

Path Parameters

Name	Type	Description
merchant_id*	string	Merchant ID

200: OK

Field Definitions

Field Name	Type	Description	Required?
data	array	Recurring Payments	Required
data[i].plan_id	string	PayEngine system ID for the Recurring Payment Plan	Required
data[i].name	string	Plan name	Required
data[i].amount	string	Recurring payment amount	Required
data[i].currency_code	string	ISO Currency code If not provided it defaults to US Dollar (USD)	Required
data[i].billing_period	string	DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY	Required
data[i].duration	string	The number of recurring payments that will be processed in total	Required
data[i].duration_unit	string	Accepted values are DAYS | WEEKS | MONTHS | YEARS	Required

Sample Request

curl --location --request GET '<API_HOST>/api/merchant/2be66e67-88a7-4e04-985d-0a1cfb0a648c/recurring-payments/8049a73c-2ac4-431c-b9a0-2e60acd937eb/recurring-payments/plans?page=1&limit=10' \
--header 'Authorization: Basic <API_KEY>'

Sample Response

{
    "data": [
    {
        "plan_id": "8049a73c-2ac4-431c-b9a0-2e60acd937eb",
        "name": "Basic",  
        "amount": 100.00,       
        "currency_code": "USD",
        "billing_period": "MONTHLY",
        "duration": 2,
        "duration_unit": "MONTHS"
    },
    {
        "plan_id": "9089a73c-2ac4-431c-b9a0-2e60acd989js",
        "name": "Premium",  
        "amount": 300.00,       
        "currency_code": "USD",
        "billing_period": "MONTHLY",
        "duration": 3,
        "duration_unit": "MONTHS"
    }
  ]
}