Get pricing for a product attribute

GET

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

GET

/api/v2/pricing/:productAttributeId

1 const url = 'https://api.agentpaid.io/api/v2/pricing/productAttributeId';
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   "productAttributeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3   "name": "Premium Support Plan",
4   "pricing": {
5     "pricingType": "RecurringPerUnit",
6     "chargeType": "fixed",
7     "pricePoints": [
8       {
9         "currency": "USD",
10         "unitPrice": 15,
11         "tiers": [
12           {
13             "lowerBound": 1,
14             "flatAmount": 0,
15             "index": 0,
16             "number": 1,
17             "tierBillingType": "perUnit",
18             "unitAmount": 15,
19             "upperBound": 100
20           }
21         ],
22         "minQuantity": 1,
23         "maxQuantity": 100,
24         "includedQuantity": 0
25       }
26     ],
27     "pricingModel": "standard",
28     "eventName": "monthly_billing",
29     "billingFrequency": "monthly",
30     "billingType": "postpaid",
31     "creditsCurrencyId": "USD",
32     "creditCost": 15,
33     "unitValue": 1,
34     "percentageValue": 0,
35     "costPlusMultiplier": 1.2
36   },
37   "creditBenefits": [
38     {
39       "id": "b7a1f8d2-4c3e-4f9a-9a2d-1e2f3b4c5d6e",
40       "creditsCurrencyId": "USD",
41       "amount": 100,
42       "recipient": "customer",
43       "isInfiniteTotal": false,
44       "allocationCadence": "monthly",
45       "creditGrantTiming": "start_of_period",
46       "overageUnitPrice": 0.15,
47       "rolloverAmount": 50,
48       "rolloverDuration": 3,
49       "rolloverDurationUnit": "months"
50     }
51   ]
52 }

Returns pricing and credit benefits for a single product attribute.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

productAttributeIdstringRequiredformat: "uuid"

Response

200

productAttributeIdstring

namestring

pricingobject

creditBenefitslist of objects

Errors

404

Not Found Error

500

Internal Server Error