Get Open Sales Credits
GET/api/customers/:customer/open-sales-credits
Get the customer's open sales credits that can still be applied as store credit, each with its unapplied balance. A credit note issued against a sales invoice is included for whatever part of it that invoice did not absorb (for example a credit on an already-paid invoice); overpayment credits are included.
customers:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
total is the credit's tax-inclusive value (line amounts plus tax for tax-exclusive credits) and balance is total less every amount already applied — the same basis applied amounts are recorded on.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.