List Products

TypeScript

import { Autumn } from 'autumn-js';

const autumn = new Autumn();

const { data, error } = await autumn.products.list();

{
  "list": [
    {
      "id": "<string>",
      "name": "<string>",
      "group": "<string>",
      "env": "sandbox",
      "is_add_on": true,
      "is_default": true,
      "archived": true,
      "version": 123,
      "created_at": 123,
      "items": [
        {
          "type": "feature",
          "feature_id": "<string>",
          "feature_type": "single_use",
          "included_usage": 123,
          "interval": "minute",
          "interval_count": 123,
          "price": 123,
          "tiers": [
            {
              "to": 100,
              "amount": 10
            }
          ],
          "usage_model": "prepaid",
          "billing_units": 123,
          "reset_usage_when_enabled": true,
          "entity_feature_id": "<string>",
          "display": {
            "primary_text": "<string>",
            "secondary_text": "<string>"
          },
          "quantity": 123,
          "next_cycle_quantity": 123,
          "config": {
            "rollover": {
              "max": 123,
              "length": 123,
              "duration": "month"
            },
            "on_increase": "bill_immediately",
            "on_decrease": "prorate"
          }
        }
      ],
      "free_trial": {
        "duration": "day",
        "length": 123,
        "unique_fingerprint": true,
        "card_required": true,
        "trial_available": true
      },
      "base_variant_id": "<string>",
      "scenario": "scheduled"
    }
  ]
}

GET

products

TypeScript

import { Autumn } from 'autumn-js';

const autumn = new Autumn();

const { data, error } = await autumn.products.list();

{
  "list": [
    {
      "id": "<string>",
      "name": "<string>",
      "group": "<string>",
      "env": "sandbox",
      "is_add_on": true,
      "is_default": true,
      "archived": true,
      "version": 123,
      "created_at": 123,
      "items": [
        {
          "type": "feature",
          "feature_id": "<string>",
          "feature_type": "single_use",
          "included_usage": 123,
          "interval": "minute",
          "interval_count": 123,
          "price": 123,
          "tiers": [
            {
              "to": 100,
              "amount": 10
            }
          ],
          "usage_model": "prepaid",
          "billing_units": 123,
          "reset_usage_when_enabled": true,
          "entity_feature_id": "<string>",
          "display": {
            "primary_text": "<string>",
            "secondary_text": "<string>"
          },
          "quantity": 123,
          "next_cycle_quantity": 123,
          "config": {
            "rollover": {
              "max": 123,
              "length": 123,
              "duration": "month"
            },
            "on_increase": "bill_immediately",
            "on_decrease": "prorate"
          }
        }
      ],
      "free_trial": {
        "duration": "day",
        "length": 123,
        "unique_fingerprint": true,
        "card_required": true,
        "trial_available": true
      },
      "base_variant_id": "<string>",
      "scenario": "scheduled"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

list

object[]

required

Show child attributes

list.id

string

required

The ID of the product you set when creating the product

list.name

string

required

The name of the product

list.group

string | null

required

Product group which this product belongs to

list.env

enum<string>

required

The environment of the product

Available options:

sandbox,

live

list.is_add_on

boolean

required

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

list.is_default

boolean

required

Whether the product is the default product

list.archived

boolean

required

Whether this product has been archived and is no longer available

list.version

number

required

The current version of the product

list.created_at

number

required

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

list.items

object[]

required

Array of product items that define the product's features and pricing

Show child attributes

list.items.type

enum<string> | null

The type of the product item

Available options:

feature,

priced_feature,

price

list.items.feature_id

string | null

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

list.items.feature_type

enum<string> | null

Single use features are used once and then depleted, like API calls or credits. Continuous use features are those being used on an ongoing-basis, like storage or seats.

Available options:

single_use,

continuous_use,

boolean,

static

list.items.included_usage

The amount of usage included for this feature.

list.items.interval

enum<string> | null

The reset or billing interval of the product item. If null, feature will have no reset date, and if there's a price, it will be billed one-off.

Available options:

minute,

hour,

day,

week,

month,

quarter,

semi_annual,

year

list.items.interval_count

number | null

The interval count of the product item.

list.items.price

number | null

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

list.items.tiers

object[] | null

Tiered pricing for the product item. Not applicable for fixed price items.

Show child attributes

list.items.tiers.to

required

The maximum amount of usage for this tier.

Example:

100

list.items.tiers.amount

number

required

The price of the product item for this tier.

Example:

10

list.items.usage_model

enum<string> | null

Whether the feature should be prepaid upfront or billed for how much they use end of billing period.

Available options:

prepaid,

pay_per_use

list.items.billing_units

number | null

The amount per billing unit (eg. $9 / 250 units)

list.items.reset_usage_when_enabled

boolean | null

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

list.items.entity_feature_id

string | null

The entity feature ID of the product item if applicable.

list.items.display

object

The display of the product item.

Show child attributes

list.items.display.primary_text

string

required

list.items.display.secondary_text

string | null

list.items.quantity

number | null

Used in customer context. Quantity of the feature the customer has prepaid for.

list.items.next_cycle_quantity

number | null

Used in customer context. Quantity of the feature the customer will prepay for in the next cycle.

list.items.config

object

Configuration for rollover and proration behavior of the feature.

Show child attributes

list.items.config.rollover

object

Show child attributes

list.items.config.rollover.max

number | null

required

list.items.config.rollover.length

number

required

list.items.config.rollover.duration

enum<string>

default:month

Available options:

month,

forever

list.items.config.on_increase

enum<string> | null

Available options:

bill_immediately,

prorate_immediately,

prorate_next_cycle,

bill_next_cycle

list.items.config.on_decrease

enum<string> | null

Available options:

prorate,

prorate_immediately,

prorate_next_cycle,

none,

no_prorations

list.free_trial

object

required

Free trial configuration for this product, if available

Show child attributes

list.free_trial.duration

enum<string>

required

The duration type of the free trial

Available options:

day,

month,

year

list.free_trial.length

number

required

The length of the duration type specified

list.free_trial.unique_fingerprint

boolean

required

Whether the free trial is limited to one per customer fingerprint

list.free_trial.card_required

boolean

required

Whether the free trial requires a card. If false, the customer can attach the product without going through a checkout flow or having a card on file.

list.free_trial.trial_available

boolean | null

default:true

required

Used in customer context. Whether the free trial is available for the customer if they were to attach the product.

list.base_variant_id

string | null

required

ID of the base variant this product is derived from

list.scenario

enum<string>

Scenario for when this product is used in attach flows

Available options:

scheduled,

active,

new,

renew,

upgrade,

downgrade,

cancel,

expired,

past_due

Get Product

Create Product

⌘I

Core

Customers

Entities

Features

Products

Referrals

CLI

Platform (Beta)

Authorizations

Response