Skip to main content

Billing Accounts

Use the Billing API to retrieve information about the billing accounts in an organization, to modify billing accounts, and to delete billing accounts.

Billing-Account Object
{
  "name": "account1",
  "id": "cebe4692-498e-4c04-81ac-8ad04210ca9d",
  "email": "user@company.com",
  "type": "INVOICE",
  "balance": 1006,
  "createdAt": 1644426138824,
  "createdBy": "3426883f-6968-4b1b-8f3c-c097be2afef3",
  "modifiedAt": 1644569952075,
  "modifiedBy": "678cc92c-01ed-4db3-9a28-d1f871042d9f"
}

Billing-Account Attributes​

{{< api-section file="data/api/billing.json" data="billingAccountAttributes" >}}

attributes​

{{< api-section file="data/api/billing.json" data="typeAttributes" >}}

Listing All Billing Accounts​

Returns a list of billing-account objects for the billing accounts for an organization specified by its ID.

List All Billing Accounts
GET /v0/organizations/{organizationId}/billing

Parameters​

{{< api-section file="data/api/billing.json" data="listAllAccountsParameters" >}}

Example Request
curl -X GET 'https://api.dremio.cloud/v0/organizations/3b4046f3-94c3-404b-85bb-f7deb8652a40/billing' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
Example Response
[
  {
    "name": "account38479",
    "id": "cebe4692-498e-4c04-81ac-8ad04210ca9d",
    "email": "user@company.com",
    "type": "INVOICE",
    "balance": 1006,
    "createdAt": 1644426138824,
    "createdBy": "3426883f-6968-4b1b-8f3c-c097be2afef3",
    "modifiedAt": 1644569952075,
    "modifiedBy": "678cc92c-01ed-4db3-9a28-d1f871042d9f"
  },
  {
    "name": "account42837",
    "id": "dfbg4602-498e-5e14-55ec-8aa04216cb0f",
    "email": "user@company.com",
    "type": "INVOICE",
    "balance": 989.07,
    "createdAt": 1644426139093,
    "createdBy": "3426883f-6968-4b1b-8f3c-c097be2afef3",
    "modifiedAt": 1644569954444,
    "modifiedBy": "678cc92c-01ed-4db3-9a28-d1f871042d9f"
  }
]

Responses​

{{< api-responses file="data/api/billing.json" data="listAllAccountsResponses" >}}

Retrieving a Billing Account​

Retrieves a billing-account object specified by its ID.

Retrieve a Billing Account
GET /v0/organizations/{organizationId}/billing/{id}

Parameters​

{{< api-section file="data/api/billing.json" data="retrieveAccountParameters" >}}

Example Request
curl -X GET 'https://api.dremio.cloud/v0/organizations/3b4046f3-94c3-404b-85bb-f7deb8652a40/billing/cebe4692-498e-4c04-81ac-8ad04210ca9d' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
Example Response
{
  "name": "account1",
  "id": "cebe4692-498e-4c04-81ac-8ad04210ca9d",
  "email": "user@company.com",
  "type": "INVOICE",
  "balance": 1006,
  "createdAt": 1644426138824,
  "createdBy": "3426883f-6968-4b1b-8f3c-c097be2afef3",
  "modifiedAt": 1644569952075,
  "modifiedBy": "678cc92c-01ed-4db3-9a28-d1f871042d9f"
}

Responses​

{{< api-responses file="data/api/billing.json" data="retrieveAccountResponses" >}}

Modifying a Billing Account​

Returns a modified billing-account object for a billing account specified by its ID. You can change the name of a billing account, the email associated with the billing account, or both.

Modify a Billing Account
PUT /v0/organizations/{organizationId}/billing/{id}

Parameters​

{{< api-section file="data/api/billing.json" data="modifyAccountParameters" >}}

Example Request
curl -X PUT 'https://api.dremio.cloud/v0/organizations/3b4046f3-94c3-404b-85bb-f7deb8652a40/billing/cebe4692-498e-4c04-81ac-8ad04210ca9d' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json' \
-d '{
  "name": "newAccountName",
  "email": "differentUser@company.com"
  }'
Example Response
{
  "name": "newAccountName",
  "id": "cebe4692-498e-4c04-81ac-8ad04210ca9d",
  "email": "differentUser@company.com",
  "type": "INVOICE",
  "balance": 1006,
  "createdAt": 1644426138824,
  "createdBy": "3426883f-6968-4b1b-8f3c-c097be2afef3",
  "modifiedAt": 1644605639932,
  "modifiedBy": "3426883f-6968-4b1b-8f3c-c097be2afef3"
}

Responses​

{{< api-responses file="data/api/billing.json" data="modifyAccountResponses" >}}

Deleting a Billing Account​

Deletes a billing account specified by its ID.

Delete a Billing Account
DELETE /v0/organizations/{organizationId}/billing/{id}

Parameters​

{{< api-section file="data/api/billing.json" data="deleteAccountParameters" >}}

Example Request
curl -X DELETE 'https://api.dremio.cloud/v0/organizations/3b4046f3-94c3-404b-85bb-f7deb8652a40/billing/cebe4692-498e-4c04-81ac-8ad04210ca9d' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
Example Response
No response

Responses​

{{< api-responses file="data/api/billing.json" data="deleteAccountResponses" >}}