STstiggio
Products

Update a product

Changed on

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

patch/api/v1/products/{id}

Request

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

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

  • 913f273cc2f7Revision changes
    • warning

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

  • 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