orb-billing 6.10.0 → 6.12.0

package/src/resources/subscriptions.ts

@@ -846,6 +846,17 @@ export 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
@@ -1040,11 +1051,19 @@ export 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
@@ -1090,7 +1109,21 @@ export class Subscriptions extends APIResource {
 
   /**
    * 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
@@ -1294,7 +1327,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;
 
@@ -1400,7 +1437,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;
 
@@ -1535,7 +1576,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;
 
@@ -1677,7 +1722,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;
 
@@ -1805,7 +1854,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;
 
@@ -1945,7 +1998,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;
 
@@ -2083,7 +2140,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;
 
@@ -2251,7 +2312,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;
 
@@ -2379,7 +2444,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;
 
@@ -2485,7 +2554,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;
 
@@ -2591,7 +2664,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;
 
@@ -2736,7 +2813,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;
 
@@ -2875,7 +2956,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;
 
@@ -2998,7 +3083,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;
 
@@ -3104,7 +3193,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;
 
@@ -3223,7 +3316,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;
 
@@ -3375,7 +3472,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;
 
@@ -3531,7 +3632,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;
 
@@ -3669,7 +3774,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;
 
@@ -3806,7 +3915,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;
 
@@ -3940,7 +4053,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;
 
@@ -4046,7 +4163,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;
 
@@ -4191,7 +4312,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;
 
@@ -4297,7 +4422,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;
 
@@ -4420,7 +4549,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;
 
@@ -5317,7 +5450,11 @@ export 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;
 
@@ -5472,7 +5609,11 @@ export 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;
 
@@ -5620,7 +5761,11 @@ export 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;
 
@@ -5789,7 +5934,11 @@ export 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;
 
@@ -5925,7 +6074,11 @@ export 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;
 
@@ -6058,7 +6211,11 @@ export 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;
 
@@ -6191,7 +6348,11 @@ export 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;
 
@@ -6350,7 +6511,11 @@ export 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;
 
@@ -6498,7 +6663,11 @@ export 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;
 
@@ -6633,7 +6802,11 @@ export 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;
 
@@ -6975,7 +7148,11 @@ export 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;
 
@@ -7130,7 +7307,11 @@ export 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;
 
@@ -7278,7 +7459,11 @@ export 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;
 
@@ -7447,7 +7632,11 @@ export 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;
 
@@ -7583,7 +7772,11 @@ export 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;
 
@@ -7716,7 +7909,11 @@ export 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;
 
@@ -7849,7 +8046,11 @@ export 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;
 
@@ -8008,7 +8209,11 @@ export 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;
 
@@ -8156,7 +8361,11 @@ export 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;
 
@@ -8291,7 +8500,11 @@ export 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;
 
@@ -8793,7 +9006,11 @@ export 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;
 
@@ -8941,7 +9158,11 @@ export 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;
 
@@ -9082,7 +9303,11 @@ export 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;
 
@@ -9244,7 +9469,11 @@ export 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;
 
@@ -9370,7 +9599,11 @@ export 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;
 
@@ -9496,7 +9729,11 @@ export 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;
 
@@ -9648,7 +9885,11 @@ export 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;
 
@@ -9789,7 +10030,11 @@ export 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;
 
@@ -9917,7 +10162,11 @@ export 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;
 
@@ -10667,7 +10916,11 @@ export 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;
 
@@ -10822,7 +11075,11 @@ export 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;
 
@@ -10970,7 +11227,11 @@ export 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;
 
@@ -11139,7 +11400,11 @@ export 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;
 
@@ -11275,7 +11540,11 @@ export 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;
 
@@ -11408,7 +11677,11 @@ export 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;
 
@@ -11541,7 +11814,11 @@ export 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;
 
@@ -11700,7 +11977,11 @@ export 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;
 
@@ -11848,7 +12129,11 @@ export 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;
 
@@ -11983,7 +12268,11 @@ export 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;
 
@@ -12325,7 +12614,11 @@ export 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;
 
@@ -12480,7 +12773,11 @@ export 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;
 
@@ -12628,7 +12925,11 @@ export 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;
 
@@ -12797,7 +13098,11 @@ export 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;
 
@@ -12933,7 +13238,11 @@ export 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;
 
@@ -13066,7 +13375,11 @@ export 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;
 
@@ -13199,7 +13512,11 @@ export 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;
 
@@ -13358,7 +13675,11 @@ export 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;
 
@@ -13506,7 +13827,11 @@ export 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;
 
@@ -13641,7 +13966,11 @@ export 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;