Skip to content

API Explorer

The interactive API Explorer lets you experiment with requests against both sandbox and live environments. Use it to:

  • Inspect each endpoint's request and response schema.
  • Quickly try requests with your own credentials.
  • Share reproducible examples with teammates when debugging.

Accessing the Explorer

The Explorer is bundled with the VRP Billing service and is available at /api/docs/ when you run the application locally or deploy it to your environments. For example:

# Local development via Docker Compose
make up
# Then open http://localhost:8000/api/docs/

In production, append /api/docs/ to the base URL of your deployment. The Explorer will require an authenticated session in the same way as other dashboard features.

Tips for Using the Explorer

  • Start with the Schemas panel to understand which fields are required and what data types are accepted.
  • Use the Try it out controls to send requests with sample data, then refine the payloads before integrating in code.
  • Copy generated curl commands to create regression tests or Postman collections.
  • Review the response headers to learn about pagination cursors and rate limiting metadata.

If you encounter any issues, contact the VRP Billing team through the usual support channels so we can help you get unblocked quickly.