Docs Paigo Tech Paigo API

Name: Paigo API
Brand: Paigo API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentPaymentsBilling Subscriptionsoauth248 EndpointsREST

For Agents

Define usage dimensions and offerings, ingest usage events, manage customers, and generate invoices through Paigo's usage-based billing API. OAuth 2.0 client-credentials.

Install Jentic One Beta

Connect the Paigo API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Paigo API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Paigo API.

Define metered dimensions and pricing offerings via /dimensions and /offerings

Ingest measured usage events via POST /usage and per-customer measurements

Manage customers and parent-child customer hierarchies via /customers/{customerId}/children/{childId}

GET STARTED

Start building with Paigo API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Paigo API, keeping it validated and agent-ready. Paigo is a usage-based billing platform: it lets product teams define dimensions and offerings, ingest measured usage, generate invoices, and manage customers (including parent-child hierarchies) and refunds. The API also exposes webhook and settings endpoints so integrations can keep downstream systems in sync. Authentication uses OAuth 2.0 client-credentials against auth.paigo.tech to mint a bearer JWT, which is then attached to every API call.

Use Cases

Patterns agents use Paigo API for, with concrete tasks.

★ Usage-Based Billing for an API Product

Wire a usage-based pricing model into an API product by defining a dimension (for example api_calls), creating an offering with tiered pricing, and ingesting usage events as customers consume the API. POST /usage carries the metered events; /offerings and /dimensions hold the pricing definition. Paigo aggregates usage and issues invoices automatically.

Create a dimension named 'api_calls', attach it to a tiered offering with $0.001 per call after a 10k free tier, and POST /usage daily for each customer

Parent-Child Customer Hierarchies

Bill an enterprise account where a parent organisation rolls up usage from multiple child entities. POST /customers/{customerId}/children/{childId} attaches a child to a parent so usage flows up the hierarchy and a single invoice covers the group. PUT and DELETE on the same path adjust the relationship as the customer's structure changes.

Attach customer 12345 (a subsidiary) as a child of customer 1000 (the parent) and confirm the next invoice rolls usage up to the parent

Refund and Invoice Adjustment

Issue a refund when a customer disputes a charge or service credit is owed. POST /customers/{customerId}/refunds creates a refund tied to the customer's invoice. Combined with read endpoints under /invoices, support agents can resolve a dispute, apply the refund, and confirm the adjustment is reflected on the next statement — all without leaving their tooling.

Read the most recent /invoices for customer 12345, then POST /customers/12345/refunds for $49 with reason 'service credit'

AI Agent Billing Operations

An AI agent uses Paigo via Jentic to answer billing questions and run routine ops. The agent searches Jentic by intent, loads the right schema, and calls Paigo through Jentic so the OAuth flow is handled centrally rather than in agent code. Useful for support assistants that need to look up invoices, ingest a missed usage batch, or apply a service credit.

Search Jentic for 'look up Paigo invoice', load the schema, and report the most recent invoice total for a named customer

Key Endpoints

48 endpoints — jentic publishes the only available openapi specification for paigo api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/usage

Ingest usage events

POST

/dimensions

Create a metered dimension

POST

/offerings

Create a pricing offering

POST

/customers

Create a customer

POST

/customers/{customerId}/children/{childId}

Attach a child customer to a parent

POST

/customers/{customerId}/refunds

Issue a refund for a customer

POST

/usage

Ingest usage events

POST

/dimensions

Create a metered dimension

POST

/offerings

Create a pricing offering

POST

/customers

Create a customer

POST

/customers/{customerId}/children/{childId}

Attach a child customer to a parent

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Paigo OAuth 2.0 client_id and client_secret are stored encrypted in the Jentic vault. Jentic exchanges them for a 24-hour JWT and refreshes automatically, so agents never touch the secret and never have to manage token expiry themselves.

Intent-based discovery

Agents search Jentic by intent — 'ingest Paigo usage events' or 'create a Paigo offering' — and Jentic returns the matching operation with its parameter schema, so the agent doesn't have to learn Paigo's resource hierarchy from scratch.

Time to first call

Direct Paigo integration: 2-3 days for OAuth flow, token refresh, dimension/offering modelling, and webhook handling. Through Jentic: under an hour — search, load, execute.

FAQs

Specific to using Paigo API through Jentic.

Why is there no official OpenAPI spec for Paigo API?

Paigo documents the API on docs.paigo.tech but does not publish a downloadable OpenAPI specification suitable for code generation. Jentic generates and maintains this spec so that AI agents and developers can call Paigo API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Paigo API use?

Paigo uses OAuth 2.0 client-credentials. You POST your `client_id` and `client_secret` to `https://auth.paigo.tech/oauth/token` with the audience set to the Paigo API gateway, receive a JWT bearer token valid for 24 hours, and attach it as `Authorization: Bearer <token>` on every API call. Jentic handles the token exchange and refresh so agents never see the client secret.

Can I ingest usage events with the Paigo API?

Yes — POST /usage is the primary ingestion endpoint. You send usage events tied to a customer and a dimension (defined under /dimensions). Paigo aggregates the events according to the offering's pricing rules and emits invoices on the configured cadence. For backfills, send historical events in batches rather than per-event.

What are the rate limits for the Paigo API?

Paigo does not publish fixed rate limits in the public spec. Treat /usage as the high-volume endpoint and batch events into single calls where possible. If you receive a 429 response, back off and retry — Paigo returns a Retry-After header on throttled responses.

How do I create a usage-based pricing model through Jentic?

Run `pip install jentic`, search for 'create a Paigo dimension', then for 'create a Paigo offering'. Create the dimension first (for example 'api_calls'), then the offering that prices it. Finally, search for 'ingest Paigo usage events' and call POST /usage as customers consume the metered resource. The OAuth token is handled by Jentic on every call.

Can I model parent-child customer relationships?

Yes — POST /customers/{customerId}/children/{childId} attaches a child to a parent so usage rolls up the hierarchy. PUT updates the relationship metadata and DELETE detaches the child. This is the right primitive when an enterprise customer wants a single invoice that covers multiple subsidiaries.

Docs Paigo Tech Paigo API

Connect the Paigo API to your agent

Capabilities

Start building with Paigo API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs