Get customer state

GET

https://api.agentpaid.io/api/v2/customers/:id/state

GET

/api/v2/customers/:id/state

1 import { PaidClient } from "@paid-ai/paid-node";
2 
3 async function main() {
4     const client = new PaidClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.customers.getCustomerStateById("cus_abc123");
8 }
9 main();

1 {
2   "customer": {
3     "id": "cus_abc123",
4     "name": "Acme Corporation",
5     "externalId": "ACME-7890",
6     "billingAddress": {
7       "line1": "123 Elm Street",
8       "line2": "Suite 400",
9       "city": "Springfield",
10       "state": "IL",
11       "zipCode": "62704",
12       "country": "USA"
13     }
14   },
15   "defaultCurrency": "USD",
16   "orders": [
17     {
18       "id": "ord_456def",
19       "externalId": "ORDER-2024-001",
20       "name": "Premium Subscription",
21       "state": "active",
22       "currency": "USD",
23       "startDate": "2024-01-01T00:00:00Z",
24       "endDate": null,
25       "effectiveUntil": null
26     }
27   ],
28   "seats": {
29     "total": 10,
30     "assigned": 7,
31     "unassigned": 3,
32     "data": [
33       {
34         "id": "seat_789ghi",
35         "orderId": "ord_456def",
36         "product": {
37           "id": "prod_123abc",
38           "externalId": "PROD-001",
39           "name": "Premium User Seat"
40         },
41         "status": "assigned",
42         "assignee": {
43           "id": "user_001",
44           "externalId": "EMP-1001",
45           "name": "Jane Doe",
46           "email": "jane.doe@acme.com"
47         },
48         "credits": {
49           "balances": [
50             {
51               "creditsCurrencyId": "cur_001",
52               "currencyName": "US Dollar",
53               "currencyKey": "USD",
54               "balance": 150.75
55             }
56           ]
57         }
58       }
59     ]
60   },
61   "checkoutLinks": [
62     {
63       "id": "chk_123xyz",
64       "url": "https://checkout.agentpaid.io/checkout/chk_123xyz",
65       "status": "active",
66       "productIds": [
67         "prod_123abc",
68         "prod_456def"
69       ],
70       "singleUse": false,
71       "allowedCurrencies": [
72         "USD",
73         "EUR"
74       ],
75       "expiresAt": "2024-12-31T23:59:59Z"
76     }
77   ],
78   "credits": {
79     "balances": [
80       {
81         "creditsCurrencyId": "cur_001",
82         "currencyName": "US Dollar",
83         "currencyKey": "USD",
84         "balance": 500
85       }
86     ]
87   },
88   "timestamp": "2024-04-27T12:00:00Z"
89 }

Get the current customer state by Paid display ID

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

idstringRequired

Paid customer display id

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