Read the signed-in end customer's balance and activity

customer.me.retrieve

Answers for the customer the session belongs to and no one else: the request names no customer or account, so a session can never read another customer. Returns each of the customer's accounts in the session's Product with its balance, and the money movements on them. A customer's actions and records come from the product.objects operations, which accept the same session.

GET /v1/customer-identity/me

Principal customer_session. Idempotency not_required. Environment either.

Input

Field	In	Type	Description
`productId` required	query	`string`	The Product the session is bound to, as customer.join returned it. Any other Product is refused.
`X-Hyperscale-Environment`	header	`sandbox \| live`

Request sample

curl --request GET 'https://hyperscale0.ai/v1/customer-identity/me' \
  --header "Authorization: Bearer $HYPERSCALE_API_KEY" \
  --header 'X-Hyperscale-Environment: sandbox'

Errors

Code	HTTP	Cause
`environment_mismatch`	403	The session was issued for sandbox or live and the request targets the other environment.
`internal_error`	500	Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience.
`invalid_request`	400	The request does not match the API reference.
`missing_required_scope`	403	The credential is valid but does not grant one or more operation scopes.
`not_found`	404	No Hyperscale route matched the requested path and method.
`product_access_suspended`	403	The Product is disabled or closed, so its credentials are suspended in every environment.
`product_activation_required`	403	The live Product or required live capability is not active yet.
`rate_limited`	429	The credential sent more than its limit in the current 60-second window: 600 requests per API key or session, 1,200 per IP address. Every response carries `x-ratelimit-limit`, `x-ratelimit-remaining` and `x-ratelimit-reset` (Unix seconds).
`resource_not_found`	404	The requested resource does not exist in the credential's visible scope.
`resource_reader_unavailable`	503	A generated read model could not serve the request at this moment.
`state_conflict`	409	The operation conflicts with the current durable state of the resource.
`tenant_mismatch`	403	The request mixed tenant-owned identifiers across tenant boundaries.
`tenant_not_found`	404	The credential resolved to a tenant Hyperscale cannot find.
`unauthorized`	403	The request did not include a valid Hyperscale bearer credential for this environment.
`ledger_unavailable`	503	The ledger could not be reached, did not answer in time, or returned incomplete evidence for the accounts this request reads. `details.reason` is `request_timeout` when the call timed out.
`tenant_status_forbidden`	409	The company is suspended or closed, so every credential bound to it is refused, reads included. `details.tenantId` names the company.

All operations