Preview Multi Attach

Typescript (SDK)

import { Autumn } from 'autumn-js'

const autumn = new Autumn()

const result = await autumn.billing.previewMultiAttach({
  customerId: "cus_123",
  plans: [
    {
      planId: "pro_plan",
    },
    {
      planId: "addon_seats",
      featureQuantities: [
        {
          featureId: "seats",
          quantity: 5,
        },
      ],
    },
  ],
});

from autumn_sdk import Autumn

autumn = Autumn(secret_key="am_sk_test...")

res = autumn.billing.preview_multi_attach(
    customer_id="cus_123",
    plans=[
        {
            "plan_id": "pro_plan",
        },
        {
            "plan_id": "addon_seats",
            "feature_quantities": [
                {
                    "feature_id": "seats",
                    "quantity": 5,
                },
            ],
        },
    ],
    redirect_mode="if_required",
)

curl --request POST \
  --url https://api.useautumn.com/v1/billing.preview_multi_attach \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '
{
  "customer_id": "cus_123",
  "plans": [
    {
      "plan_id": "pro_plan"
    },
    {
      "plan_id": "addon_seats",
      "feature_quantities": [
        {
          "feature_id": "seats",
          "quantity": 5
        }
      ]
    }
  ]
}
'

{
  "customerId": "charles",
  "lineItems": [
    {
      "display_name": "Pro seed",
      "description": "Pro seed - Base Price (from 18 Feb 2026 to 18 Mar 2026)",
      "subtotal": 20,
      "total": 20,
      "discounts": []
    }
  ],
  "subtotal": 20,
  "total": 20,
  "currency": "usd"
}

POST

billing.preview_multi_attach

Typescript (SDK)

import { Autumn } from 'autumn-js'

const autumn = new Autumn()

const result = await autumn.billing.previewMultiAttach({
  customerId: "cus_123",
  plans: [
    {
      planId: "pro_plan",
    },
    {
      planId: "addon_seats",
      featureQuantities: [
        {
          featureId: "seats",
          quantity: 5,
        },
      ],
    },
  ],
});

from autumn_sdk import Autumn

autumn = Autumn(secret_key="am_sk_test...")

res = autumn.billing.preview_multi_attach(
    customer_id="cus_123",
    plans=[
        {
            "plan_id": "pro_plan",
        },
        {
            "plan_id": "addon_seats",
            "feature_quantities": [
                {
                    "feature_id": "seats",
                    "quantity": 5,
                },
            ],
        },
    ],
    redirect_mode="if_required",
)

curl --request POST \
  --url https://api.useautumn.com/v1/billing.preview_multi_attach \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '
{
  "customer_id": "cus_123",
  "plans": [
    {
      "plan_id": "pro_plan"
    },
    {
      "plan_id": "addon_seats",
      "feature_quantities": [
        {
          "feature_id": "seats",
          "quantity": 5
        }
      ]
    }
  ]
}
'

{
  "customerId": "charles",
  "lineItems": [
    {
      "display_name": "Pro seed",
      "description": "Pro seed - Base Price (from 18 Feb 2026 to 18 Mar 2026)",
      "subtotal": 20,
      "total": 20,
      "discounts": []
    }
  ],
  "subtotal": 20,
  "total": 20,
  "currency": "usd"
}

Body Parameters

Response

{
  "customerId": "charles",
  "lineItems": [
    {
      "display_name": "Pro seed",
      "description": "Pro seed - Base Price (from 18 Feb 2026 to 18 Mar 2026)",
      "subtotal": 20,
      "total": 20,
      "discounts": []
    }
  ],
  "subtotal": 20,
  "total": 20,
  "currency": "usd"
}

Authorizations

Authorization

string

header

required

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

Headers

x-api-version

string

default:2.3.0

required

Body

application/json

customer_id

string

required

The ID of the customer to attach the plans to.

plans

object[]

required

The list of plans to attach to the customer.

Minimum array length: 1

Show child attributes

entity_id

string

The ID of the entity to attach the plans to.

free_trial

FreeTrialParams · object | null

Free trial configuration applied to all plans. Pass an object to set a custom trial, or null to remove any trial.

Show child attributes

currency

string

Currency to bill this multi-attach in (e.g. usd, eur). Must match the customer's currency if they are already locked to one, and every plan must offer a paid price in it. Defaults to the customer's currency, then the org default.

invoice_mode

object

Invoice mode creates a draft or open invoice and sends it to the customer, instead of charging their card immediately.

Show child attributes

discounts

AttachDiscount · object[]

List of discounts to apply. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code.

Show child attributes

success_url

string

URL to redirect to after successful checkout.

checkout_session_params

object

Additional parameters to pass into the creation of the Stripe checkout session.

Show child attributes

redirect_mode

enum<string>

default:if_required

Controls when to return a checkout URL. 'always' returns a URL even if payment succeeds, 'if_required' only when payment action is needed, 'never' disables redirects.

Available options:

always,

if_required,

never

new_billing_subscription

boolean

Only applicable when the customer has an existing Stripe subscription. If true, creates a new separate subscription instead of merging into the existing one.

enable_plan_immediately

boolean

If true, the cusProducts are activated immediately even when payment is pending via Stripe checkout.

customer_data

CustomerData · object

Customer details to set when creating a customer

Show child attributes

entity_data

object

Show child attributes

Response

200 - application/json

customer_id

string

required

The ID of the customer.

line_items

object[]

required

Show child attributes

subtotal

number

required

The total amount in cents before discounts and tax for the current billing period.

total

number

required

The final amount in cents after discounts and tax for the current billing period.

currency

string

required

The three-letter ISO currency code (e.g., 'usd').

incoming

object[]

required

Products or subscription changes being added or updated.

Show child attributes

outgoing

object[]

required

Products or subscription changes being removed or ended.

Show child attributes

redirect_to_checkout

boolean

required

Whether the customer will be redirected to a checkout page if attach is called.

checkout_type

enum<string> | null

required

The type of checkout that will be used if the customer is redirected to a checkout page.

Available options:

stripe_checkout,

autumn_checkout

next_cycle

object

Preview of the next billing cycle, if applicable. This shows what the customer will be charged in subsequent cycles.

Show child attributes

expand

string[]

Expand the response with additional data.

tax

object

Tax preview for the immediate charge. Contact us to enable the tax flag on your organisation. Shows only with flag enabled, a Stripe customer exists and has a location.

Show child attributes

invoice_credits

object

Stripe customer invoice credits preview.

Show child attributes

Setup Payment Multi Attach

⌘I

Billing

Balances

Customers

Authorization

Events

Entities

Plans

Features

Rewards & Referrals

Webhook Events

Platform (Beta)

Preview Multi Attach

Body Parameters

Response

Authorizations

Headers

Body

Response

​Body Parameters

​Response

Authorizations

Headers

Body

Response

Body Parameters

Response