Get Item

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

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

Get Item

cURL

curl --request GET \
  --url https://api.stack-auth.com/api/v1/payments/items/{customer_type}/{customer_id}/{item_id}

200

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

Path Parameters

customer_type · string · required

The type of customer

Example:

"user"

customer_id · string · required

The ID of the customer

Example:

"user_1234567890abcdef"

item_id · string · required

The ID of the item to retrieve

Example:

"credits"

Response

200 - application/json

Successful response

id · string · required

The ID of the item

Example:

"credits"

display_name · string · required

The human-readable name of the item

Example:

"API Credits"

quantity · number · required

The current quantity of the item (can be negative)

Example:

1000