Update product

PUT

https://api.agentpaid.io/api/v2/products/:id

PUT

/api/v2/products/:id

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

{
  "id": "prod_001",
  "name": "API Pro",
  "description": "Professional API plan",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-15T00:00:00.000Z",
  "active": true,
  "productCode": "api-pro",
  "externalId": "my-product-123",
  "archivedAt": "2024-01-15T09:30:00Z",
  "metadata": {},
  "productAttributes": [
    {
      "productAttributeId": "pa_001",
      "name": "Monthly subscription",
      "active": true,
      "pricing": {
        "pricingType": "RecurringPerUnit",
        "chargeType": "recurring",
        "pricePoints": [
          {
            "currency": "USD",
            "unitPrice": 99
          }
        ],
        "pricingModel": "PerUnit",
        "billingFrequency": "Monthly",
        "billingType": "Advance"
      },
      "creditBenefits": [
        {
          "id": "cb_001",
          "creditsCurrencyId": "cc_123",
          "amount": 1000,
          "recipient": "organization",
          "isInfiniteTotal": false,
          "allocationCadence": "upfront"
        }
      ]
    }
  ]
}

Update a product by ID. Also creates and edits product attributes: productAttributes upserts attributes and sets their pricing (metering event, price points, credit brackets). This is the endpoint to use to add pricing to a product created without any.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

idstringRequired

Request

Body

namestringOptional>=1 character

descriptionstring or nullOptional

activebooleanOptional

productCodestring or nullOptional

externalIdstring or nullOptional

metadatamap from strings to any or nullOptional

productAttributeslist of objectsOptional

Response

200

idstring

namestring

descriptionstring or null

createdAtdatetime

updatedAtdatetime

activeboolean

productCodestring or null

externalIdstring or null

archivedAtdatetime or null

metadatamap from strings to any or null

productAttributeslist of objects

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error