Path parameters

• organization_id string Required

  Identifier for the organization

Query parameters

• from string

  A datetime for the beginning of the desired range for which to fetch costs. Defaults to start of current month.

• to string

  A datetime for the end of the desired range for which to fetch costs. Defaults to the current date.

Responses

• 200 application/json

  Top-level cost overview for the organization

  Hide response attributes Show response attributes object

  • costs object Required

    Costs overview for an organization. All of the costs, credits, trials are expressed in Elastic Consumption Unit (ECU).

    Hide costs attributes Show costs attributes object

    • total number(double) Required

      Total costs

    • dimensions array[object] Required

      A collection of billing details by dimension.

      Billing dimension

      Hide dimensions attributes Show dimensions attributes object

      • type string Required

        The type of the billing dimension

        Values are capacity, data_in, data_internode, data_out, storage_api, or storage_bytes.

      • cost number(double) Required

        The cost of the billing dimension

  • trials number(double) Required

    Trial costs for the organization

  • hourly_rate number(double) Required

    Hourly rate applied.

  • balance object

    The available balance for an organization

    Hide balance attributes Show balance attributes object

    • available number(double) Required

      Available balance

    • remaining number(double) Required

      Remaining balance

    • line_items array[object] Required

      A collection of order line items for for an organization

      Line Item

      Hide line_items attributes Show line_items attributes object

      • id string Required

        Line Item ID

      • ecu_quantity number(double) Required

        Original Elastic Consumption Unit (ECU) quantity

      • ecu_balance number(double) Required

        Elastic Consumption Unit (ECU) Balance

      • start string(date-time) Required

        Start of the line item's validity

      • end string(date-time) Required

        Expiration of the line item

• 400 application/json

  The specified date range is invalid. (code: costs.invalid_date_range)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is costs.invalid_date_range.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string Required

      A human readable message describing the error that occurred

    • fields array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields

• 403 application/json

  The current user does not have access to the requested organization. (code: organization.invalid_access)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is organization.invalid_access.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string Required

      A human readable message describing the error that occurred

    • fields array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields

• 404 application/json

  Organization not found. (code: organization.not_found)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is organization.not_found.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string Required

      A human readable message describing the error that occurred

    • fields array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields

• 500 application/json

  An error occurred when fetching an overview of the costs for the organization. (code: billing_service.failed_request)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is billing_service.failed_request.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string Required

      A human readable message describing the error that occurred

    • fields array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields