Clerk API (unofficial showcase)
GET/billing/subscription_items

List all subscription items

Returns a list of all subscription items for the instance. The subscription items are returned sorted by creation date, with the newest appearing first. This includes subscriptions for both users and organizations. Pagination is supported.

8 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
statusstringoptional
Filter subscription items by status
Allowed:activeendedpast_dueupcomingfree_trial
payer_typestringoptional
Filter subscription items by payer type
Allowed:userorg
plan_idstringoptional
Filter subscription items by plan ID
include_freebooleanoptional
Whether to include free plan subscription items
Default:false
querystringoptional
Search query to filter subscription items

5 status codes
200A list of commerce subscription items.
dataarray<object>required
Array of subscription items.
total_countintegerrequired
Total number of subscription items.
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.