stripe 17.1.0.pre.beta.2 → 17.1.0

data/lib/stripe/resources/invoice.rb

@@ -49,35 +49,8 @@ module Stripe
 
     nested_resource_class_methods :line, operations: %i[list]
 
-    class AmountsDue < Stripe::StripeObject
-      # Incremental amount due for this payment in cents (or local equivalent).
-      attr_reader :amount
-      # The amount in cents (or local equivalent) that was paid for this payment.
-      attr_reader :amount_paid
-      # The difference between the payment’s amount and amount_paid, in cents (or local equivalent).
-      attr_reader :amount_remaining
-      # Number of days from when invoice is finalized until the payment is due.
-      attr_reader :days_until_due
-      # An arbitrary string attached to the object. Often useful for displaying to users.
-      attr_reader :description
-      # Date on which a payment plan’s payment is due.
-      attr_reader :due_date
-      # Timestamp when the payment was paid.
-      attr_reader :paid_at
-      # The status of the payment, one of `open`, `paid`, or `past_due`
-      attr_reader :status
-
-      def self.inner_class_types
-        @inner_class_types = {}
-      end
-
-      def self.field_remappings
-        @field_remappings = {}
-      end
-    end
-
-    class AutomaticTax < Stripe::StripeObject
-      class Liability < Stripe::StripeObject
+    class AutomaticTax < ::Stripe::StripeObject
+      class Liability < ::Stripe::StripeObject
         # The connected account being referenced when `type` is `account`.
         attr_reader :account
         # Type of the account referenced.
@@ -111,7 +84,7 @@ module Stripe
       end
     end
 
-    class ConfirmationSecret < Stripe::StripeObject
+    class ConfirmationSecret < ::Stripe::StripeObject
       # The client_secret of the payment that Stripe creates for the invoice after finalization.
       attr_reader :client_secret
       # The type of client_secret. Currently this is always payment_intent, referencing the default payment_intent that Stripe creates during invoice finalization
@@ -126,7 +99,7 @@ module Stripe
       end
     end
 
-    class CustomField < Stripe::StripeObject
+    class CustomField < ::Stripe::StripeObject
       # The name of the custom field.
       attr_reader :name
       # The value of the custom field.
@@ -141,7 +114,7 @@ module Stripe
       end
     end
 
-    class CustomerAddress < Stripe::StripeObject
+    class CustomerAddress < ::Stripe::StripeObject
       # City, district, suburb, town, or village.
       attr_reader :city
       # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
@@ -164,8 +137,8 @@ module Stripe
       end
     end
 
-    class CustomerShipping < Stripe::StripeObject
-      class Address < Stripe::StripeObject
+    class CustomerShipping < ::Stripe::StripeObject
+      class Address < ::Stripe::StripeObject
         # City, district, suburb, town, or village.
         attr_reader :city
         # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
@@ -207,7 +180,7 @@ module Stripe
       end
     end
 
-    class CustomerTaxId < Stripe::StripeObject
+    class CustomerTaxId < ::Stripe::StripeObject
       # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`
       attr_reader :type
       # The value of the tax ID.
@@ -222,7 +195,7 @@ module Stripe
       end
     end
 
-    class FromInvoice < Stripe::StripeObject
+    class FromInvoice < ::Stripe::StripeObject
       # The relation between this invoice and the cloned invoice
       attr_reader :action
       # The invoice that was cloned.
@@ -237,7 +210,7 @@ module Stripe
       end
     end
 
-    class Issuer < Stripe::StripeObject
+    class Issuer < ::Stripe::StripeObject
       # The connected account being referenced when `type` is `account`.
       attr_reader :account
       # Type of the account referenced.
@@ -252,7 +225,7 @@ module Stripe
       end
     end
 
-    class LastFinalizationError < Stripe::StripeObject
+    class LastFinalizationError < ::Stripe::StripeObject
       # For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one.
       attr_reader :advice_code
       # For card errors, the ID of the failed charge.
@@ -329,21 +302,8 @@ module Stripe
       end
     end
 
