Product Catalog
List plans
List all plans.
get/api/v1/plans
Query parameters
includeDeletedboolean
Include deleted plans in response.
Usage: ?includeDeleted=true
idstring[]
Filter by plan.id attribute
[ "01G65Z755AFWAKHE12NY0CQ9FH" ]
keystring[]
Filter by plan.key attribute
keyVersionobject
Filter by plan.key and plan.version attributes
statusPlanStatus[]
Only return plans with the given status.
Usage:
- ?status=active: return only the currently active plan
- ?status=draft: return only the draft plan
- ?status=archived: return only the archived plans
currencyCurrencyCode[]
Filter by plan.currency attribute
[ "USD" ]
pageinteger
Page index.
Default is 1.
pageSizeinteger
The maximum number of items per page.
Default is 100.
order'ASC' | 'DESC'
The order direction.
The order direction.
orderBy'id' | 'key' | 'version' | 'created_at' | 'updated_at'
Order by options for plans.
The order by field.
Response
The request has succeeded.