orb-billing 2.11.2 → 3.0.0

package/src/resources/subscriptions.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
+import * as Core from '../core';
 import * as SubscriptionsAPI from './subscriptions';
 import * as Shared from './shared';
 import * as CustomersAPI from './customers/customers';
@@ -842,6 +842,21 @@ export class Subscriptions extends APIResource {
    * interval. This will only apply to this price interval, not any other price
    * intervals on the subscription.
    *
+   * ## Adjustment intervals
+   *
+   * An adjustment interval represents the time period that a particular adjustment
+   * (a discount, minimum, or maximum) applies to the prices on a subscription.
+   * Adjustment intervals can be added to a subscription by specifying them in the
+   * `add_adjustments` array, or modified via the `edit_adjustments` array. When
+   * creating an adjustment interval, you'll need to provide the definition of the
+   * new adjustment (the type of adjustment, and which prices it applies to), as well
+   * as the start and end dates for the adjustment interval. The start and end dates
+   * of an existing adjustment interval can be edited via the `edit_adjustments`
+   * field (just like price intervals). (To "change" the amount of a discount,
+   * minimum, or maximum, then, you'll need to end the existing interval, and create
+   * a new adjustment interval with the new amount and a start date that matches the
+   * end date of the previous interval.)
+   *
    * ## Editing price intervals
    *
    * Price intervals can be adjusted by specifying edits to make in the `edit` array.
@@ -3575,10 +3590,20 @@ export interface SubscriptionPriceIntervalsParams {
    */
   add?: Array<SubscriptionPriceIntervalsParams.Add>;
 
+  /**
+   * A list of adjustments to add to the subscription.
+   */
+  add_adjustments?: Array<SubscriptionPriceIntervalsParams.AddAdjustment>;
+
   /**
    * A list of price intervals to edit on the subscription.
    */
   edit?: Array<SubscriptionPriceIntervalsParams.Edit>;
+
+  /**
+   * A list of adjustments to edit on the subscription.
+   */
+  edit_adjustments?: Array<SubscriptionPriceIntervalsParams.EditAdjustment>;
 }
 
 export namespace SubscriptionPriceIntervalsParams {
@@ -3589,6 +3614,11 @@ export namespace SubscriptionPriceIntervalsParams {
      */
     start_date: (string & {}) | Shared.BillingCycleRelativeDate;
 
+    /**
+     * The definition of a new allocation price to create and add to the subscription.
+     */
+    allocation_price?: Add.AllocationPrice | null;
+
     /**
      * A list of discounts to initialize on the price interval.
      */
@@ -3657,6 +3687,33 @@ export namespace SubscriptionPriceIntervalsParams {
   }
 
   export namespace Add {
+    /**
+     * The definition of a new allocation price to create and add to the subscription.
+     */
+    export interface AllocationPrice {
+      /**
+       * An amount of the currency to allocate to the customer at the specified cadence.
+       */
+      amount: string;
+
+      /**
+       * The cadence at which to allocate the amount to the customer.
+       */
+      cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual';
+
+      /**
+       * An ISO 4217 currency string or a custom pricing unit identifier in which to bill
+       * this price.
+       */
+      currency: string;
+
+      /**
+       * Whether the allocated amount should expire at the end of the cadence or roll
+       * over to the next period.
+       */
+      expires_at_end_of_cadence: boolean;
+    }
+
     export interface AmountDiscountCreationParams {
       /**
        * Only available if discount_type is `amount`.
@@ -3702,7 +3759,7 @@ export namespace SubscriptionPriceIntervalsParams {
       /**
        * The cadence to bill for this price on.
        */
-      cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
 
       /**
        * An ISO 4217 currency string for which this price is billed in.
@@ -3755,6 +3812,13 @@ export namespace SubscriptionPriceIntervalsParams {
        * The property used to group this price on an invoice
        */
       invoice_grouping_key?: 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?: Record<string, string | null> | null;
     }
 
     export namespace NewFloatingUnitPrice {
@@ -3770,7 +3834,7 @@ export namespace SubscriptionPriceIntervalsParams {
       /**
        * The cadence to bill for this price on.
        */
-      cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
 
       /**
        * An ISO 4217 currency string for which this price is billed in.
@@ -3823,6 +3887,13 @@ export namespace SubscriptionPriceIntervalsParams {
        * The property used to group this price on an invoice
        */
       invoice_grouping_key?: 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?: Record<string, string | null> | null;
     }
 
     export namespace NewFloatingPackagePrice {
@@ -3844,7 +3915,7 @@ export namespace SubscriptionPriceIntervalsParams {
       /**
        * The cadence to bill for this price on.
        */
-      cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
 
       /**
        * An ISO 4217 currency string for which this price is billed in.
@@ -3897,6 +3968,13 @@ export namespace SubscriptionPriceIntervalsParams {
        * The property used to group this price on an invoice
        */
       invoice_grouping_key?: 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?: Record<string, string | null> | null;
     }
 
     export namespace NewFloatingMatrixPrice {
@@ -3938,7 +4016,7 @@ export namespace SubscriptionPriceIntervalsParams {
       /**
        * The cadence to bill for this price on.
        */
-      cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
 
       /**
        * An ISO 4217 currency string for which this price is billed in.
@@ -3991,6 +4069,13 @@ export namespace SubscriptionPriceIntervalsParams {
        * The property used to group this price on an invoice
        */
       invoice_grouping_key?: 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?: Record<string, string | null> | null;
     }
 
     export namespace NewFloatingMatrixWithAllocationPrice {
@@ -4037,7 +4122,7 @@ export namespace SubscriptionPriceIntervalsParams {
       /**
        * The cadence to bill for this price on.
        */
-      cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
 
       /**
        * An ISO 4217 currency string for which this price is billed in.
@@ -4090,6 +4175,13 @@ export namespace SubscriptionPriceIntervalsParams {
        * The property used to group this price on an invoice
        */
       invoice_grouping_key?: 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?: Record<string, string | null> | null;
     }
 
     export namespace NewFloatingTieredPrice {
@@ -4124,7 +4216,7 @@ export namespace SubscriptionPriceIntervalsParams {
       /**
        * The cadence to bill for this price on.
        */
-      cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
 
       /**
        * An ISO 4217 currency string for which this price is billed in.
@@ -4177,6 +4269,13 @@ export namespace SubscriptionPriceIntervalsParams {
        * The property used to group this price on an invoice
        */
       invoice_grouping_key?: 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?: Record<string, string | null> | null;
     }
 
     export namespace NewFloatingTieredBpsPrice {
@@ -4219,7 +4318,7 @@ export namespace SubscriptionPriceIntervalsParams {
       /**
        * The cadence to bill for this price on.
        */
-      cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
 
       /**
        * An ISO 4217 currency string for which this price is billed in.
@@ -4270,6 +4369,13 @@ export namespace SubscriptionPriceIntervalsParams {
        * The property used to group this price on an invoice
        */
       invoice_grouping_key?: 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?: Record<string, string | null> | null;
     }
 
     export namespace NewFloatingBpsPrice {
@@ -4292,7 +4398,7 @@ export namespace SubscriptionPriceIntervalsParams {
       /**
        * The cadence to bill for this price on.
        */
-      cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
 
       /**
        * An ISO 4217 currency string for which this price is billed in.
@@ -4343,6 +4449,13 @@ export namespace SubscriptionPriceIntervalsParams {
        * The property used to group this price on an invoice
        */
       invoice_grouping_key?: 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?: Record<string, string | null> | null;
     }
 
     export namespace NewFloatingBulkBpsPrice {
@@ -4380,7 +4493,7 @@ export namespace SubscriptionPriceIntervalsParams {
       /**
        * The cadence to bill for this price on.
        */
-      cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
 
       /**
        * An ISO 4217 currency string for which this price is billed in.
@@ -4431,6 +4544,13 @@ export namespace SubscriptionPriceIntervalsParams {
        * The property used to group this price on an invoice
        */
       invoice_grouping_key?: 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?: Record<string, string | null> | null;
     }
 
     export namespace NewFloatingBulkPrice {
@@ -4460,7 +4580,7 @@ export namespace SubscriptionPriceIntervalsParams {
       /**
        * The cadence to bill for this price on.
        */
-      cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
 
       /**
        * An ISO 4217 currency string for which this price is billed in.
@@ -4513,13 +4633,20 @@ export namespace SubscriptionPriceIntervalsParams {
        * The property used to group this price on an invoice
        */
       invoice_grouping_key?: 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?: Record<string, string | null> | null;
     }
 
     export interface NewFloatingTieredPackagePrice {
       /**
        * The cadence to bill for this price on.
        */
-      cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
 
       /**
        * An ISO 4217 currency string for which this price is billed in.
@@ -4572,13 +4699,20 @@ export namespace SubscriptionPriceIntervalsParams {
        * The property used to group this price on an invoice
        */
       invoice_grouping_key?: 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?: Record<string, string | null> | null;
     }
 
     export interface NewFloatingGroupedTieredPrice {
       /**
        * The cadence to bill for this price on.
        */
-      cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
 
       /**
        * An ISO 4217 currency string for which this price is billed in.
@@ -4631,13 +4765,20 @@ export namespace SubscriptionPriceIntervalsParams {
        * The property used to group this price on an invoice
        */
       invoice_grouping_key?: 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?: Record<string, string | null> | null;
     }
 
     export interface NewFloatingTieredWithMinimumPrice {
       /**
        * The cadence to bill for this price on.
        */
-      cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
 
       /**
        * An ISO 4217 currency string for which this price is billed in.
@@ -4690,13 +4831,20 @@ export namespace SubscriptionPriceIntervalsParams {
        * The property used to group this price on an invoice
        */
       invoice_grouping_key?: 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?: Record<string, string | null> | null;
     }
 
     export interface NewFloatingPackageWithAllocationPrice {
       /**
        * The cadence to bill for this price on.
        */
-      cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
 
       /**
        * An ISO 4217 currency string for which this price is billed in.
@@ -4749,13 +4897,20 @@ export namespace SubscriptionPriceIntervalsParams {
        * The property used to group this price on an invoice
        */
       invoice_grouping_key?: 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?: Record<string, string | null> | null;
     }
 
     export interface NewFloatingTieredPackageWithMinimumPrice {
       /**
        * The cadence to bill for this price on.
        */
-      cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
 
       /**
        * An ISO 4217 currency string for which this price is billed in.
@@ -4808,13 +4963,20 @@ export namespace SubscriptionPriceIntervalsParams {
        * The property used to group this price on an invoice
        */
       invoice_grouping_key?: 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?: Record<string, string | null> | null;
     }
 
     export interface NewFloatingUnitWithPercentPrice {
       /**
        * The cadence to bill for this price on.
        */
-      cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
 
       /**
        * An ISO 4217 currency string for which this price is billed in.
@@ -4867,13 +5029,20 @@ export namespace SubscriptionPriceIntervalsParams {
        * The property used to group this price on an invoice
        */
       invoice_grouping_key?: 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?: Record<string, string | null> | null;
     }
 
     export interface NewFloatingTieredWithProrationPrice {
       /**
        * The cadence to bill for this price on.
        */
-      cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
 
       /**
        * An ISO 4217 currency string for which this price is billed in.
@@ -4926,13 +5095,20 @@ export namespace SubscriptionPriceIntervalsParams {
        * The property used to group this price on an invoice
        */
       invoice_grouping_key?: 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?: Record<string, string | null> | null;
     }
 
     export interface NewFloatingUnitWithProrationPrice {
       /**
        * The cadence to bill for this price on.
        */
-      cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
 
       /**
        * An ISO 4217 currency string for which this price is billed in.
@@ -4985,6 +5161,87 @@ export namespace SubscriptionPriceIntervalsParams {
        * The property used to group this price on an invoice
        */
       invoice_grouping_key?: 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?: Record<string, string | null> | null;
+    }
+  }
+
+  export interface AddAdjustment {
+    /**
+     * The definition of a new adjustment to create and add to the subscription.
+     */
+    adjustment:
+      | AddAdjustment.NewPercentageDiscount
+      | AddAdjustment.NewAmountDiscount
+      | AddAdjustment.NewMinimum
+      | AddAdjustment.NewMaximum;
+
+    /**
+     * The start date of the adjustment interval. This is the date that the adjustment
+     * will start affecting prices on the subscription.
+     */
+    start_date: (string & {}) | Shared.BillingCycleRelativeDate;
+
+    /**
+     * The end date of the adjustment interval. This is the date that the adjustment
+     * will stop affecting prices on the subscription.
+     */
+    end_date?: (string & {}) | Shared.BillingCycleRelativeDate | null;
+  }
+
+  export namespace AddAdjustment {
+    export interface NewPercentageDiscount {
+      adjustment_type: 'percentage_discount';
+
+      /**
+       * The set of price IDs to which this adjustment applies.
+       */
+      applies_to_price_ids: Array<string>;
+
+      percentage_discount: number;
+    }
+
+    export interface NewAmountDiscount {
+      adjustment_type: 'amount_discount';
+
+      amount_discount: string;
+
+      /**
+       * The set of price IDs to which this adjustment applies.
+       */
+      applies_to_price_ids: Array<string>;
+    }
+
+    export interface NewMinimum {
+      adjustment_type: 'minimum';
+
+      /**
+       * The set of price IDs to which this adjustment applies.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * The item ID that revenue from this minimum will be attributed to.
+       */
+      item_id: string;
+
+      minimum_amount: string;
+    }
+
+    export interface NewMaximum {
+      adjustment_type: 'maximum';
+
+      /**
+       * The set of price IDs to which this adjustment applies.
+       */
+      applies_to_price_ids: Array<string>;
+
+      maximum_amount: string;
     }
   }
 
@@ -5034,6 +5291,25 @@ export namespace SubscriptionPriceIntervalsParams {
       quantity: number;
     }
   }
+
+  export interface EditAdjustment {
+    /**
+     * The id of the adjustment interval to edit.
+     */
+    adjustment_interval_id: string;
+
+    /**
+     * The updated end date of this adjustment interval. If not specified, the start
+     * date will not be updated.
+     */
+    end_date?: (string & {}) | Shared.BillingCycleRelativeDate | null;
+
+    /**
+     * The updated start date of this adjustment interval. If not specified, the start
+     * date will not be updated.
+     */
+    start_date?: (string & {}) | Shared.BillingCycleRelativeDate;
+  }
 }
 
 export interface SubscriptionSchedulePlanChangeParams {

package/src/resources/top-level.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '../core';
 import { APIResource } from '../resource';
+import * as Core from '../core';
 import * as TopLevelAPI from './top-level';
 
 export class TopLevel extends APIResource {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.11.2'; // x-release-please-version
+export const VERSION = '3.0.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.11.2";
+export declare const VERSION = "3.0.0";
 //# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '2.11.2'; // x-release-please-version
+exports.VERSION = '3.0.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '2.11.2'; // x-release-please-version
+export const VERSION = '3.0.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}