Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qovery Billing API

The Billing API from Qovery — 14 operation(s) for billing.

Qovery Billing API is one of 94 APIs that Qovery publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Billing. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, authentication docs, and rate-limit docs.

This API exposes 16 operations across 14 paths, and defines 24 schemas. It is described by OpenAPI 3.0.0, at version 1.0.4.

Requests are made against a single base URL, https://api.qovery.com.

16 operations 14 paths 24 schemas 1 DELETE9 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.4
Base URL
https://api.qovery.com
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Qovery Billing API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • bearerAuth — JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' cu…
  • ApiKeyAuth — Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Curl Example ' curl https://console.qovery.com/organization -…

Paths & Operations 16

Across 14 paths, the API surfaces 16 operations — 1 DELETE, 9 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Billing 16
GET
/organization/{organizationId}/currentCost
Get organization current cost
getOrganizationCurrentCost 1 param → 200401403404
POST
/organization/{organizationId}/creditCode
Add credit code
addCreditCode 1 param body → 200400401403404
POST
/organization/{organizationId}/changePlan
Change organization plan
changePlan 1 param body → 200400401403404
GET
/organization/{organizationId}/cluster/{clusterId}/currentCost
Get cluster current cost
getClusterCurrentCost 2 params → 200401403404
GET
/organization/{organizationId}/billingInfo
Get organization billing info
getOrganizationBillingInfo 1 param → 200401403404
PUT
/organization/{organizationId}/billingInfo
Edit Organization Billing Info
editOrganizationBillingInfo 1 param body → 200400401403404
GET
/organization/{organizationId}/billingStatus
Get organization billing status
getOrganizationBillingStatus 1 param → 200401403404
POST
/organization/{organizationId}/billingUsageReport
Generate organization billing usage report
generateBillingUsageReport 1 param body → 200400401403404
GET
/organization/{organizationId}/billingExternalId
Get organization billing external ID
getOrganizationBillingExternalId 1 param → 200401403404
GET
/organization/{organizationId}/invoice
List organization invoices
listOrganizationInvoice 1 param → 200401403404
GET
/organization/{organizationId}/invoice/{invoiceId}
Get organization invoice
getOrganizationInvoice 2 params → 200401403404
GET
/organization/{organizationId}/invoice/{invoiceId}/download
Get invoice link
getOrganizationInvoicePDF 2 params → 200401403404
POST
/organization/{organizationId}/downloadInvoices
Download all invoices
organizationDownloadAllInvoices 1 param → 202401403404
GET
/organization/{organizationId}/creditCard
List organization credit cards
listOrganizationCreditCards 1 param → 200401403404
POST
/organization/{organizationId}/creditCard
Add credit card
addCreditCard 1 param body → 201400401403404
DELETE
/organization/{organizationId}/creditCard/{creditCardId}
Delete credit card
deleteCreditCard 2 params → 204401403404

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are BillingInfoRequest (10 properties), BillingInfo (10 properties), OrganizationRequest (8 properties), CreditCard (7 properties). Each schema is shown below with its type and property counts.

BillingInfoRequest
object
10 properties 7 required
InvoiceStatusEnum
string
Link
object
7 properties 7 required
Invoice
CreditCard
object
7 properties 7 required
OrganizationRequest
object
8 properties 2 required
BillingInfo
object
10 properties
OrganizationCurrentCost
CurrentCost
object
4 properties
BillingExternalId
object
1 property
ServiceTypeEnum
string
type of the service (application, database, job, ...)
OrganizationBillingUsageReportResponse
object
2 properties
CreditCardResponseList
object
1 property
OrganizationCreditCodeRequest
object
1 property
CreditCardRequest
object
5 properties 4 required
InvoiceResponseList
object
1 property
CostRange
object
5 properties 3 required
OrganizationChangePlanRequest
object
1 property
Cost
object
3 properties 3 required
PlanEnum
string
FREE, BUSINESS & PROFESSIONAL are deprecated. 2025 plans are the new plans available.
BillingStatus
object
2 properties
OrganizationBillingUsageReportRequest
object
3 properties 3 required
Base
object
3 properties 2 required
Organization

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-billing-api-openapi.yml Raw ↑

Other APIs Qovery publishes across the network.

Qovery Account Info API
Qovery Alert Receivers API
Qovery Alert Rules API
Qovery Application Actions API
Qovery Application Configuration API
Qovery Application Custom Domain API
Qovery Application Deployment History API
Qovery Application Deployment Restriction API
Qovery Application Environment Variable API
Qovery Application Logs API
Qovery Application Main Calls API
Qovery Application Secret API