List Plans
GET {{baseUrl}}/v1/plans?ending_before=<number>&limit=<number>&starting_after=<string>
Retrieve a list of all plans. Use the optional query parameters to filter the results. You can filter the results further by specifying one or more Plan fields as additional query parameters.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
ending_before | string | The ID of the plan created after the last plan you want to retrieve. | |
limit | string | The maximum number of plans to return. Range 1-100. Default is 10. | |
starting_after | string | The ID of the plan created before the first plan you want to retrieve. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"active":"\u003cboolean\u003e","aggregate_usage":"last_during_period","amount":"\u003cnumber\u003e","billing_scheme":"per_unit","created_at":"\u003cnumber\u003e","currency":"ETB","id":"\u003cstring\u003e","interval":"month","interval_count":"\u003cnumber\u003e","metadata":{},"nickname":"\u003cstring\u003e","product":{"active":"\u003cboolean\u003e","attributes":["\u003cstring\u003e","\u003cstring\u003e"],"created_at":"\u003cnumber\u003e","description":"\u003cstring\u003e","id":"\u003cstring\u003e","images":["\u003cstring\u003e","\u003cstring\u003e"],"metadata":{},"name":"\u003cstring\u003e","package_dimensions":{"height":"\u003cnumber\u003e","length":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","width":"\u003cnumber\u003e"},"shippable":"\u003cboolean\u003e","skus":[{"active":"\u003cboolean\u003e","attributes":{},"created_at":"\u003cnumber\u003e","currency":"BSD","id":"\u003cstring\u003e","image":"\u003cstring\u003e","inventory":{},"metadata":{},"package_dimensions":{"height":"\u003cnumber\u003e","length":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","width":"\u003cnumber\u003e"},"price":"\u003cnumber\u003e","product":"\u003cstring\u003e","updated_at":"\u003cnumber\u003e"},{"active":"\u003cboolean\u003e","attributes":{},"created_at":"\u003cnumber\u003e","currency":"INR","id":"\u003cstring\u003e","image":"\u003cstring\u003e","inventory":{},"metadata":{},"package_dimensions":{"height":"\u003cnumber\u003e","length":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","width":"\u003cnumber\u003e"},"price":"\u003cnumber\u003e","product":"\u003cstring\u003e","updated_at":"\u003cnumber\u003e"}],"statement_descriptor":"\u003cstring\u003e","type":"goods","unit_label":"\u003cstring\u003e","updated_at":"\u003cnumber\u003e"},"tiers":[{"amount":"\u003cnumber\u003e","flat_amount":"\u003cnumber\u003e","up_to":"\u003cstring\u003e"},{"amount":"\u003cnumber\u003e","flat_amount":"\u003cnumber\u003e","up_to":"\u003cstring\u003e"}],"tiers_mode":"volume","transform_usage":{"divide_by":"\u003cnumber\u003e","round":"\u003cstring\u003e"},"trial_period_days":"\u003cnumber\u003e","usage_type":"metered"},{"active":"\u003cboolean\u003e","aggregate_usage":"sum","amount":"\u003cnumber\u003e","billing_scheme":"per_unit","created_at":"\u003cnumber\u003e","currency":"NZD","id":"\u003cstring\u003e","interval":"day","interval_count":"\u003cnumber\u003e","metadata":{},"nickname":"\u003cstring\u003e","product":{"active":"\u003cboolean\u003e","attributes":["\u003cstring\u003e","\u003cstring\u003e"],"created_at":"\u003cnumber\u003e","description":"\u003cstring\u003e","id":"\u003cstring\u003e","images":["\u003cstring\u003e","\u003cstring\u003e"],"metadata":{},"name":"\u003cstring\u003e","package_dimensions":{"height":"\u003cnumber\u003e","length":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","width":"\u003cnumber\u003e"},"shippable":"\u003cboolean\u003e","skus":[{"active":"\u003cboolean\u003e","attributes":{},"created_at":"\u003cnumber\u003e","currency":"KES","id":"\u003cstring\u003e","image":"\u003cstring\u003e","inventory":{},"metadata":{},"package_dimensions":{"height":"\u003cnumber\u003e","length":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","width":"\u003cnumber\u003e"},"price":"\u003cnumber\u003e","product":"\u003cstring\u003e","updated_at":"\u003cnumber\u003e"},{"active":"\u003cboolean\u003e","attributes":{},"created_at":"\u003cnumber\u003e","currency":"SDG","id":"\u003cstring\u003e","image":"\u003cstring\u003e","inventory":{},"metadata":{},"package_dimensions":{"height":"\u003cnumber\u003e","length":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","width":"\u003cnumber\u003e"},"price":"\u003cnumber\u003e","product":"\u003cstring\u003e","updated_at":"\u003cnumber\u003e"}],"statement_descriptor":"\u003cstring\u003e","type":"goods","unit_label":"\u003cstring\u003e","updated_at":"\u003cnumber\u003e"},"tiers":[{"amount":"\u003cnumber\u003e","flat_amount":"\u003cnumber\u003e","up_to":"\u003cstring\u003e"},{"amount":"\u003cnumber\u003e","flat_amount":"\u003cnumber\u003e","up_to":"\u003cstring\u003e"}],"tiers_mode":"graduated","transform_usage":{"divide_by":"\u003cnumber\u003e","round":"\u003cstring\u003e"},"trial_period_days":"\u003cnumber\u003e","usage_type":"metered"}],"status":{"error_code":"\u003cstring\u003e","message":"\u003cstring\u003e","operation_id":"\u003cstring\u003e","response_code":"\u003cstring\u003e","status":"\u003cstring\u003e"}}