# File generated from our OpenAPI spec
# frozen_string_literal: true

module Stripe
  # Subscriptions allow you to charge a customer on a recurring basis.
  #
  # Related guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creating)
  class Subscription < APIResource
    extend Stripe::APIOperations::Create
    extend Stripe::APIOperations::List
    extend Stripe::APIOperations::Search
    include Stripe::APIOperations::Save

    OBJECT_NAME = "subscription"
    def self.object_name
      "subscription"
    end

    class AutomaticTax < Stripe::StripeObject
      class Liability < Stripe::StripeObject
        # The connected account being referenced when `type` is `account`.
        attr_reader :account
        # Type of the account referenced.
        attr_reader :type
      end
      # If Stripe disabled automatic tax, this enum describes why.
      attr_reader :disabled_reason
      # Whether Stripe automatically computes tax on this subscription.
      attr_reader :enabled
      # 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.
      attr_reader :liability
    end

    class BillingCycleAnchorConfig < Stripe::StripeObject
      # The day of the month of the billing_cycle_anchor.
      attr_reader :day_of_month
      # The hour of the day of the billing_cycle_anchor.
      attr_reader :hour
      # The minute of the hour of the billing_cycle_anchor.
      attr_reader :minute
      # The month to start full cycle billing periods.
      attr_reader :month
      # The second of the minute of the billing_cycle_anchor.
      attr_reader :second
    end

    class BillingModeDetails < Stripe::StripeObject
      # Details on when the current billing_mode was adopted.
      attr_reader :updated_at
    end

    class BillingThresholds < Stripe::StripeObject
      # Monetary threshold that triggers the subscription to create an invoice
      attr_reader :amount_gte
      # 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`.
      attr_reader :reset_billing_cycle_anchor
    end

    class CancellationDetails < Stripe::StripeObject
      # Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
      attr_reader :comment
      # The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
      attr_reader :feedback
      # Why this subscription was canceled.
      attr_reader :reason
    end

    class InvoiceSettings < Stripe::StripeObject
      class Issuer < Stripe::StripeObject
        # The connected account being referenced when `type` is `account`.
        attr_reader :account
        # Type of the account referenced.
        attr_reader :type
      end
      # The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
      attr_reader :account_tax_ids
      # Attribute for field issuer
      attr_reader :issuer
    end

    class LastPriceMigrationError < Stripe::StripeObject
      class FailedTransition < Stripe::StripeObject
        # The original price to be migrated.
        attr_reader :source_price
        # The intended resulting price of the migration.
        attr_reader :target_price
      end
      # The time at which the price migration encountered an error.
      attr_reader :errored_at
      # The involved price pairs in each failed transition.
      attr_reader :failed_transitions
      # The type of error encountered by the price migration.
      attr_reader :type
    end

    class PauseCollection < Stripe::StripeObject
      # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
      attr_reader :behavior
      # The time after which the subscription will resume collecting payments.
      attr_reader :resumes_at
    end

    class PaymentSettings < Stripe::StripeObject
      class PaymentMethodOptions < Stripe::StripeObject
        class AcssDebit < Stripe::StripeObject
          class MandateOptions < Stripe::StripeObject
            # Transaction type of the mandate.
            attr_reader :transaction_type
          end
          # Attribute for field mandate_options
          attr_reader :mandate_options
          # Bank account verification method.
          attr_reader :verification_method
        end

        class Bancontact < Stripe::StripeObject
          # Preferred language of the Bancontact authorization page that the customer is redirected to.
          attr_reader :preferred_language
        end

        class Card < Stripe::StripeObject
          class MandateOptions < Stripe::StripeObject
            # Amount to be charged for future payments.
            attr_reader :amount
            # One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
            attr_reader :amount_type
            # A description of the mandate or subscription that is meant to be displayed to the customer.
            attr_reader :description
          end
          # Attribute for field mandate_options
          attr_reader :mandate_options
          # Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
          attr_reader :network
          # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
          attr_reader :request_three_d_secure
        end

        class CustomerBalance < Stripe::StripeObject
          class BankTransfer < Stripe::StripeObject
            class EuBankTransfer < Stripe::StripeObject
              # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
              attr_reader :country
            end
            # Attribute for field eu_bank_transfer
            attr_reader :eu_bank_transfer
            # The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
            attr_reader :type
          end
          # Attribute for field bank_transfer
          attr_reader :bank_transfer
          # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
          attr_reader :funding_type
        end

        class IdBankTransfer < Stripe::StripeObject; end
        class Konbini < Stripe::StripeObject; end
        class SepaDebit < Stripe::StripeObject; end

        class UsBankAccount < Stripe::StripeObject
          class FinancialConnections < Stripe::StripeObject
            class Filters < Stripe::StripeObject
              # The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
              attr_reader :account_subcategories
              # The institution to use to filter for possible accounts to link.
              attr_reader :institution
            end
            # Attribute for field filters
            attr_reader :filters
            # The list of permissions to request. The `payment_method` permission must be included.
            attr_reader :permissions
            # Data features requested to be retrieved upon account creation.
            attr_reader :prefetch
          end
          # Attribute for field financial_connections
          attr_reader :financial_connections
          # Bank account verification method.
          attr_reader :verification_method
        end
        # This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.
        attr_reader :acss_debit
        # This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.
        attr_reader :bancontact
        # This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.
        attr_reader :card
        # This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.
        attr_reader :customer_balance
        # This sub-hash contains details about the Indonesia bank transfer payment method options to pass to invoices created by the subscription.
        attr_reader :id_bank_transfer
        # This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.
        attr_reader :konbini
        # This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription.
        attr_reader :sepa_debit
        # This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.
        attr_reader :us_bank_account
      end
      # Payment-method-specific configuration to provide to invoices created by the subscription.
      attr_reader :payment_method_options
      # The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).
      attr_reader :payment_method_types
      # Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`.
      attr_reader :save_default_payment_method
    end

    class PendingInvoiceItemInterval < Stripe::StripeObject
      # Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
      attr_reader :interval
      # The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
      attr_reader :interval_count
    end

    class PendingUpdate < Stripe::StripeObject
      # If the update is applied, 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.
      attr_reader :billing_cycle_anchor
      # The point after which the changes reflected by this update will be discarded and no longer applied.
      attr_reader :expires_at
      # The number of iterations of prebilling to apply.
      attr_reader :prebilling_iterations
      # List of subscription items, each with an attached plan, that will be set if the update is applied.
      attr_reader :subscription_items
      # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.
      attr_reader :trial_end
      # Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
      attr_reader :trial_from_plan
    end

    class Prebilling < Stripe::StripeObject
      # ID of the prebilling invoice.
      attr_reader :invoice
      # The end of the last period for which the invoice pre-bills.
      attr_reader :period_end
      # The start of the first period for which the invoice pre-bills.
      attr_reader :period_start
      # Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
      attr_reader :update_behavior
    end

    class TransferData < Stripe::StripeObject
      # 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.
      attr_reader :amount_percent
      # The account where funds from the payment will be transferred to upon payment success.
      attr_reader :destination
    end

    class TrialSettings < Stripe::StripeObject
      class EndBehavior < Stripe::StripeObject
        # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
        attr_reader :missing_payment_method
      end
      # Defines how a subscription behaves when a free trial ends.
      attr_reader :end_behavior
    end

    class CancelParams < Stripe::RequestParams
      class CancellationDetails < Stripe::RequestParams
        # Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
        attr_accessor :comment
        # The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
        attr_accessor :feedback

        def initialize(comment: nil, feedback: nil)
          @comment = comment
          @feedback = feedback
        end
      end
      # Details about why this subscription was cancelled
      attr_accessor :cancellation_details
      # Specifies which fields in the response should be expanded.
      attr_accessor :expand
      # Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. Defaults to `false`.
      attr_accessor :invoice_now
      # Will generate a proration invoice item that credits remaining unused time until the subscription period end. Defaults to `false`.
      attr_accessor :prorate

      def initialize(cancellation_details: nil, expand: nil, invoice_now: nil, prorate: nil)
        @cancellation_details = cancellation_details
        @expand = expand
        @invoice_now = invoice_now
        @prorate = prorate
      end
    end

    class UpdateParams < Stripe::RequestParams
      class AddInvoiceItem < Stripe::RequestParams
        class Discount < Stripe::RequestParams
          class DiscountEnd < Stripe::RequestParams
            class Duration < Stripe::RequestParams
              # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
              attr_accessor :interval
              # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
              attr_accessor :interval_count

              def initialize(interval: nil, interval_count: nil)
                @interval = interval
                @interval_count = interval_count
              end
            end
            # Time span for the redeemed discount.
            attr_accessor :duration
            # A precise Unix timestamp for the discount to end. Must be in the future.
            attr_accessor :timestamp
            # The type of calculation made to determine when the discount ends.
            attr_accessor :type

            def initialize(duration: nil, timestamp: nil, type: nil)
              @duration = duration
              @timestamp = timestamp
              @type = type
            end
          end
          # ID of the coupon to create a new discount for.
          attr_accessor :coupon
          # ID of an existing discount on the object (or one of its ancestors) to reuse.
          attr_accessor :discount
          # Details to determine how long the discount should be applied for.
          attr_accessor :discount_end
          # ID of the promotion code to create a new discount for.
          attr_accessor :promotion_code

          def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
            @coupon = coupon
            @discount = discount
            @discount_end = discount_end
            @promotion_code = promotion_code
          end
        end

        class PriceData < Stripe::RequestParams
          # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
          attr_accessor :currency
          # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
          attr_accessor :product
          # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
          attr_accessor :tax_behavior
          # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
          attr_accessor :unit_amount
          # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
          attr_accessor :unit_amount_decimal

          def initialize(
            currency: nil,
            product: nil,
            tax_behavior: nil,
            unit_amount: nil,
            unit_amount_decimal: nil
          )
            @currency = currency
            @product = product
            @tax_behavior = tax_behavior
            @unit_amount = unit_amount
            @unit_amount_decimal = unit_amount_decimal
          end
        end
        # The coupons to redeem into discounts for the item.
        attr_accessor :discounts
        # The ID of the price object. One of `price` or `price_data` is required.
        attr_accessor :price
        # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
        attr_accessor :price_data
        # Quantity for this item. Defaults to 1.
        attr_accessor :quantity
        # The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
        attr_accessor :tax_rates

        def initialize(discounts: nil, price: nil, price_data: nil, quantity: nil, tax_rates: nil)
          @discounts = discounts
          @price = price
          @price_data = price_data
          @quantity = quantity
          @tax_rates = tax_rates
        end
      end

      class AutomaticTax < Stripe::RequestParams
        class Liability < Stripe::RequestParams
          # The connected account being referenced when `type` is `account`.
          attr_accessor :account
          # Type of the account referenced in the request.
          attr_accessor :type

          def initialize(account: nil, type: nil)
            @account = account
            @type = type
          end
        end
        # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
        attr_accessor :enabled
        # 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.
        attr_accessor :liability

        def initialize(enabled: nil, liability: nil)
          @enabled = enabled
          @liability = liability
        end
      end

      class BillingThresholds < Stripe::RequestParams
        # Monetary threshold that triggers the subscription to advance to a new billing period
        attr_accessor :amount_gte
        # 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.
        attr_accessor :reset_billing_cycle_anchor

        def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil)
          @amount_gte = amount_gte
          @reset_billing_cycle_anchor = reset_billing_cycle_anchor
        end
      end

      class CancellationDetails < Stripe::RequestParams
        # Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
        attr_accessor :comment
        # The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
        attr_accessor :feedback

        def initialize(comment: nil, feedback: nil)
          @comment = comment
          @feedback = feedback
        end
      end

      class Discount < Stripe::RequestParams
        class DiscountEnd < Stripe::RequestParams
          class Duration < Stripe::RequestParams
            # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
            attr_accessor :interval
            # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
            attr_accessor :interval_count

            def initialize(interval: nil, interval_count: nil)
              @interval = interval
              @interval_count = interval_count
            end
          end
          # Time span for the redeemed discount.
          attr_accessor :duration
          # A precise Unix timestamp for the discount to end. Must be in the future.
          attr_accessor :timestamp
          # The type of calculation made to determine when the discount ends.
          attr_accessor :type

          def initialize(duration: nil, timestamp: nil, type: nil)
            @duration = duration
            @timestamp = timestamp
            @type = type
          end
        end
        # ID of the coupon to create a new discount for.
        attr_accessor :coupon
        # ID of an existing discount on the object (or one of its ancestors) to reuse.
        attr_accessor :discount
        # Details to determine how long the discount should be applied for.
        attr_accessor :discount_end
        # ID of the promotion code to create a new discount for.
        attr_accessor :promotion_code

        def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
          @coupon = coupon
          @discount = discount
          @discount_end = discount_end
          @promotion_code = promotion_code
        end
      end

      class InvoiceSettings < Stripe::RequestParams
        class Issuer < Stripe::RequestParams
          # The connected account being referenced when `type` is `account`.
          attr_accessor :account
          # Type of the account referenced in the request.
          attr_accessor :type

          def initialize(account: nil, type: nil)
            @account = account
            @type = type
          end
        end
        # The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
        attr_accessor :account_tax_ids
        # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
        attr_accessor :issuer

        def initialize(account_tax_ids: nil, issuer: nil)
          @account_tax_ids = account_tax_ids
          @issuer = issuer
        end
      end

      class Item < Stripe::RequestParams
        class BillingThresholds < Stripe::RequestParams
          # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
          attr_accessor :usage_gte

          def initialize(usage_gte: nil)
            @usage_gte = usage_gte
          end
        end

        class Discount < Stripe::RequestParams
          class DiscountEnd < Stripe::RequestParams
            class Duration < Stripe::RequestParams
              # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
              attr_accessor :interval
              # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
              attr_accessor :interval_count

              def initialize(interval: nil, interval_count: nil)
                @interval = interval
                @interval_count = interval_count
              end
            end
            # Time span for the redeemed discount.
            attr_accessor :duration
            # A precise Unix timestamp for the discount to end. Must be in the future.
            attr_accessor :timestamp
            # The type of calculation made to determine when the discount ends.
            attr_accessor :type

            def initialize(duration: nil, timestamp: nil, type: nil)
              @duration = duration
              @timestamp = timestamp
              @type = type
            end
          end
          # ID of the coupon to create a new discount for.
          attr_accessor :coupon
          # ID of an existing discount on the object (or one of its ancestors) to reuse.
          attr_accessor :discount
          # Details to determine how long the discount should be applied for.
          attr_accessor :discount_end
          # ID of the promotion code to create a new discount for.
          attr_accessor :promotion_code

          def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
            @coupon = coupon
            @discount = discount
            @discount_end = discount_end
            @promotion_code = promotion_code
          end
        end

        class PriceData < Stripe::RequestParams
          class Recurring < Stripe::RequestParams
            # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
            attr_accessor :interval
            # The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
            attr_accessor :interval_count

            def initialize(interval: nil, interval_count: nil)
              @interval = interval
              @interval_count = interval_count
            end
          end
          # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
          attr_accessor :currency
          # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
          attr_accessor :product
          # The recurring components of a price such as `interval` and `interval_count`.
          attr_accessor :recurring
          # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
          attr_accessor :tax_behavior
          # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
          attr_accessor :unit_amount
          # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
          attr_accessor :unit_amount_decimal

          def initialize(
            currency: nil,
            product: nil,
            recurring: nil,
            tax_behavior: nil,
            unit_amount: nil,
            unit_amount_decimal: nil
          )
            @currency = currency
            @product = product
            @recurring = recurring
            @tax_behavior = tax_behavior
            @unit_amount = unit_amount
            @unit_amount_decimal = unit_amount_decimal
          end
        end
        # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
        attr_accessor :billing_thresholds
        # Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
        attr_accessor :clear_usage
        # A flag that, if set to `true`, will delete the specified item.
        attr_accessor :deleted
        # The coupons to redeem into discounts for the subscription item.
        attr_accessor :discounts
        # Subscription item to update.
        attr_accessor :id
        # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        attr_accessor :metadata
        # Plan ID for this item, as a string.
        attr_accessor :plan
        # The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
        attr_accessor :price
        # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
        attr_accessor :price_data
        # Quantity for this item.
        attr_accessor :quantity
        # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
        attr_accessor :tax_rates

        def initialize(
          billing_thresholds: nil,
          clear_usage: nil,
          deleted: nil,
          discounts: nil,
          id: nil,
          metadata: nil,
          plan: nil,
          price: nil,
          price_data: nil,
          quantity: nil,
          tax_rates: nil
        )
          @billing_thresholds = billing_thresholds
          @clear_usage = clear_usage
          @deleted = deleted
          @discounts = discounts
          @id = id
          @metadata = metadata
          @plan = plan
          @price = price
          @price_data = price_data
          @quantity = quantity
          @tax_rates = tax_rates
        end
      end

      class PauseCollection < Stripe::RequestParams
        # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
        attr_accessor :behavior
        # The time after which the subscription will resume collecting payments.
        attr_accessor :resumes_at

        def initialize(behavior: nil, resumes_at: nil)
          @behavior = behavior
          @resumes_at = resumes_at
        end
      end

      class PaymentSettings < Stripe::RequestParams
        class PaymentMethodOptions < Stripe::RequestParams
          class AcssDebit < Stripe::RequestParams
            class MandateOptions < Stripe::RequestParams
              # Transaction type of the mandate.
              attr_accessor :transaction_type

              def initialize(transaction_type: nil)
                @transaction_type = transaction_type
              end
            end
            # Additional fields for Mandate creation
            attr_accessor :mandate_options
            # Verification method for the intent
            attr_accessor :verification_method

            def initialize(mandate_options: nil, verification_method: nil)
              @mandate_options = mandate_options
              @verification_method = verification_method
            end
          end

          class Bancontact < Stripe::RequestParams
            # Preferred language of the Bancontact authorization page that the customer is redirected to.
            attr_accessor :preferred_language

            def initialize(preferred_language: nil)
              @preferred_language = preferred_language
            end
          end

          class Card < Stripe::RequestParams
            class MandateOptions < Stripe::RequestParams
              # Amount to be charged for future payments.
              attr_accessor :amount
              # One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
              attr_accessor :amount_type
              # A description of the mandate or subscription that is meant to be displayed to the customer.
              attr_accessor :description

              def initialize(amount: nil, amount_type: nil, description: nil)
                @amount = amount
                @amount_type = amount_type
                @description = description
              end
            end
            # Configuration options for setting up an eMandate for cards issued in India.
            attr_accessor :mandate_options
            # Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
            attr_accessor :network
            # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
            attr_accessor :request_three_d_secure

            def initialize(mandate_options: nil, network: nil, request_three_d_secure: nil)
              @mandate_options = mandate_options
              @network = network
              @request_three_d_secure = request_three_d_secure
            end
          end

          class CustomerBalance < Stripe::RequestParams
            class BankTransfer < Stripe::RequestParams
              class EuBankTransfer < Stripe::RequestParams
                # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
                attr_accessor :country

                def initialize(country: nil)
                  @country = country
                end
              end
              # Configuration for eu_bank_transfer funding type.
              attr_accessor :eu_bank_transfer
              # The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
              attr_accessor :type

              def initialize(eu_bank_transfer: nil, type: nil)
                @eu_bank_transfer = eu_bank_transfer
                @type = type
              end
            end
            # Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
            attr_accessor :bank_transfer
            # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
            attr_accessor :funding_type

            def initialize(bank_transfer: nil, funding_type: nil)
              @bank_transfer = bank_transfer
              @funding_type = funding_type
            end
          end

          class IdBankTransfer < Stripe::RequestParams; end
          class Konbini < Stripe::RequestParams; end
          class SepaDebit < Stripe::RequestParams; end

          class UsBankAccount < Stripe::RequestParams
            class FinancialConnections < Stripe::RequestParams
              class Filters < Stripe::RequestParams
                # The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
                attr_accessor :account_subcategories
                # ID of the institution to use to filter for selectable accounts.
                attr_accessor :institution

                def initialize(account_subcategories: nil, institution: nil)
                  @account_subcategories = account_subcategories
                  @institution = institution
                end
              end
              # Provide filters for the linked accounts that the customer can select for the payment method.
              attr_accessor :filters
              # The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
              attr_accessor :permissions
              # List of data features that you would like to retrieve upon account creation.
              attr_accessor :prefetch

              def initialize(filters: nil, permissions: nil, prefetch: nil)
                @filters = filters
                @permissions = permissions
                @prefetch = prefetch
              end
            end
            # Additional fields for Financial Connections Session creation
            attr_accessor :financial_connections
            # Verification method for the intent
            attr_accessor :verification_method

            def initialize(financial_connections: nil, verification_method: nil)
              @financial_connections = financial_connections
              @verification_method = verification_method
            end
          end
          # This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
          attr_accessor :acss_debit
          # This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
          attr_accessor :bancontact
          # This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
          attr_accessor :card
          # This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
          attr_accessor :customer_balance
          # This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
          attr_accessor :id_bank_transfer
          # This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
          attr_accessor :konbini
          # This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
          attr_accessor :sepa_debit
          # This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
          attr_accessor :us_bank_account

          def initialize(
            acss_debit: nil,
            bancontact: nil,
            card: nil,
            customer_balance: nil,
            id_bank_transfer: nil,
            konbini: nil,
            sepa_debit: nil,
            us_bank_account: nil
          )
            @acss_debit = acss_debit
            @bancontact = bancontact
            @card = card
            @customer_balance = customer_balance
            @id_bank_transfer = id_bank_transfer
            @konbini = konbini
            @sepa_debit = sepa_debit
            @us_bank_account = us_bank_account
          end
        end
        # Payment-method-specific configuration to provide to invoices created by the subscription.
        attr_accessor :payment_method_options
        # The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration
        attr_accessor :payment_method_types
        # Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.
        attr_accessor :save_default_payment_method

        def initialize(
          payment_method_options: nil,
          payment_method_types: nil,
          save_default_payment_method: nil
        )
          @payment_method_options = payment_method_options
          @payment_method_types = payment_method_types
          @save_default_payment_method = save_default_payment_method
        end
      end

      class PendingInvoiceItemInterval < Stripe::RequestParams
        # Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
        attr_accessor :interval
        # The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
        attr_accessor :interval_count

        def initialize(interval: nil, interval_count: nil)
          @interval = interval
          @interval_count = interval_count
        end
      end

      class Prebilling < Stripe::RequestParams
        # This is used to determine the number of billing cycles to prebill.
        attr_accessor :iterations
        # Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
        attr_accessor :update_behavior

        def initialize(iterations: nil, update_behavior: nil)
          @iterations = iterations
          @update_behavior = update_behavior
        end
      end

      class TransferData < Stripe::RequestParams
        # 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.
        attr_accessor :amount_percent
        # ID of an existing, connected Stripe account.
        attr_accessor :destination

        def initialize(amount_percent: nil, destination: nil)
          @amount_percent = amount_percent
          @destination = destination
        end
      end

      class TrialSettings < Stripe::RequestParams
        class EndBehavior < Stripe::RequestParams
          # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
          attr_accessor :missing_payment_method

          def initialize(missing_payment_method: nil)
            @missing_payment_method = missing_payment_method
          end
        end
        # Defines how the subscription should behave when the user's free trial ends.
        attr_accessor :end_behavior

        def initialize(end_behavior: nil)
          @end_behavior = end_behavior
        end
      end
      # A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
      attr_accessor :add_invoice_items
      # 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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
      attr_accessor :application_fee_percent
      # Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
      attr_accessor :automatic_tax
      # Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
      attr_accessor :billing_cycle_anchor
      # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
      attr_accessor :billing_thresholds
      # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
      attr_accessor :cancel_at
      # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
      attr_accessor :cancel_at_period_end
      # Details about why this subscription was cancelled
      attr_accessor :cancellation_details
      # 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`. Defaults to `charge_automatically`.
      attr_accessor :collection_method
      # Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
      attr_accessor :days_until_due
      # 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](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
      attr_accessor :default_payment_method
      # 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](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
      attr_accessor :default_source
      # 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. Pass an empty string to remove previously-defined tax rates.
      attr_accessor :default_tax_rates
      # 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 and certain local payment methods UIs.
      attr_accessor :description
      # The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer.
      attr_accessor :discounts
      # Specifies which fields in the response should be expanded.
      attr_accessor :expand
      # All invoices will be billed using the specified settings.
      attr_accessor :invoice_settings
      # A list of up to 20 subscription items, each with an attached price.
      attr_accessor :items
      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
      attr_accessor :metadata
      # Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
      attr_accessor :off_session
      # The account on behalf of which to charge, for each of the subscription's invoices.
      attr_accessor :on_behalf_of
      # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
      attr_accessor :pause_collection
      # Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
      #
      # Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
      #
      # Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).
      #
      # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.
      attr_accessor :payment_behavior
      # Payment settings to pass to invoices created by the subscription.
      attr_accessor :payment_settings
      # Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
      attr_accessor :pending_invoice_item_interval
      # If specified, the invoicing for the given billing cycle iterations will be processed now.
      attr_accessor :prebilling
      # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
      attr_accessor :proration_behavior
      # If set, prorations will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. `proration_date` can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.
      attr_accessor :proration_date
      # 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. This will be unset if you POST an empty value.
      attr_accessor :transfer_data
      # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, `trial_end` will override the default trial period of the plan the customer is being subscribed to. The `billing_cycle_anchor` will be updated to the `trial_end` value. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.
      attr_accessor :trial_end
      # Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
      attr_accessor :trial_from_plan
      # Settings related to subscription trials.
      attr_accessor :trial_settings

      def initialize(
        add_invoice_items: nil,
        application_fee_percent: nil,
        automatic_tax: nil,
        billing_cycle_anchor: nil,
        billing_thresholds: nil,
        cancel_at: nil,
        cancel_at_period_end: nil,
        cancellation_details: nil,
        collection_method: nil,
        days_until_due: nil,
        default_payment_method: nil,
        default_source: nil,
        default_tax_rates: nil,
        description: nil,
        discounts: nil,
        expand: nil,
        invoice_settings: nil,
        items: nil,
        metadata: nil,
        off_session: nil,
        on_behalf_of: nil,
        pause_collection: nil,
        payment_behavior: nil,
        payment_settings: nil,
        pending_invoice_item_interval: nil,
        prebilling: nil,
        proration_behavior: nil,
        proration_date: nil,
        transfer_data: nil,
        trial_end: nil,
        trial_from_plan: nil,
        trial_settings: nil
      )
        @add_invoice_items = add_invoice_items
        @application_fee_percent = application_fee_percent
        @automatic_tax = automatic_tax
        @billing_cycle_anchor = billing_cycle_anchor
        @billing_thresholds = billing_thresholds
        @cancel_at = cancel_at
        @cancel_at_period_end = cancel_at_period_end
        @cancellation_details = cancellation_details
        @collection_method = collection_method
        @days_until_due = days_until_due
        @default_payment_method = default_payment_method
        @default_source = default_source
        @default_tax_rates = default_tax_rates
        @description = description
        @discounts = discounts
        @expand = expand
        @invoice_settings = invoice_settings
        @items = items
        @metadata = metadata
        @off_session = off_session
        @on_behalf_of = on_behalf_of
        @pause_collection = pause_collection
        @payment_behavior = payment_behavior
        @payment_settings = payment_settings
        @pending_invoice_item_interval = pending_invoice_item_interval
        @prebilling = prebilling
        @proration_behavior = proration_behavior
        @proration_date = proration_date
        @transfer_data = transfer_data
        @trial_end = trial_end
        @trial_from_plan = trial_from_plan
        @trial_settings = trial_settings
      end
    end

    class DeleteDiscountParams < Stripe::RequestParams; end

    class ListParams < Stripe::RequestParams
      class AutomaticTax < Stripe::RequestParams
        # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
        attr_accessor :enabled

        def initialize(enabled: nil)
          @enabled = enabled
        end
      end

      class Created < Stripe::RequestParams
        # Minimum value to filter by (exclusive)
        attr_accessor :gt
        # Minimum value to filter by (inclusive)
        attr_accessor :gte
        # Maximum value to filter by (exclusive)
        attr_accessor :lt
        # Maximum value to filter by (inclusive)
        attr_accessor :lte

        def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
          @gt = gt
          @gte = gte
          @lt = lt
          @lte = lte
        end
      end

      class CurrentPeriodEnd < Stripe::RequestParams
        # Minimum value to filter by (exclusive)
        attr_accessor :gt
        # Minimum value to filter by (inclusive)
        attr_accessor :gte
        # Maximum value to filter by (exclusive)
        attr_accessor :lt
        # Maximum value to filter by (inclusive)
        attr_accessor :lte

        def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
          @gt = gt
          @gte = gte
          @lt = lt
          @lte = lte
        end
      end

      class CurrentPeriodStart < Stripe::RequestParams
        # Minimum value to filter by (exclusive)
        attr_accessor :gt
        # Minimum value to filter by (inclusive)
        attr_accessor :gte
        # Maximum value to filter by (exclusive)
        attr_accessor :lt
        # Maximum value to filter by (inclusive)
        attr_accessor :lte

        def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
          @gt = gt
          @gte = gte
          @lt = lt
          @lte = lte
        end
      end
      # Filter subscriptions by their automatic tax settings.
      attr_accessor :automatic_tax
      # The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.
      attr_accessor :collection_method
      # Only return subscriptions that were created during the given date interval.
      attr_accessor :created
      # Only return subscriptions whose current_period_end falls within the given date interval.
      attr_accessor :current_period_end
      # Only return subscriptions whose current_period_start falls within the given date interval.
      attr_accessor :current_period_start
      # The ID of the customer whose subscriptions will be retrieved.
      attr_accessor :customer
      # The ID of the account whose subscriptions will be retrieved.
      attr_accessor :customer_account
      # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
      attr_accessor :ending_before
      # Specifies which fields in the response should be expanded.
      attr_accessor :expand
      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
      attr_accessor :limit
      # The ID of the plan whose subscriptions will be retrieved.
      attr_accessor :plan
      # Filter for subscriptions that contain this recurring price ID.
      attr_accessor :price
      # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
      attr_accessor :starting_after
      # The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.
      attr_accessor :status
      # Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.
      attr_accessor :test_clock

      def initialize(
        automatic_tax: nil,
        collection_method: nil,
        created: nil,
        current_period_end: nil,
        current_period_start: nil,
        customer: nil,
        customer_account: nil,
        ending_before: nil,
        expand: nil,
        limit: nil,
        plan: nil,
        price: nil,
        starting_after: nil,
        status: nil,
        test_clock: nil
      )
        @automatic_tax = automatic_tax
        @collection_method = collection_method
        @created = created
        @current_period_end = current_period_end
        @current_period_start = current_period_start
        @customer = customer
        @customer_account = customer_account
        @ending_before = ending_before
        @expand = expand
        @limit = limit
        @plan = plan
        @price = price
        @starting_after = starting_after
        @status = status
        @test_clock = test_clock
      end
    end

    class CreateParams < Stripe::RequestParams
      class AddInvoiceItem < Stripe::RequestParams
        class Discount < Stripe::RequestParams
          class DiscountEnd < Stripe::RequestParams
            class Duration < Stripe::RequestParams
              # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
              attr_accessor :interval
              # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
              attr_accessor :interval_count

              def initialize(interval: nil, interval_count: nil)
                @interval = interval
                @interval_count = interval_count
              end
            end
            # Time span for the redeemed discount.
            attr_accessor :duration
            # A precise Unix timestamp for the discount to end. Must be in the future.
            attr_accessor :timestamp
            # The type of calculation made to determine when the discount ends.
            attr_accessor :type

            def initialize(duration: nil, timestamp: nil, type: nil)
              @duration = duration
              @timestamp = timestamp
              @type = type
            end
          end
          # ID of the coupon to create a new discount for.
          attr_accessor :coupon
          # ID of an existing discount on the object (or one of its ancestors) to reuse.
          attr_accessor :discount
          # Details to determine how long the discount should be applied for.
          attr_accessor :discount_end
          # ID of the promotion code to create a new discount for.
          attr_accessor :promotion_code

          def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
            @coupon = coupon
            @discount = discount
            @discount_end = discount_end
            @promotion_code = promotion_code
          end
        end

        class PriceData < Stripe::RequestParams
          # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
          attr_accessor :currency
          # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
          attr_accessor :product
          # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
          attr_accessor :tax_behavior
          # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
          attr_accessor :unit_amount
          # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
          attr_accessor :unit_amount_decimal

          def initialize(
            currency: nil,
            product: nil,
            tax_behavior: nil,
            unit_amount: nil,
            unit_amount_decimal: nil
          )
            @currency = currency
            @product = product
            @tax_behavior = tax_behavior
            @unit_amount = unit_amount
            @unit_amount_decimal = unit_amount_decimal
          end
        end
        # The coupons to redeem into discounts for the item.
        attr_accessor :discounts
        # The ID of the price object. One of `price` or `price_data` is required.
        attr_accessor :price
        # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
        attr_accessor :price_data
        # Quantity for this item. Defaults to 1.
        attr_accessor :quantity
        # The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
        attr_accessor :tax_rates

        def initialize(discounts: nil, price: nil, price_data: nil, quantity: nil, tax_rates: nil)
          @discounts = discounts
          @price = price
          @price_data = price_data
          @quantity = quantity
          @tax_rates = tax_rates
        end
      end

      class AutomaticTax < Stripe::RequestParams
        class Liability < Stripe::RequestParams
          # The connected account being referenced when `type` is `account`.
          attr_accessor :account
          # Type of the account referenced in the request.
          attr_accessor :type

          def initialize(account: nil, type: nil)
            @account = account
            @type = type
          end
        end
        # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
        attr_accessor :enabled
        # 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.
        attr_accessor :liability

        def initialize(enabled: nil, liability: nil)
          @enabled = enabled
          @liability = liability
        end
      end

      class BillingCycleAnchorConfig < Stripe::RequestParams
        # The day of the month the billing_cycle_anchor should be. Ranges from 1 to 31.
        attr_accessor :day_of_month
        # The hour of the day the billing_cycle_anchor should be. Ranges from 0 to 23.
        attr_accessor :hour
        # The minute of the hour the billing_cycle_anchor should be. Ranges from 0 to 59.
        attr_accessor :minute
        # The month to start full cycle billing periods. Ranges from 1 to 12.
        attr_accessor :month
        # The second of the minute the billing_cycle_anchor should be. Ranges from 0 to 59.
        attr_accessor :second

        def initialize(day_of_month: nil, hour: nil, minute: nil, month: nil, second: nil)
          @day_of_month = day_of_month
          @hour = hour
          @minute = minute
          @month = month
          @second = second
        end
      end

      class BillingMode < Stripe::RequestParams
        # Attribute for param field type
        attr_accessor :type

        def initialize(type: nil)
          @type = type
        end
      end

      class BillingThresholds < Stripe::RequestParams
        # Monetary threshold that triggers the subscription to advance to a new billing period
        attr_accessor :amount_gte
        # 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.
        attr_accessor :reset_billing_cycle_anchor

        def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil)
          @amount_gte = amount_gte
          @reset_billing_cycle_anchor = reset_billing_cycle_anchor
        end
      end

      class Discount < Stripe::RequestParams
        class DiscountEnd < Stripe::RequestParams
          class Duration < Stripe::RequestParams
            # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
            attr_accessor :interval
            # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
            attr_accessor :interval_count

            def initialize(interval: nil, interval_count: nil)
              @interval = interval
              @interval_count = interval_count
            end
          end
          # Time span for the redeemed discount.
          attr_accessor :duration
          # A precise Unix timestamp for the discount to end. Must be in the future.
          attr_accessor :timestamp
          # The type of calculation made to determine when the discount ends.
          attr_accessor :type

          def initialize(duration: nil, timestamp: nil, type: nil)
            @duration = duration
            @timestamp = timestamp
            @type = type
          end
        end
        # ID of the coupon to create a new discount for.
        attr_accessor :coupon
        # ID of an existing discount on the object (or one of its ancestors) to reuse.
        attr_accessor :discount
        # Details to determine how long the discount should be applied for.
        attr_accessor :discount_end
        # ID of the promotion code to create a new discount for.
        attr_accessor :promotion_code

        def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
          @coupon = coupon
          @discount = discount
          @discount_end = discount_end
          @promotion_code = promotion_code
        end
      end

      class InvoiceSettings < Stripe::RequestParams
        class Issuer < Stripe::RequestParams
          # The connected account being referenced when `type` is `account`.
          attr_accessor :account
          # Type of the account referenced in the request.
          attr_accessor :type

          def initialize(account: nil, type: nil)
            @account = account
            @type = type
          end
        end
        # The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
        attr_accessor :account_tax_ids
        # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
        attr_accessor :issuer

        def initialize(account_tax_ids: nil, issuer: nil)
          @account_tax_ids = account_tax_ids
          @issuer = issuer
        end
      end

      class Item < Stripe::RequestParams
        class BillingThresholds < Stripe::RequestParams
          # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
          attr_accessor :usage_gte

          def initialize(usage_gte: nil)
            @usage_gte = usage_gte
          end
        end

        class Discount < Stripe::RequestParams
          class DiscountEnd < Stripe::RequestParams
            class Duration < Stripe::RequestParams
              # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
              attr_accessor :interval
              # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
              attr_accessor :interval_count

              def initialize(interval: nil, interval_count: nil)
                @interval = interval
                @interval_count = interval_count
              end
            end
            # Time span for the redeemed discount.
            attr_accessor :duration
            # A precise Unix timestamp for the discount to end. Must be in the future.
            attr_accessor :timestamp
            # The type of calculation made to determine when the discount ends.
            attr_accessor :type

            def initialize(duration: nil, timestamp: nil, type: nil)
              @duration = duration
              @timestamp = timestamp
              @type = type
            end
          end
          # ID of the coupon to create a new discount for.
          attr_accessor :coupon
          # ID of an existing discount on the object (or one of its ancestors) to reuse.
          attr_accessor :discount
          # Details to determine how long the discount should be applied for.
          attr_accessor :discount_end
          # ID of the promotion code to create a new discount for.
          attr_accessor :promotion_code

          def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
            @coupon = coupon
            @discount = discount
            @discount_end = discount_end
            @promotion_code = promotion_code
          end
        end

        class PriceData < Stripe::RequestParams
          class Recurring < Stripe::RequestParams
            # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
            attr_accessor :interval
            # The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
            attr_accessor :interval_count

            def initialize(interval: nil, interval_count: nil)
              @interval = interval
              @interval_count = interval_count
            end
          end
          # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
          attr_accessor :currency
          # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
          attr_accessor :product
          # The recurring components of a price such as `interval` and `interval_count`.
          attr_accessor :recurring
          # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
          attr_accessor :tax_behavior
          # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
          attr_accessor :unit_amount
          # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
          attr_accessor :unit_amount_decimal

          def initialize(
            currency: nil,
            product: nil,
            recurring: nil,
            tax_behavior: nil,
            unit_amount: nil,
            unit_amount_decimal: nil
          )
            @currency = currency
            @product = product
            @recurring = recurring
            @tax_behavior = tax_behavior
            @unit_amount = unit_amount
            @unit_amount_decimal = unit_amount_decimal
          end
        end

        class Trial < Stripe::RequestParams
          # List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
          attr_accessor :converts_to
          # Determines the type of trial for this item.
          attr_accessor :type

          def initialize(converts_to: nil, type: nil)
            @converts_to = converts_to
            @type = type
          end
        end
        # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
        attr_accessor :billing_thresholds
        # The coupons to redeem into discounts for the subscription item.
        attr_accessor :discounts
        # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        attr_accessor :metadata
        # Plan ID for this item, as a string.
        attr_accessor :plan
        # The ID of the price object.
        attr_accessor :price
        # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
        attr_accessor :price_data
        # Quantity for this item.
        attr_accessor :quantity
        # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
        attr_accessor :tax_rates
        # Define options to configure the trial on the subscription item.
        attr_accessor :trial

        def initialize(
          billing_thresholds: nil,
          discounts: nil,
          metadata: nil,
          plan: nil,
          price: nil,
          price_data: nil,
          quantity: nil,
          tax_rates: nil,
          trial: nil
        )
          @billing_thresholds = billing_thresholds
          @discounts = discounts
          @metadata = metadata
          @plan = plan
          @price = price
          @price_data = price_data
          @quantity = quantity
          @tax_rates = tax_rates
          @trial = trial
        end
      end

      class PaymentSettings < Stripe::RequestParams
        class PaymentMethodOptions < Stripe::RequestParams
          class AcssDebit < Stripe::RequestParams
            class MandateOptions < Stripe::RequestParams
              # Transaction type of the mandate.
              attr_accessor :transaction_type

              def initialize(transaction_type: nil)
                @transaction_type = transaction_type
              end
            end
            # Additional fields for Mandate creation
            attr_accessor :mandate_options
            # Verification method for the intent
            attr_accessor :verification_method

            def initialize(mandate_options: nil, verification_method: nil)
              @mandate_options = mandate_options
              @verification_method = verification_method
            end
          end

          class Bancontact < Stripe::RequestParams
            # Preferred language of the Bancontact authorization page that the customer is redirected to.
            attr_accessor :preferred_language

            def initialize(preferred_language: nil)
              @preferred_language = preferred_language
            end
          end

          class Card < Stripe::RequestParams
            class MandateOptions < Stripe::RequestParams
              # Amount to be charged for future payments.
              attr_accessor :amount
              # One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
              attr_accessor :amount_type
              # A description of the mandate or subscription that is meant to be displayed to the customer.
              attr_accessor :description

              def initialize(amount: nil, amount_type: nil, description: nil)
                @amount = amount
                @amount_type = amount_type
                @description = description
              end
            end
            # Configuration options for setting up an eMandate for cards issued in India.
            attr_accessor :mandate_options
            # Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
            attr_accessor :network
            # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
            attr_accessor :request_three_d_secure

            def initialize(mandate_options: nil, network: nil, request_three_d_secure: nil)
              @mandate_options = mandate_options
              @network = network
              @request_three_d_secure = request_three_d_secure
            end
          end

          class CustomerBalance < Stripe::RequestParams
            class BankTransfer < Stripe::RequestParams
              class EuBankTransfer < Stripe::RequestParams
                # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
                attr_accessor :country

                def initialize(country: nil)
                  @country = country
                end
              end
              # Configuration for eu_bank_transfer funding type.
              attr_accessor :eu_bank_transfer
              # The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
              attr_accessor :type

              def initialize(eu_bank_transfer: nil, type: nil)
                @eu_bank_transfer = eu_bank_transfer
                @type = type
              end
            end
            # Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
            attr_accessor :bank_transfer
            # The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
            attr_accessor :funding_type

            def initialize(bank_transfer: nil, funding_type: nil)
              @bank_transfer = bank_transfer
              @funding_type = funding_type
            end
          end

          class IdBankTransfer < Stripe::RequestParams; end
          class Konbini < Stripe::RequestParams; end
          class SepaDebit < Stripe::RequestParams; end

          class UsBankAccount < Stripe::RequestParams
            class FinancialConnections < Stripe::RequestParams
              class Filters < Stripe::RequestParams
                # The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
                attr_accessor :account_subcategories
                # ID of the institution to use to filter for selectable accounts.
                attr_accessor :institution

                def initialize(account_subcategories: nil, institution: nil)
                  @account_subcategories = account_subcategories
                  @institution = institution
                end
              end
              # Provide filters for the linked accounts that the customer can select for the payment method.
              attr_accessor :filters
              # The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
              attr_accessor :permissions
              # List of data features that you would like to retrieve upon account creation.
              attr_accessor :prefetch

              def initialize(filters: nil, permissions: nil, prefetch: nil)
                @filters = filters
                @permissions = permissions
                @prefetch = prefetch
              end
            end
            # Additional fields for Financial Connections Session creation
            attr_accessor :financial_connections
            # Verification method for the intent
            attr_accessor :verification_method

            def initialize(financial_connections: nil, verification_method: nil)
              @financial_connections = financial_connections
              @verification_method = verification_method
            end
          end
          # This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
          attr_accessor :acss_debit
          # This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
          attr_accessor :bancontact
          # This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
          attr_accessor :card
          # This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
          attr_accessor :customer_balance
          # This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
          attr_accessor :id_bank_transfer
          # This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
          attr_accessor :konbini
          # This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
          attr_accessor :sepa_debit
          # This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
          attr_accessor :us_bank_account

          def initialize(
            acss_debit: nil,
            bancontact: nil,
            card: nil,
            customer_balance: nil,
            id_bank_transfer: nil,
            konbini: nil,
            sepa_debit: nil,
            us_bank_account: nil
          )
            @acss_debit = acss_debit
            @bancontact = bancontact
            @card = card
            @customer_balance = customer_balance
            @id_bank_transfer = id_bank_transfer
            @konbini = konbini
            @sepa_debit = sepa_debit
            @us_bank_account = us_bank_account
          end
        end
        # Payment-method-specific configuration to provide to invoices created by the subscription.
        attr_accessor :payment_method_options
        # The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration
        attr_accessor :payment_method_types
        # Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.
        attr_accessor :save_default_payment_method

        def initialize(
          payment_method_options: nil,
          payment_method_types: nil,
          save_default_payment_method: nil
        )
          @payment_method_options = payment_method_options
          @payment_method_types = payment_method_types
          @save_default_payment_method = save_default_payment_method
        end
      end

      class PendingInvoiceItemInterval < Stripe::RequestParams
        # Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
        attr_accessor :interval
        # The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
        attr_accessor :interval_count

        def initialize(interval: nil, interval_count: nil)
          @interval = interval
          @interval_count = interval_count
        end
      end

      class Prebilling < Stripe::RequestParams
        # This is used to determine the number of billing cycles to prebill.
        attr_accessor :iterations
        # Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
        attr_accessor :update_behavior

        def initialize(iterations: nil, update_behavior: nil)
          @iterations = iterations
          @update_behavior = update_behavior
        end
      end

      class TransferData < Stripe::RequestParams
        # 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.
        attr_accessor :amount_percent
        # ID of an existing, connected Stripe account.
        attr_accessor :destination

        def initialize(amount_percent: nil, destination: nil)
          @amount_percent = amount_percent
          @destination = destination
        end
      end

      class TrialSettings < Stripe::RequestParams
        class EndBehavior < Stripe::RequestParams
          # Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
          attr_accessor :missing_payment_method

          def initialize(missing_payment_method: nil)
            @missing_payment_method = missing_payment_method
          end
        end
        # Defines how the subscription should behave when the user's free trial ends.
        attr_accessor :end_behavior

        def initialize(end_behavior: nil)
          @end_behavior = end_behavior
        end
      end
      # A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
      attr_accessor :add_invoice_items
      # 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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
      attr_accessor :application_fee_percent
      # Automatic tax settings for this subscription.
      attr_accessor :automatic_tax
      # For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
      attr_accessor :backdate_start_date
      # A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.
      attr_accessor :billing_cycle_anchor
      # Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC.
      attr_accessor :billing_cycle_anchor_config
      # Controls how prorations and invoices for subscriptions are calculated and orchestrated.
      attr_accessor :billing_mode
      # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
      attr_accessor :billing_thresholds
      # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
      attr_accessor :cancel_at
      # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
      attr_accessor :cancel_at_period_end
      # 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`. Defaults to `charge_automatically`.
      attr_accessor :collection_method
      # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
      attr_accessor :currency
      # The identifier of the customer to subscribe.
      attr_accessor :customer
      # The identifier of the account to subscribe.
      attr_accessor :customer_account
      # Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
      attr_accessor :days_until_due
      # 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](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
      attr_accessor :default_payment_method
      # 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](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
      attr_accessor :default_source
      # 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.
      attr_accessor :default_tax_rates
      # 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 and certain local payment methods UIs.
      attr_accessor :description
      # The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer.
      attr_accessor :discounts
      # Specifies which fields in the response should be expanded.
      attr_accessor :expand
      # All invoices will be billed using the specified settings.
      attr_accessor :invoice_settings
      # A list of up to 20 subscription items, each with an attached price.
      attr_accessor :items
      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
      attr_accessor :metadata
      # Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
      attr_accessor :off_session
      # The account on behalf of which to charge, for each of the subscription's invoices.
      attr_accessor :on_behalf_of
      # Only applies to subscriptions with `collection_method=charge_automatically`.
      #
      # Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
      #
      # Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state.
      #
      # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.
      #
      # `pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription.
      #
      # Subscriptions with `collection_method=send_invoice` are automatically activated regardless of the first Invoice status.
      attr_accessor :payment_behavior
      # Payment settings to pass to invoices created by the subscription.
      attr_accessor :payment_settings
      # Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
      attr_accessor :pending_invoice_item_interval
      # If specified, the invoicing for the given billing cycle iterations will be processed now.
      attr_accessor :prebilling
      # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
      attr_accessor :proration_behavior
      # 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.
      attr_accessor :transfer_data
      # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
      attr_accessor :trial_end
      # Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
      attr_accessor :trial_from_plan
      # Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
      attr_accessor :trial_period_days
      # Settings related to subscription trials.
      attr_accessor :trial_settings

      def initialize(
        add_invoice_items: nil,
        application_fee_percent: nil,
        automatic_tax: nil,
        backdate_start_date: nil,
        billing_cycle_anchor: nil,
        billing_cycle_anchor_config: nil,
        billing_mode: nil,
        billing_thresholds: nil,
        cancel_at: nil,
        cancel_at_period_end: nil,
        collection_method: nil,
        currency: nil,
        customer: nil,
        customer_account: nil,
        days_until_due: nil,
        default_payment_method: nil,
        default_source: nil,
        default_tax_rates: nil,
        description: nil,
        discounts: nil,
        expand: nil,
        invoice_settings: nil,
        items: nil,
        metadata: nil,
        off_session: nil,
        on_behalf_of: nil,
        payment_behavior: nil,
        payment_settings: nil,
        pending_invoice_item_interval: nil,
        prebilling: nil,
        proration_behavior: nil,
        transfer_data: nil,
        trial_end: nil,
        trial_from_plan: nil,
        trial_period_days: nil,
        trial_settings: nil
      )
        @add_invoice_items = add_invoice_items
        @application_fee_percent = application_fee_percent
        @automatic_tax = automatic_tax
        @backdate_start_date = backdate_start_date
        @billing_cycle_anchor = billing_cycle_anchor
        @billing_cycle_anchor_config = billing_cycle_anchor_config
        @billing_mode = billing_mode
        @billing_thresholds = billing_thresholds
        @cancel_at = cancel_at
        @cancel_at_period_end = cancel_at_period_end
        @collection_method = collection_method
        @currency = currency
        @customer = customer
        @customer_account = customer_account
        @days_until_due = days_until_due
        @default_payment_method = default_payment_method
        @default_source = default_source
        @default_tax_rates = default_tax_rates
        @description = description
        @discounts = discounts
        @expand = expand
        @invoice_settings = invoice_settings
        @items = items
        @metadata = metadata
        @off_session = off_session
        @on_behalf_of = on_behalf_of
        @payment_behavior = payment_behavior
        @payment_settings = payment_settings
        @pending_invoice_item_interval = pending_invoice_item_interval
        @prebilling = prebilling
        @proration_behavior = proration_behavior
        @transfer_data = transfer_data
        @trial_end = trial_end
        @trial_from_plan = trial_from_plan
        @trial_period_days = trial_period_days
        @trial_settings = trial_settings
      end
    end

    class SearchParams < Stripe::RequestParams
      # Specifies which fields in the response should be expanded.
      attr_accessor :expand
      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
      attr_accessor :limit
      # A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
      attr_accessor :page
      # The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for subscriptions](https://stripe.com/docs/search#query-fields-for-subscriptions).
      attr_accessor :query

      def initialize(expand: nil, limit: nil, page: nil, query: nil)
        @expand = expand
        @limit = limit
        @page = page
        @query = query
      end
    end

    class MigrateParams < Stripe::RequestParams
      class BillingMode < Stripe::RequestParams
        # Attribute for param field type
        attr_accessor :type

        def initialize(type: nil)
          @type = type
        end
      end
      # Controls how prorations and invoices for subscriptions are calculated and orchestrated.
      attr_accessor :billing_mode
      # Specifies which fields in the response should be expanded.
      attr_accessor :expand

      def initialize(billing_mode: nil, expand: nil)
        @billing_mode = billing_mode
        @expand = expand
      end
    end

    class ResumeParams < Stripe::RequestParams
      # The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
      attr_accessor :billing_cycle_anchor
      # Specifies which fields in the response should be expanded.
      attr_accessor :expand
      # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`.
      attr_accessor :proration_behavior
      # If set, prorations will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint.
      attr_accessor :proration_date

      def initialize(
        billing_cycle_anchor: nil,
        expand: nil,
        proration_behavior: nil,
        proration_date: nil
      )
        @billing_cycle_anchor = billing_cycle_anchor
        @expand = expand
        @proration_behavior = proration_behavior
        @proration_date = proration_date
      end
    end
    # ID of the Connect Application that created the subscription.
    attr_reader :application
    # 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.
    attr_reader :application_fee_percent
    # Attribute for field automatic_tax
    attr_reader :automatic_tax
    # The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.
    attr_reader :billing_cycle_anchor
    # The fixed values used to calculate the `billing_cycle_anchor`.
    attr_reader :billing_cycle_anchor_config
    # Controls how prorations and invoices for subscriptions are calculated and orchestrated.
    attr_reader :billing_mode
    # Details about when the current billing_mode was updated.
    attr_reader :billing_mode_details
    # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
    attr_reader :billing_thresholds
    # A date in the future at which the subscription will automatically get canceled
    attr_reader :cancel_at
    # Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.
    attr_reader :cancel_at_period_end
    # 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.
    attr_reader :canceled_at
    # Details about why this subscription was cancelled
    attr_reader :cancellation_details
    # 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`.
    attr_reader :collection_method
    # Time at which the object was created. Measured in seconds since the Unix epoch.
    attr_reader :created
    # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
    attr_reader :currency
    # ID of the customer who owns the subscription.
    attr_reader :customer
    # ID of the account who owns the subscription.
    attr_reader :customer_account
    # 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`.
    attr_reader :days_until_due
    # 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](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
    attr_reader :default_payment_method
    # 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](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
    attr_reader :default_source
    # 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.
    attr_reader :default_tax_rates
    # 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 and certain local payment methods UIs.
    attr_reader :description
    # The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
    attr_reader :discounts
    # If the subscription has ended, the date the subscription ended.
    attr_reader :ended_at
    # Unique identifier for the object.
    attr_reader :id
    # Attribute for field invoice_settings
    attr_reader :invoice_settings
    # List of subscription items, each with an attached price.
    attr_reader :items
    # Details of the most recent price migration that failed for the subscription.
    attr_reader :last_price_migration_error
    # The most recent invoice this subscription has generated.
    attr_reader :latest_invoice
    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
    attr_reader :livemode
    # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    attr_reader :metadata
    # Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.
    attr_reader :next_pending_invoice_item_invoice
    # String representing the object's type. Objects of the same type share the same value.
    attr_reader :object
    # The account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://stripe.com/docs/connect/subscriptions#on-behalf-of) for details.
    attr_reader :on_behalf_of
    # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
    attr_reader :pause_collection
    # Payment settings passed on to invoices created by the subscription.
    attr_reader :payment_settings
    # Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
    attr_reader :pending_invoice_item_interval
    # You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) 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](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2).
    attr_reader :pending_setup_intent
    # If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.
    attr_reader :pending_update
    # Time period and invoice for a Subscription billed in advance.
    attr_reader :prebilling
    # The schedule attached to the subscription
    attr_reader :schedule
    # Date when the subscription was first created. The date might differ from the `created` date due to backdating.
    attr_reader :start_date
    # Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, `unpaid`, or `paused`.
    #
    # For `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` status. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal status, 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.
    #
    # A subscription can only enter a `paused` status [when a trial ends without a payment method](https://stripe.com/docs/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged.
    #
    # If subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings).
    #
    # 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.
    attr_reader :status
    # ID of the test clock this subscription belongs to.
    attr_reader :test_clock
    # 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.
    attr_reader :transfer_data
    # If the subscription has a trial, the end of that trial.
    attr_reader :trial_end
    # Settings related to subscription trials.
    attr_reader :trial_settings
    # If the subscription has a trial, the beginning of that trial. For subsequent trials, this date remains as the start of the first ever trial on the subscription.
    attr_reader :trial_start

    # Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata).
    #
    # Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://docs.stripe.com/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true.
    #
    # By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
    def cancel(params = {}, opts = {})
      request_stripe_object(
        method: :delete,
        path: format("/v1/subscriptions/%<subscription_exposed_id>s", { subscription_exposed_id: CGI.escape(self["id"]) }),
        params: params,
        opts: opts
      )
    end

    # Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata).
    #
    # Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://docs.stripe.com/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true.
    #
    # By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
    def self.cancel(subscription_exposed_id, params = {}, opts = {})
      request_stripe_object(
        method: :delete,
        path: format("/v1/subscriptions/%<subscription_exposed_id>s", { subscription_exposed_id: CGI.escape(subscription_exposed_id) }),
        params: params,
        opts: opts
      )
    end

    # Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.
    #
    # When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request.
    # The payment_behavior parameter determines the exact behavior of the initial payment.
    #
    # To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://docs.stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead.
    # Schedules provide the flexibility to model more complex billing configurations that change over time.
    def self.create(params = {}, opts = {})
      request_stripe_object(method: :post, path: "/v1/subscriptions", params: params, opts: opts)
    end

    # Removes the currently applied discount on a subscription.
    def delete_discount(params = {}, opts = {})
      request_stripe_object(
        method: :delete,
        path: format("/v1/subscriptions/%<subscription_exposed_id>s/discount", { subscription_exposed_id: CGI.escape(self["id"]) }),
        params: params,
        opts: opts
      )
    end

    # Removes the currently applied discount on a subscription.
    def self.delete_discount(subscription_exposed_id, params = {}, opts = {})
      request_stripe_object(
        method: :delete,
        path: format("/v1/subscriptions/%<subscription_exposed_id>s/discount", { subscription_exposed_id: CGI.escape(subscription_exposed_id) }),
        params: params,
        opts: opts
      )
    end

    # By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.
    def self.list(params = {}, opts = {})
      request_stripe_object(method: :get, path: "/v1/subscriptions", params: params, opts: opts)
    end

    # Upgrade the billing_mode of an existing subscription.
    def migrate(params = {}, opts = {})
      request_stripe_object(
        method: :post,
        path: format("/v1/subscriptions/%<subscription>s/migrate", { subscription: CGI.escape(self["id"]) }),
        params: params,
        opts: opts
      )
    end

    # Upgrade the billing_mode of an existing subscription.
    def self.migrate(subscription, params = {}, opts = {})
      request_stripe_object(
        method: :post,
        path: format("/v1/subscriptions/%<subscription>s/migrate", { subscription: CGI.escape(subscription) }),
        params: params,
        opts: opts
      )
    end

    # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.
    def resume(params = {}, opts = {})
      request_stripe_object(
        method: :post,
        path: format("/v1/subscriptions/%<subscription>s/resume", { subscription: CGI.escape(self["id"]) }),
        params: params,
        opts: opts
      )
    end

    # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.
    def self.resume(subscription, params = {}, opts = {})
      request_stripe_object(
        method: :post,
        path: format("/v1/subscriptions/%<subscription>s/resume", { subscription: CGI.escape(subscription) }),
        params: params,
        opts: opts
      )
    end

    def self.search(params = {}, opts = {})
      request_stripe_object(
        method: :get,
        path: "/v1/subscriptions/search",
        params: params,
        opts: opts
      )
    end

    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
      search(params, opts).auto_paging_each(&blk)
    end

    # Updates an existing subscription to match the specified parameters.
    # When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.
    # To preview how the proration is calculated, use the [create preview](https://docs.stripe.com/docs/api/invoices/create_preview) endpoint.
    #
    # By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they'll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they'll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month's 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.
    #
    # Switching prices does not normally change the billing date or generate an immediate charge unless:
    #
    #
    # The billing interval is changed (for example, from monthly to yearly).
    # The subscription moves from free to paid.
    # A trial starts or ends.
    #
    #
    # In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://docs.stripe.com/docs/billing/subscriptions/upgrade-downgrade#immediate-payment).
    #
    # If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://docs.stripe.com/docs/api/invoices/create).
    #
    # If you don't want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don't generate any credits for the old subscription's unused time. We still reset the billing date and bill immediately for the new subscription.
    #
    # Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating <a href="/docs/billing/subscriptions/usage-based">usage-based billing](https://docs.stripe.com/docs/rate-limits) instead.
    def self.update(subscription_exposed_id, params = {}, opts = {})
      request_stripe_object(
        method: :post,
        path: format("/v1/subscriptions/%<subscription_exposed_id>s", { subscription_exposed_id: CGI.escape(subscription_exposed_id) }),
        params: params,
        opts: opts
      )
    end

    save_nested_resource :source
  end
end