{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-openapi.bundled.yaml","sidebar":"sidebar-sidebars.yaml"},"props":{"definitionId":"openapi.bundled.yaml","dynamicMarkdocComponents":[],"baseSlug":"/openapi.bundled","seo":{"title":"BillRun REST API"},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"BillRun REST API","description":"BillRun exposes three families of HTTP endpoints:\n\n- `/billapi/{collection}/{action}` - the modern entity API (CRUD + lifecycle\n  actions on accounts, subscribers, plans, services, rates, balances, bills,\n  discounts, charges, taxes, users, reports, etc).\n- `/api/{action}` - the legacy action API used for one-off operations such as\n  credit, payment, refunds, reports, subscribers lookup, and admin tasks.\n- `/realtime` - the realtime rating/charging endpoint used by network\n  elements (OCS-style start / update / release events).\n\nAuthentication is one of:\n\n- Session cookie obtained via `POST /auth/login`.\n- OAuth2 access token issued by `POST /oauth2/token`.\n- Per-request signature using a shared secret (the `signature` parameter)\n  for machine-to-machine integrations.\n\nSee [docs.bill.run](https://docs.bill.run/en/api/security) for the\nauthoritative behavior documentation; this OpenAPI document mirrors that\ninterface.\n","summary":"Open-source billing & rating platform - REST API reference."},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"api.bill.run","port":4000,"ipAddress":"216.73.216.45"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"main"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/openapi.bundled","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}