Stripe.Resources.Reserve.Hold (tiger_stripe v0.4.0)

Copy Markdown View Source

ReservesReserveHoldsResourcesReserveHold

ReserveHolds are used to place a temporary ReserveHold on a merchant's funds.

Summary

Types

t()

Functions

expandable_fields()
object_name()

Types

t()

@type t() :: %Stripe.Resources.Reserve.Hold{
  amount: term(),
  amount_releasable: term(),
  created: term(),
  created_by: term(),
  currency: term(),
  id: term(),
  is_releasable: term(),
  livemode: term(),
  metadata: term(),
  object: term(),
  reason: term(),
  release_details: term(),
  release_schedule: term(),
  reserve_plan: term(),
  source_charge: term(),
  source_type: term()
}
  • amount - Amount reserved. A positive integer representing how much is reserved in the smallest currency unit.
  • amount_releasable - Amount in cents that can be released from this ReserveHold
  • created - Time at which the object was created. Measured in seconds since the Unix epoch. Format: Unix timestamp.
  • created_by - Indicates which party created this ReserveHold. Possible values: application, stripe.
  • currency - Three-letter ISO currency code, in lowercase. Must be a supported currency. Format: ISO 4217 currency code.
  • id - Unique identifier for the object. Max length: 5000.
  • is_releasable - Whether there are any funds available to release on this ReserveHold. Note that if the ReserveHold is in the process of being released, this could be false, even though the funds haven't been fully released yet.
  • 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.
  • object - String representing the object's type. Objects of the same type share the same value. Possible values: reserve.hold.
  • reason - The reason for the ReserveHold. Possible values: charge, standalone.
  • release_details - List of ReserveReleases and the amounts released from this ReserveHold. Expandable.
  • release_schedule - Expandable.
  • reserve_plan - The ReservePlan which produced this ReserveHold (i.e., resplan_123) Nullable. Expandable.
  • source_charge - The Charge which funded this ReserveHold (e.g., ch_123) Nullable. Expandable.
  • source_type - Which source balance type this ReserveHold reserves funds from. One of bank_account, card, or fpx. Possible values: bank_account, card, fpx.

Functions

expandable_fields()

object_name()