Skip to main content

Get Gift Card Breakage

GET 

/api/ledger/gift-card-breakage

The tenant's gift-card breakage policy and what it would write off today.

Required scope: accounting:read

Grant 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​

OK

Response Headers
    Content-Type