Update a product

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

PATCH /api/v1/products/{id}

JavaScript

JavaScript

import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const product = await client.v1.products.updateProduct('x');

console.log(product.data);

200

{
  "data": {
    "id": "product-revvenu",
    "displayName": "Revvenu",
    "description": "SaaS billing platform",
    "status": "PUBLISHED",
    "multipleSubscriptions": false,
    "metadata": {},
    "productSettings": {
      "downgradePlanId": "c9b0a382-5b7d-4d32-9f62-8c4e1a7b3d9f",
      "prorateAtEndOfBillingPeriod": null,
      "subscriptionCancellationTime": "END_OF_BILLING_PERIOD",
      "subscriptionEndSetup": "DOWNGRADE_TO_FREE",
      "subscriptionStartPlanId": "a1d4e8f2-6c3b-4a9e-b5f7-2d8c9e0f1a3b",
      "subscriptionStartSetup": "FREE_PLAN"
    },
    "createdAt": "2025-10-26T10:00:00.000Z",
    "updatedAt": "2025-10-26T10:00:00.000Z"
  }
}

Authorizations

X-API-KEY · string · header · required

Server API Key

Headers

X-ACCOUNT-ID · string

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-ID · string

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

Path Parameters

id · string · required

The unique identifier of the entity

Required string length: 1 - 255

Body

application/json

Partially update an existing product. Only provided fields are updated.

displayName · string

Display name of the product

Maximum string length: 255

description · string | null

Description of the product

Maximum string length: 255

multipleSubscriptions · boolean

Indicates if multiple subscriptions to this product are allowed

metadata · object

Additional metadata for the product

Show child attributes

productSettings · object

Show child attributes

usageResetCutoffRule · UsageResetCutoffRule · object

Rule defining when usage resets upon subscription update.

Show child attributes

Response

200

application/json

The updated product object.

Response object

data · Product · object · required

Product configuration object

Show child attributes