On this page

    Credit Balances

    Use the Billing API to list the credit balances for a billing account.

    Credit-Balance Object
    {
      "balance": 10,
      "expireDate": 1644624000000
    }
    

    Attributes

    balance

    Double

    Remaining DCUs.


    expireDate

    Integer

    The number of milliseconds since UNIX epoch at which the credits will expire.


    Listing All Credit Balances for a Billing Account

    Lists the balances in DCUs for a billing account specified by its ID.

    List All Credit Balances for a Billing Account
    GET /v0/organizations/{organizationId}/billing/{id}/credits
    

    Parameters

    organizationId

    path

    String

    The UUID for the organization.


    id

    path

    String

    The UUID for the billing account.

    Example Request
    curl -X GET 'https://api.dremio.cloud/v0/organizations/3b4046f3-94c3-404b-85bb-f7deb8652a40/billing/cebe4692-498e-4c04-81ac-8ad04210ca9d/credits' \
    -H 'Authorization: Bearer <personal access token>' \
    -H 'Content-Type: application/json'
    
    Example Response
    {
      "data": [
        {
          "balance": 10,
          "expireDate": 1644624000000
        },
        {
          "balance": 23,
          "expireDate": 1644624000000
        },
        {
          "balance": 12,
          "expireDate": 1644624000000
        },
        {
          "balance": 9,
          "expireDate": 1644624000000
        },
        {
          "balance": 1,
          "expireDate": 1644624000000
        },
        {
          "balance": 303,
          "expireDate": 1644796800000
        },
        {
          "balance": 1000,
          "expireDate": 1675962138905
        }
      ]
    }
    

    Responses

    200

    Success.

    401

    User is not allowed to view the balance for this billing account.

    404

    No billing account with the provided ID was found.