@flexprice/sdk 2.1.37 → 2.1.39

package/docs/sdk/models/pause-subscription-request-request.md

@@ -0,0 +1,19 @@
+# PauseSubscriptionRequestRequest
+
+## Example Usage
+
+```typescript
+import { PauseSubscriptionRequestRequest } from "@flexprice/sdk/sdk/models";
+
+let value: PauseSubscriptionRequestRequest = {
+  id: "<id>",
+  body: {},
+};
+```
+
+## Fields
+
+| Field                                                                             | Type                                                                              | Required                                                                          | Description                                                                       |
+| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
+| `id`                                                                              | *string*                                                                          | :heavy_check_mark:                                                                | Subscription ID                                                                   |
+| `body`                                                                            | [models.PauseSubscriptionRequest](../../sdk/models/pause-subscription-request.md) | :heavy_check_mark:                                                                | Pause subscription request                                                        |

package/docs/sdk/models/pause-subscription-request.md

@@ -0,0 +1,19 @@
+# PauseSubscriptionRequest
+
+Pauses an active subscription now. Usage and arrear fixed charges up to the pause are billed on a closing invoice.
+
+## Example Usage
+
+```typescript
+import { PauseSubscriptionRequest } from "@flexprice/sdk/sdk/models";
+
+let value: PauseSubscriptionRequest = {};
+```
+
+## Fields
+
+| Field                                                                                                                                                     | Type                                                                                                                                                      | Required                                                                                                                                                  | Description                                                                                                                                               |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `metadata`                                                                                                                                                | Record<string, *string*>                                                                                                                                  | :heavy_minus_sign:                                                                                                                                        | Metadata stored on the pause<br/>@Example {"requested_by": "customer", "channel": "support_ticket"}                                                       |
+| `prorationBehavior`                                                                                                                                       | [models.ProrationBehavior](../../sdk/models/proration-behavior.md)                                                                                        | :heavy_minus_sign:                                                                                                                                        | N/A                                                                                                                                                       |
+| `reason`                                                                                                                                                  | *string*                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                        | Reason for pausing the subscription<br/>@Description Optional reason for the pause. Maximum 255 characters<br/>@Example "Customer requested temporary suspension" |

package/docs/sdk/models/pause-subscription-response.md

