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

Copy Markdown View Source

TaxProductResourceTaxTransaction

A Tax Transaction records the tax collected from or refunded to 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.Transaction{
  created: term(),
  currency: term(),
  customer: term(),
  customer_details: term(),
  id: term(),
  line_items: term(),
  livemode: term(),
  metadata: term(),
  object: term(),
  posted_at: term(),
  reference: term(),
  reversal: term(),
  ship_from_details: term(),
  shipping_cost: term(),
  tax_date: term(),
  type: term()
}
  • created - Time at which the object was created. Measured in seconds since the Unix epoch. Format: Unix timestamp.
  • 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.
  • id - Unique identifier for the transaction. Max length: 5000.
  • line_items - The tax collected or refunded, by line item. 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.
  • metadata - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Nullable.
  • object - String representing the object's type. Objects of the same type share the same value. Possible values: tax.transaction.
  • posted_at - The Unix timestamp representing when the tax liability is assumed or reduced. Format: Unix timestamp.
  • reference - A custom unique identifier, such as 'myOrder_123'. Max length: 5000.
  • reversal - If type=reversal, contains information about what was reversed. Nullable. Expandable.
  • ship_from_details - The details of the ship from location, such as the address. Nullable. Expandable.
  • shipping_cost - The shipping cost details for the transaction. Nullable. 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.
  • type - If reversal, this transaction reverses an earlier transaction. Possible values: reversal, transaction.

Functions

expandable_fields()

object_name()