View Source Stripe.Tax.Registration (stripity_stripe v3.3.1)
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.
Stripe 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.
Related guide: Using the Registrations API
Summary
Types
Options for the registration in AE.
Options for the registration in AL.
Options for the registration in AM.
Options for the registration in AO.
Options for the registration in AT.
Options for the registration in AU.
Options for the registration in AW.
Options for the registration in AZ.
Options for the registration in BA.
Options for the registration in BB.
Options for the registration in BD.
Options for the registration in BE.
Options for the registration in BF.
Options for the registration in BG.
Options for the registration in BH.
Options for the registration in BJ.
Options for the registration in BS.
Options for the registration in BY.
Options for the registration in CA.
Options for the registration in CD.
Options for the registration in CH.
Options for the registration in CL.
Options for the registration in CM.
Options for the registration in CO.
Specific options for a registration in the specified country.
Options for the registration in CR.
Options for the registration in CV.
Options for the registration in CY.
Options for the registration in CZ.
Options for the registration in DE.
Options for the registration in DK.
Options for the registration in EC.
Options for the registration in EE.
Options for the registration in EG.
Options for the registration in ES.
Options for the registration in ET.
Options for the registration in FI.
Options for the registration in FR.
Options for the registration in GB.
Options for the registration in GE.
Options for the registration in GN.
Options for the registration in GR.
Options for the registration in HR.
Options for the registration in HU.
Options for the registration in ID.
Options for the registration in IE.
Options for the registration in IN.
Options for the registration in IS.
Options for the registration in IT.
Options for the registration in JP.
Options for the registration in KE.
Options for the registration in KG.
Options for the registration in KH.
Options for the registration in KR.
Options for the registration in KZ.
Options for the registration in LA.
Options for the local amusement tax registration.
Options for the local lease tax registration.
Options for the registration in LT.
Options for the registration in LU.
Options for the registration in LV.
Options for the registration in MA.
Options for the registration in MD.
Options for the registration in ME.
Options for the registration in MK.
Options for the registration in MR.
Options for the registration in MT.
Options for the registration in MX.
Options for the registration in MY.
Options for the registration in NG.
Options for the registration in NL.
Options for the registration in NO.
Options for the registration in NP.
Options for the registration in NZ.
Options for the registration in OM.
Options for the registration in PE.
Options for the registration in PH.
Options for the registration in PL.
Options for the provincial tax registration.
Options for the registration in PT.
Options for the registration in RO.
Options for the registration in RS.
Options for the registration in RU.
Options for the registration in SA.
Options for the registration in SE.
Options for the registration in SG.
Options for the registration in SI.
Options for the registration in SK.
Options for the registration in SN.
Options for the registration in SR.
Options for the standard registration.
Options for the state sales tax registration.
The tax.registration type.
Options for the registration in TH.
Options for the registration in TJ.
Options for the registration in TR.
Options for the registration in TW.
Options for the registration in TZ.
Options for the registration in UA.
Options for the registration in UG.
Options for the registration in US.
Options for the registration in UY.
Options for the registration in UZ.
Options for the registration in VN.
Options for the registration in ZA.
Options for the registration in ZM.
Options for the registration in ZW.
Functions
Creates a new Tax Registration object.
Returns a list of Tax Registration objects.
Returns a Tax Registration object.
Updates an existing Tax Registration object.
Types
@type ae() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in AE.
@type al() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in AL.
@type am() :: %{optional(:type) => :simplified}
Options for the registration in AM.
@type ao() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in AO.
@type at() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in AT.
@type au() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in AU.
@type aw() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in AW.
@type az() :: %{optional(:type) => :simplified}
Options for the registration in AZ.
@type ba() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in BA.
@type bb() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in BB.
@type bd() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in BD.
@type be() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in BE.
@type bf() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in BF.
@type bg() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in BG.
@type bh() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in BH.
@type bj() :: %{optional(:type) => :simplified}
Options for the registration in BJ.
@type bs() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in BS.
@type by() :: %{optional(:type) => :simplified}
Options for the registration in BY.
@type ca() :: %{ optional(:province_standard) => province_standard(), optional(:type) => :province_standard | :simplified | :standard }
Options for the registration in CA.
@type cd() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in CD.
@type ch() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in CH.
@type cl() :: %{optional(:type) => :simplified}
Options for the registration in CL.
@type cm() :: %{optional(:type) => :simplified}
Options for the registration in CM.
@type co() :: %{optional(:type) => :simplified}
Options for the registration in CO.
@type country_options() :: %{ optional(:is) => is(), optional(:ec) => ec(), optional(:th) => th(), optional(:bd) => bd(), optional(:bf) => bf(), optional(:fi) => fi(), optional(:om) => om(), optional(:ee) => ee(), optional(:me) => me(), optional(:am) => am(), optional(:gr) => gr(), optional(:cv) => cv(), optional(:ug) => ug(), optional(:zw) => zw(), optional(:cd) => cd(), optional(:sa) => sa(), optional(:sn) => sn(), optional(:tz) => tz(), optional(:bh) => bh(), optional(:be) => be(), optional(:kh) => kh(), optional(:mt) => mt(), optional(:fr) => fr(), optional(:eg) => eg(), optional(:pl) => pl(), optional(:de) => de(), optional(:ge) => ge(), optional(:co) => co(), optional(:np) => np(), optional(:kz) => kz(), optional(:ch) => ch(), optional(:se) => se(), optional(:sk) => sk(), optional(:us) => us(), optional(:cy) => cy(), optional(:au) => au(), optional(:md) => md(), optional(:si) => si(), optional(:kg) => kg(), optional(:it) => it(), optional(:vn) => vn(), optional(:mr) => mr(), optional(:hr) => hr(), optional(:zm) => zm(), optional(:by) => by(), optional(:bb) => bb(), optional(:ro) => ro(), optional(:bs) => bs(), optional(:mx) => mx(), optional(:ie) => ie(), optional(:id) => id(), optional(:es) => es(), optional(:sg) => sg(), optional(:gn) => gn(), optional(:ru) => ru(), optional(:cl) => cl(), optional(:hu) => hu(), optional(:kr) => kr(), optional(:az) => az(), optional(:ae) => ae(), optional(:ke) => ke(), optional(:jp) => jp(), optional(:lv) => lv(), optional(:no) => no(), optional(:cz) => cz(), optional(:ca) => ca(), optional(:tj) => tj(), optional(:al) => al(), optional(:ph) => ph(), optional(:in) => in_field(), optional(:tw) => tw(), optional(:cr) => cr(), optional(:nz) => nz(), optional(:dk) => dk(), optional(:my) => my(), optional(:la) => la(), optional(:sr) => sr(), optional(:mk) => mk(), optional(:nl) => nl(), optional(:lu) => lu(), optional(:ao) => ao(), optional(:uz) => uz(), optional(:ba) => ba(), optional(:za) => za(), optional(:cm) => cm(), optional(:lt) => lt(), optional(:pe) => pe(), optional(:bg) => bg(), optional(:rs) => rs(), optional(:ua) => ua(), optional(:tr) => tr(), optional(:uy) => uy(), optional(:aw) => aw(), optional(:ma) => ma(), optional(:at) => at(), optional(:ng) => ng(), optional(:gb) => gb(), optional(:et) => et(), optional(:pt) => pt(), optional(:bj) => bj() }
Specific options for a registration in the specified country.
@type cr() :: %{optional(:type) => :simplified}
Options for the registration in CR.
@type cv() :: %{optional(:type) => :simplified}
Options for the registration in CV.
@type cy() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in CY.
@type cz() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in CZ.
@type de() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in DE.
@type dk() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in DK.
@type ec() :: %{optional(:type) => :simplified}
Options for the registration in EC.
@type ee() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in EE.
@type eg() :: %{optional(:type) => :simplified}
Options for the registration in EG.
@type elections() :: %{ optional(:jurisdiction) => binary(), optional(:type) => :local_use_tax | :simplified_sellers_use_tax | :single_local_use_tax }
@type es() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in ES.
@type et() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in ET.
@type fi() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in FI.
@type fr() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in FR.
@type gb() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in GB.
@type ge() :: %{optional(:type) => :simplified}
Options for the registration in GE.
@type gn() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in GN.
@type gr() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in GR.
@type hr() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in HR.
@type hu() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in HU.
@type id() :: %{optional(:type) => :simplified}
Options for the registration in ID.
@type ie() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in IE.
@type in_field() :: %{optional(:type) => :simplified}
Options for the registration in IN.
@type is() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in IS.
@type it() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in IT.
@type jp() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in JP.
@type ke() :: %{optional(:type) => :simplified}
Options for the registration in KE.
@type kg() :: %{optional(:type) => :simplified}
Options for the registration in KG.
@type kh() :: %{optional(:type) => :simplified}
Options for the registration in KH.
@type kr() :: %{optional(:type) => :simplified}
Options for the registration in KR.
@type kz() :: %{optional(:type) => :simplified}
Options for the registration in KZ.
@type la() :: %{optional(:type) => :simplified}
Options for the registration in LA.
@type local_amusement_tax() :: %{optional(:jurisdiction) => binary()}
Options for the local amusement tax registration.
@type local_lease_tax() :: %{optional(:jurisdiction) => binary()}
Options for the local lease tax registration.
@type lt() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in LT.
@type lu() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in LU.
@type lv() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in LV.
@type ma() :: %{optional(:type) => :simplified}
Options for the registration in MA.
@type md() :: %{optional(:type) => :simplified}
Options for the registration in MD.
@type me() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in ME.
@type mk() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in MK.
@type mr() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in MR.
@type mt() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in MT.
@type mx() :: %{optional(:type) => :simplified}
Options for the registration in MX.
@type my() :: %{optional(:type) => :simplified}
Options for the registration in MY.
@type ng() :: %{optional(:type) => :simplified}
Options for the registration in NG.
@type nl() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in NL.
@type no() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in NO.
@type np() :: %{optional(:type) => :simplified}
Options for the registration in NP.
@type nz() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in NZ.
@type om() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in OM.
@type pe() :: %{optional(:type) => :simplified}
Options for the registration in PE.
@type ph() :: %{optional(:type) => :simplified}
Options for the registration in PH.
@type pl() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in PL.
@type province_standard() :: %{optional(:province) => binary()}
Options for the provincial tax registration.
@type pt() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in PT.
@type ro() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in RO.
@type rs() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in RS.
@type ru() :: %{optional(:type) => :simplified}
Options for the registration in RU.
@type sa() :: %{optional(:type) => :simplified}
Options for the registration in SA.
@type se() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in SE.
@type sg() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in SG.
@type si() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in SI.
@type sk() :: %{ optional(:standard) => standard(), optional(:type) => :ioss | :oss_non_union | :oss_union | :standard }
Options for the registration in SK.
@type sn() :: %{optional(:type) => :simplified}
Options for the registration in SN.
@type sr() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in SR.
@type standard() :: %{optional(:place_of_supply_scheme) => :inbound_goods | :standard}
Options for the standard registration.
@type state_sales_tax() :: %{optional(:elections) => [elections()]}
Options for the state sales tax registration.
@type t() :: %Stripe.Tax.Registration{ active_from: integer(), country: binary(), country_options: term(), created: integer(), expires_at: integer() | nil, id: binary(), livemode: boolean(), object: binary(), status: binary() }
The tax.registration type.
active_fromTime at which the registration becomes active. Measured in seconds since the Unix epoch.countryTwo-letter country code (ISO 3166-1 alpha-2).country_optionscreatedTime at which the object was created. Measured in seconds since the Unix epoch.expires_atIf 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.idUnique identifier for the object.livemodeHas the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.objectString representing the object's type. Objects of the same type share the same value.statusThe status of the registration. This field is present for convenience and can be deduced fromactive_fromandexpires_at.
@type th() :: %{optional(:type) => :simplified}
Options for the registration in TH.
@type tj() :: %{optional(:type) => :simplified}
Options for the registration in TJ.
@type tr() :: %{optional(:type) => :simplified}
Options for the registration in TR.
@type tw() :: %{optional(:type) => :simplified}
Options for the registration in TW.
@type tz() :: %{optional(:type) => :simplified}
Options for the registration in TZ.
@type ua() :: %{optional(:type) => :simplified}
Options for the registration in UA.
@type ug() :: %{optional(:type) => :simplified}
Options for the registration in UG.
@type us() :: %{ optional(:local_amusement_tax) => local_amusement_tax(), optional(:local_lease_tax) => local_lease_tax(), optional(:state) => binary(), optional(:state_sales_tax) => state_sales_tax(), optional(:type) => :local_amusement_tax | :local_lease_tax | :state_communications_tax | :state_retail_delivery_fee | :state_sales_tax }
Options for the registration in US.
@type uy() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in UY.
@type uz() :: %{optional(:type) => :simplified}
Options for the registration in UZ.
@type vn() :: %{optional(:type) => :simplified}
Options for the registration in VN.
@type za() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in ZA.
@type zm() :: %{optional(:type) => :simplified}
Options for the registration in ZM.
@type zw() :: %{optional(:standard) => standard(), optional(:type) => :standard}
Options for the registration in ZW.
Functions
@spec create( params :: %{ optional(:active_from) => :now | integer(), optional(:country) => binary(), optional(:country_options) => country_options(), optional(:expand) => [binary()], optional(:expires_at) => integer() }, opts :: Keyword.t() ) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Creates a new Tax Registration object.
Details
- Method:
post - Path:
/v1/tax/registrations
@spec list( params :: %{ optional(:ending_before) => binary(), optional(:expand) => [binary()], optional(:limit) => integer(), optional(:starting_after) => binary(), optional(:status) => :active | :all | :expired | :scheduled }, opts :: Keyword.t() ) :: {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Returns a list of Tax Registration objects.
Details
- Method:
get - Path:
/v1/tax/registrations
@spec retrieve( id :: binary(), params :: %{optional(:expand) => [binary()]}, opts :: Keyword.t() ) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Returns a Tax Registration object.
Details
- Method:
get - Path:
/v1/tax/registrations/{id}
@spec update( id :: binary(), params :: %{ optional(:active_from) => :now | integer(), optional(:expand) => [binary()], optional(:expires_at) => :now | integer() | binary() }, opts :: Keyword.t() ) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Updates an existing Tax Registration object.
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.
Details
- Method:
post - Path:
/v1/tax/registrations/{id}