List customer API keys | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.customers.listCustomerApiKeys({
        id: "cus_abc123",
    });
}
main();

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "customerId": "cus_abc123",
      "customerExternalId": "string",
      "scopes": [
        "write:usage"
      ],
      "keyPrefix": "paid_ck_live_3f9",
      "last4": "string",
      "status": "ACTIVE",
      "createdAt": "2024-01-15T09:30:00Z",
      "lastUsedAt": "2024-01-15T09:30:00Z",
      "expiresAt": "2024-01-15T09:30:00Z",
      "revokedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "pagination": {
    "limit": 1,
    "offset": 1,
    "total": 1,
    "hasMore": true
  }
}

Lists this customer’s API keys, newest first and paginated, revoked and expired ones included. The secret is never returned; keyPrefix and last4 identify each key. Use the value returned as customer.id, for example cus_abc123; if you have your own customer ID, use the /api/v2/customers/external/{externalId}/… twin.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

idstringRequiredformat: "^cus_.+"

Paid customer display id

Query parameters

limitintegerOptional1-100Defaults to 10

offsetintegerOptional>=0

Response

200

datalist of objects

paginationobject

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error