Get 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": "[email protected]",
    "items": [
      {
        "item_id": "123e4567-e89b-12d3-a456-426614174000",
        "item_name": "gpt4o_input_tokens_used",
        "billing_alias": "gpt4o_input_tokens_used"
      }
    ]
  }
]

Usage

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

Get 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": "[email protected]",
    "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

customer_id

string

required

The unique identifier for the customer.

Example:

"9f8b47e4-1aad-4f08-b1e3-d9e4b4b85e8f"

external_customer_id

string | null

An external identifier for the customer mapped by external systems.

Example:

"ext789"

customer_name

string | null

The name of the customer. This field is optional and can be used for display purposes.

Example:

"John Doe"

customer_email

string | null

The email address of the customer. Optional and can be used for communication.

Example:

"[email protected]"

items

ItemSchema · object[]

A list of events associated with the customer. Each event is represented by an event_id and event_name.

Show child attributes

items.item_id

string

required

The unique identifier for the item.

Example:

"123e4567-e89b-12d3-a456-426614174000"

items.item_name

string

required

The name of the item, typically describing what the billable item is about. This field is mapped to the plan_item name so that when a new usage item is ingested the system will automatically map it the plan line item.

Example:

"gpt4o_input_tokens_used"

items.billing_alias

string | null

The billing alias of the item, typically describing what the billable item is about. This field is mapped to the plan_item billing_alias so that when a new usage item is ingested the system will automatically map it the plan line item.

Example:

"gpt4o_input_tokens_used"

Retrieve Usage Data Batch Job Status Billable Metric Create Api

⌘I

API Documentation

Authorizations

Query Parameters

Response