diff --git a/.latest-tag-stripe-openapi-sdk b/.latest-tag-stripe-openapi-sdk index fc908948..7a598060 100644 --- a/.latest-tag-stripe-openapi-sdk +++ b/.latest-tag-stripe-openapi-sdk @@ -1 +1 @@ -v630 +v634 diff --git a/lib/generated/account.ex b/lib/generated/account.ex index affd4e89..3cb4b083 100644 --- a/lib/generated/account.ex +++ b/lib/generated/account.ex @@ -91,7 +91,7 @@ defmodule Stripe.Account do ) ( - @typedoc "The Kanji variation of the company's primary address (Japan only)." + @typedoc "The Kanji variation of the the individual's primary address (Japan only)." @type address_kanji :: %{ optional(:city) => binary, optional(:country) => binary, @@ -216,18 +216,13 @@ defmodule Stripe.Account do ) ( - @typedoc "Settings specific to the account's use of the Card Issuing product." - @type card_issuing :: %{optional(:tos_acceptance) => tos_acceptance} + @typedoc "The card_issuing capability." + @type card_issuing :: %{optional(:requested) => boolean} ) ( - @typedoc "Settings specific to card charging on the account." - @type card_payments :: %{ - optional(:decline_on) => decline_on, - optional(:statement_descriptor_prefix) => binary, - optional(:statement_descriptor_prefix_kana) => binary | binary, - optional(:statement_descriptor_prefix_kanji) => binary | binary - } + @typedoc "The card_payments capability." + @type card_payments :: %{optional(:requested) => boolean} ) ( diff --git a/lib/generated/checkout__session.ex b/lib/generated/checkout__session.ex index 88ca5384..95083d9e 100644 --- a/lib/generated/checkout__session.ex +++ b/lib/generated/checkout__session.ex @@ -950,8 +950,11 @@ defmodule Stripe.Checkout.Session do ) ( - @typedoc "The parameters used to automatically create a Transfer when the payment succeeds.\nFor more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts)." - @type transfer_data :: %{optional(:amount) => integer, optional(:destination) => binary} + @typedoc "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges." + @type transfer_data :: %{ + optional(:amount_percent) => number, + optional(:destination) => binary + } ) ( diff --git a/lib/generated/payment_intent.ex b/lib/generated/payment_intent.ex index 4ee484e0..482acc32 100644 --- a/lib/generated/payment_intent.ex +++ b/lib/generated/payment_intent.ex @@ -101,7 +101,7 @@ defmodule Stripe.PaymentIntent do ) ( - @typedoc "Shipping address." + @typedoc nil @type address :: %{ optional(:city) => binary, optional(:country) => binary, @@ -136,8 +136,8 @@ defmodule Stripe.PaymentIntent do ) ( - @typedoc nil - @type au_becs_debit :: %{optional(:setup_future_usage) => :none | :off_session | :on_session} + @typedoc "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account." + @type au_becs_debit :: %{optional(:account_number) => binary, optional(:bsb_number) => binary} ) ( @@ -149,8 +149,8 @@ defmodule Stripe.PaymentIntent do ) ( - @typedoc "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account." - @type bacs_debit :: %{optional(:account_number) => binary, optional(:sort_code) => binary} + @typedoc nil + @type bacs_debit :: %{optional(:setup_future_usage) => :none | :off_session | :on_session} ) ( @@ -192,11 +192,8 @@ defmodule Stripe.PaymentIntent do ) ( - @typedoc nil - @type boleto :: %{ - optional(:expires_after_days) => integer, - optional(:setup_future_usage) => :none | :off_session | :on_session - } + @typedoc "If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method." + @type boleto :: %{optional(:tax_id) => binary} ) ( @@ -285,38 +282,8 @@ defmodule Stripe.PaymentIntent do ) ( - @typedoc "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method." - @type eps :: %{ - optional(:bank) => - :arzte_und_apotheker_bank - | :austrian_anadi_bank_ag - | :bank_austria - | :bankhaus_carl_spangler - | :bankhaus_schelhammer_und_schattera_ag - | :bawag_psk_ag - | :bks_bank_ag - | :brull_kallmus_bank_ag - | :btv_vier_lander_bank - | :capital_bank_grawe_gruppe_ag - | :deutsche_bank_ag - | :dolomitenbank - | :easybank_ag - | :erste_bank_und_sparkassen - | :hypo_alpeadriabank_international_ag - | :hypo_bank_burgenland_aktiengesellschaft - | :hypo_noe_lb_fur_niederosterreich_u_wien - | :hypo_oberosterreich_salzburg_steiermark - | :hypo_tirol_bank_ag - | :hypo_vorarlberg_bank_ag - | :marchfelder_bank - | :oberbank_ag - | :raiffeisen_bankengruppe_osterreich - | :schoellerbank_ag - | :sparda_bank_wien - | :volksbank_gruppe - | :volkskreditbank_ag - | :vr_bank_braunau - } + @typedoc nil + @type eps :: %{optional(:setup_future_usage) => :none} ) ( @@ -350,8 +317,25 @@ defmodule Stripe.PaymentIntent do ) ( - @typedoc nil - @type ideal :: %{optional(:setup_future_usage) => :none | :off_session} + @typedoc "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method." + @type ideal :: %{ + optional(:bank) => + :abn_amro + | :asn_bank + | :bunq + | :handelsbanken + | :ing + | :knab + | :moneyou + | :n26 + | :rabobank + | :regiobank + | :revolut + | :sns_bank + | :triodos_bank + | :van_lanschot + | :yoursafe + } ) ( @@ -360,56 +344,8 @@ defmodule Stripe.PaymentIntent do ) ( - @typedoc nil - @type klarna :: %{ - optional(:capture_method) => :manual, - optional(:preferred_locale) => - :"cs-CZ" - | :"da-DK" - | :"de-AT" - | :"de-CH" - | :"de-DE" - | :"el-GR" - | :"en-AT" - | :"en-AU" - | :"en-BE" - | :"en-CA" - | :"en-CH" - | :"en-CZ" - | :"en-DE" - | :"en-DK" - | :"en-ES" - | :"en-FI" - | :"en-FR" - | :"en-GB" - | :"en-GR" - | :"en-IE" - | :"en-IT" - | :"en-NL" - | :"en-NO" - | :"en-NZ" - | :"en-PL" - | :"en-PT" - | :"en-SE" - | :"en-US" - | :"es-ES" - | :"es-US" - | :"fi-FI" - | :"fr-BE" - | :"fr-CA" - | :"fr-CH" - | :"fr-FR" - | :"it-CH" - | :"it-IT" - | :"nb-NO" - | :"nl-BE" - | :"nl-NL" - | :"pl-PL" - | :"pt-PT" - | :"sv-FI" - | :"sv-SE", - optional(:setup_future_usage) => :none - } + @typedoc "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method." + @type klarna :: %{optional(:dob) => dob} ) ( @@ -471,34 +407,10 @@ defmodule Stripe.PaymentIntent do ) ( - @typedoc "If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method." + @typedoc nil @type p24 :: %{ - optional(:bank) => - :alior_bank - | :bank_millennium - | :bank_nowy_bfg_sa - | :bank_pekao_sa - | :banki_spbdzielcze - | :blik - | :bnp_paribas - | :boz - | :citi_handlowy - | :credit_agricole - | :envelobank - | :etransfer_pocztowy24 - | :getin_bank - | :ideabank - | :ing - | :inteligo - | :mbank_mtransfer - | :nest_przelew - | :noble_pay - | :pbac_z_ipko - | :plus_bank - | :santander_przelew24 - | :tmobile_usbugi_bankowe - | :toyota_bank - | :volkswagen_bank + optional(:setup_future_usage) => :none, + optional(:tos_shown_and_accepted) => boolean } ) @@ -678,11 +590,8 @@ defmodule Stripe.PaymentIntent do ) ( - @typedoc nil - @type sepa_debit :: %{ - optional(:mandate_options) => map(), - optional(:setup_future_usage) => :none | :off_session | :on_session - } + @typedoc "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account." + @type sepa_debit :: %{optional(:iban) => binary} ) ( diff --git a/lib/generated/setup_intent.ex b/lib/generated/setup_intent.ex index e3ea8b63..35bb17a7 100644 --- a/lib/generated/setup_intent.ex +++ b/lib/generated/setup_intent.ex @@ -62,11 +62,11 @@ defmodule Stripe.SetupIntent do ) ( - @typedoc "If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method." + @typedoc "If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options." @type acss_debit :: %{ - optional(:account_number) => binary, - optional(:institution_number) => binary, - optional(:transit_number) => binary + optional(:currency) => :cad | :usd, + optional(:mandate_options) => mandate_options, + optional(:verification_method) => :automatic | :instant | :microdeposits } ) @@ -278,13 +278,18 @@ defmodule Stripe.SetupIntent do ) ( - @typedoc "Additional fields for Mandate creation" + @typedoc "Configuration options for setting up an eMandate for cards issued in India." @type mandate_options :: %{ - optional(:custom_mandate_url) => binary | binary, - optional(:default_for) => list(:invoice | :subscription), - optional(:interval_description) => binary, - optional(:payment_schedule) => :combined | :interval | :sporadic, - optional(:transaction_type) => :business | :personal + optional(:amount) => integer, + optional(:amount_type) => :fixed | :maximum, + optional(:currency) => binary, + optional(:description) => binary, + optional(:end_date) => integer, + optional(:interval) => :day | :month | :sporadic | :week | :year, + optional(:interval_count) => integer, + optional(:reference) => binary, + optional(:start_date) => integer, + optional(:supported_types) => list(:india) } ) diff --git a/lib/generated/tax__registration.ex b/lib/generated/tax__registration.ex new file mode 100644 index 00000000..ee126782 --- /dev/null +++ b/lib/generated/tax__registration.ex @@ -0,0 +1,552 @@ +defmodule Stripe.Tax.Registration do + use Stripe.Entity + + @moduledoc "A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://stripe.com/docs/tax).\n\nStripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://stripe.com/docs/tax/registering).\n\nRelated guide: [Using the Registrations API](https://stripe.com/docs/tax/registrations-api)" + ( + defstruct [ + :active_from, + :country, + :country_options, + :created, + :expires_at, + :id, + :livemode, + :object, + :status + ] + + @typedoc "The `tax.registration` type.\n\n * `active_from` Time at which the registration becomes active. Measured in seconds since the Unix epoch.\n * `country` Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).\n * `country_options` \n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `expires_at` 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.\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `status` The status of the registration. This field is present for convenience and can be deduced from `active_from` and `expires_at`.\n" + @type t :: %__MODULE__{ + active_from: integer, + country: binary, + country_options: term, + created: integer, + expires_at: integer | nil, + id: binary, + livemode: boolean, + object: binary, + status: binary + } + ) + + ( + @typedoc "Options for the registration in AE." + @type ae :: %{optional(:type) => :standard} + ) + + ( + @typedoc "Options for the registration in AT." + @type at :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in AU." + @type au :: %{optional(:type) => :standard} + ) + + ( + @typedoc "Options for the registration in BE." + @type be :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in BG." + @type bg :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in CA." + @type ca :: %{ + optional(:province_standard) => province_standard, + optional(:type) => :province_standard | :simplified | :standard + } + ) + + ( + @typedoc "Options for the registration in CH." + @type ch :: %{optional(:type) => :standard} + ) + + ( + @typedoc "Options for the registration in CL." + @type cl :: %{optional(:type) => :simplified} + ) + + ( + @typedoc "Options for the registration in CO." + @type co :: %{optional(:type) => :simplified} + ) + + ( + @typedoc "Specific options for a registration in the specified `country`." + @type country_options :: %{ + optional(:vn) => vn, + optional(:lv) => lv, + optional(:cl) => cl, + optional(:se) => se, + optional(:pl) => pl, + optional(:nz) => nz, + optional(:lt) => lt, + optional(:de) => de, + optional(:fr) => fr, + optional(:fi) => fi, + optional(:sa) => sa, + optional(:es) => es, + optional(:sg) => sg, + optional(:tr) => tr, + optional(:sk) => sk, + optional(:ie) => ie, + optional(:th) => th, + optional(:us) => us, + optional(:co) => co, + optional(:ee) => ee, + optional(:hu) => hu, + optional(:it) => it, + optional(:jp) => jp, + optional(:si) => si, + optional(:kr) => kr, + optional(:gb) => gb, + optional(:ca) => ca, + optional(:dk) => dk, + optional(:nl) => nl, + optional(:my) => my, + optional(:ae) => ae, + optional(:gr) => gr, + optional(:ch) => ch, + optional(:be) => be, + optional(:cz) => cz, + optional(:no) => no, + optional(:lu) => lu, + optional(:cy) => cy, + optional(:au) => au, + optional(:mt) => mt, + optional(:is) => is, + optional(:bg) => bg, + optional(:za) => za, + optional(:hr) => hr, + optional(:id) => id, + optional(:ro) => ro, + optional(:mx) => mx, + optional(:pt) => pt, + optional(:at) => at + } + ) + + ( + @typedoc "Options for the registration in CY." + @type cy :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in CZ." + @type cz :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in DE." + @type de :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in DK." + @type dk :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in EE." + @type ee :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in ES." + @type es :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in FI." + @type fi :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in FR." + @type fr :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in GB." + @type gb :: %{optional(:type) => :standard} + ) + + ( + @typedoc "Options for the registration in GR." + @type gr :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in HR." + @type hr :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in HU." + @type hu :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in ID." + @type id :: %{optional(:type) => :simplified} + ) + + ( + @typedoc "Options for the registration in IE." + @type ie :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in IS." + @type is :: %{optional(:type) => :standard} + ) + + ( + @typedoc "Options for the registration in IT." + @type it :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in JP." + @type jp :: %{optional(:type) => :standard} + ) + + ( + @typedoc "Options for the registration in KR." + @type kr :: %{optional(:type) => :simplified} + ) + + ( + @typedoc "Options for the local amusement tax registration." + @type local_amusement_tax :: %{optional(:jurisdiction) => binary} + ) + + ( + @typedoc "Options for the local lease tax registration." + @type local_lease_tax :: %{optional(:jurisdiction) => binary} + ) + + ( + @typedoc "Options for the registration in LT." + @type lt :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in LU." + @type lu :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in LV." + @type lv :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in MT." + @type mt :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in MX." + @type mx :: %{optional(:type) => :simplified} + ) + + ( + @typedoc "Options for the registration in MY." + @type my :: %{optional(:type) => :simplified} + ) + + ( + @typedoc "Options for the registration in NL." + @type nl :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in NO." + @type no :: %{optional(:type) => :standard} + ) + + ( + @typedoc "Options for the registration in NZ." + @type nz :: %{optional(:type) => :standard} + ) + + ( + @typedoc "Options for the registration in PL." + @type pl :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the provincial tax registration." + @type province_standard :: %{optional(:province) => binary} + ) + + ( + @typedoc "Options for the registration in PT." + @type pt :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in RO." + @type ro :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in SA." + @type sa :: %{optional(:type) => :simplified} + ) + + ( + @typedoc "Options for the registration in SE." + @type se :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in SG." + @type sg :: %{optional(:type) => :standard} + ) + + ( + @typedoc "Options for the registration in SI." + @type si :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the registration in SK." + @type sk :: %{ + optional(:standard) => standard, + optional(:type) => :ioss | :oss_non_union | :oss_union | :standard + } + ) + + ( + @typedoc "Options for the standard registration." + @type standard :: %{optional(:place_of_supply_scheme) => :small_seller | :standard} + ) + + ( + @typedoc "Options for the registration in TH." + @type th :: %{optional(:type) => :simplified} + ) + + ( + @typedoc "Options for the registration in TR." + @type tr :: %{optional(:type) => :simplified} + ) + + ( + @typedoc "Options for the registration in US." + @type us :: %{ + optional(:local_amusement_tax) => local_amusement_tax, + optional(:local_lease_tax) => local_lease_tax, + optional(:state) => binary, + optional(:type) => + :local_amusement_tax + | :local_lease_tax + | :state_communications_tax + | :state_sales_tax + } + ) + + ( + @typedoc "Options for the registration in VN." + @type vn :: %{optional(:type) => :simplified} + ) + + ( + @typedoc "Options for the registration in ZA." + @type za :: %{optional(:type) => :standard} + ) + + ( + nil + + @doc "

Returns a list of Tax Registration objects.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/tax/registrations`\n" + ( + @spec list( + params :: %{ + optional(:ending_before) => binary, + optional(:expand) => list(binary), + optional(:limit) => integer, + optional(:starting_after) => binary, + optional(:status) => :active | :all | :expired | :scheduled + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.List.t(Stripe.Tax.Registration.t())} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def list(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/tax/registrations", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:get) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Creates a new Tax Registration object.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/tax/registrations`\n" + ( + @spec create( + params :: %{ + optional(:active_from) => :now | integer, + optional(:country) => binary, + optional(:country_options) => country_options, + optional(:expand) => list(binary), + optional(:expires_at) => integer + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Tax.Registration.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def create(params \\ %{}, opts \\ []) do + path = Stripe.OpenApi.Path.replace_path_params("/v1/tax/registrations", [], []) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) + + ( + nil + + @doc "

Updates an existing Tax Registration object.

\n\n

A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.

\n\n#### Details\n\n * Method: `post`\n * Path: `/v1/tax/registrations/{id}`\n" + ( + @spec update( + id :: binary(), + params :: %{ + optional(:active_from) => :now | integer, + optional(:expand) => list(binary), + optional(:expires_at) => :now | integer | binary + }, + opts :: Keyword.t() + ) :: + {:ok, Stripe.Tax.Registration.t()} + | {:error, Stripe.ApiErrors.t()} + | {:error, term()} + def update(id, params \\ %{}, opts \\ []) do + path = + Stripe.OpenApi.Path.replace_path_params( + "/v1/tax/registrations/{id}", + [ + %OpenApiGen.Blueprint.Parameter{ + in: "path", + name: "id", + required: true, + schema: %OpenApiGen.Blueprint.Parameter.Schema{ + name: "id", + title: nil, + type: "string", + items: [], + properties: [], + any_of: [] + } + } + ], + [id] + ) + + Stripe.Request.new_request(opts) + |> Stripe.Request.put_endpoint(path) + |> Stripe.Request.put_params(params) + |> Stripe.Request.put_method(:post) + |> Stripe.Request.make_request() + end + ) + ) +end diff --git a/lib/generated/token.ex b/lib/generated/token.ex index d56e79fc..3b6698b7 100644 --- a/lib/generated/token.ex +++ b/lib/generated/token.ex @@ -20,11 +20,12 @@ defmodule Stripe.Token do ) ( - @typedoc "Details on the legal guardian's acceptance of the main Stripe service agreement." + @typedoc "Information for the account this token represents." @type account :: %{ - optional(:date) => integer, - optional(:ip) => binary, - optional(:user_agent) => binary | binary + optional(:business_type) => :company | :government_entity | :individual | :non_profit, + optional(:company) => company, + optional(:individual) => individual, + optional(:tos_shown_and_accepted) => boolean } ) @@ -51,7 +52,7 @@ defmodule Stripe.Token do ) ( - @typedoc "The Kana variation of the the individual's primary address (Japan only)." + @typedoc "The Kana variation of the person's address (Japan only)." @type address_kana :: %{ optional(:city) => binary, optional(:country) => binary, @@ -64,7 +65,7 @@ defmodule Stripe.Token do ) ( - @typedoc "The Kanji variation of the company's primary address (Japan only)." + @typedoc "The Kanji variation of the the individual's primary address (Japan only)." @type address_kanji :: %{ optional(:city) => binary, optional(:country) => binary, diff --git a/priv/openapi/spec3.sdk.json b/priv/openapi/spec3.sdk.json index 72892361..7a85b903 100644 --- a/priv/openapi/spec3.sdk.json +++ b/priv/openapi/spec3.sdk.json @@ -25155,7 +25155,8 @@ } }, "required": [ - "billing_agreement_id" + "billing_agreement_id", + "payer_id" ], "title": "mandate_paypal", "type": "object", @@ -33057,6 +33058,13 @@ "type": "string" } }, + "required": [ + "payer_email", + "payer_id", + "payer_name", + "seller_protection", + "transaction_id" + ], "title": "payment_method_details_paypal", "type": "object", "x-expandableFields": [ @@ -34689,7 +34697,8 @@ } }, "required": [ - "preferred_locale" + "preferred_locale", + "reference" ], "title": "payment_method_options_paypal", "type": "object", @@ -34933,6 +34942,10 @@ "type": "string" } }, + "required": [ + "payer_email", + "payer_id" + ], "title": "payment_method_paypal", "type": "object", "x-expandableFields": [], @@ -48753,6 +48766,105 @@ "in_package": "Tax" } }, + "tax.registration": { + "description": "A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://stripe.com/docs/tax).\n\nStripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://stripe.com/docs/tax/registering).\n\nRelated guide: [Using the Registrations API](https://stripe.com/docs/tax/registrations-api)", + "properties": { + "active_from": { + "description": "Time at which the registration becomes active. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + }, + "country": { + "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", + "maxLength": 5000, + "type": "string" + }, + "country_options": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options" + }, + "created": { + "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + }, + "expires_at": { + "description": "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.", + "format": "unix-time", + "nullable": true, + "type": "integer" + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "tax.registration" + ], + "type": "string" + }, + "status": { + "description": "The status of the registration. This field is present for convenience and can be deduced from `active_from` and `expires_at`.", + "enum": [ + "active", + "expired", + "scheduled" + ], + "type": "string" + } + }, + "required": [ + "active_from", + "country", + "country_options", + "created", + "expires_at", + "id", + "livemode", + "object", + "status" + ], + "title": "TaxProductRegistrationsResourceTaxRegistration", + "type": "object", + "x-expandableFields": [ + "country_options" + ], + "x-resourceId": "tax.registration", + "x-stripeOperations": [ + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/tax/registrations" + }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/tax/registrations" + }, + { + "method_name": "update", + "method_on": "service", + "method_type": "update", + "operation": "post", + "path": "/v1/tax/registrations/{id}" + } + ], + "x-stripeResource": { + "class_name": "Registration", + "has_collection_class": true, + "in_package": "Tax" + } + }, "tax.settings": { "description": "You can use Tax `Settings` to manage configurations used by Stripe Tax calculations.\n\nRelated guide: [Using the Settings API](https://stripe.com/docs/tax/settings-api)", "properties": { @@ -49497,6 +49609,441 @@ "in_package": "" } }, + "tax_product_registrations_resource_country_options": { + "description": "", + "properties": { + "ae": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" + }, + "at": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "au": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" + }, + "be": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "bg": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "ca": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_canada" + }, + "ch": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" + }, + "cl": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, + "co": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, + "cy": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "cz": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "de": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "dk": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "ee": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "es": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "fi": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "fr": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "gb": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" + }, + "gr": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "hr": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "hu": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "id": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, + "ie": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "is": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" + }, + "it": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "jp": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" + }, + "kr": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, + "lt": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "lu": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "lv": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "mt": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "mx": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, + "my": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, + "nl": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "no": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" + }, + "nz": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" + }, + "pl": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "pt": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "ro": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "sa": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, + "se": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "sg": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" + }, + "si": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "sk": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe" + }, + "th": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, + "tr": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, + "us": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_united_states" + }, + "vn": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified" + }, + "za": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default" + } + }, + "title": "TaxProductRegistrationsResourceCountryOptions", + "type": "object", + "x-expandableFields": [ + "ae", + "at", + "au", + "be", + "bg", + "ca", + "ch", + "cl", + "co", + "cy", + "cz", + "de", + "dk", + "ee", + "es", + "fi", + "fr", + "gb", + "gr", + "hr", + "hu", + "id", + "ie", + "is", + "it", + "jp", + "kr", + "lt", + "lu", + "lv", + "mt", + "mx", + "my", + "nl", + "no", + "nz", + "pl", + "pt", + "ro", + "sa", + "se", + "sg", + "si", + "sk", + "th", + "tr", + "us", + "vn", + "za" + ], + "x-stripeResource": { + "class_name": "CountryOptions", + "in_package": "" + } + }, + "tax_product_registrations_resource_country_options_ca_province_standard": { + "description": "", + "properties": { + "province": { + "description": "Two-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "province" + ], + "title": "TaxProductRegistrationsResourceCountryOptionsCaProvinceStandard", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "ProvinceStandard", + "in_package": "" + } + }, + "tax_product_registrations_resource_country_options_canada": { + "description": "", + "properties": { + "province_standard": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_ca_province_standard" + }, + "type": { + "description": "Type of registration in Canada.", + "enum": [ + "province_standard", + "simplified", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "TaxProductRegistrationsResourceCountryOptionsCanada", + "type": "object", + "x-expandableFields": [ + "province_standard" + ], + "x-stripeResource": { + "class_name": "Canada", + "in_package": "" + } + }, + "tax_product_registrations_resource_country_options_default": { + "description": "", + "properties": { + "type": { + "description": "Type of registration in `country`.", + "enum": [ + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "TaxProductRegistrationsResourceCountryOptionsDefault", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "Default", + "in_package": "" + } + }, + "tax_product_registrations_resource_country_options_eu_standard": { + "description": "", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "TaxProductRegistrationsResourceCountryOptionsEuStandard", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "Standard", + "in_package": "" + } + }, + "tax_product_registrations_resource_country_options_europe": { + "description": "", + "properties": { + "standard": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_eu_standard" + }, + "type": { + "description": "Type of registration in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "TaxProductRegistrationsResourceCountryOptionsEurope", + "type": "object", + "x-expandableFields": [ + "standard" + ], + "x-stripeResource": { + "class_name": "Europe", + "in_package": "" + } + }, + "tax_product_registrations_resource_country_options_simplified": { + "description": "", + "properties": { + "type": { + "description": "Type of registration in `country`.", + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "TaxProductRegistrationsResourceCountryOptionsSimplified", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "Simplified", + "in_package": "" + } + }, + "tax_product_registrations_resource_country_options_united_states": { + "description": "", + "properties": { + "local_amusement_tax": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_local_amusement_tax" + }, + "local_lease_tax": { + "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_local_lease_tax" + }, + "state": { + "description": "Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).", + "maxLength": 5000, + "type": "string" + }, + "type": { + "description": "Type of registration in the US.", + "enum": [ + "local_amusement_tax", + "local_lease_tax", + "state_communications_tax", + "state_sales_tax" + ], + "type": "string" + } + }, + "required": [ + "state", + "type" + ], + "title": "TaxProductRegistrationsResourceCountryOptionsUnitedStates", + "type": "object", + "x-expandableFields": [ + "local_amusement_tax", + "local_lease_tax" + ], + "x-stripeResource": { + "class_name": "UnitedStates", + "in_package": "" + } + }, + "tax_product_registrations_resource_country_options_us_local_amusement_tax": { + "description": "", + "properties": { + "jurisdiction": { + "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "jurisdiction" + ], + "title": "TaxProductRegistrationsResourceCountryOptionsUsLocalAmusementTax", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "LocalAmusementTax", + "in_package": "" + } + }, + "tax_product_registrations_resource_country_options_us_local_lease_tax": { + "description": "", + "properties": { + "jurisdiction": { + "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "jurisdiction" + ], + "title": "TaxProductRegistrationsResourceCountryOptionsUsLocalLeaseTax", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "LocalLeaseTax", + "in_package": "" + } + }, "tax_product_resource_customer_details": { "description": "", "properties": { @@ -129684,6 +130231,1816 @@ } } }, + "/v1/tax/registrations": { + "get": { + "description": "

Returns a list of Tax Registration objects.

", + "operationId": "GetTaxRegistrations", + "parameters": [ + { + "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", + "in": "query", + "name": "starting_after", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "The status of the Tax Registration.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "active", + "all", + "expired", + "scheduled" + ], + "type": "string" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/tax.registration" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "pattern": "^/v1/tax/registrations", + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "TaxProductRegistrationsResourceTaxRegistrationList", + "type": "object", + "x-expandableFields": [ + "data" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "

Creates a new Tax Registration object.

", + "operationId": "PostTaxRegistrations", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "active_from": { + "explode": true, + "style": "deepObject" + }, + "country_options": { + "explode": true, + "style": "deepObject" + }, + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "active_from": { + "anyOf": [ + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + }, + { + "format": "unix-time", + "type": "integer" + } + ], + "description": "Time at which the Tax Registration becomes active. It can be either `now` to indicate the current time, or a future timestamp measured in seconds since the Unix epoch." + }, + "country": { + "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", + "maxLength": 5000, + "type": "string" + }, + "country_options": { + "description": "Specific options for a registration in the specified `country`.", + "properties": { + "ae": { + "description": "Options for the registration in AE.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "default", + "type": "object" + }, + "at": { + "description": "Options for the registration in AT.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "au": { + "description": "Options for the registration in AU.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "default", + "type": "object" + }, + "be": { + "description": "Options for the registration in BE.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "bg": { + "description": "Options for the registration in BG.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "ca": { + "description": "Options for the registration in CA.", + "properties": { + "province_standard": { + "description": "Options for the provincial tax registration.", + "properties": { + "province": { + "description": "Two-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "province" + ], + "title": "province_standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in Canada.", + "enum": [ + "province_standard", + "simplified", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "canada", + "type": "object" + }, + "ch": { + "description": "Options for the registration in CH.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "default", + "type": "object" + }, + "cl": { + "description": "Options for the registration in CL.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, + "co": { + "description": "Options for the registration in CO.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, + "cy": { + "description": "Options for the registration in CY.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "cz": { + "description": "Options for the registration in CZ.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "de": { + "description": "Options for the registration in DE.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "dk": { + "description": "Options for the registration in DK.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "ee": { + "description": "Options for the registration in EE.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "es": { + "description": "Options for the registration in ES.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "fi": { + "description": "Options for the registration in FI.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "fr": { + "description": "Options for the registration in FR.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "gb": { + "description": "Options for the registration in GB.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "default", + "type": "object" + }, + "gr": { + "description": "Options for the registration in GR.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "hr": { + "description": "Options for the registration in HR.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "hu": { + "description": "Options for the registration in HU.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "id": { + "description": "Options for the registration in ID.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, + "ie": { + "description": "Options for the registration in IE.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "is": { + "description": "Options for the registration in IS.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "default", + "type": "object" + }, + "it": { + "description": "Options for the registration in IT.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "jp": { + "description": "Options for the registration in JP.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "default", + "type": "object" + }, + "kr": { + "description": "Options for the registration in KR.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, + "lt": { + "description": "Options for the registration in LT.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "lu": { + "description": "Options for the registration in LU.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "lv": { + "description": "Options for the registration in LV.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "mt": { + "description": "Options for the registration in MT.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "mx": { + "description": "Options for the registration in MX.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, + "my": { + "description": "Options for the registration in MY.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, + "nl": { + "description": "Options for the registration in NL.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "no": { + "description": "Options for the registration in NO.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "default", + "type": "object" + }, + "nz": { + "description": "Options for the registration in NZ.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "default", + "type": "object" + }, + "pl": { + "description": "Options for the registration in PL.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "pt": { + "description": "Options for the registration in PT.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "ro": { + "description": "Options for the registration in RO.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "sa": { + "description": "Options for the registration in SA.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, + "se": { + "description": "Options for the registration in SE.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "sg": { + "description": "Options for the registration in SG.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "default", + "type": "object" + }, + "si": { + "description": "Options for the registration in SI.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "sk": { + "description": "Options for the registration in SK.", + "properties": { + "standard": { + "description": "Options for the standard registration.", + "properties": { + "place_of_supply_scheme": { + "description": "Place of supply scheme used in an EU standard registration.", + "enum": [ + "small_seller", + "standard" + ], + "type": "string" + } + }, + "required": [ + "place_of_supply_scheme" + ], + "title": "standard", + "type": "object" + }, + "type": { + "description": "Type of registration to be created in an EU country.", + "enum": [ + "ioss", + "oss_non_union", + "oss_union", + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "europe", + "type": "object" + }, + "th": { + "description": "Options for the registration in TH.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, + "tr": { + "description": "Options for the registration in TR.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, + "us": { + "description": "Options for the registration in US.", + "properties": { + "local_amusement_tax": { + "description": "Options for the local amusement tax registration.", + "properties": { + "jurisdiction": { + "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `06613` (Bloomington), `21696` (East Dundee), `24582` (Evanston), and `68081` (Schiller Park).", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "jurisdiction" + ], + "title": "local_amusement_tax", + "type": "object" + }, + "local_lease_tax": { + "description": "Options for the local lease tax registration.", + "properties": { + "jurisdiction": { + "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago).", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "jurisdiction" + ], + "title": "local_lease_tax", + "type": "object" + }, + "state": { + "description": "Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).", + "maxLength": 5000, + "type": "string" + }, + "type": { + "description": "Type of registration to be created in the US.", + "enum": [ + "local_amusement_tax", + "local_lease_tax", + "state_communications_tax", + "state_sales_tax" + ], + "type": "string" + } + }, + "required": [ + "state", + "type" + ], + "title": "united_states", + "type": "object" + }, + "vn": { + "description": "Options for the registration in VN.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "simplified" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "simplified", + "type": "object" + }, + "za": { + "description": "Options for the registration in ZA.", + "properties": { + "type": { + "description": "Type of registration to be created in `country`.", + "enum": [ + "standard" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "default", + "type": "object" + } + }, + "title": "country_options", + "type": "object" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "expires_at": { + "description": "If set, the Tax Registration stops being active at this time. If not set, the Tax Registration will be active indefinitely. Timestamp measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "active_from", + "country", + "country_options" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax.registration" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/tax/registrations/{id}": { + "post": { + "description": "

Updates an existing Tax Registration object.

\n\n

A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.

", + "operationId": "PostTaxRegistrationsId", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "active_from": { + "explode": true, + "style": "deepObject" + }, + "expand": { + "explode": true, + "style": "deepObject" + }, + "expires_at": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "active_from": { + "anyOf": [ + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + }, + { + "format": "unix-time", + "type": "integer" + } + ], + "description": "Time at which the registration becomes active. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch." + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "expires_at": { + "anyOf": [ + { + "enum": [ + "now" + ], + "maxLength": 5000, + "type": "string" + }, + { + "format": "unix-time", + "type": "integer" + }, + { + "enum": [ + "" + ], + "type": "string" + } + ], + "description": "If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch." + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tax.registration" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/tax/settings": { "get": { "description": "

Retrieves Tax Settings for a merchant.

",