> ## Documentation Index
> Fetch the complete documentation index at: https://docs.subtotal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Account

> Your own account: your team, the brands you subscribe to, your plan and what it includes, and the OAuth scopes your token was granted. Any valid credential can read it; no scope is required.

[Subtotal Connector tool: get\_account](/docs/connector/tools.md#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](/docs/connector/introduction.md) or [partner app](/docs/partner-apps/introduction.md) 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.


## OpenAPI

````yaml get /account
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers: []
security: []
paths:
  /account:
    get:
      tags:
        - account
      summary: Get Account
      description: >-
        Your own account: your team, the brands you subscribe to, your plan and
        what it includes, and the OAuth scopes your token was granted. Any valid
        credential can read it; no scope is required.
      operationId: get_account_account_get
      parameters:
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - name: x-api-key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AccountResponse:
      properties:
        client_id:
          type: string
          title: Client Id
          description: Your account (team) id
        name:
          type: string
          title: Name
          description: Your team's name
        status:
          $ref: '#/components/schemas/ClientStatus'
        creation_date:
          type: string
          format: date-time
          title: Creation Date
        brands:
          items:
            $ref: '#/components/schemas/AccountBrand'
          type: array
          title: Brands
          description: The brands you subscribe to, by name
        plan:
          $ref: '#/components/schemas/AccountPlan'
        scopes:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Scopes
          description: >-
            The OAuth scopes granted to the token making this call; null for an
            API key, which is unscoped
      type: object
      required:
        - client_id
        - name
        - status
        - creation_date
        - brands
        - plan
        - scopes
      title: AccountResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ClientStatus:
      type: string
      enum:
        - active
        - inactive
      title: ClientStatus
    AccountBrand:
      properties:
        brand_id:
          type: string
          title: Brand Id
        name:
          type: string
          title: Name
      type: object
      required:
        - brand_id
        - name
      title: AccountBrand
    AccountPlan:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: >-
            Your plan, as the dashboard names it; null when you have no current
            plan
        analytics_entitled:
          type: boolean
          title: Analytics Entitled
          description: Whether your plan includes the dashboard's purchase analytics
        mcp_entitled:
          type: boolean
          title: Mcp Entitled
          description: Whether your plan includes the Subtotal MCP server
        purchase_access:
          $ref: '#/components/schemas/PurchaseAccessScope'
          description: >-
            Which purchases your plan shares: all_purchases; full_basket (whole
            baskets holding one of your brands' products); or brand_products
            (only your brands' items in those baskets). The plan's ceiling: an
            API key or OAuth token can be narrower, e.g. a token with
            purchases:brand_products reads brand_products
      type: object
      required:
        - name
        - analytics_entitled
        - mcp_entitled
        - purchase_access
      title: AccountPlan
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    PurchaseAccessScope:
      type: string
      enum:
        - all_purchases
        - full_basket
        - brand_products
      title: PurchaseAccessScope

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.