Addon Entitlements4

Addons9

Auto recharge1

Bulk Import2

Contracts6

Coupons5

Credit consumption2

Credit grants3

Credit ledger1

Credit usage1

Custom currencies6

Customer Integrations5

Customers9

Data Export6

Entitlements2

Features6

Governance Assignments2

Governance Entities5

Governance Entitlements Check1

Governance Entity Types2

Governance Hierarchy1

Invoices1

Plan Entitlements4

Plans10

Products6

Promotional Entitlements3

Subscriptions14

Usage5

Plans

Update a plan

Updates an existing plan's properties such as display name, description, and metadata.

patch/api/v1/plans/{id}

Path parameters

idstring required

The unique identifier of the entity

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

displayNamestring

The display name of the package

descriptionstring nullable

The description of the package

billingIdstring nullable

The unique identifier for the entity in the billing provider

metadataobject

Metadata associated with the entity

parentPlanIdstring nullable

The ID of the parent plan, if applicable

compatibleAddonIdsstring[] nullable

Response

The updated plan object.

Changes

Changed in 9 of the 115 revisions of this API.134

Aug 10, 20263e2c8cfcd0352See the full diff
- ●
  removed the request property ///
  request-property-removed
- ●
  removed the request property ///
  request-property-removed
Jul 28, 2026913f273cc2f71See the full diff
- ●
  added the new ContractNotFound enum value to the response property for the response status
  response-property-enum-value-added
Jul 26, 202631f34fb3676d1See the full diff
- ○
  added the new optional request property ///
  new-optional-request-property
Jul 23, 2026b876edd1a4fc61See the full diff
- ●
  removed the request property ///
  request-property-removed
- ●
  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
- ○
  added the new optional request property ///
  new-optional-request-property
Jul 8, 202658bb216ff8ce1See the full diff
- ●
  added the new GovernanceNotEnabled enum value to the response property for the response status
  response-property-enum-value-added
Jun 8, 20263acd63d6c8612See the full diff
- ○
  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
Jun 4, 20264fa87d66426d1See the full diff
- ●
  added the new PricingModelNotSupportedByBillingIntegration enum value to the response property for the response status
  response-property-enum-value-added
May 31, 20260dece860f6781See the full diff
- ●
  added the new DataExportIntegrationError enum value to the response property for the response status
  response-property-enum-value-added
May 28, 2026b181b166a2a51See the full diff
- ●
  added the new InvalidReceivedSignatureError enum value to the response property for the response status
  response-property-enum-value-added

Full history