Get Account Settings
GET/api/admin/portal/accounts/:customer/settings
Get an account's portal settings.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
payment_term_id is the payment term that drives invoice due dates. payment_terms is its resolved display label and is read-only — write payment_term_id instead.
credit_limit and credit_hold are reported here for context but are owned by the customer record, not by this endpoint.
allow_backorder is a tri-state: null inherits the portal-wide default (see Update Portal Settings), true always allows backorders for this account, false never does. An individual product that sets its own backorder rule overrides both.
order_discount_tiers_json is the account's order-value discount ladder — [{"min_subtotal": 1000, "percent": 3}, {"min_subtotal": 5000, "percent": 5}] reads as "3% over 1,000, 5% over 5,000". At most 10 tiers; each threshold must be distinct and each percentage must exceed the one below it, or the write is rejected with 422. Send null to remove the ladder.
It is separate from discount_percent, which is a flat percentage off the tier/list price applied per line while pricing. The two compound: lines are priced with the flat discount, then the ladder applies to the resulting subtotal as an order-level discount on the created order.
Catalogs (since 2026-10-13). An account can carry several catalogs and sees the UNION of them (an exclusion only hides a product within the catalog that declares it). portal_catalog_ids is the account's set; empty means it follows the catalog marked Default (uses_default_catalog). portal_catalogs details each with the catalog's own order-value ladder (order_discount_tiers_json), this account's override (override_order_discount_tiers_json: null = uses the catalog's, [] = catalog discount switched off for this account) and the ladder in effect. portal_catalog_id / portal_catalog_name are kept for older clients: the lowest catalog id, and every name joined.
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.