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').

Ingest Event

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

Template Get Api

Creates a contract based on a template and selected option.

Create Contract Api

API Documentation

Customer payment methods