Create a schedule

POST {{baseUrl}}/v1/subscription_schedules

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

Request Body

[{"name"=>"customer", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"default_settings[application_fee_percent]", "value"=>"<number>", "datatype"=>"string"}, {"name"=>"default_settings[automatic_tax][enabled]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"default_settings[billing_cycle_anchor]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"default_settings[billing_thresholds][amount_gte]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"default_settings[billing_thresholds][reset_billing_cycle_anchor]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"default_settings[collection_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"default_settings[default_payment_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"default_settings[description]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"default_settings[invoice_settings][days_until_due]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"default_settings[on_behalf_of]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"default_settings[transfer_data][destination]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"default_settings[transfer_data][amount_percent]", "value"=>"<number>", "datatype"=>"string"}, {"name"=>"end_behavior", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expand[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expand[1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"from_subscription", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][items][0][billing_thresholds][usage_gte]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[0][items][0][price]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][items][0][price_data][currency]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][items][0][price_data][product]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][items][0][price_data][recurring][interval]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][items][0][price_data][recurring][interval_count]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[0][items][0][price_data][tax_behavior]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][items][0][price_data][unit_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[0][items][0][price_data][unit_amount_decimal]", "value"=>"<decimal>", "datatype"=>"string"}, {"name"=>"phases[0][items][0][quantity]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[0][items][0][tax_rates][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][items][0][tax_rates][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][items][1][billing_thresholds][usage_gte]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[0][items][1][price]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][items][1][price_data][currency]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][items][1][price_data][product]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][items][1][price_data][recurring][interval]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][items][1][price_data][recurring][interval_count]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[0][items][1][price_data][tax_behavior]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][items][1][price_data][unit_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[0][items][1][price_data][unit_amount_decimal]", "value"=>"<decimal>", "datatype"=>"string"}, {"name"=>"phases[0][items][1][quantity]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[0][items][1][tax_rates][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][items][1][tax_rates][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][add_invoice_items][0][price]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][add_invoice_items][0][price_data][currency]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][add_invoice_items][0][price_data][product]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][add_invoice_items][0][price_data][tax_behavior]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][add_invoice_items][0][price_data][unit_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[0][add_invoice_items][0][price_data][unit_amount_decimal]", "value"=>"<decimal>", "datatype"=>"string"}, {"name"=>"phases[0][add_invoice_items][0][quantity]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[0][add_invoice_items][0][tax_rates][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][add_invoice_items][0][tax_rates][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][add_invoice_items][1][price]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][add_invoice_items][1][price_data][currency]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][add_invoice_items][1][price_data][product]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][add_invoice_items][1][price_data][tax_behavior]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][add_invoice_items][1][price_data][unit_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[0][add_invoice_items][1][price_data][unit_amount_decimal]", "value"=>"<decimal>", "datatype"=>"string"}, {"name"=>"phases[0][add_invoice_items][1][quantity]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[0][add_invoice_items][1][tax_rates][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][add_invoice_items][1][tax_rates][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][application_fee_percent]", "value"=>"<number>", "datatype"=>"string"}, {"name"=>"phases[0][automatic_tax][enabled]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"phases[0][billing_cycle_anchor]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][billing_thresholds][amount_gte]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[0][billing_thresholds][reset_billing_cycle_anchor]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"phases[0][collection_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][coupon]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][currency]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][default_payment_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][default_tax_rates][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][default_tax_rates][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][description]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][end_date]", "value"=>"<unix-time>", "datatype"=>"string"}, {"name"=>"phases[0][invoice_settings][days_until_due]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[0][iterations]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[0][metadata]", "value"=>"<object>", "datatype"=>"string"}, {"name"=>"phases[0][on_behalf_of]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][proration_behavior]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][transfer_data][destination]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[0][transfer_data][amount_percent]", "value"=>"<number>", "datatype"=>"string"}, {"name"=>"phases[0][trial]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"phases[0][trial_end]", "value"=>"<unix-time>", "datatype"=>"string"}, {"name"=>"phases[1][items][0][billing_thresholds][usage_gte]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[1][items][0][price]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][items][0][price_data][currency]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][items][0][price_data][product]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][items][0][price_data][recurring][interval]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][items][0][price_data][recurring][interval_count]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[1][items][0][price_data][tax_behavior]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][items][0][price_data][unit_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[1][items][0][price_data][unit_amount_decimal]", "value"=>"<decimal>", "datatype"=>"string"}, {"name"=>"phases[1][items][0][quantity]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[1][items][0][tax_rates][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][items][0][tax_rates][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][items][1][billing_thresholds][usage_gte]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[1][items][1][price]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][items][1][price_data][currency]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][items][1][price_data][product]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][items][1][price_data][recurring][interval]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][items][1][price_data][recurring][interval_count]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[1][items][1][price_data][tax_behavior]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][items][1][price_data][unit_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[1][items][1][price_data][unit_amount_decimal]", "value"=>"<decimal>", "datatype"=>"string"}, {"name"=>"phases[1][items][1][quantity]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[1][items][1][tax_rates][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][items][1][tax_rates][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][add_invoice_items][0][price]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][add_invoice_items][0][price_data][currency]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][add_invoice_items][0][price_data][product]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][add_invoice_items][0][price_data][tax_behavior]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][add_invoice_items][0][price_data][unit_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[1][add_invoice_items][0][price_data][unit_amount_decimal]", "value"=>"<decimal>", "datatype"=>"string"}, {"name"=>"phases[1][add_invoice_items][0][quantity]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[1][add_invoice_items][0][tax_rates][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][add_invoice_items][0][tax_rates][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][add_invoice_items][1][price]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][add_invoice_items][1][price_data][currency]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][add_invoice_items][1][price_data][product]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][add_invoice_items][1][price_data][tax_behavior]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][add_invoice_items][1][price_data][unit_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[1][add_invoice_items][1][price_data][unit_amount_decimal]", "value"=>"<decimal>", "datatype"=>"string"}, {"name"=>"phases[1][add_invoice_items][1][quantity]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[1][add_invoice_items][1][tax_rates][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][add_invoice_items][1][tax_rates][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][application_fee_percent]", "value"=>"<number>", "datatype"=>"string"}, {"name"=>"phases[1][automatic_tax][enabled]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"phases[1][billing_cycle_anchor]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][billing_thresholds][amount_gte]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[1][billing_thresholds][reset_billing_cycle_anchor]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"phases[1][collection_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][coupon]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][currency]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][default_payment_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][default_tax_rates][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][default_tax_rates][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][description]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][end_date]", "value"=>"<unix-time>", "datatype"=>"string"}, {"name"=>"phases[1][invoice_settings][days_until_due]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[1][iterations]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"phases[1][metadata]", "value"=>"<object>", "datatype"=>"string"}, {"name"=>"phases[1][on_behalf_of]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][proration_behavior]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][transfer_data][destination]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phases[1][transfer_data][amount_percent]", "value"=>"<number>", "datatype"=>"string"}, {"name"=>"phases[1][trial]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"phases[1][trial_end]", "value"=>"<unix-time>", "datatype"=>"string"}]

HEADERS