stripe 17.0.0 → 17.1.0.pre.alpha.1

data/lib/stripe/params/invoice_add_lines_params.rb

@@ -2,24 +2,52 @@
 # frozen_string_literal: true
 
 module Stripe
-  class InvoiceAddLinesParams < Stripe::RequestParams
-    class Line < Stripe::RequestParams
-      class Discount < Stripe::RequestParams
+  class InvoiceAddLinesParams < ::Stripe::RequestParams
+    class Line < ::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
 
-      class Period < Stripe::RequestParams
+      class Period < ::Stripe::RequestParams
         # The end of the period, which must be greater than or equal to the start. This value is inclusive.
         attr_accessor :end
         # The start of the period. This value is inclusive.
@@ -31,8 +59,8 @@ module Stripe
         end
       end
 
-      class PriceData < Stripe::RequestParams
-        class ProductData < Stripe::RequestParams
+      class PriceData < ::Stripe::RequestParams
+        class ProductData < ::Stripe::RequestParams
           # The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
           attr_accessor :description
           # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
@@ -92,7 +120,7 @@ module Stripe
         end
       end
 
-      class Pricing < Stripe::RequestParams
+      class Pricing < ::Stripe::RequestParams
         # The ID of the price object.
         attr_accessor :price
 
@@ -101,8 +129,8 @@ module Stripe
         end
       end
 
-      class TaxAmount < Stripe::RequestParams
-        class TaxRateData < Stripe::RequestParams
+      class TaxAmount < ::Stripe::RequestParams
+        class TaxRateData < ::Stripe::RequestParams
           # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
           attr_accessor :country
           # An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
@@ -172,6 +200,8 @@ module Stripe
       attr_accessor :discounts
       # ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created.
       attr_accessor :invoice_item
+      # The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
+      attr_accessor :margins
       # 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
       # The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
@@ -193,6 +223,7 @@ module Stripe
         discountable: nil,
         discounts: nil,
         invoice_item: nil,
+        margins: nil,
         metadata: nil,
         period: nil,
         price_data: nil,
@@ -206,6 +237,7 @@ module Stripe
         @discountable = discountable
         @discounts = discounts
         @invoice_item = invoice_item
+        @margins = margins
         @metadata = metadata
         @period = period
         @price_data = price_data

data/lib/stripe/params/invoice_attach_payment_params.rb

@@ -2,15 +2,60 @@
 # frozen_string_literal: true
 
 module Stripe
-  class InvoiceAttachPaymentParams < Stripe::RequestParams
+  class InvoiceAttachPaymentParams < ::Stripe::RequestParams
+    class PaymentRecordData < ::Stripe::RequestParams
+      # The amount that was paid out of band.
+      attr_accessor :amount
+      # The currency that was paid out of band.
+      attr_accessor :currency
+      # 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
+      # The type of money movement for this out of band payment record.
+      attr_accessor :money_movement_type
+      # The timestamp when this out of band payment was paid.
+      attr_accessor :paid_at
+      # The reference for this out of band payment record.
+      attr_accessor :payment_reference
+
+      def initialize(
+        amount: nil,
+        currency: nil,
+        metadata: nil,
+        money_movement_type: nil,
+        paid_at: nil,
+        payment_reference: nil
+      )
+        @amount = amount
+        @currency = currency
+        @metadata = metadata
+        @money_movement_type = money_movement_type
+        @paid_at = paid_at
+        @payment_reference = payment_reference
+      end
+    end
+    # The portion of the `amount` on the PaymentIntent or out of band payment to apply to this invoice. It defaults to the entire amount.
+    attr_accessor :amount_requested
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand
     # The ID of the PaymentIntent to attach to the invoice.
     attr_accessor :payment_intent
+    # The ID of the PaymentRecord to attach to the invoice.
+    attr_accessor :payment_record
+    # The PaymentRecord data for attaching an out of band payment to the invoice.
+    attr_accessor :payment_record_data
 
-    def initialize(expand: nil, payment_intent: nil)
+    def initialize(
+      amount_requested: nil,
+      expand: nil,
+      payment_intent: nil,
+      payment_record: nil,
+      payment_record_data: nil
+    )
+      @amount_requested = amount_requested
       @expand = expand
       @payment_intent = payment_intent
+      @payment_record = payment_record
+      @payment_record_data = payment_record_data
     end
   end
 end

data/lib/stripe/params/invoice_create_params.rb

@@ -2,9 +2,27 @@
 # frozen_string_literal: true
 
 module Stripe
