Sign in
Products

Update a product

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

patch/api/v1/products/{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

Display name of the product

descriptionstring nullable

Description of the product

multipleSubscriptionsboolean

Indicates if multiple subscriptions to this product are allowed

metadataobject nullable

Additional metadata for the product

Response

The updated product object.

Changes

Changed in 7 of the 115 revisions of this API.102

  • 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

  • b876edd1a4fc5See the full diff
    • ●

      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

  • 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