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

# Check a discount code

> Checks that a discount code exists, hasn't been used yet, is still valid, and is for the given kind of service, and returns its terms. With `teamID`, this needs the `billing.manage` permission.



## OpenAPI

````yaml /spec/platform-billing.yaml get /v1/discount-codes/show
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/discount-codes/show:
    get:
      tags:
        - Discount Codes
      summary: Check a discount code
      description: >-
        Checks that a discount code exists, hasn't been used yet, is still
        valid, and is for the given kind of service, and returns its terms. With
        `teamID`, this needs the `billing.manage` permission.
      operationId: getDiscountCode
      parameters:
        - $ref: '#/components/parameters/TeamID'
        - name: code
          in: query
          required: true
          schema:
            type: string
          example: <discount-code>
        - name: serviceType
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/DiscountServiceType'
      responses:
        '200':
          description: The discount code's terms.
          content:
            application/json:
              schema:
                type: object
                properties:
                  _id:
                    type: string
                  code:
                    type: string
                  discountPercentage:
                    type: number
                  maxUsageAmount:
                    type: number
                    description: The most the code can discount in total.
                  validUntil:
                    type: string
                    format: date-time
                    description: Last moment the code can be applied.
                  timespan:
                    type: integer
                    description: How many days the discount lasts once applied.
                  serviceType:
                    type: string
                  createdAt:
                    type: string
                    format: date-time
              example:
                _id: '000000000000000000000090'
                code: <discount-code>
                discountPercentage: 20
                maxUsageAmount: 500000
                validUntil: '2026-06-01T00:00:00.000Z'
                timespan: 30
                serviceType: project
                createdAt: '2026-01-01T08:00:00.000Z'
        '400':
          description: >-
            The query or `teamID` is invalid, or the code is already active on
            one of your services of this type (`another_active_discount_code`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/TeamForbidden'
        '404':
          description: >-
            The code doesn't exist, is used or has expired
            (`discount_code_not_found`), or is for another kind of service
            (`discount_code_service_mismatch`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                statusCode: 404
                error: Not Found
                message: Discount code not found
                data:
                  code: discount_code_not_found
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:
    DiscountServiceType:
      type: string
      enum:
        - project
        - database
        - mailServer
        - bucket
        - vm
        - ai
    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
    ObjectID:
      type: string
      pattern: ^[0-9a-fA-F]{24}$
      description: 24-character hexadecimal ID.
    AuthError:
      type: object
      description: Error body returned when the API token is rejected.
      properties:
        error:
          type: string
  responses:
    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.