List pricing for a product

GET

https://api.agentpaid.io/api/v2/pricing/

GET

/api/v2/pricing/

1 const url = 'https://api.agentpaid.io/api/v2/pricing/?productId=prod_9f8e7d6c5b4a3210';
2 const options = {
3   method: 'GET',
4   headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "data": [
3     {
4       "productAttributeId": "attr_123e4567-e89b-12d3-a456-426614174000",
5       "name": "Premium Support",
6       "pricing": {
7         "pricingType": "RecurringPerUnit",
8         "chargeType": "fixed",
9         "pricePoints": [
10           {
11             "currency": "USD",
12             "unitPrice": 15,
13             "tiers": [
14               {
15                 "lowerBound": 1,
16                 "flatAmount": 0,
17                 "index": 0,
18                 "number": 1,
19                 "tierBillingType": "perUnit",
20                 "unitAmount": 15,
21                 "upperBound": 100
22               }
23             ],
24             "minQuantity": 1,
25             "maxQuantity": 100,
26             "includedQuantity": 0
27           }
28         ],
29         "pricingModel": "standard",
30         "eventName": "monthly_billing",
31         "billingFrequency": "monthly",
32         "billingType": "postpaid",
33         "creditsCurrencyId": "credits_usd",
34         "creditCost": 15,
35         "unitValue": 1,
36         "percentageValue": 0,
37         "costPlusMultiplier": 1
38       },
39       "creditBenefits": [
40         {
41           "id": "cb_9876543210abcdef",
42           "creditsCurrencyId": "credits_usd",
43           "amount": 100,
44           "recipient": "customer_account",
45           "isInfiniteTotal": false,
46           "allocationCadence": "monthly",
47           "creditGrantTiming": "start_of_period",
48           "overageUnitPrice": 0.15,
49           "rolloverAmount": 50,
50           "rolloverDuration": 3,
51           "rolloverDurationUnit": "months"
52         }
53       ]
54     }
55   ]
56 }

Returns pricing for all product attributes of a product. Each entry includes the attribute's pricing configuration and credit benefits.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Query parameters

productIdstringRequired

Product display ID or UUID

Response

200

datalist of objects

Errors

404

Not Found Error

500

Internal Server Error