API Reference
This section provides detailed, structured documentation for every public API endpoint offered by Gale. It includes request formats, response payloads, authentication requirements, and usage examples for each supported operation.Authentication
All endpoints require a valid API token passed in theAuthorization
header:
Testing and Environments
Use the sandbox environment for development and testing:Best Practices
- Use unique
Idempotency-Key
values for all POST/PUT operations. - Handle
429 Too Many Requests
errors by implementing backoff logic. - Validate webhook signatures before processing events.
Start Exploring API Endpoints
Products
Create, list, update, delete, and check HSA/FSA eligibility for every item.
Checkout
Create hosted checkouts, fetch status, refund, or cancel a session.
Webhooks
Receive real-time events for checkout status and product-eligibility changes.
Subscription Plans
Create recurring-billing plans and attach one or many to your products.