API Reference
Reference for the current GetPaidHQ REST API.
The API is mounted under /api.
https://api.getpaidhq.com/apiAuthenticate with a bearer API key:
Authorization: Bearer YOUR_API_KEYStart Here
Overview
API base path, core objects, and request shape
Authentication
Bearer API keys and access rules
Pagination
List response format and query parameters
Errors
Error response format and common status codes
Core Resources
Customers
Create and read customers; attach payment methods
Catalog
Products, variants, prices, and meters
Orders & Checkout
Create orders and activate subscriptions
Usage Records
Ingest metered usage and read current-period totals
Webhooks
Manage webhook endpoints
Dunning
Campaigns, attempts, configurations, and payment tokens
System Docs
System-level explanations are in Documentation.
List responses use:
{
"data": [],
"meta": { "total": 0, "page": 0, "limit": 10 }
}See Pagination and Errors for shared behavior.