admin

Inspects an identity: keys, ledger and credit history.

get/admin/identities/{email}

Request

  • Base URL: https://api.mapmap.ai
  • URL: https://api.mapmap.ai/admin/identities/{email}
  • Auth: HTTP bearer

Path parameters

emailstring required

Identity email (case-insensitive)

Response

Identity, keys, balance and history

balance_penceinteger required

Prepaid balance, in pence.

credited_total_penceinteger required

Lifetime credited total, in pence.

mau_includedinteger required

Included monthly active users per calendar month.

mau_overdrawnboolean required

Whether the identity is MAU-overdrawn this month (fail-open flag: serving continued; sustained overdraw is a commercial conversation).

mau_this_monthinteger required

Distinct monthly active users recorded this calendar month.

month_usedinteger required

Metered quota units recorded this calendar month across the identity's keys. Paired with the live keys' monthly_quota it gives quota burn, which is what the account page leads with.

planstring required

Coarse plan label (free until a subscription is activated).

stripe_customer_idstring nullable

The Stripe customer this identity is linked to, or null when it has never been through checkout.

Changes

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