Discounts

Download schema

List all discounts for an organization and usable categories/products/offers/references/regions/zones where the discount can be applied.

List all user's discounts

GET

https://api.scaleway.com

/billing/v2alpha1/discounts

List all discounts for an organization and usable categories/products/offers/references/regions/zones where the discount can be applied.

List all user's discounts › query Parameters

order_by

string · enum

Order discounts in the response by their description.

Enum values:

creation_date_desc

creation_date_asc

start_date_desc

start_date_asc

stop_date_desc

stop_date_asc

Default: creation_date_desc

page

integer · int32

Positive integer to choose the page to return.

page_size

integer · uint32

Positive integer lower or equal to 100 to select the number of items to return.

organization_id

string

ID of the organization. (UUID format)

List all user's discounts › Responses

200

scaleway.billing.v2alpha1.ListDiscountsResponse

total_count

integer · uint64

Total number of discounts.

scaleway.billing.v2alpha1.Discount[]

Paginated returned discounts.

GET/billing/v2alpha1/discounts

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/billing/v2alpha1/discounts"

Example Responses

{
  "total_count": 0,
  "discounts": [
    {
      "id": "id",
      "creation_date": "2022-03-22T12:34:56.123456Z",
      "organization_id": "organization_id",
      "description": "description",
      "value": 0,
      "value_used": 0,
      "value_remaining": 0,
      "mode": "unknown_discount_mode",
      "start_date": "2022-03-22T12:34:56.123456Z",
      "stop_date": "2022-03-22T12:34:56.123456Z",
      "coupon": {
        "description": "description"
      },
      "filters": [
        {
          "type": "unknown_type",
          "value": "value",
          "exclude": true
        }
      ]
    }
  ]
}

json

application/json

Invoices

List all user's discounts

GET

https://api.scaleway.com

/billing/v2alpha1/discounts

List all discounts for an organization and usable categories/products/offers/references/regions/zones where the discount can be applied.

List all user's discounts › query Parameters

order_by

string · enum

Order discounts in the response by their description.

Enum values:

creation_date_desc

creation_date_asc

start_date_desc

start_date_asc

stop_date_desc

stop_date_asc

Default: creation_date_desc

page

integer · int32

Positive integer to choose the page to return.

page_size

integer · uint32

Positive integer lower or equal to 100 to select the number of items to return.

organization_id

string

ID of the organization. (UUID format)

List all user's discounts › Responses

200

scaleway.billing.v2alpha1.ListDiscountsResponse

total_count

integer · uint64

Total number of discounts.

scaleway.billing.v2alpha1.Discount[]

Paginated returned discounts.