Schema2020-08-27object
subscription_schedule_phase_configuration

A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period.
Source: openapi/spec3.json
Commit: d70de345383d
Active snapshot: da69df7e6e11
SchedulesPhaseAutomaticTax

object
enabled boolean
required
Whether Stripe automatically computes tax on invoices created during this phase.
Root JSON Schema
{"description":"A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period.","properties":{"add_invoice_items":{"description":"A list of prices and quantities that will generate invoice items appended to the first invoice for this phase.","items":{"$ref":"#/components/schemas/subscription_schedule_add_invoice_item"},"type":"array"},"application_fee_percent":{"description":"A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule.","nullable":true,"type":"number"},"automatic_tax":{"$ref":"#/components/schemas/schedules_phase_automatic_tax"},"billing_cycle_anchor":{"description":"Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).","enum":["automatic","phase_start"],"nullable":true,"type":"string"},"billing_thresholds":{"anyOf":[{"$ref":"#/components/schemas/subscription_billing_thresholds"}],"description":"Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period","nullable":true},"collection_method":{"description":"Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions.","enum":["charge_automatically","send_invoice"],"nullable":true,"type":"string"},"coupon":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/coupon"},{"$ref":"#/components/schemas/deleted_coupon"}],"description":"ID of the coupon to use during this phase of the subscription schedule.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/coupon"},{"$ref":"#/components/schemas/deleted_coupon"}]}},"default_payment_method":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/payment_method"}],"description":"ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/payment_method"}]}},"default_tax_rates":{"description":"The default tax rates to apply to the subscription during this phase of the subscription schedule.","items":{"$ref":"#/components/schemas/tax_rate"},"nullable":true,"type":"array"},"end_date":{"description":"The end of this phase of the subscription schedule.","format":"unix-time","type":"integer"},"invoice_settings":{"anyOf":[{"$ref":"#/components/schemas/invoice_setting_subscription_schedule_setting"}],"description":"The invoice settings applicable during this phase.","nullable":true},"items":{"description":"Subscription items to configure the subscription to during this phase of the subscription schedule.","items":{"$ref":"#/components/schemas/subscription_schedule_configuration_item"},"type":"array"},"proration_behavior":{"description":"If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`.","enum":["always_invoice","create_prorations","none"],"type":"string"},"start_date":{"description":"The start of this phase of the subscription schedule.","format":"unix-time","type":"integer"},"transfer_data":{"anyOf":[{"$ref":"#/components/schemas/subscription_transfer_data"}],"description":"The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.","nullable":true},"trial_end":{"description":"When the trial ends within the phase.","format":"unix-time","nullable":true,"type":"integer"}},"required":["add_invoice_items","end_date","items","proration_behavior","start_date"],"title":"SubscriptionSchedulePhaseConfiguration","type":"object","x-expandableFields":["add_invoice_items","automatic_tax","billing_thresholds","coupon","default_payment_method","default_tax_rates","invoice_settings","items","transfer_data"]}