-    class Parent < Stripe::StripeObject
-      class BillingCadenceDetails < Stripe::StripeObject
-        # The billing cadence that generated this invoice
-        attr_reader :billing_cadence
-
-        def self.inner_class_types
-          @inner_class_types = {}
-        end
-
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-
-      class QuoteDetails < Stripe::StripeObject
+    class Parent < ::Stripe::StripeObject
+      class QuoteDetails < ::Stripe::StripeObject
         # The quote that generated this invoice
         attr_reader :quote
 
@@ -356,41 +316,23 @@ module Stripe
         end
       end
 
-      class SubscriptionDetails < Stripe::StripeObject
-        class PauseCollection < Stripe::StripeObject
-          # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
-          attr_reader :behavior
-          # The time after which the subscription will resume collecting payments.
-          attr_reader :resumes_at
-
-          def self.inner_class_types
-            @inner_class_types = {}
-          end
-
-          def self.field_remappings
-            @field_remappings = {}
-          end
-        end
+      class SubscriptionDetails < ::Stripe::StripeObject
         # Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.
         #  *Note: This attribute is populated only for invoices created on or after June 29, 2023.*
         attr_reader :metadata
-        # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
-        attr_reader :pause_collection
         # The subscription that generated this invoice
         attr_reader :subscription
         # Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
         attr_reader :subscription_proration_date
 
         def self.inner_class_types
-          @inner_class_types = { pause_collection: PauseCollection }
+          @inner_class_types = {}
         end
 
         def self.field_remappings
           @field_remappings = {}
         end
       end
-      # Details about the billing cadence that generated this invoice
-      attr_reader :billing_cadence_details
       # Details about the quote that generated this invoice
       attr_reader :quote_details
       # Details about the subscription that generated this invoice
@@ -400,7 +342,6 @@ module Stripe
 
       def self.inner_class_types
         @inner_class_types = {
-          billing_cadence_details: BillingCadenceDetails,
           quote_details: QuoteDetails,
           subscription_details: SubscriptionDetails,
         }
@@ -411,10 +352,10 @@ module Stripe
       end
     end
 
-    class PaymentSettings < Stripe::StripeObject
-      class PaymentMethodOptions < Stripe::StripeObject
-        class AcssDebit < Stripe::StripeObject
-          class MandateOptions < Stripe::StripeObject
+    class PaymentSettings < ::Stripe::StripeObject
+      class PaymentMethodOptions < ::Stripe::StripeObject
+        class AcssDebit < ::Stripe::StripeObject
+          class MandateOptions < ::Stripe::StripeObject
             # Transaction type of the mandate.
             attr_reader :transaction_type
 
@@ -440,7 +381,7 @@ module Stripe
           end
         end
 
-        class Bancontact < Stripe::StripeObject
+        class Bancontact < ::Stripe::StripeObject
           # Preferred language of the Bancontact authorization page that the customer is redirected to.
           attr_reader :preferred_language
 
@@ -453,8 +394,8 @@ module Stripe
           end
         end
 
-        class Card < Stripe::StripeObject
-          class Installments < Stripe::StripeObject
+        class Card < ::Stripe::StripeObject
+          class Installments < ::Stripe::StripeObject
             # Whether Installments are enabled for this Invoice.
             attr_reader :enabled
 
@@ -480,9 +421,9 @@ module Stripe
           end
         end
 
-        class CustomerBalance < Stripe::StripeObject
-          class BankTransfer < Stripe::StripeObject
-            class EuBankTransfer < Stripe::StripeObject
+        class CustomerBalance < ::Stripe::StripeObject
+          class BankTransfer < ::Stripe::StripeObject
+            class EuBankTransfer < ::Stripe::StripeObject
               # The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
               attr_reader :country
 
@@ -521,17 +462,7 @@ module Stripe
           end
         end
 
-        class IdBankTransfer < Stripe::StripeObject
-          def self.inner_class_types
-            @inner_class_types = {}
-          end
-
-          def self.field_remappings
-            @field_remappings = {}
-          end
-        end
-
-        class Konbini < Stripe::StripeObject
+        class Konbini < ::Stripe::StripeObject
           def self.inner_class_types
             @inner_class_types = {}
           end
@@ -541,10 +472,7 @@ module Stripe
           end
         end
 
-        class Pix < Stripe::StripeObject
-          # Determines if the amount includes the IOF tax.
-          attr_reader :amount_includes_iof
-
+        class SepaDebit < ::Stripe::StripeObject
           def self.inner_class_types
             @inner_class_types = {}
           end
@@ -554,54 +482,11 @@ module Stripe
           end
         end
 
-        class SepaDebit < Stripe::StripeObject
-          def self.inner_class_types
-            @inner_class_types = {}
-          end
-
-          def self.field_remappings
-            @field_remappings = {}
-          end
-        end
-
-        class Upi < Stripe::StripeObject
-          class MandateOptions < Stripe::StripeObject
-            # Amount to be charged for future payments.
-            attr_reader :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_reader :amount_type
-            # A description of the mandate or subscription that is meant to be displayed to the customer.
-            attr_reader :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_reader :end_date
-
-            def self.inner_class_types
-              @inner_class_types = {}
-            end
-
-            def self.field_remappings
-              @field_remappings = {}
-            end
-          end
-          # Attribute for field mandate_options
-          attr_reader :mandate_options
-
-          def self.inner_class_types
-            @inner_class_types = { mandate_options: MandateOptions }
-          end
-
-          def self.field_remappings
-            @field_remappings = {}
-          end
-        end
-
-        class UsBankAccount < Stripe::StripeObject
-          class FinancialConnections < Stripe::StripeObject
-            class Filters < Stripe::StripeObject
+        class UsBankAccount < ::Stripe::StripeObject
+          class FinancialConnections < ::Stripe::StripeObject
+            class Filters < ::Stripe::StripeObject
               # The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
               attr_reader :account_subcategories
-              # The institution to use to filter for possible accounts to link.
-              attr_reader :institution
 
               def self.inner_class_types
                 @inner_class_types = {}
@@ -647,16 +532,10 @@ module Stripe
         attr_reader :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_reader :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_reader :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_reader :konbini
-        # If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
-        attr_reader :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_reader :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_reader :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_reader :us_bank_account
 
@@ -666,11 +545,8 @@ module Stripe
             bancontact: Bancontact,
             card: Card,
             customer_balance: CustomerBalance,
-            id_bank_transfer: IdBankTransfer,
             konbini: Konbini,
-            pix: Pix,
             sepa_debit: SepaDebit,
-            upi: Upi,
             us_bank_account: UsBankAccount,
           }
         end
@@ -695,8 +571,8 @@ module Stripe
       end
     end
 
-    class Rendering < Stripe::StripeObject
-      class Pdf < Stripe::StripeObject
+    class Rendering < ::Stripe::StripeObject
+      class Pdf < ::Stripe::StripeObject
         # Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale.
         attr_reader :page_size
 
@@ -726,8 +602,8 @@ module Stripe
       end
     end
 
-    class ShippingCost < Stripe::StripeObject
-      class Tax < Stripe::StripeObject
+    class ShippingCost < ::Stripe::StripeObject
+      class Tax < ::Stripe::StripeObject
         # Amount of tax applied for this rate.
         attr_reader :amount
         # Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
@@ -767,8 +643,8 @@ module Stripe
       end
     end
 
-    class ShippingDetails < Stripe::StripeObject
-      class Address < Stripe::StripeObject
+    class ShippingDetails < ::Stripe::StripeObject
+      class Address < ::Stripe::StripeObject
         # City, district, suburb, town, or village.
         attr_reader :city
         # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
@@ -810,7 +686,7 @@ module Stripe
       end
     end
 
-    class StatusTransitions < Stripe::StripeObject
+    class StatusTransitions < ::Stripe::StripeObject
       # The time that the invoice draft was finalized.
       attr_reader :finalized_at
       # The time that the invoice was marked uncollectible.
@@ -829,8 +705,8 @@ module Stripe
       end
     end
 
-    class ThresholdReason < Stripe::StripeObject
-      class ItemReason < Stripe::StripeObject
+    class ThresholdReason < ::Stripe::StripeObject
+      class ItemReason < ::Stripe::StripeObject
         # The IDs of the line items that triggered the threshold invoice.
         attr_reader :line_item_ids
         # The quantity threshold boundary that applied to the given line item.
@@ -858,7 +734,7 @@ module Stripe
       end
     end
 
-    class TotalDiscountAmount < Stripe::StripeObject
+    class TotalDiscountAmount < ::Stripe::StripeObject
       # The amount, in cents (or local equivalent), of the discount.
       attr_reader :amount
       # The discount that was applied to get this discount amount.
