Update Gift Card Breakage Policy
PUT/api/ledger/gift-card-breakage
Save the gift-card breakage policy, or preview it without saving.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body:
after_months(integer 1-120, or null; required key) — how many months after the sale month unspent value is written off. null turns breakage off; nothing already written off changes.percent(number, required, above 0 and at most 100) — the share of what is still unspent to write off.preview_only(boolean, optional) — true returns what the policy would write off today without saving it.
Changing the policy only affects sale months not yet written off.
Requires the accounting.manage_settings permission.
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.