Get rated usage summary¶

Aggregate rated usage by billing period, hour, day, or month, grouped by meter, workspace, and record status.

GET https://billing.moi.matrixorigin.cn/api/v1/billing/accounts/$ACCOUNT_ID/usage-summary

Before you begin¶

Prepare a valid personal access token for the account owner.
Call List current accounts to obtain the target account’s ID.

Request example¶

Replace $MOI_PERSONAL_ACCESS_TOKEN and $ACCOUNT_ID in the example with your personal access token and the selected account’s ID.

curl -X GET \
  "https://billing.moi.matrixorigin.cn/api/v1/billing/accounts/$ACCOUNT_ID/usage-summary?granularity=period" \
  -H "X-API-Key: $MOI_PERSONAL_ACCESS_TOKEN"

Path parameters¶

Parameter	Type	Required	Description
`accountID`	string	Yes	Target account ID from `items[].billing_account_id` in the List current accounts response.

Query parameters¶

Parameter	Type	Required	Description
`from`	string	No	Inclusive start by record creation time; accepts RFC 3339, `YYYY-MM-DD`, or Unix seconds as a string. Defaults to the start of the last 30 days, including today.
`to`	string	No	Exclusive end by record creation time. A date-only value expands to midnight after that date. Defaults to tomorrow at midnight in the billing time zone.
`timezone`	string	No	IANA time zone; defaults to the billing time zone for the account region.
`granularity`	string	No	Time granularity: period, hour, day, or month; defaults to period.
`period_granularity`	string	No	Alias used only when granularity is empty.
`period`	string	No	Filter by posting period in `YYYY-MM` format.
`meter_code`	string	No	Filter by meter code.
`billing_item_code`	string	No	Filter by billing item code; when combined with `meter_code`, both must match the same meter.
`workspace_id`	string	No	Filter by the workspace of the usage event.
`status`	string	No	Filter by usage record status; use charged for charged records. Omitted means no status filter.
`subject_type`	string	No	Filter by account owner type.
`subject_id`	string	No	Filter by account owner ID.
`q`	string	No	Case-insensitive search over rated record ID, usage event ID, meter code, or event key.
`search`	string	No	Alias for q, used only when q is empty.

Successful response¶

Returns HTTP 200 with usage and charges aggregated at the selected time granularity.

Response example

{
  "items": [
    {
      "bucket_start": "2026-09-01T00:00:00+08:00",
      "bucket_end": "2026-10-01T00:00:00+08:00",
      "bucket_start_unix": 1788192000,
      "bucket_end_unix": 1790784000,
      "period": "2026-09",
      "meter_code": "meter_example",
      "billing_item_code": "meter_example",
      "billing_item_display_name": "Example usage",
      "unit": "token",
      "status": "charged",
      "quantity": "1000",
      "gross_credit": "1.000000000000",
      "discount_credit": "0.100000000000",
      "net_credit": "0.900000000000",
      "source_record_ids": [
        "rated_record_example"
      ],
      "source_record_count": 1
    }
  ],
  "total_credit": "0.900000000000",
  "granularity": "period",
  "timezone": "Asia/Shanghai",
  "from": "2026-09-01T00:00:00+08:00",
  "to": "2026-10-01T00:00:00+08:00"
}

Fields

Field	Type	Description
`items`	array of object	Aggregated results.
`items[].bucket_start`	string	Bucket start in RFC 3339 format.
`items[].bucket_end`	string	Exclusive bucket end.
`items[].bucket_start_unix`	integer	Bucket start in Unix seconds.
`items[].bucket_end_unix`	integer	Bucket end in Unix seconds.
`items[].period`	string	Usage period in `YYYY-MM` format.
`items[].meter_code`	string	Meter code.
`items[].billing_item_code`	string	Billing item code.
`items[].billing_item_display_name`	string	Billing item display name.
`items[].unit`	string	Usage unit.
`items[].workspace_id`	string	Workspace ID; may be omitted when no workspace is associated.
`items[].status`	string	Status of the aggregated usage records.
`items[].quantity`	string	Usage quantity in the billing item’s unit.
`items[].gross_credit`	string	Gross charge in Credit.
`items[].discount_credit`	string	Discount in Credit.
`items[].net_credit`	string	Net charge in Credit.
`items[].source_record_ids`	array of string	Rated usage record IDs included in the aggregate.
`items[].source_record_count`	integer	Number of records included in the aggregate.
`total_credit`	string	Sum of returned net charges in Credit.
`granularity`	string	Applied time granularity.
`timezone`	string	Applied IANA time zone.
`from`	string	Inclusive query start.
`to`	string	Exclusive query end.

In field paths, [] denotes each array item. For example, items[].bucket_start refers to the corresponding field in each item.

Error response¶

An unsupported time granularity returns HTTP 400; correct the query parameters.

Response example

{
  "code": "invalid_request",
  "message": "invalid request",
  "error": "invalid request"
}

Fields

Field	Type	Description
`code`	string	Error code.
`message`	string	Error message.
`error`	string	Compatibility error message, with the same content as message.

Last updated on Sep 15, 2026