@@ -873,30 +749,13 @@ module Stripe
       end
     end
 
-    class TotalMarginAmount < 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
-
-      def self.inner_class_types
-        @inner_class_types = {}
-      end
-
-      def self.field_remappings
-        @field_remappings = {}
-      end
-    end
-
-    class TotalPretaxCreditAmount < Stripe::StripeObject
+    class TotalPretaxCreditAmount < ::Stripe::StripeObject
       # The amount, in cents (or local equivalent), of the pretax credit amount.
       attr_reader :amount
       # The credit balance transaction that was applied to get this pretax credit amount.
       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
 
@@ -909,8 +768,8 @@ module Stripe
       end
     end
 
-    class TotalTax < Stripe::StripeObject
-      class TaxRateDetails < Stripe::StripeObject
+    class TotalTax < ::Stripe::StripeObject
+      class TaxRateDetails < ::Stripe::StripeObject
         # Attribute for field tax_rate
         attr_reader :tax_rate
 
@@ -959,8 +818,6 @@ module Stripe
     attr_reader :amount_remaining
     # This is the sum of all the shipping amounts.
     attr_reader :amount_shipping
-    # List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.
-    attr_reader :amounts_due
     # ID of the Connect Application that created the invoice.
     attr_reader :application
     # Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
@@ -995,8 +852,6 @@ module Stripe
     attr_reader :custom_fields
     # The ID of the customer who will be billed.
     attr_reader :customer
-    # The ID of the account who will be billed.
-    attr_reader :customer_account
     # The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.
     attr_reader :customer_address
     # The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated.
@@ -1011,8 +866,6 @@ module Stripe
     attr_reader :customer_tax_exempt
     # The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.
     attr_reader :customer_tax_ids
-    # The margins applied to the invoice. Can be overridden by line item `margins`. Use `expand[]=default_margins` to expand each margin.
-    attr_reader :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_reader :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.
@@ -1103,8 +956,6 @@ module Stripe
     attr_reader :total_discount_amounts
     # The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
     attr_reader :total_excluding_tax
-    # The aggregate amounts calculated per margin across all line items.
-    attr_reader :total_margin_amounts
     # Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
     attr_reader :total_pretax_credit_amounts
     # The aggregate tax information of all line items.
@@ -1393,7 +1244,6 @@ module Stripe
 
     def self.inner_class_types
       @inner_class_types = {
-        amounts_due: AmountsDue,
         automatic_tax: AutomaticTax,
         confirmation_secret: ConfirmationSecret,
         custom_fields: CustomField,
@@ -1411,7 +1261,6 @@ module Stripe
         status_transitions: StatusTransitions,
         threshold_reason: ThresholdReason,
         total_discount_amounts: TotalDiscountAmount,
-        total_margin_amounts: TotalMarginAmount,
         total_pretax_credit_amounts: TotalPretaxCreditAmount,
         total_taxes: TotalTax,
       }

data/lib/stripe/resources/invoice_item.rb

@@ -21,8 +21,8 @@ module Stripe
       "invoiceitem"
     end
 
-    class Parent < Stripe::StripeObject
-      class SubscriptionDetails < Stripe::StripeObject
+    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
@@ -50,7 +50,7 @@ module Stripe
       end
     end
 
-    class Period < Stripe::StripeObject
+    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
       # The start of the period. This value is inclusive.
@@ -65,8 +65,8 @@ module Stripe
       end
     end
 
-    class Pricing < Stripe::StripeObject
-      class PriceDetails < Stripe::StripeObject
+    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.
@@ -96,8 +96,8 @@ module Stripe
       end
     end
 
-    class ProrationDetails < Stripe::StripeObject
-      class DiscountAmount < Stripe::StripeObject
+    class ProrationDetails < ::Stripe::StripeObject
+      class DiscountAmount < ::Stripe::StripeObject
         # The amount, in cents (or local equivalent), of the discount.
         attr_reader :amount
         # The discount that was applied to get this discount amount.
@@ -128,8 +128,6 @@ 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.
@@ -144,8 +142,6 @@ 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
     # The amount after discounts, but before credits and taxes. This field is `null` for `discountable=true` items.