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

# Get balance and billing details

> Returns your balance and billing contact details. With `teamID`, it also returns the team's, if your role has a billing permission there.



## OpenAPI

````yaml /spec/platform-billing.yaml get /v1/billing
openapi: 3.0.1
info:
  title: Billing & Subscription
  version: 1.0.0
  description: |
    Check your balance and costs, add credit, download invoices and receipts,
    manage your subscription plan, and apply discount codes.

    All amounts are in Toman (IRT).

    With `teamID`, these endpoints work on the team's billing. Most of them
    need the `billing.manage` permission in the team; the description of each
    endpoint says which permission it needs.
servers:
  - url: https://api.liara.ir
security:
  - bearerAuth: []
tags:
  - name: Balance & Usage
    description: Balance, current costs and service counts.
  - name: Payments
    description: Add credit and list past payments.
  - name: Invoices & Receipts
    description: Monthly billing invoices and payment receipts.
  - name: Subscription
    description: View and change the account's subscription plan.
  - name: Discount Codes
    description: Check and apply discount codes.
paths:
  /v1/billing:
    get:
      tags:
        - Balance & Usage
      summary: Get balance and billing details
      description: >-
        Returns your balance and billing contact details. With `teamID`, it also
        returns the team's, if your role has a billing permission there.
      operationId: getBilling
      parameters:
        - $ref: '#/components/parameters/TeamID'
      responses:
        '200':
          description: Balance and billing details.
          content:
            application/json:
              schema:
                type: object
                properties:
                  user:
                    $ref: '#/components/schemas/BillingDetails'
                  team:
                    allOf:
                      - $ref: '#/components/schemas/BillingDetails'
                    description: >-
                      Only with `teamID`. Empty if your role has no billing
                      permission in the team.
              example:
                user:
                  balance: 2500000
                  accountType: REAL_PERSON
                  contactInfo: {}
                  minCreditAmount: 20000
                  isManualMinCredit: false
        '400':
          $ref: '#/components/responses/InvalidTeamID'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/TeamNotFound'
components:
  parameters:
    TeamID:
      name: teamID
      in: query
      required: false
      description: >-
        Run the request in the context of a team you belong to, instead of your
        personal account.
      schema:
        $ref: '#/components/schemas/ObjectID'
      example: '000000000000000000000002'
  schemas:
    BillingDetails:
      type: object
      properties:
        balance:
          type: number
          description: Current balance.
        accountType:
          type: string
          enum:
            - REAL_PERSON
            - LEGAL_PERSON
        contactInfo:
          type: object
          description: Saved billing contact details (see `POST /v1/contact-info`).
        contactInfoSavedAt:
          type: string
          format: date-time
        minCreditAmount:
          type: number
          description: Balance threshold for low-credit notifications.
        isManualMinCredit:
          type: boolean
          description: Whether the low-credit threshold was set manually.
        minCreditLastNotifiedAt:
          type: string
          format: date-time
          description: When a low-credit notification was last sent.
    ObjectID:
      type: string
      pattern: ^[0-9a-fA-F]{24}$
      description: 24-character hexadecimal ID.
    Error:
      type: object
      description: Standard error body.
      properties:
        statusCode:
          type: integer
        error:
          type: string
          description: HTTP status text.
        message:
          type: string
          description: What went wrong.
        data:
          type: object
          nullable: true
          description: >-
            Extra details. When present, `code` is a stable, machine-readable
            error code.
          properties:
            code:
              type: string
    AuthError:
      type: object
      description: Error body returned when the API token is rejected.
      properties:
        error:
          type: string
  responses:
    InvalidTeamID:
      description: '`teamID` isn''t a valid ID.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 400
            error: Bad Request
            message: Invalid team ID.
            data: null
    Unauthorized:
      description: The API token is missing, invalid or expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthError'
          example:
            error: Unauthorized.
    TeamNotFound:
      description: You sent a `teamID` for a team you aren't a member of.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 403
            error: Forbidden
            message: Team not found
            data:
              code: team_not_found
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Send your API token as `Authorization: Bearer <api-token>`.'

````

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