orb-billing 5.48.0 → 5.76.0

package/resources/subscriptions.js

@@ -267,6 +267,12 @@ class Subscriptions extends resource_1.APIResource {
      * ## Limits
      *
      * By default, Orb limits the number of subscriptions per customer to 100.
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.create();
+     * ```
      */
     create(body, options) {
         return this._client.post('/subscriptions', { body, ...options });
@@ -275,6 +281,13 @@ class Subscriptions extends resource_1.APIResource {
      * This endpoint can be used to update the `metadata`, `net terms`,
      * `auto_collection`, `invoicing_threshold`, and `default_invoice_memo` properties
      * on a subscription.
+     *
+     * @example
+     * ```ts
+     * const subscription = await client.subscriptions.update(
+     *   'subscription_id',
+     * );
+     * ```
      */
     update(subscriptionId, body, options) {
         return this._client.put(`/subscriptions/${subscriptionId}`, { body, ...options });
@@ -347,6 +360,14 @@ class Subscriptions extends resource_1.APIResource {
      * Orb will void the intervening invoice and generate a new one based on the new
      * dates for the subscription. See the section on
      * [cancellation behaviors](/product-catalog/creating-subscriptions#cancellation-behaviors).
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.cancel('subscription_id', {
+     *     cancel_option: 'end_of_subscription_term',
+     *   });
+     * ```
      */
     cancel(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/cancel`, { body, ...options });
@@ -354,6 +375,13 @@ class Subscriptions extends resource_1.APIResource {
     /**
      * This endpoint is used to fetch a [Subscription](/core-concepts##subscription)
      * given an identifier.
+     *
+     * @example
+     * ```ts
+     * const subscription = await client.subscriptions.fetch(
+     *   'subscription_id',
+     * );
+     * ```
      */
     fetch(subscriptionId, options) {
         return this._client.get(`/subscriptions/${subscriptionId}`, options);
@@ -449,12 +477,29 @@ class Subscriptions extends resource_1.APIResource {
      * existing list of transitions can be retrieved using the
      * `fixed_fee_quantity_transitions` property on a subscription’s serialized price
      * intervals.
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.priceIntervals(
+     *     'subscription_id',
+     *   );
+     * ```
      */
     priceIntervals(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/price_intervals`, { body, ...options });
     }
     /**
      * Redeem a coupon effective at a given time.
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.redeemCoupon(
+     *     'subscription_id',
+     *     { change_option: 'requested_date' },
+     *   );
+     * ```
      */
     redeemCoupon(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/redeem_coupon`, { body, ...options });
@@ -643,6 +688,15 @@ class Subscriptions extends resource_1.APIResource {
      * a plan change, adjusting the customer balance as needed. For details on this
      * behavior, see
      * [Modifying subscriptions](/product-catalog/modifying-subscriptions#prorations-for-in-advance-fees).
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.schedulePlanChange(
+     *     'subscription_id',
+     *     { change_option: 'requested_date' },
+     *   );
+     * ```
      */
     schedulePlanChange(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/schedule_plan_change`, { body, ...options });
@@ -650,6 +704,14 @@ class Subscriptions extends resource_1.APIResource {
     /**
      * Manually trigger a phase, effective the given date (or the current time, if not
      * specified).
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.triggerPhase(
+     *     'subscription_id',
+     *   );
+     * ```
      */
     triggerPhase(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/trigger_phase`, { body, ...options });
@@ -661,6 +723,20 @@ class Subscriptions extends resource_1.APIResource {
      * To be eligible, the subscription must currently be active and have a future
      * 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.
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.unscheduleCancellation(
+     *     'subscription_id',
+     *   );
+     * ```
      */
     unscheduleCancellation(subscriptionId, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/unschedule_cancellation`, options);
@@ -671,6 +747,15 @@ class Subscriptions extends resource_1.APIResource {
      *
      * If there are no updates scheduled, a request validation error will be returned
      * with a 400 status code.
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.unscheduleFixedFeeQuantityUpdates(
+     *     'subscription_id',
+     *     { price_id: 'price_id' },
+     *   );
+     * ```
      */
     unscheduleFixedFeeQuantityUpdates(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/unschedule_fixed_fee_quantity_updates`, {
@@ -681,6 +766,14 @@ class Subscriptions extends resource_1.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.
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.unschedulePendingPlanChanges(
+     *     'subscription_id',
+     *   );
+     * ```
      */
     unschedulePendingPlanChanges(subscriptionId, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/unschedule_pending_plan_changes`, options);
@@ -700,6 +793,15 @@ class Subscriptions extends resource_1.APIResource {
      *
      * If the fee is an in-advance fixed fee, it will also issue an immediate invoice
      * for the difference for the remainder of the billing period.
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.updateFixedFeeQuantity(
+     *     'subscription_id',
+     *     { price_id: 'price_id', quantity: 0 },
+     *   );
+     * ```
      */
     updateFixedFeeQuantity(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/update_fixed_fee_quantity`, {
@@ -726,6 +828,15 @@ class Subscriptions extends resource_1.APIResource {
      * end date shift (so, e.g., if a plan change is scheduled or an add-on price was
      * added, that change will be pushed back by the same amount of time the trial is
      * extended).
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.updateTrial(
+     *     'subscription_id',
+     *     { trial_end_date: '2017-07-21T17:32:28Z' },
+     *   );
+     * ```
      */
     updateTrial(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/update_trial`, { body, ...options });

package/resources/subscriptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../src/resources/subscriptions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAO3C,iDAAsD;AAEtD,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqQG;IACH,MAAM,CACJ,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAkBD,IAAI,CACF,QAAsD,EAAE,EACxD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8DG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAsB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAuBD,UAAU,CACR,cAAsB,EACtB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAiBD,aAAa,CACX,cAAsB,EACtB,QAA+D,EAAE,EACjE,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,kBAAkB,cAAc,WAAW,EAC3C,sCAAsC,EACtC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IA4MD,UAAU,CACR,cAAsB,EACtB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyEG;IACH,cAAc,CACZ,cAAsB,EACtB,IAAsC,EACtC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;OAEG;IACH,YAAY,CACV,cAAsB,EACtB,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwLG;IACH,kBAAkB,CAChB,cAAsB,EACtB,IAA0C,EAC1C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,YAAY,CACV,cAAsB,EACtB,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;OAOG;IACH,sBAAsB,CACpB,cAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,0BAA0B,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;OAMG;IACH,iCAAiC,CAC/B,cAAsB,EACtB,IAAyD,EACzD,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,wCAAwC,EAAE;YACjG,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,4BAA4B,CAC1B,cAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,sBAAsB,CACpB,cAAsB,EACtB,IAA8C,EAC9C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,4BAA4B,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,CACT,cAAsB,EACtB,IAAmC,EACnC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;CACF;AAniCD,sCAmiCC;AAED,MAAa,iBAAkB,SAAQ,iBAAkB;CAAG;AAA5D,8CAA4D;AAE5D,MAAa,sCAAuC,SAAQ,iBAAuC;CAAG;AAAtG,wFAAsG;AAwpRtG,aAAa,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;AACpD,aAAa,CAAC,sCAAsC,GAAG,sCAAsC,CAAC"}
+{"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../src/resources/subscriptions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAO3C,iDAAsD;AAEtD,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2QG;IACH,MAAM,CACJ,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IA+BD,IAAI,CACF,QAAsD,EAAE,EACxD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsEG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,cAAsB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IA8BD,UAAU,CACR,cAAsB,EACtB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IA2BD,aAAa,CACX,cAAsB,EACtB,QAA+D,EAAE,EACjE,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,kBAAkB,cAAc,WAAW,EAC3C,sCAAsC,EACtC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAkND,UAAU,CACR,cAAsB,EACtB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiFG;IACH,cAAc,CACZ,cAAsB,EACtB,IAAsC,EACtC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CACV,cAAsB,EACtB,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiMG;IACH,kBAAkB,CAChB,cAAsB,EACtB,IAA0C,EAC1C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CACV,cAAsB,EACtB,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,sBAAsB,CACpB,cAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,0BAA0B,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,iCAAiC,CAC/B,cAAsB,EACtB,IAAyD,EACzD,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,wCAAwC,EAAE;YACjG,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,4BAA4B,CAC1B,cAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,sBAAsB,CACpB,cAAsB,EACtB,IAA8C,EAC9C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,4BAA4B,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,WAAW,CACT,cAAsB,EACtB,IAAmC,EACnC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;CACF;AAtrCD,sCAsrCC;AAED,MAAa,iBAAkB,SAAQ,iBAAkB;CAAG;AAA5D,8CAA4D;AAE5D,MAAa,sCAAuC,SAAQ,iBAAuC;CAAG;AAAtG,wFAAsG;AAujXtG,aAAa,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;AACpD,aAAa,CAAC,sCAAsC,GAAG,sCAAsC,CAAC"}

package/resources/subscriptions.mjs

@@ -264,6 +264,12 @@ export class Subscriptions extends APIResource {
      * ## Limits
      *
      * By default, Orb limits the number of subscriptions per customer to 100.
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.create();
+     * ```
      */
     create(body, options) {
         return this._client.post('/subscriptions', { body, ...options });
@@ -272,6 +278,13 @@ export class Subscriptions extends APIResource {
      * This endpoint can be used to update the `metadata`, `net terms`,
      * `auto_collection`, `invoicing_threshold`, and `default_invoice_memo` properties
      * on a subscription.
+     *
+     * @example
+     * ```ts
+     * const subscription = await client.subscriptions.update(
+     *   'subscription_id',
+     * );
+     * ```
      */
     update(subscriptionId, body, options) {
         return this._client.put(`/subscriptions/${subscriptionId}`, { body, ...options });
@@ -344,6 +357,14 @@ export class Subscriptions extends APIResource {
      * Orb will void the intervening invoice and generate a new one based on the new
      * dates for the subscription. See the section on
      * [cancellation behaviors](/product-catalog/creating-subscriptions#cancellation-behaviors).
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.cancel('subscription_id', {
+     *     cancel_option: 'end_of_subscription_term',
+     *   });
+     * ```
      */
     cancel(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/cancel`, { body, ...options });
@@ -351,6 +372,13 @@ export class Subscriptions extends APIResource {
     /**
      * This endpoint is used to fetch a [Subscription](/core-concepts##subscription)
      * given an identifier.
+     *
+     * @example
+     * ```ts
+     * const subscription = await client.subscriptions.fetch(
+     *   'subscription_id',
+     * );
+     * ```
      */
     fetch(subscriptionId, options) {
         return this._client.get(`/subscriptions/${subscriptionId}`, options);
@@ -446,12 +474,29 @@ export class Subscriptions extends APIResource {
      * existing list of transitions can be retrieved using the
      * `fixed_fee_quantity_transitions` property on a subscription’s serialized price
      * intervals.
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.priceIntervals(
+     *     'subscription_id',
+     *   );
+     * ```
      */
     priceIntervals(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/price_intervals`, { body, ...options });
     }
     /**
      * Redeem a coupon effective at a given time.
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.redeemCoupon(
+     *     'subscription_id',
+     *     { change_option: 'requested_date' },
+     *   );
+     * ```
      */
     redeemCoupon(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/redeem_coupon`, { body, ...options });
@@ -640,6 +685,15 @@ export class Subscriptions extends APIResource {
      * a plan change, adjusting the customer balance as needed. For details on this
      * behavior, see
      * [Modifying subscriptions](/product-catalog/modifying-subscriptions#prorations-for-in-advance-fees).
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.schedulePlanChange(
+     *     'subscription_id',
+     *     { change_option: 'requested_date' },
+     *   );
+     * ```
      */
     schedulePlanChange(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/schedule_plan_change`, { body, ...options });
@@ -647,6 +701,14 @@ export class Subscriptions extends APIResource {
     /**
      * Manually trigger a phase, effective the given date (or the current time, if not
      * specified).
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.triggerPhase(
+     *     'subscription_id',
+     *   );
+     * ```
      */
     triggerPhase(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/trigger_phase`, { body, ...options });
@@ -658,6 +720,20 @@ export class Subscriptions extends APIResource {
      * To be eligible, the subscription must currently be active and have a future
      * 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.
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.unscheduleCancellation(
+     *     'subscription_id',
+     *   );
+     * ```
      */
     unscheduleCancellation(subscriptionId, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/unschedule_cancellation`, options);
@@ -668,6 +744,15 @@ export class Subscriptions extends APIResource {
      *
      * If there are no updates scheduled, a request validation error will be returned
      * with a 400 status code.
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.unscheduleFixedFeeQuantityUpdates(
+     *     'subscription_id',
+     *     { price_id: 'price_id' },
+     *   );
+     * ```
      */
     unscheduleFixedFeeQuantityUpdates(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/unschedule_fixed_fee_quantity_updates`, {
@@ -678,6 +763,14 @@ 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.
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.unschedulePendingPlanChanges(
+     *     'subscription_id',
+     *   );
+     * ```
      */
     unschedulePendingPlanChanges(subscriptionId, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/unschedule_pending_plan_changes`, options);
@@ -697,6 +790,15 @@ export class Subscriptions extends APIResource {
      *
      * If the fee is an in-advance fixed fee, it will also issue an immediate invoice
      * for the difference for the remainder of the billing period.
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.updateFixedFeeQuantity(
+     *     'subscription_id',
+     *     { price_id: 'price_id', quantity: 0 },
+     *   );
+     * ```
      */
     updateFixedFeeQuantity(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/update_fixed_fee_quantity`, {
@@ -723,6 +825,15 @@ export class Subscriptions extends APIResource {
      * end date shift (so, e.g., if a plan change is scheduled or an add-on price was
      * added, that change will be pushed back by the same amount of time the trial is
      * extended).
+     *
+     * @example
+     * ```ts
+     * const mutatedSubscription =
+     *   await client.subscriptions.updateTrial(
+     *     'subscription_id',
+     *     { trial_end_date: '2017-07-21T17:32:28Z' },
+     *   );
+     * ```
      */
     updateTrial(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/update_trial`, { body, ...options });

package/resources/subscriptions.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"subscriptions.mjs","sourceRoot":"","sources":["../src/resources/subscriptions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAOpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqQG;IACH,MAAM,CACJ,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAkBD,IAAI,CACF,QAAsD,EAAE,EACxD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8DG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAsB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAuBD,UAAU,CACR,cAAsB,EACtB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAiBD,aAAa,CACX,cAAsB,EACtB,QAA+D,EAAE,EACjE,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,kBAAkB,cAAc,WAAW,EAC3C,sCAAsC,EACtC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IA4MD,UAAU,CACR,cAAsB,EACtB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyEG;IACH,cAAc,CACZ,cAAsB,EACtB,IAAsC,EACtC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;OAEG;IACH,YAAY,CACV,cAAsB,EACtB,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwLG;IACH,kBAAkB,CAChB,cAAsB,EACtB,IAA0C,EAC1C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,YAAY,CACV,cAAsB,EACtB,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;OAOG;IACH,sBAAsB,CACpB,cAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,0BAA0B,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;OAMG;IACH,iCAAiC,CAC/B,cAAsB,EACtB,IAAyD,EACzD,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,wCAAwC,EAAE;YACjG,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,4BAA4B,CAC1B,cAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,sBAAsB,CACpB,cAAsB,EACtB,IAA8C,EAC9C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,4BAA4B,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,CACT,cAAsB,EACtB,IAAmC,EACnC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,IAAkB;CAAG;AAE5D,MAAM,OAAO,sCAAuC,SAAQ,IAAuC;CAAG;AAwpRtG,aAAa,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;AACpD,aAAa,CAAC,sCAAsC,GAAG,sCAAsC,CAAC"}
+{"version":3,"file":"subscriptions.mjs","sourceRoot":"","sources":["../src/resources/subscriptions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAOpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2QG;IACH,MAAM,CACJ,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IA+BD,IAAI,CACF,QAAsD,EAAE,EACxD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsEG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,cAAsB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IA8BD,UAAU,CACR,cAAsB,EACtB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IA2BD,aAAa,CACX,cAAsB,EACtB,QAA+D,EAAE,EACjE,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,kBAAkB,cAAc,WAAW,EAC3C,sCAAsC,EACtC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAkND,UAAU,CACR,cAAsB,EACtB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiFG;IACH,cAAc,CACZ,cAAsB,EACtB,IAAsC,EACtC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CACV,cAAsB,EACtB,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiMG;IACH,kBAAkB,CAChB,cAAsB,EACtB,IAA0C,EAC1C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CACV,cAAsB,EACtB,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,sBAAsB,CACpB,cAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,0BAA0B,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,iCAAiC,CAC/B,cAAsB,EACtB,IAAyD,EACzD,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,wCAAwC,EAAE;YACjG,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,4BAA4B,CAC1B,cAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,sBAAsB,CACpB,cAAsB,EACtB,IAA8C,EAC9C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,4BAA4B,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,WAAW,CACT,cAAsB,EACtB,IAAmC,EACnC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,IAAkB;CAAG;AAE5D,MAAM,OAAO,sCAAuC,SAAQ,IAAuC;CAAG;AAujXtG,aAAa,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;AACpD,aAAa,CAAC,sCAAsC,GAAG,sCAAsC,CAAC"}

package/src/core.ts

@@ -1053,10 +1053,10 @@ export const ensurePresent = <T>(value: T | null | undefined): T => {
  */
 export const readEnv = (env: string): string | undefined => {
   if (typeof process !== 'undefined') {
-    return process.env?.[env]?.trim() ?? undefined;
+    return process.env?.[env]?.trim() || undefined;
   }
   if (typeof Deno !== 'undefined') {
-    return Deno.env?.get?.(env)?.trim();
+    return Deno.env?.get?.(env)?.trim() || undefined;
   }
   return undefined;
 };

package/src/index.ts

@@ -338,6 +338,18 @@ export class Orb extends Core.APIClient {
       fetch: options.fetch,
     });
 
+    const customHeadersEnv = Core.readEnv('ORB_CUSTOM_HEADERS');
+    if (customHeadersEnv) {
+      const parsed: Record<string, string> = {};
+      for (const line of customHeadersEnv.split('\n')) {
+        const colon = line.indexOf(':');
+        if (colon >= 0) {
+          parsed[line.substring(0, colon).trim()] = line.substring(colon + 1).trim();
+        }
+      }
+      options.defaultHeaders = { ...parsed, ...options.defaultHeaders };
+    }
+
     this._options = options;
     this.idempotencyHeader = 'Idempotency-Key';
 

package/src/resources/alerts.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
 import * as Core from '../core';
+import * as AlertsAPI from './alerts';
 import * as Shared from './shared';
 import { Page, type PageParams } from '../pagination';
 
@@ -249,6 +250,18 @@ export interface Alert {
    * Minified license type for alert serialization.
    */
   license_type?: Alert.LicenseType | null;
+
+  /**
+   * Filters scoping which prices are included in grouped cost alert evaluation.
+   */
+  price_filters?: Array<Alert.PriceFilter> | null;
+
+  /**
+   * Per-group threshold overrides. Each override maps a specific combination of
+   * grouping_keys values to a replacement threshold list. Only present for grouped
+   * cost alerts that have at least one override.
+   */
+  threshold_overrides?: Array<Alert.ThresholdOverride> | null;
 }
 
 export namespace Alert {
@@ -298,6 +311,42 @@ export namespace Alert {
   export interface LicenseType {
     id: string;
   }
+
+  export interface PriceFilter {
+    /**
+     * The property of the price to filter on.
+     */
+    field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+    /**
+     * Should prices that match the filter be included or excluded.
+     */
+    operator: 'includes' | 'excludes';
+
+    /**
+     * The IDs or values that match this filter.
+     */
+    values: Array<string>;
+  }
+
+  /**
+   * A per-group threshold override on a grouped cost alert.
+   *
+   * An empty `thresholds` list means the group is silenced (never fires). A
+   * non-empty list fully replaces the default thresholds for that group.
+   */
+  export interface ThresholdOverride {
+    /**
+     * The values of the grouping keys that identify this group. The list length
+     * matches the alert's grouping_keys.
+     */
+    group_values: Array<string>;
+
+    /**
+     * The thresholds applied to this group. An empty list means the group is silenced.
+     */
+    thresholds: Array<AlertsAPI.Threshold>;
+  }
 }
 
 /**
@@ -318,6 +367,59 @@ export interface AlertUpdateParams {
    * The thresholds that define the values at which the alert will be triggered.
    */
   thresholds: Array<Threshold>;
+
+  /**
+   * Replaces the price filters on a grouped cost alert; an empty list clears them.
+   * Only applicable to cost alerts with grouping_keys. Omit to leave unchanged.
+   */
+  price_filters?: Array<AlertUpdateParams.PriceFilter> | null;
+
+  /**
+   * Replaces the per-group threshold overrides on a grouped cost alert; an empty
+   * list clears them. Only applicable to cost alerts with grouping_keys. Omit to
+   * leave unchanged.
+   */
+  threshold_overrides?: Array<AlertUpdateParams.ThresholdOverride> | null;
+}
+
+export namespace AlertUpdateParams {
+  export interface PriceFilter {
+    /**
+     * The property of the price to filter on.
+     */
+    field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+    /**
+     * Should prices that match the filter be included or excluded.
+     */
+    operator: 'includes' | 'excludes';
+
+    /**
+     * The IDs or values that match this filter.
+     */
+    values: Array<string>;
+  }
+
+  /**
+   * Per-group threshold override on a grouped cost alert.
+   *
+   * - An empty `thresholds` list silences alerts for this group (never fires).
+   * - A non-empty list fully replaces the default thresholds for this group.
+   */
+  export interface ThresholdOverride {
+    /**
+     * The values of the grouping keys that identify this group. The list length must
+     * match the alert's grouping_keys, and values appear in the same order as
+     * grouping_keys.
+     */
+    group_values: Array<string>;
+
+    /**
+     * The thresholds to apply to this group. An empty list silences alerts for this
+     * group. A non-empty list fully replaces the default thresholds for this group.
+     */
+    thresholds: Array<AlertsAPI.Threshold>;
+  }
 }
 
 export interface AlertListParams extends PageParams {
@@ -390,6 +492,12 @@ export interface AlertCreateForSubscriptionParams {
    */
   type: 'usage_exceeded' | 'cost_exceeded';
 
+  /**
+   * The case sensitive currency or custom pricing unit to use for grouped cost
+   * alerts. Required when grouping_keys is set.
+   */
+  currency?: string | null;
+
   /**
    * The property keys to group cost alerts by. Only applicable for cost_exceeded
    * alerts.
@@ -402,10 +510,60 @@ export interface AlertCreateForSubscriptionParams {
   metric_id?: string | null;
 
   /**
-   * The pricing unit to use for grouped cost alerts. Required when grouping_keys is
-   * set.
+   * Filters to scope which prices are included in grouped cost alert evaluation.
+   * Supports filtering by price_id, item_id, or price_type with includes/excludes
+   * operators. Only applicable when grouping_keys is set.
+   */
+  price_filters?: Array<AlertCreateForSubscriptionParams.PriceFilter> | null;
+
+  /**
+   * Per-group threshold overrides. Each override maps a specific combination of
+   * grouping_keys values to a list of thresholds that fully replaces the default
+   * thresholds for that group. An empty thresholds list silences the group. Groups
+   * without an override use the default thresholds. Only applicable when
+   * grouping_keys is set.
+   */
+  threshold_overrides?: Array<AlertCreateForSubscriptionParams.ThresholdOverride> | null;
+}
+
+export namespace AlertCreateForSubscriptionParams {
+  export interface PriceFilter {
+    /**
+     * The property of the price to filter on.
+     */
+    field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+    /**
+     * Should prices that match the filter be included or excluded.
+     */
+    operator: 'includes' | 'excludes';
+
+    /**
+     * The IDs or values that match this filter.
+     */
+    values: Array<string>;
+  }
+
+  /**
+   * Per-group threshold override on a grouped cost alert.
+   *
+   * - An empty `thresholds` list silences alerts for this group (never fires).
+   * - A non-empty list fully replaces the default thresholds for this group.
    */
-  pricing_unit_id?: string | null;
+  export interface ThresholdOverride {
+    /**
+     * The values of the grouping keys that identify this group. The list length must
+     * match the alert's grouping_keys, and values appear in the same order as
+     * grouping_keys.
+     */
+    group_values: Array<string>;
+
+    /**
+     * The thresholds to apply to this group. An empty list silences alerts for this
+     * group. A non-empty list fully replaces the default thresholds for this group.
+     */
+    thresholds: Array<AlertsAPI.Threshold>;
+  }
 }
 
 export interface AlertDisableParams {