GuidesAPI ReferenceChangelogDiscussions
Log In
API Reference

Revoke a customer's access to an address

  • Permission: ADDRESS_MANAGEMENT
  • Roles: extended_user, flex_management

Ends a customer’s access. The grant is closed rather than deleted, so the access history stays queryable — the revoked grant is returned with its disconnectedAt set. Revoking access that is not currently held reports 404.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

UUID of the address

string
required

The customer's Chargee sub, as issued when they were registered. URL-encode it: a federated customer's sub can contain /, which would otherwise split the path.

Responses

403

Forbidden — the caller's role lacks the required permission (ADDRESS_MANAGEMENT).

404

Address not found, no such customer in this realm, or the customer had no access to revoke

502

The address service is unavailable or timed out. error is SERVICE_UNAVAILABLE.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json