GET/billing/plans

List all billing plans

Returns a list of all billing plans for the instance. The plans are returned sorted by creation date, with the newest plans appearing first. This includes both free and paid plans. Pagination is supported.

4 parameters
paginatedbooleanoptional
Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.
limitintegeroptional
Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
Default:10
offsetintegeroptional
Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.
Default:0
payer_typestringoptional
Filter plans by payer type
Allowed:userorg

5 status codes
200A list of commerce plans.
dataarray<object>required
Array of plans.
total_countintegerrequired
Total number of plans.
400Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
401Authentication invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Invalid request parameters
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
500Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 400 is returned: Request was not successful. A 401 is returned: Authentication invalid. A 422 is returned: Invalid request parameters. A 500 is returned: Request was not successful.