stripe 18.1.0 → 18.2.0.pre.beta.1

data/lib/stripe/params/invoice_item_create_params.rb

@@ -4,16 +4,44 @@
 module Stripe
   class InvoiceItemCreateParams < ::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
@@ -83,6 +111,8 @@ module Stripe
     attr_accessor :expand
     # The ID of an existing invoice to add this invoice item to. For subscription invoices, when left blank, the invoice item will be added to the next upcoming scheduled invoice. For standalone invoices, the invoice item won't be automatically added unless you pass `pending_invoice_item_behavior: 'include'` when creating the invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice.
     attr_accessor :invoice
+    # The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
+    attr_accessor :margins
     # 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`.
     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://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
@@ -114,6 +144,7 @@ module Stripe
       discounts: nil,
       expand: nil,
       invoice: nil,
+      margins: nil,
       metadata: nil,
       period: nil,
       price_data: nil,
@@ -134,6 +165,7 @@ module Stripe
       @discounts = discounts
       @expand = expand
       @invoice = invoice
+      @margins = margins
       @metadata = metadata
       @period = period
       @price_data = price_data

data/lib/stripe/params/invoice_item_update_params.rb

@@ -4,16 +4,44 @@
 module Stripe
   class InvoiceItemUpdateParams < ::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
@@ -75,6 +103,8 @@ module Stripe
     attr_accessor :discounts
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand
+    # The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
+    attr_accessor :margins
     # 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`.
     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://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
@@ -100,6 +130,7 @@ module Stripe
       discountable: nil,
       discounts: nil,
       expand: nil,
+      margins: nil,
       metadata: nil,
       period: nil,
       price_data: nil,
@@ -115,6 +146,7 @@ module Stripe
       @discountable = discountable
       @discounts = discounts
       @expand = expand
+      @margins = margins
       @metadata = metadata
       @period = period
       @price_data = price_data

data/lib/stripe/params/invoice_line_item_update_params.rb

@@ -4,16 +4,44 @@
 module Stripe
   class InvoiceLineItemUpdateParams < ::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
@@ -171,6 +199,8 @@ module Stripe
     attr_accessor :discounts
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand
+    # 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://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`. For [type=subscription](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
     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://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
@@ -192,6 +222,7 @@ module Stripe
       discountable: nil,
       discounts: nil,
       expand: nil,
+      margins: nil,
       metadata: nil,
       period: nil,
       price_data: nil,
@@ -205,6 +236,7 @@ module Stripe
       @discountable = discountable
       @discounts = discounts
       @expand = expand
+      @margins = margins
       @metadata = metadata
       @period = period
       @price_data = price_data

data/lib/stripe/params/invoice_update_lines_params.rb

@@ -5,16 +5,44 @@ module Stripe
   class InvoiceUpdateLinesParams < ::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
@@ -172,6 +200,8 @@ module Stripe
       attr_accessor :discounts
       # ID of an existing line item on the invoice.
       attr_accessor :id
+      # 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://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`. For [type=subscription](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
       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://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
@@ -193,6 +223,7 @@ module Stripe
         discountable: nil,
         discounts: nil,
         id: nil,
+        margins: nil,
         metadata: nil,
         period: nil,
         price_data: nil,
@@ -206,6 +237,7 @@ module Stripe
         @discountable = discountable
         @discounts = discounts
         @id = id
+        @margins = margins
         @metadata = metadata
         @period = period
         @price_data = price_data

data/lib/stripe/params/invoice_update_params.rb

@@ -3,6 +3,24 @@
 
 module Stripe
   class InvoiceUpdateParams < ::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`.
@@ -39,16 +57,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
@@ -168,6 +214,7 @@ module Stripe
           end
         end
 
+        class IdBankTransfer < ::Stripe::RequestParams; end
         class Konbini < ::Stripe::RequestParams; end
 
         class Payto < ::Stripe::RequestParams
@@ -190,16 +237,54 @@ module Stripe
           end
         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
               # 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.
@@ -233,12 +318,18 @@ 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 `payto`, this sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent.
         attr_accessor :payto
+        # 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
 
@@ -247,18 +338,24 @@ module Stripe
           bancontact: nil,
           card: nil,
           customer_balance: nil,
+          id_bank_transfer: nil,
           konbini: nil,
           payto: 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
           @payto = payto
+          @pix = pix
           @sepa_debit = sepa_debit
+          @upi = upi
           @us_bank_account = us_bank_account
         end
       end
@@ -468,6 +565,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://docs.stripe.com/billing/invoices/connect#collecting-fees).
     attr_accessor :application_fee_amount
     # Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice.
@@ -482,6 +581,8 @@ module Stripe
     attr_accessor :custom_fields
     # The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.
     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.
@@ -523,6 +624,7 @@ module Stripe
 
     def initialize(
       account_tax_ids: nil,
+      amounts_due: nil,
       application_fee_amount: nil,
       auto_advance: nil,
       automatic_tax: nil,
@@ -530,6 +632,7 @@ module Stripe
       collection_method: nil,
       custom_fields: nil,
       days_until_due: nil,
+      default_margins: nil,
       default_payment_method: nil,
       default_source: nil,
       default_tax_rates: nil,
@@ -551,6 +654,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
@@ -558,6 +662,7 @@ module Stripe
       @collection_method = collection_method
       @custom_fields = custom_fields
       @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

data/lib/stripe/params/issuing/cardholder_create_params.rb

@@ -194,7 +194,8 @@ module Stripe
       attr_accessor :metadata
       # The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. This field cannot contain any special characters or numbers.
       attr_accessor :name
-      # The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied) for more details.
+      # The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards.
+      #  While phone number is optional if the cardholder will not be creating EU cards, note that this cardholder will not be eligible for 3DS without a phone number. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied) for more details.
       attr_accessor :phone_number
       # The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.
       #  This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder.