@openmeter/sdk 1.0.0-beta.209 → 1.0.0-beta.210

package/dist/src/client/schemas.d.ts

@@ -1374,6 +1374,60 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    '/api/v1/plans/{planId}/addons': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List all available add-ons for plan
+         * @description List all available add-ons for plan.
+         */
+        get: operations['listPlanAddons'];
+        put?: never;
+        /**
+         * Create new add-on assignment for plan
+         * @description Create new add-on assignment for plan.
+         */
+        post: operations['createPlanAddon'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/api/v1/plans/{planId}/addons/{planAddonId}': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get add-on assignment for plan
+         * @description Get add-on assignment for plan by id.
+         */
+        get: operations['getPlanAddon'];
+        /**
+         * Update add-on assignment for plan
+         * @description Update add-on assignment for plan.
+         */
+        put: operations['updatePlanAddon'];
+        post?: never;
+        /**
+         * Delete add-on assignment for plan
+         * @description Delete add-on assignment for plan.
+         *
+         *     Once a plan is deleted it cannot be undeleted.
+         */
+        delete: operations['deletePlanAddon'];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/api/v1/plans/{planId}/archive': {
         parameters: {
             query?: never;
@@ -2308,16 +2362,8 @@ export interface components {
              *     Expand settings govern if this includes the whole app object or just the ID references. */
             readonly apps: components['schemas']['BillingProfileAppsOrReference'];
         };
-        /** @description A discount on a price. This extends the productcatalog.Discount union to include the
-         *     billing specific extra fields required. */
-        BillingDiscount: components['schemas']['BillingDiscountPercentage'] | components['schemas']['BillingDiscountUsage'];
         /** @description A percentage discount. */
         BillingDiscountPercentage: {
-            /**
-             * @description The type of the discount. (enum property replaced by openapi-typescript)
-             * @enum {string}
-             */
-            type: 'percentage';
             /**
              * Percentage
              * @description The percentage of the discount.
@@ -2328,18 +2374,17 @@ export interface components {
              *
              *     This is used to link discounts across different invoices (progressive billing use case).
              *
-             *     If not provided, the invoicing engine will auto-generate one.
+             *     If not provided, the invoicing engine will auto-generate one. When editing an invoice line,
+             *     please make sure to keep the same correlation ID of the discount or in progressive billing
+             *     setups the discount amounts might be incorrect.
              * @example 01G65Z755AFWAKHE12NY0CQ9FH
              */
             correlationId?: string;
         };
+        /** @description The reason for the discount. */
+        BillingDiscountReason: components['schemas']['DiscountReasonMaximumSpend'] | components['schemas']['DiscountReasonRatecardPercentage'] | components['schemas']['DiscountReasonRatecardUsage'];
         /** @description A usage discount. */
         BillingDiscountUsage: {
-            /**
-             * @description The type of the discount. (enum property replaced by openapi-typescript)
-             * @enum {string}
-             */
-            type: 'usage';
             /**
              * Usage
              * @description The quantity of the usage discount.
@@ -2352,11 +2397,20 @@ export interface components {
              *
              *     This is used to link discounts across different invoices (progressive billing use case).
              *
-             *     If not provided, the invoicing engine will auto-generate one.
+             *     If not provided, the invoicing engine will auto-generate one. When editing an invoice line,
+             *     please make sure to keep the same correlation ID of the discount or in progressive billing
+             *     setups the discount amounts might be incorrect.
              * @example 01G65Z755AFWAKHE12NY0CQ9FH
              */
             correlationId?: string;
         };
+        /** @description A discount by type. */
+        BillingDiscounts: {
+            /** @description The percentage discount. */
+            percentage?: components['schemas']['BillingDiscountPercentage'];
+            /** @description The usage discount. */
+            usage?: components['schemas']['BillingDiscountUsage'];
+        };
         /** @description Party represents a person or business entity. */
         BillingParty: {
             /** @description Unique identifier for the party (if available) */
@@ -3366,20 +3420,71 @@ export interface components {
              */
             subjectKeys: string[];
         };
-        /** @description A discount on a price. */
-        Discount: components['schemas']['DiscountPercentage'] | components['schemas']['DiscountUsage'];
         /** @description Percentage discount. */
         DiscountPercentage: {
             /**
-             * @description The type of the discount. (enum property replaced by openapi-typescript)
+             * Percentage
+             * @description The percentage of the discount.
+             */
+            percentage: components['schemas']['Percentage'];
+        };
+        /** @description The reason for the discount is a maximum spend. */
+        DiscountReasonMaximumSpend: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: 'maximum_spend';
+        };
+        /** @description The reason for the discount is a ratecard percentage. */
+        DiscountReasonRatecardPercentage: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
              * @enum {string}
              */
-            type: 'percentage';
+            type: 'ratecard_percentage';
             /**
              * Percentage
              * @description The percentage of the discount.
              */
             percentage: components['schemas']['Percentage'];
+            /**
+             * @description Correlation ID for the discount.
+             *
+             *     This is used to link discounts across different invoices (progressive billing use case).
+             *
+             *     If not provided, the invoicing engine will auto-generate one. When editing an invoice line,
+             *     please make sure to keep the same correlation ID of the discount or in progressive billing
+             *     setups the discount amounts might be incorrect.
+             * @example 01G65Z755AFWAKHE12NY0CQ9FH
+             */
+            correlationId?: string;
+        };
+        /** @description The reason for the discount is a ratecard usage. */
+        DiscountReasonRatecardUsage: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: 'ratecard_usage';
+            /**
+             * Usage
+             * @description The quantity of the usage discount.
+             *
+             *     Must be positive.
+             */
+            quantity: components['schemas']['Numeric'];
+            /**
+             * @description Correlation ID for the discount.
+             *
+             *     This is used to link discounts across different invoices (progressive billing use case).
+             *
+             *     If not provided, the invoicing engine will auto-generate one. When editing an invoice line,
+             *     please make sure to keep the same correlation ID of the discount or in progressive billing
+             *     setups the discount amounts might be incorrect.
+             * @example 01G65Z755AFWAKHE12NY0CQ9FH
+             */
+            correlationId?: string;
         };
         /** @description Usage discount.
          *
@@ -3387,11 +3492,6 @@ export interface components {
          *     this means that any usage on a specific feature is considered 0 until this discount
          *     is exhausted. */
         DiscountUsage: {
-            /**
-             * @description The type of the discount. (enum property replaced by openapi-typescript)
-             * @enum {string}
-             */
-            type: 'usage';
             /**
              * Usage
              * @description The quantity of the usage discount.
@@ -3400,6 +3500,13 @@ export interface components {
              */
             quantity: components['schemas']['Numeric'];
         };
