Record Gift Card Breakage
POST/api/ledger/gift-card-breakage/record
Write off every sale month that is due today under the saved policy. Each month becomes one balanced journal (debit Gift Card Liability, credit Gift Card Breakage), dated today and synced to the accounting provider like any manual journal. A month already written off is never written off again, so repeating the call is safe. The same run happens automatically on the 1st of each month.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Returns the refreshed preview. Requires the accounting.sync 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.