Stripe.Resources.Tax.Calculation (tiger_stripe v0.4.0)

Copy Markdown View Source

TaxProductResourceTaxCalculation

A Tax Calculation allows you to calculate the tax to collect from your customer.

Related guide: Calculate tax in your custom payment flow

Summary

Types

t()

Functions

expandable_fields()
object_name()

Types

t()

@type t() :: %Stripe.Resources.Tax.Calculation{
  amount_total: term(),
  currency: term(),
  customer: term(),
  customer_details: term(),
  expires_at: term(),
  id: term(),
  line_items: term(),
  livemode: term(),
  object: term(),
  ship_from_details: term(),
  shipping_cost: term(),
  tax_amount_exclusive: term(),
  tax_amount_inclusive: term(),
  tax_breakdown: term(),
  tax_date: term()
}
  • amount_total - Total amount after taxes in the smallest currency unit.
  • currency - Three-letter ISO currency code, in lowercase. Must be a supported currency. Max length: 5000.
  • customer - The ID of an existing Customer used for the resource. Max length: 5000. Nullable.
  • customer_details - Expandable.
  • expires_at - Timestamp of date at which the tax calculation will expire. Format: Unix timestamp. Nullable.
  • id - Unique identifier for the calculation. Max length: 5000. Nullable.
  • line_items - The list of items the customer is purchasing. Nullable. Expandable.
  • livemode - If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
  • object - String representing the object's type. Objects of the same type share the same value. Possible values: tax.calculation.
  • ship_from_details - The details of the ship from location, such as the address. Nullable. Expandable.
  • shipping_cost - The shipping cost details for the calculation. Nullable. Expandable.
  • tax_amount_exclusive - The amount of tax to be collected on top of the line item prices.
  • tax_amount_inclusive - The amount of tax already included in the line item prices.
  • tax_breakdown - Breakdown of individual tax amounts that add up to the total. Expandable.
  • tax_date - The calculation uses the tax rules and rates that are in effect at this timestamp. You can use a date up to 31 days in the past or up to 31 days in the future. If you use a future date, Stripe doesn't guarantee that the expected tax rules and rate being used match the actual rules and rate that will be in effect on that date. We deploy tax changes before their effective date, but not within a fixed window. Format: Unix timestamp.

Functions

expandable_fields()

object_name()