atmn 1.1.25 → 2.0.0

package/src/generated/apiRoutes.ts

@@ -0,0 +1,3787 @@
+// Generated by @autumn/atmn-generator from packages/openapi/openapi.yml (the public spec).
+// Do not edit — run `bun generate` in packages/atmn-generator instead.
+
+export type ApiFieldType = "string" | "number" | "boolean" | "json";
+
+export type ApiField = {
+	readonly name: string;
+	readonly type: ApiFieldType;
+	readonly required: boolean;
+	readonly description?: string;
+};
+
+export type ApiRoute = {
+	readonly group: string;
+	readonly method: string;
+	readonly path: string;
+	readonly description?: string;
+	/** `array` bodies (batch routes) take JSON only; `none` takes nothing. */
+	readonly body: "object" | "array" | "none";
+	readonly fields: readonly ApiField[];
+};
+
+/** The x-api-version every request carries: the spec's default. */
+export const API_VERSION = "2.4.0";
+
+export const API_ROUTES: readonly ApiRoute[] = [
+	{
+		group: "customers",
+		method: "get_or_create",
+		path: "/v1/customers.get_or_create",
+		description:
+			"Creates a customer if they do not exist, or returns the existing customer by your external customer ID.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+			},
+			{
+				name: "name",
+				type: "string",
+				required: false,
+				description: "Customer's name",
+			},
+			{
+				name: "email",
+				type: "string",
+				required: false,
+				description: "Customer's email address",
+			},
+			{
+				name: "fingerprint",
+				type: "string",
+				required: false,
+				description:
+					"Unique identifier (eg, serial number) to detect duplicate customers and prevent free trial abuse",
+			},
+			{
+				name: "metadata",
+				type: "json",
+				required: false,
+				description: "Additional metadata for the customer",
+			},
+			{
+				name: "stripe_id",
+				type: "string",
+				required: false,
+				description: "Stripe customer ID if you already have one",
+			},
+			{
+				name: "create_in_stripe",
+				type: "boolean",
+				required: false,
+				description: "Whether to create the customer in Stripe",
+			},
+			{
+				name: "auto_enable_plan_id",
+				type: "string",
+				required: false,
+				description: "The ID of the free plan to auto-enable for the customer",
+			},
+			{
+				name: "send_email_receipts",
+				type: "boolean",
+				required: false,
+				description: "Whether to send email receipts to this customer",
+			},
+			{
+				name: "currency",
+				type: "string",
+				required: false,
+				description:
+					"Currency to bill this customer in (e.g. usd, eur). Defaults to the organization's default currency.",
+			},
+			{
+				name: "billing_controls",
+				type: "json",
+				required: false,
+				description: "Billing controls for the customer (auto top-ups, etc.)",
+			},
+			{
+				name: "config",
+				type: "json",
+				required: false,
+				description: "Miscellaneous configurations for the customer.",
+			},
+			{
+				name: "expand",
+				type: "json",
+				required: false,
+				description:
+					"Fields to expand in the returned customer response, such as subscriptions.plan, purchases.plan, balances.feature, or flags.feature.",
+			},
+		],
+	},
+	{
+		group: "customers",
+		method: "get",
+		path: "/v1/customers.get",
+		description:
+			"Fetches a customer by ID, optionally expanding related data such as invoices or entities.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "ID of the customer to fetch",
+			},
+			{
+				name: "expand",
+				type: "json",
+				required: false,
+				description:
+					"Expand related customer data like invoices or entities, or expand nested objects like balances.feature, flags.feature, subscriptions.plan, and purchases.plan.",
+			},
+		],
+	},
+	{
+		group: "customers",
+		method: "list",
+		path: "/v1/customers.list",
+		description:
+			'Lists customers with cursor pagination and optional filters. Pass `start_cursor: ""` (or omit) for the first page; use `next_cursor` from a prior response for subsequent pages.',
+		body: "object",
+		fields: [
+			{
+				name: "start_cursor",
+				type: "string",
+				required: false,
+				description:
+					"Opaque pagination cursor. Empty string (default) requests the first page; use next_cursor from a prior response for subsequent pages.",
+			},
+			{
+				name: "limit",
+				type: "number",
+				required: false,
+				description:
+					"Number of items to return. Default 50, hard ceiling 5000.",
+			},
+			{
+				name: "plans",
+				type: "json",
+				required: false,
+				description:
+					"Filter by plan ID and version. Returns customers with active subscriptions to this plan.",
+			},
+			{
+				name: "subscription_status",
+				type: "string",
+				required: false,
+				description:
+					"Filter by customer product status. Defaults to active and scheduled.",
+			},
+			{
+				name: "search",
+				type: "string",
+				required: false,
+				description: "Search customers by id, name, or email.",
+			},
+			{
+				name: "processors",
+				type: "json",
+				required: false,
+				description:
+					"Filter by customer processor type (stripe, revenuecat, vercel).",
+			},
+			{
+				name: "sort_order",
+				type: "string",
+				required: false,
+				description:
+					"Sort by customer creation time. Defaults to desc (newest first).",
+			},
+			{
+				name: "created_at_range",
+				type: "json",
+				required: false,
+				description:
+					"Filter by customer creation time (epoch milliseconds, inclusive bounds).",
+			},
+		],
+	},
+	{
+		group: "customers",
+		method: "update",
+		path: "/v1/customers.update",
+		description: "Updates an existing customer by ID.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "ID of the customer to update",
+			},
+			{
+				name: "name",
+				type: "string",
+				required: false,
+				description: "Customer's name",
+			},
+			{
+				name: "email",
+				type: "string",
+				required: false,
+				description: "Customer's email address",
+			},
+			{
+				name: "fingerprint",
+				type: "string",
+				required: false,
+				description:
+					"Unique identifier (eg, serial number) to detect duplicate customers and prevent free trial abuse",
+			},
+			{
+				name: "metadata",
+				type: "json",
+				required: false,
+				description: "Additional metadata for the customer",
+			},
+			{
+				name: "stripe_id",
+				type: "string",
+				required: false,
+				description: "Stripe customer ID if you already have one",
+			},
+			{
+				name: "send_email_receipts",
+				type: "boolean",
+				required: false,
+				description: "Whether to send email receipts to this customer",
+			},
+			{
+				name: "currency",
+				type: "string",
+				required: false,
+				description:
+					"Currency to bill this customer in (e.g. usd, eur). Defaults to the organization's default currency.",
+			},
+			{
+				name: "billing_controls",
+				type: "json",
+				required: false,
+			},
+			{
+				name: "config",
+				type: "json",
+				required: false,
+				description: "Miscellaneous configurations for the customer.",
+			},
+			{
+				name: "new_customer_id",
+				type: "string",
+				required: false,
+				description: "New ID for the customer",
+			},
+		],
+	},
+	{
+		group: "customers",
+		method: "delete",
+		path: "/v1/customers.delete",
+		description: "Deletes a customer by ID.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "ID of the customer to delete",
+			},
+			{
+				name: "delete_in_stripe",
+				type: "boolean",
+				required: false,
+				description: "Whether to also delete the customer in Stripe",
+			},
+		],
+	},
+	{
+		group: "plans",
+		method: "create",
+		path: "/v1/plans.create",
+		description:
+			"Creates a new plan with optional base price and feature configurations.",
+		body: "object",
+		fields: [
+			{
+				name: "plan_id",
+				type: "string",
+				required: true,
+				description: "The ID of the plan to create.",
+			},
+			{
+				name: "group",
+				type: "string",
+				required: false,
+				description:
+					"Group identifier for organizing related plans. Plans in the same group are mutually exclusive.",
+			},
+			{
+				name: "name",
+				type: "string",
+				required: true,
+				description: "Display name of the plan.",
+			},
+			{
+				name: "description",
+				type: "string",
+				required: false,
+				description: "Optional description of the plan.",
+			},
+			{
+				name: "add_on",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, this plan can be attached alongside other plans. Otherwise, attaching replaces existing plans in the same group.",
+			},
+			{
+				name: "auto_enable",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, plan is automatically attached when a customer is created. Use for free tiers.",
+			},
+			{
+				name: "price",
+				type: "json",
+				required: false,
+				description:
+					"Base recurring price for the plan. Omit for free or usage-only plans.",
+			},
+			{
+				name: "items",
+				type: "json",
+				required: false,
+				description:
+					"Feature configurations for this plan. Each item defines included units, pricing, and reset behavior.",
+			},
+			{
+				name: "licenses",
+				type: "json",
+				required: false,
+				description:
+					"Plans offered as assignable licenses under this plan. The full set replaces existing links.",
+			},
+			{
+				name: "free_trial",
+				type: "json",
+				required: false,
+				description:
+					"Free trial configuration. Customers can try this plan before being charged.",
+			},
+			{
+				name: "config",
+				type: "json",
+				required: false,
+				description: "Miscellaneous plan-level configuration flags.",
+			},
+			{
+				name: "billing_controls",
+				type: "json",
+				required: false,
+				description: "Plan-level billing controls used as customer defaults.",
+			},
+			{
+				name: "metadata",
+				type: "json",
+				required: false,
+				description:
+					"Arbitrary key-value metadata defined by you for your own use (e.g. UI copy, feature highlights). Values can be any JSON-serializable value. Shared across all versions of the plan.",
+			},
+			{
+				name: "create_in_stripe",
+				type: "boolean",
+				required: false,
+			},
+		],
+	},
+	{
+		group: "plans",
+		method: "get",
+		path: "/v1/plans.get",
+		description: "Retrieves a single plan by its ID.",
+		body: "object",
+		fields: [
+			{
+				name: "plan_id",
+				type: "string",
+				required: true,
+				description: "The ID of the plan to retrieve.",
+			},
+			{
+				name: "version",
+				type: "number",
+				required: false,
+				description:
+					"The version of the plan to get. Defaults to the latest version.",
+			},
+		],
+	},
+	{
+		group: "plans",
+		method: "list",
+		path: "/v1/plans.list",
+		description: "Lists all plans in the current environment.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: false,
+				description:
+					"Customer ID to include eligibility info (trial availability, attach scenario).",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+				description: "Entity ID for entity-scoped plans.",
+			},
+			{
+				name: "include_archived",
+				type: "boolean",
+				required: false,
+				description: "If true, includes archived plans in the response.",
+			},
+			{
+				name: "all_versions",
+				type: "boolean",
+				required: false,
+				description: "If true, includes all plan versions.",
+			},
+		],
+	},
+	{
+		group: "plans",
+		method: "update",
+		path: "/v1/plans.update",
+		description:
+			"Updates an existing plan. Creates a new version unless `disableVersion` is set.",
+		body: "object",
+		fields: [
+			{
+				name: "plan_id",
+				type: "string",
+				required: true,
+				description: "The ID of the plan to update.",
+			},
+			{
+				name: "group",
+				type: "string",
+				required: false,
+			},
+			{
+				name: "name",
+				type: "string",
+				required: false,
+				description: "Display name of the plan.",
+			},
+			{
+				name: "description",
+				type: "string",
+				required: false,
+			},
+			{
+				name: "add_on",
+				type: "boolean",
+				required: false,
+				description: "Whether the plan is an add-on.",
+			},
+			{
+				name: "auto_enable",
+				type: "boolean",
+				required: false,
+				description: "Whether the plan is automatically enabled.",
+			},
+			{
+				name: "price",
+				type: "json",
+				required: false,
+				description:
+					"The price of the plan. Set to null to remove the base price.",
+			},
+			{
+				name: "items",
+				type: "json",
+				required: false,
+				description:
+					"Feature configurations for this plan. Each item defines included units, pricing, and reset behavior.",
+			},
+			{
+				name: "licenses",
+				type: "json",
+				required: false,
+				description:
+					"Plans offered as assignable licenses under this plan. The full set replaces existing links.",
+			},
+			{
+				name: "free_trial",
+				type: "json",
+				required: false,
+				description:
+					"The free trial of the plan. Set to null to remove the free trial.",
+			},
+			{
+				name: "config",
+				type: "json",
+				required: false,
+				description: "Miscellaneous plan-level configuration flags.",
+			},
+			{
+				name: "billing_controls",
+				type: "json",
+				required: false,
+				description: "Plan-level billing controls used as customer defaults.",
+			},
+			{
+				name: "metadata",
+				type: "json",
+				required: false,
+				description:
+					"Arbitrary key-value metadata defined by you for your own use (e.g. UI copy, feature highlights). Values can be any JSON-serializable value. Shared across all versions of the plan.",
+			},
+			{
+				name: "create_in_stripe",
+				type: "boolean",
+				required: false,
+			},
+			{
+				name: "version",
+				type: "number",
+				required: false,
+			},
+			{
+				name: "archived",
+				type: "boolean",
+				required: false,
+			},
+			{
+				name: "base_plan_id",
+				type: "string",
+				required: false,
+				description:
+					"The base plan this plan should be linked to as a variant. Set to null to detach it from its base plan.",
+			},
+			{
+				name: "new_plan_id",
+				type: "string",
+				required: false,
+				description:
+					"The new ID to use for the plan. Can only be updated if the plan has not been used by any customers.",
+			},
+			{
+				name: "disable_version",
+				type: "boolean",
+				required: false,
+			},
+			{
+				name: "all_versions",
+				type: "boolean",
+				required: false,
+				description:
+					"Apply the update diff to all versions of this plan. Mutually exclusive with disable_version.",
+			},
+			{
+				name: "migration",
+				type: "json",
+				required: false,
+			},
+			{
+				name: "force_version",
+				type: "boolean",
+				required: false,
+				description:
+					"Force versioning even when no customers exist. Mutually exclusive with disable_version.",
+			},
+			{
+				name: "update_variant_ids",
+				type: "json",
+				required: false,
+				description:
+					"Variant plan IDs to apply this update to. Empty or omitted means no propagation.",
+			},
+			{
+				name: "update_license_parents",
+				type: "json",
+				required: false,
+				description:
+					"Parent plan versions that should receive this license-plan update.",
+			},
+			{
+				name: "variants",
+				type: "json",
+				required: false,
+				description:
+					"Additive variant updates for this base plan. Missing variants are created when name is provided.",
+			},
+			{
+				name: "is_default",
+				type: "boolean",
+				required: false,
+				description:
+					"Whether this is the org's default plan. Cannot be true on a variant.",
+			},
+		],
+	},
+	{
+		group: "plans",
+		method: "delete",
+		path: "/v1/plans.delete",
+		description: "Deletes a plan by its ID.",
+		body: "object",
+		fields: [
+			{
+				name: "plan_id",
+				type: "string",
+				required: true,
+				description: "The ID of the plan to delete.",
+			},
+			{
+				name: "all_versions",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, deletes all versions of the plan. Otherwise, only deletes the latest version.",
+			},
+		],
+	},
+	{
+		group: "features",
+		method: "create",
+		path: "/v1/features.create",
+		description: "Creates a new feature.",
+		body: "object",
+		fields: [
+			{
+				name: "name",
+				type: "string",
+				required: true,
+				description: "The name of the feature.",
+			},
+			{
+				name: "type",
+				type: "string",
+				required: true,
+				description:
+					"The type of the feature. 'single_use' features are consumed, like API calls, tokens, or messages. 'continuous_use' features are allocated, like seats, workspaces, or projects. 'credit_system' features are schemas that unify multiple 'single_use' features into a single credit system.",
+			},
+			{
+				name: "consumable",
+				type: "boolean",
+				required: false,
+				description:
+					"Whether this feature is consumable. A consumable feature is one that periodically resets and is consumed rather than allocated (like credits, API requests, etc.). Applicable only for 'metered' features.",
+			},
+			{
+				name: "display",
+				type: "json",
+				required: false,
+				description:
+					"Singular and plural display names for the feature in your user interface.",
+			},
+			{
+				name: "credit_schema",
+				type: "json",
+				required: false,
+				description:
+					"A schema that maps metered feature IDs to flat or graduated credit costs. For classic credit systems only — AI credit systems use model_markups instead.",
+			},
+			{
+				name: "model_markups",
+				type: "json",
+				required: false,
+				description:
+					"Per-model markup overrides for AI credit systems. Maps model IDs to their markup configuration.",
+			},
+			{
+				name: "default_markup",
+				type: "number",
+				required: false,
+				description:
+					"Default percentage markup for this AI credit system. Used when no model or provider markup applies. Use -100 to make usage free.",
+			},
+			{
+				name: "provider_markups",
+				type: "json",
+				required: false,
+				description:
+					"Per-provider default markup percentages for AI credit systems. Provider keys match the first segment of model_id.",
+			},
+			{
+				name: "event_names",
+				type: "json",
+				required: false,
+			},
+			{
+				name: "feature_id",
+				type: "string",
+				required: true,
+				description: "The ID of the feature to create.",
+			},
+		],
+	},
+	{
+		group: "features",
+		method: "get",
+		path: "/v1/features.get",
+		description: "Retrieves a single feature by its ID.",
+		body: "object",
+		fields: [
+			{
+				name: "feature_id",
+				type: "string",
+				required: true,
+				description: "The ID of the feature.",
+			},
+		],
+	},
+	{
+		group: "features",
+		method: "list",
+		path: "/v1/features.list",
+		description: "Lists all features in the current environment.",
+		body: "none",
+		fields: [],
+	},
+	{
+		group: "features",
+		method: "update",
+		path: "/v1/features.update",
+		description: "Updates an existing feature.",
+		body: "object",
+		fields: [
+			{
+				name: "name",
+				type: "string",
+				required: false,
+				description: "The name of the feature.",
+			},
+			{
+				name: "type",
+				type: "string",
+				required: false,
+				description:
+					"The type of the feature. 'single_use' features are consumed, like API calls, tokens, or messages. 'continuous_use' features are allocated, like seats, workspaces, or projects. 'credit_system' features are schemas that unify multiple 'single_use' features into a single credit system.",
+			},
+			{
+				name: "consumable",
+				type: "boolean",
+				required: false,
+				description:
+					"Whether this feature is consumable. A consumable feature is one that periodically resets and is consumed rather than allocated (like credits, API requests, etc.). Applicable only for 'metered' features.",
+			},
+			{
+				name: "display",
+				type: "json",
+				required: false,
+				description:
+					"Singular and plural display names for the feature in your user interface.",
+			},
+			{
+				name: "credit_schema",
+				type: "json",
+				required: false,
+				description:
+					"A schema that maps metered feature IDs to flat or graduated credit costs. For classic credit systems only — AI credit systems use model_markups instead.",
+			},
+			{
+				name: "model_markups",
+				type: "json",
+				required: false,
+				description:
+					"Per-model markup overrides for AI credit systems. Maps model IDs to their markup configuration.",
+			},
+			{
+				name: "default_markup",
+				type: "number",
+				required: false,
+				description:
+					"Default percentage markup for this AI credit system. Used when no model or provider markup applies. Use -100 to make usage free.",
+			},
+			{
+				name: "provider_markups",
+				type: "json",
+				required: false,
+				description:
+					"Per-provider default markup percentages for AI credit systems. Provider keys match the first segment of model_id.",
+			},
+			{
+				name: "event_names",
+				type: "json",
+				required: false,
+			},
+			{
+				name: "archived",
+				type: "boolean",
+				required: false,
+				description:
+					"Whether the feature is archived. Archived features are hidden from the dashboard.",
+			},
+			{
+				name: "feature_id",
+				type: "string",
+				required: true,
+				description: "The ID of the feature to update.",
+			},
+			{
+				name: "new_feature_id",
+				type: "string",
+				required: false,
+				description:
+					"The new ID of the feature. Feature ID can only be updated if it's not being used by any customers.",
+			},
+		],
+	},
+	{
+		group: "features",
+		method: "delete",
+		path: "/v1/features.delete",
+		description: "Deletes a feature by its ID.",
+		body: "object",
+		fields: [
+			{
+				name: "feature_id",
+				type: "string",
+				required: true,
+				description: "The ID of the feature to delete.",
+			},
+		],
+	},
+	{
+		group: "billing",
+		method: "attach",
+		path: "/v1/billing.attach",
+		description:
+			"Attaches a plan to a customer. Handles new subscriptions, upgrades and downgrades.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The ID of the customer to attach the plan to.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+				description: "The ID of the entity to attach the plan to.",
+			},
+			{
+				name: "plan_id",
+				type: "string",
+				required: true,
+				description: "The ID of the plan.",
+			},
+			{
+				name: "feature_quantities",
+				type: "json",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "version",
+				type: "number",
+				required: false,
+				description: "The version of the plan to attach.",
+			},
+			{
+				name: "free_trial",
+				type: "json",
+				required: false,
+				description:
+					"Free trial for this plan. A shorthand for customize.free_trial, which takes precedence when both are given.",
+			},
+			{
+				name: "customize",
+				type: "json",
+				required: false,
+				description:
+					"Customize the plan to attach. Can override the price, items, licenses, free trial, or a combination.",
+			},
+			{
+				name: "invoice_mode",
+				type: "json",
+				required: false,
+				description:
+					"Invoice mode creates a draft or open invoice and sends it to the customer, instead of charging their card immediately. This uses Stripe's send_invoice collection method.",
+			},
+			{
+				name: "proration_behavior",
+				type: "string",
+				required: false,
+				description:
+					"How to handle proration when updating an existing subscription. 'prorate_immediately' charges/credits prorated amounts now, 'none' skips creating any charges.",
+			},
+			{
+				name: "redirect_mode",
+				type: "string",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "subscription_id",
+				type: "string",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "discounts",
+				type: "json",
+				required: false,
+				description:
+					"List of discounts to apply. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code.",
+			},
+			{
+				name: "success_url",
+				type: "string",
+				required: false,
+				description: "URL to redirect to after successful checkout.",
+			},
+			{
+				name: "new_billing_subscription",
+				type: "boolean",
+				required: false,
+				description:
+					"Only applicable when the customer has an existing Stripe subscription. If true, creates a new separate subscription instead of merging into the existing one.",
+			},
+			{
+				name: "billing_cycle_anchor",
+				type: "json",
+				required: false,
+				description:
+					"Reset the billing cycle immediately with 'now', or schedule a reset at a future Unix timestamp in milliseconds.",
+			},
+			{
+				name: "plan_schedule",
+				type: "string",
+				required: false,
+				description:
+					"When the plan change should take effect. 'immediate' applies now, 'end_of_cycle' schedules for the end of the current billing cycle. By default, upgrades are immediate and downgrades are scheduled.",
+			},
+			{
+				name: "starts_at",
+				type: "number",
+				required: false,
+				description:
+					"Unix timestamp in milliseconds for when the attached plan should start. Future dates create a scheduled subscription.",
+			},
+			{
+				name: "ends_at",
+				type: "number",
+				required: false,
+				description:
+					"Unix timestamp in milliseconds for when the attached plan should end.",
+			},
+			{
+				name: "checkout_session_params",
+				type: "json",
+				required: false,
+				description:
+					"Additional parameters to pass into the creation of the Stripe checkout session.",
+			},
+			{
+				name: "long_lived_checkout",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, returns an Autumn-hosted checkout link that can create a fresh Stripe checkout session when opened.",
+			},
+			{
+				name: "custom_line_items",
+				type: "json",
+				required: false,
+				description:
+					"Custom line items that override the auto-generated proration invoice. Only valid for immediate plan changes (eg. upgrades or one off plans).",
+			},
+			{
+				name: "processor_subscription_id",
+				type: "string",
+				required: false,
+				description:
+					"The processor subscription ID to link. Use this to attach an existing Stripe subscription instead of creating a new one.",
+			},
+			{
+				name: "carry_over_balances",
+				type: "json",
+				required: false,
+				description: "Whether to carry over balances from the previous plan.",
+			},
+			{
+				name: "carry_over_usages",
+				type: "json",
+				required: false,
+				description: "Whether to carry over usages from the previous plan.",
+			},
+			{
+				name: "license_quantities",
+				type: "json",
+				required: false,
+				description:
+					"Seat quantities for the plan's licenses, keyed by license plan.",
+			},
+			{
+				name: "metadata",
+				type: "json",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "no_billing_changes",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, skips any billing changes for the attach operation.",
+			},
+			{
+				name: "enable_plan_immediately",
+				type: "boolean",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "tax_rate_id",
+				type: "string",
+				required: false,
+				description:
+					"Stripe tax rate ID (txr_...) to apply as the default tax rate on the created subscription, invoice, or checkout session line items.",
+			},
+			{
+				name: "currency",
+				type: "string",
+				required: false,
+				description:
+					"Currency to bill this attach in (e.g. usd, eur). Must match the customer's currency if they are already locked to one, and the plan must offer a paid price in it. Defaults to the customer's currency, then the org default.",
+			},
+			{
+				name: "remove_plan_ids",
+				type: "json",
+				required: false,
+				description:
+					"Plan IDs to expire on the customer as part of this attach. Each must be an active plan billed on the same subscription as the attach (or a free plan); plans on a separate subscription are rejected.",
+			},
+		],
+	},
+	{
+		group: "billing",
+		method: "create_schedule",
+		path: "/v1/billing.create_schedule",
+		description:
+			"Creates a multi-phase subscription schedule for a customer. The first phase starts immediately and subsequent phases automatically transition at their scheduled start times.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The ID of the customer to create the schedule for.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+				description: "Optional entity ID for an entity-scoped schedule.",
+			},
+			{
+				name: "free_trial",
+				type: "json",
+				required: false,
+				description:
+					"Free trial configuration applied to every plan in the immediate phase.",
+			},
+			{
+				name: "currency",
+				type: "string",
+				required: false,
+				description:
+					"Three-letter Stripe-supported currency code used to bill the immediate phase (for example, 'usd').",
+			},
+			{
+				name: "invoice_mode",
+				type: "json",
+				required: false,
+				description:
+					"Invoice mode creates and sends an invoice instead of charging the customer's payment method immediately for the first phase.",
+			},
+			{
+				name: "discounts",
+				type: "json",
+				required: false,
+				description:
+					"List of discounts to apply to the immediate phase. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code.",
+			},
+			{
+				name: "success_url",
+				type: "string",
+				required: false,
+				description: "URL to redirect to after successful checkout.",
+			},
+			{
+				name: "checkout_session_params",
+				type: "json",
+				required: false,
+				description:
+					"Additional parameters to pass into the creation of the Stripe checkout session.",
+			},
+			{
+				name: "redirect_mode",
+				type: "string",
+				required: false,
+				description:
+					"Controls when to return a checkout URL for the immediate phase. 'always' forces a confirmation or checkout flow, 'if_required' only redirects when needed, and 'never' disables redirects.",
+			},
+			{
+				name: "billing_behavior",
+				type: "string",
+				required: false,
+				description:
+					"Whether to prorate the immediate phase. 'none' skips proration charges and credits.",
+			},
+			{
+				name: "no_billing_changes",
+				type: "boolean",
+				required: false,
+				description: "If true, skips any billing changes for the schedule.",
+			},
+			{
+				name: "billing_cycle_anchor",
+				type: "json",
+				required: false,
+				description:
+					"Pass 'now' to reset the billing cycle anchor of the immediate phase to the current time.",
+			},
+			{
+				name: "enable_plan_immediately",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, the immediate-phase cusProducts are activated immediately (and scheduled-phase cusProducts pre-inserted) even when payment is pending via Stripe checkout. The Autumn schedule rows are persisted on checkout.session.completed.",
+			},
+			{
+				name: "preserve_add_ons",
+				type: "boolean",
+				required: false,
+				description:
+					"Deprecated and ignored. Active plans the schedule does not declare are always retained.",
+			},
+			{
+				name: "unscheduled_plans",
+				type: "json",
+				required: false,
+				description:
+					"Plans billed with the immediate phase that the schedule never expires or replaces. No phase may declare a plan in the same group and scope.",
+			},
+			{
+				name: "phases",
+				type: "json",
+				required: true,
+				description: "Ordered phase definitions for the schedule.",
+			},
+		],
+	},
+	{
+		group: "billing",
+		method: "multi_attach",
+		path: "/v1/billing.multi_attach",
+		description:
+			"Attaches multiple plans to a customer in a single request. Creates a single Stripe subscription with all plans consolidated.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The ID of the customer to attach the plans to.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+				description: "The ID of the entity to attach the plans to.",
+			},
+			{
+				name: "plans",
+				type: "json",
+				required: true,
+				description: "The list of plans to attach to the customer.",
+			},
+			{
+				name: "free_trial",
+				type: "json",
+				required: false,
+				description:
+					"Free trial configuration applied to all plans. Pass an object to set a custom trial, or null to remove any trial.",
+			},
+			{
+				name: "starts_at",
+				type: "number",
+				required: false,
+				description:
+					"Unix timestamp in milliseconds for backdating every plan in this multi-attach.",
+			},
+			{
+				name: "currency",
+				type: "string",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "invoice_mode",
+				type: "json",
+				required: false,
+				description:
+					"Invoice mode creates a draft or open invoice and sends it to the customer, instead of charging their card immediately.",
+			},
+			{
+				name: "discounts",
+				type: "json",
+				required: false,
+				description:
+					"List of discounts to apply. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code.",
+			},
+			{
+				name: "billing_behavior",
+				type: "string",
+				required: false,
+				description:
+					"How to handle billing. 'prorate_immediately' charges/credits prorated amounts now, 'none' does not charge/credit anything.",
+			},
+			{
+				name: "billing_cycle_anchor",
+				type: "json",
+				required: false,
+				description:
+					"Pass 'now' to reset the billing cycle of every plan on the subscription to the time of this request.",
+			},
+			{
+				name: "success_url",
+				type: "string",
+				required: false,
+				description: "URL to redirect to after successful checkout.",
+			},
+			{
+				name: "checkout_session_params",
+				type: "json",
+				required: false,
+				description:
+					"Additional parameters to pass into the creation of the Stripe checkout session.",
+			},
+			{
+				name: "redirect_mode",
+				type: "string",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "new_billing_subscription",
+				type: "boolean",
+				required: false,
+				description:
+					"Only applicable when the customer has an existing Stripe subscription. If true, creates a new separate subscription instead of merging into the existing one.",
+			},
+			{
+				name: "enable_plan_immediately",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, the cusProducts are activated immediately even when payment is pending via Stripe checkout.",
+			},
+			{
+				name: "customer_data",
+				type: "json",
+				required: false,
+			},
+			{
+				name: "entity_data",
+				type: "json",
+				required: false,
+			},
+		],
+	},
+	{
+		group: "billing",
+		method: "preview_attach",
+		path: "/v1/billing.preview_attach",
+		description:
+			"Previews the billing changes that would occur when attaching a plan, without actually making any changes.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The ID of the customer to attach the plan to.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+				description: "The ID of the entity to attach the plan to.",
+			},
+			{
+				name: "plan_id",
+				type: "string",
+				required: true,
+				description: "The ID of the plan.",
+			},
+			{
+				name: "feature_quantities",
+				type: "json",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "version",
+				type: "number",
+				required: false,
+				description: "The version of the plan to attach.",
+			},
+			{
+				name: "free_trial",
+				type: "json",
+				required: false,
+				description:
+					"Free trial for this plan. A shorthand for customize.free_trial, which takes precedence when both are given.",
+			},
+			{
+				name: "customize",
+				type: "json",
+				required: false,
+				description:
+					"Customize the plan to attach. Can override the price, items, licenses, free trial, or a combination.",
+			},
+			{
+				name: "invoice_mode",
+				type: "json",
+				required: false,
+				description:
+					"Invoice mode creates a draft or open invoice and sends it to the customer, instead of charging their card immediately. This uses Stripe's send_invoice collection method.",
+			},
+			{
+				name: "proration_behavior",
+				type: "string",
+				required: false,
+				description:
+					"How to handle proration when updating an existing subscription. 'prorate_immediately' charges/credits prorated amounts now, 'none' skips creating any charges.",
+			},
+			{
+				name: "redirect_mode",
+				type: "string",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "subscription_id",
+				type: "string",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "discounts",
+				type: "json",
+				required: false,
+				description:
+					"List of discounts to apply. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code.",
+			},
+			{
+				name: "success_url",
+				type: "string",
+				required: false,
+				description: "URL to redirect to after successful checkout.",
+			},
+			{
+				name: "new_billing_subscription",
+				type: "boolean",
+				required: false,
+				description:
+					"Only applicable when the customer has an existing Stripe subscription. If true, creates a new separate subscription instead of merging into the existing one.",
+			},
+			{
+				name: "billing_cycle_anchor",
+				type: "json",
+				required: false,
+				description:
+					"Reset the billing cycle immediately with 'now', or schedule a reset at a future Unix timestamp in milliseconds.",
+			},
+			{
+				name: "plan_schedule",
+				type: "string",
+				required: false,
+				description:
+					"When the plan change should take effect. 'immediate' applies now, 'end_of_cycle' schedules for the end of the current billing cycle. By default, upgrades are immediate and downgrades are scheduled.",
+			},
+			{
+				name: "starts_at",
+				type: "number",
+				required: false,
+				description:
+					"Unix timestamp in milliseconds for when the attached plan should start. Future dates create a scheduled subscription.",
+			},
+			{
+				name: "ends_at",
+				type: "number",
+				required: false,
+				description:
+					"Unix timestamp in milliseconds for when the attached plan should end.",
+			},
+			{
+				name: "checkout_session_params",
+				type: "json",
+				required: false,
+				description:
+					"Additional parameters to pass into the creation of the Stripe checkout session.",
+			},
+			{
+				name: "long_lived_checkout",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, returns an Autumn-hosted checkout link that can create a fresh Stripe checkout session when opened.",
+			},
+			{
+				name: "custom_line_items",
+				type: "json",
+				required: false,
+				description:
+					"Custom line items that override the auto-generated proration invoice. Only valid for immediate plan changes (eg. upgrades or one off plans).",
+			},
+			{
+				name: "processor_subscription_id",
+				type: "string",
+				required: false,
+				description:
+					"The processor subscription ID to link. Use this to attach an existing Stripe subscription instead of creating a new one.",
+			},
+			{
+				name: "carry_over_balances",
+				type: "json",
+				required: false,
+				description: "Whether to carry over balances from the previous plan.",
+			},
+			{
+				name: "carry_over_usages",
+				type: "json",
+				required: false,
+				description: "Whether to carry over usages from the previous plan.",
+			},
+			{
+				name: "license_quantities",
+				type: "json",
+				required: false,
+				description:
+					"Seat quantities for the plan's licenses, keyed by license plan.",
+			},
+			{
+				name: "metadata",
+				type: "json",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "no_billing_changes",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, skips any billing changes for the attach operation.",
+			},
+			{
+				name: "enable_plan_immediately",
+				type: "boolean",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "tax_rate_id",
+				type: "string",
+				required: false,
+				description:
+					"Stripe tax rate ID (txr_...) to apply as the default tax rate on the created subscription, invoice, or checkout session line items.",
+			},
+			{
+				name: "currency",
+				type: "string",
+				required: false,
+				description:
+					"Currency to bill this attach in (e.g. usd, eur). Must match the customer's currency if they are already locked to one, and the plan must offer a paid price in it. Defaults to the customer's currency, then the org default.",
+			},
+			{
+				name: "remove_plan_ids",
+				type: "json",
+				required: false,
+				description:
+					"Plan IDs to expire on the customer as part of this attach. Each must be an active plan billed on the same subscription as the attach (or a free plan); plans on a separate subscription are rejected.",
+			},
+		],
+	},
+	{
+		group: "billing",
+		method: "preview_multi_attach",
+		path: "/v1/billing.preview_multi_attach",
+		description:
+			"Previews the billing changes that would occur when attaching multiple plans, without actually making any changes.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The ID of the customer to attach the plans to.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+				description: "The ID of the entity to attach the plans to.",
+			},
+			{
+				name: "plans",
+				type: "json",
+				required: true,
+				description: "The list of plans to attach to the customer.",
+			},
+			{
+				name: "free_trial",
+				type: "json",
+				required: false,
+				description:
+					"Free trial configuration applied to all plans. Pass an object to set a custom trial, or null to remove any trial.",
+			},
+			{
+				name: "starts_at",
+				type: "number",
+				required: false,
+				description:
+					"Unix timestamp in milliseconds for backdating every plan in this multi-attach.",
+			},
+			{
+				name: "currency",
+				type: "string",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "invoice_mode",
+				type: "json",
+				required: false,
+				description:
+					"Invoice mode creates a draft or open invoice and sends it to the customer, instead of charging their card immediately.",
+			},
+			{
+				name: "discounts",
+				type: "json",
+				required: false,
+				description:
+					"List of discounts to apply. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code.",
+			},
+			{
+				name: "billing_behavior",
+				type: "string",
+				required: false,
+				description:
+					"How to handle billing. 'prorate_immediately' charges/credits prorated amounts now, 'none' does not charge/credit anything.",
+			},
+			{
+				name: "billing_cycle_anchor",
+				type: "json",
+				required: false,
+				description:
+					"Pass 'now' to reset the billing cycle of every plan on the subscription to the time of this request.",
+			},
+			{
+				name: "success_url",
+				type: "string",
+				required: false,
+				description: "URL to redirect to after successful checkout.",
+			},
+			{
+				name: "checkout_session_params",
+				type: "json",
+				required: false,
+				description:
+					"Additional parameters to pass into the creation of the Stripe checkout session.",
+			},
+			{
+				name: "redirect_mode",
+				type: "string",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "new_billing_subscription",
+				type: "boolean",
+				required: false,
+				description:
+					"Only applicable when the customer has an existing Stripe subscription. If true, creates a new separate subscription instead of merging into the existing one.",
+			},
+			{
+				name: "enable_plan_immediately",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, the cusProducts are activated immediately even when payment is pending via Stripe checkout.",
+			},
+			{
+				name: "customer_data",
+				type: "json",
+				required: false,
+			},
+			{
+				name: "entity_data",
+				type: "json",
+				required: false,
+			},
+		],
+	},
+	{
+		group: "billing",
+		method: "update",
+		path: "/v1/billing.update",
+		description:
+			"Updates an existing subscription. Use to modify feature quantities, cancel, or change plan configuration.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The ID of the customer to attach the plan to.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+				description: "The ID of the entity to attach the plan to.",
+			},
+			{
+				name: "plan_id",
+				type: "string",
+				required: false,
+				description:
+					"The ID of the plan to update. Optional if subscription_id is provided, or if the customer has only one product.",
+			},
+			{
+				name: "feature_quantities",
+				type: "json",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "version",
+				type: "number",
+				required: false,
+				description: "The version of the plan to attach.",
+			},
+			{
+				name: "free_trial",
+				type: "json",
+				required: false,
+				description:
+					"Free trial for this plan. A shorthand for customize.free_trial, which takes precedence when both are given.",
+			},
+			{
+				name: "customize",
+				type: "json",
+				required: false,
+				description:
+					"Customize the plan to attach. Can override the price, items, licenses, free trial, or a combination.",
+			},
+			{
+				name: "invoice_mode",
+				type: "json",
+				required: false,
+				description:
+					"Invoice mode creates a draft or open invoice and sends it to the customer, instead of charging their card immediately. This uses Stripe's send_invoice collection method.",
+			},
+			{
+				name: "proration_behavior",
+				type: "string",
+				required: false,
+				description:
+					"How to handle proration when updating an existing subscription. 'prorate_immediately' charges/credits prorated amounts now, 'none' skips creating any charges.",
+			},
+			{
+				name: "redirect_mode",
+				type: "string",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "subscription_id",
+				type: "string",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "discounts",
+				type: "json",
+				required: false,
+				description:
+					"List of discounts to apply. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code.",
+			},
+			{
+				name: "cancel_action",
+				type: "string",
+				required: false,
+				description:
+					"Action to perform for cancellation. 'cancel_immediately' cancels now with prorated refund, 'cancel_end_of_cycle' cancels at period end, 'uncancel' reverses a pending cancellation.",
+			},
+			{
+				name: "billing_cycle_anchor",
+				type: "json",
+				required: false,
+				description:
+					"Reset the billing cycle immediately with 'now', or schedule a reset at a future Unix timestamp in milliseconds.",
+			},
+			{
+				name: "no_billing_changes",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, the subscription is updated internally without applying billing changes in Stripe.",
+			},
+			{
+				name: "refund_last_payment",
+				type: "string",
+				required: false,
+				description:
+					"Controls how the last payment is refunded on immediate cancellation. 'prorated' refunds the unused portion, 'full' refunds the entire last payment.",
+			},
+			{
+				name: "subscription_params",
+				type: "json",
+				required: false,
+				description:
+					"Additional parameters to pass into the Stripe subscription update or cancel call.",
+			},
+			{
+				name: "recalculate_balances",
+				type: "json",
+				required: false,
+				description:
+					"Controls whether balances should be recalculated during the subscription update.",
+			},
+			{
+				name: "carry_over_usages",
+				type: "json",
+				required: false,
+				description: "Whether to carry over usages from the previous plan.",
+			},
+			{
+				name: "license_quantities",
+				type: "json",
+				required: false,
+				description:
+					"Total seat quantities (inclusive of the license's included count) per license plan offered by this plan. Licenses not listed keep their current paid quantity.",
+			},
+			{
+				name: "custom_line_items",
+				type: "json",
+				required: false,
+				description:
+					"Custom line items that replace the auto-generated proration invoice, or bill a standalone invoice when nothing else changes. Only valid on an existing recurring subscription.",
+			},
+		],
+	},
+	{
+		group: "billing",
+		method: "preview_update",
+		path: "/v1/billing.preview_update",
+		description:
+			"Previews the billing changes that would occur when updating a subscription, without actually making any changes.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The ID of the customer to attach the plan to.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+				description: "The ID of the entity to attach the plan to.",
+			},
+			{
+				name: "plan_id",
+				type: "string",
+				required: false,
+				description:
+					"The ID of the plan to update. Optional if subscription_id is provided, or if the customer has only one product.",
+			},
+			{
+				name: "feature_quantities",
+				type: "json",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "version",
+				type: "number",
+				required: false,
+				description: "The version of the plan to attach.",
+			},
+			{
+				name: "free_trial",
+				type: "json",
+				required: false,
+				description:
+					"Free trial for this plan. A shorthand for customize.free_trial, which takes precedence when both are given.",
+			},
+			{
+				name: "customize",
+				type: "json",
+				required: false,
+				description:
+					"Customize the plan to attach. Can override the price, items, licenses, free trial, or a combination.",
+			},
+			{
+				name: "invoice_mode",
+				type: "json",
+				required: false,
+				description:
+					"Invoice mode creates a draft or open invoice and sends it to the customer, instead of charging their card immediately. This uses Stripe's send_invoice collection method.",
+			},
+			{
+				name: "proration_behavior",
+				type: "string",
+				required: false,
+				description:
+					"How to handle proration when updating an existing subscription. 'prorate_immediately' charges/credits prorated amounts now, 'none' skips creating any charges.",
+			},
+			{
+				name: "redirect_mode",
+				type: "string",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "subscription_id",
+				type: "string",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "discounts",
+				type: "json",
+				required: false,
+				description:
+					"List of discounts to apply. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code.",
+			},
+			{
+				name: "cancel_action",
+				type: "string",
+				required: false,
+				description:
+					"Action to perform for cancellation. 'cancel_immediately' cancels now with prorated refund, 'cancel_end_of_cycle' cancels at period end, 'uncancel' reverses a pending cancellation.",
+			},
+			{
+				name: "billing_cycle_anchor",
+				type: "json",
+				required: false,
+				description:
+					"Reset the billing cycle immediately with 'now', or schedule a reset at a future Unix timestamp in milliseconds.",
+			},
+			{
+				name: "no_billing_changes",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, the subscription is updated internally without applying billing changes in Stripe.",
+			},
+			{
+				name: "refund_last_payment",
+				type: "string",
+				required: false,
+				description:
+					"Controls how the last payment is refunded on immediate cancellation. 'prorated' refunds the unused portion, 'full' refunds the entire last payment.",
+			},
+			{
+				name: "subscription_params",
+				type: "json",
+				required: false,
+				description:
+					"Additional parameters to pass into the Stripe subscription update or cancel call.",
+			},
+			{
+				name: "recalculate_balances",
+				type: "json",
+				required: false,
+				description:
+					"Controls whether balances should be recalculated during the subscription update.",
+			},
+			{
+				name: "carry_over_usages",
+				type: "json",
+				required: false,
+				description: "Whether to carry over usages from the previous plan.",
+			},
+			{
+				name: "license_quantities",
+				type: "json",
+				required: false,
+				description:
+					"Total seat quantities (inclusive of the license's included count) per license plan offered by this plan. Licenses not listed keep their current paid quantity.",
+			},
+			{
+				name: "custom_line_items",
+				type: "json",
+				required: false,
+				description:
+					"Custom line items that replace the auto-generated proration invoice, or bill a standalone invoice when nothing else changes. Only valid on an existing recurring subscription.",
+			},
+		],
+	},
+	{
+		group: "billing",
+		method: "multi_update",
+		path: "/v1/billing.multi_update",
+		description:
+			"Updates multiple plans on a customer in a single request. Currently supports cancel actions (immediately, end of cycle, or uncancel) across one or more subscriptions.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The ID of the customer to update plans for.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+				description:
+					"The ID of the entity to update plans for. Individual updates can override this with their own entity_id.",
+			},
+			{
+				name: "refund_last_payment",
+				type: "string",
+				required: false,
+				description:
+					"Controls how the last payment is refunded on immediate cancellation. 'prorated' refunds the unused portion, 'full' refunds the entire last payment.",
+			},
+			{
+				name: "subscription_params",
+				type: "json",
+				required: false,
+				description:
+					"Additional parameters to pass into the Stripe subscription update or cancel call.",
+			},
+			{
+				name: "updates",
+				type: "json",
+				required: true,
+				description: "The list of plan updates to apply to the customer.",
+			},
+		],
+	},
+	{
+		group: "billing",
+		method: "preview_multi_update",
+		path: "/v1/billing.preview_multi_update",
+		description:
+			"Previews the billing changes of a multi-plan update without making any changes. Returns one core preview per affected subscription.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The ID of the customer to update plans for.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+				description:
+					"The ID of the entity to update plans for. Individual updates can override this with their own entity_id.",
+			},
+			{
+				name: "refund_last_payment",
+				type: "string",
+				required: false,
+				description:
+					"Controls how the last payment is refunded on immediate cancellation. 'prorated' refunds the unused portion, 'full' refunds the entire last payment.",
+			},
+			{
+				name: "subscription_params",
+				type: "json",
+				required: false,
+				description:
+					"Additional parameters to pass into the Stripe subscription update or cancel call.",
+			},
+			{
+				name: "updates",
+				type: "json",
+				required: true,
+				description: "The list of plan updates to apply to the customer.",
+			},
+		],
+	},
+	{
+		group: "billing",
+		method: "open_customer_portal",
+		path: "/v1/billing.open_customer_portal",
+		description:
+			"Create a billing portal session for a customer to manage their subscription.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The ID of the customer to open the billing portal for.",
+			},
+			{
+				name: "configuration_id",
+				type: "string",
+				required: false,
+				description:
+					"Stripe billing portal configuration ID. Create configurations in your Stripe dashboard.",
+			},
+			{
+				name: "return_url",
+				type: "string",
+				required: false,
+				description:
+					"URL to redirect to when back button is clicked in the billing portal",
+			},
+		],
+	},
+	{
+		group: "billing",
+		method: "setup_payment",
+		path: "/v1/billing.setup_payment",
+		description:
+			"Create a payment setup session for a customer to add or update their payment method.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The ID of the customer to attach the plan to.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+				description: "The ID of the entity to attach the plan to.",
+			},
+			{
+				name: "plan_id",
+				type: "string",
+				required: false,
+				description:
+					"If specified, the plan will be attached to the customer after setup.",
+			},
+			{
+				name: "feature_quantities",
+				type: "json",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "version",
+				type: "number",
+				required: false,
+				description: "The version of the plan to attach.",
+			},
+			{
+				name: "free_trial",
+				type: "json",
+				required: false,
+				description:
+					"Free trial for this plan. A shorthand for customize.free_trial, which takes precedence when both are given.",
+			},
+			{
+				name: "customize",
+				type: "json",
+				required: false,
+				description:
+					"Customize the plan to attach. Can override the price, items, licenses, free trial, or a combination.",
+			},
+			{
+				name: "proration_behavior",
+				type: "string",
+				required: false,
+				description:
+					"How to handle proration when updating an existing subscription. 'prorate_immediately' charges/credits prorated amounts now, 'none' skips creating any charges.",
+			},
+			{
+				name: "subscription_id",
+				type: "string",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "discounts",
+				type: "json",
+				required: false,
+				description:
+					"List of discounts to apply. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code.",
+			},
+			{
+				name: "success_url",
+				type: "string",
+				required: false,
+				description: "URL to redirect to after successful checkout.",
+			},
+			{
+				name: "billing_cycle_anchor",
+				type: "json",
+				required: false,
+				description:
+					"Reset the billing cycle immediately with 'now', or schedule a reset at a future Unix timestamp in milliseconds.",
+			},
+			{
+				name: "starts_at",
+				type: "number",
+				required: false,
+				description:
+					"Unix timestamp in milliseconds for when the attached plan should start. Future dates create a scheduled subscription.",
+			},
+			{
+				name: "ends_at",
+				type: "number",
+				required: false,
+				description:
+					"Unix timestamp in milliseconds for when the attached plan should end.",
+			},
+			{
+				name: "checkout_session_params",
+				type: "json",
+				required: false,
+				description:
+					"Additional parameters to pass into the creation of the Stripe checkout session.",
+			},
+			{
+				name: "custom_line_items",
+				type: "json",
+				required: false,
+				description:
+					"Custom line items that override the auto-generated proration invoice. Only valid for immediate plan changes (eg. upgrades or one off plans).",
+			},
+			{
+				name: "processor_subscription_id",
+				type: "string",
+				required: false,
+				description:
+					"The processor subscription ID to link. Use this to attach an existing Stripe subscription instead of creating a new one.",
+			},
+			{
+				name: "carry_over_balances",
+				type: "json",
+				required: false,
+				description: "Whether to carry over balances from the previous plan.",
+			},
+			{
+				name: "carry_over_usages",
+				type: "json",
+				required: false,
+				description: "Whether to carry over usages from the previous plan.",
+			},
+			{
+				name: "license_quantities",
+				type: "json",
+				required: false,
+				description:
+					"Seat quantities for the plan's licenses, keyed by license plan.",
+			},
+			{
+				name: "metadata",
+				type: "json",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "no_billing_changes",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, skips any billing changes for the attach operation.",
+			},
+			{
+				name: "enable_plan_immediately",
+				type: "boolean",
+				required: false,
+				description:
+					"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.",
+			},
+			{
+				name: "tax_rate_id",
+				type: "string",
+				required: false,
+				description:
+					"Stripe tax rate ID (txr_...) to apply as the default tax rate on the created subscription, invoice, or checkout session line items.",
+			},
+			{
+				name: "currency",
+				type: "string",
+				required: false,
+				description:
+					"Currency to bill this attach in (e.g. usd, eur). Must match the customer's currency if they are already locked to one, and the plan must offer a paid price in it. Defaults to the customer's currency, then the org default.",
+			},
+			{
+				name: "remove_plan_ids",
+				type: "json",
+				required: false,
+				description:
+					"Plan IDs to expire on the customer as part of this attach. Each must be an active plan billed on the same subscription as the attach (or a free plan); plans on a separate subscription are rejected.",
+			},
+		],
+	},
+	{
+		group: "billing",
+		method: "import",
+		path: "/v1/billing.import",
+		description:
+			"Image a customer into Autumn for live migration. Read-only against processors.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "Autumn customer to image into.",
+			},
+			{
+				name: "customer_data",
+				type: "json",
+				required: false,
+				description:
+					"Optional identity fields upserted onto the customer (applied to existing customers too).",
+			},
+			{
+				name: "processors",
+				type: "json",
+				required: false,
+				description:
+					"The customer's processor identities (e.g. Stripe customer id, RevenueCat app_user_id). Omit for customers with no processor, e.g. those only ever on a free plan.",
+			},
+			{
+				name: "billables",
+				type: "json",
+				required: true,
+				description:
+					"The billing objects (subscriptions, one-offs) to image, each carrying its plan.",
+			},
+			{
+				name: "dry_run",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, validate and compute without persisting; returns what would be flashed.",
+			},
+		],
+	},
+	{
+		group: "balances",
+		method: "create",
+		path: "/v1/balances.create",
+		description: "Create a balance for a customer feature.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The ID of the customer.",
+			},
+			{
+				name: "feature_id",
+				type: "string",
+				required: true,
+				description: "The ID of the feature.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+				description:
+					"The ID of the entity for entity-scoped balances (e.g., per-seat limits).",
+			},
+			{
+				name: "included_grant",
+				type: "number",
+				required: false,
+				description:
+					"The initial balance amount to grant. For metered features, this is the number of units the customer can use.",
+			},
+			{
+				name: "unlimited",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, the balance has unlimited usage. Cannot be combined with 'included_grant'.",
+			},
+			{
+				name: "reset",
+				type: "json",
+				required: false,
+				description:
+					"Reset configuration for the balance. If not provided, the balance is a one-time grant that never resets.",
+			},
+			{
+				name: "rollover",
+				type: "json",
+				required: false,
+				description: "Rollover configuration for the balance.",
+			},
+			{
+				name: "expires_at",
+				type: "number",
+				required: false,
+				description:
+					"Unix timestamp (milliseconds) when the balance expires. Mutually exclusive with reset.",
+			},
+			{
+				name: "next_reset_at",
+				type: "number",
+				required: false,
+				description:
+					"Unix timestamp (milliseconds) for the first reset boundary, allowing a custom (e.g. shorter) first period. Requires 'reset', and must occur before 'expires_at' if both are provided. Subsequent resets advance by one reset interval from this boundary.",
+			},
+			{
+				name: "balance_id",
+				type: "string",
+				required: false,
+				description:
+					"A unique identifier for this balance. Use this to target the balance in future update / delete calls.",
+			},
+		],
+	},
+	{
+		group: "balances",
+		method: "update",
+		path: "/v1/balances.update",
+		description: "Update a customer balance.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The ID of the customer.",
+			},
+			{
+				name: "feature_id",
+				type: "string",
+				required: true,
+				description: "The ID of the feature.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+				description:
+					"The ID of the entity for entity-scoped balances (e.g., per-seat limits).",
+			},
+			{
+				name: "remaining",
+				type: "number",
+				required: false,
+				description:
+					"Set the remaining balance to this exact value. Cannot be combined with add_to_balance.",
+			},
+			{
+				name: "add_to_balance",
+				type: "number",
+				required: false,
+				description:
+					"Add this amount to the current balance. Use negative values to subtract. Cannot be combined with current_balance.",
+			},
+			{
+				name: "usage",
+				type: "number",
+				required: false,
+				description:
+					"The usage amount to update. Cannot be combined with remaining or add_to_balance.",
+			},
+			{
+				name: "interval",
+				type: "string",
+				required: false,
+				description:
+					"Target a specific balance by its reset interval. Use when the customer has multiple balances for the same feature with different reset intervals.",
+			},
+			{
+				name: "included_grant",
+				type: "number",
+				required: false,
+				description: "Set the granted balance to this exact value.",
+			},
+			{
+				name: "balance_id",
+				type: "string",
+				required: false,
+				description:
+					"Target a specific balance by its ID (set on create). Use when the customer has multiple balances for the same feature.",
+			},
+			{
+				name: "next_reset_at",
+				type: "number",
+				required: false,
+				description:
+					"The next reset time for the balance. If there are multiple breakdowns, this will update the breakdown with the next reset time.",
+			},
+			{
+				name: "expires_at",
+				type: "number",
+				required: false,
+				description:
+					"Unix timestamp (milliseconds) when the balance expires. Targets a specific balance via balance_id / interval when the customer has multiple balances for the same feature.",
+			},
+		],
+	},
+	{
+		group: "balances",
+		method: "delete",
+		path: "/v1/balances.delete",
+		description:
+			"Delete a balance for a customer feature. Can only delete a balance that is not attached to a price (eg. you cannot delete messages that have an overage price).",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The ID of the customer.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+				description: "The ID of the entity.",
+			},
+			{
+				name: "feature_id",
+				type: "string",
+				required: false,
+				description: "The ID of the feature.",
+			},
+			{
+				name: "balance_id",
+				type: "string",
+				required: false,
+				description: "The ID of the balance to delete.",
+			},
+			{
+				name: "recalculate_balances",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, deduct the deleted balance's remaining amount from the customer's other balances for the same feature after deletion.",
+			},
+			{
+				name: "interval",
+				type: "string",
+				required: false,
+				description:
+					"Target a specific balance by its reset interval. Use when the customer has multiple balances for the same feature with different reset intervals.",
+			},
+		],
+	},
+	{
+		group: "balances",
+		method: "finalize",
+		path: "/v1/balances.finalize",
+		description:
+			"Finalize a previously locked balance. Use 'confirm' to commit the deduction, or 'release' to return the held balance.",
+		body: "object",
+		fields: [
+			{
+				name: "lock_id",
+				type: "string",
+				required: true,
+				description:
+					"The lock ID that was passed into the previous check call.",
+			},
+			{
+				name: "action",
+				type: "string",
+				required: true,
+				description:
+					"Use 'confirm' to commit the deduction, or 'release' to return the held balance.",
+			},
+			{
+				name: "override_value",
+				type: "number",
+				required: false,
+				description:
+					"Additional properties to attach to this finalize lock event.",
+			},
+			{
+				name: "properties",
+				type: "json",
+				required: false,
+				description:
+					"Additional properties to attach to this finalize lock event.",
+			},
+		],
+	},
+	{
+		group: "balances",
+		method: "check",
+		path: "/v1/balances.check",
+		description:
+			"Checks whether a customer currently has enough balance to use a feature.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The ID of the customer.",
+			},
+			{
+				name: "feature_id",
+				type: "string",
+				required: true,
+				description: "The ID of the feature.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+				description:
+					"The ID of the entity for entity-scoped balances (e.g., per-seat limits).",
+			},
+			{
+				name: "required_balance",
+				type: "number",
+				required: false,
+				description:
+					"Minimum balance required for access. Returns allowed: false if the customer's balance is below this value. Defaults to 1.",
+			},
+			{
+				name: "properties",
+				type: "json",
+				required: false,
+				description:
+					"Additional properties to attach to the usage event if send_event is true.",
+			},
+			{
+				name: "send_event",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, atomically records a usage event while checking access. The required_balance value is used as the usage amount. Combines check + track in one call.",
+			},
+			{
+				name: "lock",
+				type: "json",
+				required: false,
+				description:
+					"Reserve units of a feature upfront by passing a lock_id, then call balances.finalize to confirm or release the hold.",
+			},
+			{
+				name: "with_preview",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, includes upgrade/upsell information in the response when access is denied. Useful for displaying paywalls.",
+			},
+		],
+	},
+	{
+		group: "balances",
+		method: "track",
+		path: "/v1/balances.track",
+		description:
+			"Records usage for a customer feature and returns updated balances.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The ID of the customer.",
+			},
+			{
+				name: "feature_id",
+				type: "string",
+				required: false,
+				description:
+					"The ID of the feature to track usage for. Required if event_name is not provided.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+				description:
+					"The ID of the entity for entity-scoped balances (e.g., per-seat limits).",
+			},
+			{
+				name: "event_name",
+				type: "string",
+				required: false,
+				description:
+					"Event name to track usage for. Use instead of feature_id when multiple features should be tracked from a single event.",
+			},
+			{
+				name: "value",
+				type: "number",
+				required: false,
+				description:
+					"The amount of usage to record. Defaults to 1. Use negative values to credit balance (e.g., when removing a seat).",
+			},
+			{
+				name: "properties",
+				type: "json",
+				required: false,
+				description: "Additional properties to attach to this usage event.",
+			},
+			{
+				name: "timestamp",
+				type: "number",
+				required: false,
+				description:
+					"Unix timestamp in milliseconds to use for the usage event. Defaults to the current time.",
+			},
+			{
+				name: "overage_behavior",
+				type: "string",
+				required: false,
+				description:
+					'How to handle usage that exceeds the available balance. "cap" (default) deducts only what fits, stopping at zero. "overflow" deducts the full value: the balance can go negative and usage limits do not clamp the deduction, though spend limits still apply.',
+			},
+			{
+				name: "async",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, enqueue the event for asynchronous processing and return 204 immediately. The response will not include balance information.",
+			},
+			{
+				name: "lock",
+				type: "json",
+				required: false,
+			},
+		],
+	},
+	{
+		group: "balances",
+		method: "track_tokens",
+		path: "/v1/balances.track_tokens",
+		description:
+			"Records AI token usage for a customer and returns the updated AI credit balance.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The ID of the customer.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+				description: "The ID of the entity for entity-scoped balances.",
+			},
+			{
+				name: "feature_id",
+				type: "string",
+				required: false,
+				description:
+					"The ID of the AI credit system feature. Auto-detected from the customer's entitlements if omitted — only required when a customer has multiple AI credit systems.",
+			},
+			{
+				name: "model_id",
+				type: "string",
+				required: true,
+				description:
+					"The AI model as '[provider]/[model]' (e.g. 'anthropic/claude-opus-4-8', 'openrouter/openai/gpt-4o'). The provider is the first path segment and must match a provider + model key in models.dev.",
+			},
+			{
+				name: "input_tokens",
+				type: "number",
+				required: true,
+				description:
+					"Number of non-cached text input tokens consumed. Exclusive of cache and audio token pools.",
+			},
+			{
+				name: "output_tokens",
+				type: "number",
+				required: true,
+				description:
+					"Number of text output tokens consumed. Exclusive of the reasoning and audio output pools.",
+			},
+			{
+				name: "cache_read_tokens",
+				type: "number",
+				required: false,
+				description: "Number of cached input tokens read.",
+			},
+			{
+				name: "cache_write_tokens",
+				type: "number",
+				required: false,
+				description: "Number of input tokens written to the cache.",
+			},
+			{
+				name: "audio_input_tokens",
+				type: "number",
+				required: false,
+				description: "Number of audio input tokens consumed.",
+			},
+			{
+				name: "audio_output_tokens",
+				type: "number",
+				required: false,
+				description: "Number of audio output tokens generated.",
+			},
+			{
+				name: "reasoning_tokens",
+				type: "number",
+				required: false,
+				description: "Number of reasoning tokens generated.",
+			},
+			{
+				name: "properties",
+				type: "json",
+				required: false,
+				description: "Additional properties to attach to this usage event.",
+			},
+			{
+				name: "timestamp",
+				type: "number",
+				required: false,
+				description:
+					"Unix timestamp in milliseconds to use for the usage event. Defaults to the current time.",
+			},
+			{
+				name: "overage_behavior",
+				type: "string",
+				required: false,
+				description:
+					'How to handle usage that exceeds the available balance. "cap" (default) deducts only what fits, stopping at zero. "overflow" deducts the full value: the balance can go negative and usage limits do not clamp the deduction, though spend limits still apply.',
+			},
+			{
+				name: "async",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, enqueue the event for asynchronous processing and return 204 immediately. The response will not include balance information.",
+			},
+		],
+	},
+	{
+		group: "balances",
+		method: "batch_track",
+		path: "/v1/balances.batch_track",
+		description:
+			"Enqueue up to 1000 usage events for asynchronous processing. Items are validated synchronously up front; validated items are then enqueued via SQS for background deduction by workers. The response returns 202 immediately and does not include balance information. On partial enqueue failure (some items fail to enqueue, others succeed), the endpoint still returns 202 and logs the failures server-side; clients should NOT retry, because retrying re-enqueues the already-succeeded items. A 503 is returned only when zero items were successfully enqueued (queue entirely unavailable) — that case is safe to retry.",
+		body: "array",
+		fields: [],
+	},
+	{
+		group: "events",
+		method: "list",
+		path: "/v1/events.list",
+		description:
+			"List usage events for your organization. Filter by customer, feature, or time range.",
+		body: "object",
+		fields: [
+			{
+				name: "start_cursor",
+				type: "string",
+				required: false,
+				description:
+					"Opaque pagination cursor. Empty string (default) requests the first page; use next_cursor from a prior response for subsequent pages.",
+			},
+			{
+				name: "limit",
+				type: "number",
+				required: false,
+				description:
+					"Number of items to return. Default 50, hard ceiling 5000.",
+			},
+			{
+				name: "customer_id",
+				type: "string",
+				required: false,
+				description: "Filter events by customer ID",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+				description:
+					"Filter events by entity ID (e.g., per-seat or per-resource)",
+			},
+			{
+				name: "feature_id",
+				type: "json",
+				required: false,
+				description: "Filter by specific feature ID(s)",
+			},
+			{
+				name: "custom_range",
+				type: "json",
+				required: false,
+				description: "Filter events by time range",
+			},
+		],
+	},
+	{
+		group: "events",
+		method: "aggregate",
+		path: "/v1/events.aggregate",
+		description:
+			"Aggregate usage events by time period. Returns usage totals grouped by feature and optionally by a custom property.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: false,
+				description: "Customer ID to aggregate events for",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+				description:
+					"Entity ID to filter aggregated events for (e.g., per-seat or per-resource limits)",
+			},
+			{
+				name: "feature_id",
+				type: "json",
+				required: true,
+				description: "Feature ID(s) to aggregate events for",
+			},
+			{
+				name: "group_by",
+				type: "string",
+				required: false,
+				description:
+					'Property to group events by (e.g. "properties.region"), or "$customer_id" / "$entity_id" / "$plan_id" to group by those columns. When aggregate_on is "deducted", "$feature_id" groups deductions by the tracked feature that consumed each balance.',
+			},
+			{
+				name: "range",
+				type: "string",
+				required: false,
+				description:
+					"Time range to aggregate events for. Either range or custom_range must be provided",
+			},
+			{
+				name: "bin_size",
+				type: "string",
+				required: false,
+				description:
+					"Size of the time bins to aggregate events for. Defaults to hour if range is 24h, otherwise day",
+			},
+			{
+				name: "custom_range",
+				type: "json",
+				required: false,
+				description:
+					"Custom time range to aggregate events for. If provided, range must not be provided",
+			},
+			{
+				name: "filter_by",
+				type: "json",
+				required: false,
+				description:
+					'Filter events by property values, e.g. {"model": "gpt-4", "region": "us"}. Maximum 5 filters.',
+			},
+			{
+				name: "max_groups",
+				type: "number",
+				required: false,
+				description:
+					"Maximum number of distinct group values to return per time bin when using group_by. Remaining values are bundled into an 'Other' bucket. Defaults to 9",
+			},
+			{
+				name: "aggregate_on",
+				type: "string",
+				required: false,
+				description:
+					'Set to "deducted" to additionally return a per-balance breakdown of what each event consumed, under `deductions`. Purely additive: `list` and `total` are unchanged. Requires customer_id.',
+			},
+		],
+	},
+	{
+		group: "invoices",
+		method: "insert",
+		path: "/v1/invoices.insert",
+		description:
+			"Inserts or updates up to 500 historical invoices without reading or mutating the billing processor.",
+		body: "object",
+		fields: [
+			{
+				name: "invoices",
+				type: "json",
+				required: true,
+				description: "Invoices to insert or update, in response order.",
+			},
+		],
+	},
+	{
+		group: "invoices",
+		method: "list",
+		path: "/v1/invoices.list",
+		description:
+			'Lists invoices with cursor pagination and optional filters (customer, entity, status, processor). Pass `start_cursor: ""` (or omit) for the first page; use `next_cursor` from a prior response for subsequent pages.',
+		body: "object",
+		fields: [
+			{
+				name: "start_cursor",
+				type: "string",
+				required: false,
+				description:
+					"Opaque pagination cursor. Empty string (default) requests the first page; use next_cursor from a prior response for subsequent pages.",
+			},
+			{
+				name: "limit",
+				type: "number",
+				required: false,
+				description:
+					"Number of items to return. Default 50, hard ceiling 5000.",
+			},
+			{
+				name: "customer_id",
+				type: "string",
+				required: false,
+				description: "Filter invoices to a single customer by ID.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+				description:
+					"Filter invoices to a single entity by ID. Must be provided together with customer_id, since entity IDs are only unique per customer.",
+			},
+			{
+				name: "status",
+				type: "json",
+				required: false,
+				description:
+					"Filter by invoice status (draft, open, paid, void, uncollectible).",
+			},
+			{
+				name: "processor_types",
+				type: "json",
+				required: false,
+				description:
+					"Filter by billing processor (stripe, revenuecat). Invoices recorded before processor tracking count as stripe.",
+			},
+		],
+	},
+	{
+		group: "invoices",
+		method: "pay",
+		path: "/v1/invoices.pay",
+		description:
+			"Marks an open Stripe invoice as paid out of band. No charge is attempted; use this when payment was collected elsewhere (e.g. a marketplace). Already-paid invoices are returned unchanged.",
+		body: "object",
+		fields: [
+			{
+				name: "invoice_id",
+				type: "string",
+				required: true,
+				description: "The Autumn invoice ID to mark as paid.",
+			},
+		],
+	},
+	{
+		group: "licenses",
+		method: "attach",
+		path: "/v1/licenses.attach",
+		description: "Assigns licenses to one or more entities.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+			},
+			{
+				name: "plan_id",
+				type: "string",
+				required: true,
+			},
+			{
+				name: "entities",
+				type: "json",
+				required: true,
+			},
+		],
+	},
+	{
+		group: "licenses",
+		method: "release",
+		path: "/v1/licenses.release",
+		description: "Releases licenses assigned to one or more entities.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+			},
+			{
+				name: "license_plan_id",
+				type: "string",
+				required: false,
+				description:
+					"Scopes the release when an entity holds licenses of multiple plans.",
+			},
+			{
+				name: "entity_ids",
+				type: "json",
+				required: true,
+			},
+		],
+	},
+	{
+		group: "licenses",
+		method: "list_assignments",
+		path: "/v1/licenses.list_assignments",
+		description: "Lists license assignments for a customer.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+			},
+			{
+				name: "plan_id",
+				type: "string",
+				required: false,
+			},
+			{
+				name: "active",
+				type: "boolean",
+				required: false,
+			},
+		],
+	},
+	{
+		group: "licenses",
+		method: "list",
+		path: "/v1/licenses.list",
+		description: "Lists a customer's license pools and available seats.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: false,
+			},
+		],
+	},
+	{
+		group: "entities",
+		method: "create",
+		path: "/v1/entities.create",
+		description:
+			"Creates an entity for a customer and feature, then returns the entity with balances and subscriptions.",
+		body: "object",
+		fields: [
+			{
+				name: "name",
+				type: "string",
+				required: false,
+				description: "The name of the entity",
+			},
+			{
+				name: "feature_id",
+				type: "string",
+				required: true,
+				description: "The ID of the feature this entity is associated with",
+			},
+			{
+				name: "billing_controls",
+				type: "json",
+				required: false,
+				description: "Billing controls for the entity.",
+			},
+			{
+				name: "customer_data",
+				type: "json",
+				required: false,
+				description:
+					"Customer attributes used to resolve the customer when customer_id is not provided.",
+			},
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The ID of the customer to create the entity for.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: true,
+				description: "The ID of the entity.",
+			},
+		],
+	},
+	{
+		group: "entities",
+		method: "get",
+		path: "/v1/entities.get",
+		description: "Fetches an entity by its ID.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: false,
+				description: "The ID of the customer to create the entity for.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: true,
+				description: "The ID of the entity.",
+			},
+		],
+	},
+	{
+		group: "entities",
+		method: "list",
+		path: "/v1/entities.list",
+		description:
+			"Lists entities across the organization with pagination and optional filters.",
+		body: "object",
+		fields: [
+			{
+				name: "start_cursor",
+				type: "string",
+				required: false,
+				description:
+					"Opaque pagination cursor. Empty string (default) requests the first page; use next_cursor from a prior response for subsequent pages.",
+			},
+			{
+				name: "limit",
+				type: "number",
+				required: false,
+				description:
+					"Number of items to return. Default 50, hard ceiling 5000.",
+			},
+			{
+				name: "plans",
+				type: "json",
+				required: false,
+				description:
+					"Filter by plan ID and version. Returns entities with active subscriptions to this plan, including plans inherited from the parent customer.",
+			},
+			{
+				name: "subscription_status",
+				type: "string",
+				required: false,
+				description:
+					"Filter customer products used for entity hydration and plan matching. Defaults to active and scheduled.",
+			},
+			{
+				name: "search",
+				type: "string",
+				required: false,
+				description: "Search entities by id or name.",
+			},
+			{
+				name: "processors",
+				type: "json",
+				required: false,
+				description:
+					"Filter by parent customer processor type (stripe, revenuecat, vercel).",
+			},
+			{
+				name: "customer_id",
+				type: "string",
+				required: false,
+				description:
+					"Restrict the response to entities owned by this customer id. Use to bulk-fetch all entities for one customer in a single paginated call instead of iterating entities.get.",
+			},
+		],
+	},
+	{
+		group: "entities",
+		method: "update",
+		path: "/v1/entities.update",
+		description:
+			"Updates an existing entity and returns the refreshed entity object.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: false,
+				description: "The ID of the customer that owns the entity.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: true,
+				description: "The ID of the entity.",
+			},
+			{
+				name: "billing_controls",
+				type: "json",
+				required: false,
+				description: "Billing controls to replace on the entity.",
+			},
+		],
+	},
+	{
+		group: "entities",
+		method: "delete",
+		path: "/v1/entities.delete",
+		description: "Deletes an entity by entity ID.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: false,
+				description: "The ID of the customer.",
+			},
+			{
+				name: "entity_id",
+				type: "string",
+				required: true,
+				description: "The ID of the entity.",
+			},
+		],
+	},
+	{
+		group: "referrals",
+		method: "create_code",
+		path: "/v1/referrals.create_code",
+		description:
+			"Create or fetch a referral code for a customer in a referral program.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The unique identifier of the customer",
+			},
+			{
+				name: "program_id",
+				type: "string",
+				required: true,
+				description: "ID of your referral program",
+			},
+		],
+	},
+	{
+		group: "referrals",
+		method: "redeem_code",
+		path: "/v1/referrals.redeem_code",
+		description: "Redeem a referral code for a customer.",
+		body: "object",
+		fields: [
+			{
+				name: "code",
+				type: "string",
+				required: true,
+				description: "The referral code to redeem",
+			},
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The unique identifier of the customer redeeming the code",
+			},
+		],
+	},
+	{
+		group: "referral_programs",
+		method: "create",
+		path: "/v1/referral_programs.create",
+		description: "Create a referral program linked to an existing reward.",
+		body: "object",
+		fields: [
+			{
+				name: "id",
+				type: "string",
+				required: true,
+			},
+			{
+				name: "reward_id",
+				type: "string",
+				required: true,
+			},
+			{
+				name: "redeem_on",
+				type: "string",
+				required: true,
+				description:
+					"When the reward is granted: on redemption, or when the redeemer checks out.",
+			},
+			{
+				name: "received_by",
+				type: "string",
+				required: true,
+				description:
+					"Who receives the reward: the referrer only, or both parties.",
+			},
+			{
+				name: "max_redemptions",
+				type: "number",
+				required: false,
+				description:
+					"A positive redemption limit, or null for unlimited redemptions.",
+			},
+			{
+				name: "plan_ids",
+				type: "json",
+				required: false,
+				description:
+					"Required when redeem_on is checkout. Plan IDs must be unique.",
+			},
+			{
+				name: "exclude_trial",
+				type: "boolean",
+				required: false,
+				description:
+					"Whether checkouts that start a trial should skip granting the reward.",
+			},
+			{
+				name: "internal_id",
+				type: "string",
+				required: false,
+				description:
+					"Address an existing referral program by its stable id. Omit when creating — the server generates one.",
+			},
+		],
+	},
+	{
+		group: "referral_programs",
+		method: "list",
+		path: "/v1/referral_programs.list",
+		description: "List the referral programs configured for the org.",
+		body: "none",
+		fields: [],
+	},
+	{
+		group: "referral_programs",
+		method: "get",
+		path: "/v1/referral_programs.get",
+		description: "Fetch a referral program by ID.",
+		body: "object",
+		fields: [
+			{
+				name: "referral_program_id",
+				type: "string",
+				required: true,
+				description: "The ID of the referral program.",
+			},
+		],
+	},
+	{
+		group: "referral_programs",
+		method: "update",
+		path: "/v1/referral_programs.update",
+		description:
+			"Update a referral program. Omitted fields keep their current value.",
+		body: "object",
+		fields: [
+			{
+				name: "referral_program_id",
+				type: "string",
+				required: true,
+				description: "The ID of the referral program.",
+			},
+			{
+				name: "reward_id",
+				type: "string",
+				required: false,
+				description: "The ID of the reward granted when a code is redeemed.",
+			},
+			{
+				name: "redeem_on",
+				type: "string",
+				required: false,
+				description:
+					"When the reward is granted: on redemption, or when the redeemer checks out.",
+			},
+			{
+				name: "received_by",
+				type: "string",
+				required: false,
+				description:
+					"Who receives the reward: the referrer only, or both parties.",
+			},
+			{
+				name: "max_redemptions",
+				type: "number",
+				required: false,
+				description:
+					"A positive redemption limit. Omit to leave unchanged; null removes it.",
+			},
+			{
+				name: "plan_ids",
+				type: "json",
+				required: false,
+				description:
+					"Required when redeem_on is checkout. Plan IDs must be unique. Omit to leave unchanged; null removes them.",
+			},
+			{
+				name: "exclude_trial",
+				type: "boolean",
+				required: false,
+				description: "Omit to leave unchanged; null removes it.",
+			},
+		],
+	},
+	{
+		group: "referral_programs",
+		method: "delete",
+		path: "/v1/referral_programs.delete",
+		description: "Delete a referral program.",
+		body: "object",
+		fields: [
+			{
+				name: "referral_program_id",
+				type: "string",
+				required: true,
+				description: "The ID of the referral program.",
+			},
+		],
+	},
+	{
+		group: "rewards",
+		method: "create",
+		path: "/v1/rewards.create",
+		description: "Create a coupon or feature grant.",
+		body: "object",
+		fields: [
+			{
+				name: "coupon",
+				type: "json",
+				required: false,
+				description:
+					"Provide exactly one of coupon or feature_grant, not both.",
+			},
+			{
+				name: "feature_grant",
+				type: "json",
+				required: false,
+				description:
+					"Provide exactly one of coupon or feature_grant, not both.",
+			},
+		],
+	},
+	{
+		group: "rewards",
+		method: "list",
+		path: "/v1/rewards.list",
+		description: "List the coupons and feature grants configured for the org.",
+		body: "none",
+		fields: [],
+	},
+	{
+		group: "rewards",
+		method: "get",
+		path: "/v1/rewards.get",
+		description: "Fetch a coupon or feature grant by ID.",
+		body: "object",
+		fields: [
+			{
+				name: "reward_id",
+				type: "string",
+				required: true,
+				description: "The ID of the coupon or feature grant.",
+			},
+		],
+	},
+	{
+		group: "rewards",
+		method: "update",
+		path: "/v1/rewards.update",
+		description:
+			"Update a coupon or feature grant. Omitted fields keep their current value.",
+		body: "object",
+		fields: [
+			{
+				name: "reward_id",
+				type: "string",
+				required: true,
+				description: "The ID of the coupon or feature grant.",
+			},
+			{
+				name: "coupon",
+				type: "json",
+				required: false,
+			},
+			{
+				name: "feature_grant",
+				type: "json",
+				required: false,
+			},
+		],
+	},
+	{
+		group: "rewards",
+		method: "delete",
+		path: "/v1/rewards.delete",
+		description: "Delete a coupon or feature grant.",
+		body: "object",
+		fields: [
+			{
+				name: "reward_id",
+				type: "string",
+				required: true,
+				description: "The ID of the coupon or feature grant.",
+			},
+		],
+	},
+	{
+		group: "rewards",
+		method: "redeem",
+		path: "/v1/rewards.redeem",
+		description: "Redeem a reward promo code for a customer.",
+		body: "object",
+		fields: [
+			{
+				name: "code",
+				type: "string",
+				required: true,
+				description: "The reward promo code to redeem",
+			},
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The unique identifier of the customer redeeming the code",
+			},
+		],
+	},
+	{
+		group: "platform",
+		method: "link_revenuecat",
+		path: "/v1/platform.link_revenuecat",
+		description:
+			"Generate a RevenueCat OAuth URL for linking a project to an organization.",
+		body: "object",
+		fields: [
+			{
+				name: "organization_slug",
+				type: "string",
+				required: true,
+			},
+			{
+				name: "env",
+				type: "string",
+				required: true,
+			},
+			{
+				name: "project_name",
+				type: "string",
+				required: true,
+			},
+			{
+				name: "redirect_url",
+				type: "string",
+				required: true,
+			},
+		],
+	},
+	{
+		group: "platform",
+		method: "sync_revenuecat",
+		path: "/v1/platform.sync_revenuecat",
+		description:
+			"Push an organization's plans into RevenueCat as products (creating or renaming them across the project's apps) and set test-store prices from each plan's price. Requires the org to have linked RevenueCat via OAuth.",
+		body: "object",
+		fields: [
+			{
+				name: "organization_slug",
+				type: "string",
+				required: true,
+			},
+			{
+				name: "env",
+				type: "string",
+				required: true,
+				description: '"test" and "sandbox" both target the sandbox environment',
+			},
+			{
+				name: "product_ids",
+				type: "json",
+				required: false,
+				description: "Plans to push. Omit to sync every plan in the org/env.",
+			},
+		],
+	},
+	{
+		group: "platform",
+		method: "get_revenuecat_keys",
+		path: "/v1/platform.get_revenuecat_keys",
+		description:
+			"Retrieve a managed organization's RevenueCat public (SDK) API keys, grouped by app — for the test store, App Store, and Google Play Store. Use these to configure the RevenueCat SDK in the org's mobile app.",
+		body: "object",
+		fields: [
+			{
+				name: "organization_slug",
+				type: "string",
+				required: true,
+			},
+			{
+				name: "env",
+				type: "string",
+				required: true,
+				description: '"test" and "sandbox" both target the sandbox environment',
+			},
+		],
+	},
+	{
+		group: "keys",
+		method: "mint",
+		path: "/v1/keys.mint",
+		description:
+			"Mints a per-customer token (a scoped `am_jwt_` credential) so a downstream / self-hosted app can call Autumn directly without your secret key. Returns a short-lived access token plus a rotating refresh token, both bound to the given customer. Authenticated with your secret key.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description: "The customer to mint a token for.",
+			},
+			{
+				name: "indefinite",
+				type: "boolean",
+				required: false,
+				description:
+					"If true, mint a non-expiring access token (no refresh token). Revoke via keys.revoke.",
+			},
+		],
+	},
+	{
+		group: "keys",
+		method: "refresh",
+		path: "/v1/keys.refresh",
+		description:
+			"Exchanges a refresh token (sent as the Bearer credential) for a freshly rotated access + refresh pair. Self-service for the token holder — no secret key required. The previous refresh token is honored for one rotation as a grace window; replaying an older one revokes the customer's tokens.",
+		body: "none",
+		fields: [],
+	},
+	{
+		group: "keys",
+		method: "revoke",
+		path: "/v1/keys.revoke",
+		description:
+			"Revokes every outstanding token (access and refresh) for a customer. Authenticated with your secret key. New tokens can be issued afterwards with `keys.mint`.",
+		body: "object",
+		fields: [
+			{
+				name: "customer_id",
+				type: "string",
+				required: true,
+				description:
+					"The customer whose tokens (every outstanding access + refresh token) should be revoked.",
+			},
+		],
+	},
+	{
+		group: "sandboxes",
+		method: "create",
+		path: "/v1/sandboxes.create",
+		description:
+			"Creates a sandbox: an isolated copy of your organization with its own catalog, customers and secret key. Returns the sandbox's secret key once, in this response — store it, it cannot be read back. Authenticated with your organization's secret key (a sandbox's own key cannot create sandboxes).",
+		body: "object",
+		fields: [
+			{
+				name: "name",
+				type: "string",
+				required: true,
+				description: "A name for the sandbox, unique within your organization.",
+			},
+			{
+				name: "color",
+				type: "string",
+				required: false,
+				description:
+					"Colour the dashboard uses to label the sandbox. Defaults to `gray`.",
+			},
+			{
+				name: "icon",
+				type: "string",
+				required: false,
+				description:
+					"Icon the dashboard uses to label the sandbox. Defaults to `Flask`.",
+			},
+		],
+	},
+	{
+		group: "sandboxes",
+		method: "list",
+		path: "/v1/sandboxes.list",
+		description:
+			"Lists every sandbox belonging to your organization, newest first. Secret keys are never returned here — only `sandboxes.create` shows one.",
+		body: "none",
+		fields: [],
+	},
+	{
+		group: "sandboxes",
+		method: "delete",
+		path: "/v1/sandboxes.delete",
+		description:
+			"Permanently deletes a sandbox and everything inside it: its catalog, customers and secret key. Cannot be undone.",
+		body: "object",
+		fields: [
+			{
+				name: "id",
+				type: "string",
+				required: true,
+				description: "The ID of the sandbox to delete.",
+			},
+		],
+	},
+	{
+		group: "sandboxes",
+		method: "reset",
+		path: "/v1/sandboxes.reset",
+		description:
+			"Wipes every customer, plan, feature and migration draft in the sandbox the calling key belongs to, leaving the sandbox itself, its secret keys and its settings in place. There is no id to pass: a sandbox's own key resets that sandbox, and an organization's test-mode key resets its default sandbox environment. Refused for live keys — only sandboxes can be reset. Cannot be undone.",
+		body: "none",
+		fields: [],
+	},
+];