npm - @flexprice/sdk - Versions diffs - 2.1.20 → 2.1.25 - Mend

@flexprice/sdk 2.1.20 → 2.1.25

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1402) hide show

package/docs/sdk/models/subscription-filter.md CHANGED Viewed

@@ -10,29 +10,30 @@ let value: SubscriptionFilter = {};
 ## Fields
-| Field                                                                                                                                                                                                                                                                                                      | Type                                                                                                                                                                                                                                                                                                       | Required                                                                                                                                                                                                                                                                                                   | Description                                                                                                                                                                                                                                                                                                |
-| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `activeAt`                                                                                                                                                                                                                                                                                                 | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | ActiveAt filters subscriptions that are active at the given time                                                                                                                                                                                                                                           |
-| `billingCadence`                                                                                                                                                                                                                                                                                           | [models.BillingCadence](../../sdk/models/billing-cadence.md)[]                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | BillingCadence filters by billing cadence                                                                                                                                                                                                                                                                  |
-| `billingPeriod`                                                                                                                                                                                                                                                                                            | [models.BillingPeriod](../../sdk/models/billing-period.md)[]                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | BillingPeriod filters by billing period                                                                                                                                                                                                                                                                    |
-| `customerId`                                                                                                                                                                                                                                                                                               | *string*                                                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | CustomerID filters by customer ID                                                                                                                                                                                                                                                                          |
-| `customerIds`                                                                                                                                                                                                                                                                                              | *string*[]                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | CustomerIDs filters by customer IDs                                                                                                                                                                                                                                                                        |
-| `effectiveDateForUpdate`                                                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | EffectiveDateForUpdate selects subscriptions that need a billing-period pass on or before this time:<br/>current_period_end <= date OR (cancel_at IS NOT NULL AND cancel_at <= date).<br/>When nil, period/cancel cutoff logic is not applied by this field (see TimeRangeFilter for legacy period-end filtering). |
-| `endTime`                                                                                                                                                                                                                                                                                                  | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | N/A                                                                                                                                                                                                                                                                                                        |
-| `expand`                                                                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | N/A                                                                                                                                                                                                                                                                                                        |
-| `externalCustomerId`                                                                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | ExternalCustomerID filters by external customer ID                                                                                                                                                                                                                                                         |
-| `filters`                                                                                                                                                                                                                                                                                                  | [models.FilterCondition](../../sdk/models/filter-condition.md)[]                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | N/A                                                                                                                                                                                                                                                                                                        |
-| `invoicingCustomerIds`                                                                                                                                                                                                                                                                                     | *string*[]                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | InvoicingCustomerIDs filters by invoicing customer ID                                                                                                                                                                                                                                                      |
-| `limit`                                                                                                                                                                                                                                                                                                    | *number*                                                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | N/A                                                                                                                                                                                                                                                                                                        |
-| `offset`                                                                                                                                                                                                                                                                                                   | *number*                                                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | N/A                                                                                                                                                                                                                                                                                                        |
-| `order`                                                                                                                                                                                                                                                                                                    | [models.SubscriptionFilterOrder](../../sdk/models/subscription-filter-order.md)                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | N/A                                                                                                                                                                                                                                                                                                        |
-| `parentSubscriptionIds`                                                                                                                                                                                                                                                                                    | *string*[]                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | ParentSubscriptionIDs filters by parent subscription IDs                                                                                                                                                                                                                                                   |
-| `planId`                                                                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | PlanID filters by plan ID                                                                                                                                                                                                                                                                                  |
-| `sort`                                                                                                                                                                                                                                                                                                     | [models.SortCondition](../../sdk/models/sort-condition.md)[]                                                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | N/A                                                                                                                                                                                                                                                                                                        |
-| `startTime`                                                                                                                                                                                                                                                                                                | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | N/A                                                                                                                                                                                                                                                                                                        |
-| `status`                                                                                                                                                                                                                                                                                                   | [models.Status](../../sdk/models/status.md)                                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | N/A                                                                                                                                                                                                                                                                                                        |
-| `subscriptionIds`                                                                                                                                                                                                                                                                                          | *string*[]                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | N/A                                                                                                                                                                                                                                                                                                        |
-| `subscriptionStatus`                                                                                                                                                                                                                                                                                       | [models.SubscriptionStatus](../../sdk/models/subscription-status.md)[]                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | SubscriptionStatus filters by subscription status                                                                                                                                                                                                                                                          |
-| `subscriptionType`                                                                                                                                                                                                                                                                                         | [models.SubscriptionType](../../sdk/models/subscription-type.md)[]                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | SubscriptionType filters by subscription type                                                                                                                                                                                                                                                              |
-| `trialEndDueLte`                                                                                                                                                                                                                                                                                           | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | TrialEndDueLTE, when set, restricts to subscriptions with trial_end not nil and trial_end <= trial_end_due_lte.<br/>Use with subscription_status trialing for trial-end cron processing.                                                                                                                   |
-| `withLineItems`                                                                                                                                                                                                                                                                                            | *boolean*                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                         | WithLineItems includes line items in the response                                                                                                                                                                                                                                                          |
+| Field                                                                                                                                                                                                                                                                                                                                                                               | Type                                                                                                                                                                                                                                                                                                                                                                                | Required                                                                                                                                                                                                                                                                                                                                                                            | Description                                                                                                                                                                                                                                                                                                                                                                         |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `activeAt`                                                                                                                                                                                                                                                                                                                                                                          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | ActiveAt filters subscriptions that are active at the given time                                                                                                                                                                                                                                                                                                                    |
+| `billingCadence`                                                                                                                                                                                                                                                                                                                                                                    | [models.BillingCadence](../../sdk/models/billing-cadence.md)[]                                                                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | BillingCadence filters by billing cadence                                                                                                                                                                                                                                                                                                                                           |
+| `billingPeriod`                                                                                                                                                                                                                                                                                                                                                                     | [models.BillingPeriod](../../sdk/models/billing-period.md)[]                                                                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | BillingPeriod filters by billing period                                                                                                                                                                                                                                                                                                                                             |
+| `customerId`                                                                                                                                                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | CustomerID filters by customer ID                                                                                                                                                                                                                                                                                                                                                   |
+| `customerIds`                                                                                                                                                                                                                                                                                                                                                                       | *string*[]                                                                                                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | CustomerIDs filters by customer IDs                                                                                                                                                                                                                                                                                                                                                 |
+| `effectiveDateForUpdate`                                                                                                                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | EffectiveDateForUpdate selects subscriptions that need a billing-period pass on or before this time:<br/>current_period_end <= date OR (cancel_at IS NOT NULL AND cancel_at <= date).<br/>When nil, period/cancel cutoff logic is not applied by this field (see TimeRangeFilter for legacy period-end filtering).                                                                  |
+| `endTime`                                                                                                                                                                                                                                                                                                                                                                           | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                                                                 |
+| `expand`                                                                                                                                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                                                                 |
+| `externalCustomerId`                                                                                                                                                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | ExternalCustomerID filters by external customer ID                                                                                                                                                                                                                                                                                                                                  |
+| `filters`                                                                                                                                                                                                                                                                                                                                                                           | [models.FilterCondition](../../sdk/models/filter-condition.md)[]                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                                                                 |
+| `invoicingCustomerIds`                                                                                                                                                                                                                                                                                                                                                              | *string*[]                                                                                                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | InvoicingCustomerIDs filters by invoicing customer ID                                                                                                                                                                                                                                                                                                                               |
+| `limit`                                                                                                                                                                                                                                                                                                                                                                             | *number*                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                                                                 |
+| `offset`                                                                                                                                                                                                                                                                                                                                                                            | *number*                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                                                                 |
+| `order`                                                                                                                                                                                                                                                                                                                                                                             | [models.SubscriptionFilterOrder](../../sdk/models/subscription-filter-order.md)                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                                                                 |
+| `parentSubscriptionIds`                                                                                                                                                                                                                                                                                                                                                             | *string*[]                                                                                                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | ParentSubscriptionIDs filters by parent subscription IDs                                                                                                                                                                                                                                                                                                                            |
+| `planId`                                                                                                                                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | PlanID filters by plan ID                                                                                                                                                                                                                                                                                                                                                           |
+| `sort`                                                                                                                                                                                                                                                                                                                                                                              | [models.SortCondition](../../sdk/models/sort-condition.md)[]                                                                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                                                                 |
+| `startTime`                                                                                                                                                                                                                                                                                                                                                                         | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                                                                 |
+| `status`                                                                                                                                                                                                                                                                                                                                                                            | [models.Status](../../sdk/models/status.md)                                                                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                                                                 |
+| `subscriptionIds`                                                                                                                                                                                                                                                                                                                                                                   | *string*[]                                                                                                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                                                                 |
+| `subscriptionStatus`                                                                                                                                                                                                                                                                                                                                                                | [models.SubscriptionStatus](../../sdk/models/subscription-status.md)[]                                                                                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | SubscriptionStatus filters by subscription status                                                                                                                                                                                                                                                                                                                                   |
+| `subscriptionType`                                                                                                                                                                                                                                                                                                                                                                  | [models.SubscriptionType](../../sdk/models/subscription-type.md)[]                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | SubscriptionType filters by subscription type                                                                                                                                                                                                                                                                                                                                       |
+| `trialEndDueLte`                                                                                                                                                                                                                                                                                                                                                                    | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | TrialEndDueLTE, when set, restricts to subscriptions with trial_end not nil and trial_end <= trial_end_due_lte.<br/>Use with subscription_status trialing for trial-end cron processing.                                                                                                                                                                                            |
+| `withCouponAssociations`                                                                                                                                                                                                                                                                                                                                                            | *boolean*                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | WithCouponAssociations eager-loads coupon associations and their coupons.<br/><br/>Kept separate from WithLineItems because the coupon_associations table has no<br/>index leading with subscription_id, so Ent's edge load degrades to a full table<br/>scan. Only set it when the response actually surfaces the associations; the<br/>service layer back-fills it from expand="coupon_associations". |
+| `withLineItems`                                                                                                                                                                                                                                                                                                                                                                     | *boolean*                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                  | WithLineItems includes line items in the response.<br/><br/>Deprecated: use expand="subscription_line_items" instead. Retained for<br/>backwards compatibility and for internal callers that need to force-disable<br/>line item loading (set to false). The service layer ORs this with the<br/>expand check before invoking the repository.                                       |

