stripe 19.2.0 → 19.3.0.pre.alpha.2

data/lib/stripe/params/subscription_create_params.rb

@@ -5,16 +5,44 @@ module Stripe
   class SubscriptionCreateParams < ::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, promotion_code: nil)
+        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
@@ -257,17 +285,97 @@ module Stripe
     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
+
+      class Settings < ::Stripe::RequestParams
+        class ServicePeriodAnchorConfig < ::Stripe::RequestParams
+          class Custom < ::Stripe::RequestParams
+            # The day of the month the anchor should be. Ranges from 1 to 31.
+            attr_accessor :day_of_month
+            # The hour of the day the anchor should be. Ranges from 0 to 23.
+            attr_accessor :hour
+            # The minute of the hour the anchor should be. Ranges from 0 to 59.
+            attr_accessor :minute
+            # The month to start full cycle periods. Ranges from 1 to 12.
+            attr_accessor :month
+            # The second of the minute the 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
+          # Anchor the service period to a custom date. Type must be `custom` to specify.
+          attr_accessor :custom
+          # The type of service period anchor config. Defaults to `subscription_service_cycle_anchor` if omitted.
+          attr_accessor :type
+
+          def initialize(custom: nil, type: nil)
+            @custom = custom
+            @type = type
+          end
+        end
+        # Configures service period cycle anchoring.
+        attr_accessor :service_period_anchor_config
+        # The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `now` if omitted.
+        attr_accessor :start_date
+
+        def initialize(service_period_anchor_config: nil, start_date: nil)
+          @service_period_anchor_config = service_period_anchor_config
+          @start_date = start_date
+        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
+      # Settings for discount application including service period anchoring.
+      attr_accessor :settings
 
-      def initialize(coupon: nil, discount: nil, promotion_code: nil)
+      def initialize(
+        coupon: nil,
+        discount: nil,
+        discount_end: nil,
+        promotion_code: nil,
+        settings: nil
+      )
         @coupon = coupon
         @discount = discount
+        @discount_end = discount_end
         @promotion_code = promotion_code
+        @settings = settings
       end
     end
 
@@ -304,18 +412,110 @@ module Stripe
         end
       end
 
+      class CurrentTrial < ::Stripe::RequestParams
+        # Unix timestamp representing the end of the trial offer period. Required when the trial offer has `duration.type=timestamp`. Cannot be specified when `duration.type=relative`.
+        attr_accessor :trial_end
+        # The ID of the trial offer to apply to the subscription item.
+        attr_accessor :trial_offer
+
+        def initialize(trial_end: nil, trial_offer: nil)
+          @trial_end = trial_end
+          @trial_offer = trial_offer
+        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
+
+        class Settings < ::Stripe::RequestParams
+          class ServicePeriodAnchorConfig < ::Stripe::RequestParams
+            class Custom < ::Stripe::RequestParams
+              # The day of the month the anchor should be. Ranges from 1 to 31.
+              attr_accessor :day_of_month
+              # The hour of the day the anchor should be. Ranges from 0 to 23.
+              attr_accessor :hour
+              # The minute of the hour the anchor should be. Ranges from 0 to 59.
+              attr_accessor :minute
+              # The month to start full cycle periods. Ranges from 1 to 12.
+              attr_accessor :month
+              # The second of the minute the 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
+            # Anchor the service period to a custom date. Type must be `custom` to specify.
+            attr_accessor :custom
+            # The type of service period anchor config. Defaults to `subscription_service_cycle_anchor` if omitted.
+            attr_accessor :type
+
+            def initialize(custom: nil, type: nil)
+              @custom = custom
+              @type = type
+            end
+          end
+          # Configures service period cycle anchoring.
+          attr_accessor :service_period_anchor_config
+          # The start date of the discount's service period when applying a coupon or promotion code with a service period duration. Defaults to `now` if omitted.
+          attr_accessor :start_date
+
+          def initialize(service_period_anchor_config: nil, start_date: nil)
+            @service_period_anchor_config = service_period_anchor_config
+            @start_date = start_date
+          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
+        # Settings for discount application including service period anchoring.
+        attr_accessor :settings
 
