Get Customer Tax Exemption at Register
GET/api/pos/register-sessions/:registerSession/customers/:customer/tax-exemption
Get whether a sale to this customer at this register is cleared of sales tax today, and why. Requires a Bearer token with the pos.operate scope.
orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
An in-store sale is taxed where the goods change hands, so the state that matters is the register warehouse's state, not the customer's address. The sale is exempt only when the customer is marked tax exempt AND an approved, in-date exemption certificate covers that state. Checkout applies exactly the same decision, so use this to preview the cart total before ringing up the sale.
Response fields
applied(boolean) — true when the sale is cleared of tax.reason(string) — one ofvalid_certificate,legacy(a customer with no certificates, judged on the exemption details on their record),expired,lapsed,pending,not_accepted,wrong_state,no_certificate,not_exempt.certificate_id,certificate_number,expires_on(Y-m-d) — the certificate the decision rests on, when there is one.region(string) — the two-letter state code of the register's warehouse.message(string) — a plain-language explanation, suitable to show to the cashier.
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
Response Headers
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.