package/docs/sdk/models/subscription-inheritance-config.md CHANGED Viewed

@@ -10,9 +10,10 @@ let value: SubscriptionInheritanceConfig = {};
 ## Fields
-| Field                                                                                                                                                                         | Type                                                                                                                                                                          | Required                                                                                                                                                                      | Description                                                                                                                                                                   |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `externalCustomerIdsToInheritSubscription`                                                                                                                                    | *string*[]                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                            | ExternalCustomerIDsToInheritSubscription: child customer external IDs for which<br/>inherited skeleton subscriptions will be created. Only valid for parent behavior.         |
-| `invoicingCustomerExternalId`                                                                                                                                                 | *string*                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                            | InvoicingCustomerExternalID sets a different billing recipient (external ID).<br/>Required for delegated; rejected for inherited; optional for others.                        |
-| `parentSubscriptionId`                                                                                                                                                        | *string*                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                            | ParentSubscriptionID links this subscription to an existing parent.<br/>Required for inherited and grouped_invoicing; rejected for standalone, delegated, parent.             |
-| `subscriptionsIdsForGroupedInvoicing`                                                                                                                                         | *string*[]                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                            | SubscriptionsIDsForGroupedInvoicing: existing standalone subscription IDs to convert to<br/>grouped_invoicing under this parent at creation time. Only valid for parent behavior. |
+| Field                                                                                                                                 | Type                                                                                                                                  | Required                                                                                                                              | Description                                                                                                                           |
+| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
+| `externalCustomerIdsToInheritSubscription`                                                                                            | *string*[]                                                                                                                            | :heavy_minus_sign:                                                                                                                    | ExternalCustomerIDsToInheritSubscription creates inherited skeleton subscriptions for child customers. Parent only.                   |
+| `groupedInvoicingChildrenToCreate`                                                                                                    | [models.GroupedInvoicingChildRequest](../../sdk/models/grouped-invoicing-child-request.md)[]                                          | :heavy_minus_sign:                                                                                                                    | N/A                                                                                                                                   |
+| `invoicingCustomerExternalId`                                                                                                         | *string*                                                                                                                              | :heavy_minus_sign:                                                                                                                    | InvoicingCustomerExternalID routes invoices to a different customer. Required for delegated; rejected for inherited.                  |
+| `parentSubscriptionId`                                                                                                                | *string*                                                                                                                              | :heavy_minus_sign:                                                                                                                    | ParentSubscriptionID links to an existing parent. Required for inherited/grouped_invoicing; rejected for standalone/delegated/parent. |
+| `subscriptionsIdsForGroupedInvoicing`                                                                                                 | *string*[]                                                                                                                            | :heavy_minus_sign:                                                                                                                    | SubscriptionsIDsForGroupedInvoicing converts existing standalone subscriptions to grouped_invoicing under this parent. Parent only.   |

