List products

GET

https://api.agentpaid.io/api/v1/products

GET

/api/v1/products

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.products.list();
8 }
9 main();

200Retrieved

1 [
2   {
3     "id": "string",
4     "organizationId": "string",
5     "name": "string",
6     "type": "agent",
7     "active": true,
8     "externalId": "string",
9     "displayId": "string",
10     "description": "string",
11     "productCode": "string",
12     "ProductAttribute": [
13       {
14         "name": "string",
15         "active": true,
16         "pricing": {
17           "taxable": true,
18           "chargeType": "oneTime",
19           "pricingModel": "PerUnit",
20           "billingFrequency": "monthly",
21           "pricePoints": {},
22           "eventName": "string",
23           "creditCost": 1.1
24         }
25       }
26     ],
27     "metadata": {},
28     "createdAt": "2024-01-15T09:30:00Z",
29     "updatedAt": "2024-01-15T09:30:00Z"
30   }
31 ]

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Success response

idstringformat: "uuid"

organizationIdstringformat: "uuid"

namestring

typeenum

The type of product

activeboolean

externalIdstring or null

displayIdstring

Human-readable display ID

descriptionstring or null

productCodestring or null

ProductAttributelist of objects

Pricing attributes for this product

metadatamap from strings to any or null

createdAtdatetime

updatedAtdatetime