Get all plans
Returns a paginated list of recurring billing plans as { meta: { count, totalPages, page, limit }, data: [...] }.
Query params: page (default 1), limit (default 10), sort (default -updatedAt; - prefix for descending), name (partial, case-insensitive match).
amount is an integer in cents. untilTerminated is true when payments is 0. Deleted plans are excluded. meta.count is the total number of matching plans, not the page size.
query Parameters
pagePage number for paginating
limitLimit items per page
namePartial, case-insensitive match on the plan name.
sortSort field, - prefix for descending. Default -updatedAt.
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
Get all plans › Responses
Paginated plans list.
Add Plan
Create a new recurring billing plan. Plans are reusable templates linked to subscriptions.
amount is an integer in cents (1000 = $10.00). payments is 0–52, where 0 = until terminated.
Frequency: exactly one mode is required — dayFrequency (> 0) alone, or monthFrequency (1–24) together with dayOfMonth (1–31).
createdBy/updatedBy are set by the server; any value sent is ignored.
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
Add Plan › Request Body
paymentsNumber of payments, 0–52. 0 = until terminated (the response then reports untilTerminated: true)
amountInteger amount in cents (1000 = $10.00)
namePlan name
dayFrequencyCharge every N days (> 0). Frequency mode A: send alone, without monthFrequency/dayOfMonth. Exactly one mode is required
monthFrequencyCharge every N months, 1–24. Frequency mode B: send together with dayOfMonth
dayOfMonthDay of the month to charge, 1–31. Frequency mode B: send together with monthFrequency
createdBySet by the server (creator identity); any value sent is ignored
updatedBySet by the server (last updater identity); any value sent is ignored
Add Plan › Responses
Plan created.
Get a plan
Retrieve a single billing plan by ID. amount is an integer in cents; untilTerminated is true when payments is 0; createdBy/updatedBy are set by the server; deletedAt is null unless the plan was deleted. Older plans may omit unset frequency fields or createdBy.
path Parameters
idPlan ID
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
Get a plan › Responses
Plan returned.
Delete a Plan
Soft-delete a billing plan: the response carries the plan with deletedAt populated and it disappears from the list. Deleting an already-deleted plan returns 200 and refreshes deletedAt.
path Parameters
idPlan ID
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
Delete a Plan › Responses
Plan deleted. Returns the plan with deletedAt populated.