Billing

List all subscription items

Changed on

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.

get/billing/subscription_items

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/billing/subscription_items
  • Auth: HTTP bearer

Query parameters

paginatedboolean

Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.

limitinteger

Applies a limit to the number of results returned. Can be used for paginating the results together with offset.

offsetinteger

Skip the first offset results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit.

status'active' | 'ended' | 'past_due' | 'upcoming' | 'free_trial'

Filter subscription items by status

payer_type'user' | 'org'

Filter subscription items by payer type

plan_idstring

Filter subscription items by plan ID

include_freeboolean

Whether to include free plan subscription items

querystring

Search query to filter subscription items

Response

A list of commerce subscription items.

total_countinteger required

Total number of subscription items.

Changes

  • 2025-11-101d47a6af3befRevision changes
    • warning

      added the new payer-credits enum value to the /// response property for the response status

  • 2025-11-10b45c56a4eed9Revision changes
    • info

      added to the // response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status