Charges

Download schema

A charge details a gross usage or commitment.

List charges

GET

https://api.scaleway.com

/billing/v2beta1/charges

List charges for organizations or projects. You must specify at least organization_ids or project_ids.

List charges › query Parameters

organization_id

string · required

Organization ID to filter for, only charges for this organization will be returned.

order_by

string · enum

Sort order of charges in the response.

Enum values:

start_date_asc

start_date_desc

Default: start_date_asc

page_token

string

Token returned by previous call to list next paginated charges, omitted for first page.

page_size

integer · uint32

Number of charges to return per page.

start_date_after

string · date-time

Minimum start date of charges to filter for, defaults to the start of the billing period. (RFC 3339 format)

end_date_before

string · date-time

Maximum end date of charges to filter for, defaults to the end of the billing period. (RFC 3339 format)

invoice_ids

string[]

Invoice IDs to filter for, only charges from these invoices will be returned. (UUID format)

project_ids

string[]

Project IDs to filter for, only charges for these projects will be returned. (UUID format)

resource_ids

string[]

Resource IDs to filter for, only charges for these resources will be returned.

resource_names

string[]

Resource display names to filter for, only charges for these resources will be returned.

skus

string[]

SKU IDs to filter for, only charges for these SKUs will be returned.

clamp_to_time_range

boolean

Clamp charges to the requested time range.

List charges › Responses

200

scaleway.billing.v2beta1.ListChargesResponse

scaleway.billing.v2beta1.Charge[]

Paginated matching charges.

next_page_token

string

Page token to use with following call to keep listing charges if there are more.

GET/billing/v2beta1/charges

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/billing/v2beta1/charges?organization_id=string"

Example Responses

{
  "charges": [
    {
      "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "sku": "sku",
      "invoice_id": "6170692e-7363-616c-6577-61792e636f6d",
      "resource_id": "resource_id",
      "resource_name": "resource_name",
      "price": {
        "currency_code": "currency_code",
        "units": 0,
        "nanos": 0
      },
      "start_date": "2022-03-22T12:34:56.123456Z",
      "end_date": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z"
    }
  ],
  "next_page_token": "next_page_token"
}

json

application/json

List charges

GET

https://api.scaleway.com

/billing/v2beta1/charges

List charges for organizations or projects. You must specify at least organization_ids or project_ids.

List charges › query Parameters

organization_id

string · required

Organization ID to filter for, only charges for this organization will be returned.

order_by

string · enum

Sort order of charges in the response.

Enum values:

start_date_asc

start_date_desc

Default: start_date_asc

page_token

string

Token returned by previous call to list next paginated charges, omitted for first page.

page_size

integer · uint32

Number of charges to return per page.

start_date_after

string · date-time

Minimum start date of charges to filter for, defaults to the start of the billing period. (RFC 3339 format)

end_date_before

string · date-time

Maximum end date of charges to filter for, defaults to the end of the billing period. (RFC 3339 format)

invoice_ids

string[]

Invoice IDs to filter for, only charges from these invoices will be returned. (UUID format)

project_ids

string[]

Project IDs to filter for, only charges for these projects will be returned. (UUID format)

resource_ids

string[]

Resource IDs to filter for, only charges for these resources will be returned.

resource_names

string[]

Resource display names to filter for, only charges for these resources will be returned.

skus

string[]

SKU IDs to filter for, only charges for these SKUs will be returned.

clamp_to_time_range

boolean

Clamp charges to the requested time range.

List charges › Responses

200

scaleway.billing.v2beta1.ListChargesResponse

scaleway.billing.v2beta1.Charge[]

Paginated matching charges.

next_page_token

string

Page token to use with following call to keep listing charges if there are more.