Stripe.TaxRate (stripity_stripe v2.17.3) View Source

Work with Stripe TaxRate objects.

Link to this section Summary

Types

t()

Functions

create(params, opts \\ [])

Create a tax rate.

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

List all tax rates.

retrieve(id, opts \\ [])

Retrieve a tax rate.

update(id, params, opts \\ [])

Update a tax rate.

Link to this section Types

t()

Specs

t() :: %Stripe.TaxRate{
  active: boolean(),
  country: String.t() | nil,
  created: Stripe.timestamp(),
  description: String.t() | nil,
  display_name: String.t(),
  id: Stripe.id(),
  inclusive: boolean(),
  jurisdiction: String.t() | nil,
  livemode: boolean(),
  metadata: Stripe.Types.metadata(),
  object: String.t(),
  percentage: integer(),
  state: String.t() | nil
}

Link to this section Functions

create(params, opts \\ [])

Specs

create(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
when params:
       %{
         :percentage => number(),
         :display_name => String.t(),
         :inclusive => boolean(),
         optional(:active) => boolean(),
         optional(:country) => String.t(),
         optional(:description) => String.t(),
         optional(:metadata) => Stripe.Types.metadata(),
         optional(:jurisdiction) => String.t(),
         optional(:state) => String.t()
       }
       | %{}

Create a tax rate.

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

Specs

list(params, Stripe.options()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params:
       %{
         optional(:active) => boolean(),
         optional(:created) => Stripe.date_query(),
         optional(:ending_before) => t() | Stripe.id(),
         optional(:limit) => 1..100,
         optional(:inclusive) => boolean(),
         optional(:percentage) => number(),
         optional(:starting_after) => t() | Stripe.id()
       }
       | %{}

List all tax rates.

retrieve(id, opts \\ [])

Specs

retrieve(Stripe.id() | t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Retrieve a tax rate.

update(id, params, opts \\ [])

Specs

update(Stripe.id() | t(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params:
       %{
         optional(:percentage) => number(),
         optional(:country) => String.t(),
         optional(:display_name) => String.t(),
         optional(:inclusive) => boolean(),
         optional(:active) => boolean(),
         optional(:description) => String.t(),
         optional(:metadata) => Stripe.Types.metadata(),
         optional(:jurisdiction) => String.t(),
         optional(:state) => String.t()
       }
       | %{}

Update a tax rate.

Takes the id and a map of changes.