@@ -0,0 +1,127 @@
+# PauseSubscriptionResponse
+
+The paused subscription and its pause
+
+## Example Usage
+
+```typescript
+import { PauseSubscriptionResponse } from "@flexprice/sdk/sdk/models";
+
+let value: PauseSubscriptionResponse = {
+  subscription: {
+    couponAssociations: [
+      {
+        subscriptionLineItem: {
+          price: {
+            addon: {
+              prices: [
+                {
+                  addon: {},
+                  meter: {
+                    createdAt: new Date("2024-03-20T15:04:05Z"),
+                    eventName: "api_request",
+                    id: "550e8400-e29b-41d4-a716-446655440000",
+                    name: "API Usage Meter",
+                    status: "published",
+                    tenantId: "tenant123",
+                    updatedAt: new Date("2024-03-20T15:04:05Z"),
+                  },
+                  plan: {},
+                },
+              ],
+            },
+            meter: {
+              createdAt: new Date("2024-03-20T15:04:05Z"),
+              eventName: "api_request",
+              id: "550e8400-e29b-41d4-a716-446655440000",
+              name: "API Usage Meter",
+              status: "published",
+              tenantId: "tenant123",
+              updatedAt: new Date("2024-03-20T15:04:05Z"),
+            },
+            plan: {},
+          },
+        },
+      },
+    ],
+    entitlements: [
+      {
+        feature: {
+          meter: {
+            createdAt: new Date("2024-03-20T15:04:05Z"),
+            eventName: "api_request",
+            id: "550e8400-e29b-41d4-a716-446655440000",
+            name: "API Usage Meter",
+            status: "published",
+            tenantId: "tenant123",
+            updatedAt: new Date("2024-03-20T15:04:05Z"),
+          },
+        },
+      },
+    ],
+    latestInvoice: {
+      subscription: {
+        couponAssociations: [
+          {
+            subscriptionLineItem: {
+              price: {
+                addon: {
+                  prices: [
+                    {
+                      addon: {},
+                      meter: {
+                        createdAt: new Date("2024-03-20T15:04:05Z"),
+                        eventName: "api_request",
+                        id: "550e8400-e29b-41d4-a716-446655440000",
+                        name: "API Usage Meter",
+                        status: "published",
+                        tenantId: "tenant123",
+                        updatedAt: new Date("2024-03-20T15:04:05Z"),
+                      },
+                      plan: {},
+                    },
+                  ],
+                },
+                meter: {
+                  createdAt: new Date("2024-03-20T15:04:05Z"),
+                  eventName: "api_request",
+                  id: "550e8400-e29b-41d4-a716-446655440000",
+                  name: "API Usage Meter",
+                  status: "published",
+                  tenantId: "tenant123",
+                  updatedAt: new Date("2024-03-20T15:04:05Z"),
+                },
+                plan: {},
+              },
+            },
+          },
+        ],
+        entitlements: [
+          {
+            feature: {
+              meter: {
+                createdAt: new Date("2024-03-20T15:04:05Z"),
+                eventName: "api_request",
+                id: "550e8400-e29b-41d4-a716-446655440000",
+                name: "API Usage Meter",
+                status: "published",
+                tenantId: "tenant123",
+                updatedAt: new Date("2024-03-20T15:04:05Z"),
+              },
+            },
+          },
+        ],
+        plan: {},
+      },
+    },
+    plan: {},
+  },
+};
+```
+
+## Fields
+
+| Field                                                                               | Type                                                                                | Required                                                                            | Description                                                                         |
+| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
+| `pause`                                                                             | [models.SubscriptionPauseResponse](../../sdk/models/subscription-pause-response.md) | :heavy_minus_sign:                                                                  | Response object containing subscription pause information                           |
+| `subscription`                                                                      | [models.SubscriptionResponse](../../sdk/models/subscription-response.md)            | :heavy_minus_sign:                                                                  | N/A                                                                                 |

package/docs/sdk/models/payment-terms.md

@@ -13,5 +13,5 @@ let value: PaymentTerms = "30 NET";
 ## Values
 
 ```typescript
-"15 NET" | "30 NET" | "45 NET" | "60 NET" | "75 NET" | "90 NET" | Unrecognized<string>
+"15 NET" | "30 NET" | "45 NET" | "60 NET" | "75 NET" | "90 NET" | "END_OF_MONTH" | "END_OF_NEXT_MONTH" | Unrecognized<string>
 ```

package/docs/sdk/models/resume-subscription-request-request.md

@@ -0,0 +1,19 @@
+# ResumeSubscriptionRequestRequest
+
+## Example Usage
+
+```typescript
+import { ResumeSubscriptionRequestRequest } from "@flexprice/sdk/sdk/models";
+
+let value: ResumeSubscriptionRequestRequest = {
+  id: "<id>",
+  body: {},
+};
+```
+
+## Fields
+
+| Field                                                                               | Type                                                                                | Required                                                                            | Description                                                                         |
+| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
+| `id`                                                                                | *string*                                                                            | :heavy_check_mark:                                                                  | Subscription ID                                                                     |
+| `body`                                                                              | [models.ResumeSubscriptionRequest](../../sdk/models/resume-subscription-request.md) | :heavy_check_mark:                                                                  | Resume subscription request                                                         |

package/docs/sdk/models/resume-subscription-request.md

