API Documentation
Interactive reference powered by the Example OpenAPI spec.
Payments API
Interactive API Documentation
Browse endpoints, inspect request/response schemas, and send test calls with environment-aware authentication. Every request is instrumented so your team can trace adoption.
- Collection-level variables for sandbox vs. production
- Inline `curl` snippets and language-specific examples
- "Copy as JSON" and response diffing for rapid iteration
Live API Playground
Test requests in real-time
POST /v1/invoices
curl https://api.example-payments.test/v1/invoices \
-H "Authorization: Bearer sandbox_123" \
-d '{ "customer_id": "cus_001", "total": 4200 }'Demo requests run against a safe sandbox environment so evaluators can experiment without risking production data.
Guides & Tutorials
Curated walkthroughs that turn requests into real workflows.
Launch your first request
Authenticate with a sandbox API key, create a customer, and issue a test invoice in under five minutes.
Resilient webhook retries
Build idempotent handlers with retry-safe payloads, recommended exponential backoff, and sample failure recovery flows.
Meter usage without drift
Stream usage events with guardrails for duplicate detection, proration, and analytics-ready reporting.
Changelog
Celebrate the improvements your team ships week over week.
Usage-based billing beta
Preview endpoints for real-time consumption tracking, plus new POST /v1/meters and GET /v1/meters/{id} resources to query balances.
Invoice workflow upgrades
Auto-reconcile failed payments, resend invoice emails on demand, and expose payment status webhooks in the dashboard.
Sandbox polish & sample data
Sandbox accounts now boot with live-like customers, payment methods, and downloadable PDF invoices for quick demos.