v1

latestOpenAPI 3.0.02026-07-2641142112.7 KB

Consumption

Retrieve the current credit consumption period

get/consumption/current-period

Response

The current consumption period

idstring uuid required

Unique identifier of the consumption period

creditsinteger required

Remaining credits

creditsInitialinteger required

Credits allocated at the start of the period

periodStartstring date-time required

Start of the period

periodEndstring date-time required

End of the period

expiredboolean required

Whether this period has expired

Example response

{
  "id": "091c4dc8-e979-4607-b9ca-78260ab48dfe",
  "credits": 3,
  "creditsInitial": 3,
  "periodStart": "2024-10-21T11:20:17Z",
  "periodEnd": "2224-10-21T11:20:17Z",
  "expired": false
}