Striped v0.5.0

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

Tax codes classify goods and services for tax purposes.

Link to this section Summary

Types

t()

The tax_code type.

Functions

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

A list of all tax codes available to add to Products in order to allow specific tax calculations.

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

Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Stripe.TaxCode{
  description: binary(),
  id: binary(),
  name: binary(),
  object: binary()
}

The tax_code type.

  • description A detailed description of which types of products the tax code represents.
  • id Unique identifier for the object.
  • name A short name for the tax code.
  • object String representing the object's type. Objects of the same type share the same value.

Link to this section Functions

Link to this function

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

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

A list of all tax codes available to add to Products in order to allow specific tax calculations.

Details

  • Method: get
  • Path: /v1/tax_codes
Link to this function

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

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

Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

Details

  • Method: get
  • Path: /v1/tax_codes/{id}