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

Copy Markdown View Source

Parameters for transaction create reversal.

Summary

Types

line_items()
shipping_cost()
t()

Types

line_items()

@type line_items() :: %{
  optional(:amount) => integer() | nil,
  optional(:amount_tax) => integer() | nil,
  optional(:metadata) => %{required(String.t()) => String.t()} | nil,
  optional(:original_line_item) => String.t() | nil,
  optional(:quantity) => integer() | nil,
  optional(:reference) => String.t() | nil,
  optional(String.t()) => term()
}
  • amount - The amount to reverse, in the smallest currency unit in negative.
  • amount_tax - The amount of tax to reverse, in the smallest currency unit in negative.
  • 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.
  • original_line_item - The id of the line item to reverse in the original transaction. Max length: 5000.
  • quantity - The quantity reversed. Appears in tax exports, but does not affect the amount of tax reversed.
  • reference - A custom identifier for this line item in the reversal transaction, such as 'L1-refund'. Max length: 500.

shipping_cost()

@type shipping_cost() :: %{
  optional(:amount) => integer() | nil,
  optional(:amount_tax) => integer() | nil,
  optional(String.t()) => term()
}

t()

@type t() :: %Stripe.Params.Tax.TransactionCreateReversalParams{
  expand: [String.t()] | nil,
  flat_amount: integer() | nil,
  line_items: [line_items()] | nil,
  metadata: %{required(String.t()) => String.t()} | nil,
  mode: String.t(),
  original_transaction: String.t(),
  reference: String.t(),
  shipping_cost: shipping_cost() | nil
}
  • expand - Specifies which fields in the response should be expanded.
  • flat_amount - A flat amount to reverse across the entire transaction, in the smallest currency unit in negative. This value represents the total amount to refund from the transaction, including taxes.
  • line_items - The line item amounts to reverse.
  • 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
  • mode - If partial, the provided line item or shipping cost amounts are reversed. If full, the original transaction is fully reversed. Possible values: full, partial.
  • original_transaction - The ID of the Transaction to partially or fully reverse. Max length: 5000.
  • reference - A custom identifier for this reversal, such as myOrder_123-refund_1, which must be unique across all transactions. The reference helps identify this reversal transaction in exported tax reports. Max length: 500.
  • shipping_cost - The shipping cost to reverse.