stripe 15.5.0 → 15.6.0.pre.alpha.1

data/lib/stripe/resources/invoice_item.rb

@@ -22,12 +22,38 @@ module Stripe
     end
 
     class Parent < Stripe::StripeObject
+      class LicenseFeeSubscriptionDetails < Stripe::StripeObject
+        # The license fee subscription that generated this invoice item
+        attr_reader :license_fee_subscription
+        # The license fee version that generated this invoice item
+        attr_reader :license_fee_version
+        # The pricing plan subscription that manages the license fee subscription
+        attr_reader :pricing_plan_subscription
+        # The pricing plan version at the time this invoice item was generated
+        attr_reader :pricing_plan_version
+      end
+
+      class RateCardSubscriptionDetails < Stripe::StripeObject
+        # The pricing plan subscription that manages the rate card subscription
+        attr_reader :pricing_plan_subscription
+        # The pricing plan version at the time this invoice item was generated
+        attr_reader :pricing_plan_version
+        # The rate card subscription that generated this invoice item
+        attr_reader :rate_card_subscription
+        # The rate card version that generated this invoice item
+        attr_reader :rate_card_version
+      end
+
       class SubscriptionDetails < Stripe::StripeObject
         # The subscription that generated this invoice item
         attr_reader :subscription
         # The subscription item that generated this invoice item
         attr_reader :subscription_item
       end
+      # Details about the license fee subscription that generated this invoice item
+      attr_reader :license_fee_subscription_details
+      # Details about the rate card subscription that generated this invoice item
+      attr_reader :rate_card_subscription_details
       # Details about the subscription that generated this invoice item
       attr_reader :subscription_details
       # The type of parent that generated this invoice item
@@ -42,14 +68,36 @@ module Stripe
     end
 
     class Pricing < Stripe::StripeObject
+      class LicenseFeeDetails < Stripe::StripeObject
+        # The ID of the license fee this item is associated with
+        attr_reader :license_fee
+        # The version of the license fee this item is associated with
+        attr_reader :license_fee_version
+        # The ID of the licensed item this item is associated with
+        attr_reader :licensed_item
+      end
+
       class PriceDetails < Stripe::StripeObject
         # The ID of the price this item is associated with.
         attr_reader :price
         # The ID of the product this item is associated with.
         attr_reader :product
       end
+
+      class RateCardRateDetails < Stripe::StripeObject
+        # The ID of billable item this item is associated with
+        attr_reader :metered_item
+        # The ID of the rate card this item is associated with
+        attr_reader :rate_card
+        # The ID of the rate card rate this item is associated with
+        attr_reader :rate_card_rate
+      end
+      # Attribute for field license_fee_details
+      attr_reader :license_fee_details
       # Attribute for field price_details
       attr_reader :price_details
+      # Attribute for field rate_card_rate_details
+      attr_reader :rate_card_rate_details
       # The type of the pricing details.
       attr_reader :type
       # The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.
@@ -60,16 +108,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 +207,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 +234,7 @@ module Stripe
         discountable: nil,
         discounts: nil,
         expand: nil,
+        margins: nil,
         metadata: nil,
         period: nil,
         price_data: nil,
@@ -171,6 +250,7 @@ module Stripe
         @discountable = discountable
         @discounts = discounts
         @expand = expand
+        @margins = margins
         @metadata = metadata
         @period = period
         @price_data = price_data
@@ -205,6 +285,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 +303,7 @@ module Stripe
       def initialize(
         created: nil,
         customer: nil,
+        customer_account: nil,
         ending_before: nil,
         expand: nil,
         invoice: nil,
@@ -230,6 +313,7 @@ module Stripe
       )
         @created = created
         @customer = customer
+        @customer_account = customer_account
         @ending_before = ending_before
         @expand = expand
         @invoice = invoice
@@ -241,16 +325,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 +420,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 +432,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://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 +459,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 +480,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 +505,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 +521,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
@@ -42,6 +49,32 @@ module Stripe
         attr_reader :subscription
       end
 
