@type automatic_tax() :: %{optional(:enabled) => boolean()}

Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.

@type bank_transfer() :: %{
  optional(:eu_bank_transfer) => eu_bank_transfer(),
  optional(:type) => binary()
}

Configuration for the bank transfer funding type, if the funding_type is set to bank_transfer.

@type eu_bank_transfer() :: %{optional(:country) => binary()}

Configuration for eu_bank_transfer funding type.

@type financial_connections() :: %{
  optional(:permissions) => [
    :balances | :ownership | :payment_method | :transactions
  ]
}

Additional fields for Financial Connections Session creation

@type mandate_options() :: %{optional(:transaction_type) => :business | :personal}

Additional fields for Mandate creation

@type payment_method_options() :: %{
  optional(:acss_debit) => acss_debit() | binary(),
  optional(:bancontact) => bancontact() | binary(),
  optional(:card) => card() | binary(),
  optional(:customer_balance) => customer_balance() | binary(),
  optional(:konbini) => map() | binary(),
  optional(:us_bank_account) => us_bank_account() | binary()
}

Payment-method-specific configuration to provide to invoices created by the subscription.

@type payment_settings() :: %{
  optional(:payment_method_options) => payment_method_options(),
  optional(:payment_method_types) =>
    [
      :ach_credit_transfer
      | :ach_debit
      | :acss_debit
      | :au_becs_debit
      | :bacs_debit
      | :bancontact
      | :boleto
      | :card
      | :customer_balance
      | :fpx
      | :giropay
      | :grabpay
      | :ideal
      | :konbini
      | :link
      | :paynow
      | :promptpay
      | :sepa_credit_transfer
      | :sepa_debit
      | :sofort
      | :us_bank_account
      | :wechat_pay
    ]
    | binary(),
  optional(:save_default_payment_method) => :off | :on_subscription
}

Payment settings to pass to invoices created by the subscription.

@type price_data() :: %{
  optional(:currency) => binary(),
  optional(:product) => binary(),
  optional(:recurring) => recurring(),
  optional(:tax_behavior) => :exclusive | :inclusive | :unspecified,
  optional(:unit_amount) => integer(),
  optional(:unit_amount_decimal) => binary()
}

Data used to generate a new Price object inline.

@type recurring() :: %{
  optional(:interval) => :day | :month | :week | :year,
  optional(:interval_count) => integer()
}

The recurring components of a price such as interval and interval_count.

@type t() :: %Stripe.Subscription{
  application: (binary() | term() | term()) | nil,
  application_fee_percent: term() | nil,
  automatic_tax: term(),
  billing_cycle_anchor: integer(),
  billing_thresholds: term() | nil,
  cancel_at: integer() | nil,
  cancel_at_period_end: boolean(),
  canceled_at: integer() | nil,
  collection_method: binary(),
  created: integer(),
  currency: binary(),
  current_period_end: integer(),
  current_period_start: integer(),
  customer: binary() | Stripe.Customer.t() | Stripe.DeletedCustomer.t(),
  days_until_due: integer() | nil,
  default_payment_method: (binary() | Stripe.PaymentMethod.t()) | nil,
  default_source: (binary() | Stripe.PaymentSource.t()) | nil,
  default_tax_rates: term() | nil,
  description: binary() | nil,
  discount: term() | nil,
  ended_at: integer() | nil,
  id: binary(),
  items: term(),
  latest_invoice: (binary() | Stripe.Invoice.t()) | nil,
  livemode: boolean(),
  metadata: term(),
  next_pending_invoice_item_invoice: integer() | nil,
  object: binary(),
  on_behalf_of: (binary() | Stripe.Account.t()) | nil,
  pause_collection: term() | nil,
  payment_settings: term() | nil,
  pending_invoice_item_interval: term() | nil,
  pending_setup_intent: (binary() | Stripe.SetupIntent.t()) | nil,
  pending_update: term() | nil,
  schedule: (binary() | Stripe.SubscriptionSchedule.t()) | nil,
  start_date: integer(),
  status: binary(),
  test_clock: (binary() | Stripe.TestHelpers.TestClock.t()) | nil,
  transfer_data: term() | nil,
  trial_end: integer() | nil,
  trial_start: integer() | nil
}

The subscription type.

• application_fee_percent 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.
• livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
• collection_method Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the 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.
• default_payment_method ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
• metadata 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.
• description The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces.
• pending_setup_intent You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the SCA Migration Guide.
• discount Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.
• start_date Date when the subscription was first created. The date might differ from the created date due to backdating.
• on_behalf_of The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
• pause_collection If specified, payment collection for this subscription will be paused.
• customer ID of the customer who owns the subscription.
• ended_at If the subscription has ended, the date the subscription ended.
• days_until_due Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
• payment_settings Payment settings passed on to invoices created by the subscription.
• application ID of the Connect Application that created the subscription.
• pending_invoice_item_interval Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
• billing_thresholds Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
• next_pending_invoice_item_invoice Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.
• default_source ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If default_payment_method is also set, default_payment_method will take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
• cancel_at_period_end If the subscription has been canceled with the at_period_end flag set to true, cancel_at_period_end on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.
• object String representing the object's type. Objects of the same type share the same value.
• billing_cycle_anchor Determines the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.
• test_clock ID of the test clock this subscription belongs to.
• automatic_tax
• schedule The schedule attached to the subscription
• canceled_at If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
• current_period_end End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
• latest_invoice The most recent invoice this subscription has generated.
• currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
• created Time at which the object was created. Measured in seconds since the Unix epoch.
• trial_end If the subscription has a trial, the end of that trial.
• cancel_at A date in the future at which the subscription will automatically get canceled
• trial_start If the subscription has a trial, the beginning of that trial.
• current_period_start Start of the current period that the subscription has been invoiced for.
• status Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, or unpaid.

For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active state. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal state, the open invoice will be voided and no further invoices will be generated.

A subscription that is currently in a trial period is trialing and moves to active when the trial period is over.

If subscription collection_method=charge_automatically it becomes past_due when payment to renew it fails and canceled or unpaid (depending on your subscriptions settings) when Stripe has exhausted all payment retry attempts.

If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.

• items List of subscription items, each with an attached price.
• transfer_data The account (if any) the 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.
• id Unique identifier for the object.
• pending_update If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.
• default_tax_rates The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.

@type transfer_data() :: %{
  optional(:amount_percent) => number(),
  optional(:destination) => binary()
}

If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.