package/docs/sdk/models/subscription-line-item-filter.md CHANGED Viewed

@@ -31,4 +31,5 @@ let value: SubscriptionLineItemFilter = {};
 | `sort`                                                                                            | [models.SortCondition](../../sdk/models/sort-condition.md)[]                                      | :heavy_minus_sign:                                                                                | N/A                                                                                               |
 | `startTime`                                                                                       | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)     | :heavy_minus_sign:                                                                                | N/A                                                                                               |
 | `status`                                                                                          | [models.Status](../../sdk/models/status.md)                                                       | :heavy_minus_sign:                                                                                | N/A                                                                                               |
-| `subscriptionIds`                                                                                 | *string*[]                                                                                        | :heavy_minus_sign:                                                                                | Specific filters                                                                                  |
+| `subscriptionIds`                                                                                 | *string*[]                                                                                        | :heavy_minus_sign:                                                                                | N/A                                                                                               |
+| `subscriptionLineItemIds`                                                                         | *string*[]                                                                                        | :heavy_minus_sign:                                                                                | Specific filters                                                                                  |

package/docs/sdk/models/subscription-line-item-response.md CHANGED Viewed

@@ -65,6 +65,7 @@ let value: SubscriptionLineItemResponse = {
 | `id`                                                                                            | *string*                                                                                        | :heavy_minus_sign:                                                                              | N/A                                                                                             |
 | `invoiceCadence`                                                                                | [models.InvoiceCadence](../../sdk/models/invoice-cadence.md)                                    | :heavy_minus_sign:                                                                              | N/A                                                                                             |
 | `metadata`                                                                                      | Record<string, *string*>                                                                        | :heavy_minus_sign:                                                                              | N/A                                                                                             |
+| `meter`                                                                                         | [models.MeterMeter](../../sdk/models/meter-meter.md)                                            | :heavy_minus_sign:                                                                              | N/A                                                                                             |
 | `meterDisplayName`                                                                              | *string*                                                                                        | :heavy_minus_sign:                                                                              | N/A                                                                                             |
 | `meterId`                                                                                       | *string*                                                                                        | :heavy_minus_sign:                                                                              | N/A                                                                                             |
 | `planDisplayName`                                                                               | *string*                                                                                        | :heavy_minus_sign:                                                                              | N/A                                                                                             |

package/docs/sdk/models/subscription-modification-action.md ADDED Viewed

@@ -0,0 +1,15 @@
+# SubscriptionModificationAction
+## Example Usage
+```typescript
+import { SubscriptionModificationAction } from "@flexprice/sdk/sdk/models";
+let value: SubscriptionModificationAction = "remove";
+```
+## Values
+```typescript
+"add" | "remove"
+```

package/docs/sdk/models/subscription-modify-response.md CHANGED Viewed

@@ -11,8 +11,108 @@ let value: SubscriptionModifyResponse = {
       {
         invoice: {
           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: {},
               },
             },
@@ -23,8 +123,108 @@ let value: SubscriptionModifyResponse = {
     ],
   },
   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: {},
       },
     },
