API resources
Every resource group exposed by the Plugipay API, with a link to its per-resource page. Each per-resource page documents every endpoint with method, path, parameters, response shape, and error codes.
If you're new to the API, read Authentication and Conventions first — the per-resource pages assume you know them.
Core resources
| Resource | What |
|---|---|
| Customers | People who can pay you. Attached to payments and subscriptions. |
| Plans | Recurring offers. Templates that subscriptions reference. |
| Checkout sessions | One-time hosted payment intents. |
| Subscriptions | A customer's commitment to a plan. |
| Invoices | Receipts of money owed (subscription-generated or manual). |
| Refunds | Money returned to customers. |
| Receipts | Receipts of money received (auto-generated per payment). |
| Payouts | Settlements from Plugipay's balance to your bank. |
| Ledger | The chronological record of every financial entry. |
Identity & access
| Resource | What |
|---|---|
| Workspaces | Tenant containers. |
| API keys | HMAC credentials for server-to-server auth. |
Integrations
| Resource | What |
|---|---|
| Webhook endpoints | Where Plugipay POSTs event notifications. |
| Events | Queryable history of events (the same events that fire webhooks). |
| Portal sessions | Customer-facing self-serve billing portal links. |
| Adapters | Payment provider connections (Xendit, Midtrans, PayPal). |
Reading these pages
Each resource page follows the same shape:
- Overview — what the resource is, how it relates to others.
- Endpoints — one section per method (
Create,Retrieve,List,Update,Delete). - Per-endpoint — method + path, request parameters table, response example, error codes specific to this operation.
- The object — the full field reference for the resource.
- Events — which webhook events this resource produces.
Where to find things
- Code samples in your language? Each endpoint shows Node, Python, and Go side by side. For a deeper SDK reference, see SDKs.
- Webhook event types? Webhooks has the full catalog.
- Status codes and error codes? Errors.
- Rate limits per endpoint class? Rate limits.
- HMAC signing recipe? Authentication.
- Idempotency? Idempotency.
- The object identifier prefix table? Concepts.
Coverage notes
Some endpoints exist in the backend but aren't documented here because they're internal:
/v1/dashboard/*— the portal's own API for rendering dashboard views./v1/cron/*— internal cron triggers./v1/ingress/*— inbound provider webhooks (Xendit, Midtrans → Plugipay)./v1/huudis/*— OIDC session bridge./v1/admin/*— Plugipay platform admin operations.
If you need access to one of these, contact us — we can usually expose the relevant data via a documented endpoint instead.