stripe 15.3.0 → 15.4.0.pre.beta.1

data/lib/stripe/resources/invoice_item.rb

@@ -60,16 +60,44 @@ module Stripe
 
     class UpdateParams < 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
@@ -131,6 +159,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://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.
@@ -156,6 +186,7 @@ module Stripe
         discountable: nil,
         discounts: nil,
         expand: nil,
+        margins: nil,
         metadata: nil,
         period: nil,
         price_data: nil,
@@ -171,6 +202,7 @@ module Stripe
         @discountable = discountable
         @discounts = discounts
         @expand = expand
+        @margins = margins
         @metadata = metadata
         @period = period
         @price_data = price_data
@@ -205,6 +237,8 @@ module Stripe
       attr_accessor :created
       # The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned.
       attr_accessor :customer
+      # The identifier of the account whose invoice items to return. If none is provided, all invoice items will be returned.
+      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.
@@ -221,6 +255,7 @@ module Stripe
       def initialize(
         created: nil,
         customer: nil,
+        customer_account: nil,
         ending_before: nil,
         expand: nil,
         invoice: nil,
@@ -230,6 +265,7 @@ module Stripe
       )
         @created = created
         @customer = customer
+        @customer_account = customer_account
         @ending_before = ending_before
         @expand = expand
         @invoice = invoice
@@ -241,16 +277,44 @@ module Stripe
 
     class CreateParams < 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
@@ -308,6 +372,8 @@ module Stripe
       attr_accessor :currency
       # The ID of the customer who will be billed when this invoice item is billed.
       attr_accessor :customer
+      # The ID of the account who will be billed when this invoice item is billed.
+      attr_accessor :customer_account
       # An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
       attr_accessor :description
       # Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items.
@@ -318,6 +384,8 @@ module Stripe
       attr_accessor :expand
       # The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled 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://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.
@@ -343,11 +411,13 @@ module Stripe
         amount: nil,
         currency: nil,
         customer: nil,
+        customer_account: nil,
         description: nil,
         discountable: nil,
         discounts: nil,
         expand: nil,
         invoice: nil,
+        margins: nil,
         metadata: nil,
         period: nil,
         price_data: nil,
@@ -362,11 +432,13 @@ module Stripe
         @amount = amount
         @currency = currency
         @customer = customer
+        @customer_account = customer_account
         @description = description
         @discountable = discountable
         @discounts = discounts
         @expand = expand
         @invoice = invoice
+        @margins = margins
         @metadata = metadata
         @period = period
         @price_data = price_data
@@ -385,6 +457,8 @@ module Stripe
     attr_reader :currency
     # The ID of the customer who will be billed when this invoice item is billed.
     attr_reader :customer
+    # The ID of the account who will be billed when this invoice item is billed.
+    attr_reader :customer_account
     # Time at which the object was created. Measured in seconds since the Unix epoch.
     attr_reader :date
     # An arbitrary string attached to the object. Often useful for displaying to users.
@@ -399,6 +473,8 @@ module Stripe
     attr_reader :invoice
     # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
     attr_reader :livemode
+    # The margins which apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
+    attr_reader :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.
     attr_reader :metadata
     # String representing the object's type. Objects of the same type share the same value.

data/lib/stripe/resources/invoice_line_item.rb

@@ -20,6 +20,13 @@ module Stripe
       attr_reader :discount
     end
 
+    class MarginAmount < Stripe::StripeObject
+      # The amount, in cents (or local equivalent), of the reduction in line item amount.
+      attr_reader :amount
+      # The margin that was applied to get this margin amount.
+      attr_reader :margin
+    end
+
     class Parent < Stripe::StripeObject
       class InvoiceItemDetails < Stripe::StripeObject
         class ProrationDetails < Stripe::StripeObject
@@ -86,6 +93,8 @@ module Stripe
       attr_reader :credit_balance_transaction
       # The discount that was applied to get this pretax credit amount.
       attr_reader :discount
+      # The margin that was applied to get this pretax credit amount.
+      attr_reader :margin
       # Type of the pretax credit amount referenced.
       attr_reader :type
     end
@@ -105,6 +114,13 @@ module Stripe
       attr_reader :unit_amount_decimal
     end
 
+    class TaxCalculationReference < Stripe::StripeObject
+      # The calculation identifier for tax calculation response.
+      attr_reader :calculation_id
+      # The calculation identifier for tax calculation response line item.
+      attr_reader :calculation_item_id
+    end
+
     class Tax < Stripe::StripeObject
       class TaxRateDetails < Stripe::StripeObject
         # Attribute for field tax_rate
