Issue Store Credit
POST/api/customers/:customer/store-credit
Manually issue (or adjust) store credit for a customer.
customers:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Request body:
• amount (required, numeric, non-zero) — magnitude for signed reasons (goodwill/top_up add, expiry removes); for an adjustment the sign is honored, so a negative value removes credit.
• reason (required) — one of the human-selectable reasons: goodwill, top_up, adjustment, expiry. System reasons (refund, overpayment, redemption, reversal) are rejected here.
• notes (optional, string) — free-text note.
• reference (optional, string) — external reference; defaults to an auto-generated SC-###### code.
An adjustment/expiry that would drive the wallet below zero returns 422.
Authentication: Requires Bearer token (PAT). Requires permission: customers.update.
Request
Responses
- 201
- 401
- 403
- 404
- 422
- 429
Created
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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.