Developer Guide
Short integration pointers for building on GetPaidHQ.
Start with the API reference when you need exact request and response shapes. This section links to implementation-focused guides.
Authentication
Bearer API keys and public routes
Catalog
Model products, variants, prices, and meters
Subscriptions & Orders
Create recurring billing through checkout orders
Usage & Metering
Metered usage ingestion
Dunning Recovery
Connect failed-payment recovery to your app
Webhooks
Outbound subscriptions and provider webhook receiver
API Reference
Current endpoint reference
Common sequence
- Create products, variants, and prices.
- Create or reuse a customer.
- Store a reusable payment token if the subscription will auto-renew.
- Create and complete an order.
- Use webhooks or polling to react to billing events.
- Send usage events for metered prices.