import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.billing.setupPayment({
customerId: "cus_123",
successUrl: "https://example.com/account/billing",
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.billing.setup_payment(
customer_id="cus_123",
success_url="https://example.com/account/billing",
)curl --request POST \
--url https://api.useautumn.com/v1/billing.setup_payment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"customer_id": "cus_123",
"success_url": "https://example.com/account/billing"
}
'{
"customer_id": "cus_123",
"url": "https://checkout.stripe.com/..."
}
Setup Payment
Create a payment setup session for a customer to add or update their payment method.
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.billing.setupPayment({
customerId: "cus_123",
successUrl: "https://example.com/account/billing",
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.billing.setup_payment(
customer_id="cus_123",
success_url="https://example.com/account/billing",
)curl --request POST \
--url https://api.useautumn.com/v1/billing.setup_payment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"customer_id": "cus_123",
"success_url": "https://example.com/account/billing"
}
'{
"customer_id": "cus_123",
"url": "https://checkout.stripe.com/..."
}
Body Parameters
Response
{
"customer_id": "cus_123",
"url": "https://checkout.stripe.com/..."
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
The ID of the customer to attach the plan to.
The ID of the entity to attach the plan to.
If specified, the plan will be attached to the customer after setup.
If this plan contains prepaid features, use this field to specify the quantity of each prepaid feature. This quantity includes the included amount and billing units defined when setting up the plan.
Show child attributes
Show child attributes
The version of the plan to attach.
Free trial for this plan. A shorthand for customize.free_trial, which takes precedence when both are given.
Show child attributes
Show child attributes
Customize the plan to attach. Can override the price, items, licenses, free trial, or a combination.
Show child attributes
Show child attributes
How to handle proration when updating an existing subscription. 'prorate_immediately' charges/credits prorated amounts now, 'none' skips creating any charges, 'bill_difference' bills the larger of the full-period price difference and the prorated amount (full difference on upgrades, prorated credit on downgrades) now without changing the billing cycle.
prorate_immediately, none, bill_difference A unique ID to identify this subscription. Can be used to target specific subscriptions in update operations when a customer has multiple products with the same plan.
List of discounts to apply. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code.
Show child attributes
Show child attributes
URL to redirect to after successful checkout.
Reset the billing cycle immediately with 'now', or schedule a reset at a future Unix timestamp in milliseconds.
Unix timestamp in milliseconds for when the attached plan should start. Future dates create a scheduled subscription.
0 <= x <= 9007199254740991Unix timestamp in milliseconds for when the attached plan should end.
0 <= x <= 9007199254740991Additional parameters to pass into the creation of the Stripe checkout session.
Show child attributes
Show child attributes
Custom line items that override the auto-generated proration invoice. Only valid for immediate plan changes (eg. upgrades or one off plans).
Show child attributes
Show child attributes
Lines to remove from the invoice this request creates. Never changes the subscription or later invoices.
1Show child attributes
Show child attributes
Lines to add to the invoice this request creates. Never changes the subscription or later invoices.
1Show child attributes
Show child attributes
The processor subscription ID to link. Use this to attach an existing Stripe subscription instead of creating a new one.
Whether to carry over balances from the previous plan.
Show child attributes
Show child attributes
Whether to carry over usages from the previous plan.
Show child attributes
Show child attributes
Seat quantities for the plan's licenses, keyed by license plan.
Show child attributes
Show child attributes
Key-value metadata to attach to the Stripe subscription, invoice, and checkout session created during this attach flow. Keys prefixed with 'autumn_' are reserved and will be stripped.
Show child attributes
Show child attributes
If true, skips any billing changes for the attach operation.
If true, the customer's plan is activated immediately even when payment is deferred (invoice mode) or pending (Stripe checkout). For Stripe checkout, the customer_product is inserted before the customer completes the hosted form. Set it here rather than on invoice_mode, which only covers the invoice-unpaid case.
Tax behavior for this attach. Use automatic_tax to turn automatic tax on or off for this request, or rate_id to apply a fixed tax rate.
Show child attributes
Show child attributes
Billing address, tax IDs and tax exemption to save to the customer before billing. Lets an invoice-mode attach supply the address automatic tax needs in the same call.
Show child attributes
Show child attributes
Stripe tax rate ID (txr_...) to apply as the default tax rate on the created subscription, invoice, or checkout session line items.
Currency to bill this attach in (e.g. usd, eur). Must match the customer's currency if they are already locked to one. Without customize, the plan must offer a paid price in it. With customize, every price that states no currency of its own is billed in this currency at the amount given (not converted), so a one-off contract in e.g. EUR needs no plan-level currency setup. Defaults to the customer's currency, then the org default.
Plan IDs to expire on the customer as part of this attach. Each must be an active plan. When no plan in the same group is being replaced, the attach takes over the subscription of the first paid plan listed here, unless new_billing_subscription is true (paid plans cannot be removed in that case). Any other paid plan must be billed on that same subscription (free plans can always be removed). Only allowed when the new plan starts immediately (not with plan_schedule: end_of_cycle, or a future starts_at without enable_plan_immediately).
Discounts to remove from the subscription, by reward ID. Discounts not listed are left unchanged.
Show child attributes
Show child attributes