Retrieve All Plans

Get a list of all your existing plans.

HTTP Request¶

GET /v1/payments/plans

RequestResponse

Request Headers

{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}

Response

[
    {
        "id": "UUID",
        "type": "INSTALLMENT",
        "planDetails": {
            "installment": [
                {
                    "modifierType": "RATE",
                    "rate": 0.02,
                    "installments": 3
                },
                {
                    "modifierType": "RATE",
                    "rate": 0.05,
                    "installments": 6
                },
                {
                    "modifierType": "RATE",
                    "rate": 0.1,
                    "installments": 12
                }
            ]
        }
    }
]

HTTP Headers Details¶

Key	Value
Authorization	"Bearer" + " " + {{access_token}}
x-api-key	{{api_key}}

Response Body Details¶

Parameter	Type	Description
-	JSON Array	JSON array of all plans.

Object Parameters¶

JSON Array Object¶

Parameter	Type	Description
id	String	The plan ID, an UUID
type	String	Type of the plan.
planDetails	JSON	The plan details.

planDetails¶

Parameter	Type	Description
installment	JSON Array	Installments plan details.
tax	JSON Array	Tax plan details.

installment¶

Parameter	Type	Description
modifierType	String	Modifier type. RATE
rate	Positive Float	Surcharge rate.
installments	Integer	Number of installments.

tax¶

Parameter	Type	Description
modifierType	String	Modifier type. RATE
rate	Positive Float	Tax rate.
type	String	Type of tax fee.