Get Items

Retrieve Usage-Based Billable Items

Fetch a list of usage-based billable items, optionally filtered by a specific customer ID or external customer ID.

Overview

This endpoint allows you to retrieve billable items along with associated customer details from the database. You can filter the results by either a customer ID or external customer ID. If no filter is provided, the endpoint returns billable items for all customers.

Parameters

customer_id (optional): The unique identifier of the customer to filter events by.
external_customer_id (optional): The external identifier of the customer to filter events by.

GET

api

usage

items

curl --request GET \
  --url https://api.justpaid.io/api/v1/usage/items \
  --header 'Authorization: Bearer <token>'

[
  {
    "customer_id": "9f8b47e4-1aad-4f08-b1e3-d9e4b4b85e8f",
    "external_customer_id": "ext789",
    "customer_name": "John Doe",
    "customer_email": "john.doe@example.com",
    "items": [
      {
        "item_id": "123e4567-e89b-12d3-a456-426614174000",
        "item_name": "gpt4o_input_tokens_used",
        "billing_alias": "gpt4o_input_tokens_used"
      }
    ]
  }
]

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

customer_id

string

external_customer_id

string

Response

200 - application/json

A list of customers with their associated events

The response is of type ItemListSchema · object[].

curl --request GET \
  --url https://api.justpaid.io/api/v1/usage/items \
  --header 'Authorization: Bearer <token>'

[
  {
    "customer_id": "9f8b47e4-1aad-4f08-b1e3-d9e4b4b85e8f",
    "external_customer_id": "ext789",
    "customer_name": "John Doe",
    "customer_email": "john.doe@example.com",
    "items": [
      {
        "item_id": "123e4567-e89b-12d3-a456-426614174000",
        "item_name": "gpt4o_input_tokens_used",
        "billing_alias": "gpt4o_input_tokens_used"
      }
    ]
  }
]

Get Items

Retrieve Usage-Based Billable Items

Fetch a list of usage-based billable items, optionally filtered by a specific customer ID or external customer ID.

Overview

Parameters

customer_id (optional): The unique identifier of the customer to filter events by.
external_customer_id (optional): The external identifier of the customer to filter events by.

GET

api

usage

items

curl --request GET \
  --url https://api.justpaid.io/api/v1/usage/items \
  --header 'Authorization: Bearer <token>'

[
  {
    "customer_id": "9f8b47e4-1aad-4f08-b1e3-d9e4b4b85e8f",
    "external_customer_id": "ext789",
    "customer_name": "John Doe",
    "customer_email": "john.doe@example.com",
    "items": [
      {
        "item_id": "123e4567-e89b-12d3-a456-426614174000",
        "item_name": "gpt4o_input_tokens_used",
        "billing_alias": "gpt4o_input_tokens_used"
      }
    ]
  }
]

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

customer_id

string

external_customer_id

string

Response

200 - application/json

A list of customers with their associated events

The response is of type ItemListSchema · object[].

curl --request GET \
  --url https://api.justpaid.io/api/v1/usage/items \
  --header 'Authorization: Bearer <token>'

[
  {
    "customer_id": "9f8b47e4-1aad-4f08-b1e3-d9e4b4b85e8f",
    "external_customer_id": "ext789",
    "customer_name": "John Doe",
    "customer_email": "john.doe@example.com",
    "items": [
      {
        "item_id": "123e4567-e89b-12d3-a456-426614174000",
        "item_name": "gpt4o_input_tokens_used",
        "billing_alias": "gpt4o_input_tokens_used"
      }
    ]
  }
]

Authorizations

Query Parameters

Response

API Documentation

Authorizations

Query Parameters

Response