Usage summary

List read-only current provider usage summaries

Returns customer-visible usage summaries for all platform launch verticals when the authenticated automation client has platform.billing_owner_visibility.read. External URL: /v1/providers/current/usage-summary. Current Next.js implementation path: /api/platform/v1/providers/current/usage-summary. This read-only route does not require Idempotency-Key; it exposes plan state, usage-summary test IDs, approved rollup posture, and observe-only billing side-effect blocking only. It never reads usage event tables or partner-facing billing tables, returns raw usage payloads or raw payment payloads, sends invoices, collects payments, enforces quota, suspends credentials, or calls external finance providers.

get/providers/current/usage-summary

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/providers/current/usage-summary
  • Auth: HTTP bearer

Headers

X-Correlation-Idstring

Optional partner-provided correlation ID echoed into request evidence.

Response

Read-only customer-visible usage summaries.

principalPrincipal required(unresolved $ref)
livemodeboolean required
request_idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.