List products | Paid | Documentation

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        environment: "https://api.agentpaid.io/api/v1",
        token: "YOUR_TOKEN_HERE",
    });
    await client.products.list();
}
main();

[
  {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "organizationId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
    "name": "Premium Support Agent",
    "type": "agent",
    "active": true,
    "externalId": "EXT-12345",
    "displayId": "AGT-001",
    "description": "Provides 24/7 premium customer support services",
    "productCode": "PSA-2024",
    "ProductAttribute": [
      {
        "name": "Standard Support Plan",
        "active": true,
        "pricing": {
          "taxable": true,
          "chargeType": "recurring",
          "pricingModel": "PerUnit",
          "billingFrequency": "monthly",
          "pricePoints": {
            "default": {
              "unitPrice": 99.99,
              "minQuantity": 1,
              "includedQuantity": 0,
              "tiers": [
                {
                  "unitPrice": 99.99,
                  "minQuantity": 1,
                  "maxQuantity": 10
                },
                {
                  "unitPrice": 89.99,
                  "minQuantity": 11,
                  "maxQuantity": 50
                }
              ]
            }
          },
          "eventName": "support_subscription",
          "creditCost": 99.99
        }
      }
    ],
    "metadata": {
      "category": "support",
      "region": "US"
    },
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-04-10T12:00:00Z"
  }
]

Authentication

AuthorizationBearer

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

Response

Success response

idstringformat: "uuid"

organizationIdstringformat: "uuid"

namestring

typeenum

The type of product

Allowed values:

activeboolean

externalIdstring or null

displayIdstring or null

Human-readable display ID

descriptionstring or null

productCodestring or null

ProductAttributelist of objects or null

Pricing attributes for this product

metadatamap from strings to any or null

createdAtdatetime or null

updatedAtdatetime or null