List plans

GET/api/v1/billing_plansbilling:write

The merchant's billing plans.

Query parameters

pageinteger

Page number, from 1.

page_sizeinteger

Items per page.

orderstring

Sort, e.g. id desc for newest first.

statusinteger

1 active, 2 draft, 3 archived.

Headers

Authorizationheaderrequired

Bearer with your secret key, or the merchant's OAuth token.

Returns

entries and pagination.

Errors

401 The key or token is missing, wrong or revoked, is for the other environment, or doesn't have the scope this endpoint needs.

PreviousGet a plan NextUpdate a plan

{ "state": "ok", "result": { "entries": [ { "id": 61, "uid": "plan_…", "name": "Monthly box", "flat_rate": 4500, "currency_code": "JMD", "billing_cycle": 3, "duration": 3, "trial_period": 0, "charge_strategy": 1, "status": 1, "public": false } ], "pagination": { "page": 1, "page_size": 20, "total_entries": 1, "total_pages": 1, "more": false, "next_pages": [], "last_pages": [] } } }