@@ -0,0 +1,18 @@
+# ResumeSubscriptionRequest
+
+Resumes a paused subscription now. The billing anchor is kept, so the first period runs from the resume time to the next billing date.
+
+## Example Usage
+
+```typescript
+import { ResumeSubscriptionRequest } from "@flexprice/sdk/sdk/models";
+
+let value: ResumeSubscriptionRequest = {};
+```
+
+## Fields
+
+| Field                                                              | Type                                                               | Required                                                           | Description                                                        |
+| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
+| `metadata`                                                         | Record<string, *string*>                                           | :heavy_minus_sign:                                                 | Metadata merged into the pause<br/>@Example {"resumed_by": "admin"} |
+| `prorationBehavior`                                                | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign:                                                 | N/A                                                                |

package/docs/sdk/models/resume-subscription-response.md

@@ -0,0 +1,127 @@
+# ResumeSubscriptionResponse
+
+The resumed subscription and the pause it ended
+
+## Example Usage
+
+```typescript
+import { ResumeSubscriptionResponse } from "@flexprice/sdk/sdk/models";
+
+let value: ResumeSubscriptionResponse = {
+  subscription: {
+    couponAssociations: [
+      {
+        subscriptionLineItem: {
+          price: {
+            addon: {
+              prices: [
+                {
+                  addon: {},
+                  meter: {
+                    createdAt: new Date("2024-03-20T15:04:05Z"),
+                    eventName: "api_request",
+                    id: "550e8400-e29b-41d4-a716-446655440000",
+                    name: "API Usage Meter",
+                    status: "published",
+                    tenantId: "tenant123",
+                    updatedAt: new Date("2024-03-20T15:04:05Z"),
+                  },
+                  plan: {},
+                },
+              ],
+            },
+            meter: {
+              createdAt: new Date("2024-03-20T15:04:05Z"),
+              eventName: "api_request",
+              id: "550e8400-e29b-41d4-a716-446655440000",
+              name: "API Usage Meter",
+              status: "published",
+              tenantId: "tenant123",
+              updatedAt: new Date("2024-03-20T15:04:05Z"),
+            },
+            plan: {},
+          },
+        },
+      },
+    ],
+    entitlements: [
+      {
+        feature: {
+          meter: {
+            createdAt: new Date("2024-03-20T15:04:05Z"),
+            eventName: "api_request",
+            id: "550e8400-e29b-41d4-a716-446655440000",
+            name: "API Usage Meter",
+            status: "published",
+            tenantId: "tenant123",
+            updatedAt: new Date("2024-03-20T15:04:05Z"),
+          },
+        },
+      },
+    ],
+    latestInvoice: {
+      subscription: {
+        couponAssociations: [
+          {
+            subscriptionLineItem: {
+              price: {
+                addon: {
+                  prices: [
+                    {
+                      addon: {},
+                      meter: {
+                        createdAt: new Date("2024-03-20T15:04:05Z"),
+                        eventName: "api_request",
+                        id: "550e8400-e29b-41d4-a716-446655440000",
+                        name: "API Usage Meter",
+                        status: "published",
+                        tenantId: "tenant123",
+                        updatedAt: new Date("2024-03-20T15:04:05Z"),
+                      },
+                      plan: {},
+                    },
+                  ],
+                },
+                meter: {
+                  createdAt: new Date("2024-03-20T15:04:05Z"),
+                  eventName: "api_request",
+                  id: "550e8400-e29b-41d4-a716-446655440000",
+                  name: "API Usage Meter",
+                  status: "published",
+                  tenantId: "tenant123",
+                  updatedAt: new Date("2024-03-20T15:04:05Z"),
+                },
+                plan: {},
+              },
+            },
+          },
+        ],
+        entitlements: [
+          {
+            feature: {
+              meter: {
+                createdAt: new Date("2024-03-20T15:04:05Z"),
+                eventName: "api_request",
+                id: "550e8400-e29b-41d4-a716-446655440000",
+                name: "API Usage Meter",
+                status: "published",
+                tenantId: "tenant123",
+                updatedAt: new Date("2024-03-20T15:04:05Z"),
+              },
+            },
+          },
+        ],
+        plan: {},
+      },
+    },
+    plan: {},
+  },
+};
+```
+
+## Fields
+
+| Field                                                                               | Type                                                                                | Required                                                                            | Description                                                                         |
+| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
+| `pause`                                                                             | [models.SubscriptionPauseResponse](../../sdk/models/subscription-pause-response.md) | :heavy_minus_sign:                                                                  | Response object containing subscription pause information                           |
+| `subscription`                                                                      | [models.SubscriptionResponse](../../sdk/models/subscription-response.md)            | :heavy_minus_sign:                                                                  | N/A                                                                                 |

