exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.SDK.TaxCodes (exoapi_stripe v0.1.4)

Link to this section Summary

Types

get_tax_codes_id_opts()
get_tax_codes_opts()

Functions

get_tax_codes(client, opts \\ [])

description: <p>A list of <a href="https://stripe.com/docs/tax/tax-codes">all tax codes available</a> to add to Products in order to allow specific tax calculations.</p>

get_tax_codes_id(client, id, opts \\ [])

description: <p>Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.</p>

Link to this section Types

Link to this type

get_tax_codes_id_opts()

View Source 
@type get_tax_codes_id_opts() :: {:expand, String.t()}
Link to this type

get_tax_codes_opts()

View Source 
@type get_tax_codes_opts() ::
  {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}

Link to this section Functions

Link to this function

get_tax_codes(client, opts \\ [])

View Source 
@spec get_tax_codes(client :: ExOAPI.Client.t(), [get_tax_codes_opts()]) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.TaxCode.t()]
     }
   | map()}
  | {:error, any()}

description: <p>A list of <a href="https://stripe.com/docs/tax/tax-codes">all tax codes available</a> to add to Products in order to allow specific tax calculations.</p>

Link to this function

get_tax_codes_id(client, id, opts \\ [])

View Source 
@spec get_tax_codes_id(
  client :: ExOAPI.Client.t(),
  id :: String.t(),
  [get_tax_codes_id_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.TaxCode.t() | map()}
  | {:error, any()}

description: <p>Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.</p>