Stripe.Params.Tax.SettingsUpdateParams (tiger_stripe v0.3.0)

Copy Markdown View Source

Parameters for settings update.

Summary

Types

defaults()

@type defaults() :: %{
  optional(:tax_behavior) => String.t() | nil,
  optional(:tax_code) => String.t() | nil,
  optional(String.t()) => term()
}
  • tax_behavior - Specifies the default tax behavior to be used when the item's price has unspecified tax behavior. One of inclusive, exclusive, or inferred_by_currency. Once specified, it cannot be changed back to null. Possible values: exclusive, inclusive, inferred_by_currency.
  • tax_code - A tax code ID.

head_office()

@type head_office() :: %{
  optional(:address) => head_office_address() | nil,
  optional(String.t()) => term()
}
  • address - The location of the business for tax purposes.

head_office_address()

@type head_office_address() :: %{
  optional(:city) => String.t() | nil,
  optional(:country) => String.t() | nil,
  optional(:line1) => String.t() | nil,
  optional(:line2) => String.t() | nil,
  optional(:postal_code) => String.t() | nil,
  optional(:state) => String.t() | nil,
  optional(String.t()) => term()
}
  • city - City, district, suburb, town, or village. Max length: 5000.
  • country - Two-letter country code (ISO 3166-1 alpha-2). Max length: 5000.
  • line1 - Address line 1, such as the street, PO Box, or company name. Max length: 5000.
  • line2 - Address line 2, such as the apartment, suite, unit, or building. Max length: 5000.
  • postal_code - ZIP or postal code. Max length: 5000.
  • state - State/province as an ISO 3166-2 subdivision code, without country prefix, such as "NY" or "TX". Max length: 5000.

t()

@type t() :: %Stripe.Params.Tax.SettingsUpdateParams{
  defaults: defaults() | nil,
  expand: [String.t()] | nil,
  head_office: head_office() | nil
}
  • defaults - Default configuration to be used on Stripe Tax calculations.
  • expand - Specifies which fields in the response should be expanded.
  • head_office - The place where your business is located.