Billing Summary

GET 
/backend/api/billing/summary

Host: https://core.ocplanet.cloud

Access a summary of billing information, providing an overview of the user's financial status.

Request

Responses

200

application/json

Schema

Schema

billing_currency stringrequired
credits arrayrequired
invoices_details objectrequired
invoices_count integerrequired
paid_invoices_count integerrequired
unpaid_amount integerrequired
unpaid_invoice_id integer
unpaid_invoices_count integerrequired
unpaid_amount_currency nullstringrequired
latest_data_from stringrequired
services_count integerrequired
uptodate_credit numberrequired
validate_credit_card booleanrequired

Example (from schema)

{
  "billing_currency": "string",
  "credits": [
    null
  ],
  "invoices_details": {
    "invoices_count": 0,
    "paid_invoices_count": 0,
    "unpaid_amount": 0,
    "unpaid_invoice_id": 0,
    "unpaid_invoices_count": 0
  },
  "latest_data_from": "string",
  "services_count": 0,
  "uptodate_credit": 0,
  "validate_credit_card": true
}

Example

{
  "validate_credit_card": false,
  "credits": [],
  "uptodate_credit": 63.39,
  "billing_currency": "EUR",
  "services_count": 1,
  "latest_data_from": "2024-03-21T14:15:01.087241Z",
  "invoices_details": {
    "invoices_count": 0,
    "unpaid_invoices_count": 0,
    "paid_invoices_count": 0,
    "unpaid_amount": 0,
    "unpaid_amount_currency": null
  }
}

Loading...