-  class InvoiceCreateParams < Stripe::RequestParams
-    class AutomaticTax < Stripe::RequestParams
-      class Liability < Stripe::RequestParams
+  class InvoiceCreateParams < ::Stripe::RequestParams
+    class AmountsDue < ::Stripe::RequestParams
+      # The amount in cents (or local equivalent).
+      attr_accessor :amount
+      # Number of days from when invoice is finalized until the payment is due.
+      attr_accessor :days_until_due
+      # An arbitrary string attached to the object. Often useful for displaying to users.
+      attr_accessor :description
+      # Date on which a payment plan’s payment is due.
+      attr_accessor :due_date
+
+      def initialize(amount: nil, days_until_due: nil, description: nil, due_date: nil)
+        @amount = amount
+        @days_until_due = days_until_due
+        @description = description
+        @due_date = due_date
+      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.
@@ -26,7 +44,7 @@ module Stripe
       end
     end
 
-    class CustomField < Stripe::RequestParams
+    class CustomField < ::Stripe::RequestParams
       # The name of the custom field. This may be up to 40 characters.
       attr_accessor :name
       # The value of the custom field. This may be up to 140 characters.
@@ -38,22 +56,50 @@ module Stripe
       end
     end
 
-    class Discount < 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
 
-    class FromInvoice < Stripe::RequestParams
+    class FromInvoice < ::Stripe::RequestParams
       # The relation between the new invoice and the original invoice. Currently, only 'revision' is permitted
       attr_accessor :action
       # The `id` of the invoice that will be cloned.
@@ -65,7 +111,7 @@ module Stripe
       end
     end
 
-    class Issuer < 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.
@@ -77,10 +123,10 @@ module Stripe
       end
     end
 
-    class PaymentSettings < Stripe::RequestParams
-      class PaymentMethodOptions < Stripe::RequestParams
-        class AcssDebit < Stripe::RequestParams
-          class MandateOptions < Stripe::RequestParams
+    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
 
@@ -99,7 +145,7 @@ module Stripe
           end
         end
 
-        class Bancontact < Stripe::RequestParams
+        class Bancontact < ::Stripe::RequestParams
           # Preferred language of the Bancontact authorization page that the customer is redirected to.
           attr_accessor :preferred_language
 
@@ -108,9 +154,9 @@ module Stripe
           end
         end
 
-        class Card < Stripe::RequestParams
-          class Installments < Stripe::RequestParams
-            class Plan < Stripe::RequestParams
+        class Card < ::Stripe::RequestParams
+          class Installments < ::Stripe::RequestParams
+            class Plan < ::Stripe::RequestParams
               # For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
               attr_accessor :count
               # For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
@@ -149,9 +195,9 @@ module Stripe
           end
         end
 
-        class CustomerBalance < Stripe::RequestParams
-          class BankTransfer < Stripe::RequestParams
-            class EuBankTransfer < Stripe::RequestParams
+        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
 
@@ -180,17 +226,57 @@ module Stripe
           end
         end
 
-        class Konbini < Stripe::RequestParams; end
-        class SepaDebit < Stripe::RequestParams; end
+        class IdBankTransfer < ::Stripe::RequestParams; end
+        class Konbini < ::Stripe::RequestParams; end
+
+        class Pix < ::Stripe::RequestParams
+          # Determines if the amount includes the IOF tax. Defaults to `never`.
+          attr_accessor :amount_includes_iof
+
+          def initialize(amount_includes_iof: nil)
+            @amount_includes_iof = amount_includes_iof
+          end
+        end
+
+        class SepaDebit < ::Stripe::RequestParams; end
+
+        class Upi < ::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
+            # End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
+            attr_accessor :end_date
+
+            def initialize(amount: nil, amount_type: nil, description: nil, end_date: nil)
+              @amount = amount
+              @amount_type = amount_type
+              @description = description
+              @end_date = end_date
+            end
+          end
+          # Configuration options for setting up an eMandate
+          attr_accessor :mandate_options
+
+          def initialize(mandate_options: nil)
+            @mandate_options = mandate_options
+          end
+        end
 
-        class UsBankAccount < Stripe::RequestParams
-          class FinancialConnections < Stripe::RequestParams
-            class Filters < Stripe::RequestParams
+        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)
+              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.
@@ -224,10 +310,16 @@ module Stripe
         attr_accessor :card
         # If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
         attr_accessor :customer_balance
+        # If paying by `id_bank_transfer`, 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
         # If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
         attr_accessor :konbini
+        # If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
+        attr_accessor :pix
         # If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
         attr_accessor :sepa_debit
+        # If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
+        attr_accessor :upi
         # If paying by `us_bank_account`, 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
 
