Stripe.Resources.Tax.Settings (tiger_stripe v0.3.0)

Copy Markdown View Source

TaxProductResourceTaxSettings

You can use Tax Settings to manage configurations used by Stripe Tax calculations.

Related guide: Using the Settings API

Summary

Types

defaults()
head_office()
status_details()
status_details_pending()
t()

Functions

expandable_fields()
object_name()

Types

defaults()

@type defaults() :: %{
  optional(:provider) => String.t() | nil,
  optional(:tax_behavior) => String.t() | nil,
  optional(:tax_code) => String.t() | nil,
  optional(String.t()) => term()
}
  • provider - The tax calculation provider this account uses. Defaults to stripe when not using a third-party provider. Possible values: anrok, avalara, sphere, stripe.
  • tax_behavior - Default tax behavior used to specify whether the price is considered inclusive of taxes or exclusive of taxes. If the item's price has a tax behavior set, it will take precedence over the default tax behavior. Possible values: exclusive, inclusive, inferred_by_currency. Nullable.
  • tax_code - Default tax code used to classify your products and prices. Max length: 5000. Nullable.

head_office()

@type head_office() :: %{
  optional(:address) => Stripe.Resources.Address.t() | nil,
  optional(String.t()) => term()
}
  • address

status_details()

@type status_details() :: %{
  optional(:active) => map() | nil,
  optional(:pending) => status_details_pending() | nil,
  optional(String.t()) => term()
}
  • active
  • pending

status_details_pending()

@type status_details_pending() :: %{
  optional(:missing_fields) => [String.t()] | nil,
  optional(String.t()) => term()
}
  • missing_fields - The list of missing fields that are required to perform calculations. It includes the entry head_office when the status is pending. It is recommended to set the optional values even if they aren't listed as required for calculating taxes. Calculations can fail if missing fields aren't explicitly provided on every call. Nullable.

t()

@type t() :: %Stripe.Resources.Tax.Settings{
  defaults: defaults(),
  head_office: head_office(),
  livemode: boolean(),
  object: String.t(),
  status: String.t(),
  status_details: status_details()
}
  • defaults - Expandable.
  • head_office - The place where your business is located. Nullable. Expandable.
  • 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. Possible values: tax.settings.
  • status - The status of the Tax Settings. Possible values: active, pending.
  • status_details - Expandable.

Functions

expandable_fields()

object_name()