platforms
Reserve rules
Update reserve rule
Update an upcoming reserve rule. Only reserve rules that have never been active can be updated.
put/accounts/entities/{entityId}/reserve-rules/{id}
Request
- Base URLhttps://{prefix}.api.sandbox.checkout.com
- Auth
- OAuth 2Client credentialsToken URLstringScopesaccounts
- or API key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Headers
If-Matchstring required
Identifies a specific version of a reserve rule to update.
Request body
Example request
{
"rolling": {
"percentage": 10,
"holding_duration": {
"weeks": 2
}
}
}Response
Reserve rule updated successfully.
Example response
{
"id": "rsv_qn4nis4k3ykpzzu7cvtuvhqqga"
}Changes
No recorded changes to this operation across all 1 revision of this API.