Billing API

Introduction

Scaleway's Billing API provides a quick overview of your cloud consumption and allows you to monitor expenses. Public cloud services follow a 'pay as you go' model, ensuring you pay only for what you use. Some products offer plan options. Your monthly invoice, calculated at month-end based on exact resource usage and may include additional invoices for upfront payments during the month.

Concepts and pricing

Scaleway products offer different billing models, with billing cycles by the minute, hour, month or year. For a clear estimate of product prices, visit our pricing page. You'll also find a cost estimator for each product in the console when you order a resource.

Money type

All fields referencing money across Scaleway API are represented with a common Money definition - AKA Money type.

The gRPC google.type.Money type is used to represent amounts of money with their currency type.

The Money type is defined by Google as such:

// Represents an amount of money with its currency type.
message Money {
  // The three-letter currency code defined in ISO 4217.
  string currency_code = 1;
  // The whole units of the amount.
  // For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
  int64 units = 2;
  // Number of nano (10^-9) units of the amount.
  // The value must be between -999,999,999 and +999,999,999 inclusive.
  // If `units` is positive, `nanos` must be positive or zero.
  // If `units` is zero, `nanos` can be positive, zero, or negative.
  // If `units` is negative, `nanos` must be negative or zero.
  // For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
  int32 nanos = 3;
}

Quickstart

1. Configure your environment variables.

   Note

   This is an optional step that aims at simplifying your usage of the API.

   export SCW_SECRET_KEY="<API secret key>"
   export SCW_ORGANIZATION_ID="<Scaleway Organization ID>"
   

2. Run the following command to obtain your consumption over the current month.

   curl -X GET \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     -H "Content-Type: application/json" \
     "https://api.scaleway.com/billing/v2beta1/consumptions?organization_id=$SCW_ORGANIZATION_ID"
   

3. Run the following command to obtain your consumption over the current month for just one category of products.

   Specify the target category_name as one of:

   • BareMetal
   • Compute
   • Containers
   • Labs
   • Managed Databases
   • Managed Services
   • Network
   • Object Storage
   • Observability
   • Security and Identity
   • Serverless
   • Storage
   • Subscription

   curl -X GET \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     -H "Content-Type: application/json" \
     "https://api.scaleway.com/billing/v2beta1/consumptions?organization_id=$SCW_ORGANIZATION_ID&category_name=Compute"
   

4. Run the following command to obtain your consumption for a specific month.

   Specify the target billing period as YYYY-MM, e.g. 2023-11.

   curl -X GET \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     -H "Content-Type: application/json" \
     "https://api.scaleway.com/billing/v2beta1/consumptions?organization_id=$SCW_ORGANIZATION_ID&billing_period=2023-11"
   

5. Run the following command to obtain your consumption for a specific project only.

   First, choose your target project_id:

   export SCW_PROJECT_ID="<Scaleway Project ID>"
   

   Then inject it in your API request:

   curl -X GET \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     -H "Content-Type: application/json" \
     "https://api.scaleway.com/billing/v2beta1/consumptions?project_id=SCW_PROJECT_ID"
   

Technical Information

IAM requirements

Keep in mind that:

• You must have appropriate IAM permissions to manage billing. If you are the Owner of the Organization, you will automatically have these permissions. Otherwise, you will need a policy giving you the BillingManager permission set. If you were previously a Billing Administrator, you will automatically have been migrated to the BillingAdministrator group when you activated IAM, which gives you the appropriate permissions.
• You only need BillingReadOnly permissions to query consumption. ​

Going further

​ For more help using Scaleway’s Billing API, check out the following resources: ​

• Our main documentation
• Our Slack Community
• Our support ticketing system.