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

ReservesReservePlansResourcesReservePlan

ReservePlans are used to automatically place holds on a merchant's funds until the plan expires. It takes a portion of each incoming Charge (including those resulting from a Transfer from a platform account).

Summary

Types

t()

Functions

expandable_fields()

object_name()

Types

t()

@type t() :: %Stripe.Resources.Reserve.Plan{
  created: term(),
  created_by: term(),
  currency: term(),
  disabled_at: term(),
  fixed_release: term(),
  id: term(),
  livemode: term(),
  metadata: term(),
  object: term(),
  percent: term(),
  rolling_release: term(),
  status: term(),
  type: term()
}

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 ReservePlan. Possible values: application, stripe.
currency - Three-letter ISO currency code, in lowercase. Must be a supported currency. An unset currency indicates that the plan applies to all currencies. Format: ISO 4217 currency code. Nullable.
disabled_at - Time at which the ReservePlan was disabled. Format: Unix timestamp. Nullable.
fixed_release - Expandable.
id - Unique identifier for the object. Max length: 5000.
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.plan.
percent - The percent of each Charge to reserve.
rolling_release - Expandable.
status - The current status of the ReservePlan. The ReservePlan only affects charges if it is active. Possible values: active, disabled, expired.
type - The type of the ReservePlan. Possible values: fixed_release, rolling_release.