Get ai hosting plan and usages of a customer by planId

GET/v2/customers/{customerId}/ai-hostings/{planId}/

API version

v2

Request method

GET

Operation ID

ai-hosting-customer-get-plan

---

Request

• customerIdstring

  required
• planIdstring

  required

Responses

Format

application/json

Description

The customer usage and plan.

Schema documentation

• customerIdstring

  required
• deletedAtstring (date-time)
• descriptionstring

  required
• keysobject

  required
  • availableinteger (≥ -1)

    required
  • planLimitinteger (≥ -1)

    required
  • usedinteger (≥ 0)

    required
• modelTermsApprovalRequiredboolean

  required
• nextTokenResetstring (date-time)

  required
• planIdstring

  required
• rateLimitobject

  required

  The number of allowed requests per unit. Limits are shared across all keys within the same project.

  • allowedRequestsPerUnitinteger

    required
  • unit"minute"

    required
• tokensobject

  required
  • availableinteger (≥ -1, int64)

    required
  • planLimitinteger (≥ -1, int64)

    required
  • usedinteger (≥ 0, int64)

    required
• topUsagesarray of object
  • Array[
    • *object
      • keyIdstring
      • namestring

        required
      • projectIdstring
      • tokenUsedinteger (int64)

        required
    ]

Example

Content-Type: application/json

{
  "customerId": "string",
  "deletedAt": "1985-10-26T01:21:00.000Z",
  "description": "string",
  "keys": {
    "available": 123,
    "planLimit": 123,
    "used": 123
  },
  "modelTermsApprovalRequired": true,
  "nextTokenReset": "1985-10-26T01:21:00.000Z",
  "planId": "string",
  "rateLimit": {
    "allowedRequestsPerUnit": 123,
    "unit": "minute"
  },
  "tokens": {
    "available": 123,
    "planLimit": 123,
    "used": 123
  },
  "topUsages": [
    {
      "keyId": "string",
      "name": "string",
      "projectId": "string",
      "tokenUsed": 123
    }
  ]
}

JSON Schema

{
  "properties": {
    "customerId": {
      "type": "string"
    },
    "deletedAt": {
      "format": "date-time",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "keys": {
      "properties": {
        "available": {
          "minimum": -1,
          "type": "integer"
        },
        "planLimit": {
          "minimum": -1,
          "type": "integer"
        },
        "used": {
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "used",
        "available",
        "planLimit"
      ],
      "type": "object"
    },
    "modelTermsApprovalRequired": {
      "default": false,
      "type": "boolean"
    },
    "nextTokenReset": {
      "format": "date-time",
      "type": "string"
    },
    "planId": {
      "type": "string"
    },
    "rateLimit": {
      "description": "The number of allowed requests per unit. Limits are shared across all keys within the same project.",
      "properties": {
        "allowedRequestsPerUnit": {
          "type": "integer"
        },
        "unit": {
          "enum": [
            "minute"
          ],
          "type": "string"
        }
      },
      "required": [
        "allowedRequestsPerUnit",
        "unit"
      ],
      "type": "object"
    },
    "tokens": {
      "properties": {
        "available": {
          "format": "int64",
          "minimum": -1,
          "type": "integer"
        },
        "planLimit": {
          "format": "int64",
          "minimum": -1,
          "type": "integer"
        },
        "used": {
          "format": "int64",
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "used",
        "available",
        "planLimit"
      ],
      "type": "object"
    },
    "topUsages": {
      "items": {
        "properties": {
          "keyId": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "projectId": {
            "type": "string"
          },
          "tokenUsed": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "name",
          "tokenUsed"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "customerId",
    "planId",
    "description",
    "keys",
    "tokens",
    "rateLimit",
    "nextTokenReset",
    "modelTermsApprovalRequired"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/customers/string/ai-hostings/string?topUsageCount=123

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.aiHosting.aiHostingCustomerGetPlan({
  "customerId": "string",
  "planId": "string",
  "queryParameters": {
    "topUsageCount": 123
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\AIHosting\AiHostingCustomerGetPlan\AiHostingCustomerGetPlanRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new AiHostingCustomerGetPlanRequest(
  customerId: "string",
  planId: "string"
))
  ->withTopUsageCount(123);
$response = $client->aiHosting()->aiHostingCustomerGetPlan($request);

var_dump($response->getBody();