List pending credit consumption by external ID

GET

https://api.agentpaid.io/api/v2/customers/external/:externalId/credits/pending-consumption

GET

/api/v2/customers/external/:externalId/credits/pending-consumption

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.listCustomerPendingCreditConsumptionByExternalId("customer_123", {});
8 }
9 main();

1 {
2   "data": [
3     {
4       "credits": 75,
5       "creditCurrency": {
6         "key": "api_credits",
7         "name": "API Credits"
8       },
9       "orderId": "ord_789xyz",
10       "eventName": "agent.message_sent",
11       "occurredAt": "2024-04-10T14:22:00Z",
12       "recordedAt": "2024-04-10T14:25:00Z"
13     },
14     {
15       "credits": 30,
16       "creditCurrency": {
17         "key": "sms_credits",
18         "name": "SMS Credits"
19       },
20       "orderId": "ord_456def",
21       "eventName": "agent.sms_delivery",
22       "occurredAt": "2024-04-09T11:10:00Z",
23       "recordedAt": "2024-04-09T11:15:00Z"
24     }
25   ],
26   "pagination": {
27     "limit": 10,
28     "offset": 0,
29     "total": 25,
30     "hasMore": true
31   }
32 }

List credit consumption recorded before a matching credit pool existed, for a customer looked up by external ID.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

externalIdstringRequired

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

Query parameters

limitintegerOptional1-100Defaults to 10

offsetintegerOptional

Response

200

datalist of objects

Pending consumption, oldest first. Entries leave this list once they are applied to a credit pool or settled.

paginationobject

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error