v1

latestOpenAPI 3.0.02026-07-26280204.9 KB

Payment Plan

List All Payment Plans

Retrieve a list of all Payment Plans. Use query parameters to filter the list.

This API comes with Pagination support, you can customize limit and page query parameters as per the requirements.

get/payment-plan

frequency'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY' | 'QUARTERLY'

Filter by frequency. Accepts single or multiple values

countrystring

Example:SG

ISO country code

payment_plan_idstring

Filter by payment plan id

payment_plan_namestring

Filter by payment plan name (partial match)

currencystring

Example:SGD

ISO 4217 currency code

is_auto_debitboolean

Whether the plan supports auto-debit

start_timeinteger

Example:1690694621

EPOCH timestamp

end_timeinteger

Example:1722317021

EPOCH timestamp

limitinteger

Example:10

Max number of payment plans per page. Default is 10 per page

pageinteger

Example:1

The page number to return. If unspecified, the first page is returned