Create Plan

---

description: >- This API allows partners to create a recurring payment plan for a given merchant ID

Create Plan

Create a recurring payment plan

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

Path Parameters

Name	Type	Description
merchant_id	string	Merchant ID

Request Body

Name	Type	Description
merchant_id*	string	Merchant ID
data.name*	string	Plan name
data.amount*	string	Max Length=12 Allowed characters: 0-9 and .(dot) Payment amount including sales tax Note: this value always reflects the total dollar amount for example 1.00 and 1 both will be considered $1.00 and 0.10 will be 10 cents.
data.currency_code	string	ISO Currency code If not provided it defaults to US Dollar (USD)
data.billing_period*	string	Accepted values are DAILY | WEEKLY | MONTHLY | QUARTERLY| ANNUAL
data.duration*	string	Specify the number of recurring payments that will be processed in total
data.duration_unit*	string	Accepted values are DAYS | WEEKS | MONTHS | YEARS

200

Field Definitions

Field Name	Type	Description	Required?
plan_id	string	PayEngine system ID for the Recurring Payment	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)	Optional
billing_period	string	DAILY, WEEKLY, MONTHLY, YEARLY	Required
duration	int	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 Body

{
    "merchant_id": "1cc7b594-b80f-4227-a0fa-299c4c6ce8ab",
    "data": {  
        "name": "Basic",  
        "amount": 100.00,       
        "currency_code": "USD",
        "billing_period": "MONTHLY",
        "duration": "2",
        "duration_unit": "MONTHS"
    }
}

Sample Response Body

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