@@ -126,16 +142,44 @@ module Stripe
 
     class UpdateParams < 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
@@ -283,6 +327,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://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`. For [type=subscription](https://stripe.com/docs/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://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.
@@ -304,6 +350,7 @@ module Stripe
         discountable: nil,
         discounts: nil,
         expand: nil,
+        margins: nil,
         metadata: nil,
         period: nil,
         price_data: nil,
@@ -317,6 +364,7 @@ module Stripe
         @discountable = discountable
         @discounts = discounts
         @expand = expand
+        @margins = margins
         @metadata = metadata
         @period = period
         @price_data = price_data
@@ -344,6 +392,10 @@ module Stripe
     attr_reader :invoice
     # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
     attr_reader :livemode
+    # The amount of margin calculated per margin for this line item.
+    attr_reader :margin_amounts
+    # The margins applied to the line item. When set, the `default_margins` on the invoice do not apply to the line item. Use `expand[]=margins` to expand each margin.
+    attr_reader :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. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.
     attr_reader :metadata
     # String representing the object's type. Objects of the same type share the same value.
@@ -360,6 +412,8 @@ module Stripe
     attr_reader :quantity
     # Attribute for field subscription
     attr_reader :subscription
+    # The tax calculation identifiers of the line item.
+    attr_reader :tax_calculation_reference
     # The tax information of the line item.
     attr_reader :taxes
 

data/lib/stripe/resources/invoice_payment.rb

@@ -11,8 +11,6 @@ module Stripe
   # This resource and its endpoints allows you to easily track if a payment is associated with a specific invoice and
   # monitor the allocation details of the payments.
   class InvoicePayment < APIResource
-    extend Stripe::APIOperations::List
-
     OBJECT_NAME = "invoice_payment"
     def self.object_name
       "invoice_payment"
@@ -23,6 +21,8 @@ module Stripe
       attr_reader :charge
       # ID of the PaymentIntent associated with this payment when `type` is `payment_intent`. Note: This property is only populated for invoices finalized on or after March 15th, 2019.
       attr_reader :payment_intent
+      # ID of the PaymentRecord associated with this payment when `type` is `payment_record`.
+      attr_reader :payment_record
       # Type of payment object associated with this invoice payment.
       attr_reader :type
     end
@@ -33,52 +33,6 @@ module Stripe
       # The time that the payment succeeded.
       attr_reader :paid_at
     end
-
-    class ListParams < Stripe::RequestParams
-      class Payment < Stripe::RequestParams
-        # Only return invoice payments associated by this payment intent ID.
-        attr_accessor :payment_intent
-        # Only return invoice payments associated by this payment type.
-        attr_accessor :type
-
-        def initialize(payment_intent: nil, type: nil)
-          @payment_intent = payment_intent
-          @type = type
-        end
-      end
-      # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
-      attr_accessor :ending_before
-      # Specifies which fields in the response should be expanded.
-      attr_accessor :expand
-      # The identifier of the invoice whose payments to return.
-      attr_accessor :invoice
-      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
-      attr_accessor :limit
-      # The payment details of the invoice payments to return.
-      attr_accessor :payment
-      # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
-      attr_accessor :starting_after
-      # The status of the invoice payments to return.
-      attr_accessor :status
-
-      def initialize(
-        ending_before: nil,
-        expand: nil,
-        invoice: nil,
-        limit: nil,
-        payment: nil,
-        starting_after: nil,
-        status: nil
-      )
-        @ending_before = ending_before
-        @expand = expand
-        @invoice = invoice
-        @limit = limit
-        @payment = payment
-        @starting_after = starting_after
-        @status = status
-      end
-    end
     # Amount that was actually paid for this invoice, in cents (or local equivalent). This field is null until the payment is `paid`. This amount can be less than the `amount_requested` if the PaymentIntent’s `amount_received` is not sufficient to pay all of the invoices that it is attached to.
     attr_reader :amount_paid
     # Amount intended to be paid toward this invoice, in cents (or local equivalent)
@@ -103,10 +57,5 @@ module Stripe
     attr_reader :status
     # Attribute for field status_transitions
     attr_reader :status_transitions
-
-    # When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.
-    def self.list(params = {}, opts = {})
-      request_stripe_object(method: :get, path: "/v1/invoice_payments", params: params, opts: opts)
-    end
   end
 end

data/lib/stripe/resources/issuing/cardholder.rb

@@ -366,7 +366,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://stripe.com/docs/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://stripe.com/docs/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://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.