> ## 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.

# List payments

> Lists all your completed and failed payments, newest first. With `teamID`, this needs the `billing.manage` permission.



## OpenAPI

````yaml /spec/platform-billing.yaml get /v1/payments
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/payments:
    get:
      tags:
        - Payments
      summary: List payments
      description: >-
        Lists all your completed and failed payments, newest first. With
        `teamID`, this needs the `billing.manage` permission.
      operationId: listPayments
      parameters:
        - $ref: '#/components/parameters/TeamID'
      responses:
        '200':
          description: Your payments.
          content:
            application/json:
              schema:
                type: object
                properties:
                  payments:
                    type: array
                    items:
                      $ref: '#/components/schemas/Payment'
              example:
                payments:
                  - _id: '000000000000000000000060'
                    amount: 1000000
                    status: SUCCEED
                    gateway:
                      name: <gateway-name>
                    invoiceNumber: 1000
                    created_at: '2026-01-01T08:00:00.000Z'
                    actor:
                      fullname: نام نمونه
                      email: you@example.com
                    paymentVersion: 2
                    hasInvoice: false
                    invoiceType: 2
                    traceNumber: <trace-number>
        '400':
          $ref: '#/components/responses/InvalidTeamID'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/TeamForbidden'
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:
    Payment:
      type: object
      properties:
        _id:
          type: string
        amount:
          type: number
        status:
          type: string
          enum:
            - SUCCEED
            - FAILED
        gateway:
          type: object
          properties:
            name:
              type: string
              description: Display name of the payment gateway.
        invoiceNumber:
          type: integer
        created_at:
          type: string
          format: date-time
        actor:
          type: object
          description: The person who made the payment, for team payments.
          properties:
            fullname:
              type: string
            email:
              type: string
        paymentVersion:
          type: integer
          description: >-
            `2` for payments with a receipt (`GET .../billing-receipt`), `1` for
            older payments with an invoice (`GET .../invoice`).
        hasInvoice:
          type: boolean
          description: >-
            Whether an invoice is available from `GET
            /v1/payments/{paymentID}/invoice`.
        invoiceType:
          type: integer
          nullable: true
          description: >-
            `1` if the payment was made with an economic code on file, `2` if
            not, or `null` if no contact details were recorded.
        traceNumber:
          type: string
          description: The gateway's reference number for the payment.
    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.
    TeamForbidden:
      description: >-
        With `teamID`: you aren't a member of the team (`team_not_found`), or
        your role doesn't have the required permission (`no_permission`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            teamNotFound:
              summary: Not a team member
              value:
                statusCode: 403
                error: Forbidden
                message: Team not found
                data:
                  code: team_not_found
            noPermission:
              summary: Missing permission
              value:
                statusCode: 403
                error: Forbidden
                message: You do not have permission to access this resource.
                data:
                  code: no_permission
  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.