+      class LicenseFeeSubscriptionDetails < Stripe::StripeObject
+        # The invoice item that generated this line item
+        attr_reader :invoice_item
+        # The license fee subscription that generated this line item
+        attr_reader :license_fee_subscription
+        # The license fee version at the time this line item was generated
+        attr_reader :license_fee_version
+        # The pricing plan subscription that manages the license fee subscription
+        attr_reader :pricing_plan_subscription
+        # The pricing plan version at the time this line item was generated
+        attr_reader :pricing_plan_version
+      end
+
+      class RateCardSubscriptionDetails < Stripe::StripeObject
+        # The invoice item that generated this line item
+        attr_reader :invoice_item
+        # The pricing plan subscription that manages the rate card subscription
+        attr_reader :pricing_plan_subscription
+        # The pricing plan version at the time this line item was generated
+        attr_reader :pricing_plan_version
+        # The rate card subscription that generated this line item
+        attr_reader :rate_card_subscription
+        # The rate card version at the time this line item was generated
+        attr_reader :rate_card_version
+      end
+
       class SubscriptionItemDetails < Stripe::StripeObject
         class ProrationDetails < Stripe::StripeObject
           class CreditedItems < Stripe::StripeObject
@@ -66,6 +99,10 @@ module Stripe
       end
       # Details about the invoice item that generated this line item
       attr_reader :invoice_item_details
+      # Details about the license fee subscription that generated this line item
+      attr_reader :license_fee_subscription_details
+      # Details about the rate card subscription that generated this line item
+      attr_reader :rate_card_subscription_details
       # Details about the subscription item that generated this line item
       attr_reader :subscription_item_details
       # The type of parent that generated this line item
@@ -86,25 +123,56 @@ 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
 
     class Pricing < Stripe::StripeObject
+      class LicenseFeeDetails < Stripe::StripeObject
+        # The ID of the license fee this item is associated with
+        attr_reader :license_fee
+        # The version of the license fee this item is associated with
+        attr_reader :license_fee_version
+        # The ID of the licensed item this item is associated with
+        attr_reader :licensed_item
+      end
+
       class PriceDetails < Stripe::StripeObject
         # The ID of the price this item is associated with.
         attr_reader :price
         # The ID of the product this item is associated with.
         attr_reader :product
       end
+
+      class RateCardRateDetails < Stripe::StripeObject
+        # The ID of billable item this item is associated with
+        attr_reader :metered_item
+        # The ID of the rate card this item is associated with
+        attr_reader :rate_card
+        # The ID of the rate card rate this item is associated with
+        attr_reader :rate_card_rate
+      end
+      # Attribute for field license_fee_details
+      attr_reader :license_fee_details
       # Attribute for field price_details
       attr_reader :price_details
+      # Attribute for field rate_card_rate_details
+      attr_reader :rate_card_rate_details
       # The type of the pricing details.
       attr_reader :type
       # The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.
       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 +194,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 +379,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 +402,7 @@ module Stripe
         discountable: nil,
         discounts: nil,
         expand: nil,
+        margins: nil,
         metadata: nil,
         period: nil,
         price_data: nil,
@@ -317,6 +416,7 @@ module Stripe
         @discountable = discountable
         @discounts = discounts
         @expand = expand
+        @margins = margins
         @metadata = metadata
         @period = period
         @price_data = price_data
@@ -344,6 +444,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 +464,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

@@ -23,6 +23,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
@@ -38,11 +40,14 @@ module Stripe
       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 record ID.
+        attr_accessor :payment_record
         # Only return invoice payments associated by this payment type.
         attr_accessor :type
 
-        def initialize(payment_intent: nil, type: nil)
+        def initialize(payment_intent: nil, payment_record: nil, type: nil)
           @payment_intent = payment_intent
+          @payment_record = payment_record
           @type = type
         end
       end

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

@@ -343,10 +343,6 @@ module Stripe
         attr_accessor :cardholder
         # The currency for the card.
         attr_accessor :currency
-        # The desired expiration month (1-12) for this card if [specifying a custom expiration date](/issuing/cards/virtual/issue-cards?testing-method=with-code#exp-dates).
-        attr_accessor :exp_month
-        # The desired 4-digit expiration year for this card if [specifying a custom expiration date](/issuing/cards/virtual/issue-cards?testing-method=with-code#exp-dates).
-        attr_accessor :exp_year
         # Specifies which fields in the response should be expanded.
         attr_accessor :expand
         # The new financial account ID the card will be associated with. This field allows a card to be reassigned to a different financial account.
@@ -375,8 +371,6 @@ module Stripe
         def initialize(
           cardholder: nil,
           currency: nil,
-          exp_month: nil,
-          exp_year: nil,
           expand: nil,
           financial_account: nil,
           metadata: nil,
@@ -392,8 +386,6 @@ module Stripe
         )
           @cardholder = cardholder
           @currency = currency
-          @exp_month = exp_month
-          @exp_year = exp_year
           @expand = expand
           @financial_account = financial_account
           @metadata = metadata

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.