List Products

curl -X GET https://api.autumnai.com/products \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "list": [
    {
      "id": "Free Plan",
      "name": "Free Plan",
      "group": null,
      "env": "sandbox",
      "is_add_on": false,
      "is_default": true,
      "archived": false,
      "version": 1,
      "created_at": 1761296829908,
      "items": [
        {
          "type": "feature",
          "feature_id": "messages",
          "included_usage": 10,
          "interval": "month",
          "interval_count": 1,
          "reset_usage_when_enabled": true,
          "entity_feature_id": null,
          "display": {
            "primary_text": "10 Messages"
          }
        }
      ],
      "free_trial": null,
      "base_variant_id": null,
      "scenario": "new"
    },
    {
      "id": "Pro Product",
      "name": "Pro Plan",
      "group": null,
      "env": "sandbox",
      "is_add_on": false,
      "is_default": false,
      "archived": false,
      "version": 1,
      "created_at": 1761296829908,
      "items": [
        {
          "type": "price",
          "feature_id": null,
          "interval": "month",
          "interval_count": 1,
          "price": 20,
          "display": {
            "primary_text": "$20",
            "secondary_text": "per month"
          }
        },
        {
          "type": "priced_feature",
          "feature_id": "messages",
          "included_usage": 1000,
          "interval": "month",
          "interval_count": 1,
          "price": 0.5,
          "usage_model": "pay_per_use",
          "billing_units": 1000,
          "reset_usage_when_enabled": true,
          "entity_feature_id": null,
          "display": {
            "primary_text": "1,000 Messages",
            "secondary_text": "then $0.5 per 1,000 Messages"
          }
        }
      ],
      "free_trial": {
        "duration": "day",
        "length": 7,
        "unique_fingerprint": false,
        "card_required": true
      },
      "base_variant_id": null,
      "scenario": "new"
    }
  ]
}

GET

products

curl -X GET https://api.autumnai.com/products \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "list": [
    {
      "id": "Free Plan",
      "name": "Free Plan",
      "group": null,
      "env": "sandbox",
      "is_add_on": false,
      "is_default": true,
      "archived": false,
      "version": 1,
      "created_at": 1761296829908,
      "items": [
        {
          "type": "feature",
          "feature_id": "messages",
          "included_usage": 10,
          "interval": "month",
          "interval_count": 1,
          "reset_usage_when_enabled": true,
          "entity_feature_id": null,
          "display": {
            "primary_text": "10 Messages"
          }
        }
      ],
      "free_trial": null,
      "base_variant_id": null,
      "scenario": "new"
    },
    {
      "id": "Pro Product",
      "name": "Pro Plan",
      "group": null,
      "env": "sandbox",
      "is_add_on": false,
      "is_default": false,
      "archived": false,
      "version": 1,
      "created_at": 1761296829908,
      "items": [
        {
          "type": "price",
          "feature_id": null,
          "interval": "month",
          "interval_count": 1,
          "price": 20,
          "display": {
            "primary_text": "$20",
            "secondary_text": "per month"
          }
        },
        {
          "type": "priced_feature",
          "feature_id": "messages",
          "included_usage": 1000,
          "interval": "month",
          "interval_count": 1,
          "price": 0.5,
          "usage_model": "pay_per_use",
          "billing_units": 1000,
          "reset_usage_when_enabled": true,
          "entity_feature_id": null,
          "display": {
            "primary_text": "1,000 Messages",
            "secondary_text": "then $0.5 per 1,000 Messages"
          }
        }
      ],
      "free_trial": {
        "duration": "day",
        "length": 7,
        "unique_fingerprint": false,
        "card_required": true
      },
      "base_variant_id": null,
      "scenario": "new"
    }
  ]
}

Retrieves a list of all products in your environment.

Response

list

array

Array of product objects.

Show Product Object

string

The ID of the product you set when creating 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 (sandbox or production).

is_add_on

boolean

Whether the product is an add-on and can be purchased alongside other products.

