API Reference

The API is mounted under /api.

https://api.getpaidhq.com/api

Authenticate with a bearer API key:

Authorization: Bearer YOUR_API_KEY

Start Here

API base path, core objects, and request shape

Bearer API keys and access rules

List response format and query parameters

Error response format and common status codes

Create and read customers; attach payment methods

Products, variants, prices, and meters

Create orders and activate subscriptions

Ingest metered usage and read current-period totals

Manage webhook endpoints

Campaigns, attempts, configurations, and payment tokens

System-level explanations are in Documentation.

List responses use:

{
  "data": [],
  "meta": { "total": 0, "page": 0, "limit": 10 }
}

See Pagination and Errors for shared behavior.