Raw API Schema

You can download the complete OpenAPI specification that powers the VRP Billing API. The schema is shared between the dashboard, our SDKs, and this documentation site so that you always have an up-to-date contract for integrations.

Download

• YAML schema — ideal for human-friendly editing or use with tooling that understands OpenAPI YAML inputs.

Working with the Schema

Use the schema to generate strongly typed clients, perform contract testing, or validate requests and responses within your services. Popular options include:

• datamodel-code-generator for creating Python data classes.
• openapi-generator for generating API clients in more than 50 languages.
• spectral or similar linters to enforce additional quality rules.

When you automate against the schema, make sure you are always working with the latest version committed to this repository. We recommend pinning the documentation repository to a specific tag or commit and updating it as part of your release process.