Create a ReserveHold Preview
POST / v1 / reserve / holds
Create a ReserveHold.
Parameters
- amount integer Required Amount to reserve. A positive integer representing how much to reserve in the smallest currency unit (e.g., 100 cents to reserve $1.00 or 100 to reserve ¥100, a zero-decimal currency).
- currency enum Required Three-letter ISO currency code, in lowercase. Must be a supported currency.
- release _ schedule object Required Configure when to release the ReserveHold.
- metadata map 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.
More parameters
- source _ type string
Returns
Returns a ReserveHold object.
cURL
Response
{ "id": "reshold_61SxrUZH1aQJj97WT41Q8rCFhzAUW", "object": "reserve.hold", "amount": 1000, "amount_releasable": 1000, "created": 1753380387, "created_by": "application", "currency": "usd", "is_releasable": true, "livemode": false, "metadata": {}, "reason": "standalone", "release_schedule": { "release_after": 1755972386, "scheduled_release": 1755993600 }, "reserve_plan": null, "source_charge": null, "source_type": "card"}
Update a ReserveHold Preview
POST / v1 / reserve / holds /:id
Update a ReserveHold’s release schedule or metadata.
Parameters
- id string Required The identifier of the ReserveHold to update.
- metadata map 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. - release _ schedule object Configure when to release the ReserveHold.
Returns
Returns the updated ReserveHold object.
cURL
Response
{ "id": "reshold_61SxrUZH1aQJj97WT41Q8rCFhzAUW", "object": "reserve.hold", "amount": 1000, "amount_releasable": 1000, "created": 1753380387, "created_by": "application", "currency": "usd", "is_releasable": true, "livemode": false, "metadata": { "test_key": "test_value" }, "reason": "standalone", "release_schedule": { "release_after": 1758588150, "scheduled_release": 1758672000 }, "reserve_plan": null, "source_charge": null, "source_type": "card"}
Retrieve a ReserveHold Preview
GET / v1 / reserve / holds /:id
Retrieve a ReserveHold.
Parameters
- id string Required The identifier of the ReserveHold to retrieve.
Returns
Returns a ReserveHold object.
Response
{ "id": "reshold_61SxrUZH1aQJj97WT41Q8rCFhzAUW", "object": "reserve.hold", "amount": 1000, "amount_releasable": 1000, "created": 1753380387, "created_by": "application", "currency": "usd", "is_releasable": true, "livemode": false, "metadata": {}, "reason": "standalone", "release_schedule": { "release_after": 1755972386, "scheduled_release": 1755993600 }, "reserve_plan": null, "source_charge": null, "source_type": "card"}