@@ -236,16 +328,22 @@ module Stripe
           bancontact: nil,
           card: nil,
           customer_balance: nil,
+          id_bank_transfer: nil,
           konbini: nil,
+          pix: nil,
           sepa_debit: nil,
+          upi: 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
+          @pix = pix
           @sepa_debit = sepa_debit
+          @upi = upi
           @us_bank_account = us_bank_account
         end
       end
@@ -263,8 +361,8 @@ module Stripe
       end
     end
 
-    class Rendering < Stripe::RequestParams
-      class Pdf < Stripe::RequestParams
+    class Rendering < ::Stripe::RequestParams
+      class Pdf < ::Stripe::RequestParams
         # Page size for invoice PDF. Can be set to `a4`, `letter`, or `auto`.
         #  If set to `auto`, invoice PDF page size defaults to `a4` for customers with
         #  Japanese locale and `letter` for customers with other locales.
@@ -291,10 +389,10 @@ module Stripe
       end
     end
 
-    class ShippingCost < Stripe::RequestParams
-      class ShippingRateData < Stripe::RequestParams
-        class DeliveryEstimate < Stripe::RequestParams
-          class Maximum < Stripe::RequestParams
+    class ShippingCost < ::Stripe::RequestParams
+      class ShippingRateData < ::Stripe::RequestParams
+        class DeliveryEstimate < ::Stripe::RequestParams
+          class Maximum < ::Stripe::RequestParams
             # A unit of time.
             attr_accessor :unit
             # Must be greater than 0.
@@ -306,7 +404,7 @@ module Stripe
             end
           end
 
-          class Minimum < Stripe::RequestParams
+          class Minimum < ::Stripe::RequestParams
             # A unit of time.
             attr_accessor :unit
             # Must be greater than 0.
@@ -328,8 +426,8 @@ module Stripe
           end
         end
 
-        class FixedAmount < Stripe::RequestParams
-          class CurrencyOptions < Stripe::RequestParams
+        class FixedAmount < ::Stripe::RequestParams
+          class CurrencyOptions < ::Stripe::RequestParams
             # A non-negative integer in cents representing how much to charge.
             attr_accessor :amount
             # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
@@ -397,8 +495,8 @@ module Stripe
       end
     end
 
-    class ShippingDetails < Stripe::RequestParams
-      class Address < Stripe::RequestParams
+    class ShippingDetails < ::Stripe::RequestParams
+      class Address < ::Stripe::RequestParams
         # City, district, suburb, town, or village.
         attr_accessor :city
         # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
@@ -442,7 +540,7 @@ module Stripe
       end
     end
 
-    class TransferData < Stripe::RequestParams
+    class TransferData < ::Stripe::RequestParams
       # The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
       attr_accessor :amount
       # ID of an existing, connected Stripe account.
@@ -455,6 +553,8 @@ module Stripe
     end
     # The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
     attr_accessor :account_tax_ids
+    # List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
+    attr_accessor :amounts_due
     # A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).
     attr_accessor :application_fee_amount
     # Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. Defaults to false.
@@ -471,8 +571,12 @@ module Stripe
     attr_accessor :custom_fields
     # The ID of the customer who will be billed.
     attr_accessor :customer
+    # The ID of the account who will be billed.
+    attr_accessor :customer_account
     # The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.
     attr_accessor :days_until_due
+    # The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
+    attr_accessor :default_margins
     # ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
     attr_accessor :default_payment_method
     # ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
@@ -520,6 +624,7 @@ module Stripe
 
     def initialize(
       account_tax_ids: nil,
+      amounts_due: nil,
       application_fee_amount: nil,
       auto_advance: nil,
       automatic_tax: nil,
@@ -528,7 +633,9 @@ module Stripe
       currency: nil,
       custom_fields: nil,
       customer: nil,
+      customer_account: nil,
       days_until_due: nil,
+      default_margins: nil,
       default_payment_method: nil,
       default_source: nil,
       default_tax_rates: nil,
@@ -553,6 +660,7 @@ module Stripe
       transfer_data: nil
     )
       @account_tax_ids = account_tax_ids
+      @amounts_due = amounts_due
       @application_fee_amount = application_fee_amount
       @auto_advance = auto_advance
       @automatic_tax = automatic_tax
@@ -561,7 +669,9 @@ module Stripe
       @currency = currency
       @custom_fields = custom_fields
       @customer = customer
+      @customer_account = customer_account
       @days_until_due = days_until_due
+      @default_margins = default_margins
       @default_payment_method = default_payment_method
       @default_source = default_source
       @default_tax_rates = default_tax_rates