@@ -35,7 +235,8 @@ let value: SubscriptionModifyResponse = {
 ## Fields
-| Field                                                                    | Type                                                                     | Required                                                                 | Description                                                              |
-| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
-| `changedResources`                                                       | [models.ChangedResources](../../sdk/models/changed-resources.md)         | :heavy_minus_sign:                                                       | N/A                                                                      |
-| `subscription`                                                           | [models.SubscriptionResponse](../../sdk/models/subscription-response.md) | :heavy_minus_sign:                                                       | N/A                                                                      |
+| Field                                                                           | Type                                                                            | Required                                                                        | Description                                                                     |
+| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
+| `changedResources`                                                              | [models.ChangedResources](../../sdk/models/changed-resources.md)                | :heavy_minus_sign:                                                              | N/A                                                                             |
+| `checkoutSession`                                                               | [models.CheckoutSessionResponse](../../sdk/models/checkout-session-response.md) | :heavy_minus_sign:                                                              | N/A                                                                             |
+| `subscription`                                                                  | [models.SubscriptionResponse](../../sdk/models/subscription-response.md)        | :heavy_minus_sign:                                                              | N/A                                                                             |

package/docs/sdk/models/subscription-modify-type.md CHANGED Viewed

@@ -5,11 +5,11 @@
 ```typescript
 import { SubscriptionModifyType } from "@flexprice/sdk/sdk/models";
-let value: SubscriptionModifyType = "tax";
+let value: SubscriptionModifyType = "addon";
 ```
 ## Values
 ```typescript
-"inheritance" | "quantity_change" | "grouped_invoicing" | "trial_end" | "coupon" | "tax"
+"inheritance" | "quantity_change" | "grouped_invoicing" | "trial_end" | "coupon" | "tax" | "addon"
 ```

package/docs/sdk/models/subscription-phase-create-request.md CHANGED Viewed

@@ -12,13 +12,13 @@ let value: SubscriptionPhaseCreateRequest = {
 ## Fields
-| Field                                                                                                                                                             | Type                                                                                                                                                              | Required                                                                                                                                                          | Description                                                                                                                                                       |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `coupons`                                                                                                                                                         | *string*[]                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                | Deprecated: use SubscriptionCoupons instead.                                                                                                                      |
-| `endDate`                                                                                                                                                         | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                     | :heavy_minus_sign:                                                                                                                                                | N/A                                                                                                                                                               |
-| `lineItemCoupons`                                                                                                                                                 | Record<string, *string*[]>                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                | Deprecated: use SubscriptionCoupons instead.                                                                                                                      |
-| `lineItems`                                                                                                                                                       | [models.CreateSubscriptionLineItemRequest](../../sdk/models/create-subscription-line-item-request.md)[]                                                           | :heavy_minus_sign:                                                                                                                                                | LineItems are extra line items to add during this phase, primarily one-time charges.<br/>Each item's start_date defaults to the phase's start_date when not provided. |
-| `metadata`                                                                                                                                                        | Record<string, *string*>                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                | N/A                                                                                                                                                               |
-| `overrideLineItems`                                                                                                                                               | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[]                                                                                | :heavy_minus_sign:                                                                                                                                                | OverrideLineItems allows customizing specific prices for this phase<br/>If not provided, phase will use the same line items as the subscription (plan prices)     |
-| `startDate`                                                                                                                                                       | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                     | :heavy_check_mark:                                                                                                                                                | N/A                                                                                                                                                               |
-| `subscriptionCoupons`                                                                                                                                             | [models.SubscriptionCouponInput](../../sdk/models/subscription-coupon-input.md)[]                                                                                 | :heavy_minus_sign:                                                                                                                                                | SubscriptionCoupons is the preferred way to attach coupons to this phase.                                                                                         |
+| Field                                                                                                   | Type                                                                                                    | Required                                                                                                | Description                                                                                             |
+| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
+| `coupons`                                                                                               | *string*[]                                                                                              | :heavy_minus_sign:                                                                                      | Deprecated: use SubscriptionCoupons instead.                                                            |
+| `endDate`                                                                                               | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)           | :heavy_minus_sign:                                                                                      | N/A                                                                                                     |
+| `lineItemCoupons`                                                                                       | Record<string, *string*[]>                                                                              | :heavy_minus_sign:                                                                                      | Deprecated: use SubscriptionCoupons instead.                                                            |
+| `lineItems`                                                                                             | [models.CreateSubscriptionLineItemRequest](../../sdk/models/create-subscription-line-item-request.md)[] | :heavy_minus_sign:                                                                                      | LineItems are extra (non-plan) line items for this phase; start_date defaults to phase start.           |
+| `metadata`                                                                                              | Record<string, *string*>                                                                                | :heavy_minus_sign:                                                                                      | N/A                                                                                                     |
+| `overrideLineItems`                                                                                     | [models.OverrideLineItemRequest](../../sdk/models/override-line-item-request.md)[]                      | :heavy_minus_sign:                                                                                      | OverrideLineItems overrides specific plan prices for this phase.                                        |
+| `startDate`                                                                                             | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)           | :heavy_check_mark:                                                                                      | N/A                                                                                                     |
+| `subscriptionCoupons`                                                                                   | [models.SubscriptionCouponInput](../../sdk/models/subscription-coupon-input.md)[]                       | :heavy_minus_sign:                                                                                      | SubscriptionCoupons is the preferred way to attach coupons to this phase.                               |