View Source Stripe.Tax.Registration (stripity_stripe v3.2.0)

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

ae()

Options for the registration in AE.

at()

Options for the registration in AT.

au()

Options for the registration in AU.

be()

Options for the registration in BE.

bg()

Options for the registration in BG.

ca()

Options for the registration in CA.

ch()

Options for the registration in CH.

cl()

Options for the registration in CL.

co()

Options for the registration in CO.

country_options()

Specific options for a registration in the specified country.

cy()

Options for the registration in CY.

cz()

Options for the registration in CZ.

de()

Options for the registration in DE.

dk()

Options for the registration in DK.

ee()

Options for the registration in EE.

es()

Options for the registration in ES.

fi()

Options for the registration in FI.

fr()

Options for the registration in FR.

gb()

Options for the registration in GB.

gr()

Options for the registration in GR.

hr()

Options for the registration in HR.

hu()

Options for the registration in HU.

id()

Options for the registration in ID.

ie()

Options for the registration in IE.

is()

Options for the registration in IS.

it()

Options for the registration in IT.

jp()

Options for the registration in JP.

kr()

Options for the registration in KR.

local_amusement_tax()

Options for the local amusement tax registration.

local_lease_tax()

Options for the local lease tax registration.

lt()

Options for the registration in LT.

lu()

Options for the registration in LU.

lv()

Options for the registration in LV.

mt()

Options for the registration in MT.

mx()

Options for the registration in MX.

my()

Options for the registration in MY.

nl()

Options for the registration in NL.

no()

Options for the registration in NO.

nz()

Options for the registration in NZ.

pl()

Options for the registration in PL.

province_standard()

Options for the provincial tax registration.

pt()

Options for the registration in PT.

ro()

Options for the registration in RO.

sa()

Options for the registration in SA.

se()

Options for the registration in SE.

sg()

Options for the registration in SG.

si()

Options for the registration in SI.

sk()

Options for the registration in SK.

standard()

Options for the standard registration.

t()

The tax.registration type.

th()

Options for the registration in TH.

tr()

Options for the registration in TR.

us()

Options for the registration in US.

vn()

Options for the registration in VN.

za()

Options for the registration in ZA.

Functions

create(params \\ %{}, opts \\ [])

Creates a new Tax Registration object.

list(params \\ %{}, opts \\ [])

Returns a list of Tax Registration objects.

retrieve(id, params \\ %{}, opts \\ [])

Returns a Tax Registration object.

update(id, params \\ %{}, opts \\ [])

Updates an existing Tax Registration object.

Types

ae()

@type ae() :: %{optional(:type) => :standard}

Options for the registration in AE.

at()

@type at() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in AT.

au()

@type au() :: %{optional(:type) => :standard}

Options for the registration in AU.

be()

@type be() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in BE.

bg()

@type bg() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in BG.

ca()

@type ca() :: %{
  optional(:province_standard) => province_standard(),
  optional(:type) => :province_standard | :simplified | :standard
}

Options for the registration in CA.

ch()

@type ch() :: %{optional(:type) => :standard}

Options for the registration in CH.

cl()

@type cl() :: %{optional(:type) => :simplified}

Options for the registration in CL.

co()

@type co() :: %{optional(:type) => :simplified}

Options for the registration in CO.

country_options()

@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()
}

Specific options for a registration in the specified country.

cy()

@type cy() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in CY.

cz()

@type cz() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in CZ.

de()

@type de() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in DE.

dk()

@type dk() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in DK.

ee()

@type ee() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in EE.

es()

@type es() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in ES.

fi()

@type fi() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in FI.

fr()

@type fr() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in FR.

gb()

@type gb() :: %{optional(:type) => :standard}

Options for the registration in GB.

gr()

@type gr() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in GR.

hr()

@type hr() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in HR.

hu()

@type hu() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in HU.

id()

@type id() :: %{optional(:type) => :simplified}

Options for the registration in ID.

ie()

@type ie() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in IE.

is()

@type is() :: %{optional(:type) => :standard}

Options for the registration in IS.

it()

@type it() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in IT.

jp()

@type jp() :: %{optional(:type) => :standard}

Options for the registration in JP.

kr()

@type kr() :: %{optional(:type) => :simplified}

Options for the registration in KR.

local_amusement_tax()

@type local_amusement_tax() :: %{optional(:jurisdiction) => binary()}

Options for the local amusement tax registration.

local_lease_tax()

@type local_lease_tax() :: %{optional(:jurisdiction) => binary()}

Options for the local lease tax registration.

lt()

@type lt() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in LT.

lu()

@type lu() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in LU.

lv()

@type lv() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in LV.

mt()

@type mt() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in MT.

mx()

@type mx() :: %{optional(:type) => :simplified}

Options for the registration in MX.

my()

@type my() :: %{optional(:type) => :simplified}

Options for the registration in MY.

nl()

@type nl() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in NL.

no()

@type no() :: %{optional(:type) => :standard}

Options for the registration in NO.

nz()

@type nz() :: %{optional(:type) => :standard}

Options for the registration in NZ.

pl()

@type pl() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in PL.

province_standard()

@type province_standard() :: %{optional(:province) => binary()}

Options for the provincial tax registration.

pt()

@type pt() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in PT.

ro()

@type ro() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in RO.

sa()

@type sa() :: %{optional(:type) => :simplified}

Options for the registration in SA.

se()

@type se() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in SE.

sg()

@type sg() :: %{optional(:type) => :standard}

Options for the registration in SG.

si()

@type si() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in SI.

sk()

@type sk() :: %{
  optional(:standard) => standard(),
  optional(:type) => :ioss | :oss_non_union | :oss_union | :standard
}

Options for the registration in SK.

standard()

@type standard() :: %{optional(:place_of_supply_scheme) => :small_seller | :standard}

Options for the standard registration.

t()

@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_from Time at which the registration becomes active. Measured in seconds since the Unix epoch.
country Two-letter country code (ISO 3166-1 alpha-2).
country_options
created Time at which the object was created. Measured in seconds since the Unix epoch.
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.
id Unique identifier for the object.
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
object String representing the object's type. Objects of the same type share the same value.
status The status of the registration. This field is present for convenience and can be deduced from active_from and expires_at.

th()

@type th() :: %{optional(:type) => :simplified}

Options for the registration in TH.

tr()

@type tr() :: %{optional(:type) => :simplified}

Options for the registration in TR.

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
}

Options for the registration in US.

vn()

@type vn() :: %{optional(:type) => :simplified}

Options for the registration in VN.

za()

@type za() :: %{optional(:type) => :standard}

Options for the registration in ZA.

Functions

create(params \\ %{}, opts \\ [])

@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

list(params \\ %{}, opts \\ [])

@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

retrieve(id, params \\ %{}, opts \\ [])

@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}

update(id, params \\ %{}, opts \\ [])

@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}