orb-billing 6.11.0 → 6.12.0

package/src/resources/plans/plans.ts

@@ -500,7 +500,8 @@ export namespace PlanCreateParams {
       /**
        * License allocations to associate with this price. Each entry defines a
        * per-license credit pool granted each cadence. Requires license_type_id or
-       * license_type_configuration to be set.
+       * license_type_configuration to be set. Usage prices draw down from these
+       * allocations only if they set the same license type.
        */
       license_allocations: Array<LicenseAllocationPrice.LicenseAllocation>;
 
@@ -581,7 +582,11 @@ export namespace PlanCreateParams {
       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;
 
@@ -706,7 +711,11 @@ export namespace PlanCreateParams {
       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;
 
@@ -861,7 +870,11 @@ export namespace PlanCreateParams {
       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;
 
@@ -1009,7 +1022,11 @@ export namespace PlanCreateParams {
       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;
 
@@ -1178,7 +1195,11 @@ export namespace PlanCreateParams {
       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;
 
@@ -1314,7 +1335,11 @@ export namespace PlanCreateParams {
       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;
 
@@ -1447,7 +1472,11 @@ export namespace PlanCreateParams {
       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;
 
@@ -1580,7 +1609,11 @@ export namespace PlanCreateParams {
       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;
 
@@ -1739,7 +1772,11 @@ export namespace PlanCreateParams {
       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;
 
@@ -1887,7 +1924,11 @@ export namespace PlanCreateParams {
       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;
 
@@ -2022,7 +2063,11 @@ export namespace PlanCreateParams {
       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;