customers

Revoke a customer API key (by external customer id)

Revokes one of this customer's keys, which then stops authenticating. Keys are never deleted: a revoked key stays listed with revokedAt set, and deleting the customer revokes its keys too. Revoking an already revoked key returns it unchanged. 404 when the key does not belong to this customer. Addresses the customer by your external customer id.

delete/customers/external/{externalId}/api-keys/{apiKeyId}

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/customers/external/{externalId}/api-keys/{apiKeyId}
  • Auth: HTTP bearer

Path parameters

externalIdstring required

Customer ID from your system, stored on Paid as the customer's externalId.

apiKeyIdstring uuid required

The key's id, as returned by create or list.

Response

200

idstring uuid required

The key's id.

namestring required
descriptionstring nullable required
customerIdstring nullable required

Display id (cus_…) of the customer the key acts for.

customerExternalIdstring nullable required

That customer's id in your system, if it has one.

scopesstring[] required

What the key may do.

keyPrefixstring required

The key's first characters, to recognise it in a list.

last4string required

The key's last four characters.

status'ACTIVE' | 'REVOKED' | 'EXPIRED' required

ACTIVE until the key is revoked (REVOKED) or its expiry passes (EXPIRED).

createdAtstring date-time required
lastUsedAtstring date-time nullable required
expiresAtstring date-time nullable required
revokedAtstring date-time nullable required

Changes

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