Developer resources
API documentation
This is the planned v1 API contract. Endpoints are not active until backend provisioning, authentication, rate limiting, and request logging are implemented. Do not send live credentials or payment details.
Availability: not yet enabled.
The examples below document intended resource shapes only; they are not live service responses.
The examples below document intended resource shapes only; they are not live service responses.
Authentication
When enabled, authenticate using a customer API key in the Authorization header. Never put keys in a browser app or public repository.
Authorization: Bearer <your_api_key>
Planned endpoints
- GET /api/v1/account — account and wallet summary.
- GET /api/v1/coupons — coupons assigned to the authenticated customer.
- POST /api/v1/coupons/redeem — atomically redeem an eligible coupon.
- POST /api/v1/orders — create an order only for an available service.
- GET /api/v1/orders/{id} — retrieve an owned order and its status.
- GET /api/v1/usage — inspect customer API usage and quota.
Errors and usage
The live API will return structured 4xx/5xx errors and enforce per-key rate limits. Retry-after and quota details will be documented when the server implementation is available.