@paid-ai/paid-node 1.0.1-alpha0 → 1.0.1-alpha2

package/reference.md

@@ -2775,6 +2775,220 @@ await client.plans.getUsage("planId", {
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">subscribe</a>(planId, { ...params }) -> Paid.Order</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates a new order for a customer subscribing to a plan. The order will be created with the plan's products and pricing attributes.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.plans.subscribe("planId", {
+    customerExternalId: "customerExternalId",
+    currency: "currency"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**planId:** `string` — The ID of the plan
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Paid.PlansSubscribeRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Plans.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">unsubscribe</a>(planId, { ...params }) -> Paid.CancelRenewalResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Cancels the renewal of an active order for a customer's plan subscription. The order will remain active until the cancellation date.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.plans.unsubscribe("planId", {
+    customerExternalId: "customerExternalId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**planId:** `string` — The ID of the plan
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Paid.PlansUnsubscribeRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Plans.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">upgrade</a>({ ...params }) -> Paid.ProrationUpgradeResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Upgrades a customer from one plan to another with automatic proration. Credits are applied for the unused portion of the current billing period, and the order is updated with the new plan's pricing.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.plans.upgrade({
+    customerExternalId: "customerExternalId",
+    oldPlanId: "oldPlanId",
+    newPlanId: "newPlanId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Paid.PlansUpgradeRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Plans.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -2824,6 +3038,69 @@ await client.plans.getGroupById("planGroupId");
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">getGroupPlans</a>(planGroupId) -> Paid.PlanWithFeatures[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves all plans in a plan group with their features (product-attribute pairs)
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.plans.getGroupPlans("planGroupId");
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**planGroupId:** `string` — The ID of the plan group
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Plans.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -2910,15 +3187,15 @@ await client.usage.recordBulk({
 await client.usage.usageRecordBulkV2({
     signals: [{
             event_name: "emails_sent",
-            product_id: "63fd642c-569d-44f9-8d67-5cf4944a16cc",
-            customer_id: "7d0b6fce-d82a-433d-8315-c994f8f1d68d"
+            product_id: "prod_abc123def",
+            customer_id: "cus_xyz789ghi"
         }, {
             event_name: "emails_sent",
             external_product_id: "acme-product",
             external_customer_id: "acme-inc"
         }, {
             event_name: "meeting_booked",
-            product_id: "63fd642c-569d-44f9-8d67-5cf4944a16cc",
+            product_id: "prod_abc123def",
             external_customer_id: "acme-inc",
             data: {
                 "meeting_duration": 30,