STstiggio
Promotional Entitlements

Get a list of promotional entitlements

Changed on

Retrieves a paginated list of a customer's promotional entitlements.

get/api/v1/customers/{id}/promotional-entitlements

Request

  • Base URL
    https://api.stigg.io
  • URL
    https://api.stigg.io/api/v1/customers/{id}/promotional-entitlements
  • Auth
    API key in header X-API-KEY

Path parameters

idstring required

The unique identifier of the entity

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

statusstring[]

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

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 promotional entitlement objects.

Changes

  • 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

  • 58bb216ff8ceRevision changes
    • warning

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