stripe 13.6.0.pre.beta.1 → 14.0.0

data/lib/stripe/resources/invoice_item.rb

@@ -24,6 +24,19 @@ module Stripe
       "invoiceitem"
     end
 
+    class Parent < Stripe::StripeObject
+      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 subscription that generated this invoice item
+      attr_reader :subscription_details
+      # The type of parent that generated this invoice item
+      attr_reader :type
+    end
+
     class Period < Stripe::StripeObject
       # The end of the period, which must be greater than or equal to the start. This value is inclusive.
       attr_reader :end
@@ -31,58 +44,36 @@ module Stripe
       attr_reader :start
     end
 
-    class DeleteParams < Stripe::RequestParams
+    class Pricing < Stripe::StripeObject
+      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
+      # Attribute for field price_details
+      attr_reader :price_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 RetrieveParams < Stripe::RequestParams
-      # Specifies which fields in the response should be expanded.
-      attr_accessor :expand
-
-      def initialize(expand: nil)
-        @expand = expand
-      end
+    class DeleteParams < Stripe::RequestParams
     end
 
     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, discount_end: nil, promotion_code: nil)
+        def initialize(coupon: nil, discount: nil, promotion_code: nil)
           @coupon = coupon
           @discount = discount
-          @discount_end = discount_end
           @promotion_code = promotion_code
         end
       end
@@ -102,7 +93,7 @@ module Stripe
       class PriceData < Stripe::RequestParams
         # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
         attr_accessor :currency
-        # The ID of the product that this price will belong to.
+        # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
         attr_accessor :product
         # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
         attr_accessor :tax_behavior
@@ -125,6 +116,15 @@ module Stripe
           @unit_amount_decimal = unit_amount_decimal
         end
       end
+
+      class Pricing < Stripe::RequestParams
+        # The ID of the price object.
+        attr_accessor :price
+
+        def initialize(price: nil)
+          @price = price
+        end
+      end
       # The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
       attr_accessor :amount
       # An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
@@ -135,16 +135,14 @@ 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.
       attr_accessor :period
-      # The ID of the price object. One of `price` or `price_data` is required.
-      attr_accessor :price
-      # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
+      # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
       attr_accessor :price_data
+      # The pricing information for the invoice item.
+      attr_accessor :pricing
       # Non-negative integer. The quantity of units for the invoice item.
       attr_accessor :quantity
       # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
@@ -153,9 +151,7 @@ module Stripe
       attr_accessor :tax_code
       # The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. Pass an empty string to remove previously-defined tax rates.
       attr_accessor :tax_rates
-      # The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.
-      attr_accessor :unit_amount
-      # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
+      # The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount_decimal` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount_decimal` will reduce the `amount_due` on the invoice. Accepts at most 12 decimal places.
       attr_accessor :unit_amount_decimal
 
       def initialize(
@@ -164,16 +160,14 @@ module Stripe
         discountable: nil,
         discounts: nil,
         expand: nil,
-        margins: nil,
         metadata: nil,
         period: nil,
-        price: nil,
         price_data: nil,
+        pricing: nil,
         quantity: nil,
         tax_behavior: nil,
         tax_code: nil,
         tax_rates: nil,
-        unit_amount: nil,
         unit_amount_decimal: nil
       )
         @amount = amount
@@ -181,16 +175,14 @@ module Stripe
         @discountable = discountable
         @discounts = discounts
         @expand = expand
-        @margins = margins
         @metadata = metadata
         @period = period
-        @price = price
         @price_data = price_data
+        @pricing = pricing
         @quantity = quantity
         @tax_behavior = tax_behavior
         @tax_code = tax_code
         @tax_rates = tax_rates
-        @unit_amount = unit_amount
         @unit_amount_decimal = unit_amount_decimal
       end
     end
@@ -253,44 +245,16 @@ 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, discount_end: nil, promotion_code: nil)
+        def initialize(coupon: nil, discount: nil, promotion_code: nil)
           @coupon = coupon
           @discount = discount
-          @discount_end = discount_end
           @promotion_code = promotion_code
         end
       end
@@ -310,7 +274,7 @@ module Stripe
       class PriceData < Stripe::RequestParams
         # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
         attr_accessor :currency
-        # The ID of the product that this price will belong to.
+        # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
         attr_accessor :product
         # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
         attr_accessor :tax_behavior
@@ -333,6 +297,15 @@ module Stripe
           @unit_amount_decimal = unit_amount_decimal
         end
       end
+
+      class Pricing < Stripe::RequestParams
+        # The ID of the price object.
+        attr_accessor :price
+
+        def initialize(price: nil)
+          @price = price
+        end
+      end
       # The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice.
       attr_accessor :amount
       # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
@@ -349,16 +322,14 @@ 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.
       attr_accessor :period
-      # The ID of the price object. One of `price` or `price_data` is required.
-      attr_accessor :price
-      # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
+      # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
       attr_accessor :price_data
+      # The pricing information for the invoice item.
+      attr_accessor :pricing
       # Non-negative integer. The quantity of units for the invoice item.
       attr_accessor :quantity
       # The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
@@ -369,9 +340,7 @@ module Stripe
       attr_accessor :tax_code
       # The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.
       attr_accessor :tax_rates
-      # The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice.
-      attr_accessor :unit_amount
-      # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
+      # The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount_decimal` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount_decimal` will reduce the `amount_due` on the invoice. Accepts at most 12 decimal places.
       attr_accessor :unit_amount_decimal
 
       def initialize(
@@ -383,17 +352,15 @@ module Stripe
         discounts: nil,
         expand: nil,
         invoice: nil,
-        margins: nil,
         metadata: nil,
         period: nil,
-        price: nil,
         price_data: nil,
+        pricing: nil,
         quantity: nil,
         subscription: nil,
         tax_behavior: nil,
         tax_code: nil,
         tax_rates: nil,
-        unit_amount: nil,
         unit_amount_decimal: nil
       )
         @amount = amount
@@ -404,17 +371,15 @@ module Stripe
         @discounts = discounts
         @expand = expand
         @invoice = invoice
-        @margins = margins
         @metadata = metadata
         @period = period
-        @price = price
         @price_data = price_data
+        @pricing = pricing
         @quantity = quantity
         @subscription = subscription
         @tax_behavior = tax_behavior
         @tax_code = tax_code
         @tax_rates = tax_rates
-        @unit_amount = unit_amount
         @unit_amount_decimal = unit_amount_decimal
       end
     end
@@ -438,34 +403,24 @@ 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.
     attr_reader :object
+    # The parent that generated this invoice
+    attr_reader :parent
     # Attribute for field period
     attr_reader :period
-    # If the invoice item is a proration, the plan of the subscription that the proration was computed for.
-    attr_reader :plan
-    # The price of the invoice item.
-    attr_reader :price
+    # The pricing information of the invoice item.
+    attr_reader :pricing
     # Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
     attr_reader :proration
     # Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
     attr_reader :quantity
-    # The subscription that this invoice item has been created for, if any.
-    attr_reader :subscription
-    # The subscription item that this invoice item has been created for, if any.
-    attr_reader :subscription_item
     # The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.
     attr_reader :tax_rates
     # ID of the test clock this invoice item belongs to.
     attr_reader :test_clock
-    # Unit amount (in the `currency` specified) of the invoice item.
-    attr_reader :unit_amount
-    # Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
-    attr_reader :unit_amount_decimal
     # Always true for a deleted object
     attr_reader :deleted