-        def initialize(coupon: nil, discount: nil, promotion_code: nil)
+        def initialize(
+          coupon: nil,
+          discount: nil,
+          discount_end: nil,
+          promotion_code: nil,
+          settings: nil
+        )
           @coupon = coupon
           @discount = discount
+          @discount_end = discount_end
           @promotion_code = promotion_code
+          @settings = settings
         end
       end
 
@@ -364,8 +564,22 @@ module Stripe
           @field_encodings = { unit_amount_decimal: :decimal_string }
         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 trial offer to apply to this subscription item.
+      attr_accessor :current_trial
       # The coupons to redeem into discounts for the subscription item.
       attr_accessor :discounts
       # Set of [key-value pairs](https://docs.stripe.com/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`.
@@ -380,18 +594,23 @@ module Stripe
       attr_accessor :quantity
       # A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/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,
+        current_trial: nil,
         discounts: nil,
         metadata: nil,
         plan: nil,
         price: nil,
         price_data: nil,
         quantity: nil,
-        tax_rates: nil
+        tax_rates: nil,
+        trial: nil
       )
         @billing_thresholds = billing_thresholds
+        @current_trial = current_trial
         @discounts = discounts
         @metadata = metadata
         @plan = plan
@@ -399,6 +618,7 @@ module Stripe
         @price_data = price_data
         @quantity = quantity
         @tax_rates = tax_rates
+        @trial = trial
       end
 
       def self.field_encodings
@@ -439,6 +659,43 @@ module Stripe
           end
         end
 
+        class Bizum < ::Stripe::RequestParams
+          class MandateOptions < ::Stripe::RequestParams
+            # Amount to be charged for future payments. Required when `amount_type=fixed`.
+            attr_accessor :amount
+            # Indicates the mandate amount type.
+            attr_accessor :amount_type
+
+            def initialize(amount: nil, amount_type: nil)
+              @amount = amount
+              @amount_type = amount_type
+            end
+          end
+          # Configuration options for setting up a mandate
+          attr_accessor :mandate_options
+
+          def initialize(mandate_options: nil)
+            @mandate_options = mandate_options
+          end
+        end
+
+        class Blik < ::Stripe::RequestParams
+          class MandateOptions < ::Stripe::RequestParams
+            # Date when the mandate expires and no further payments will be charged. If not provided, the mandate will be set to be indefinite.
+            attr_accessor :expires_after
+
+            def initialize(expires_after: nil)
+              @expires_after = expires_after
+            end
+          end
+          # Configuration options for setting up a mandate
+          attr_accessor :mandate_options
+
+          def initialize(mandate_options: nil)
+            @mandate_options = mandate_options
+          end
+        end
+
         class Card < ::Stripe::RequestParams
           class MandateOptions < ::Stripe::RequestParams
             # Amount to be charged for future payments, specified in the presentment currency.
@@ -468,6 +725,8 @@ module Stripe
           end
         end
 
+        class CheckScan < ::Stripe::RequestParams; end
+
         class CustomerBalance < ::Stripe::RequestParams
           class BankTransfer < ::Stripe::RequestParams
             class EuBankTransfer < ::Stripe::RequestParams
@@ -499,6 +758,7 @@ module Stripe
           end
         end
 
+        class IdBankTransfer < ::Stripe::RequestParams; end
         class Konbini < ::Stripe::RequestParams; end
 
         class Payto < ::Stripe::RequestParams
@@ -588,9 +848,12 @@ module Stripe
             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)
+              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.
@@ -616,14 +879,34 @@ module Stripe
             @verification_method = verification_method
           end
         end
+
+        class WechatPay < ::Stripe::RequestParams
+          # The app ID registered with WeChat Pay. Only required when client is `ios` or `android`.
+          attr_accessor :app_id
+          # The client type that the end customer will pay from.
+          attr_accessor :client
+
+          def initialize(app_id: nil, client: nil)
+            @app_id = app_id
+            @client = client
+          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 Bizum payment method options to pass to the invoice’s PaymentIntent.
+        attr_accessor :bizum
+        # This sub-hash contains details about the Blik payment method options to pass to the invoice’s PaymentIntent.
+        attr_accessor :blik
         # 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 Check Scan payment method options to pass to the invoice’s PaymentIntent.
+        attr_accessor :check_scan
         # 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 PayTo payment method options to pass to the invoice’s PaymentIntent.
@@ -636,29 +919,41 @@ module Stripe
         attr_accessor :upi
         # 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
+        # This sub-hash contains details about the WeChat Pay payment method options to pass to the invoice’s PaymentIntent.
+        attr_accessor :wechat_pay
 
         def initialize(
           acss_debit: nil,
           bancontact: nil,
+          bizum: nil,
+          blik: nil,
           card: nil,
+          check_scan: nil,
           customer_balance: nil,
+          id_bank_transfer: nil,
           konbini: nil,
           payto: nil,
           pix: nil,
           sepa_debit: nil,
           upi: nil,
-          us_bank_account: nil
+          us_bank_account: nil,
+          wechat_pay: nil
         )
           @acss_debit = acss_debit
           @bancontact = bancontact
+          @bizum = bizum
+          @blik = blik
           @card = card
+          @check_scan = check_scan
           @customer_balance = customer_balance
+          @id_bank_transfer = id_bank_transfer
           @konbini = konbini
           @payto = payto
           @pix = pix
           @sepa_debit = sepa_debit
           @upi = upi
           @us_bank_account = us_bank_account
+          @wechat_pay = wechat_pay
         end
       end
       # Payment-method-specific configuration to provide to invoices created by the subscription.
@@ -691,6 +986,18 @@ module Stripe
       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
@@ -705,10 +1012,13 @@ module Stripe
 
     class TrialSettings < ::Stripe::RequestParams
       class EndBehavior < ::Stripe::RequestParams
+        # Indicates how the subscription's billing cycle anchor is reset when a trial ends. Defaults to `now`.
+        attr_accessor :billing_cycle_anchor
         # 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)
+        def initialize(billing_cycle_anchor: nil, missing_payment_method: nil)
+          @billing_cycle_anchor = billing_cycle_anchor
           @missing_payment_method = missing_payment_method
         end
       end
@@ -727,6 +1037,8 @@ module Stripe
     attr_accessor :automatic_tax
     # A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items 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
+    # The Billing Cadence which controls the timing of recurring invoice generation for this subscription. If unset, the subscription will bill according to its own configured schedule and create its own invoices. If set, this subscription will be billed by the cadence instead, potentially sharing invoices with the other subscriptions linked to that Cadence.
+    attr_accessor :billing_cadence
     # A future timestamp in UTC format to anchor the subscription's [billing cycle](https://docs.stripe.com/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 occurrence of the day_of_month at the hour, minute, and second UTC.
@@ -779,6 +1091,8 @@ module Stripe
     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](/api/invoices/create) 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://docs.stripe.com/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.
@@ -797,6 +1111,7 @@ module Stripe
       application_fee_percent: nil,
       automatic_tax: nil,
       backdate_start_date: nil,
+      billing_cadence: nil,
       billing_cycle_anchor: nil,
       billing_cycle_anchor_config: nil,
       billing_mode: nil,
@@ -823,6 +1138,7 @@ module Stripe
       payment_behavior: nil,
       payment_settings: nil,
       pending_invoice_item_interval: nil,
+      prebilling: nil,
       proration_behavior: nil,
       transfer_data: nil,
       trial_end: nil,
@@ -834,6 +1150,7 @@ module Stripe
       @application_fee_percent = application_fee_percent
       @automatic_tax = automatic_tax
       @backdate_start_date = backdate_start_date
+      @billing_cadence = billing_cadence
       @billing_cycle_anchor = billing_cycle_anchor
       @billing_cycle_anchor_config = billing_cycle_anchor_config
       @billing_mode = billing_mode
@@ -860,6 +1177,7 @@ module Stripe
       @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