Plan Entitlements

Create plan entitlements

Creates one or more entitlements (feature or credit) on a draft plan.

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

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).

Request body

Response

The newly created plan entitlement objects.

Changes

Changed in 8 of the 115 revisions of this API.105

  • b876edd1a4fc51See the full diff
    • added the new CreditOveragePriceCurrencyNotFound enum value to the response property for the response status

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

    • removed the InvoicePreviewNotAvailableForDraftContract enum value from the response property for the response status

      response-property-enum-value-removed

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

      response-property-enum-value-added

    • added the new optional request property ///

      new-optional-request-property

    • added the required property /// to the response with the status

      response-required-property-added

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

      response-property-enum-value-added

    • added the new optional header request parameter X-ACCOUNT-ID

      new-optional-request-parameter

    • added the new optional header request parameter X-ENVIRONMENT-ID

      new-optional-request-parameter

    • added the new PricingModelNotSupportedByBillingIntegration enum value to the response property for the response status

      response-property-enum-value-added

    • added the new DataExportIntegrationError enum value to the response property for the response status

      response-property-enum-value-added

    • added the new InvalidReceivedSignatureError enum value to the response property for the response status

      response-property-enum-value-added