API Reference
Functional reference by domain for the Beacon public API.
reference • updated 2026-03-15
How to use this reference
The reference is organized by functional domain to reduce discovery time and align ownership by team.
Endpoint groups
- Billing API: subscriptions, checkout, and customer portal.
- Stripe Connect API: account onboarding and refresh cycles.
- Webhooks API: event ingestion, signature validation, and replay.
- Fiscal API: documents, reconciliation, and setup state.
- Observability API: health, metrics, and operational alerts.
Global conventions
| Topic | Rule |
|---|---|
| Authentication | Authorization: Bearer <access_token> |
| Idempotency | Idempotency-Key is recommended for mutating operations |
| Versioning | Route prefix uses /v1 |
| Errors | Payload includes code, message, and request_id |
OpenAPI
Use OpenAPI spec to consume the partial contract and prepare for tools such as Scalar/Redoc.