v4

latestOpenAPI 3.0.22026-08-02109239415.7 KB

manage

Retrieve user credit information and spending metrics

get/manage/api/credits

Query parameters

organization_idstring required

Base64 encoded organization ID to filter credit information for a specific organization

start_timestring date-time required

Start time to look back for calculating average daily spend and other metrics

end_timestring date-time

Inclusive end time to look back for calculating average daily spend and other metrics. If not provided, the current time will be used.

Response

User credit information retrieved successfully

Example response

{
  "total_spend": {
    "amount": 1050,
    "currency_code": "USD"
  },
  "average_daily_spend": {
    "amount": 1050,
    "currency_code": "USD"
  },
  "available_credits": {
    "amount": 1050,
    "currency_code": "USD"
  }
}