Update product

PUT

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

PUT

/api/v1/products/:productId

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.update("productId", {
8         body: {},
9     });
10 }
11 main();

200Updated

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

Authentication

AuthorizationBearer

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

Path parameters

productIdstringRequired

Request

This endpoint expects an object.

namestringOptional

descriptionstringOptional

externalIdstringOptional

typeenumOptional

activebooleanOptional

productCodestringOptional

ProductAttributelist of objectsOptional

Pricing attributes for this product

metadatamap from strings to anyOptional

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