Skip to main content
GET
Get Account
Subtotal Connector tool: get_account The account your credential acts for: your team, the brands you subscribe to, your plan and what it includes, and the OAuth scopes your token was granted.
  • plan.name is the plan shown on the dashboard’s billing page, or null when your account has no current plan. Without a plan, analytics_entitled and mcp_entitled are false and purchase_access is brand_products.
  • plan.purchase_access is your plan’s purchase access: all_purchases, full_basket (whole baskets that hold one of your brands’ products), or brand_products (only your brands’ items in those baskets). It is your plan’s ceiling and doesn’t change per credential: an API key or OAuth token can be set narrower, so a token with purchases:brand_products gets only your brands’ items even when this field shows all_purchases.
  • scopes lists the scopes on a Subtotal Connector or partner app OAuth token, and is null for an API key, which is unscoped.
Any valid API key or OAuth token can call it; no scope is required.

Headers

authorization
string | null
x-api-key
string | null

Response

Successful Response

client_id
string
required

Your account (team) id

name
string
required

Your team's name

status
enum<string>
required
Available options:
active,
inactive
creation_date
string<date-time>
required
brands
AccountBrand · object[]
required

The brands you subscribe to, by name

plan
AccountPlan · object
required
scopes
string[] | null
required

The OAuth scopes granted to the token making this call; null for an API key, which is unscoped