REST API
API Keys
Use the REST API to manage QR codes, payments, subscriptions, refunds, additional charges, checkout sessions, customer portal sessions, and customers. Bearer API key required. Common errors: 400 validation, 401 invalid key, 403 plan limits (errors.plan.feature_not_available or errors.plan.premium_or_enterprise_required), 404 not found, 409 conflicts, 429 rate limit. Lists use limit and offset.
REST API
REST API
Use the REST API to manage QR codes, payments, subscriptions, refunds, additional charges, checkout sessions, customer portal sessions, and customers. Bearer API key required. Common errors: 400 validation, 401 invalid key, 403 plan limits (errors.plan.feature_not_available or errors.plan.premium_or_enterprise_required), 404 not found, 409 conflicts, 429 rate limit. Lists use limit and offset.
1. Get your API key
Create an API key in the API Keys section.
2. Send it in every request
Include your key in the Authorization header on every request.
Authorization: Bearer YOUR_API_KEY3. Choose an endpoint
Select an endpoint from the menu on the left to view request and response documentation.