is_default

boolean

Whether the product is the default product.

archived

boolean

Whether this product has been archived and is no longer available.

version

number

The current version of the product.

created_at

number

The timestamp of when the product was created in milliseconds since epoch.

items

array

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

Show Product Item Object

type

enum

The type of the product item (price, priced_feature, or feature).

feature_id

string

The feature ID of the product item. If the item is a fixed price, will be null.

feature_type

enum

The type of feature (single_use, continuous_use, boolean, or static).

included_usage

number | 'inf'

The amount of usage included for this feature.

interval

enum

The reset or billing interval of the product item.

interval_count

number

The interval count of the product item.

price

number

The price of the product item.

tiers

array

Tiered pricing for the product item.

tier_behavior

enum

How tiers are applied (graduated or volume).

usage_model

enum

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

billing_units

number

The amount per billing unit.

reset_usage_when_enabled

boolean

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

entity_feature_id

string

The entity feature ID of the product item if applicable.

display

object

Display configuration for the product item.

Show Display Object

primary_text

string

Primary display text.

secondary_text

string

Secondary display text.

config

object

Configuration for rollover and proration behavior.

free_trial

object

Free trial configuration for this product, if available.

Show Free Trial Object

duration

enum

The duration type of the free trial (day, month, or year).

length

number

The length of the duration type specified.

unique_fingerprint

boolean

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

card_required

boolean

Whether the free trial requires a card.

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.

Show Properties Object

is_free

boolean

True if the product has no base price or usage prices.

is_one_off

boolean

True if the product only contains a one-time price.

interval_group

string

The billing interval group for recurring products.

has_trial

boolean

True if the product includes a free trial.

updateable

boolean

True if the product can be updated after creation.

curl -X GET https://api.autumnai.com/products \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "list": [
    {
      "id": "Free Plan",
      "name": "Free Plan",
      "group": null,
      "env": "sandbox",
      "is_add_on": false,
      "is_default": true,
      "archived": false,
      "version": 1,
      "created_at": 1761296829908,
      "items": [
        {
          "type": "feature",
          "feature_id": "messages",
          "included_usage": 10,
          "interval": "month",
          "interval_count": 1,
          "reset_usage_when_enabled": true,
          "entity_feature_id": null,
          "display": {
            "primary_text": "10 Messages"
          }
        }
      ],
      "free_trial": null,
      "base_variant_id": null,
      "scenario": "new"
    },
    {
      "id": "Pro Product",
      "name": "Pro Plan",
      "group": null,
      "env": "sandbox",
      "is_add_on": false,
      "is_default": false,
      "archived": false,
      "version": 1,
      "created_at": 1761296829908,
      "items": [
        {
          "type": "price",
          "feature_id": null,
          "interval": "month",
          "interval_count": 1,
          "price": 20,
          "display": {
            "primary_text": "$20",
            "secondary_text": "per month"
          }
        },
        {
          "type": "priced_feature",
          "feature_id": "messages",
          "included_usage": 1000,
          "interval": "month",
          "interval_count": 1,
          "price": 0.5,
          "usage_model": "pay_per_use",
          "billing_units": 1000,
          "reset_usage_when_enabled": true,
          "entity_feature_id": null,
          "display": {
            "primary_text": "1,000 Messages",
            "secondary_text": "then $0.5 per 1,000 Messages"
          }
        }
      ],
      "free_trial": {
        "duration": "day",
        "length": 7,
        "unique_fingerprint": false,
        "card_required": true
      },
      "base_variant_id": null,
      "scenario": "new"
    }
  ]
}

Get Product

Update Product

⌘I

Build docs developers (and LLMs) love

Get started for free Talk to us

Overview

Core Endpoints

Customers

Products

Features

Invoices

Events

Response

Build docs developers (and LLMs) love

Overview

Core Endpoints

Customers

Products

Features

Invoices

Events

​Response

Build docs developers (and LLMs) love

Response