Attach a plan
attach_planDestructive
MUTATES Autumn billing data — attaches (subscribes) a plan to a customer; may create an invoice / return a payment URL. Autumn API: POST /v1/billing.attach. Returns { customer_id, invoice, payment_url, required_action }.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan_id | Yes | The ID of the plan. | |
| version | No | The version of the plan to attach. | |
| customize | No | Optional plan overrides (price, items, licenses, free trial). | |
| entity_id | No | The ID of the entity to attach the plan to. | |
| customer_id | Yes | The ID of the customer to attach the plan to. | |
| success_url | No | URL to redirect to after a successful checkout. | |
| invoice_mode | No | Invoice-mode configuration object (send an invoice instead of auto-charging). | |
| redirect_mode | No | Checkout redirect mode: always, if_required, or never. | |
| feature_quantities | No | Prepaid feature quantities: array of { feature_id, quantity?, adjustable? }. | |
| checkout_session_params | No | Extra Stripe checkout session params (can carry metadata). |