Archive product

Archives a product, preventing new subscriptions. All plans and addons are archived.

POST /api/v1/products/{id}/archive

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.archiveProduct('x');

console.log(product.data);

200

{
  "data": {
    "id": "product-revvenu",
    "displayName": "Revvenu",
    "description": "SaaS billing platform",
    "status": "ARCHIVED",
    "multipleSubscriptions": false,
    "metadata": {},
    "productSettings": {
      "subscriptionEndSetup": "CANCEL_SUBSCRIPTION",
      "subscriptionCancellationTime": "SPECIFIC_DATE",
      "subscriptionStartSetup": "FREE_PLAN"
    },
    "createdAt": "2025-08-17T04:38:24.842Z",
    "updatedAt": "2025-10-08T04:34:18.047Z"
  }
}

Authorizations

X-API-KEY · string · header · required

Server API Key

Path Parameters

id · string · required

The unique identifier of the entity

Required string length: 1 - 255

Response

200

application/json

The archived product object.

Response object

data · Product · object · required

Product configuration object

Show child attributes