Get Account Statement
GET/api/portal/account/statement
Return the active account's payment terms, credit limit, open invoice balance, open order value, and available credit.
Called by a B2B portal buyer with the bearer token POST /api/portal/auth/login returns (or the buyer's feed key) — not with a staff Personal Access Token.
Which orders: by default every order the account has, whatever channel it came through (the portal, the merchant's store, phone or email orders entered by staff) — another channel's draft orders are never shown. A merchant can limit this to orders placed in the portal (Portal Settings → Order history).
Request
Responses
- 200
- 401
- 403
- 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.
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.