Update Product

PATCH /products/:id

cURL

curl -X PATCH https://api.autumnai.com/products/Pro%20Product \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Pro Plan (Updated)",
    "description": "Our premium plan with advanced features",
    "items": [
      {
        "price": 25,
        "interval": "month"
      },
      {
        "feature_id": "messages",
        "included_usage": 2000,
        "price": 0.4,
        "interval": "month",
        "usage_model": "pay_per_use"
      }
    ]
  }'

import { Autumn } from '@autumnai/node-sdk';

const autumn = new Autumn({
  apiKey: process.env.AUTUMN_API_KEY,
});

const product = await autumn.products.update({
  productId: 'Pro Product',
  name: 'Pro Plan (Updated)',
  description: 'Our premium plan with advanced features',
  items: [
    {
      price: 25,
      interval: 'month',
    },
    {
      feature_id: 'messages',
      included_usage: 2000,
      price: 0.4,
      interval: 'month',
      usage_model: 'pay_per_use',
    },
  ],
});

from autumn import Autumn

autumn = Autumn(api_key="YOUR_API_KEY")

product = autumn.products.update(
    product_id="Pro Product",
    name="Pro Plan (Updated)",
    description="Our premium plan with advanced features",
    items=[
        {
            "price": 25,
            "interval": "month",
        },
        {
            "feature_id": "messages",
            "included_usage": 2000,
            "price": 0.4,
            "interval": "month",
            "usage_model": "pay_per_use",
        },
    ],
)

200

{
  "id": "Pro Product",
  "name": "Pro Plan (Updated)",
  "description": "Our premium plan with advanced features",
  "group": null,
  "env": "sandbox",
  "is_add_on": false,
  "is_default": false,
  "archived": false,
  "version": 2,
  "created_at": 1761296829908,
  "items": [
    {
      "type": "price",
      "feature_id": null,
      "interval": "month",
      "interval_count": 1,
      "price": 25,
      "display": {
        "primary_text": "$25",
        "secondary_text": "per month"
      }
    },
    {
      "type": "priced_feature",
      "feature_id": "messages",
      "included_usage": 2000,
      "interval": "month",
      "interval_count": 1,
      "price": 0.4,
      "usage_model": "pay_per_use",
      "billing_units": 1000,
      "reset_usage_when_enabled": true,
      "entity_feature_id": null,
      "display": {
        "primary_text": "2,000 Messages",
        "secondary_text": "then $0.4 per 1,000 Messages"
      }
    }
  ],
  "free_trial": null,
  "base_variant_id": null,
  "scenario": "new"
}

Updates an existing product. You can also use POST for this endpoint (will be deprecated in the future).

Path Parameters

product_id · string · required

The ID of the product to update.

Request Body

id · string

The new ID of the product. Used to rename the product ID.

name · string

The name of the product.

description · string

The description of the product.

is_add_on · boolean

Whether the product is an add-on.

is_default · boolean

Whether the product is the default product.

group · string

Product group which this product belongs to.

archived · boolean

Archive this product using this flag. Archived products are hidden on the dashboard.

items · array

Array of product items that define the product’s features and pricing. Updates the entire items array.

Show Product Item Object

type · enum

The type of the product item.

• price - Fixed price item
• priced_feature - Feature with pricing
• feature - Feature without pricing

feature_id · string

The feature ID of the product item. Should be null for fixed price items.

included_usage · number | 'inf'

The amount of usage included for this feature (per interval).

interval · enum

The reset or billing interval of the product item.

• day
• week
• month
• year

interval_count · number

Interval count of the feature.

price · number

The price of the product item. Should be null if tiered pricing is set.

usage_model · enum

Whether the feature should be prepaid upfront or billed based on usage.

• prepaid
• pay_per_use

billing_units · number

The billing units of the product item.

tiers · array

Tiered pricing for the product item.

Show Tier Object

to · number | 'inf' · required

The maximum amount of usage for this tier.

amount · number · required

The price of the product item for this tier.

flat_amount · number

A flat fee charged for this tier, in addition to the per-unit amount.

tier_behavior · enum

The type of tiered pricing.

• graduated
• volume

