Update product | Paid | Documentation

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.products.update({
        productId: "productId",
        body: {},
    });
}
main();

{
  "id": "string",
  "organizationId": "string",
  "name": "string",
  "type": "agent",
  "active": true,
  "externalId": "string",
  "displayId": "string",
  "description": "string",
  "productCode": "string",
  "ProductAttribute": [
    {
      "name": "string",
      "active": true,
      "pricing": {
        "taxable": true,
        "chargeType": "oneTime",
        "pricingModel": "PerUnit",
        "billingFrequency": "monthly",
        "pricePoints": {},
        "eventName": "string",
        "creditCost": 1.1
      }
    }
  ],
  "metadata": {},
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z"
}

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 nullOptional

displayIdstringOptional

Human-readable display ID

descriptionstring or nullOptional

productCodestring or nullOptional

ProductAttributelist of objectsOptional

Pricing attributes for this product

metadatamap from strings to any or nullOptional

createdAtdatetimeOptional

updatedAtdatetimeOptional