STstiggio
Subscriptions

Get a list of subscriptions

Changed on

Retrieves a paginated list of subscriptions, with optional filters for customer, status, and plan.

get/api/v1/subscriptions

Request

  • Base URL
    https://api.stigg.io
  • URL
    https://api.stigg.io/api/v1/subscriptions
  • Auth
    API key in header X-API-KEY

Query parameters

afterstring uuid

Return items that come after this cursor

beforestring uuid

Return items that come before this cursor

limitinteger

Maximum number of items to return

customerIdstring

Filter by customer ID

statusstring[]

Filter by subscription status. Supports comma-separated values for multiple statuses

planIdstring

Filter by plan ID

resourceIdstring

Filter by resource ID

pricingTypestring[]

Filter by pricing type. Supports comma-separated values for multiple types

gtstring date-time

Greater than the specified createdAt value

gtestring date-time

Greater than or equal to the specified createdAt value

ltstring date-time

Less than the specified createdAt value

ltestring date-time

Less than or equal to the specified createdAt value

Filter by creation date using range operators: gt, gte, lt, lte

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Response

A paginated list of subscription objects.

Changes

  • 913f273cc2f7Revision changes
    • info

      added the optional property // to the response with the status

  • b876edd1a4fcRevision changes
    • warning

      added the new CreditOveragePriceCurrencyNotFound enum value to the response property for the response status

    • warning

      added the new InvalidCreditOverageBillingModel enum value to the response property for the response status

    • warning

      added the new InvoicePreviewNotAvailableForDraftContract enum value to the response property for the response status

    • warning

      added the new OveragePriceNotSupportedOnAddon enum value to the response property for the response status

    • warning

      added the new OveragePriceRequiresUsageLimit enum value to the response property for the response status