Striped v0.5.0

View Source Stripe.TaxId (Striped v0.5.0) (generated)

You can add one or multiple tax IDs to a customer. A customer's tax IDs are displayed on invoices and credit notes issued for the customer.

Related guide: Customer Tax Identification Numbers.

Link to this section Summary

Types

t()

The tax_id type.

Functions

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

Creates a new TaxID object for a customer.

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

Deletes an existing TaxID object.

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

Returns a list of tax IDs for a customer.

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

Retrieves the TaxID object with the given identifier.

Link to this section Types

Link to this type

t()

View Source 
@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 ae_trn, au_abn, au_arn, bg_uic, br_cnpj, br_cpf, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, ch_vat, cl_tin, 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, ph_tin, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, th_vat, tr_tin, tw_vat, ua_vat, us_ein, or za_vat. Note that some legacy tax IDs have type unknown
  • value Value of the tax ID.
  • verification Tax ID verification information.

Link to this section Functions

Link to this function

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

View Source 
@spec create(
  client :: Stripe.t(),
  customer :: binary(),
  params :: %{
    optional(:expand) => [binary()],
    optional(:type) =>
      :ae_trn
      | :au_abn
      | :au_arn
      | :bg_uic
      | :br_cnpj
      | :br_cpf
      | :ca_bn
      | :ca_gst_hst
      | :ca_pst_bc
      | :ca_pst_mb
      | :ca_pst_sk
      | :ca_qst
      | :ch_vat
      | :cl_tin
      | :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
      | :ph_tin
      | :ru_inn
      | :ru_kpp
      | :sa_vat
      | :sg_gst
      | :sg_uen
      | :si_tin
      | :th_vat
      | :tr_tin
      | :tw_vat
      | :ua_vat
      | :us_ein
      | :za_vat,
    optional(:value) => binary()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Creates a new TaxID object for a customer.

Details

  • Method: post
  • Path: /v1/customers/{customer}/tax_ids
Link to this function

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

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

Deletes an existing TaxID object.

Details

  • Method: delete
  • Path: /v1/customers/{customer}/tax_ids/{id}
Link to this function

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

View Source 
@spec list(
  client :: Stripe.t(),
  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
Link to this function

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

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

Retrieves the TaxID object with the given identifier.

Details

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