orb-billing 6.14.0 → 6.16.0

package/src/resources/customers/credits/top-ups.ts

@@ -29,7 +29,13 @@ export class TopUps extends APIResource {
   }
 
   /**
-   * List top-ups
+   * This endpoint returns a list of a customer's active top-ups; a top-up that has
+   * been deactivated is not included. While a top-up is active, the customer's
+   * balance is increased by the top-up amount whenever it falls to the top-up's
+   * threshold.
+   *
+   * The response also includes pagination_metadata, which lets the caller retrieve
+   * the next page of results if they exist.
    */
   list(
     customerID: string,
@@ -91,7 +97,13 @@ export class TopUps extends APIResource {
   }
 
   /**
-   * List top-ups by external ID
+   * This endpoint returns a list of a customer's active top-ups; a top-up that has
+   * been deactivated is not included. While a top-up is active, the customer's
+   * balance is increased by the top-up amount whenever it falls to the top-up's
+   * threshold.
+   *
+   * The response also includes pagination_metadata, which lets the caller retrieve
+   * the next page of results if they exist.
    */
   listByExternalID(
     externalCustomerID: string,

package/src/resources/dimensional-price-groups/dimensional-price-groups.ts

@@ -44,7 +44,10 @@ export class DimensionalPriceGroups extends APIResource {
   }
 
   /**
-   * Fetch dimensional price group
+   * This endpoint returns a dimensional price group identified by its ID. A
+   * dimensional price group partitions the result of a billable metric by a set of
+   * dimensions, and the prices in the group specify which partition their usage is
+   * derived from.
    *
    * @example
    * ```ts
@@ -80,7 +83,13 @@ export class DimensionalPriceGroups extends APIResource {
   }
 
   /**
-   * List dimensional price groups
+   * This endpoint returns a list of all dimensional price groups for an account. A
+   * dimensional price group partitions the result of a billable metric by a set of
+   * dimensions, and the prices in the group specify which partition their usage is
+   * derived from.
+   *
+   * The response also includes pagination_metadata, which lets the caller retrieve
+   * the next page of results if they exist.
    *
    * @example
    * ```ts

package/src/resources/dimensional-price-groups/external-dimensional-price-group-id.ts

@@ -8,7 +8,10 @@ import { path } from '../../internal/utils/path';
 
 export class ExternalDimensionalPriceGroupID extends APIResource {
   /**
-   * Fetch dimensional price group by external ID
+   * This endpoint returns a dimensional price group identified by the external ID
+   * you assigned it, rather than by its Orb ID. A dimensional price group partitions
+   * the result of a billable metric by a set of dimensions, and the prices in the
+   * group specify which partition their usage is derived from.
    *
    * @example
    * ```ts

package/src/resources/items.ts

@@ -57,7 +57,9 @@ export class Items extends APIResource {
   }
 
   /**
-   * Archive item
+   * This endpoint archives an item, and cascades to archive every price for that
+   * item that is still active. An item that is already archived cannot be archived
+   * again.
    *
    * @example
    * ```ts

package/src/resources/plans/migrations.ts

@@ -13,7 +13,9 @@ import { path } from '../../internal/utils/path';
  */
 export class Migrations extends APIResource {
   /**
-   * Fetch migration
+   * This endpoint returns a migration for a plan, identified by its ID. A migration
+   * moves a plan's subscriptions onto a new version of that plan; the response
+   * reports the effective time it is scheduled for and its current status.
    */
   retrieve(
     migrationID: string,

package/src/resources/plans/plans.ts

@@ -459,6 +459,7 @@ export namespace PlanCreateParams {
       | Shared.NewPlanPackageWithAllocationPrice
       | Shared.NewPlanUnitWithPercentPrice
       | Shared.NewPlanMatrixWithAllocationPrice
+      | Price.NewPlanTieredMatrixWithAllocationPrice
       | Price.NewPlanMatrixWithThresholdDiscountsPrice
       | Price.NewPlanTieredWithProrationPrice
       | Shared.NewPlanUnitWithProrationPrice
@@ -934,6 +935,167 @@ export namespace PlanCreateParams {
       }
     }
 
+    export interface NewPlanTieredMatrixWithAllocationPrice {
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      /**
+       * The id of the item the price will be associated with.
+       */
+      item_id: string;
+
+      /**
+       * The pricing model type
+       */
+      model_type: 'tiered_matrix_with_allocation';
+
+      /**
+       * The name of the price.
+       */
+      name: string;
+
+      /**
+       * Configuration for tiered_matrix_with_allocation pricing
+       */
+      tiered_matrix_with_allocation_config: NewPlanTieredMatrixWithAllocationPrice.TieredMatrixWithAllocationConfig;
+
+      /**
+       * The id of the billable metric for the price. Only needed if the price is
+       * usage-based.
+       */
+      billable_metric_id?: string | null;
+
+      /**
+       * If the Price represents a fixed cost, the price will be billed in-advance if
+       * this is true, and in-arrears if this is false.
+       */
+      billed_in_advance?: boolean | null;
+
+      /**
+       * For custom cadence: specifies the duration of the billing period in days or
+       * months.
+       */
+      billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+
+      /**
+       * The per unit conversion rate of the price currency to the invoicing currency.
+       */
+      conversion_rate?: number | null;
+
+      /**
+       * The configuration for the rate of the price currency to the invoicing currency.
+       */
+      conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+
+      /**
+       * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+       * price is billed.
+       */
+      currency?: string | null;
+
+      /**
+       * For dimensional price: specifies a price group and dimension values
+       */
+      dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
+
+      /**
+       * An alias for the price.
+       */
+      external_price_id?: string | null;
+
+      /**
+       * If the Price represents a fixed cost, this represents the quantity of units
+       * applied.
+       */
+      fixed_price_quantity?: number | null;
+
+      /**
+       * The property used to group this price on an invoice
+       */
+      invoice_grouping_key?: string | null;
+
+      /**
+       * Within each billing cycle, specifies the cadence at which invoices are produced.
+       * If unspecified, a single invoice is produced per billing cycle.
+       */
+      invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+
+      /**
+       * 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;
+
+      /**
+       * User-specified key/value pairs for the resource. Individual keys can be removed
+       * by setting the value to `null`, and the entire metadata mapping can be cleared
+       * by setting `metadata` to `null`.
+       */
+      metadata?: { [key: string]: string | null } | null;
+
+      /**
+       * A transient ID that can be used to reference this price when adding adjustments
+       * in the same API call.
+       */
+      reference_id?: string | null;
+    }
+
+    export namespace NewPlanTieredMatrixWithAllocationPrice {
+      /**
+       * Configuration for tiered_matrix_with_allocation pricing
+       */
+      export interface TieredMatrixWithAllocationConfig {
+        /**
+         * Usage allocation, pooled across all matrix cells
+         */
+        allocation: string;
+
+        /**
+         * Per unit rate for usage whose matrix cell has no configured tiers
+         */
+        default_unit_amount: string;
+
+        /**
+         * One or two event property values to evaluate matrix cells by
+         */
+        dimensions: Array<string>;
+
+        /**
+         * Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
+         * own rows
+         */
+        tiers: Array<TieredMatrixWithAllocationConfig.Tier>;
+      }
+
+      export namespace TieredMatrixWithAllocationConfig {
+        /**
+         * Configuration for a single tier scoped to one matrix cell
+         */
+        export interface Tier {
+          /**
+           * The matrix cell this tier applies to, as one or two dimension values
+           */
+          dimension_values: Array<string>;
+
+          /**
+           * Exclusive tier starting value. The tier runs up to and including the next bound
+           * configured for the same matrix cell.
+           */
+          tier_lower_bound: string;
+
+          /**
+           * Per unit amount
+           */
+          unit_amount: string;
+        }
+      }
+    }
+
     export interface NewPlanMatrixWithThresholdDiscountsPrice {
       /**
        * The cadence to bill for this price on.