Schema2020-08-27object

subscription_schedules_resource_default_settings

Source: openapi/spec3.json
Commit: d70de345383d
Active snapshot: da69df7e6e11

SubscriptionSchedulesResourceDefaultSettingsAutomaticTax

object

enabled boolean

required

Whether Stripe automatically computes tax on invoices created during this phase.

Root JSON Schema

{"properties":{"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/subscription_schedules_resource_default_settings_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"],"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"},"default_payment_method":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/payment_method"}],"description":"ID of the default payment method for 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"}]}},"invoice_settings":{"anyOf":[{"$ref":"#/components/schemas/invoice_setting_subscription_schedule_setting"}],"description":"The subscription schedule's default invoice settings.","nullable":true},"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}},"required":["billing_cycle_anchor"],"title":"SubscriptionSchedulesResourceDefaultSettings","type":"object","x-expandableFields":["automatic_tax","billing_thresholds","default_payment_method","invoice_settings","transfer_data"]}