STstiggio
Plan Entitlements

Get a list of plan entitlements

Changed on

Retrieves a list of entitlements for a plan.

get/api/v1/plans/{planId}/entitlements

Request

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

Path parameters

planIdstring required

The plan ID

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 list of plan 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