The Subscription Schedule object 

Attributes

• idstring

  Unique identifier for the object.

• current_phasenullable object

  Object representing the start and end dates for the current phase of the subscription schedule, if it is active.

  Hide child attributes

  • current_phase.end_datetimestamp

    The end of this phase of the subscription schedule.

  • current_phase.start_datetimestamp

    The start of this phase of the subscription schedule.

• customerstringExpandable

  ID of the customer who owns the subscription schedule.

• metadatanullable object

  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• phasesarray of objects

  Configuration for the subscription schedule’s phases.

  Hide child attributes

  • phases.add_invoice_itemsarray of objects

    A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.

    Hide child attributes

    • phases.add_invoice_items.discountsarray of objects

      The stackable discounts that will be applied to the item.

      Hide child attributes

      • phases.add_invoice_items.discounts.couponnullable stringExpandable

        ID of the coupon to create a new discount for.

      • phases.add_invoice_items.discounts.discountnullable stringExpandable

        ID of an existing discount on the object (or one of its ancestors) to reuse.

      • phases.add_invoice_items.discounts.promotion_codenullable stringExpandable

        ID of the promotion code to create a new discount for.

    • phases.add_invoice_items.metadatanullable object

      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • phases.add_invoice_items.periodobject

      The period associated with this invoice item.

      Hide child attributes

      • phases.add_invoice_items.period.endobject

        End of the invoice item period.

        Hide child attributes

        • phases.add_invoice_items.period.end.timestampnullable timestamp

          A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to period.start.

        • phases.add_invoice_items.period.end.typeenum

          Select how to calculate the end of the invoice item period.

          Possible enum values

          min_item_period_end The minimum current_period_end of all underlying subscription items whose periods overlap this phase

          phase_end End of the phase

          timestamp Custom timestamp to use for the end of the invoice item period

      • phases.add_invoice_items.period.startobject

        Start of the invoice item period.

        Hide child attributes

        • phases.add_invoice_items.period.start.timestampnullable timestamp

          A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to period.end.

        • phases.add_invoice_items.period.start.typeenum

          Select how to calculate the start of the invoice item period.

          Possible enum values

          max_item_period_start The maximum current_period_start of all underlying subscription items whose periods overlap this phase

          phase_start Start of the phase

          timestamp Custom timestamp to use for the start of the invoice item period

    • phases.add_invoice_items.pricestringExpandable

      ID of the price used to generate the invoice item.

    • phases.add_invoice_items.quantitynullable integer

      The quantity of the invoice item.

    • phases.add_invoice_items.tax_ratesnullable array of objects

      The tax rates which apply to the item. When set, the default_tax_rates do not apply to this item.

      Hide child attributes

      • phases.add_invoice_items.tax_rates.idstring

        Unique identifier for the object.

      • phases.add_invoice_items.tax_rates.objectstring

        String representing the object’s type. Objects of the same type share the same value.

      • phases.add_invoice_items.tax_rates.activeboolean

        Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.

      • phases.add_invoice_items.tax_rates.countrynullable string

        Two-letter country code (ISO 3166-1 alpha-2).

      • phases.add_invoice_items.tax_rates.createdtimestamp

        Time at which the object was created. Measured in seconds since the Unix epoch.

      • phases.add_invoice_items.tax_rates.descriptionnullable string

        An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

      • phases.add_invoice_items.tax_rates.display_namestring

        The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

      • phases.add_invoice_items.tax_rates.effective_percentagenullable float

        Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product’s taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.

      • phases.add_invoice_items.tax_rates.flat_amountnullable object

        The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.

        Hide child attributes

        • phases.add_invoice_items.tax_rates.flat_amount.amountinteger

          Amount of the tax when the rate_type is flat_amount. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

        • phases.add_invoice_items.tax_rates.flat_amount.currencystring

          Three-letter ISO currency code, in lowercase.

      • phases.add_invoice_items.tax_rates.inclusiveboolean

        This specifies if the tax rate is inclusive or exclusive.

      • phases.add_invoice_items.tax_rates.jurisdictionnullable string

        The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

      • phases.add_invoice_items.tax_rates.jurisdiction_levelnullable enum

        The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.

        Possible enum values

        city

        country

        county

        district

        multiple

        state

      • phases.add_invoice_items.tax_rates.livemodeboolean

        Has the value true if the object exists in live mode or the value false if the object exists in test mode.

      • phases.add_invoice_items.tax_rates.metadatanullable object

        Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

      • phases.add_invoice_items.tax_rates.percentagefloat

        Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.

      • phases.add_invoice_items.tax_rates.rate_typenullable enum

        Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.

        Possible enum values

        flat_amount A fixed amount applied as tax, regardless of the taxable amount, such as a retail delivery fee.

        percentage A tax rate expressed as a percentage of the taxable amount, such as the sales tax rate in California.

      • phases.add_invoice_items.tax_rates.statenullable string

        ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.

      • phases.add_invoice_items.tax_rates.tax_typenullable enum

        The high-level tax type, such as vat or sales_tax.

        Possible enum values

        amusement_tax Amusement Tax

        communications_tax Communications Tax

        gst Goods and Services Tax

        hst Harmonized Sales Tax

        igst Integrated Goods and Services Tax

        jct Japanese Consumption Tax

        lease_tax Chicago Lease Tax

        pst Provincial Sales Tax

        qst Quebec Sales Tax

        retail_delivery_fee Retail Delivery Fee

        Show 4 more

  • phases.application_fee_percentnullable floatConnect only

    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner’s Stripe account during this phase of the schedule.

  • phases.automatic_taxnullable object

    Automatic tax settings for this phase.

    Hide child attributes

    • phases.automatic_tax.disabled_reasonnullable enum

      If Stripe disabled automatic tax, this enum describes why.

      Possible enum values

      requires_location_inputs Stripe’s systems automatically turned off Tax for this subscription schedule when finalizing one of its invoices with a missing or incomplete location for your customer.

    • phases.automatic_tax.enabledboolean

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

    • phases.automatic_tax.liabilitynullable objectConnect only

      The account that’s liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.

      Hide child attributes

      • phases.automatic_tax.liability.accountnullable stringExpandable

        The connected account being referenced when type is account.

      • phases.automatic_tax.liability.typeenum

        Type of the account referenced.

        Possible enum values

        account Indicates that the account being referenced is a connected account which is different from the account making the API request but related to it.

        self Indicates that the account being referenced is the account making the API request.

  • phases.billing_cycle_anchornullable enum

    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.

    Possible enum values

    automatic

    phase_start

  • phases.billing_thresholdsnullable object

    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period

    Hide child attributes

    • phases.billing_thresholds.amount_gtenullable integer

      Monetary threshold that triggers the subscription to create an invoice

    • phases.billing_thresholds.reset_billing_cycle_anchornullable boolean

      Indicates if the billing_cycle_anchor should be reset when a threshold is reached. If true, billing_cycle_anchor will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be true if the subscription contains items with plans that have aggregate_usage=last_ever.

  • phases.collection_methodnullable enum

    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 and mark the subscription as active.

    Possible enum values

    charge_automatically

    send_invoice

  • phases.currencyenum

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

  • phases.default_payment_methodnullable stringExpandable

    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.

  • phases.default_tax_ratesnullable array of objects

    The default tax rates to apply to the subscription during this phase of the subscription schedule.

    Hide child attributes

    • phases.default_tax_rates.idstring

      Unique identifier for the object.

    • phases.default_tax_rates.objectstring

      String representing the object’s type. Objects of the same type share the same value.

    • phases.default_tax_rates.activeboolean

      Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.

    • phases.default_tax_rates.countrynullable string

      Two-letter country code (ISO 3166-1 alpha-2).

    • phases.default_tax_rates.createdtimestamp

      Time at which the object was created. Measured in seconds since the Unix epoch.

    • phases.default_tax_rates.descriptionnullable string

      An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

    • phases.default_tax_rates.display_namestring

      The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

    • phases.default_tax_rates.effective_percentagenullable float

      Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product’s taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.

    • phases.default_tax_rates.flat_amountnullable object

      The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.

      Hide child attributes

      • phases.default_tax_rates.flat_amount.amountinteger

        Amount of the tax when the rate_type is flat_amount. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

      • phases.default_tax_rates.flat_amount.currencystring

        Three-letter ISO currency code, in lowercase.

    • phases.default_tax_rates.inclusiveboolean

      This specifies if the tax rate is inclusive or exclusive.

    • phases.default_tax_rates.jurisdictionnullable string

      The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

    • phases.default_tax_rates.jurisdiction_levelnullable enum

      The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.

      Possible enum values

      city

      country

      county

      district

      multiple

      state

    • phases.default_tax_rates.livemodeboolean

      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • phases.default_tax_rates.metadatanullable object

      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • phases.default_tax_rates.percentagefloat

      Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.

    • phases.default_tax_rates.rate_typenullable enum

      Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.

      Possible enum values

      flat_amount A fixed amount applied as tax, regardless of the taxable amount, such as a retail delivery fee.

      percentage A tax rate expressed as a percentage of the taxable amount, such as the sales tax rate in California.

    • phases.default_tax_rates.statenullable string

      ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.

    • phases.default_tax_rates.tax_typenullable enum

      The high-level tax type, such as vat or sales_tax.

      Possible enum values

      amusement_tax Amusement Tax

      communications_tax Communications Tax

      gst Goods and Services Tax

      hst Harmonized Sales Tax

      igst Integrated Goods and Services Tax

      jct Japanese Consumption Tax

      lease_tax Chicago Lease Tax

      pst Provincial Sales Tax

      qst Quebec Sales Tax

      retail_delivery_fee Retail Delivery Fee

      Show 4 more

  • phases.descriptionnullable string

    Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

  • phases.discountsarray of objects

    The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.

    Hide child attributes

    • phases.discounts.couponnullable stringExpandable

      ID of the coupon to create a new discount for.

    • phases.discounts.discountnullable stringExpandable

      ID of an existing discount on the object (or one of its ancestors) to reuse.

    • phases.discounts.promotion_codenullable stringExpandable

      ID of the promotion code to create a new discount for.

  • phases.end_datetimestamp

    The end of this phase of the subscription schedule.

  • phases.invoice_settingsnullable object

    The invoice settings applicable during this phase.

    Hide child attributes

    • phases.invoice_settings.account_tax_idsnullable array of stringsExpandable

      The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.

    • phases.invoice_settings.days_until_duenullable integer

      Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be null for subscription schedules where billing=charge_automatically.

    • phases.invoice_settings.issuernullable objectConnect only

      The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

      Hide child attributes

      • phases.invoice_settings.issuer.accountnullable stringExpandable

        The connected account being referenced when type is account.

      • phases.invoice_settings.issuer.typeenum

        Type of the account referenced.

        Possible enum values

        account Indicates that the account being referenced is a connected account which is different from the account making the API request but related to it.

        self Indicates that the account being referenced is the account making the API request.

  • phases.itemsarray of objects

    Subscription items to configure the subscription to during this phase of the subscription schedule.

    Hide child attributes

    • phases.items.billing_thresholdsnullable object

      Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period

      Hide child attributes

      • phases.items.billing_thresholds.usage_gtenullable integer

        Usage threshold that triggers the subscription to create an invoice

    • phases.items.discountsarray of objects

      The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.

      Hide child attributes

      • phases.items.discounts.couponnullable stringExpandable

        ID of the coupon to create a new discount for.

      • phases.items.discounts.discountnullable stringExpandable

        ID of an existing discount on the object (or one of its ancestors) to reuse.

      • phases.items.discounts.promotion_codenullable stringExpandable

        ID of the promotion code to create a new discount for.

    • phases.items.metadatanullable object

      Set of key-value pairs that you can attach to an item. Metadata on this item will update the underlying subscription item’s metadata when the phase is entered.

    • phases.items.pricestringExpandable

      ID of the price to which the customer should be subscribed.

    • phases.items.quantitynullable integer

      Quantity of the plan to which the customer should be subscribed.

    • phases.items.tax_ratesnullable array of objects

      The tax rates which apply to this phase_item. When set, the default_tax_rates on the phase do not apply to this phase_item.

      Hide child attributes

      • phases.items.tax_rates.idstring

        Unique identifier for the object.

      • phases.items.tax_rates.objectstring

        String representing the object’s type. Objects of the same type share the same value.

      • phases.items.tax_rates.activeboolean

        Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.

      • phases.items.tax_rates.countrynullable string

        Two-letter country code (ISO 3166-1 alpha-2).

      • phases.items.tax_rates.createdtimestamp

        Time at which the object was created. Measured in seconds since the Unix epoch.

      • phases.items.tax_rates.descriptionnullable string

        An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

      • phases.items.tax_rates.display_namestring

        The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

      • phases.items.tax_rates.effective_percentagenullable float

        Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product’s taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.

      • phases.items.tax_rates.flat_amountnullable object

        The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.

        Hide child attributes

        • phases.items.tax_rates.flat_amount.amountinteger

          Amount of the tax when the rate_type is flat_amount. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

        • phases.items.tax_rates.flat_amount.currencystring

          Three-letter ISO currency code, in lowercase.

      • phases.items.tax_rates.inclusiveboolean

        This specifies if the tax rate is inclusive or exclusive.

      • phases.items.tax_rates.jurisdictionnullable string

        The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

      • phases.items.tax_rates.jurisdiction_levelnullable enum

        The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.

        Possible enum values

        city

        country

        county

        district

        multiple

        state

      • phases.items.tax_rates.livemodeboolean

        Has the value true if the object exists in live mode or the value false if the object exists in test mode.

      • phases.items.tax_rates.metadatanullable object

        Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

      • phases.items.tax_rates.percentagefloat

        Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.

      • phases.items.tax_rates.rate_typenullable enum

        Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.

        Possible enum values

        flat_amount A fixed amount applied as tax, regardless of the taxable amount, such as a retail delivery fee.

        percentage A tax rate expressed as a percentage of the taxable amount, such as the sales tax rate in California.

      • phases.items.tax_rates.statenullable string

        ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.

      • phases.items.tax_rates.tax_typenullable enum

        The high-level tax type, such as vat or sales_tax.

        Possible enum values

        amusement_tax Amusement Tax

        communications_tax Communications Tax

        gst Goods and Services Tax

        hst Harmonized Sales Tax

        igst Integrated Goods and Services Tax

        jct Japanese Consumption Tax

        lease_tax Chicago Lease Tax

        pst Provincial Sales Tax

        qst Quebec Sales Tax

        retail_delivery_fee Retail Delivery Fee

        Show 4 more

  • phases.metadatanullable object

    Set of key-value pairs that you can attach to a phase. Metadata on a schedule’s phase will update the underlying subscription’s metadata when the phase is entered. Updating the underlying subscription’s metadata directly will not affect the current phase’s metadata.

  • phases.on_behalf_ofnullable stringExpandableConnect only

    The account (if any) the charge was made on behalf of for charges associated with the schedule’s subscription. See the Connect documentation for details.

  • phases.proration_behaviorenum

    When transitioning phases, controls how prorations are handled (if any). Possible values are create_prorations, none, and always_invoice.

    Possible enum values

    always_invoice

    create_prorations

    none

  • phases.start_datetimestamp

    The start of this phase of the subscription schedule.

  • phases.transfer_datanullable objectConnect only

    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.

    Hide child attributes

    • phases.transfer_data.amount_percentnullable float

      A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.

    • phases.transfer_data.destinationstringExpandable

      The account where funds from the payment will be transferred to upon payment success.

  • phases.trial_endnullable timestamp

    When the trial ends within the phase.

