Finance Summary

Retrieve your financial and billing summary.

Hint: The data returned is as of the previous hour or earlier, it may be delayed from the data displayed in the Console.

Privileges#

This API requires the account owner to enable permissions for the credentials in the Console.

  1. Go to Console - Project
  2. Click on the credential that requires the Console API to be enabled.
  3. Scroll down to "Console data privileges".
  4. Check "Allow access to finance summary data".
  5. Click the Save button.

Endpoint#

GET /finance/v1/summary

Parameters#

Request example#

curl -X GET --compressed \
-H 'Authorization: Bearer your_token' \
'https://your-api-host/finance/v1/summary'

Replace your_token and your_api_host with your JWT Authentication and API Host

Try it

Response#

{
  "metadata": {
    "tag": "2a9873efd0a6c75665dc4f6116b19bdf"
  },
  "asOf": "2024-04-03T17:13Z",
  "currency": "CNY",
  "balance": -17.54,
  "accruedCharges": {
    "previousDay": 28.92,
    "thisMonth": 113.12,
    "sinceLastBill": 113.12
  },
  "pendingBills": [
    {
      "number": "20681CYX",
      "date": "2024-04-01T10:00Z",
      "type": "PayAsYouGo",
      "status": "unpaid",
      "amount": 535.1,
      "amountDue": 17.54,
      "dueDate": "2024-04-10T23:59Z"
    },
    {
      "number": "605D0FYX",
      "date": "2024-04-02T13:34Z",
      "type": "SavingsPlans",
      "status": "unpaid",
      "amount": 2000,
      "amountDue": 2000,
      "dueDate": "2024-04-30T12:59Z"
    }
  ],
  "availableSavingsPlans": [
    {
      "billNumber": "605D0FYX",
      "status": "pending",
      "term": "1",
      "commitments": 2000,
      "utilized": 0,
      "effectiveTime": "2024-04-30T13:00Z"
    }
  ],
  "availableResourcePlans": [
    {
      "billNumber": "613D1FYX",
      "status": "active",
      "requests": "1000000",
      "commitments": 2000,
      "utilized": 12,
      "effectiveTime": "2024-04-03T17:00Z"
    }
  ]
}
  • metadata
    object
    Metadata for this response
    • tag
      string
      Unique data identifier
    • attributions
      array
      Data attribution or statements that must be displayed with the response data
  • asOf
    date-time
    Data cutoff time in ISO 8601 UTC format
  • currency
    string
    Currency code, including CNY and USD
  • balance
    number
    Account balance
  • accruedCharges
    object
    Accrued Charges
    • previousDay
      number
      Accrued charges in the previous calendar day
    • thisMonth
      number
      Accrued charges for this calendar month
    • sinceLastBill
      number
      Accrued charges since the last bill
  • pendingBills
    array
    Pending bill list
    • number
      string
      Bill number
    • date
      date-time
      The issue date of the bill
    • type
      string
      The type of bill
    • status
      string
      Payment status of the bill, including unpaid, outstanding and overdue
    • amount
      number
      Total amount of the bill
    • amountDue
      number
      The unpaid portion of the bill that is still due
    • dueDate
      date-time
      The due date for the bill payment
  • availableSavingsPlans
    array
    Available savings plan list
    • billNumber
      string
      Bill number
    • status
      string
      Status of the savings plan, including pending and active
    • term
      string
      Duration of the savings plan commitment, default is 1 year
    • commitments
      number
      Total committed amount under the savings plan
    • utilized
      number
      Committed amount that has been utilized
    • effectiveTime
      date-time
      Time when the savings plan becomes effective
  • availableResourcePlans
    array
    Available resource plan list
    • billNumber
      string
      Bill number
    • status
      string
      Status of the resource plan, including pending and active
    • requests
      number
      Total request volume included in the resource plan
    • utilized
      number
      Number of requests used from the resource plan
    • effectiveTime
      date-time
      Time when the resource plan becomes effective