stripe 15.1.0 → 15.2.0.pre.beta.1

data/lib/stripe/services/subscription_service.rb

@@ -44,16 +44,44 @@ module Stripe
     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, 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
@@ -140,16 +168,44 @@ 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
         # 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
@@ -179,16 +235,44 @@ module Stripe
 
       class Item < 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
@@ -383,6 +467,9 @@ module Stripe
             end
           end
 
+          class IdBankTransfer < Stripe::RequestParams
+          end
+
           class Konbini < Stripe::RequestParams
           end
 
@@ -394,9 +481,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.
@@ -430,6 +520,8 @@ module Stripe
           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.
@@ -442,6 +534,7 @@ module Stripe
             bancontact: nil,
             card: nil,
             customer_balance: nil,
+            id_bank_transfer: nil,
             konbini: nil,
             sepa_debit: nil,
             us_bank_account: nil
@@ -450,6 +543,7 @@ module Stripe
             @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
@@ -485,6 +579,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
@@ -567,6 +673,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](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, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It 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.
@@ -605,6 +713,7 @@ module Stripe
         payment_behavior: nil,
         payment_settings: nil,
         pending_invoice_item_interval: nil,
+        prebilling: nil,
         proration_behavior: nil,
         proration_date: nil,
         transfer_data: nil,
@@ -636,6 +745,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
         @proration_date = proration_date
         @transfer_data = transfer_data
@@ -723,6 +833,8 @@ module Stripe
       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.
@@ -747,6 +859,7 @@ module Stripe
         current_period_end: nil,
         current_period_start: nil,
         customer: nil,
+        customer_account: nil,
         ending_before: nil,
         expand: nil,
         limit: nil,
@@ -762,6 +875,7 @@ module Stripe
         @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
@@ -776,16 +890,44 @@ module Stripe
     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, 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
@@ -881,16 +1023,44 @@ 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
         # 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
@@ -920,16 +1090,44 @@ module Stripe
 
       class Item < 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
@@ -975,6 +1173,18 @@ module Stripe
             @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
         # 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`.
@@ -989,6 +1199,8 @@ module Stripe
         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(
           discounts: nil,
@@ -997,7 +1209,8 @@ module Stripe
           price: nil,
           price_data: nil,
           quantity: nil,
-          tax_rates: nil
+          tax_rates: nil,
+          trial: nil
         )
           @discounts = discounts
           @metadata = metadata
@@ -1006,6 +1219,7 @@ module Stripe
           @price_data = price_data
           @quantity = quantity
           @tax_rates = tax_rates
+          @trial = trial
         end
       end
 
@@ -1100,6 +1314,9 @@ module Stripe
             end
           end
 
+          class IdBankTransfer < Stripe::RequestParams
+          end
+
           class Konbini < Stripe::RequestParams
           end
 
@@ -1111,9 +1328,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.
@@ -1147,6 +1367,8 @@ module Stripe
           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.
@@ -1159,6 +1381,7 @@ module Stripe
             bancontact: nil,
             card: nil,
             customer_balance: nil,
+            id_bank_transfer: nil,
             konbini: nil,
             sepa_debit: nil,
             us_bank_account: nil
@@ -1167,6 +1390,7 @@ module Stripe
             @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
@@ -1202,6 +1426,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
@@ -1242,6 +1478,8 @@ module Stripe
       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
+      # Configure billing_mode in each subscription to opt in improved credit proration behavior.
+      attr_accessor :billing_mode
       # 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`.
@@ -1252,6 +1490,8 @@ module Stripe
       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).
@@ -1292,6 +1532,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](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.
@@ -1312,11 +1554,13 @@ module Stripe
         backdate_start_date: nil,
         billing_cycle_anchor: nil,
         billing_cycle_anchor_config: nil,
+        billing_mode: 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,
@@ -1332,6 +1576,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,
@@ -1345,11 +1590,13 @@ module Stripe
         @backdate_start_date = backdate_start_date
         @billing_cycle_anchor = billing_cycle_anchor
         @billing_cycle_anchor_config = billing_cycle_anchor_config
+        @billing_mode = billing_mode
         @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
@@ -1365,6 +1612,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

data/lib/stripe/services/tax/association_service.rb

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    class AssociationService < StripeService
+      class FindParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # Valid [PaymentIntent](https://stripe.com/docs/api/payment_intents/object) id
+        attr_accessor :payment_intent
+
+        def initialize(expand: nil, payment_intent: nil)
+          @expand = expand
+          @payment_intent = payment_intent
+        end
+      end
+
+      # Finds a tax association object by PaymentIntent id.
+      def find(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/tax/associations/find",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end