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", {
        body: {},
    });
}
main();

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "organizationId": "9b2d7f4e-8c3a-4f1a-9d2e-7f8a9b6c5d4e",
  "name": "Premium Support Package",
  "type": "agent",
  "active": true,
  "externalId": "EXT-12345",
  "displayId": "PROD-001",
  "description": "Provides 24/7 premium customer support with dedicated agents.",
  "productCode": "PSP-2024",
  "ProductAttribute": [
    {
      "name": "Standard Support",
      "active": true,
      "pricing": {
        "taxable": true,
        "chargeType": "recurring",
        "pricingModel": "PerUnit",
        "billingFrequency": "monthly",
        "pricePoints": {},
        "eventName": "SupportSubscription",
        "creditCost": 99.99
      }
    }
  ],
  "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

Allowed values:

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

Allowed values:

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