API Overview

The GetPaidHQ API is a JSON REST API for customer, catalog, order, subscription, usage, invoice, payment, webhook, and dunning operations.

Base URL

https://api.getpaidhq.com

All product endpoints are under /api.

Authentication

curl https://api.getpaidhq.com/api/customers \
  -H "Authorization: Bearer YOUR_API_KEY"

Keep API keys on your server.

First request

curl https://api.getpaidhq.com/api/customers \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "customer@example.com",
    "first_name": "John",
    "last_name": "Doe"
  }'

Core model

• Organization - The tenant boundary. Auth scopes requests to one organization.
• Customer - The buyer. Customers can have stored payment methods, subscriptions, invoices, payments, and dunning history.
• Product - What you sell.
• Variant - A sellable version of a product.
• Price - The billing terms for a variant. Prices can be fixed or metered.
• Order - The checkout object. Completing an order activates recurring items as subscriptions.
• Subscription - The recurring billing lifecycle after an order completes.
• Meter - Defines how usage events aggregate for metered prices.

Response shape

Single-resource endpoints return the resource directly.

List endpoints return:

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

Amounts and dates

Amounts are in the currency's minor unit unless a field explicitly uses a decimal string. Dates use RFC 3339 timestamps.