View Source Stripe.TaxId (stripity_stripe v3.2.0)

You can add one or multiple tax IDs to a customer or account. Customer and account tax IDs get displayed on related invoices and credit notes.

Summary

Types

t()

The tax_id type.

Functions

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

Creates a new tax_id object for a customer.

delete(customer, id, opts \\ [])

Deletes an existing tax_id object.

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

Returns a list of tax IDs for a customer.

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

Retrieves the tax_id object with the given identifier.

Types

t()

@type t() :: %Stripe.TaxId{
  country: binary() | nil,
  created: integer(),
  customer: (binary() | Stripe.Customer.t()) | nil,
  id: binary(),
  livemode: boolean(),
  object: binary(),
  type: binary(),
  value: binary(),
  verification: term() | nil
}

The tax_id type.

country Two-letter ISO code representing the country of the tax ID.
created Time at which the object was created. Measured in seconds since the Unix epoch.
customer ID of the customer.
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.
type Type of the tax ID, one of ad_nrt, ae_trn, ar_cuit, au_abn, au_arn, bg_uic, bo_tin, br_cnpj, br_cpf, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, ch_vat, cl_tin, cn_tin, co_nit, cr_tin, do_rcn, ec_ruc, eg_tin, es_cif, eu_oss_vat, eu_vat, gb_vat, ge_vat, hk_br, hu_tin, id_npwp, il_vat, in_gst, is_vat, jp_cn, jp_rn, jp_trn, ke_pin, kr_brn, li_uid, mx_rfc, my_frp, my_itn, my_sst, no_vat, nz_gst, pe_ruc, ph_tin, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sv_nit, th_vat, tr_tin, tw_vat, ua_vat, us_ein, uy_ruc, ve_rif, vn_tin, or za_vat. Note that some legacy tax IDs have type unknown
value Value of the tax ID.
verification Tax ID verification information.

Functions

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

@spec create(
  customer :: binary(),
  params :: %{
    optional(:expand) => [binary()],
    optional(:type) =>
      :ad_nrt
      | :ae_trn
      | :ar_cuit
      | :au_abn
      | :au_arn
      | :bg_uic
      | :bo_tin
      | :br_cnpj
      | :br_cpf
      | :ca_bn
      | :ca_gst_hst
      | :ca_pst_bc
      | :ca_pst_mb
      | :ca_pst_sk
      | :ca_qst
      | :ch_vat
      | :cl_tin
      | :cn_tin
      | :co_nit
      | :cr_tin
      | :do_rcn
      | :ec_ruc
      | :eg_tin
      | :es_cif
      | :eu_oss_vat
      | :eu_vat
      | :gb_vat
      | :ge_vat
      | :hk_br
      | :hu_tin
      | :id_npwp
      | :il_vat
      | :in_gst
      | :is_vat
      | :jp_cn
      | :jp_rn
      | :jp_trn
      | :ke_pin
      | :kr_brn
      | :li_uid
      | :mx_rfc
      | :my_frp
      | :my_itn
      | :my_sst
      | :no_vat
      | :nz_gst
      | :pe_ruc
      | :ph_tin
      | :ro_tin
      | :rs_pib
      | :ru_inn
      | :ru_kpp
      | :sa_vat
      | :sg_gst
      | :sg_uen
      | :si_tin
      | :sv_nit
      | :th_vat
      | :tr_tin
      | :tw_vat
      | :ua_vat
      | :us_ein
      | :uy_ruc
      | :ve_rif
      | :vn_tin
      | :za_vat,
    optional(:value) => binary()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Creates a new tax_id object for a customer.

Details

Method: post
Path: /v1/customers/{customer}/tax_ids

delete(customer, id, opts \\ [])

@spec delete(customer :: binary(), id :: binary(), opts :: Keyword.t()) ::
  {:ok, Stripe.DeletedTaxId.t()}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

Deletes an existing tax_id object.

Details

Method: delete
Path: /v1/customers/{customer}/tax_ids/{id}

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

@spec list(
  customer :: binary(),
  params :: %{
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:starting_after) => binary()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Returns a list of tax IDs for a customer.

Details

Method: get
Path: /v1/customers/{customer}/tax_ids

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

@spec retrieve(
  customer :: binary(),
  id :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves the tax_id object with the given identifier.

Details

Method: get
Path: /v1/customers/{customer}/tax_ids/{id}