openapi: 3.1.0
info:
  title: Interzoid Remaining API Credits API
  description: >
    This API provides information about the remaining credits for your Interzoid API key.

    To use this API, you need an API key. Register for an API key at [Interzoid Registration](https://www.interzoid.com/register-api-account).

    For more information about this API, visit the [Interzoid Remaining API Credits Documentation](https://www.interzoid.com/apis/remaining-api-credits).
  version: 1.0.0
  contact:
    name: Interzoid Support
    url: https://www.interzoid.com
    email: support@interzoid.com
externalDocs:
  description: API home page and documentation
  url: https://www.interzoid.com/apis/remaining-api-credits
servers:
  - url: https://api.interzoid.com
    description: Production server
tags:
  - name: API Credits
    description: Provides information about remaining API credits for an API key. Note a negative balance indicates a pay-as-you-go model or a current overage balance.
paths:
  /getremainingcredits:
    get:
      tags:
        - API Credits
      summary: Retrieve Remaining API Credits
      description: >
        This method retrieves the remaining credits for your API license key.

        **Note**: You must include your API key as the `license` parameter in the request. If you do not have an API key, you can register for one at [Interzoid Registration](https://www.interzoid.com/register-api-account).
      parameters:
        - name: license
          in: query
          required: true
          description: >
            Your API license key. Register for an API key at
            [Interzoid Registration](https://www.interzoid.com/register-api-account).
          schema:
            type: string
          examples:
            license:
                summary: API Key Example
                value: "r2d7df664a7c4ef6h8k"
      responses:
        '200':
          description: Successful response containing remaining API credits.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Code:
                    type: string
                    description: Status code indicating success or failure.
                  Credits:
                    type: integer
                    description: Remaining credits for your API license.
                examples:
                  - summary: Successful response example
                    value:
                      Code: "Success"
                      Credits: 46272
        '400':
          description: Bad request (e.g., missing or invalid parameters).
          content:
            application/json:
              schema:
                type: object
                properties:
                  Code:
                    type: string
                    description: Status code.
                  Message:
                    type: string
                    description: Error message.
                examples:
                  - summary: Missing or invalid parameters
                    value:
                      Code: "400"
                      Message: "Invalid license key or parameters missing."
        '402':
          description: API key not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Code:
                    type: string
                    description: Status code.
                  Message:
                    type: string
                    description: Error message.
                examples:
                  - summary: API key not found
                    value:
                      Code: "402"
                      Message: "API key not found."
        '405':
          description: Method not allowed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Code:
                    type: string
                    description: Status code.
                  Message:
                    type: string
                    description: Error message.
                examples:
                  - summary: Wrong HTTP method
                    value:
                      Code: "405"
                      Message: "Method not allowed."
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Code:
                    type: string
                    description: Status code.
                  Message:
                    type: string
                    description: Error message.
                examples:
                  - summary: Server error
                    value:
                      Code: "500"
                      Message: "Internal server error."
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: license
      in: query
  schemas:
    ResponseError:
      type: object
      properties:
        Code:
          type: string
          description: Status code.
        Message:
          type: string
          description: Error message.
security:
  - apiKeyAuth: []