@paid-ai/paid-node 0.5.0 → 1.0.0

package/reference.md

@@ -1,7 +1,5 @@
 # Reference
-
 ## Customers
-
 <details><summary><code>client.customers.<a href="/src/api/resources/customers/client/Client.ts">list</a>() -> Paid.Customer[]</code></summary>
 <dl>
 <dd>
@@ -16,8 +14,8 @@
 
 ```typescript
 await client.customers.list();
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -31,13 +29,14 @@ await client.customers.list();
 <dl>
 <dd>
 
-**requestOptions:** `Customers.RequestOptions`
-
+**requestOptions:** `CustomersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -58,9 +57,22 @@ await client.customers.list();
 await client.customers.create({
     name: "Acme, Inc.",
     externalId: "acme-inc",
+    contacts: [{
+            salutation: "Mr.",
+            firstName: "John",
+            lastName: "Doe",
+            accountName: "Acme, Inc.",
+            email: "john.doe@acme.com",
+            phone: "+1-555-0100",
+            billingStreet: "123 Main Street",
+            billingCity: "San Francisco",
+            billingStateProvince: "CA",
+            billingCountry: "USA",
+            billingPostalCode: "94102"
+        }]
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -74,21 +86,22 @@ await client.customers.create({
 <dl>
 <dd>
 
-**request:** `Paid.CustomerCreate`
-
+**request:** `Paid.CustomerCreate` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Customers.RequestOptions`
-
+**requestOptions:** `CustomersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -107,8 +120,8 @@ await client.customers.create({
 
 ```typescript
 await client.customers.get("customerId");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -122,21 +135,22 @@ await client.customers.get("customerId");
 <dl>
 <dd>
 
-**customerId:** `string`
-
+**customerId:** `string` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Customers.RequestOptions`
-
+**requestOptions:** `CustomersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -158,10 +172,10 @@ await client.customers.update("customerId", {
     name: "Acme, Inc. (Updated)",
     phone: "123-456-7890",
     employeeCount: 101,
-    annualRevenue: 1000001,
+    annualRevenue: 1000001
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -175,29 +189,30 @@ await client.customers.update("customerId", {
 <dl>
 <dd>
 
-**customerId:** `string`
-
+**customerId:** `string` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**request:** `Paid.CustomerUpdate`
-
+**request:** `Paid.CustomerUpdate` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Customers.RequestOptions`
-
+**requestOptions:** `CustomersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -216,8 +231,8 @@ await client.customers.update("customerId", {
 
 ```typescript
 await client.customers.delete("customerId");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -231,21 +246,82 @@ await client.customers.delete("customerId");
 <dl>
 <dd>
 
-**customerId:** `string`
+**customerId:** `string` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `CustomersClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.customers.<a href="/src/api/resources/customers/client/Client.ts">checkEntitlement</a>(customerId, { ...params }) -> Paid.CustomersCheckEntitlementResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.customers.checkEntitlement("customerId", {
+    event_name: "event_name",
+    view: "all"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
 
+**customerId:** `string` — The customer ID
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Customers.RequestOptions`
+**request:** `Paid.CustomersCheckEntitlementRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
 
+**requestOptions:** `CustomersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -264,8 +340,8 @@ await client.customers.delete("customerId");
 
 ```typescript
 await client.customers.getEntitlements("customerId");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -280,20 +356,21 @@ await client.customers.getEntitlements("customerId");
 <dd>
 
 **customerId:** `string` — The customer ID
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Customers.RequestOptions`
-
+**requestOptions:** `CustomersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -312,8 +389,8 @@ await client.customers.getEntitlements("customerId");
 
 ```typescript
 await client.customers.getByExternalId("externalId");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -327,21 +404,22 @@ await client.customers.getByExternalId("externalId");
 <dl>
 <dd>
 
-**externalId:** `string`
-
+**externalId:** `string` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Customers.RequestOptions`
-
+**requestOptions:** `CustomersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -360,8 +438,8 @@ await client.customers.getByExternalId("externalId");
 
 ```typescript
 await client.customers.updateByExternalId("externalId", {});
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -375,29 +453,30 @@ await client.customers.updateByExternalId("externalId", {});
 <dl>
 <dd>
 
-**externalId:** `string`
-
+**externalId:** `string` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**request:** `Paid.CustomerUpdate`
-
+**request:** `Paid.CustomerUpdate` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Customers.RequestOptions`
-
+**requestOptions:** `CustomersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -416,8 +495,8 @@ await client.customers.updateByExternalId("externalId", {});
 
 ```typescript
 await client.customers.deleteByExternalId("externalId");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -431,21 +510,22 @@ await client.customers.deleteByExternalId("externalId");
 <dl>
 <dd>
 
-**externalId:** `string`
-
+**externalId:** `string` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Customers.RequestOptions`
-
+**requestOptions:** `CustomersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -467,10 +547,10 @@ await client.customers.getCostsByExternalId("externalId", {
     limit: 1,
     offset: 1,
     startTime: "2024-01-15T09:30:00Z",
-    endTime: "2024-01-15T09:30:00Z",
+    endTime: "2024-01-15T09:30:00Z"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -485,28 +565,29 @@ await client.customers.getCostsByExternalId("externalId", {
 <dd>
 
 **externalId:** `string` — The external ID of the customer
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**request:** `Paid.CustomersGetCostsByExternalIdRequest`
-
+**request:** `Paid.CustomersGetCostsByExternalIdRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Customers.RequestOptions`
-
+**requestOptions:** `CustomersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -528,10 +609,10 @@ await client.customers.getUsageByExternalId("externalId", {
     limit: 1,
     offset: 1,
     startTime: "2024-01-15T09:30:00Z",
-    endTime: "2024-01-15T09:30:00Z",
+    endTime: "2024-01-15T09:30:00Z"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -546,35 +627,34 @@ await client.customers.getUsageByExternalId("externalId", {
 <dd>
 
 **externalId:** `string` — The external ID of the customer
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**request:** `Paid.CustomersGetUsageByExternalIdRequest`
-
+**request:** `Paid.CustomersGetUsageByExternalIdRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Customers.RequestOptions`
-
+**requestOptions:** `CustomersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-## Agents
-
-<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">list</a>() -> Paid.Agent[]</code></summary>
+<details><summary><code>client.customers.<a href="/src/api/resources/customers/client/Client.ts">listPaymentMethods</a>(externalId) -> Paid.PaymentMethod[]</code></summary>
 <dl>
 <dd>
 
@@ -586,8 +666,7 @@ await client.customers.getUsageByExternalId("externalId", {
 <dl>
 <dd>
 
-DEPRECATED: Use /products instead. Agents are now products with type='agent'.
-
+Retrieves all payment methods associated with a customer identified by their external ID.
 </dd>
 </dl>
 </dd>
@@ -602,9 +681,9 @@ DEPRECATED: Use /products instead. Agents are now products with type='agent'.
 <dd>
 
 ```typescript
-await client.agents.list();
-```
+await client.customers.listPaymentMethods("externalId");
 
+```
 </dd>
 </dl>
 </dd>
@@ -618,18 +697,27 @@ await client.agents.list();
 <dl>
 <dd>
 
-**requestOptions:** `Agents.RequestOptions`
+**externalId:** `string` — The external ID of the customer
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
 
+**requestOptions:** `CustomersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">create</a>({ ...params }) -> Paid.Agent</code></summary>
+<details><summary><code>client.customers.<a href="/src/api/resources/customers/client/Client.ts">createPaymentMethod</a>(externalId, { ...params }) -> Paid.PaymentMethod</code></summary>
 <dl>
 <dd>
 
@@ -641,8 +729,7 @@ await client.agents.list();
 <dl>
 <dd>
 
-DEPRECATED: Use POST /products instead.
-
+Creates a new payment method for a customer using a Stripe confirmation token.
 </dd>
 </dl>
 </dd>
@@ -657,13 +744,15 @@ DEPRECATED: Use POST /products instead.
 <dd>
 
 ```typescript
-await client.agents.create({
-    name: "Acme Agent",
-    description: "Acme Agent is an AI agent that does things.",
-    externalId: "acme-agent",
+await client.customers.createPaymentMethod("externalId", {
+    confirmationToken: "ctoken_1234567890",
+    returnUrl: "https://example.com/payment-method-added",
+    metadata: {
+        "source": "api"
+    }
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -677,26 +766,35 @@ await client.agents.create({
 <dl>
 <dd>
 
-**request:** `Paid.AgentCreate`
-
+**externalId:** `string` — The external ID of the customer
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Agents.RequestOptions`
+**request:** `Paid.CustomersCreatePaymentMethodRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
 
+**requestOptions:** `CustomersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">get</a>(agentId) -> Paid.Agent</code></summary>
+<details><summary><code>client.customers.<a href="/src/api/resources/customers/client/Client.ts">deletePaymentMethod</a>(externalId, paymentMethodId) -> void</code></summary>
 <dl>
 <dd>
 
@@ -708,8 +806,7 @@ await client.agents.create({
 <dl>
 <dd>
 
-DEPRECATED: Use GET /products/{productId} instead.
-
+Deletes a specific payment method from a customer's account.
 </dd>
 </dl>
 </dd>
@@ -724,9 +821,9 @@ DEPRECATED: Use GET /products/{productId} instead.
 <dd>
 
 ```typescript
-await client.agents.get("agentId");
-```
+await client.customers.deletePaymentMethod("externalId", "paymentMethodId");
 
+```
 </dd>
 </dl>
 </dd>
@@ -740,26 +837,36 @@ await client.agents.get("agentId");
 <dl>
 <dd>
 
-**agentId:** `string`
-
+**externalId:** `string` — The external ID of the customer
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Agents.RequestOptions`
+**paymentMethodId:** `string` — The ID of the payment method to delete
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
 
+**requestOptions:** `CustomersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">update</a>(agentId, { ...params }) -> Paid.Agent</code></summary>
+## Agents
+<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">list</a>() -> Paid.Agent[]</code></summary>
 <dl>
 <dd>
 
@@ -771,8 +878,7 @@ await client.agents.get("agentId");
 <dl>
 <dd>
 
-DEPRECATED: Use PUT /products/{productId} instead.
-
+DEPRECATED: Use /products instead. Agents are now products with type='agent'.
 </dd>
 </dl>
 </dd>
@@ -787,44 +893,9 @@ DEPRECATED: Use PUT /products/{productId} instead.
 <dd>
 
 ```typescript
-await client.agents.update("agentId", {
-    name: "Acme Agent (Updated)",
-    agentAttributes: [
-        {
-            name: "Emails sent signal",
-            active: true,
-            pricing: {
-                eventName: "emails_sent",
-                taxable: true,
-                chargeType: "usage",
-                pricingModel: "PerUnit",
-                billingFrequency: "monthly",
-                pricePoints: {
-                    USD: {
-                        tiers: [
-                            {
-                                minQuantity: 0,
-                                maxQuantity: 10,
-                                unitPrice: 100,
-                            },
-                            {
-                                minQuantity: 11,
-                                maxQuantity: 100,
-                                unitPrice: 90,
-                            },
-                            {
-                                minQuantity: 101,
-                                unitPrice: 80,
-                            },
-                        ],
-                    },
-                },
-            },
-        },
-    ],
-});
-```
+await client.agents.list();
 
+```
 </dd>
 </dl>
 </dd>
@@ -838,34 +909,19 @@ await client.agents.update("agentId", {
 <dl>
 <dd>
 
-**agentId:** `string`
-
+**requestOptions:** `AgentsClient.RequestOptions` 
+    
 </dd>
 </dl>
-
-<dl>
-<dd>
-
-**request:** `Paid.AgentUpdate`
-
 </dd>
 </dl>
 
-<dl>
-<dd>
-
-**requestOptions:** `Agents.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
 
 </dd>
 </dl>
 </details>
 
-<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">delete</a>(agentId) -> void</code></summary>
+<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">create</a>({ ...params }) -> Paid.Agent</code></summary>
 <dl>
 <dd>
 
@@ -877,8 +933,7 @@ await client.agents.update("agentId", {
 <dl>
 <dd>
 
-DEPRECATED: Use DELETE /products/{productId} instead.
-
+DEPRECATED: Use POST /products instead.
 </dd>
 </dl>
 </dd>
@@ -893,9 +948,13 @@ DEPRECATED: Use DELETE /products/{productId} instead.
 <dd>
 
 ```typescript
-await client.agents.delete("agentId");
-```
+await client.agents.create({
+    name: "Acme Agent",
+    description: "Acme Agent is an AI agent that does things.",
+    externalId: "acme-agent"
+});
 
+```
 </dd>
 </dl>
 </dd>
@@ -909,26 +968,27 @@ await client.agents.delete("agentId");
 <dl>
 <dd>
 
-**agentId:** `string`
-
+**request:** `Paid.AgentCreate` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Agents.RequestOptions`
-
+**requestOptions:** `AgentsClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">getByExternalId</a>(externalId) -> Paid.Agent</code></summary>
+<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">get</a>(agentId) -> Paid.Agent</code></summary>
 <dl>
 <dd>
 
@@ -940,8 +1000,7 @@ await client.agents.delete("agentId");
 <dl>
 <dd>
 
-DEPRECATED: Use GET /products/external/{externalId} instead.
-
+DEPRECATED: Use GET /products/{productId} instead.
 </dd>
 </dl>
 </dd>
@@ -956,9 +1015,9 @@ DEPRECATED: Use GET /products/external/{externalId} instead.
 <dd>
 
 ```typescript
-await client.agents.getByExternalId("externalId");
-```
+await client.agents.get("agentId");
 
+```
 </dd>
 </dl>
 </dd>
@@ -972,26 +1031,27 @@ await client.agents.getByExternalId("externalId");
 <dl>
 <dd>
 
-**externalId:** `string`
-
+**agentId:** `string` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Agents.RequestOptions`
-
+**requestOptions:** `AgentsClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">updateByExternalId</a>(externalId, { ...params }) -> Paid.Agent</code></summary>
+<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">update</a>(agentId, { ...params }) -> Paid.Agent</code></summary>
 <dl>
 <dd>
 
@@ -1003,8 +1063,7 @@ await client.agents.getByExternalId("externalId");
 <dl>
 <dd>
 
-DEPRECATED: Use PUT /products/external/{externalId} instead.
-
+DEPRECATED: Use PUT /products/{productId} instead.
 </dd>
 </dl>
 </dd>
@@ -1019,10 +1078,9 @@ DEPRECATED: Use PUT /products/external/{externalId} instead.
 <dd>
 
 ```typescript
-await client.agents.updateByExternalId("externalId", {
+await client.agents.update("agentId", {
     name: "Acme Agent (Updated)",
-    agentAttributes: [
-        {
+    agentAttributes: [{
             name: "Emails sent signal",
             active: true,
             pricing: {
@@ -1032,16 +1090,26 @@ await client.agents.updateByExternalId("externalId", {
                 pricingModel: "PerUnit",
                 billingFrequency: "monthly",
                 pricePoints: {
-                    USD: {
-                        unitPrice: 150,
-                    },
-                },
-            },
-        },
-    ],
+                    "USD": {
+                        tiers: [{
+                                minQuantity: 0,
+                                maxQuantity: 10,
+                                unitPrice: 100
+                            }, {
+                                minQuantity: 11,
+                                maxQuantity: 100,
+                                unitPrice: 90
+                            }, {
+                                minQuantity: 101,
+                                unitPrice: 80
+                            }]
+                    }
+                }
+            }
+        }]
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -1055,34 +1123,35 @@ await client.agents.updateByExternalId("externalId", {
 <dl>
 <dd>
 
-**externalId:** `string`
-
+**agentId:** `string` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**request:** `Paid.AgentUpdate`
-
+**request:** `Paid.AgentUpdate` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Agents.RequestOptions`
-
+**requestOptions:** `AgentsClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">deleteByExternalId</a>(externalId) -> void</code></summary>
+<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">delete</a>(agentId) -> void</code></summary>
 <dl>
 <dd>
 
@@ -1094,8 +1163,7 @@ await client.agents.updateByExternalId("externalId", {
 <dl>
 <dd>
 
-DEPRECATED: Use DELETE /products/external/{externalId} instead.
-
+DEPRECATED: Use DELETE /products/{productId} instead.
 </dd>
 </dl>
 </dd>
@@ -1110,9 +1178,9 @@ DEPRECATED: Use DELETE /products/external/{externalId} instead.
 <dd>
 
 ```typescript
-await client.agents.deleteByExternalId("externalId");
-```
+await client.agents.delete("agentId");
 
+```
 </dd>
 </dl>
 </dd>
@@ -1126,31 +1194,44 @@ await client.agents.deleteByExternalId("externalId");
 <dl>
 <dd>
 
-**externalId:** `string`
-
+**agentId:** `string` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Agents.RequestOptions`
-
+**requestOptions:** `AgentsClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-## Products
-
-<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">list</a>() -> Paid.Product[]</code></summary>
+<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">getByExternalId</a>(externalId) -> Paid.Agent</code></summary>
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+DEPRECATED: Use GET /products/external/{externalId} instead.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1160,9 +1241,161 @@ await client.agents.deleteByExternalId("externalId");
 <dd>
 
 ```typescript
-await client.products.list();
+await client.agents.getByExternalId("externalId");
+
 ```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**externalId:** `string` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AgentsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">updateByExternalId</a>(externalId, { ...params }) -> Paid.Agent</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+DEPRECATED: Use PUT /products/external/{externalId} instead.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.agents.updateByExternalId("externalId", {
+    name: "Acme Agent (Updated)",
+    agentAttributes: [{
+            name: "Emails sent signal",
+            active: true,
+            pricing: {
+                eventName: "emails_sent",
+                taxable: true,
+                chargeType: "usage",
+                pricingModel: "PerUnit",
+                billingFrequency: "monthly",
+                pricePoints: {
+                    "USD": {
+                        unitPrice: 150
+                    }
+                }
+            }
+        }]
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**externalId:** `string` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Paid.AgentUpdate` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AgentsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">deleteByExternalId</a>(externalId) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
 
+<dl>
+<dd>
+
+DEPRECATED: Use DELETE /products/external/{externalId} instead.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.agents.deleteByExternalId("externalId");
+
+```
 </dd>
 </dl>
 </dd>
@@ -1176,12 +1409,63 @@ await client.products.list();
 <dl>
 <dd>
 
-**requestOptions:** `Products.RequestOptions`
+**externalId:** `string` 
+    
+</dd>
+</dl>
 
+<dl>
+<dd>
+
+**requestOptions:** `AgentsClient.RequestOptions` 
+    
+</dd>
+</dl>
 </dd>
 </dl>
+
+
 </dd>
 </dl>
+</details>
+
+## Products
+<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">list</a>() -> Paid.Product[]</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.products.list();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `ProductsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
 
 </dd>
 </dl>
@@ -1204,10 +1488,10 @@ await client.products.create({
     name: "Acme Product",
     description: "Acme Product does amazing things.",
     externalId: "acme-product",
-    type: "product",
+    type: "product"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -1221,21 +1505,22 @@ await client.products.create({
 <dl>
 <dd>
 
-**request:** `Paid.ProductCreate`
-
+**request:** `Paid.ProductCreate` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Products.RequestOptions`
-
+**requestOptions:** `ProductsClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -1254,8 +1539,8 @@ await client.products.create({
 
 ```typescript
 await client.products.get("productId");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -1269,21 +1554,22 @@ await client.products.get("productId");
 <dl>
 <dd>
 
-**productId:** `string`
-
+**productId:** `string` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Products.RequestOptions`
-
+**requestOptions:** `ProductsClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -1302,8 +1588,8 @@ await client.products.get("productId");
 
 ```typescript
 await client.products.update("productId", {});
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -1317,29 +1603,30 @@ await client.products.update("productId", {});
 <dl>
 <dd>
 
-**productId:** `string`
-
+**productId:** `string` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**request:** `Paid.ProductUpdate`
-
+**request:** `Paid.ProductUpdate` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Products.RequestOptions`
-
+**requestOptions:** `ProductsClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -1358,8 +1645,8 @@ await client.products.update("productId", {});
 
 ```typescript
 await client.products.delete("productId");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -1373,21 +1660,22 @@ await client.products.delete("productId");
 <dl>
 <dd>
 
-**productId:** `string`
-
+**productId:** `string` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Products.RequestOptions`
-
+**requestOptions:** `ProductsClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -1406,8 +1694,57 @@ await client.products.delete("productId");
 
 ```typescript
 await client.products.getByExternalId("externalId");
+
 ```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
 
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**externalId:** `string` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ProductsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">updateByExternalId</a>(externalId, { ...params }) -> Paid.Product</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.products.updateByExternalId("externalId", {});
+
+```
 </dd>
 </dl>
 </dd>
@@ -1421,26 +1758,85 @@ await client.products.getByExternalId("externalId");
 <dl>
 <dd>
 
-**externalId:** `string`
+**externalId:** `string` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Paid.ProductUpdate` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ProductsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">deleteByExternalId</a>(externalId) -> void</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.products.deleteByExternalId("externalId");
 
+```
+</dd>
+</dl>
 </dd>
 </dl>
 
+#### ⚙️ Parameters
+
 <dl>
 <dd>
 
-**requestOptions:** `Products.RequestOptions`
+<dl>
+<dd>
 
+**externalId:** `string` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ProductsClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">updateByExternalId</a>(externalId, { ...params }) -> Paid.Product</code></summary>
+## Contacts
+<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">list</a>() -> Paid.Contact[]</code></summary>
 <dl>
 <dd>
 
@@ -1453,9 +1849,56 @@ await client.products.getByExternalId("externalId");
 <dd>
 
 ```typescript
-await client.products.updateByExternalId("externalId", {});
+await client.contacts.list();
+
 ```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
 
+<dl>
+<dd>
+
+**requestOptions:** `ContactsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">create</a>({ ...params }) -> Paid.Contact</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.contacts.create({
+    customerExternalId: "acme-inc",
+    salutation: "Mr.",
+    firstName: "John",
+    lastName: "Doe",
+    email: "john.doe@example.com"
+});
+
+```
 </dd>
 </dl>
 </dd>
@@ -1469,34 +1912,76 @@ await client.products.updateByExternalId("externalId", {});
 <dl>
 <dd>
 
-**externalId:** `string`
+**request:** `Paid.ContactCreate` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
 
+**requestOptions:** `ContactsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">get</a>(contactId) -> Paid.Contact</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.contacts.get("contactId");
+
+```
+</dd>
+</dl>
 </dd>
 </dl>
 
+#### ⚙️ Parameters
+
 <dl>
 <dd>
 
-**request:** `Paid.ProductUpdate`
+<dl>
+<dd>
 
+**contactId:** `string` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Products.RequestOptions`
-
+**requestOptions:** `ContactsClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-<details><summary><code>client.products.<a href="/src/api/resources/products/client/Client.ts">deleteByExternalId</a>(externalId) -> void</code></summary>
+<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">delete</a>(contactId) -> void</code></summary>
 <dl>
 <dd>
 
@@ -1509,9 +1994,9 @@ await client.products.updateByExternalId("externalId", {});
 <dd>
 
 ```typescript
-await client.products.deleteByExternalId("externalId");
-```
+await client.contacts.delete("contactId");
 
+```
 </dd>
 </dl>
 </dd>
@@ -1525,28 +2010,27 @@ await client.products.deleteByExternalId("externalId");
 <dl>
 <dd>
 
-**externalId:** `string`
-
+**contactId:** `string` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Products.RequestOptions`
-
+**requestOptions:** `ContactsClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-## Contacts
-
-<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">list</a>() -> Paid.Contact[]</code></summary>
+<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">getByExternalId</a>(externalId) -> Paid.Contact</code></summary>
 <dl>
 <dd>
 
@@ -1559,9 +2043,9 @@ await client.products.deleteByExternalId("externalId");
 <dd>
 
 ```typescript
-await client.contacts.list();
-```
+await client.contacts.getByExternalId("externalId");
 
+```
 </dd>
 </dl>
 </dd>
@@ -1575,18 +2059,27 @@ await client.contacts.list();
 <dl>
 <dd>
 
-**requestOptions:** `Contacts.RequestOptions`
+**externalId:** `string` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
 
+**requestOptions:** `ContactsClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">create</a>({ ...params }) -> Paid.Contact</code></summary>
+<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">deleteByExternalId</a>(externalId) -> void</code></summary>
 <dl>
 <dd>
 
@@ -1599,15 +2092,9 @@ await client.contacts.list();
 <dd>
 
 ```typescript
-await client.contacts.create({
-    customerExternalId: "acme-inc",
-    salutation: "Mr.",
-    firstName: "John",
-    lastName: "Doe",
-    email: "john.doe@example.com",
-});
-```
+await client.contacts.deleteByExternalId("externalId");
 
+```
 </dd>
 </dl>
 </dd>
@@ -1621,26 +2108,28 @@ await client.contacts.create({
 <dl>
 <dd>
 
-**request:** `Paid.ContactCreate`
-
+**externalId:** `string` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Contacts.RequestOptions`
-
+**requestOptions:** `ContactsClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">get</a>(contactId) -> Paid.Contact</code></summary>
+## Orders
+<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">list</a>() -> Paid.Order[]</code></summary>
 <dl>
 <dd>
 
@@ -1653,9 +2142,9 @@ await client.contacts.create({
 <dd>
 
 ```typescript
-await client.contacts.get("contactId");
-```
+await client.orders.list();
 
+```
 </dd>
 </dl>
 </dd>
@@ -1669,26 +2158,19 @@ await client.contacts.get("contactId");
 <dl>
 <dd>
 
-**contactId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Contacts.RequestOptions`
-
+**requestOptions:** `OrdersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">delete</a>(contactId) -> void</code></summary>
+<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">create</a>({ ...params }) -> Paid.Order</code></summary>
 <dl>
 <dd>
 
@@ -1701,9 +2183,16 @@ await client.contacts.get("contactId");
 <dd>
 
 ```typescript
-await client.contacts.delete("contactId");
-```
+await client.orders.create({
+    customerExternalId: "acme-inc",
+    name: "Acme Order",
+    description: "Acme Order is an order for Acme, Inc.",
+    startDate: "2025-01-01",
+    endDate: "2026-01-01",
+    currency: "USD"
+});
 
+```
 </dd>
 </dl>
 </dd>
@@ -1717,26 +2206,27 @@ await client.contacts.delete("contactId");
 <dl>
 <dd>
 
-**contactId:** `string`
-
+**request:** `Paid.OrderCreate` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Contacts.RequestOptions`
-
+**requestOptions:** `OrdersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">getByExternalId</a>(externalId) -> Paid.Contact</code></summary>
+<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">get</a>(orderId) -> Paid.Order</code></summary>
 <dl>
 <dd>
 
@@ -1749,9 +2239,9 @@ await client.contacts.delete("contactId");
 <dd>
 
 ```typescript
-await client.contacts.getByExternalId("externalId");
-```
+await client.orders.get("orderId");
 
+```
 </dd>
 </dl>
 </dd>
@@ -1765,26 +2255,27 @@ await client.contacts.getByExternalId("externalId");
 <dl>
 <dd>
 
-**externalId:** `string`
-
+**orderId:** `string` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Contacts.RequestOptions`
-
+**requestOptions:** `OrdersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">deleteByExternalId</a>(externalId) -> void</code></summary>
+<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">delete</a>(orderId) -> void</code></summary>
 <dl>
 <dd>
 
@@ -1797,9 +2288,9 @@ await client.contacts.getByExternalId("externalId");
 <dd>
 
 ```typescript
-await client.contacts.deleteByExternalId("externalId");
-```
+await client.orders.delete("orderId");
 
+```
 </dd>
 </dl>
 </dd>
@@ -1813,28 +2304,27 @@ await client.contacts.deleteByExternalId("externalId");
 <dl>
 <dd>
 
-**externalId:** `string`
-
+**orderId:** `string` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Contacts.RequestOptions`
-
+**requestOptions:** `OrdersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-## Orders
-
-<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">list</a>() -> Paid.Order[]</code></summary>
+<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">activate</a>(orderId) -> Paid.Order</code></summary>
 <dl>
 <dd>
 
@@ -1847,9 +2337,9 @@ await client.contacts.deleteByExternalId("externalId");
 <dd>
 
 ```typescript
-await client.orders.list();
-```
+await client.orders.activate("orderId");
 
+```
 </dd>
 </dl>
 </dd>
@@ -1863,21 +2353,44 @@ await client.orders.list();
 <dl>
 <dd>
 
-**requestOptions:** `Orders.RequestOptions`
+**orderId:** `string` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
 
+**requestOptions:** `OrdersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">create</a>({ ...params }) -> Paid.Order</code></summary>
+<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">activateAndPay</a>(orderId, { ...params }) -> Paid.Order</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
 <dl>
 <dd>
 
+<dl>
+<dd>
+
+Activates the order and processes the initial payment using the provided Stripe confirmation token.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1887,16 +2400,12 @@ await client.orders.list();
 <dd>
 
 ```typescript
-await client.orders.create({
-    customerExternalId: "acme-inc",
-    name: "Acme Order",
-    description: "Acme Order is an order for Acme, Inc.",
-    startDate: "2025-01-01",
-    endDate: "2026-01-01",
-    currency: "USD",
+await client.orders.activateAndPay("orderId", {
+    confirmationToken: "ctoken_1234567890",
+    returnUrl: "https://example.com/payment-complete"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -1910,29 +2419,52 @@ await client.orders.create({
 <dl>
 <dd>
 
-**request:** `Paid.OrderCreate`
-
+**orderId:** `string` — The order ID (can be internal ID or display ID)
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Orders.RequestOptions`
+**request:** `Paid.OrdersActivateAndPayRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
 
+**requestOptions:** `OrdersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">get</a>(orderId) -> Paid.Order</code></summary>
+<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">cancelRenewal</a>(orderId, { ...params }) -> Paid.CancelRenewalResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
 <dl>
 <dd>
 
+Schedules the cancellation of an order's renewal from a specified date. The order will remain active until the cancellation date.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1942,9 +2474,12 @@ await client.orders.create({
 <dd>
 
 ```typescript
-await client.orders.get("orderId");
-```
+await client.orders.cancelRenewal("orderId", {
+    orderVersion: 1,
+    cancelFromDate: "2025-12-31T00:00:00Z"
+});
 
+```
 </dd>
 </dl>
 </dd>
@@ -1958,29 +2493,52 @@ await client.orders.get("orderId");
 <dl>
 <dd>
 
-**orderId:** `string`
-
+**orderId:** `string` — The order ID (can be internal ID or display ID)
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Orders.RequestOptions`
+**request:** `Paid.CancelRenewalRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
 
+**requestOptions:** `OrdersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">delete</a>(orderId) -> void</code></summary>
+<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">schedulePlanChange</a>(orderId, { ...params }) -> Paid.ProrationUpgradeResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
 <dl>
 <dd>
 
+Schedules a plan upgrade or downgrade for an order with automatic proration calculation. Credits are applied for the unused portion of the current billing period.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1990,9 +2548,20 @@ await client.orders.get("orderId");
 <dd>
 
 ```typescript
-await client.orders.delete("orderId");
-```
+await client.orders.schedulePlanChange("orderId", {
+    orderVersion: 1,
+    effectiveDate: "2025-02-01T00:00:00Z",
+    updatedOrderLineAttributes: [{
+            orderLineAttributeId: "a1b2c3d4-5678-90ab-cdef-1234567890ab",
+            newPricing: {
+                "unitPrice": 200,
+                "currency": "USD"
+            },
+            newQuantity: 10
+        }]
+});
 
+```
 </dd>
 </dl>
 </dd>
@@ -2006,29 +2575,52 @@ await client.orders.delete("orderId");
 <dl>
 <dd>
 
-**orderId:** `string`
-
+**orderId:** `string` — The order ID (can be internal ID or display ID)
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Orders.RequestOptions`
+**request:** `Paid.ProrationUpgradeRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
 
+**requestOptions:** `OrdersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
-<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">activate</a>(orderId) -> Paid.Order</code></summary>
+<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">getInvoices</a>(orderId) -> Paid.Invoice[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
 <dl>
 <dd>
 
+<dl>
+<dd>
+
+Retrieves all invoices associated with a specific order.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -2038,9 +2630,9 @@ await client.orders.delete("orderId");
 <dd>
 
 ```typescript
-await client.orders.activate("orderId");
-```
+await client.orders.getInvoices("orderId");
 
+```
 </dd>
 </dl>
 </dd>
@@ -2054,27 +2646,27 @@ await client.orders.activate("orderId");
 <dl>
 <dd>
 
-**orderId:** `string`
-
+**orderId:** `string` — The order ID (can be internal ID or display ID)
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Orders.RequestOptions`
-
+**requestOptions:** `OrdersClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Plans
-
 <details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">getById</a>(planId) -> Paid.Plan</code></summary>
 <dl>
 <dd>
@@ -2089,8 +2681,8 @@ await client.orders.activate("orderId");
 
 ```typescript
 await client.plans.getById("planId");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2105,20 +2697,21 @@ await client.plans.getById("planId");
 <dd>
 
 **planId:** `string` — The ID of the plan
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Plans.RequestOptions`
-
+**requestOptions:** `PlansClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -2141,10 +2734,10 @@ await client.plans.getUsage("planId", {
     limit: 1,
     offset: 1,
     startTime: "2024-01-15T09:30:00Z",
-    endTime: "2024-01-15T09:30:00Z",
+    endTime: "2024-01-15T09:30:00Z"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2159,28 +2752,29 @@ await client.plans.getUsage("planId", {
 <dd>
 
 **planId:** `string` — The ID of the plan
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**request:** `Paid.PlansGetUsageRequest`
-
+**request:** `Paid.PlansGetUsageRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Plans.RequestOptions`
-
+**requestOptions:** `PlansClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -2199,8 +2793,8 @@ await client.plans.getUsage("planId", {
 
 ```typescript
 await client.plans.getGroupById("planGroupId");
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2215,26 +2809,26 @@ await client.plans.getGroupById("planGroupId");
 <dd>
 
 **planGroupId:** `string` — The ID of the plan group
-
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Plans.RequestOptions`
-
+**requestOptions:** `PlansClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Usage
-
 <details><summary><code>client.usage.<a href="/src/api/resources/usage/client/Client.ts">recordBulk</a>({ ...params }) -> void</code></summary>
 <dl>
 <dd>
@@ -2248,7 +2842,6 @@ await client.plans.getGroupById("planGroupId");
 <dd>
 
 DEPRECATED: Use POST /usage/v2/signals/bulk instead for cleaner field names.
-
 </dd>
 </dl>
 </dd>
@@ -2264,10 +2857,10 @@ DEPRECATED: Use POST /usage/v2/signals/bulk instead for cleaner field names.
 
 ```typescript
 await client.usage.recordBulk({
-    signals: [{}, {}, {}],
+    signals: [{}, {}, {}]
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2281,21 +2874,22 @@ await client.usage.recordBulk({
 <dl>
 <dd>
 
-**request:** `Paid.UsageRecordBulkRequest`
-
+**request:** `Paid.UsageRecordBulkRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Usage.RequestOptions`
-
+**requestOptions:** `UsageClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -2314,30 +2908,26 @@ await client.usage.recordBulk({
 
 ```typescript
 await client.usage.usageRecordBulkV2({
-    signals: [
-        {
+    signals: [{
             event_name: "emails_sent",
             product_id: "63fd642c-569d-44f9-8d67-5cf4944a16cc",
-            customer_id: "7d0b6fce-d82a-433d-8315-c994f8f1d68d",
-        },
-        {
+            customer_id: "7d0b6fce-d82a-433d-8315-c994f8f1d68d"
+        }, {
             event_name: "emails_sent",
             external_product_id: "acme-product",
-            external_customer_id: "acme-inc",
-        },
-        {
+            external_customer_id: "acme-inc"
+        }, {
             event_name: "meeting_booked",
             product_id: "63fd642c-569d-44f9-8d67-5cf4944a16cc",
             external_customer_id: "acme-inc",
             data: {
-                meeting_duration: 30,
-                meeting_type: "demo",
-            },
-        },
-    ],
+                "meeting_duration": 30,
+                "meeting_type": "demo"
+            }
+        }]
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2351,21 +2941,22 @@ await client.usage.usageRecordBulkV2({
 <dl>
 <dd>
 
-**request:** `Paid.UsageRecordBulkV2Request`
-
+**request:** `Paid.UsageRecordBulkV2Request` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Usage.RequestOptions`
-
+**requestOptions:** `UsageClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
@@ -2385,10 +2976,10 @@ await client.usage.usageRecordBulkV2({
 ```typescript
 await client.usage.checkUsage({
     externalCustomerId: "acme-inc",
-    externalProductId: "acme-agent",
+    externalProductId: "acme-agent"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2402,27 +2993,27 @@ await client.usage.checkUsage({
 <dl>
 <dd>
 
-**request:** `Paid.UsageCheckUsageRequest`
-
+**request:** `Paid.UsageCheckUsageRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Usage.RequestOptions`
-
+**requestOptions:** `UsageClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Traces
-
 <details><summary><code>client.traces.<a href="/src/api/resources/traces/client/Client.ts">getTraces</a>({ ...params }) -> Paid.TracesResponse</code></summary>
 <dl>
 <dd>
@@ -2444,10 +3035,10 @@ await client.traces.getTraces({
     externalCustomerId: "externalCustomerId",
     externalProductId: "externalProductId",
     externalAgentId: "externalAgentId",
-    metadata: "metadata",
+    metadata: "metadata"
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2461,27 +3052,27 @@ await client.traces.getTraces({
 <dl>
 <dd>
 
-**request:** `Paid.GetTracesRequest`
-
+**request:** `Paid.GetTracesRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Traces.RequestOptions`
-
+**requestOptions:** `TracesClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>
 
 ## Orders Lines
-
 <details><summary><code>client.orders.lines.<a href="/src/api/resources/orders/resources/lines/client/Client.ts">update</a>(orderId, { ...params }) -> Paid.Order</code></summary>
 <dl>
 <dd>
@@ -2496,19 +3087,16 @@ await client.traces.getTraces({
 
 ```typescript
 await client.orders.lines.update("orderId", {
-    lines: [
-        {
+    lines: [{
             name: "Order Line One",
-            description: "Order Line One is an order line for Acme, Inc.",
-        },
-        {
+            description: "Order Line One is an order line for Acme, Inc."
+        }, {
             name: "Order Line Two",
-            description: "Order Line Two is an order line for Acme, Inc.",
-        },
-    ],
+            description: "Order Line Two is an order line for Acme, Inc."
+        }]
 });
-```
 
+```
 </dd>
 </dl>
 </dd>
@@ -2522,29 +3110,30 @@ await client.orders.lines.update("orderId", {
 <dl>
 <dd>
 
-**orderId:** `string`
-
+**orderId:** `string` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**request:** `Paid.orders.LinesUpdateRequest`
-
+**request:** `Paid.orders.LinesUpdateRequest` 
+    
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**requestOptions:** `Lines.RequestOptions`
-
+**requestOptions:** `LinesClient.RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
 </dl>
 
+
 </dd>
 </dl>
 </details>