PApaywithlocus
End users

Retire a test or integration end user without deleting financial history

Workspace owner or admin with fresh MFA/passkey step-up only. Fails closed unless the balance is zero and every reservation, top-up attempt, external purchase, and refund is terminal. Revokes end-user tokens and scoped agent credentials, cancels outstanding approvals, resets the operational policy, freezes the credit account, and marks the identity inactive. Ledger, funding, settlement, replay, and audit rows are retained. Repeating a completed retirement is safe.

delete/credits/end-users/{externalUserId}

Request

  • Base URL
    https://api.paywithlocus.com/api
  • URL
    https://api.paywithlocus.com/api/credits/end-users/{externalUserId}
  • Auth
    HTTP bearer

Path parameters

externalUserIdstring required

Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.

Headers

X-Locus-Step-Upstring password

Short-lived raw MFA/passkey step-up token bound to the authenticated Cognito subject. Send it alongside the dashboard Bearer token for workspace-administrator mutations when the base session does not itself prove MFA within the last ten minutes. Never send it with a tenant secret key.

Response

Retirement converged

successunknown required
externalUserIdstring required

Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.

retiredboolean required
alreadyRetiredboolean required
accountIdstring uuid nullable required
revokedTokensinteger required
revokedAgentConnectionsinteger required
canceledApprovalsinteger required
policyResetboolean required

Changes

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