Get customer credit balances

GET

https://api.agentpaid.io/api/v2/customers/:id/credits/balances

GET

/api/v2/customers/:id/credits/balances

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.getCustomerCreditBalances("cus_abc123");
8 }
9 main();

1 {
2   "data": [
3     {
4       "creditsCurrencyId": "cur_USD",
5       "currencyName": "US Dollar",
6       "currencyKey": "USD",
7       "available": 1500.75,
8       "used": 350.25,
9       "total": 1851,
10       "recipient": "organization",
11       "grants": [
12         {
13           "available": 1000.5,
14           "used": 200,
15           "total": 1200.5,
16           "rolloverAmount": 150,
17           "periodStart": "2024-04-01T00:00:00Z",
18           "periodEnd": "2024-04-30T23:59:59Z",
19           "rolloverEndDate": "2024-05-15T23:59:59Z",
20           "expiresAt": "2024-06-01T00:00:00Z",
21           "isInRolloverWindow": true
22         },
23         {
24           "available": 500.25,
25           "used": 150.25,
26           "total": 650.5,
27           "rolloverAmount": 0,
28           "periodStart": "2024-03-01T00:00:00Z",
29           "periodEnd": "2024-03-31T23:59:59Z",
30           "rolloverEndDate": "2024-04-15T23:59:59Z",
31           "expiresAt": "2024-05-01T00:00:00Z",
32           "isInRolloverWindow": false
33         }
34       ],
35       "periodStart": "2024-04-01T00:00:00Z",
36       "periodEnd": "2024-04-30T23:59:59Z",
37       "rolloverEndDate": "2024-05-15T23:59:59Z"
38     },
39     {
40       "creditsCurrencyId": "cur_EUR",
41       "currencyName": "Euro",
42       "currencyKey": "EUR",
43       "available": 800,
44       "used": 200,
45       "total": 1000,
46       "recipient": "seat",
47       "grants": [
48         {
49           "available": 800,
50           "used": 200,
51           "total": 1000,
52           "rolloverAmount": 100,
53           "periodStart": "2024-04-01T00:00:00Z",
54           "periodEnd": "2024-04-30T23:59:59Z",
55           "rolloverEndDate": "2024-05-15T23:59:59Z",
56           "expiresAt": "2024-06-01T00:00:00Z",
57           "isInRolloverWindow": true
58         }
59       ],
60       "periodStart": "2024-04-01T00:00:00Z",
61       "periodEnd": "2024-04-30T23:59:59Z",
62       "rolloverEndDate": "2024-05-15T23:59:59Z"
63     }
64   ]
65 }

Get current customer credit balances grouped by currency for a Paid customer display ID. Use the value returned as customer.id, for example cus_abc123. If you have your own customer ID, use /api/v2/customers/external/{externalId}/credits/balances.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

idstringRequired

Paid customer display id

Response

200

datalist of objects

Errors

403

Forbidden Error

404

Not Found Error

500

Internal Server Error