Manage billing information, payment methods, and invoices for your Aiven organization. Billing groups allow you to organize costs across multiple projects.
List billing groups
Retrieve all billing groups in your organization.
GET /v1/account/{account_id}/billing-group
Request example
curl -X GET "https://api.aiven.io/v1/account/YOUR_ACCOUNT_ID/billing-group" \
-H "Authorization: aivenv1 YOUR_TOKEN"
Response
List of billing group objects Currency code (e.g., USD, EUR)
Email addresses for billing notifications
VAT identification number
Payment method type: card, paypal, partner
Response example
{
"billing_groups" : [
{
"billing_group_id" : "588a8e63-fda7-4ff7-9bff-577debfee604" ,
"billing_group_name" : "Production" ,
"account_id" : "a225dad8d3c4" ,
"billing_currency" : "USD" ,
"billing_email" : [ "[email protected] " ],
"company" : "Example Inc" ,
"address_lines" : [ "123 Main St" ],
"city" : "San Francisco" ,
"state" : "CA" ,
"country_code" : "US" ,
"zip_code" : "94102" ,
"vat_id" : "" ,
"payment_method" : "card"
}
]
}
Get billing group details
Retrieve detailed information about a specific billing group.
GET /v1/billing-group/{billing_group_id}
Request example
curl -X GET "https://api.aiven.io/v1/billing-group/588a8e63-fda7-4ff7-9bff-577debfee604" \
-H "Authorization: aivenv1 YOUR_TOKEN"
Response
Detailed billing group information including assigned projects List of projects assigned to this billing group
Credit card information (if applicable)
Create billing group
Create a new billing group in your organization.
POST /v1/account/{account_id}/billing-group
Request body
Name for the billing group
Currency code (e.g., USD, EUR, GBP)
Email addresses for billing notifications
VAT identification number
Request example
curl -X POST "https://api.aiven.io/v1/account/YOUR_ACCOUNT_ID/billing-group" \
-H "Authorization: aivenv1 YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"billing_group_name": "Development Team",
"billing_currency": "USD",
"company": "Example Inc",
"billing_email": ["[email protected] "],
"city": "San Francisco",
"country_code": "US"
}'
Response
The newly created billing group object
Update billing group
Update billing group information.
PUT /v1/billing-group/{billing_group_id}
Request body
Accepts the same fields as create billing group.
Request example
curl -X PUT "https://api.aiven.io/v1/billing-group/588a8e63-fda7-4ff7-9bff-577debfee604" \
-H "Authorization: aivenv1 YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"billing_email": ["[email protected] ", "[email protected] "],
"vat_id": "GB123456789"
}'
Response
The updated billing group object
Assign project to billing group
Assign a project to a specific billing group.
PUT /v1/project/{project}
Request body
Billing group ID to assign the project to
Request example
curl -X PUT "https://api.aiven.io/v1/project/my-project" \
-H "Authorization: aivenv1 YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"billing_group_id": "588a8e63-fda7-4ff7-9bff-577debfee604"
}'
List invoices
Retrieve invoices for a billing group.
GET /v1/billing-group/{billing_group_id}/invoice
Request example
curl -X GET "https://api.aiven.io/v1/billing-group/588a8e63-fda7-4ff7-9bff-577debfee604/invoice" \
-H "Authorization: aivenv1 YOUR_TOKEN"
Response
List of invoice objects Billing period start date (ISO 8601)
Billing period end date (ISO 8601)
Invoice state: unpaid, paid, void, uncollectible
Total amount including VAT
Total amount excluding VAT
URL to download invoice PDF
Response example
{
"invoices" : [
{
"invoice_number" : "INV-2024-001234" ,
"period_begin" : "2024-02-01T00:00:00Z" ,
"period_end" : "2024-02-29T23:59:59Z" ,
"state" : "paid" ,
"currency" : "USD" ,
"total_inc_vat" : "1234.56" ,
"total_vat_zero" : "1234.56" ,
"download_url" : "https://api.aiven.io/v1/invoice/INV-2024-001234/download"
}
]
}
Get estimated costs
Retrieve current month’s estimated costs for a project.
GET /v1/project/{project}/estimate
Request example
curl -X GET "https://api.aiven.io/v1/project/my-project/estimate" \
-H "Authorization: aivenv1 YOUR_TOKEN"
Response
Estimated balance for the current billing period
Per-service cost breakdown
Response example
{
"estimated_balance" : "123.45" ,
"billing_currency" : "USD" ,
"services" : [
{
"service_name" : "pg-demo" ,
"service_type" : "pg" ,
"estimated_cost" : "45.67"
},
{
"service_name" : "kafka-prod" ,
"service_type" : "kafka" ,
"estimated_cost" : "77.78"
}
]
}
Available credits
Check available credits for an account.
GET /v1/account/{account_id}/credits
Request example
curl -X GET "https://api.aiven.io/v1/account/YOUR_ACCOUNT_ID/credits" \
-H "Authorization: aivenv1 YOUR_TOKEN"
Response
Currently available credits