Get Gift Card Breakage
GET/api/ledger/gift-card-breakage
The tenant's gift-card breakage policy and what it would write off today.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Gift Card Liability is aged by the month each credit was booked (a gift card sold, or an opening balance); every debit (a card spent, refunded, voided or already written off) uses up the oldest months first. Once a sale month is after_months months old, percent of what is still unspent is written off from Gift Card Liability to Gift Card Breakage income, once per month.
after_months is null when no policy is set (the default): nothing is ever written off. blocked_reason says why nothing can be recorded (no policy, or an account not mapped). cohorts lists sale months newest first.
Authentication: Bearer token with the accounting scope.
Request
Responses
- 200
- 401
- 403
- 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.
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.