+        /** @description Discount by type on a price */
+        Discounts: {
+            /** @description The percentage discount. */
+            percentage?: components['schemas']['DiscountPercentage'];
+            /** @description The usage discount. */
+            usage?: components['schemas']['DiscountUsage'];
+        };
         /** @description Dynamic price with spend commitments. */
         DynamicPriceWithCommitments: {
             /**
@@ -4803,11 +4910,6 @@ export interface components {
             /** @description Invoice a gathering invoice */
             readonly invoice?: components['schemas']['InvoiceAvailableActionInvoiceDetails'];
         };
-        /**
-         * @description Reason code.
-         * @enum {string}
-         */
-        InvoiceDiscountReason: 'maximum_spend' | 'ratecard_discount';
         /** @description InvoiceDocumentRef is used to describe a reference to an existing document (invoice). */
         InvoiceDocumentRef: components['schemas']['CreditNoteOriginalInvoiceRef'];
         /**
@@ -4880,7 +4982,7 @@ export interface components {
              *
              *     New discounts can be added via the invoice's discounts API, to facilitate
              *     discounts that are affecting multiple lines. */
-            readonly discounts?: components['schemas']['InvoiceLineDiscount'][];
+            readonly discounts?: components['schemas']['InvoiceLineDiscounts'];
             /** @description The invoice this item belongs to. */
             invoice?: components['schemas']['InvoiceReference'];
             /** @description The currency of this line. */
@@ -5099,7 +5201,7 @@ export interface components {
              *     Default: 1 */
             quantity?: components['schemas']['Numeric'];
             /** @description The discounts that are applied to the line. */
-            discounts?: components['schemas']['BillingDiscountPercentage'][];
+            discounts?: components['schemas']['BillingDiscounts'];
         };
         /**
          * InvoiceGenericDocumentRef is used to describe an existing document or a specific part of it's contents.
@@ -5118,17 +5220,8 @@ export interface components {
         };
         /** @description BillingInvoiceLine represents a line item that is sold to the customer based on a specific (unit) price. */
         InvoiceLine: components['schemas']['InvoiceUsageBasedLine'] | components['schemas']['InvoiceFlatFeeLine'];