reset_usage_when_enabled · boolean

Whether the usage should be reset when the product is enabled.

entity_feature_id · string

The feature ID of the entity (like seats) to track sub-balances for.

config · object

Configuration for rollover and proration behavior.

Show Config Object

rollover · object

Rollover configuration.

Show Rollover Object

max · number

Maximum amount that can be rolled over.

duration · enum · default: "month"

Duration type for rollover expiry.

• day
• week
• month
• year

length · number · required

Length of the duration.

on_increase · enum

Behavior when quantity increases.

• prorate
• no_prorate

on_decrease · enum

Behavior when quantity decreases.

• prorate
• no_prorate

free_trial · object

Free trial configuration for this product.

Show Free Trial Object

duration · enum · default: "day" · required

The duration type of the free trial.

• day
• month
• year

length · number · required

The length of the duration type specified.

unique_fingerprint · boolean · default: false

Whether the free trial is limited to one per customer fingerprint.

card_required · boolean · default: true

Whether the free trial requires a card.

Response

id · string

The ID of the product.

name · string

The name of the product.

group · string

Product group which this product belongs to.

env · string

The environment of the product.

is_add_on · boolean

Whether the product is an add-on.

is_default · boolean

Whether the product is the default product.

archived · boolean

Whether this product has been archived.

version · number

The current version of the product.

created_at · number

The timestamp of when the product was created.

items · array

Array of product items that define the product’s features and pricing.

free_trial · object

Free trial configuration for this product, if available.

base_variant_id · string

ID of the base variant this product is derived from.

scenario · enum

Scenario for when this product is used in attach flows.

properties · object

Additional product properties.

cURL

curl -X PATCH https://api.autumnai.com/products/Pro%20Product \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Pro Plan (Updated)",
    "description": "Our premium plan with advanced features",
    "items": [
      {
        "price": 25,
        "interval": "month"
      },
      {
        "feature_id": "messages",
        "included_usage": 2000,
        "price": 0.4,
        "interval": "month",
        "usage_model": "pay_per_use"
      }
    ]
  }'

import { Autumn } from '@autumnai/node-sdk';

const autumn = new Autumn({
  apiKey: process.env.AUTUMN_API_KEY,
});

const product = await autumn.products.update({
  productId: 'Pro Product',
  name: 'Pro Plan (Updated)',
  description: 'Our premium plan with advanced features',
  items: [
    {
      price: 25,
      interval: 'month',
    },
    {
      feature_id: 'messages',
      included_usage: 2000,
      price: 0.4,
      interval: 'month',
      usage_model: 'pay_per_use',
    },
  ],
});

from autumn import Autumn

autumn = Autumn(api_key="YOUR_API_KEY")

product = autumn.products.update(
    product_id="Pro Product",
    name="Pro Plan (Updated)",
    description="Our premium plan with advanced features",
    items=[
        {
            "price": 25,
            "interval": "month",
        },
        {
            "feature_id": "messages",
            "included_usage": 2000,
            "price": 0.4,
            "interval": "month",
            "usage_model": "pay_per_use",
        },
    ],
)

200

{
  "id": "Pro Product",
  "name": "Pro Plan (Updated)",
  "description": "Our premium plan with advanced features",
  "group": null,
  "env": "sandbox",
  "is_add_on": false,
  "is_default": false,
  "archived": false,
  "version": 2,
  "created_at": 1761296829908,
  "items": [
    {
      "type": "price",
      "feature_id": null,
      "interval": "month",
      "interval_count": 1,
      "price": 25,
      "display": {
        "primary_text": "$25",
        "secondary_text": "per month"
      }
    },
    {
      "type": "priced_feature",
      "feature_id": "messages",
      "included_usage": 2000,
      "interval": "month",
      "interval_count": 1,
      "price": 0.4,
      "usage_model": "pay_per_use",
      "billing_units": 1000,
      "reset_usage_when_enabled": true,
      "entity_feature_id": null,
      "display": {
        "primary_text": "2,000 Messages",
        "secondary_text": "then $0.4 per 1,000 Messages"
      }
    }
  ],
  "free_trial": null,
  "base_variant_id": null,
  "scenario": "new"
}