stripe 13.2.0 → 13.3.0.pre.beta.2

data/lib/stripe/resources/tax/registration.rb

@@ -18,6 +18,385 @@ module Stripe
         "tax.registration"
       end
 
+      class CountryOptions < Stripe::StripeObject
+        class Ae < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class At < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Au < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Be < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Bg < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Bh < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class By < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Ca < Stripe::StripeObject
+          class ProvinceStandard < Stripe::StripeObject
+            attr_reader :province
+          end
+          attr_reader :province_standard, :type
+        end
+
+        class Ch < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Cl < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Co < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Cr < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Cy < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Cz < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class De < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Dk < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Ec < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Ee < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Eg < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Es < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Fi < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Fr < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Gb < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Ge < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Gr < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Hr < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Hu < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Id < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Ie < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Is < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class It < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Jp < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Ke < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Kr < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Kz < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Lt < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Lu < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Lv < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Ma < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Md < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Mt < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Mx < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class My < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Ng < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Nl < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class No < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Nz < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Om < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Pl < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Pt < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Ro < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Rs < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Ru < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Sa < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Se < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Sg < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Si < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Sk < Stripe::StripeObject
+          class Standard < Stripe::StripeObject
+            attr_reader :place_of_supply_scheme
+          end
+          attr_reader :standard, :type
+        end
+
+        class Th < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Tr < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Tz < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Us < Stripe::StripeObject
+          class LocalAmusementTax < Stripe::StripeObject
+            attr_reader :jurisdiction
+          end
+
+          class LocalLeaseTax < Stripe::StripeObject
+            attr_reader :jurisdiction
+          end
+
+          class StateSalesTax < Stripe::StripeObject
+            class Election < Stripe::StripeObject
+              attr_reader :jurisdiction, :type
+            end
+            attr_reader :elections
+          end
+          attr_reader :local_amusement_tax, :local_lease_tax, :state, :state_sales_tax, :type
+        end
+
+        class Uz < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Vn < Stripe::StripeObject
+          attr_reader :type
+        end
+
+        class Za < Stripe::StripeObject
+          attr_reader :type
+        end
+        attr_reader :ae, :at, :au, :be, :bg, :bh, :by, :ca, :ch, :cl, :co, :cr, :cy, :cz, :de, :dk, :ec, :ee, :eg, :es, :fi, :fr, :gb, :ge, :gr, :hr, :hu, :id, :ie, :is, :it, :jp, :ke, :kr, :kz, :lt, :lu, :lv, :ma, :md, :mt, :mx, :my, :ng, :nl, :no, :nz, :om, :pl, :pt, :ro, :rs, :ru, :sa, :se, :sg, :si, :sk, :th, :tr, :tz, :us, :uz, :vn, :za
+      end
+      # Time at which the registration becomes active. Measured in seconds since the Unix epoch.
+      attr_reader :active_from
+      # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+      attr_reader :country
+      # Attribute for field country_options
+      attr_reader :country_options
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch.
+      attr_reader :expires_at
+      # Unique identifier for the object.
+      attr_reader :id
+      # 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
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The status of the registration. This field is present for convenience and can be deduced from `active_from` and `expires_at`.
+      attr_reader :status
+
       # Creates a new Tax Registration object.
       def self.create(params = {}, opts = {})
         request_stripe_object(

data/lib/stripe/resources/tax/settings.rb

@@ -8,10 +8,43 @@ module Stripe
     # Related guide: [Using the Settings API](https://stripe.com/docs/tax/settings-api)
     class Settings < SingletonAPIResource
       include Stripe::APIOperations::SingletonSave
+
       OBJECT_NAME = "tax.settings"
       def self.object_name
         "tax.settings"
       end
+
+      class Defaults < Stripe::StripeObject
+        attr_reader :tax_behavior, :tax_code
+      end
+
+      class HeadOffice < Stripe::StripeObject
+        class Address < Stripe::StripeObject
+          attr_reader :city, :country, :line1, :line2, :postal_code, :state
+        end
+        attr_reader :address
+      end
+
+      class StatusDetails < Stripe::StripeObject
+        class Active < Stripe::StripeObject; end
+
+        class Pending < Stripe::StripeObject
+          attr_reader :missing_fields
+        end
+        attr_reader :active, :pending
+      end
+      # Attribute for field defaults
+      attr_reader :defaults
+      # The place where your business is located.
+      attr_reader :head_office
+      # 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
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The status of the Tax `Settings`.
+      attr_reader :status
+      # Attribute for field status_details
+      attr_reader :status_details
     end
   end
 end

data/lib/stripe/resources/tax/transaction.rb

@@ -12,6 +12,74 @@ module Stripe
         "tax.transaction"
       end
 
+      class CustomerDetails < Stripe::StripeObject
+        class Address < Stripe::StripeObject
+          attr_reader :city, :country, :line1, :line2, :postal_code, :state
+        end
+
+        class TaxId < Stripe::StripeObject
+          attr_reader :type, :value
+        end
+        attr_reader :address, :address_source, :ip_address, :tax_ids, :taxability_override
+      end
+
+      class Reversal < Stripe::StripeObject
+        attr_reader :original_transaction
+      end
+
+      class ShipFromDetails < Stripe::StripeObject
+        class Address < Stripe::StripeObject
+          attr_reader :city, :country, :line1, :line2, :postal_code, :state
+        end
+        attr_reader :address
+      end
+
+      class ShippingCost < Stripe::StripeObject
+        class TaxBreakdown < Stripe::StripeObject
+          class Jurisdiction < Stripe::StripeObject
+            attr_reader :country, :display_name, :level, :state
+          end
+
+          class TaxRateDetails < Stripe::StripeObject
+            attr_reader :display_name, :percentage_decimal, :tax_type
+          end
+          attr_reader :amount, :jurisdiction, :sourcing, :tax_rate_details, :taxability_reason, :taxable_amount
+        end
+        attr_reader :amount, :amount_tax, :shipping_rate, :tax_behavior, :tax_breakdown, :tax_code
+      end
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # 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_reader :currency
+      # The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource.
+      attr_reader :customer
+      # Attribute for field customer_details
+      attr_reader :customer_details
+      # Unique identifier for the transaction.
+      attr_reader :id
+      # The tax collected or refunded, by line item.
+      attr_reader :line_items
+      # 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
+      # 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 Unix timestamp representing when the tax liability is assumed or reduced.
+      attr_reader :posted_at
+      # A custom unique identifier, such as 'myOrder_123'.
+      attr_reader :reference
+      # If `type=reversal`, contains information about what was reversed.
+      attr_reader :reversal
+      # The details of the ship from location, such as the address.
+      attr_reader :ship_from_details
+      # The shipping cost details for the transaction.
+      attr_reader :shipping_cost
+      # Timestamp of date at which the tax rules and rates in effect applies for the calculation.
+      attr_reader :tax_date
+      # If `reversal`, this transaction reverses an earlier transaction.
+      attr_reader :type
+
       # Creates a Tax Transaction from a calculation, if that calculation hasn't expired. Calculations expire after 90 days.
       def self.create_from_calculation(params = {}, opts = {})
         request_stripe_object(

data/lib/stripe/resources/tax/transaction_line_item.rb

@@ -8,6 +8,36 @@ module Stripe
       def self.object_name
         "tax.transaction_line_item"
       end
+
+      class Reversal < Stripe::StripeObject
+        attr_reader :original_line_item
+      end
+      # The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
+      attr_reader :amount
+      # The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
+      attr_reader :amount_tax
+      # Unique identifier for the object.
+      attr_reader :id
+      # 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
+      # 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 ID of an existing [Product](https://stripe.com/docs/api/products/object).
+      attr_reader :product
+      # The number of units of the item being purchased. For reversals, this is the quantity reversed.
+      attr_reader :quantity
+      # A custom identifier for this line item in the transaction.
+      attr_reader :reference
+      # If `type=reversal`, contains information about what was reversed.
+      attr_reader :reversal
+      # Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.
+      attr_reader :tax_behavior
+      # The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource.
+      attr_reader :tax_code
+      # If `reversal`, this line item reverses an earlier transaction.
+      attr_reader :type
     end
   end
 end

data/lib/stripe/resources/tax_code.rb

@@ -11,6 +11,15 @@ module Stripe
       "tax_code"
     end
 
+    # A detailed description of which types of products the tax code represents.
+    attr_reader :description
+    # Unique identifier for the object.
+    attr_reader :id
+    # A short name for the tax code.
+    attr_reader :name
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+
     # A list of [all tax codes available](https://stripe.com/docs/tax/tax-categories) to add to Products in order to allow specific tax calculations.
     def self.list(filters = {}, opts = {})
       request_stripe_object(method: :get, path: "/v1/tax_codes", params: filters, opts: opts)

data/lib/stripe/resources/tax_deducted_at_source.rb

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TaxDeductedAtSource < APIResource
+    OBJECT_NAME = "tax_deducted_at_source"
+    def self.object_name
+      "tax_deducted_at_source"
+    end
+
+    # Unique identifier for the object.
+    attr_reader :id
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period.
+    attr_reader :period_end
+    # The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period.
+    attr_reader :period_start
+    # The TAN that was supplied to Stripe when TDS was assessed
+    attr_reader :tax_deduction_account_number
+  end
+end

data/lib/stripe/resources/tax_id.rb

@@ -16,6 +16,36 @@ module Stripe
       "tax_id"
     end
 
+    class Owner < Stripe::StripeObject
+      attr_reader :account, :application, :customer, :type
+    end
+
+    class Verification < Stripe::StripeObject
+      attr_reader :status, :verified_address, :verified_name
+    end
+    # Two-letter ISO code representing the country of the tax ID.
+    attr_reader :country
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # ID of the customer.
+    attr_reader :customer
+    # Unique identifier for the object.
+    attr_reader :id
+    # 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
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # The account or customer the tax ID belongs to.
+    attr_reader :owner
+    # Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`
+    attr_reader :type
+    # Value of the tax ID.
+    attr_reader :value
+    # Tax ID verification information.
+    attr_reader :verification
+    # Always true for a deleted object
+    attr_reader :deleted
+
     # Creates a new account or customer tax_id object.
     def self.create(params = {}, opts = {})
       request_stripe_object(method: :post, path: "/v1/tax_ids", params: params, opts: opts)

data/lib/stripe/resources/tax_rate.rb

@@ -15,6 +15,48 @@ module Stripe
       "tax_rate"
     end
 
+    class FlatAmount < Stripe::StripeObject
+      attr_reader :amount, :currency
+    end
+    # Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
+    attr_reader :active
+    # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+    attr_reader :country
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
+    attr_reader :description
+    # The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
+    attr_reader :display_name
+    # Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true,
+    # this percentage reflects the rate actually used to calculate tax based on the product's taxability
+    # and whether the user is registered to collect taxes in the corresponding jurisdiction.
+    attr_reader :effective_percentage
+    # The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.
+    attr_reader :flat_amount
+    # Unique identifier for the object.
+    attr_reader :id
+    # This specifies if the tax rate is inclusive or exclusive.
+    attr_reader :inclusive
+    # The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
+    attr_reader :jurisdiction
+    # The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates.
+    attr_reader :jurisdiction_level
+    # 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
+    # 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
+    # Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.
+    attr_reader :percentage
+    # Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location.
+    attr_reader :rate_type
+    # [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.
+    attr_reader :state
+    # The high-level tax type, such as `vat` or `sales_tax`.
+    attr_reader :tax_type
+
     # Creates a new tax rate.
     def self.create(params = {}, opts = {})
       request_stripe_object(method: :post, path: "/v1/tax_rates", params: params, opts: opts)