Sign in
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

  • 3e2c8cfcd0352See the full diff
    • ●

      removed the request property charges/overagePricingModels/items/billingCadence

      request-property-removed

    • ●

      removed the request property charges/overagePricingModels/items/billingModel

      request-property-removed

  • 913f273cc2f71See the full diff
    • ●

      added the new ContractNotFound enum value to the code response property for the response status 404

      response-property-enum-value-added

  • 31f34fb3676d1See the full diff
    • ○

      added the new optional request property charges/overagePricingModels/items/creditEntitlement

      new-optional-request-property

  • b876edd1a4fc61See the full diff
    • ●

      removed the request property charges/overagePricingModels/items/topUpCustomCurrencyId

      request-property-removed

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ○

      added the new optional request property charges/overagePricingModels/items/currencyId

      new-optional-request-property

  • 58bb216ff8ce1See the full diff
    • ●

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

      response-property-enum-value-added

  • 3acd63d6c8612See 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

  • 4fa87d66426d1See the full diff
    • ●

      added the new PricingModelNotSupportedByBillingIntegration enum value to the code response property for the response status 400

      response-property-enum-value-added

  • 0dece860f6781See the full diff
    • ●

      added the new DataExportIntegrationError enum value to the code response property for the response status 400

      response-property-enum-value-added

  • b181b166a2a51See the full diff
    • ●

      added the new InvalidReceivedSignatureError enum value to the code response property for the response status 400

      response-property-enum-value-added