### 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 Items

Schema for a list of usage based items associated with a customer.

Attributes:
    customer_id (str): Unique identifier for the customer.
    external_customer_id (Optional[str]): An optional external identifier for the customer.
    customer_name (Optional[str]): The name of the customer. Optional.
    customer_email (Optional[str]): The email address of the customer. Optional.
    items (List[ItemSchema]): A list of usage based item associated with the customer.

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

Customer Email

Customer Id

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

Customer Name

An external identifier for the customer mapped by external systems.

External Customer Id

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

Items

ItemListSchema

Schema for an individual item.

Attributes:
    item_id (str): Unique identifier for the item.
    item_name (str): Name of the item.

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.

Billing Alias

Item Id

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.

Item Name

ItemSchema

HttpBearerAuth

A list of customers with their associated events

Response

Justpaid Docs

JustPaid.io API

Blog

API Reference

Dashboard

Support

Authentication

Pagination

Webhooks

Errors

This SDK provides a simple interface to interact with the JustPaid API for usage-based billing.

JustPaid API SDK

Customer Create Api

Customer Get Api

Invoice Get Api

Invoice List Api

Invoice Payment Create Api

Invoice Payment Get Api

Invoice Payment List Api

Invoice Payment Cancel Api

Ingests a list of customer events, creating new events and identifying duplicates.

This endpoint processes a batch of customer events, checks for idempotency to prevent duplicates,
and attempts to create new events in the system. It returns detailed information about the process,
including the number of successfully created events, any duplicates identified, and errors encountered.

Parameters:
    request: The request object, which includes details about the HTTP request.
             This is typically provided by the FastAPI framework.
    customer_event_list (CustomerEventList): An object containing a list of customer events to be ingested.
                                             Each event must include an idempotency key to prevent duplicate
                                             processing.

Returns:
    A dictionary with two keys:
    - 'info': A dictionary containing details about the ingestion process, including the number of events
              successfully created ('created_events') and a list of idempotency keys for events identified
              as duplicates ('duplicates').
    - 'errors': A list of dictionaries, each representing an error encountered during the ingestion process.
                Each dictionary includes the 'idempotency_key' of the event that caused the error and a
                description of the error ('error').

API Documentation

Get Items

Retrieve Usage-Based Billable Items

Overview

Parameters

Authorizations

Query Parameters

Response