SPsparkvault
billing

Read the usage ledger

Changed on

A page of the account's usage ledger, newest first, with the filters applied to that page: a filtered page can hold fewer entries than limit, or none, while has_more is true. Page with cursor until it is false.

get/billing/transactions

Request

Query parameters

limitinteger

A page-size hint: a value above 1000 reads as 1000, and a missing, zero, negative or non-numeric one as 1000.

cursorstring

The next_cursor a previous page returned, with the same start_date, end_date, type and category. Opaque, and sealed to the query that issued it.

typestring

Only entries of this type (e.g. spark_create). Ignored with a YYYY-MM-DD start_date.

categorystring

Only entries counted under this usage category, as GET /billing/summaries names it.

start_datestring

The range's start: a Unix timestamp, or a YYYY-MM-DD date (UTC).

end_datestring date

The range's last day (YYYY-MM-DD, UTC), with a YYYY-MM-DD start_date only. Omitted: the start's day.

Response

A page of the ledger.

Changes

  • a9a10e328ba5Revision changes
    • info

      added the new optional query request parameter category

    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter end_date

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter start_date

    • info

      added the new optional query request parameter type

    • info

      added the non-success response with the status

    • info

      added the success response with the status