Distributor organization

Provisioning and lifecycle management of end-customer organizations for members of the Exoscale distributor program.

POST /distributor/organization

Create an Organization linked to your Distributor Organization.

Request body

Content-Type: application/json

Property	Type	Required	Description
`billing-address`	object	yes	ISO 20022 Structured Billing Address schema details
`display-name`	string	yes	Organization Display Name
`owner-email`	string	yes	Email Address of the first Owner
`client-id`	string	no	Organization Client ID

Example

{
  "billing-address": {
    "address": "string",
    "building-number": "string",
    "city": "string",
    "country": "string",
    "name": "string",
    "postal-code": "string",
    "street-name": "string"
  },
  "client-id": "string",
  "display-name": "string",
  "owner-email": "string"
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`billing-address`	object	ISO 20022 Structured Billing Address schema details
`client-id`	string	Organization Client ID
`id`	string	Organization ID
`status`	string	Organization Status Allowed values: `suspended`, `active`, `terminated`.

Example output

{
  "billing-address": {
    "address": "string",
    "building-number": "string",
    "city": "string",
    "country": "string",
    "name": "string",
    "postal-code": "string",
    "street-name": "string"
  },
  "client-id": "string",
  "id": "string",
  "status": "suspended"
}

SDK reference for create-distributor-organization: golang | Python | Java

CLI: exo api create-distributor-organization

get-distributor-organization

GET /distributor/organization/{id}

Get an Organization linked to your Distributor Organization.

Path parameters

Name	In	Description
`id`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`billing-address`	object	ISO 20022 Structured Billing Address schema details
`client-id`	string	Organization Client ID
`id`	string	Organization ID
`status`	string	Organization Status Allowed values: `suspended`, `active`, `terminated`.

Example output

{
  "billing-address": {
    "address": "string",
    "building-number": "string",
    "city": "string",
    "country": "string",
    "name": "string",
    "postal-code": "string",
    "street-name": "string"
  },
  "client-id": "string",
  "id": "string",
  "status": "suspended"
}

SDK reference for get-distributor-organization: golang | Python | Java

CLI: exo api get-distributor-organization

Other Operations

activate-distributor-organization

PUT /distributor/organization/{id}:activate

Activate an Organization linked to your Distributor Organization.

Path parameters

Name	In	Description
`id`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`billing-address`	object	ISO 20022 Structured Billing Address schema details
`client-id`	string	Organization Client ID
`id`	string	Organization ID
`status`	string	Organization Status Allowed values: `suspended`, `active`, `terminated`.

Example output

{
  "billing-address": {
    "address": "string",
    "building-number": "string",
    "city": "string",
    "country": "string",
    "name": "string",
    "postal-code": "string",
    "street-name": "string"
  },
  "client-id": "string",
  "id": "string",
  "status": "suspended"
}

SDK reference for activate-distributor-organization: golang | Python | Java

CLI: exo api activate-distributor-organization

list-distributor-organization-usage

GET /distributor/organization/{id}/usage

List usage records of a sub-Organization.

Path parameters

Name	In	Description
`id`	`path`

Query parameters

Name	In	Required	Description
`period`	`query`	no

Responses

Status: 200 - 200

Content-Type: application/json

Example output

[
  {
    "code": "string",
    "currency": "string",
    "end-date": "2024-01-01T12:00:00Z",
    "start-date": "2024-01-01T12:00:00Z",
    "total-excl-vat": 0,
    "total-incl-vat": 0,
    "usage": [
      {
        "description": "string",
        "product": "string",
        "quantity": 0,
        "total-excl-vat": 0,
        "total-incl-vat": 0,
        "unit": "string",
        "variable": "string"
      }
    ]
  }
]

SDK reference for list-distributor-organization-usage: golang | Python | Java

CLI: exo api list-distributor-organization-usage

list-distributor-organizations

GET /distributor/organization

List Organizations linked to your Distributor Organization.

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`organizations`	array[object]	The list of organizations. schema details

Example output

{
  "organizations": [
    {
      "billing-address": {
        "address": "string",
        "building-number": "string",
        "city": "string",
        "country": "string",
        "name": "string",
        "postal-code": "string",
        "street-name": "string"
      },
      "client-id": "string",
      "id": "string",
      "status": "suspended"
    }
  ]
}

SDK reference for list-distributor-organizations: golang | Python | Java

CLI: exo api list-distributor-organizations

schedule-purge-distributor-organization

PUT /distributor/organization/{id}:schedule-purge

Schedule the purge of an Organization linked to your Distributor Organization.

Path parameters

Name	In	Description
`id`	`path`

Responses

200: 200

Content-Type: application/json

Property	Type	Description
`message`	string	The message indicating that the Organization has been successfully purged.

Example output

{
  "message": "string"
}

202: 202

Content-Type: application/json

Property	Type	Description
`message`	string	The message indicating that the Organization has been successfully scheduled to be purged.

Example output

{
  "message": "string"
}

SDK reference for schedule-purge-distributor-organization: golang | Python | Java

CLI: exo api schedule-purge-distributor-organization

suspend-distributor-organization

PUT /distributor/organization/{id}:suspend

Suspend an Organization linked to your Distributor Organization.

Path parameters

Name	In	Description
`id`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`billing-address`	object	ISO 20022 Structured Billing Address schema details
`client-id`	string	Organization Client ID
`id`	string	Organization ID
`status`	string	Organization Status Allowed values: `suspended`, `active`, `terminated`.

Example output

{
  "billing-address": {
    "address": "string",
    "building-number": "string",
    "city": "string",
    "country": "string",
    "name": "string",
    "postal-code": "string",
    "street-name": "string"
  },
  "client-id": "string",
  "id": "string",
  "status": "suspended"
}

SDK reference for suspend-distributor-organization: golang | Python | Java

CLI: exo api suspend-distributor-organization

terminate-distributor-organization

DELETE /distributor/organization/{id}:terminate

Terminate an Organization linked to your Distributor Organization.

Path parameters

Name	In	Description
`id`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`message`	string	The message indicating that the Organization has been successfully terminated.

Example output

{
  "message": "string"
}

SDK reference for terminate-distributor-organization: golang | Python | Java

CLI: exo api terminate-distributor-organization

Last updated on February 3, 2026