REST API

Billing spans the customer API (/api/v1/user/billing, user JWT + active workspace), the Paymob payment webhook (/api/v1/webhooks/paymob, public), and the platform AI-pricing admin (/api/v1/admin/ai-pricing, super-admin).

Every endpoint below is a direct link into the interactive API reference — click it to see the full request/response schema and try the call live.

Billing

• GET /user/billing/addons — The global catalog of purchasable add-ons (the buy options for the billing
• POST /user/billing/addons — Single purchase endpoint. Routes by the catalog item's billing mode:
• DELETE /user/billing/addons/{addon_slug}
• GET /user/billing/invoices/{reference}/pdf — Download a single invoice as a branded PDF.
• GET /user/billing/invoices — Paginated invoice / payment history for the workspace, newest first.
• GET /user/billing/usage — Single usage snapshot for the current month: effective limits + consumed
• GET /user/billing/payment-status — Live payment status for a checkout payment_id (the id Paymob hands back on the
• POST /user/billing/change-plan
• POST /user/billing/cancel
• POST /webhooks/paymob
• GET /admin/ai-pricing/models
• PUT /admin/ai-pricing/models
• GET /admin/ai-pricing/credit-setting
• PUT /admin/ai-pricing/credit-setting
• GET /admin/ai-pricing/ledger

Next

Frontend Integration · Examples