package/docs/sdk/models/state.md

@@ -0,0 +1,14 @@
+# State
+
+## Example Usage
+
+```typescript
+import { State } from "@flexprice/sdk/sdk/models";
+
+let value: State = {};
+```
+
+## Fields
+
+| Field       | Type        | Required    | Description |
+| ----------- | ----------- | ----------- | ----------- |

package/docs/sdk/models/sub-modify-grouped-invoicing-params.md

@@ -6,14 +6,15 @@
 import { SubModifyGroupedInvoicingParams } from "@flexprice/sdk/sdk/models";
 
 let value: SubModifyGroupedInvoicingParams = {
-  action: "remove",
+  action: "modify",
 };
 ```
 
 ## Fields
 
-| Field                                                                         | Type                                                                          | Required                                                                      | Description                                                                   |
-| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
-| `action`                                                                      | [models.GroupedInvoicingAction](../../sdk/models/grouped-invoicing-action.md) | :heavy_check_mark:                                                            | N/A                                                                           |
-| `childSubscriptionIds`                                                        | *string*[]                                                                    | :heavy_minus_sign:                                                            | N/A                                                                           |
-| `parentSubscriptionId`                                                        | *string*                                                                      | :heavy_minus_sign:                                                            | ParentSubscriptionID is required for action 'add'.                            |
+| Field                                                                           | Type                                                                            | Required                                                                        | Description                                                                     |
+| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
+| `action`                                                                        | [models.GroupedInvoicingAction](../../sdk/models/grouped-invoicing-action.md)   | :heavy_check_mark:                                                              | N/A                                                                             |
+| `changes`                                                                       | [models.GroupedInvoicingChange](../../sdk/models/grouped-invoicing-change.md)[] | :heavy_minus_sign:                                                              | Changes is required for action 'modify'; the path subscription is the parent.   |
+| `childSubscriptionIds`                                                          | *string*[]                                                                      | :heavy_minus_sign:                                                              | N/A                                                                             |
+| `parentSubscriptionId`                                                          | *string*                                                                        | :heavy_minus_sign:                                                              | ParentSubscriptionID is required for action 'add'.                              |

package/docs/sdk/models/subscription-pause-response.md

@@ -0,0 +1,35 @@
+# SubscriptionPauseResponse
+
+Response object containing subscription pause information
+
+## Example Usage
+
+```typescript
+import { SubscriptionPauseResponse } from "@flexprice/sdk/sdk/models";
+
+let value: SubscriptionPauseResponse = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `createdAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `createdBy`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `environmentId`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | EnvironmentID is the environment identifier for the pause                                     |
+| `id`                                                                                          | *string*                                                                                      | :heavy_minus_sign:                                                                            | ID is the unique identifier for the subscription pause                                        |
+| `metadata`                                                                                    | Record<string, *string*>                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `originalPeriodEnd`                                                                           | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | OriginalPeriodEnd is the end of the billing period when the pause was created                 |
+| `originalPeriodStart`                                                                         | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | OriginalPeriodStart is the start of the billing period when the pause was created             |
+| `pauseEnd`                                                                                    | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | PauseEnd is when the pause will end (null for indefinite)                                     |
+| `pauseMode`                                                                                   | [models.PauseMode](../../sdk/models/pause-mode.md)                                            | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `pauseStart`                                                                                  | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | PauseStart is when the pause actually started                                                 |
+| `pauseStatus`                                                                                 | [models.PauseStatus](../../sdk/models/pause-status.md)                                        | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `reason`                                                                                      | *string*                                                                                      | :heavy_minus_sign:                                                                            | Reason is the reason for pausing                                                              |
+| `resumeMode`                                                                                  | [models.ResumeMode](../../sdk/models/resume-mode.md)                                          | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `resumedAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | ResumedAt is when the pause was actually ended (if manually resumed)                          |
+| `status`                                                                                      | [models.Status](../../sdk/models/status.md)                                                   | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `subscriptionId`                                                                              | *string*                                                                                      | :heavy_minus_sign:                                                                            | SubscriptionID is the identifier for the subscription                                         |
+| `tenantId`                                                                                    | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `updatedAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `updatedBy`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |

package/docs/sdk/models/sync-addon-prices-request.md

@@ -0,0 +1,17 @@
+# SyncAddonPricesRequest
+
+## Example Usage
+
+```typescript
+import { SyncAddonPricesRequest } from "@flexprice/sdk/sdk/models";
+
+let value: SyncAddonPricesRequest = {
+  id: "<id>",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `id`               | *string*           | :heavy_check_mark: | Addon ID           |

package/docs/sdk/models/update-customer-request-request.md

@@ -6,13 +6,7 @@
 import { UpdateCustomerRequestRequest } from "@flexprice/sdk/sdk/models";
 
 let value: UpdateCustomerRequestRequest = {
-  body: {
-    contactPersons: [
-      {
-        firstName: "Ryan",
-      },
-    ],
-  },
+  body: {},
 };
 ```
 

package/docs/sdk/models/update-customer-request.md

@@ -7,9 +7,7 @@ Request object for updating an existing customer. All fields are optional - only
 ```typescript
 import { UpdateCustomerRequest } from "@flexprice/sdk/sdk/models";
 
-let value: UpdateCustomerRequest = {
-  contactPersons: [],
-};
+let value: UpdateCustomerRequest = {};
 ```
 
 ## Fields
@@ -24,7 +22,7 @@ let value: UpdateCustomerRequest = {
 | `addressState`                                                                                                  | *string*                                                                                                        | :heavy_minus_sign:                                                                                              | address_state is the updated state, province, or region name with maximum 100 characters                        |
 | `billingCurrency`                                                                                               | *string*                                                                                                        | :heavy_minus_sign:                                                                                              | billing_currency updates the invoicing currency; send "" to clear it back to the charge currency                |
 | `contact`                                                                                                       | *string*                                                                                                        | :heavy_minus_sign:                                                                                              | contact is the updated contact number for the customer (e.g. phone)                                             |
-| `contactPersons`                                                                                                | [models.CustomerContactPerson](../../sdk/models/customer-contact-person.md)[]                                   | :heavy_check_mark:                                                                                              | contact_persons replaces the customer's contact persons when provided; at most one may be primary               |
+| `contactPersons`                                                                                                | [models.CustomerContactPerson](../../sdk/models/customer-contact-person.md)[]                                   | :heavy_minus_sign:                                                                                              | contact_persons replaces the customer's contact persons when provided; at most one may be primary               |
 | `email`                                                                                                         | *string*                                                                                                        | :heavy_minus_sign:                                                                                              | email is the updated email address and must be a valid email format if provided                                 |
 | `externalId`                                                                                                    | *string*                                                                                                        | :heavy_minus_sign:                                                                                              | external_id is the updated external identifier for the customer                                                 |
 | `integrationEntityMapping`                                                                                      | [models.CreateEntityIntegrationMappingRequest](../../sdk/models/create-entity-integration-mapping-request.md)[] | :heavy_minus_sign:                                                                                              | integration_entity_mapping contains provider integration mappings for this customer                             |