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

# Your account and billing profile

> Name, email, role and billing profile, plus the currencies you can choose to be billed in.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/client/settings
openapi: 3.1.0
info:
  title: Server.Express API
  version: 1.0.0
  description: >-
    The customer-facing Server.Express API: auth, billing, tickets, cloud and
    dedicated servers, hosting, reselling and account management. Every response
    uses the `{ success, data | error }` envelope.
  contact:
    name: Server.Express
    url: https://server.express
servers:
  - url: https://my.server.express/api
    description: Production
security:
  - bearerAuth: []
  - apiToken: []
tags:
  - name: API Tokens
  - name: Account
  - name: Auth
  - name: Cloud
  - name: Coupons
  - name: Credits
  - name: Dashboard
  - name: Dedicated
  - name: Health
  - name: Hosting
  - name: Integrations
  - name: Invoices
  - name: Livechat
  - name: Notifications
  - name: Passkeys
  - name: Payments
  - name: Products
  - name: Public
  - name: Public Invoices
  - name: Public Tools
  - name: Reseller
  - name: SSH Keys
  - name: Services
  - name: Tasks
  - name: Teams
  - name: Tickets
  - name: Web Hosting
  - name: Webhooks
paths:
  /v1/client/settings:
    get:
      tags:
        - Account
      summary: Your account and billing profile
      description: >-
        Name, email, role and billing profile, plus the currencies you can
        choose to be billed in.
      operationId: publicClientGetSettings
      responses:
        '200':
          description: Settings.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    required:
                      - id
                      - email
                      - firstName
                      - lastName
                      - role
                      - createdAt
                      - profile
                      - supportedCurrencies
                    properties:
                      id:
                        type: string
                        format: uuid
                      email:
                        type: string
                        format: email
                      firstName:
                        type: string
                      lastName:
                        type: string
                      role:
                        type: string
                        enum:
                          - CLIENT
                          - ADMIN
                      createdAt:
                        type: string
                        format: date-time
                      profile:
                        oneOf:
                          - $ref: '#/components/schemas/PublicClientProfile'
                          - type: 'null'
                      supportedCurrencies:
                        type: array
                        items:
                          type: string
                          enum:
                            - GBP
                            - USD
                            - EUR
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - bearerAuth: []
components:
  schemas:
    PublicClientProfile:
      type: object
      required:
        - addressLine1
        - addressLine2
        - city
        - region
        - country
        - postcode
        - phoneNumber
        - vatNumber
        - vatValid
        - clientType
        - companyName
        - preferredCurrency
      properties:
        addressLine1:
          type:
            - string
            - 'null'
        addressLine2:
          type:
            - string
            - 'null'
        city:
          type:
            - string
            - 'null'
        region:
          type:
            - string
            - 'null'
        country:
          type:
            - string
            - 'null'
          description: 2-letter ISO code.
        postcode:
          type:
            - string
            - 'null'
        phoneNumber:
          type:
            - string
            - 'null'
        vatNumber:
          type:
            - string
            - 'null'
        vatValid:
          type: boolean
          description: Set from a VIES lookup, never by the customer.
        clientType:
          type: string
          enum:
            - INDIVIDUAL
            - BUSINESS
        companyName:
          type:
            - string
            - 'null'
        preferredCurrency:
          type:
            - string
            - 'null'
          description: Null means GBP.
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
          description: Human-readable error message.
      additionalProperties: true
  responses:
    Unauthorized:
      description: Missing, invalid or expired credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: >-
        Authenticated but not allowed (missing scope, not an admin, or not your
        resource).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Session access token (JWT) from POST /v1/auth/login or /v1/auth/refresh.
        A session satisfies every API scope.
    apiToken:
      type: http
      scheme: bearer
      bearerFormat: se_live_<prefix>_<secret>
      description: >-
        Personal API token created under Settings → API tokens. Only routes
        guarded by verifyApiAuth accept it, and the token must carry the scope
        named in the operation's x-required-scope.

````

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