Get customer state by external ID | Paid

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

{
  "customer": {
    "id": "cus_abc123",
    "name": "Acme Corporation",
    "externalId": "customer_123",
    "billingAddress": {
      "line1": "123 Elm Street",
      "line2": "Suite 400",
      "city": "Springfield",
      "state": "IL",
      "zipCode": "62704",
      "country": "USA"
    }
  },
  "defaultCurrency": "USD",
  "orders": [
    {
      "id": "ord_789xyz",
      "externalId": "order_456",
      "name": "Premium Subscription",
      "state": "active",
      "currency": "USD",
      "startDate": "2023-11-01T00:00:00Z",
      "endDate": null,
      "effectiveUntil": null
    }
  ],
  "seats": {
    "total": 10,
    "assigned": 7,
    "unassigned": 3,
    "data": [
      {
        "id": "seat_123e4567-e89b-12d3-a456-426614174000",
        "orderId": "ord_789xyz",
        "product": {
          "id": "prod_001",
          "externalId": "prod_ext_001",
          "name": "Enterprise License"
        },
        "status": "assigned",
        "assignee": {
          "id": "user_987",
          "externalId": "user_ext_987",
          "name": "Jane Doe",
          "email": "jane.doe@example.com"
        },
        "credits": {
          "balances": [
            {
              "creditsCurrencyId": "cred_usd",
              "currencyName": "US Dollar",
              "currencyKey": "USD",
              "balance": 150.75
            }
          ]
        }
      }
    ]
  },
  "checkoutLinks": [
    {
      "id": "chk_456def",
      "url": "https://checkout.agentpaid.io/checkout/456def",
      "status": "active",
      "productIds": [
        "prod_001",
        "prod_002"
      ],
      "singleUse": false,
      "allowedCurrencies": [
        "USD",
        "EUR"
      ],
      "expiresAt": "2024-12-31T23:59:59Z"
    }
  ],
  "credits": {
    "balances": [
      {
        "creditsCurrencyId": "cred_usd",
        "currencyName": "US Dollar",
        "currencyKey": "USD",
        "balance": 500
      }
    ]
  },
  "timestamp": "2024-04-25T14:45:00Z"
}

Primary integration endpoint for agents and programmatic clients using their own customer IDs. Use the value you stored on customer.externalId, for example customer_123.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

externalIdstringRequired

Customer ID from the integrator’s system, stored on Paid as externalId.

Response

200

customerobject

defaultCurrencystringformat: "^[A-Z]{3}$"

ISO 4217 currency code, for example USD, EUR, or GBP.

orderslist of objects

seatsobject

checkoutLinkslist of objects

creditsobject

timestampdatetime

Errors

403

Forbidden Error

404

Not Found Error

500

Internal Server Error