Skip to main content

Update Gift Card Breakage Policy

PUT 

/api/ledger/gift-card-breakage

Save the gift-card breakage policy, or preview it without saving.

Required scope: accounting:write

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

OK

Response Headers
    Content-Type