-        /** @description InvoiceLineAppExternalIds contains the external IDs of the invoice in other apps such as Stripe. */
-        InvoiceLineAppExternalIds: {
-            /** @description The external ID of the invoice in the invoicing app if available. */
-            readonly invoicing?: string;
-            /** @description The external ID of the invoice in the tax app if available. */
-            readonly tax?: string;
-        };
-        /** @description InvoiceLineDiscount represents the actual discount applied to the invoice line. */
-        InvoiceLineDiscount: components['schemas']['InvoiceLineDiscountAmount'] | components['schemas']['InvoiceLineDiscountUsage'];
-        /** @description InvoiceLineDiscountAmount represents an amount deducted from the line, and will be applied before taxes. */
-        InvoiceLineDiscountAmount: {
+        /** @description InvoiceLineAmountDiscount represents an amount deducted from the line, and will be applied before taxes. */
+        InvoiceLineAmountDiscount: {
             /**
              * Creation Time
              * Format: date-time
@@ -5156,28 +5249,81 @@ export interface components {
              */
             readonly id: string;
             /** @description Reason code. */
-            readonly reason: components['schemas']['InvoiceDiscountReason'];
+            readonly reason: components['schemas']['BillingDiscountReason'];
             /** @description Text description as to why the discount was applied. */
             readonly description?: string;
             /** @description External IDs of the invoice in other apps such as Stripe. */
             readonly externalIds?: components['schemas']['InvoiceLineAppExternalIds'];
-            /** @description The discount from the rate card this discount is based on. */
-            readonly rateCardDiscount?: components['schemas']['Discount'];
             /**
              * Amount in the currency of the invoice
              * @description Fixed discount amount to apply (calculated if percent present).
              */
             readonly amount: components['schemas']['Numeric'];
-            /**
-             * @description The type of the discount. (enum property replaced by openapi-typescript)
-             * @enum {string}
-             */
-            type: 'amount';
         };
-        /** @description InvoiceLineDiscountUsage represents an usage-based discount applied to the line.
+        /** @description InvoiceLineAppExternalIds contains the external IDs of the invoice in other apps such as Stripe. */
+        InvoiceLineAppExternalIds: {
+            /** @description The external ID of the invoice in the invoicing app if available. */
+            readonly invoicing?: string;
+            /** @description The external ID of the invoice in the tax app if available. */
+            readonly tax?: string;
+        };
+        /** @description InvoiceLineDiscounts represents the discounts applied to the invoice line by type. */
+        InvoiceLineDiscounts: {
+            /** @description Amount based discounts applied to the line.
+             *
+             *     Amount based discounts are deduced from the total price of the line. */
+            amount?: components['schemas']['InvoiceLineAmountDiscount'][];
+            /** @description Usage based discounts applied to the line.
+             *
+             *     Usage based discounts are deduced from the usage of the line before price calculations are applied. */
+            usage?: components['schemas']['InvoiceLineUsageDiscount'][];
+        };
+        /**
+         * @description InvoiceLineManagedBy specifies who manages the line.
+         * @enum {string}
+         */
+        InvoiceLineManagedBy: 'subscription' | 'system' | 'manual';
+        /** @description InvoiceLineReplaceUpdate represents the update model for an invoice line. */
+        InvoiceLineReplaceUpdate: components['schemas']['InvoiceUsageBasedLineReplaceUpdate'] | components['schemas']['InvoiceFlatFeeLineReplaceUpdate'];
+        /**
+         * @description Line status specifies the status of the line.
+         * @enum {string}
+         */
+        InvoiceLineStatus: 'valid' | 'detail' | 'split';
+        /** @description InvoiceLineSubscriptionReference contains the references to the subscription that this line is related to. */
+        InvoiceLineSubscriptionReference: {
+            /** @description The subscription. */
+            readonly subscription: components['schemas']['IDResource'];
+            /** @description The phase of the subscription. */
+            readonly phase: components['schemas']['IDResource'];
+            /** @description The item this line is related to. */
+            readonly item: components['schemas']['IDResource'];
+        };
+        /**
+         * @description InvoiceLineTaxBehavior details how the tax item is applied to the base amount.
+         *
+         *     Inclusive means the tax is included in the base amount.
+         *     Exclusive means the tax is added to the base amount.
+         * @enum {string}
+         */
+        InvoiceLineTaxBehavior: 'inclusive' | 'exclusive';
+        /** @description TaxConfig stores the configuration for a tax line relative to an invoice line. */
+        InvoiceLineTaxItem: {
+            /** @description Tax provider configuration. */
+            readonly config?: components['schemas']['TaxConfig'];
+            /** @description Percent defines the percentage set manually or determined from
+             *     the rate key (calculated if rate present). A nil percent implies that
+             *     this tax combo is **exempt** from tax.") */
+            readonly percent?: components['schemas']['Percentage'];
+            /** @description Some countries require an additional surcharge (calculated if rate present). */
+            readonly surcharge?: components['schemas']['Numeric'];
+            /** @description Is the tax item inclusive or exclusive of the base amount. */
+            readonly behavior?: components['schemas']['InvoiceLineTaxBehavior'];
+        };
+        /** @description InvoiceLineUsageDiscount represents an usage-based discount applied to the line.
          *
          *     The deduction is done before the pricing algorithm is applied. */
-        InvoiceLineDiscountUsage: {
+        InvoiceLineUsageDiscount: {
             /**
              * Creation Time
              * Format: date-time
@@ -5205,13 +5351,11 @@ export interface components {
              */
             readonly id: string;
             /** @description Reason code. */
-            readonly reason: components['schemas']['InvoiceDiscountReason'];
+            readonly reason: components['schemas']['BillingDiscountReason'];
             /** @description Text description as to why the discount was applied. */
             readonly description?: string;
             /** @description External IDs of the invoice in other apps such as Stripe. */
             readonly externalIds?: components['schemas']['InvoiceLineAppExternalIds'];
-            /** @description The discount from the rate card this discount is based on. */
-            readonly rateCardDiscount?: components['schemas']['Discount'];
             /**
              * Usage quantity in the unit of the underlying meter
              * @description The usage to apply.
@@ -5224,53 +5368,6 @@ export interface components {
              *     Only set if progressive billing is enabled and the line is a split line.
              */
             readonly preLinePeriodQuantity?: components['schemas']['Numeric'];
-            /**
-             * @description The type of the discount. (enum property replaced by openapi-typescript)
-             * @enum {string}
-             */
-            type: 'usage';
-        };
-        /**
-         * @description InvoiceLineManagedBy specifies who manages the line.
-         * @enum {string}
-         */
-        InvoiceLineManagedBy: 'subscription' | 'system' | 'manual';
-        /** @description InvoiceLineReplaceUpdate represents the update model for an invoice line. */
-        InvoiceLineReplaceUpdate: components['schemas']['InvoiceUsageBasedLineReplaceUpdate'] | components['schemas']['InvoiceFlatFeeLineReplaceUpdate'];
-        /**
-         * @description Line status specifies the status of the line.
-         * @enum {string}
-         */
-        InvoiceLineStatus: 'valid' | 'detail' | 'split';
-        /** @description InvoiceLineSubscriptionReference contains the references to the subscription that this line is related to. */
-        InvoiceLineSubscriptionReference: {
-            /** @description The subscription. */
-            readonly subscription: components['schemas']['IDResource'];
-            /** @description The phase of the subscription. */
-            readonly phase: components['schemas']['IDResource'];
-            /** @description The item this line is related to. */
-            readonly item: components['schemas']['IDResource'];
-        };
-        /**
-         * @description InvoiceLineTaxBehavior details how the tax item is applied to the base amount.
-         *
-         *     Inclusive means the tax is included in the base amount.
-         *     Exclusive means the tax is added to the base amount.
-         * @enum {string}
-         */
-        InvoiceLineTaxBehavior: 'inclusive' | 'exclusive';
-        /** @description TaxConfig stores the configuration for a tax line relative to an invoice line. */
-        InvoiceLineTaxItem: {
-            /** @description Tax provider configuration. */
-            readonly config?: components['schemas']['TaxConfig'];
-            /** @description Percent defines the percentage set manually or determined from
-             *     the rate key (calculated if rate present). A nil percent implies that
-             *     this tax combo is **exempt** from tax.") */
-            readonly percent?: components['schemas']['Percentage'];
-            /** @description Some countries require an additional surcharge (calculated if rate present). */
-            readonly surcharge?: components['schemas']['Numeric'];
-            /** @description Is the tax item inclusive or exclusive of the base amount. */
-            readonly behavior?: components['schemas']['InvoiceLineTaxBehavior'];
         };
         /**
          * @description InvoiceNumber is a unique identifier for the invoice, generated by the
@@ -5627,7 +5724,7 @@ export interface components {
              *
              *     New discounts can be added via the invoice's discounts API, to facilitate
              *     discounts that are affecting multiple lines. */
-            readonly discounts?: components['schemas']['InvoiceLineDiscount'][];
+            readonly discounts?: components['schemas']['InvoiceLineDiscounts'];
             /** @description The invoice this item belongs to. */
             invoice?: components['schemas']['InvoiceReference'];
             /** @description The currency of this line. */
@@ -5676,14 +5773,22 @@ export interface components {
              *
              *     The rate card captures the intent of the price and discounts for the usage-based item. */
             rateCard?: components['schemas']['InvoiceUsageBasedRateCard'];
-            /** @description The quantity of the item being sold. */
+            /** @description The quantity of the item being sold.
+             *
+             *     Any usage discounts applied previously are deducted from this quantity. */
             readonly quantity?: components['schemas']['Numeric'];
             /** @description The quantity of the item that has been metered for the period before any discounts were applied. */
             readonly meteredQuantity?: components['schemas']['Numeric'];
-            /** @description The quantity of the item used in before this line's period.
+            /** @description The quantity of the item used before this line's period.
              *
-             *     It is non-zero in case of progressive billing, when this shows how much of the usage was already billed. */
+             *     It is non-zero in case of progressive billing, when this shows how much of the usage was already billed.
+             *
+             *     Any usage discounts applied previously are deducted from this quantity. */
             readonly preLinePeriodQuantity?: components['schemas']['Numeric'];
+            /** @description The metered quantity of the item used in before this line's period without any discounts applied.
+             *
+             *     It is non-zero in case of progressive billing, when this shows how much of the usage was already billed. */
+            readonly meteredPreLinePeriodQuantity?: components['schemas']['Numeric'];
         };
         /** @description InvoiceUpdateUsageBasedLineReplaceUpdate represents the update model for an UBP invoice line.
          *
@@ -5820,7 +5925,7 @@ export interface components {
              *     When null, the feature or service is free. */
             price: components['schemas']['RateCardUsageBasedPrice'] | null;
             /** @description The discounts that are applied to the line. */
-            discounts?: components['schemas']['BillingDiscount'][];
+            discounts?: components['schemas']['BillingDiscounts'];
         };
         /** @description InvoiceWorkflowInvoicingSettingsReplaceUpdate represents the update model for the invoicing settings of an invoice workflow. */
         InvoiceWorkflowInvoicingSettingsReplaceUpdate: {
@@ -6951,49 +7056,196 @@ export interface components {
              */
             phases: components['schemas']['PlanPhase'][];
         };
-        /** @description Resource create operation model. */
-        PlanCreate: {
-            /**
-             * Display name
-             * @description Human-readable name for the resource. Between 1 and 256 characters.
-             */
-            name: string;
-            /**
-             * Description
-             * @description Optional description of the resource. Maximum 1024 characters.
-             */
-            description?: string;
+        /** @description The AddonAssignment describes the association between a plan and add-on. */
+        PlanAddon: {
             /**
-             * Metadata
-             * @description Additional metadata for the resource.
+             * Creation Time
+             * Format: date-time
+             * @description Timestamp of when the resource was created.
+             * @example 2024-01-01T01:01:01.001Z
              */
-            metadata?: components['schemas']['Metadata'] | null;
+            readonly createdAt: Date;
             /**
-             * Key
-             * @description A semi-unique identifier for the resource.
+             * Last Update Time
+             * Format: date-time
+             * @description Timestamp of when the resource was last updated.
+             * @example 2024-01-01T01:01:01.001Z
              */
-            key: string;
-            /** @description Alignment configuration for the plan. */
-            alignment?: components['schemas']['Alignment'];
+            readonly updatedAt: Date;
             /**
-             * Currency
-             * @description The currency code of the plan.
-             * @default USD
+             * Deletion Time
+             * Format: date-time
+             * @description Timestamp of when the resource was permanently deleted.
+             * @example 2024-01-01T01:01:01.001Z
              */
-            currency: components['schemas']['CurrencyCode'];
+            readonly deletedAt?: Date;
             /**
-             * Plan phases
-             * @description The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.
-             *     A phase switch occurs only at the end of a billing period, ensuring that a single subscription invoice will not include charges from different phase prices.
+             * Addon
+             * @description Partially populated add-on properties.
              */
-            phases: components['schemas']['PlanPhase'][];
-        };
-        /**
-         * @description Order by options for plans.
-         * @enum {string}
-         */
-        PlanOrderBy: 'id' | 'key' | 'version' | 'created_at' | 'updated_at';
-        /** @description Paginated response */
+            addon: {
+                /**
+                 * ID
+                 * @description The ID of the add-on.
+                 * @example 01G65Z755AFWAKHE12NY0CQ9FH
+                 */
+                id: string;
+                /**
+                 * Key
+                 * @description A semi-unique identifier for the resource.
+                 */
+                readonly key: string;
+                /**
+                 * Version
+                 * @description The version of the Add-on which templates this instance.
+                 * @default 1
+                 */
+                readonly version: number;
+                /**
+                 * InstanceType
+                 * @description The instance type of the add-on.
+                 */
+                readonly instanceType: components['schemas']['AddonInstanceType'];
+            };
+            /**
+             * The plan phase from the add-on becomes purchasable
+             * @description The key of the plan phase from the add-on becomes available for purchase.
+             */
+            fromPlanPhase: string;
+            /**
+             * Max quantity of the add-on
+             * @description The maximum number of times the add-on can be purchased for the plan.
+             *     It is not applicable for add-ons with single instance type.
+             */
+            maxQuantity?: number;
+        };
+        /** @description Resource create operation model. */
+        PlanAddonCreate: {
+            /**
+             * Addon
+             * @description Partially populated add-on properties.
+             */
+            addon: {
+                /**
+                 * ID
+                 * @description The ID of the add-on.
+                 * @example 01G65Z755AFWAKHE12NY0CQ9FH
+                 */
+                id: string;
+                /**
+                 * Key
+                 * @description A semi-unique identifier for the resource.
+                 */
+                readonly key: string;
+                /**
+                 * Version
+                 * @description The version of the Add-on which templates this instance.
+                 * @default 1
+                 */
+                readonly version: number;
+                /**
+                 * InstanceType
+                 * @description The instance type of the add-on.
+                 */
+                readonly instanceType: components['schemas']['AddonInstanceType'];
+            };
+            /**
+             * The plan phase from the add-on becomes purchasable
+             * @description The key of the plan phase from the add-on becomes available for purchase.
+             */
+            fromPlanPhase: string;
+            /**
+             * Max quantity of the add-on
+             * @description The maximum number of times the add-on can be purchased for the plan.
+             *     It is not applicable for add-ons with single instance type.
+             */
+            maxQuantity?: number;
+        };
+        /** @description Resource update operation model. */
+        PlanAddonReplaceUpdate: {
+            /**
+             * Addon
+             * @description Partially populated add-on properties.
+             */
+            addon: {
+                /**
+                 * ID
+                 * @description The ID of the add-on.
+                 * @example 01G65Z755AFWAKHE12NY0CQ9FH
+                 */
+                id: string;
+                /**
+                 * Key
+                 * @description A semi-unique identifier for the resource.
+                 */
+                readonly key: string;
+                /**
+                 * Version
+                 * @description The version of the Add-on which templates this instance.
+                 * @default 1
+                 */
+                readonly version: number;
+                /**
+                 * InstanceType
+                 * @description The instance type of the add-on.
+                 */
+                readonly instanceType: components['schemas']['AddonInstanceType'];
+            };
+            /**
+             * The plan phase from the add-on becomes purchasable
+             * @description The key of the plan phase from the add-on becomes available for purchase.
+             */
+            fromPlanPhase: string;
+            /**
+             * Max quantity of the add-on
+             * @description The maximum number of times the add-on can be purchased for the plan.
+             *     It is not applicable for add-ons with single instance type.
+             */
+            maxQuantity?: number;
+        };
+        /** @description Resource create operation model. */
+        PlanCreate: {
+            /**
+             * Display name
+             * @description Human-readable name for the resource. Between 1 and 256 characters.
+             */
+            name: string;
+            /**
+             * Description
+             * @description Optional description of the resource. Maximum 1024 characters.
+             */
+            description?: string;
+            /**
+             * Metadata
+             * @description Additional metadata for the resource.
+             */
+            metadata?: components['schemas']['Metadata'] | null;
+            /**
+             * Key
+             * @description A semi-unique identifier for the resource.
+             */
+            key: string;
+            /** @description Alignment configuration for the plan. */
+            alignment?: components['schemas']['Alignment'];
+            /**
+             * Currency
+             * @description The currency code of the plan.
+             * @default USD
+             */
+            currency: components['schemas']['CurrencyCode'];
+            /**
+             * Plan phases
+             * @description The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.
+             *     A phase switch occurs only at the end of a billing period, ensuring that a single subscription invoice will not include charges from different phase prices.
+             */
+            phases: components['schemas']['PlanPhase'][];
+        };
+        /**
+         * @description Order by options for plans.
+         * @enum {string}
+         */
+        PlanOrderBy: 'id' | 'key' | 'version' | 'created_at' | 'updated_at';
+        /** @description Paginated response */
         PlanPaginatedResponse: {
             /**
              * @description The total number of items.
@@ -7309,7 +7561,7 @@ export interface components {
              * @description The discount of the rate card. For flat fee rate cards only percentage discounts are supported.
              *     Only available when price is set.
              */
-            discounts?: components['schemas']['DiscountPercentage'][];
+            discounts?: components['schemas']['Discounts'];
         };
         /** @description The entitlement template with a metered entitlement. */
         RateCardMeteredEntitlement: {
@@ -7428,7 +7680,7 @@ export interface components {
              *
              *     Flat fee rate cards only support percentage discounts.
              */
-            discounts?: components['schemas']['Discount'][];
+            discounts?: components['schemas']['Discounts'];
         };
         /** @description The price of the usage based rate card. */
         RateCardUsageBasedPrice: components['schemas']['FlatPriceWithPaymentTerm'] | components['schemas']['UnitPriceWithCommitments'] | components['schemas']['TieredPriceWithCommitments'] | components['schemas']['DynamicPriceWithCommitments'] | components['schemas']['PackagePriceWithCommitments'];
@@ -8431,7 +8683,7 @@ export interface components {
              * Discounts
              * @description The discounts applied to the rate card.
              */
-            discounts?: components['schemas']['Discount'][];
+            discounts?: components['schemas']['Discounts'];
             /** @description Describes what access is gained via the SubscriptionItem */
             included?: components['schemas']['SubscriptionItemIncluded'];
             /**
@@ -8490,7 +8742,7 @@ export interface components {
              * Discounts
              * @description The discounts on the plan.
              */
-            discounts?: components['schemas']['Discount'][];
+            discounts?: components['schemas']['Discounts'];
             /** @description A locally unique identifier for the phase. */
             key: string;
             /** @description The name of the phase. */
@@ -8548,7 +8800,7 @@ export interface components {
              * Discounts
              * @description The discounts on the plan.
              */
-            discounts?: components['schemas']['Discount'][];
+            discounts?: components['schemas']['Discounts'];
             /**
              * Format: date-time
              * @description The time from which the phase is active.
@@ -9090,9 +9342,10 @@ export type AppType = components['schemas']['AppType'];
 export type BadRequestProblemResponse = components['schemas']['BadRequestProblemResponse'];
 export type BalanceHistoryWindow = components['schemas']['BalanceHistoryWindow'];
 export type BillingCustomerProfile = components['schemas']['BillingCustomerProfile'];
-export type BillingDiscount = components['schemas']['BillingDiscount'];
 export type BillingDiscountPercentage = components['schemas']['BillingDiscountPercentage'];
+export type BillingDiscountReason = components['schemas']['BillingDiscountReason'];
 export type BillingDiscountUsage = components['schemas']['BillingDiscountUsage'];
+export type BillingDiscounts = components['schemas']['BillingDiscounts'];
 export type BillingParty = components['schemas']['BillingParty'];
 export type BillingPartyReplaceUpdate = components['schemas']['BillingPartyReplaceUpdate'];
 export type BillingPartyTaxIdentity = components['schemas']['BillingPartyTaxIdentity'];
@@ -9157,9 +9410,12 @@ export type CustomerOrderBy = components['schemas']['CustomerOrderBy'];
 export type CustomerPaginatedResponse = components['schemas']['CustomerPaginatedResponse'];
 export type CustomerReplaceUpdate = components['schemas']['CustomerReplaceUpdate'];
 export type CustomerUsageAttribution = components['schemas']['CustomerUsageAttribution'];
-export type Discount = components['schemas']['Discount'];
 export type DiscountPercentage = components['schemas']['DiscountPercentage'];
+export type DiscountReasonMaximumSpend = components['schemas']['DiscountReasonMaximumSpend'];
+export type DiscountReasonRatecardPercentage = components['schemas']['DiscountReasonRatecardPercentage'];
+export type DiscountReasonRatecardUsage = components['schemas']['DiscountReasonRatecardUsage'];
 export type DiscountUsage = components['schemas']['DiscountUsage'];
+export type Discounts = components['schemas']['Discounts'];
 export type DynamicPriceWithCommitments = components['schemas']['DynamicPriceWithCommitments'];
 export type EditSubscriptionAddItem = components['schemas']['EditSubscriptionAddItem'];
 export type EditSubscriptionAddPhase = components['schemas']['EditSubscriptionAddPhase'];
@@ -9210,7 +9466,6 @@ export type InvoiceAppExternalIds = components['schemas']['InvoiceAppExternalIds
 export type InvoiceAvailableActionDetails = components['schemas']['InvoiceAvailableActionDetails'];
 export type InvoiceAvailableActionInvoiceDetails = components['schemas']['InvoiceAvailableActionInvoiceDetails'];
 export type InvoiceAvailableActions = components['schemas']['InvoiceAvailableActions'];
-export type InvoiceDiscountReason = components['schemas']['InvoiceDiscountReason'];
 export type InvoiceDocumentRef = components['schemas']['InvoiceDocumentRef'];
 export type InvoiceDocumentRefType = components['schemas']['InvoiceDocumentRefType'];
 export type InvoiceExpand = components['schemas']['InvoiceExpand'];
@@ -9221,16 +9476,16 @@ export type InvoiceFlatFeePendingLineCreate = components['schemas']['InvoiceFlat
 export type InvoiceFlatFeeRateCard = components['schemas']['InvoiceFlatFeeRateCard'];
 export type InvoiceGenericDocumentRef = components['schemas']['InvoiceGenericDocumentRef'];
 export type InvoiceLine = components['schemas']['InvoiceLine'];
+export type InvoiceLineAmountDiscount = components['schemas']['InvoiceLineAmountDiscount'];
 export type InvoiceLineAppExternalIds = components['schemas']['InvoiceLineAppExternalIds'];
-export type InvoiceLineDiscount = components['schemas']['InvoiceLineDiscount'];
-export type InvoiceLineDiscountAmount = components['schemas']['InvoiceLineDiscountAmount'];
-export type InvoiceLineDiscountUsage = components['schemas']['InvoiceLineDiscountUsage'];
+export type InvoiceLineDiscounts = components['schemas']['InvoiceLineDiscounts'];
 export type InvoiceLineManagedBy = components['schemas']['InvoiceLineManagedBy'];
 export type InvoiceLineReplaceUpdate = components['schemas']['InvoiceLineReplaceUpdate'];
 export type InvoiceLineStatus = components['schemas']['InvoiceLineStatus'];
 export type InvoiceLineSubscriptionReference = components['schemas']['InvoiceLineSubscriptionReference'];
 export type InvoiceLineTaxBehavior = components['schemas']['InvoiceLineTaxBehavior'];
 export type InvoiceLineTaxItem = components['schemas']['InvoiceLineTaxItem'];
+export type InvoiceLineUsageDiscount = components['schemas']['InvoiceLineUsageDiscount'];
 export type InvoiceNumber = components['schemas']['InvoiceNumber'];
 export type InvoiceOrderBy = components['schemas']['InvoiceOrderBy'];
 export type InvoicePaginatedResponse = components['schemas']['InvoicePaginatedResponse'];
@@ -9309,6 +9564,9 @@ export type PaymentTerms = components['schemas']['PaymentTerms'];
 export type Percentage = components['schemas']['Percentage'];
 export type Period = components['schemas']['Period'];
 export type Plan = components['schemas']['Plan'];
+export type PlanAddon = components['schemas']['PlanAddon'];
+export type PlanAddonCreate = components['schemas']['PlanAddonCreate'];
+export type PlanAddonReplaceUpdate = components['schemas']['PlanAddonReplaceUpdate'];
 export type PlanCreate = components['schemas']['PlanCreate'];
 export type PlanOrderBy = components['schemas']['PlanOrderBy'];
 export type PlanPaginatedResponse = components['schemas']['PlanPaginatedResponse'];
@@ -18122,6 +18380,494 @@ export interface operations {
             };
         };
     };
+    listPlanAddons: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                planId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The request has succeeded. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['PlanAddon'][];
+                };
+            };
+            /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['BadRequestProblemResponse'];
+                };
+            };
+            /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
+                };
+            };
+            /** @description The server understood the request but refuses to authorize it. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
+                };
+            };
+            /** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['NotFoundProblemResponse'];
+                };
+            };
+            /** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
+            412: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
+                };
+            };
+            /** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
+                };
+            };
+            /** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
+                };
+            };
+            /** @description An unexpected error response. */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
+                };
+            };
+        };
+    };
+    createPlanAddon: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                planId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': components['schemas']['PlanAddonCreate'];
+            };
+        };
+        responses: {
+            /** @description The request has succeeded and a new resource has been created as a result. */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['PlanAddon'];
+                };
+            };
+            /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['BadRequestProblemResponse'];
+                };
+            };
+            /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
+                };
+            };
+            /** @description The server understood the request but refuses to authorize it. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
+                };
+            };
+            /** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['NotFoundProblemResponse'];
+                };
+            };
+            /** @description The request could not be completed due to a conflict with the current state of the target resource. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['ConflictProblemResponse'];
+                };
+            };
+            /** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
+            412: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
+                };
+            };
+            /** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
+                };
+            };
+            /** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
+                };
+            };
+            /** @description An unexpected error response. */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
+                };
+            };
+        };
+    };
+    getPlanAddon: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                planId: string;
+                planAddonId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The request has succeeded. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['PlanAddon'];
+                };
+            };
+            /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['BadRequestProblemResponse'];
+                };
+            };
+            /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
+                };
+            };
+            /** @description The server understood the request but refuses to authorize it. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
+                };
+            };
+            /** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['NotFoundProblemResponse'];
+                };
+            };
+            /** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
+            412: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
+                };
+            };
+            /** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
+                };
+            };
+            /** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
+                };
+            };
+            /** @description An unexpected error response. */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
+                };
+            };
+        };
+    };
+    updatePlanAddon: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                planId: string;
+                planAddonId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': components['schemas']['PlanAddonReplaceUpdate'];
+            };
+        };
+        responses: {
+            /** @description The request has succeeded. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['PlanAddon'];
+                };
+            };
+            /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['BadRequestProblemResponse'];
+                };
+            };
+            /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
+                };
+            };
+            /** @description The server understood the request but refuses to authorize it. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
+                };
+            };
+            /** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['NotFoundProblemResponse'];
+                };
+            };
+            /** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
+            412: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
+                };
+            };
+            /** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
+                };
+            };
+            /** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
+                };
+            };
+            /** @description An unexpected error response. */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
+                };
+            };
+        };
+    };
+    deletePlanAddon: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                planId: string;
+                planAddonId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description There is no content to send for this request, but the headers may be useful.  */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['BadRequestProblemResponse'];
+                };
+            };
+            /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
+                };
+            };
+            /** @description The server understood the request but refuses to authorize it. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
+                };
+            };
+            /** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['NotFoundProblemResponse'];
+                };
+            };
+            /** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
+            412: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
+                };
+            };
+            /** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
+                };
+            };
+            /** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
+                };
+            };
+            /** @description An unexpected error response. */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
+                };
+            };
+        };
+    };
     archivePlan: {
         parameters: {
             query?: never;