> ## Documentation Index
> Fetch the complete documentation index at: https://docs.useautumn.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Create Schedule
> Creates a multi-phase subscription schedule for a customer. The first phase starts immediately and subsequent phases automatically transition at their scheduled start times.
Use this endpoint to schedule future plan changes (e.g. switch from a trial plan to a paid plan on a specific date) or to define a sequence of plans that should activate over time.
export const DynamicResponseExample = ({json, statusCode = "200"}) => {
const toCamelCase = str => {
return str.replace(/_([a-z])/g, (_, c) => c.toUpperCase());
};
const convertKeysToCamelCase = obj => {
if (Array.isArray(obj)) {
return obj.map(item => convertKeysToCamelCase(item));
}
if (obj !== null && typeof obj === "object") {
return Object.keys(obj).reduce((acc, key) => {
const camelKey = toCamelCase(key);
acc[camelKey] = convertKeysToCamelCase(obj[key]);
return acc;
}, {});
}
return obj;
};
const [isTypeScript, setIsTypeScript] = useState(() => {
if (typeof window !== "undefined") {
try {
const lang = localStorage.getItem("code");
return JSON.parse(lang) === "typescript";
} catch {
return true;
}
}
return true;
});
useEffect(() => {
const onMintlifyStorage = event => {
if (event.detail?.key === "code") {
try {
const value = JSON.parse(event.detail.value);
setIsTypeScript(value === "typescript");
} catch {}
}
};
const pollInterval = setInterval(() => {
try {
const lang = localStorage.getItem("code");
const value = JSON.parse(lang);
setIsTypeScript(value === "typescript");
} catch {}
}, 300);
document.addEventListener("mintlify-localstorage", onMintlifyStorage);
return () => {
document.removeEventListener("mintlify-localstorage", onMintlifyStorage);
clearInterval(pollInterval);
};
}, []);
const camelCaseJson = useMemo(() => convertKeysToCamelCase(json), [json]);
const snakeCaseString = JSON.stringify(json, null, 2);
const camelCaseString = JSON.stringify(camelCaseJson, null, 2);
return
{isTypeScript ?
{camelCaseString}
:
{snakeCaseString}
}
;
};
export const DynamicResponseField = ({children, name, ...props}) => {
const convertToCamelCase = str => {
if (typeof str !== "string") return str;
return str.replace(/[_-](\w)/g, (_, c) => c.toUpperCase());
};
const [lang, setLang] = useState(() => {
if (typeof window !== "undefined") {
const stored = localStorage.getItem("code");
return stored || '"typescript"';
}
return '"typescript"';
});
useEffect(() => {
const onMintlifyStorage = event => {
const key = event.detail?.key;
if (key === "code") {
setLang(event.detail.value);
}
};
const pollInterval = setInterval(() => {
const current = localStorage.getItem("code");
if (current && current !== lang) {
setLang(current);
}
}, 500);
document.addEventListener("mintlify-localstorage", onMintlifyStorage);
return () => {
document.removeEventListener("mintlify-localstorage", onMintlifyStorage);
clearInterval(pollInterval);
};
}, [lang]);
const resolvedName = useMemo(() => {
try {
const value = JSON.parse(lang);
const useCamelCase = value === "typescript";
return useCamelCase ? convertToCamelCase(name) : name;
} catch {
return name;
}
}, [name, lang]);
return
{children}
;
};
export const DynamicParamField = ({children, body, path, ...props}) => {
const convertToCamelCase = str => {
if (typeof str !== "string") return str;
return str.replace(/[_-](\w)/g, (_, c) => c.toUpperCase());
};
const [lang, setLang] = useState(() => {
if (typeof window !== "undefined") {
const stored = localStorage.getItem("code");
return stored || '"typescript"';
}
return '"typescript"';
});
useEffect(() => {
const onMintlifyStorage = event => {
const key = event.detail?.key;
if (key === "code") {
setLang(event.detail.value);
}
};
const pollInterval = setInterval(() => {
const current = localStorage.getItem("code");
if (current && current !== lang) {
setLang(current);
}
}, 500);
document.addEventListener("mintlify-localstorage", onMintlifyStorage);
return () => {
document.removeEventListener("mintlify-localstorage", onMintlifyStorage);
clearInterval(pollInterval);
};
}, [lang]);
const resolvedBody = useMemo(() => {
try {
const value = JSON.parse(lang);
const useCamelCase = value === "typescript";
return useCamelCase ? convertToCamelCase(body) : body;
} catch {
return body;
}
}, [body, lang]);
const resolvedPath = useMemo(() => {
try {
const value = JSON.parse(lang);
const useCamelCase = value === "typescript";
return useCamelCase ? convertToCamelCase(path) : path;
} catch {
return path;
}
}, [path, lang]);
return
{children}
;
};
### Body Parameters
The ID of the customer to create the schedule for.
Optional entity ID for an entity-scoped schedule.
Invoice mode creates and sends an invoice instead of charging the customer's payment method immediately for the first phase.
When true, creates an invoice and sends it to the customer instead of charging their card immediately. Uses Stripe's send\_invoice collection method.
If true, enables the plan immediately even though the invoice is not paid yet.
If true, finalizes the invoice so it can be sent to the customer. If false, keeps it as a draft for manual review.
ID of an invoice template (configured in billing settings) whose footer (e.g. bank details) is applied to the invoice.
Number of days the customer has to pay the invoice before it is due (Stripe days\_until\_due).
List of discounts to apply to the immediate phase. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code.
The ID of the reward to apply as a discount.
The promotion code to apply as a discount.
URL to redirect to after successful checkout.
Additional parameters to pass into the creation of the Stripe checkout session.
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.
Whether to prorate the immediate phase. 'none' skips proration charges and credits.
Pass 'now' to reset the billing cycle anchor of the immediate phase to the current time.
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.
Ordered phase definitions for the schedule.
When this phase should start, in epoch milliseconds, or 'now' for the immediate phase.
Relative start offset from the previous resolved schedule phase.
The duration unit to offset this phase from the prior phase.
How many duration\_type periods after the prior phase to start.
Plans to materialize for this phase.
The ID of the plan to schedule in this phase.
Optional prepaid feature quantities for this phase's plan.
The ID of the feature to set quantity for.
The quantity of the feature.
Whether the customer can adjust the quantity.
Optional explicit plan version to schedule.
Customize the plan to schedule. Can override price, replace items, or patch items with add\_items and remove\_items.
Base price configuration for a plan.
Base price amount for the plan.
Billing interval (e.g. 'month', 'year').
Number of intervals per billing cycle. Defaults to 1.
Base price amounts in additional currencies. The base 'amount' is in the org's default currency.
Three-letter Stripe-supported currency code (e.g. 'eur', 'gbp').
Price amount in this currency. Set explicitly per currency, not converted from the base amount.
Override the items in the plan (PUT-style — replaces all existing items). Mutually exclusive with add\_items / remove\_items / deprecated update\_items.
The ID of the feature to configure.
Number of free units included. Balance resets to this each interval for consumable features.
If true, customer has unlimited access to this feature.
Reset configuration for consumable features. Omit for non-consumable features like seats.
Interval at which balance resets (e.g. 'month', 'year'). For consumable features only.
Number of intervals between resets. Defaults to 1.
Pricing for usage beyond included units. Omit for free features.
Price per billing\_units after included usage. Either 'amount' or 'tiers' is required.
Amounts in additional currencies for this flat price. The base 'amount' is in the org's default currency. Only valid with 'amount', not 'tiers'.
Tiered pricing. Either 'amount' or 'tiers' is required.
Billing interval. For consumable features, should match reset.interval.
Number of intervals per billing cycle. Defaults to 1.
Units per price increment. Usage is rounded UP when billed (e.g. billing\_units=100 means 101 rounds to 200).
'prepaid' for upfront payment (seats), 'usage\_based' for pay-as-you-go.
Max units purchasable beyond included. E.g. included=100, max\_purchase=300 allows 400 total. Null for no limit.
Proration settings for prepaid features. Controls mid-cycle quantity change billing.
Billing behavior when quantity increases mid-cycle.
Credit behavior when quantity decreases mid-cycle.
Rollover config for unused units. If set, unused included units carry over.
Max rollover units. Omit for unlimited rollover.
Maximum rollover as a percentage (0-100) of included + prepaid grant. Mutually exclusive with max.
When rolled over units expire.
Number of periods before expiry.
Items to add to the plan.
The ID of the feature to configure.
Number of free units included. Balance resets to this each interval for consumable features.
If true, customer has unlimited access to this feature.
Reset configuration for consumable features. Omit for non-consumable features like seats.
Interval at which balance resets (e.g. 'month', 'year'). For consumable features only.
Number of intervals between resets. Defaults to 1.
Pricing for usage beyond included units. Omit for free features.
Price per billing\_units after included usage. Either 'amount' or 'tiers' is required.
Amounts in additional currencies for this flat price. The base 'amount' is in the org's default currency. Only valid with 'amount', not 'tiers'.
Tiered pricing. Either 'amount' or 'tiers' is required.
Billing interval. For consumable features, should match reset.interval.
Number of intervals per billing cycle. Defaults to 1.
Units per price increment. Usage is rounded UP when billed (e.g. billing\_units=100 means 101 rounds to 200).
'prepaid' for upfront payment (seats), 'usage\_based' for pay-as-you-go.
Max units purchasable beyond included. E.g. included=100, max\_purchase=300 allows 400 total. Null for no limit.
Proration settings for prepaid features. Controls mid-cycle quantity change billing.
Billing behavior when quantity increases mid-cycle.
Credit behavior when quantity decreases mid-cycle.
Rollover config for unused units. If set, unused included units carry over.
Max rollover units. Omit for unlimited rollover.
Maximum rollover as a percentage (0-100) of included + prepaid grant. Mutually exclusive with max.
When rolled over units expire.
Number of periods before expiry.
Filters selecting items to remove from the plan.
Match items linked to this feature.
Match items with this billing method (prepaid or usage\_based).
Match items with this interval. Accepts either a BillingInterval (price-side) or a ResetInterval (reset-side, includes day/hour/minute) so price-less items keyed by reset.interval can be disambiguated.
Match items with this interval\_count. Disambiguates between items that share an interval but differ in count.
Override the plan's billing controls (auto top-ups, spend limits, usage limits, usage alerts, overage allowed) for this customer.
List of auto top-up configurations per feature.
The ID of the feature (credit balance) to auto top-up.
Whether auto top-up is enabled.
When the balance drops below this threshold, an auto top-up will be purchased.
Amount of credits to add per auto top-up.
Optional rate limit to cap how often auto top-ups occur.
The time interval for the purchase limit window.
Number of intervals in the purchase limit window.
Maximum number of auto top-ups allowed within the interval.
When true, auto top-up creates a send\_invoice invoice instead of auto-charging.
List of overage spend limits per feature (caps overage spend).
Optional feature ID this spend limit applies to.
Whether the overage spend limit is enabled.
How overage\_limit is interpreted: an absolute overage cap (default) or a percentage of the main-plan allowance.
Overage cap for the feature: absolute units, or a percent (e.g. 120) when limit\_type is usage\_percentage.
When true, overage for this feature is not posted to Stripe. Usage tracking and balance resets still behave normally.
List of hard usage caps per feature (max units per interval).
The feature this usage limit applies to.
Whether this usage limit is enabled.
Maximum units allowed per interval.
Interval for the cap, aligned to the customer's billing cycle.
When set, only usage from events whose properties match counts toward this cap. Omit to count all usage of the feature.
List of usage alert configurations per feature.
The feature ID this alert applies to.
Whether this usage alert is enabled.
The threshold value that triggers the alert. For usage or remaining, this is an absolute count. For usage\_percentage or remaining\_percentage, this is a percentage (0-100).
Whether the threshold is an absolute count or a percentage of the usage allowance or remaining balance.
Optional user-defined label to distinguish multiple alerts on the same feature.
List of overage allowed controls per feature. When enabled, usage can exceed balance.
The feature ID this overage allowed control applies to.
Whether overage is allowed for this feature.
A unique ID to identify this subscription. Useful when scheduling the same plan multiple times.
Pass 'phase\_start' to reset the Stripe billing cycle anchor when this phase starts.
### Response
The ID of the customer.
The entity ID for the schedule, or null when customer-level.
Whether the schedule is fully created or waiting for payment or confirmation to complete.
The ID of the created schedule. Null when the schedule is waiting on Autumn checkout confirmation.
Persisted phases in ascending starts\_at order. Empty when waiting on Autumn checkout confirmation.
The ID of the persisted phase row.
When this phase starts, in epoch milliseconds.
Customer products materialized for this phase.
Invoice details if an invoice was created. Only present when a charge was made.
The status of the invoice (e.g., 'paid', 'open', 'draft').
The Stripe invoice ID.
The total amount of the invoice in cents.
The three-letter ISO currency code (e.g., 'usd').
URL to the hosted invoice page where the customer can view and pay the invoice.
URL to redirect the customer to complete payment. Null if no payment action is required.
The type of action required to complete the payment.
A human-readable explanation of why this action is required.
```json 200 theme={null}
{
"customer_id": "cus_123",
"entity_id": null,
"status": "created",
"schedule_id": "sch_1234",
"phases": [
{
"phase_id": "sphs_1111",
"starts_at": 1735689600000,
"customer_product_ids": [
"cus_prod_1111"
]
},
{
"phase_id": "sphs_2222",
"starts_at": 1736899200000,
"customer_product_ids": [
"cus_prod_2222"
]
}
],
"invoice": null,
"payment_url": null
}
```
## OpenAPI
````yaml openapi POST /v1/billing.create_schedule
openapi: 3.1.0
info:
title: Autumn API
version: 2.3.0
servers:
- url: https://api.useautumn.com
description: Production server
security:
- secretKey: []
paths:
/v1/billing.create_schedule:
post:
tags:
- billing
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.
Use this endpoint to schedule future plan changes (e.g. switch from a
trial plan to a paid plan on a specific date) or to define a sequence of
plans that should activate over time.
operationId: createSchedule
parameters:
- name: x-api-version
in: header
required: true
schema:
type: string
default: 2.3.0
x-speakeasy-globals-hidden: true
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
customer_id:
type: string
description: The ID of the customer to create the schedule for.
entity_id:
type: string
description: Optional entity ID for an entity-scoped schedule.
invoice_mode:
type: object
properties:
enabled:
type: boolean
description: >-
When true, creates an invoice and sends it to the
customer instead of charging their card immediately.
Uses Stripe's send_invoice collection method.
enable_plan_immediately:
type: boolean
default: false
description: >-
If true, enables the plan immediately even though the
invoice is not paid yet.
finalize:
type: boolean
default: true
description: >-
If true, finalizes the invoice so it can be sent to the
customer. If false, keeps it as a draft for manual
review.
invoice_template_id:
type: string
description: >-
ID of an invoice template (configured in billing
settings) whose footer (e.g. bank details) is applied to
the invoice.
net_terms_days:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
exclusiveMinimum: 0
description: >-
Number of days the customer has to pay the invoice
before it is due (Stripe days_until_due).
required:
- enabled
description: >-
Invoice mode creates and sends an invoice instead of
charging the customer's payment method immediately for the
first phase.
discounts:
type: array
items:
type: object
properties:
reward_id:
type: string
description: The ID of the reward to apply as a discount.
promotion_code:
type: string
description: The promotion code to apply as a discount.
title: AttachDiscount
description: >-
A discount to apply. Can be either a reward ID or a
promotion code.
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.
success_url:
type: string
description: URL to redirect to after successful checkout.
checkout_session_params:
type: object
propertyNames:
type: string
additionalProperties: {}
description: >-
Additional parameters to pass into the creation of the
Stripe checkout session.
redirect_mode:
enum:
- always
- if_required
- never
type: string
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.
default: if_required
billing_behavior:
enum:
- prorate_immediately
- none
type: string
description: >-
Whether to prorate the immediate phase. 'none' skips
proration charges and credits.
billing_cycle_anchor:
const: now
description: >-
Pass 'now' to reset the billing cycle anchor of the
immediate phase to the current time.
enable_plan_immediately:
type: boolean
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.
phases:
type: array
prefixItems:
- type: object
properties:
starts_at:
anyOf:
- type: number
- const: now
description: >-
When this phase should start, in epoch milliseconds,
or 'now' for the immediate phase.
starting_after:
type: object
properties:
duration_type:
enum:
- month
- year
type: string
description: >-
The duration unit to offset this phase from the
prior phase.
duration_count:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
exclusiveMinimum: 0
description: >-
How many duration_type periods after the prior
phase to start.
required:
- duration_type
- duration_count
description: >-
Relative start offset from the previous resolved
schedule phase.
plans:
type: array
minItems: 1
items:
type: object
properties:
plan_id:
type: string
description: The ID of the plan to schedule in this phase.
feature_quantities:
type: array
items:
type: object
properties:
feature_id:
type: string
description: >-
The ID of the feature to set quantity
for.
quantity:
type: number
minimum: 0
description: The quantity of the feature.
adjustable:
type: boolean
description: >-
Whether the customer can adjust the
quantity.
required:
- feature_id
title: FeatureQuantity
description: >-
Quantity configuration for a prepaid
feature.
description: >-
Optional prepaid feature quantities for this
phase's plan.
version:
type: number
description: Optional explicit plan version to schedule.
customize:
type: object
properties:
price:
anyOf:
- type: object
properties:
amount:
type: number
description: Base price amount for the plan.
interval:
enum:
- one_off
- week
- month
- quarter
- semi_annual
- year
type: string
description: Billing interval (e.g. 'month', 'year').
interval_count:
type: number
description: >-
Number of intervals per billing cycle.
Defaults to 1.
additional_currencies:
type: array
items:
type: object
properties:
currency:
type: string
description: >-
Three-letter Stripe-supported currency
code (e.g. 'eur', 'gbp').
amount:
type: number
description: >-
Price amount in this currency. Set
explicitly per currency, not converted
from the base amount.
required:
- currency
- amount
description: >-
Base price amounts in additional
currencies. The base 'amount' is in the
org's default currency.
required:
- amount
- interval
title: BasePrice
description: Base price configuration for a plan.
- type: 'null'
description: >-
Override the base price of the plan. Pass
null to remove the base price.
items:
type: array
items:
type: object
properties:
feature_id:
type: string
description: The ID of the feature to configure.
included:
type: number
description: >-
Number of free units included. Balance
resets to this each interval for
consumable features.
unlimited:
type: boolean
description: >-
If true, customer has unlimited access
to this feature.
reset:
type: object
properties:
interval:
enum:
- one_off
- minute
- hour
- day
- week
- month
- quarter
- semi_annual
- year
type: string
description: >-
Interval at which balance resets (e.g.
'month', 'year'). For consumable
features only.
interval_count:
type: number
description: >-
Number of intervals between resets.
Defaults to 1.
required:
- interval
description: >-
Reset configuration for consumable
features. Omit for non-consumable
features like seats.
price:
type: object
properties:
amount:
type: number
description: >-
Price per billing_units after included
usage. Either 'amount' or 'tiers' is
required.
additional_currencies:
type: array
items:
type: object
properties:
currency: {}
amount: {}
description: >-
Amounts in additional currencies for
this flat price. The base 'amount' is in
the org's default currency. Only valid
with 'amount', not 'tiers'.
tiers:
type: array
items:
type: object
properties:
to: {}
amount: {}
flat_amount: {}
additional_currencies: {}
description: >-
Tiered pricing. Either 'amount' or
'tiers' is required.
tier_behavior:
enum:
- graduated
- volume
type: string
interval:
enum:
- one_off
- week
- month
- quarter
- semi_annual
- year
type: string
description: >-
Billing interval. For consumable
features, should match reset.interval.
interval_count:
type: number
default: 1
description: >-
Number of intervals per billing cycle.
Defaults to 1.
billing_units:
type: number
default: 1
description: >-
Units per price increment. Usage is
rounded UP when billed (e.g.
billing_units=100 means 101 rounds to
200).
billing_method:
enum:
- prepaid
- usage_based
type: string
description: >-
'prepaid' for upfront payment (seats),
'usage_based' for pay-as-you-go.
max_purchase:
anyOf:
- type: number
- type: 'null'
description: >-
Max units purchasable beyond included.
E.g. included=100, max_purchase=300
allows 400 total. Null for no limit.
required:
- interval
- billing_method
description: >-
Pricing for usage beyond included units.
Omit for free features.
proration:
type: object
properties:
on_increase:
enum:
- bill_immediately
- prorate_immediately
- prorate_next_cycle
- bill_next_cycle
type: string
description: >-
Billing behavior when quantity increases
mid-cycle.
on_decrease:
enum:
- prorate
- prorate_immediately
- prorate_next_cycle
- none
- no_prorations
type: string
description: >-
Credit behavior when quantity decreases
mid-cycle.
required:
- on_increase
- on_decrease
description: >-
Proration settings for prepaid features.
Controls mid-cycle quantity change
billing.
rollover:
type: object
properties:
max:
type: number
description: >-
Max rollover units. Omit for unlimited
rollover.
max_percentage:
type: number
description: >-
Maximum rollover as a percentage (0-100)
of included + prepaid grant. Mutually
exclusive with max.
expiry_duration_type:
enum:
- month
- forever
type: string
description: When rolled over units expire.
expiry_duration_length:
type: number
description: Number of periods before expiry.
required:
- expiry_duration_type
description: >-
Rollover config for unused units. If
set, unused included units carry over.
required:
- feature_id
title: PlanItem
description: >-
Configuration for a feature item in a
plan, including usage limits, pricing,
and rollover settings.
description: >-
Override the items in the plan (PUT-style
— replaces all existing items). Mutually
exclusive with add_items / remove_items /
deprecated update_items.
add_items:
type: array
items:
type: object
properties:
feature_id:
type: string
description: The ID of the feature to configure.
included:
type: number
description: >-
Number of free units included. Balance
resets to this each interval for
consumable features.
unlimited:
type: boolean
description: >-
If true, customer has unlimited access
to this feature.
reset:
type: object
properties:
interval:
enum:
- one_off
- minute
- hour
- day
- week
- month
- quarter
- semi_annual
- year
type: string
description: >-
Interval at which balance resets (e.g.
'month', 'year'). For consumable
features only.
interval_count:
type: number
description: >-
Number of intervals between resets.
Defaults to 1.
required:
- interval
description: >-
Reset configuration for consumable
features. Omit for non-consumable
features like seats.
price:
type: object
properties:
amount:
type: number
description: >-
Price per billing_units after included
usage. Either 'amount' or 'tiers' is
required.
additional_currencies:
type: array
items:
type: object
properties:
currency: {}
amount: {}
description: >-
Amounts in additional currencies for
this flat price. The base 'amount' is in
the org's default currency. Only valid
with 'amount', not 'tiers'.
tiers:
type: array
items:
type: object
properties:
to: {}
amount: {}
flat_amount: {}
additional_currencies: {}
description: >-
Tiered pricing. Either 'amount' or
'tiers' is required.
tier_behavior:
enum:
- graduated
- volume
type: string
interval:
enum:
- one_off
- week
- month
- quarter
- semi_annual
- year
type: string
description: >-
Billing interval. For consumable
features, should match reset.interval.
interval_count:
type: number
default: 1
description: >-
Number of intervals per billing cycle.
Defaults to 1.
billing_units:
type: number
default: 1
description: >-
Units per price increment. Usage is
rounded UP when billed (e.g.
billing_units=100 means 101 rounds to
200).
billing_method:
enum:
- prepaid
- usage_based
type: string
description: >-
'prepaid' for upfront payment (seats),
'usage_based' for pay-as-you-go.
max_purchase:
anyOf:
- type: number
- type: 'null'
description: >-
Max units purchasable beyond included.
E.g. included=100, max_purchase=300
allows 400 total. Null for no limit.
required:
- interval
- billing_method
description: >-
Pricing for usage beyond included units.
Omit for free features.
proration:
type: object
properties:
on_increase:
enum:
- bill_immediately
- prorate_immediately
- prorate_next_cycle
- bill_next_cycle
type: string
description: >-
Billing behavior when quantity increases
mid-cycle.
on_decrease:
enum:
- prorate
- prorate_immediately
- prorate_next_cycle
- none
- no_prorations
type: string
description: >-
Credit behavior when quantity decreases
mid-cycle.
required:
- on_increase
- on_decrease
description: >-
Proration settings for prepaid features.
Controls mid-cycle quantity change
billing.
rollover:
type: object
properties:
max:
type: number
description: >-
Max rollover units. Omit for unlimited
rollover.
max_percentage:
type: number
description: >-
Maximum rollover as a percentage (0-100)
of included + prepaid grant. Mutually
exclusive with max.
expiry_duration_type:
enum:
- month
- forever
type: string
description: When rolled over units expire.
expiry_duration_length:
type: number
description: Number of periods before expiry.
required:
- expiry_duration_type
description: >-
Rollover config for unused units. If
set, unused included units carry over.
required:
- feature_id
title: PlanItem
description: >-
Configuration for a feature item in a
plan, including usage limits, pricing,
and rollover settings.
description: Items to add to the plan.
remove_items:
type: array
items:
type: object
properties:
feature_id:
type: string
description: Match items linked to this feature.
billing_method:
enum:
- prepaid
- usage_based
type: string
description: >-
Match items with this billing method
(prepaid or usage_based).
interval:
anyOf:
- enum:
- one_off
- week
- month
- quarter
- semi_annual
- year
type: string
- enum:
- one_off
- minute
- hour
- day
- week
- month
- quarter
- semi_annual
- year
type: string
description: >-
Match items with this interval. Accepts
either a BillingInterval (price-side) or
a ResetInterval (reset-side, includes
day/hour/minute) so price-less items
keyed by reset.interval can be
disambiguated.
interval_count:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
exclusiveMinimum: 0
description: >-
Match items with this interval_count.
Disambiguates between items that share
an interval but differ in count.
title: PlanItemFilter
description: >-
Filter for matching plan items. All
provided fields must match (AND).
description: >-
Filters selecting items to remove from the
plan.
billing_controls:
type: object
properties:
auto_topups:
type: array
items:
type: object
properties:
feature_id:
type: string
description: >-
The ID of the feature (credit balance)
to auto top-up.
enabled:
type: boolean
default: false
description: Whether auto top-up is enabled.
threshold:
type: number
minimum: 0
description: >-
When the balance drops below this
threshold, an auto top-up will be
purchased.
quantity:
type: number
minimum: 1
description: >-
Amount of credits to add per auto
top-up.
purchase_limit:
type: object
properties:
interval:
enum:
- hour
- day
- week
- month
type: string
description: >-
The time interval for the purchase limit
window.
interval_count:
type: number
minimum: 1
default: 1
description: >-
Number of intervals in the purchase
limit window.
limit:
type: number
minimum: 1
description: >-
Maximum number of auto top-ups allowed
within the interval.
required:
- interval
- limit
description: >-
Optional rate limit to cap how often
auto top-ups occur.
invoice_mode:
type: boolean
description: >-
When true, auto top-up creates a
send_invoice invoice instead of
auto-charging.
required:
- feature_id
- threshold
- quantity
description: >-
List of auto top-up configurations per
feature.
spend_limits:
type: array
items:
type: object
properties:
feature_id:
type: string
description: >-
Optional feature ID this spend limit
applies to.
enabled:
type: boolean
default: false
description: >-
Whether the overage spend limit is
enabled.
limit_type:
enum:
- absolute
- usage_percentage
type: string
description: >-
How overage_limit is interpreted: an
absolute overage cap (default) or a
percentage of the main-plan allowance.
overage_limit:
type: number
minimum: 0
description: >-
Overage cap for the feature: absolute
units, or a percent (e.g. 120) when
limit_type is usage_percentage.
skip_overage_billing:
type: boolean
description: >-
When true, overage for this feature is
not posted to Stripe. Usage tracking and
balance resets still behave normally.
description: >-
List of overage spend limits per feature
(caps overage spend).
usage_limits:
type: array
items:
type: object
properties:
feature_id:
type: string
description: The feature this usage limit applies to.
enabled:
type: boolean
default: true
description: Whether this usage limit is enabled.
limit:
type: number
minimum: 0
description: Maximum units allowed per interval.
interval:
enum:
- day
- week
- month
- year
type: string
description: >-
Interval for the cap, aligned to the
customer's billing cycle.
filter:
type: object
properties:
properties:
type: object
propertyNames: {}
additionalProperties: {}
required:
- properties
description: >-
When set, only usage from events whose
properties match counts toward this cap.
Omit to count all usage of the feature.
required:
- feature_id
- limit
- interval
description: >-
List of hard usage caps per feature (max
units per interval).
usage_alerts:
type: array
items:
type: object
properties:
feature_id:
type: string
description: The feature ID this alert applies to.
enabled:
type: boolean
default: true
description: Whether this usage alert is enabled.
threshold:
type: number
minimum: 0
description: >-
The threshold value that triggers the
alert. For usage or remaining, this is
an absolute count. For usage_percentage
or remaining_percentage, this is a
percentage (0-100).
threshold_type:
enum:
- usage
- usage_percentage
- remaining
- remaining_percentage
type: string
description: >-
Whether the threshold is an absolute
count or a percentage of the usage
allowance or remaining balance.
name:
type: string
description: >-
Optional user-defined label to
distinguish multiple alerts on the same
feature.
required:
- threshold
- threshold_type
description: >-
List of usage alert configurations per
feature.
overage_allowed:
type: array
items:
type: object
properties:
feature_id:
type: string
description: >-
The feature ID this overage allowed
control applies to.
enabled:
type: boolean
default: false
description: >-
Whether overage is allowed for this
feature.
required:
- feature_id
description: >-
List of overage allowed controls per
feature. When enabled, usage can exceed
balance.
description: >-
Override the plan's billing controls (auto
top-ups, spend limits, usage limits, usage
alerts, overage allowed) for this
customer.
additionalProperties: false
description: >-
Customize the plan to schedule. Can override
price, replace items, or patch items with
add_items and remove_items.
subscription_id:
type: string
description: >-
A unique ID to identify this subscription.
Useful when scheduling the same plan multiple
times.
required:
- plan_id
description: Plans to materialize for this phase.
billing_cycle_anchor:
enum:
- phase_start
type: string
description: >-
Pass 'phase_start' to reset the Stripe billing cycle
anchor when this phase starts.
required:
- plans
items:
type: object
properties:
starts_at:
anyOf:
- type: number
- const: now
description: >-
When this phase should start, in epoch milliseconds,
or 'now' for the immediate phase.
starting_after:
type: object
properties:
duration_type:
enum:
- month
- year
type: string
description: >-
The duration unit to offset this phase from the
prior phase.
duration_count:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
exclusiveMinimum: 0
description: >-
How many duration_type periods after the prior
phase to start.
required:
- duration_type
- duration_count
description: >-
Relative start offset from the previous resolved
schedule phase.
plans:
type: array
minItems: 1
items:
type: object
properties:
plan_id:
type: string
description: The ID of the plan to schedule in this phase.
feature_quantities:
type: array
items:
type: object
properties:
feature_id:
type: string
description: The ID of the feature to set quantity for.
quantity:
type: number
minimum: 0
description: The quantity of the feature.
adjustable:
type: boolean
description: >-
Whether the customer can adjust the
quantity.
required:
- feature_id
title: FeatureQuantity
description: Quantity configuration for a prepaid feature.
description: >-
Optional prepaid feature quantities for this
phase's plan.
version:
type: number
description: Optional explicit plan version to schedule.
customize:
type: object
properties:
price:
anyOf:
- type: object
properties:
amount:
type: number
description: Base price amount for the plan.
interval:
enum:
- one_off
- week
- month
- quarter
- semi_annual
- year
type: string
description: Billing interval (e.g. 'month', 'year').
interval_count:
type: number
description: >-
Number of intervals per billing cycle.
Defaults to 1.
additional_currencies:
type: array
items:
type: object
properties:
currency:
type: string
description: >-
Three-letter Stripe-supported currency
code (e.g. 'eur', 'gbp').
amount:
type: number
description: >-
Price amount in this currency. Set
explicitly per currency, not converted
from the base amount.
required:
- currency
- amount
description: >-
Base price amounts in additional
currencies. The base 'amount' is in the
org's default currency.
required:
- amount
- interval
title: BasePrice
description: Base price configuration for a plan.
- type: 'null'
description: >-
Override the base price of the plan. Pass
null to remove the base price.
items:
type: array
items:
type: object
properties:
feature_id:
type: string
description: The ID of the feature to configure.
included:
type: number
description: >-
Number of free units included. Balance
resets to this each interval for
consumable features.
unlimited:
type: boolean
description: >-
If true, customer has unlimited access
to this feature.
reset:
type: object
properties:
interval:
enum:
- one_off
- minute
- hour
- day
- week
- month
- quarter
- semi_annual
- year
type: string
description: >-
Interval at which balance resets (e.g.
'month', 'year'). For consumable
features only.
interval_count:
type: number
description: >-
Number of intervals between resets.
Defaults to 1.
required:
- interval
description: >-
Reset configuration for consumable
features. Omit for non-consumable
features like seats.
price:
type: object
properties:
amount:
type: number
description: >-
Price per billing_units after included
usage. Either 'amount' or 'tiers' is
required.
additional_currencies:
type: array
items:
type: object
properties:
currency: {}
amount: {}
description: >-
Amounts in additional currencies for
this flat price. The base 'amount' is in
the org's default currency. Only valid
with 'amount', not 'tiers'.
tiers:
type: array
items:
type: object
properties:
to: {}
amount: {}
flat_amount: {}
additional_currencies: {}
description: >-
Tiered pricing. Either 'amount' or
'tiers' is required.
tier_behavior:
enum:
- graduated
- volume
type: string
interval:
enum:
- one_off
- week
- month
- quarter
- semi_annual
- year
type: string
description: >-
Billing interval. For consumable
features, should match reset.interval.
interval_count:
type: number
default: 1
description: >-
Number of intervals per billing cycle.
Defaults to 1.
billing_units:
type: number
default: 1
description: >-
Units per price increment. Usage is
rounded UP when billed (e.g.
billing_units=100 means 101 rounds to
200).
billing_method:
enum:
- prepaid
- usage_based
type: string
description: >-
'prepaid' for upfront payment (seats),
'usage_based' for pay-as-you-go.
max_purchase:
anyOf:
- type: number
- type: 'null'
description: >-
Max units purchasable beyond included.
E.g. included=100, max_purchase=300
allows 400 total. Null for no limit.
required:
- interval
- billing_method
description: >-
Pricing for usage beyond included units.
Omit for free features.
proration:
type: object
properties:
on_increase:
enum:
- bill_immediately
- prorate_immediately
- prorate_next_cycle
- bill_next_cycle
type: string
description: >-
Billing behavior when quantity increases
mid-cycle.
on_decrease:
enum:
- prorate
- prorate_immediately
- prorate_next_cycle
- none
- no_prorations
type: string
description: >-
Credit behavior when quantity decreases
mid-cycle.
required:
- on_increase
- on_decrease
description: >-
Proration settings for prepaid features.
Controls mid-cycle quantity change
billing.
rollover:
type: object
properties:
max:
type: number
description: >-
Max rollover units. Omit for unlimited
rollover.
max_percentage:
type: number
description: >-
Maximum rollover as a percentage (0-100)
of included + prepaid grant. Mutually
exclusive with max.
expiry_duration_type:
enum:
- month
- forever
type: string
description: When rolled over units expire.
expiry_duration_length:
type: number
description: Number of periods before expiry.
required:
- expiry_duration_type
description: >-
Rollover config for unused units. If
set, unused included units carry over.
required:
- feature_id
title: PlanItem
description: >-
Configuration for a feature item in a
plan, including usage limits, pricing, and
rollover settings.
description: >-
Override the items in the plan (PUT-style —
replaces all existing items). Mutually
exclusive with add_items / remove_items /
deprecated update_items.
add_items:
type: array
items:
type: object
properties:
feature_id:
type: string
description: The ID of the feature to configure.
included:
type: number
description: >-
Number of free units included. Balance
resets to this each interval for
consumable features.
unlimited:
type: boolean
description: >-
If true, customer has unlimited access
to this feature.
reset:
type: object
properties:
interval:
enum:
- one_off
- minute
- hour
- day
- week
- month
- quarter
- semi_annual
- year
type: string
description: >-
Interval at which balance resets (e.g.
'month', 'year'). For consumable
features only.
interval_count:
type: number
description: >-
Number of intervals between resets.
Defaults to 1.
required:
- interval
description: >-
Reset configuration for consumable
features. Omit for non-consumable
features like seats.
price:
type: object
properties:
amount:
type: number
description: >-
Price per billing_units after included
usage. Either 'amount' or 'tiers' is
required.
additional_currencies:
type: array
items:
type: object
properties:
currency: {}
amount: {}
description: >-
Amounts in additional currencies for
this flat price. The base 'amount' is in
the org's default currency. Only valid
with 'amount', not 'tiers'.
tiers:
type: array
items:
type: object
properties:
to: {}
amount: {}
flat_amount: {}
additional_currencies: {}
description: >-
Tiered pricing. Either 'amount' or
'tiers' is required.
tier_behavior:
enum:
- graduated
- volume
type: string
interval:
enum:
- one_off
- week
- month
- quarter
- semi_annual
- year
type: string
description: >-
Billing interval. For consumable
features, should match reset.interval.
interval_count:
type: number
default: 1
description: >-
Number of intervals per billing cycle.
Defaults to 1.
billing_units:
type: number
default: 1
description: >-
Units per price increment. Usage is
rounded UP when billed (e.g.
billing_units=100 means 101 rounds to
200).
billing_method:
enum:
- prepaid
- usage_based
type: string
description: >-
'prepaid' for upfront payment (seats),
'usage_based' for pay-as-you-go.
max_purchase:
anyOf:
- type: number
- type: 'null'
description: >-
Max units purchasable beyond included.
E.g. included=100, max_purchase=300
allows 400 total. Null for no limit.
required:
- interval
- billing_method
description: >-
Pricing for usage beyond included units.
Omit for free features.
proration:
type: object
properties:
on_increase:
enum:
- bill_immediately
- prorate_immediately
- prorate_next_cycle
- bill_next_cycle
type: string
description: >-
Billing behavior when quantity increases
mid-cycle.
on_decrease:
enum:
- prorate
- prorate_immediately
- prorate_next_cycle
- none
- no_prorations
type: string
description: >-
Credit behavior when quantity decreases
mid-cycle.
required:
- on_increase
- on_decrease
description: >-
Proration settings for prepaid features.
Controls mid-cycle quantity change
billing.
rollover:
type: object
properties:
max:
type: number
description: >-
Max rollover units. Omit for unlimited
rollover.
max_percentage:
type: number
description: >-
Maximum rollover as a percentage (0-100)
of included + prepaid grant. Mutually
exclusive with max.
expiry_duration_type:
enum:
- month
- forever
type: string
description: When rolled over units expire.
expiry_duration_length:
type: number
description: Number of periods before expiry.
required:
- expiry_duration_type
description: >-
Rollover config for unused units. If
set, unused included units carry over.
required:
- feature_id
title: PlanItem
description: >-
Configuration for a feature item in a
plan, including usage limits, pricing, and
rollover settings.
description: Items to add to the plan.
remove_items:
type: array
items:
type: object
properties:
feature_id:
type: string
description: Match items linked to this feature.
billing_method:
enum:
- prepaid
- usage_based
type: string
description: >-
Match items with this billing method
(prepaid or usage_based).
interval:
anyOf:
- enum:
- one_off
- week
- month
- quarter
- semi_annual
- year
type: string
- enum:
- one_off
- minute
- hour
- day
- week
- month
- quarter
- semi_annual
- year
type: string
description: >-
Match items with this interval. Accepts
either a BillingInterval (price-side) or
a ResetInterval (reset-side, includes
day/hour/minute) so price-less items
keyed by reset.interval can be
disambiguated.
interval_count:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
exclusiveMinimum: 0
description: >-
Match items with this interval_count.
Disambiguates between items that share
an interval but differ in count.
title: PlanItemFilter
description: >-
Filter for matching plan items. All
provided fields must match (AND).
description: >-
Filters selecting items to remove from the
plan.
billing_controls:
type: object
properties:
auto_topups:
type: array
items:
type: object
properties:
feature_id:
type: string
description: >-
The ID of the feature (credit balance)
to auto top-up.
enabled:
type: boolean
default: false
description: Whether auto top-up is enabled.
threshold:
type: number
minimum: 0
description: >-
When the balance drops below this
threshold, an auto top-up will be
purchased.
quantity:
type: number
minimum: 1
description: >-
Amount of credits to add per auto
top-up.
purchase_limit:
type: object
properties:
interval:
enum:
- hour
- day
- week
- month
type: string
description: >-
The time interval for the purchase limit
window.
interval_count:
type: number
minimum: 1
default: 1
description: >-
Number of intervals in the purchase
limit window.
limit:
type: number
minimum: 1
description: >-
Maximum number of auto top-ups allowed
within the interval.
required:
- interval
- limit
description: >-
Optional rate limit to cap how often
auto top-ups occur.
invoice_mode:
type: boolean
description: >-
When true, auto top-up creates a
send_invoice invoice instead of
auto-charging.
required:
- feature_id
- threshold
- quantity
description: >-
List of auto top-up configurations per
feature.
spend_limits:
type: array
items:
type: object
properties:
feature_id:
type: string
description: >-
Optional feature ID this spend limit
applies to.
enabled:
type: boolean
default: false
description: >-
Whether the overage spend limit is
enabled.
limit_type:
enum:
- absolute
- usage_percentage
type: string
description: >-
How overage_limit is interpreted: an
absolute overage cap (default) or a
percentage of the main-plan allowance.
overage_limit:
type: number
minimum: 0
description: >-
Overage cap for the feature: absolute
units, or a percent (e.g. 120) when
limit_type is usage_percentage.
skip_overage_billing:
type: boolean
description: >-
When true, overage for this feature is
not posted to Stripe. Usage tracking and
balance resets still behave normally.
description: >-
List of overage spend limits per feature
(caps overage spend).
usage_limits:
type: array
items:
type: object
properties:
feature_id:
type: string
description: The feature this usage limit applies to.
enabled:
type: boolean
default: true
description: Whether this usage limit is enabled.
limit:
type: number
minimum: 0
description: Maximum units allowed per interval.
interval:
enum:
- day
- week
- month
- year
type: string
description: >-
Interval for the cap, aligned to the
customer's billing cycle.
filter:
type: object
properties:
properties:
type: object
propertyNames: {}
additionalProperties: {}
required:
- properties
description: >-
When set, only usage from events whose
properties match counts toward this cap.
Omit to count all usage of the feature.
required:
- feature_id
- limit
- interval
description: >-
List of hard usage caps per feature (max
units per interval).
usage_alerts:
type: array
items:
type: object
properties:
feature_id:
type: string
description: The feature ID this alert applies to.
enabled:
type: boolean
default: true
description: Whether this usage alert is enabled.
threshold:
type: number
minimum: 0
description: >-
The threshold value that triggers the
alert. For usage or remaining, this is
an absolute count. For usage_percentage
or remaining_percentage, this is a
percentage (0-100).
threshold_type:
enum:
- usage
- usage_percentage
- remaining
- remaining_percentage
type: string
description: >-
Whether the threshold is an absolute
count or a percentage of the usage
allowance or remaining balance.
name:
type: string
description: >-
Optional user-defined label to
distinguish multiple alerts on the same
feature.
required:
- threshold
- threshold_type
description: >-
List of usage alert configurations per
feature.
overage_allowed:
type: array
items:
type: object
properties:
feature_id:
type: string
description: >-
The feature ID this overage allowed
control applies to.
enabled:
type: boolean
default: false
description: >-
Whether overage is allowed for this
feature.
required:
- feature_id
description: >-
List of overage allowed controls per
feature. When enabled, usage can exceed
balance.
description: >-
Override the plan's billing controls (auto
top-ups, spend limits, usage limits, usage
alerts, overage allowed) for this customer.
additionalProperties: false
description: >-
Customize the plan to schedule. Can override
price, replace items, or patch items with
add_items and remove_items.
subscription_id:
type: string
description: >-
A unique ID to identify this subscription.
Useful when scheduling the same plan multiple
times.
required:
- plan_id
description: Plans to materialize for this phase.
billing_cycle_anchor:
enum:
- phase_start
type: string
description: >-
Pass 'phase_start' to reset the Stripe billing cycle
anchor when this phase starts.
required:
- plans
description: Ordered phase definitions for the schedule.
required:
- customer_id
- phases
title: CreateScheduleParams
examples:
- customer_id: cus_123
phases:
- starts_at: 1735689600000
plans:
- plan_id: trial_plan
- starts_at: 1736899200000
plans:
- plan_id: pro_plan
example:
customer_id: cus_123
phases:
- starts_at: 1735689600000
plans:
- plan_id: trial_plan
- starts_at: 1736899200000
plans:
- plan_id: pro_plan
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
customer_id:
type: string
description: The ID of the customer.
entity_id:
anyOf:
- type: string
- type: 'null'
description: >-
The entity ID for the schedule, or null when
customer-level.
status:
enum:
- created
- pending_payment
type: string
description: >-
Whether the schedule is fully created or waiting for
payment or confirmation to complete.
schedule_id:
anyOf:
- type: string
- type: 'null'
description: >-
The ID of the created schedule. Null when the schedule is
waiting on Autumn checkout confirmation.
phases:
type: array
items:
type: object
properties:
phase_id:
type: string
description: The ID of the persisted phase row.
starts_at:
type: number
description: When this phase starts, in epoch milliseconds.
customer_product_ids:
type: array
items:
type: string
description: Customer products materialized for this phase.
required:
- phase_id
- starts_at
- customer_product_ids
description: >-
Persisted phases in ascending starts_at order. Empty when
waiting on Autumn checkout confirmation.
invoice:
type: object
properties:
status:
anyOf:
- type: string
- type: 'null'
description: >-
The status of the invoice (e.g., 'paid', 'open',
'draft').
stripe_id:
type: string
description: The Stripe invoice ID.
total:
type: number
description: The total amount of the invoice in cents.
currency:
type: string
description: The three-letter ISO currency code (e.g., 'usd').
hosted_invoice_url:
anyOf:
- type: string
- type: 'null'
description: >-
URL to the hosted invoice page where the customer can
view and pay the invoice.
required:
- status
- stripe_id
- total
- currency
- hosted_invoice_url
description: >-
Invoice details if an invoice was created. Only present
when a charge was made.
payment_url:
anyOf:
- type: string
- type: 'null'
description: >-
URL to redirect the customer to complete payment. Null if
no payment action is required.
required_action:
type: object
properties:
code:
enum:
- 3ds_required
- payment_method_required
- payment_failed
- payment_processing
type: string
description: The type of action required to complete the payment.
reason:
type: string
description: >-
A human-readable explanation of why this action is
required.
required:
- code
- reason
required:
- customer_id
- entity_id
- status
- schedule_id
- phases
- payment_url
title: CreateScheduleResponse
examples:
- customer_id: cus_123
entity_id: null
status: created
schedule_id: sch_1234
phases:
- phase_id: sphs_1111
starts_at: 1735689600000
customer_product_ids:
- cus_prod_1111
- phase_id: sphs_2222
starts_at: 1736899200000
customer_product_ids:
- cus_prod_2222
invoice: null
payment_url: null
example:
customer_id: cus_123
entity_id: null
status: created
schedule_id: sch_1234
phases:
- phase_id: sphs_1111
starts_at: 1735689600000
customer_product_ids:
- cus_prod_1111
- phase_id: sphs_2222
starts_at: 1736899200000
customer_product_ids:
- cus_prod_2222
invoice: null
payment_url: null
x-codeSamples:
- lang: typescript
label: Typescript (SDK)
source: |-
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.billing.createSchedule({
customerId: "cus_123",
phases: [
{
startsAt: 1735689600000,
plans: [
{
planId: "trial_plan",
},
],
},
{
startsAt: 1736899200000,
plans: [
{
planId: "pro_plan",
},
],
},
],
});
- lang: python
label: Python (SDK)
source: |-
from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.billing.create_schedule(
customer_id="cus_123",
phases=[
{
"starts_at": 1735689600000,
"plans": [
{
"plan_id": "trial_plan",
},
],
},
{
"starts_at": 1736899200000,
"plans": [
{
"plan_id": "pro_plan",
},
],
},
],
redirect_mode="if_required",
)
components:
securitySchemes:
secretKey:
type: http
scheme: bearer
bearerFormat: JWT
````