• statusenum

  The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.

  Possible enum values

  active

  canceled

  completed

  not_started

  released

• subscriptionnullable stringExpandable

  ID of the subscription managed by the subscription schedule.

More attributes

Collapse all

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• applicationnullable stringExpandableConnect only

  ID of the Connect Application that created the schedule.

• billing_modeobject

  The billing mode that will be used to process all future operations for the subscription schedule.

  Hide child attributes

  • billing_mode.typeenum

    Controls how prorations and invoices for subscriptions are calculated and orchestrated.

    Possible enum values

    classic Calculations for subscriptions and invoices are based on legacy defaults.

    flexible Supports more flexible calculation and orchestration options for subscriptions and invoices.

  • billing_mode.updated_atnullable timestamp

    Details on when the current billing_mode was adopted.

• canceled_atnullable timestamp

  Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.

• completed_atnullable timestamp

  Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.

• createdtimestamp

  Time at which the object was created. Measured in seconds since the Unix epoch.

• default_settingsobject

  Object representing the subscription schedule’s default settings.

  Hide child attributes

  • default_settings.application_fee_percentnullable floatConnect only

    A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner’s Stripe account during this phase of the schedule.

  • default_settings.automatic_taxobject

    Default settings for automatic tax computation.

    Hide child attributes

    • default_settings.automatic_tax.disabled_reasonnullable enum

      If Stripe disabled automatic tax, this enum describes why.

      Possible enum values

      requires_location_inputs Stripe’s systems automatically turned off Tax for this subscription schedule when finalizing one of its invoices with a missing or incomplete location for your customer.

    • default_settings.automatic_tax.enabledboolean

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

    • default_settings.automatic_tax.liabilitynullable objectConnect only

      The account that’s liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.

      Hide child attributes

      • default_settings.automatic_tax.liability.accountnullable stringExpandable

        The connected account being referenced when type is account.

      • default_settings.automatic_tax.liability.typeenum

        Type of the account referenced.

        Possible enum values

        account Indicates that the account being referenced is a connected account which is different from the account making the API request but related to it.

        self Indicates that the account being referenced is the account making the API request.

  • default_settings.billing_cycle_anchorenum

    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.

    Possible enum values

    automatic

    phase_start

  • default_settings.billing_thresholdsnullable object

    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period

    Hide child attributes

    • default_settings.billing_thresholds.amount_gtenullable integer

      Monetary threshold that triggers the subscription to create an invoice

    • default_settings.billing_thresholds.reset_billing_cycle_anchornullable boolean

      Indicates if the billing_cycle_anchor should be reset when a threshold is reached. If true, billing_cycle_anchor will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be true if the subscription contains items with plans that have aggregate_usage=last_ever.

  • default_settings.collection_methodnullable enum

    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 and mark the subscription as active.

    Possible enum values

    charge_automatically Attempt payment using the default source attached to the customer.

    send_invoice Email payment instructions to the customer.

  • default_settings.default_payment_methodnullable stringExpandable

    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.

  • default_settings.descriptionnullable string

    Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

  • default_settings.invoice_settingsobject

    The subscription schedule’s default invoice settings.

    Hide child attributes

    • default_settings.invoice_settings.account_tax_idsnullable array of stringsExpandable

      The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.

    • default_settings.invoice_settings.days_until_duenullable integer

      Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be null for subscription schedules where billing=charge_automatically.

    • default_settings.invoice_settings.issuerobjectConnect only

      The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

      Hide child attributes

      • default_settings.invoice_settings.issuer.accountnullable stringExpandable

        The connected account being referenced when type is account.

      • default_settings.invoice_settings.issuer.typeenum

        Type of the account referenced.

        Possible enum values

        account Indicates that the account being referenced is a connected account which is different from the account making the API request but related to it.

        self Indicates that the account being referenced is the account making the API request.

  • default_settings.on_behalf_ofnullable stringExpandableConnect only

    The account (if any) the charge was made on behalf of for charges associated with the schedule’s subscription. See the Connect documentation for details.

  • default_settings.transfer_datanullable objectConnect only

    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.

    Hide child attributes

    • default_settings.transfer_data.amount_percentnullable float

      A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.

    • default_settings.transfer_data.destinationstringExpandable

      The account where funds from the payment will be transferred to upon payment success.

• end_behaviorenum

  Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.

  Possible enum values

  cancel Cancel the underlying subscription when the subscription schedule ends.

  release Persist the underlying subscription in its current state when the subscription schedule ends.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• released_atnullable timestamp

  Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.

• released_subscriptionnullable string

  ID of the subscription once managed by the subscription schedule (if it is released).

• test_clocknullable stringExpandable

  ID of the test clock this subscription schedule belongs to.