Get Plan

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

Retrieve details for a Recurring Payment Plan given its ID

GET https://<Platform-host>/api/merchant/:merchant_id/recurring-payments/plans/:id

Request

Path Parameters

Name	Type	Description
id*	string	Recurring Payment Plan ID

200

Field Definitions

Field Name	Type	Description	Required?
plan_id	string	Platform system ID for the Recurring Payment Plan	Required
name	string	Plan name	Required
amount	string	Recurring payment amount	Required
currency_code	string	ISO Currency code If not provided it defaults to US Dollar (USD)	Required
billing_period	string	DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY	Required
duration	string	The number of recurring payments that will be processed in total	Required
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/recurring-payments/plans/8049a73c-2ac4-431c-b9a0-2e60acd937eb' \
--header 'Authorization: Basic <API_KEY>'

Sample Response

{
    "plan_id": "8049a73c-2ac4-431c-b9a0-2e60acd937eb",
    "name": "Basic",  
    "amount": 100.00,       
    "currency_code": "USD",
    "billing_period": "MONTHLY",
    "duration": 2,
    "duration_unit": "MONTHS"
}