orb-billing 6.10.0 → 6.12.0

package/resources/subscriptions.d.mts

@@ -774,6 +774,17 @@ export declare class Subscriptions extends APIResource {
      * Note that one of `plan_id` or `external_plan_id` is required in the request body
      * for this operation.
      *
+     * ## Interaction with scheduled cancellations
+     *
+     * Scheduling a plan change also unschedules a pending cancellation, as long as the
+     * cancellation date is on or after the plan change date: Orb honors the plan
+     * change over the scheduled cancellation, and the subscription continues on the
+     * new plan. Scheduling a plan change after the subscription's end date returns a
+     * validation error instead.
+     *
+     * Any plan changes already scheduled at or after the new plan change's date are
+     * unscheduled and replaced by it.
+     *
      * ## Customize your customer's subscriptions
      *
      * Prices and adjustments in a plan can be added, removed, or replaced on the
@@ -951,11 +962,19 @@ export declare class Subscriptions extends APIResource {
      * cancellation. This operation will turn on auto-renew, ensuring that the
      * subscription does not end at the currently scheduled cancellation time.
      *
-     * Note: uncancellation is a lossy operation. Price intervals that were cut short
-     * by the cancellation are extended to infinity (original end dates are lost), and
-     * future intervals or phases scheduled after the cancellation time are permanently
-     * deleted. For complex subscriptions with phases or scheduled plan changes,
-     * consider creating a new plan change instead of uncancelling.
+     * A cancellation that has already taken effect cannot be unscheduled. This
+     * includes backdated cancellations: once the subscription's end date is in the
+     * past, this endpoint returns a validation error.
+     *
+     * Note: uncancellation is a lossy operation. Price and adjustment intervals that
+     * were cut short by the cancellation are extended to infinity (original end dates
+     * are lost), and future intervals or phases scheduled after the cancellation time
+     * are permanently deleted. For complex subscriptions with phases or scheduled plan
+     * changes, consider creating a new plan change instead of uncancelling.
+     *
+     * If the scheduled cancellation already produced invoices or credit notes (for
+     * example, a proration refund credit note for an in-advance fee), uncancelling
+     * voids and reissues them as needed to match the subscription's new state.
      *
      * @example
      * ```ts
@@ -985,7 +1004,21 @@ export declare class Subscriptions extends APIResource {
     unscheduleFixedFeeQuantityUpdates(subscriptionID: string, body: SubscriptionUnscheduleFixedFeeQuantityUpdatesParams, options?: RequestOptions): APIPromise<SubscriptionChangesAPI.MutatedSubscription>;
     /**
      * This endpoint can be used to unschedule any pending plan changes on an existing
-     * subscription. When called, all upcoming plan changes will be unscheduled.
+     * subscription. When called, all upcoming plan changes will be unscheduled; it is
+     * not possible to unschedule a single plan change if multiple are scheduled.
+     *
+     * Note: unscheduling a plan change is a lossy operation, with the same semantics
+     * as
+     * [unscheduling a cancellation](/api-reference/subscription/unschedule-subscription-cancellation).
+     * Prices and adjustments on the current plan that were scheduled to end at the
+     * plan change time are extended to infinity (original end dates are lost), and
+     * anything scheduled to start after the plan change time is permanently deleted.
+     * Coupons redeemed as part of an unscheduled plan change are released and can be
+     * redeemed again.
+     *
+     * A scheduled cancellation is not affected by this operation: if the subscription
+     * has both a pending plan change and a scheduled cancellation, unscheduling the
+     * plan change leaves the cancellation in place.
      *
      * @example
      * ```ts
@@ -1144,7 +1177,11 @@ export interface NewSubscriptionBulkPrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -1233,7 +1270,11 @@ export interface NewSubscriptionBulkWithProrationPrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -1348,7 +1389,11 @@ export interface NewSubscriptionCumulativeGroupedBulkPrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -1468,7 +1513,11 @@ export interface NewSubscriptionGroupedAllocationPrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -1576,7 +1625,11 @@ export interface NewSubscriptionGroupedTieredPackagePrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -1694,7 +1747,11 @@ export interface NewSubscriptionGroupedTieredPrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -1811,7 +1868,11 @@ export interface NewSubscriptionGroupedWithMeteredMinimumPrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -1952,7 +2013,11 @@ export interface NewSubscriptionGroupedWithProratedMinimumPrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -2060,7 +2125,11 @@ export interface NewSubscriptionMatrixPrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -2149,7 +2218,11 @@ export interface NewSubscriptionMatrixWithAllocationPrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -2238,7 +2311,11 @@ export interface NewSubscriptionMatrixWithDisplayNamePrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -2361,7 +2438,11 @@ export interface NewSubscriptionMaxGroupTieredPackagePrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -2478,7 +2559,11 @@ export interface NewSubscriptionMinimumCompositePrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -2582,7 +2667,11 @@ export interface NewSubscriptionPackagePrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -2671,7 +2760,11 @@ export interface NewSubscriptionPackageWithAllocationPrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -2770,7 +2863,11 @@ export interface NewSubscriptionScalableMatrixWithTieredPricingPrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -2896,7 +2993,11 @@ export interface NewSubscriptionScalableMatrixWithUnitPricingPrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -3026,7 +3127,11 @@ export interface NewSubscriptionThresholdTotalAmountPrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -3143,7 +3248,11 @@ export interface NewSubscriptionTieredPackagePrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -3259,7 +3368,11 @@ export interface NewSubscriptionTieredPackageWithMinimumPrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -3371,7 +3484,11 @@ export interface NewSubscriptionTieredPrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -3460,7 +3577,11 @@ export interface NewSubscriptionTieredWithMinimumPrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -3582,7 +3703,11 @@ export interface NewSubscriptionUnitPrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -3671,7 +3796,11 @@ export interface NewSubscriptionUnitWithPercentPrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -3775,7 +3904,11 @@ export interface NewSubscriptionUnitWithProrationPrice {
      */
     invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
     /**
-     * The ID of the license type to associate with this price.
+     * The ID of the license type to associate with this price. On a usage price this
+     * also marks the price as eligible to draw down from that license type's
+     * allocation; a usage price created without it is billed normally. Usage prices
+     * with a license type must use the `unit` model, and only draw down when their
+     * currency matches the allocation's.
      */
     license_type_id?: string | null;
     /**
@@ -4474,7 +4607,11 @@ export declare namespace SubscriptionCreateParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -4606,7 +4743,11 @@ export declare namespace SubscriptionCreateParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -4731,7 +4872,11 @@ export declare namespace SubscriptionCreateParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -4870,7 +5015,11 @@ export declare namespace SubscriptionCreateParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -4986,7 +5135,11 @@ export declare namespace SubscriptionCreateParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -5098,7 +5251,11 @@ export declare namespace SubscriptionCreateParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -5210,7 +5367,11 @@ export declare namespace SubscriptionCreateParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -5345,7 +5506,11 @@ export declare namespace SubscriptionCreateParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -5470,7 +5635,11 @@ export declare namespace SubscriptionCreateParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -5584,7 +5753,11 @@ export declare namespace SubscriptionCreateParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -5836,7 +6009,11 @@ export declare namespace SubscriptionCreateParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -5968,7 +6145,11 @@ export declare namespace SubscriptionCreateParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -6093,7 +6274,11 @@ export declare namespace SubscriptionCreateParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -6232,7 +6417,11 @@ export declare namespace SubscriptionCreateParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -6348,7 +6537,11 @@ export declare namespace SubscriptionCreateParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -6460,7 +6653,11 @@ export declare namespace SubscriptionCreateParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -6572,7 +6769,11 @@ export declare namespace SubscriptionCreateParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -6707,7 +6908,11 @@ export declare namespace SubscriptionCreateParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -6832,7 +7037,11 @@ export declare namespace SubscriptionCreateParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -6946,7 +7155,11 @@ export declare namespace SubscriptionCreateParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -7328,7 +7541,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -7454,7 +7671,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -7573,7 +7794,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -7706,7 +7931,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -7812,7 +8041,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -7918,7 +8151,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -8047,7 +8284,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -8166,7 +8407,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -8274,7 +8519,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -8865,7 +9114,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -8997,7 +9250,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -9122,7 +9379,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -9261,7 +9522,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -9377,7 +9642,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -9489,7 +9758,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -9601,7 +9874,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -9736,7 +10013,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -9861,7 +10142,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -9975,7 +10260,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -10227,7 +10516,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -10359,7 +10652,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -10484,7 +10781,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -10623,7 +10924,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -10739,7 +11044,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -10851,7 +11160,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -10963,7 +11276,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -11098,7 +11415,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -11223,7 +11544,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**
@@ -11337,7 +11662,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
             /**
-             * The ID of the license type to associate with this price.
+             * The ID of the license type to associate with this price. On a usage price this
+             * also marks the price as eligible to draw down from that license type's
+             * allocation; a usage price created without it is billed normally. Usage prices
+             * with a license type must use the `unit` model, and only draw down when their
+             * currency matches the allocation's.
              */
             license_type_id?: string | null;
             /**