Sign in

v21

OpenAPI 3.1.0raw.githubusercontent.com2026-08-011060456.0 KB
Payments

Get Item

Retrieves information about a specific item (credits, quotas, etc.) for a customer.

get/payments/items/{customer_type}/{customer_id}/{item_id}

Path parameters

customer_type'user' | 'team' | 'custom' required

The type of customer

Example:user

The type of customer

customer_idstring required

The ID of the customer

Example:user_1234567890abcdef

The ID of the customer

item_idstring required

The ID of the item to retrieve

Example:credits

The ID of the item to retrieve

Response

Successful response

idstring required

The ID of the item

display_namestring required

The human-readable name of the item

quantitynumber required

The current quantity of the item (can be negative)

Example response

{
  "id": "credits",
  "display_name": "API Credits",
  "quantity": 1000
}