stripe 5.55.0 → 18.2.0.pre.beta.1

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

@@ -0,0 +1,86 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    # A Tax Association exposes the Tax Transactions that Stripe attempted to create on your behalf based on the PaymentIntent input
+    class Association < APIResource
+      OBJECT_NAME = "tax.association"
+      def self.object_name
+        "tax.association"
+      end
+
+      class TaxTransactionAttempt < ::Stripe::StripeObject
+        class Committed < ::Stripe::StripeObject
+          # The [Tax Transaction](https://docs.stripe.com/api/tax/transaction/object)
+          attr_reader :transaction
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Errored < ::Stripe::StripeObject
+          # Details on why we couldn't commit the tax transaction.
+          attr_reader :reason
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field committed
+        attr_reader :committed
+        # Attribute for field errored
+        attr_reader :errored
+        # The source of the tax transaction attempt. This is either a refund or a payment intent.
+        attr_reader :source
+        # The status of the transaction attempt. This can be `errored` or `committed`.
+        attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = { committed: Committed, errored: Errored }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The [Tax Calculation](https://docs.stripe.com/api/tax/calculations/object) that was included in PaymentIntent.
+      attr_reader :calculation
+      # 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 [PaymentIntent](https://docs.stripe.com/api/payment_intents/object) that this Tax Association is tracking.
+      attr_reader :payment_intent
+      # Information about the tax transactions linked to this payment intent
+      attr_reader :tax_transaction_attempts
+
+      # Finds a tax association object by PaymentIntent id.
+      def self.find(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/tax/associations/find",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { tax_transaction_attempts: TaxTransactionAttempt }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,321 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    # A Tax Calculation allows you to calculate the tax to collect from your customer.
+    #
+    # Related guide: [Calculate tax in your custom payment flow](https://docs.stripe.com/tax/custom)
+    class Calculation < APIResource
+      extend Stripe::APIOperations::Create
+
+      OBJECT_NAME = "tax.calculation"
+      def self.object_name
+        "tax.calculation"
+      end
+
+      class CustomerDetails < ::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)).
+          attr_reader :country
+          # Address line 1, such as the street, PO Box, or company name.
+          attr_reader :line1
+          # Address line 2, such as the apartment, suite, unit, or building.
+          attr_reader :line2
+          # ZIP or postal code.
+          attr_reader :postal_code
+          # State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX".
+          attr_reader :state
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class TaxId < ::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.
+          attr_reader :value
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The customer's postal address (for example, home or business location).
+        attr_reader :address
+        # The type of customer address provided.
+        attr_reader :address_source
+        # The customer's IP address (IPv4 or IPv6).
+        attr_reader :ip_address
+        # The customer's tax IDs (for example, EU VAT numbers).
+        attr_reader :tax_ids
+        # The taxability override used for taxation.
+        attr_reader :taxability_override
+
+        def self.inner_class_types
+          @inner_class_types = { address: Address, tax_ids: TaxId }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class ShipFromDetails < ::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)).
+          attr_reader :country
+          # Address line 1, such as the street, PO Box, or company name.
+          attr_reader :line1
+          # Address line 2, such as the apartment, suite, unit, or building.
+          attr_reader :line2
+          # ZIP or postal code.
+          attr_reader :postal_code
+          # State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX".
+          attr_reader :state
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field address
+        attr_reader :address
+
+        def self.inner_class_types
+          @inner_class_types = { address: Address }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class ShippingCost < ::Stripe::StripeObject
+        class TaxBreakdown < ::Stripe::StripeObject
+          class Jurisdiction < ::Stripe::StripeObject
+            # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+            attr_reader :country
+            # A human-readable name for the jurisdiction imposing the tax.
+            attr_reader :display_name
+            # Indicates the level of the jurisdiction imposing the tax.
+            attr_reader :level
+            # [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States.
+            attr_reader :state
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class TaxRateDetails < ::Stripe::StripeObject
+            # A localized display name for tax type, intended to be human-readable. For example, "Local Sales and Use Tax", "Value-added tax (VAT)", or "Umsatzsteuer (USt.)".
+            attr_reader :display_name
+            # The tax rate percentage as a string. For example, 8.5% is represented as "8.5".
+            attr_reader :percentage_decimal
+            # The tax type, such as `vat` or `sales_tax`.
+            attr_reader :tax_type
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
+          attr_reader :amount
+          # Attribute for field jurisdiction
+          attr_reader :jurisdiction
+          # Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address).
+          attr_reader :sourcing
+          # Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax.
+          attr_reader :tax_rate_details
+          # The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
+          attr_reader :taxability_reason
+          # The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
+          attr_reader :taxable_amount
+
+          def self.inner_class_types
+            @inner_class_types = { jurisdiction: Jurisdiction, tax_rate_details: TaxRateDetails }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The shipping amount in the [smallest currency unit](https://docs.stripe.com/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 shipping, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
+        attr_reader :amount_tax
+        # The ID of an existing [ShippingRate](https://docs.stripe.com/api/shipping_rates/object).
+        attr_reader :shipping_rate
+        # Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.
+        attr_reader :tax_behavior
+        # Detailed account of taxes relevant to shipping cost.
+        attr_reader :tax_breakdown
+        # The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for shipping.
+        attr_reader :tax_code
+
+        def self.inner_class_types
+          @inner_class_types = { tax_breakdown: TaxBreakdown }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class TaxBreakdown < ::Stripe::StripeObject
+        class TaxRateDetails < ::Stripe::StripeObject
+          class FlatAmount < ::Stripe::StripeObject
+            # Amount of the tax when the `rate_type` is `flat_amount`. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
+            attr_reader :amount
+            # Three-letter ISO currency code, in lowercase.
+            attr_reader :currency
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+          attr_reader :country
+          # 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
+          # The tax rate percentage as a string. For example, 8.5% is represented as `"8.5"`.
+          attr_reader :percentage_decimal
+          # Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.
+          attr_reader :rate_type
+          # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
+          attr_reader :state
+          # The tax type, such as `vat` or `sales_tax`.
+          attr_reader :tax_type
+
+          def self.inner_class_types
+            @inner_class_types = { flat_amount: FlatAmount }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
+        attr_reader :amount
+        # Specifies whether the tax amount is included in the line item amount.
+        attr_reader :inclusive
+        # Attribute for field tax_rate_details
+        attr_reader :tax_rate_details
+        # The reasoning behind this tax, for example, if the product is tax exempt. We might extend the possible values for this field to support new tax rules.
+        attr_reader :taxability_reason
+        # The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
+        attr_reader :taxable_amount
+
+        def self.inner_class_types
+          @inner_class_types = { tax_rate_details: TaxRateDetails }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Total amount after taxes in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
+      attr_reader :amount_total
+      # 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://docs.stripe.com/api/customers/object) used for the resource.
+      attr_reader :customer
+      # Attribute for field customer_details
+      attr_reader :customer_details
+      # Timestamp of date at which the tax calculation will expire.
+      attr_reader :expires_at
+      # Unique identifier for the calculation.
+      attr_reader :id
+      # The list of items the customer is purchasing.
+      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
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The details of the ship from location, such as the address.
+      attr_reader :ship_from_details
+      # The shipping cost details for the calculation.
+      attr_reader :shipping_cost
+      # The amount of tax to be collected on top of the line item prices.
+      attr_reader :tax_amount_exclusive
+      # The amount of tax already included in the line item prices.
+      attr_reader :tax_amount_inclusive
+      # Breakdown of individual tax amounts that add up to the total.
+      attr_reader :tax_breakdown
+      # Timestamp of date at which the tax rules and rates in effect applies for the calculation.
+      attr_reader :tax_date
+
+      # Calculates tax based on the input and returns a Tax Calculation object.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/tax/calculations",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Retrieves the line items of a tax calculation as a collection, if the calculation hasn't expired.
+      def list_line_items(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: format("/v1/tax/calculations/%<calculation>s/line_items", { calculation: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Retrieves the line items of a tax calculation as a collection, if the calculation hasn't expired.
+      def self.list_line_items(calculation, params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: format("/v1/tax/calculations/%<calculation>s/line_items", { calculation: CGI.escape(calculation) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = {
+          customer_details: CustomerDetails,
+          ship_from_details: ShipFromDetails,
+          shipping_cost: ShippingCost,
+          tax_breakdown: TaxBreakdown,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,103 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    class CalculationLineItem < APIResource
+      OBJECT_NAME = "tax.calculation_line_item"
+      def self.object_name
+        "tax.calculation_line_item"
+      end
+
+      class TaxBreakdown < ::Stripe::StripeObject
+        class Jurisdiction < ::Stripe::StripeObject
+          # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+          attr_reader :country
+          # A human-readable name for the jurisdiction imposing the tax.
+          attr_reader :display_name
+          # Indicates the level of the jurisdiction imposing the tax.
+          attr_reader :level
+          # [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States.
+          attr_reader :state
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class TaxRateDetails < ::Stripe::StripeObject
+          # A localized display name for tax type, intended to be human-readable. For example, "Local Sales and Use Tax", "Value-added tax (VAT)", or "Umsatzsteuer (USt.)".
+          attr_reader :display_name
+          # The tax rate percentage as a string. For example, 8.5% is represented as "8.5".
+          attr_reader :percentage_decimal
+          # The tax type, such as `vat` or `sales_tax`.
+          attr_reader :tax_type
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
+        attr_reader :amount
+        # Attribute for field jurisdiction
+        attr_reader :jurisdiction
+        # Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address).
+        attr_reader :sourcing
+        # Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax.
+        attr_reader :tax_rate_details
+        # The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
+        attr_reader :taxability_reason
+        # The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
+        attr_reader :taxable_amount
+
+        def self.inner_class_types
+          @inner_class_types = { jurisdiction: Jurisdiction, tax_rate_details: TaxRateDetails }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The line item amount in the [smallest currency unit](https://docs.stripe.com/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://docs.stripe.com/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://docs.stripe.com/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://docs.stripe.com/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.
+      attr_reader :reference
+      # Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.
+      attr_reader :tax_behavior
+      # Detailed account of taxes relevant to this line item.
+      attr_reader :tax_breakdown
+      # The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for this resource.
+      attr_reader :tax_code
+
+      def self.inner_class_types
+        @inner_class_types = { tax_breakdown: TaxBreakdown }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end