release: 4.63.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "4.62.0"
+  ".": "4.63.0"
 }

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 103
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-7b65f996788617c2d2f2e8e941d366edd1a2844f15eefec555e220b03bbc6d4c.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-d4f03b16daf0bae33be634c959dafb0e21b0bcb156beb162f8235394dca88e7c.yml

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 4.63.0 (2025-02-27)
+
+Full Changelog: [v4.62.0...v4.63.0](https://github.com/orbcorp/orb-node/compare/v4.62.0...v4.63.0)
+
+### Features
+
+* **api:** api update ([#528](https://github.com/orbcorp/orb-node/issues/528)) ([7ae6783](https://github.com/orbcorp/orb-node/commit/7ae678312ced9035bc41c45f3957c57bb4a9c966))
+
 ## 4.62.0 (2025-02-25)
 
 Full Changelog: [v4.61.0...v4.62.0](https://github.com/orbcorp/orb-node/compare/v4.61.0...v4.62.0)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "orb-billing",
-  "version": "4.62.0",
+  "version": "4.63.0",
   "description": "The official TypeScript library for the Orb API",
   "author": "Orb <[email protected]>",
   "types": "dist/index.d.ts",

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

@@ -50,7 +50,8 @@ export class TopUps extends APIResource {
   }
 
   /**
-   * Delete top-up
+   * This deactivates the top-up and voids any invoices associated with pending
+   * credit blocks purchased through the top-up.
    */
   delete(customerId: string, topUpId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.delete(`/customers/${customerId}/credits/top_ups/${topUpId}`, {
@@ -80,7 +81,8 @@ export class TopUps extends APIResource {
   }
 
   /**
-   * Delete top-up by external ID
+   * This deactivates the top-up and voids any invoices associated with pending
+   * credit blocks purchased through the top-up.
    */
   deleteByExternalId(
     externalCustomerId: string,

src/resources/subscriptions.ts

@@ -1634,6 +1634,11 @@ export namespace Subscription {
      */
     end_date: string | null;
 
+    /**
+     * An additional filter to apply to usage queries.
+     */
+    filter: string | null;
+
     /**
      * The fixed fee quantity transitions for this price interval. This is only
      * relevant for fixed fees.
@@ -1659,6 +1664,12 @@ export namespace Subscription {
      * for this price.
      */
     start_date: string;
+
+    /**
+     * A list of customer IDs whose usage events will be aggregated and billed under
+     * this price interval.
+     */
+    usage_customer_ids: Array<string> | null;
   }
 
   export namespace PriceInterval {
@@ -2320,6 +2331,11 @@ export namespace SubscriptionCreateResponse {
      */
     end_date: string | null;
 
+    /**
+     * An additional filter to apply to usage queries.
+     */
+    filter: string | null;
+
     /**
      * The fixed fee quantity transitions for this price interval. This is only
      * relevant for fixed fees.
@@ -2345,6 +2361,12 @@ export namespace SubscriptionCreateResponse {
      * for this price.
      */
     start_date: string;
+
+    /**
+     * A list of customer IDs whose usage events will be aggregated and billed under
+     * this price interval.
+     */
+    usage_customer_ids: Array<string> | null;
   }
 
   export namespace PriceInterval {
@@ -2924,6 +2946,11 @@ export namespace SubscriptionCancelResponse {
      */
     end_date: string | null;
 
+    /**
+     * An additional filter to apply to usage queries.
+     */
+    filter: string | null;
+
     /**
      * The fixed fee quantity transitions for this price interval. This is only
      * relevant for fixed fees.
@@ -2949,6 +2976,12 @@ export namespace SubscriptionCancelResponse {
      * for this price.
      */
     start_date: string;
+
+    /**
+     * A list of customer IDs whose usage events will be aggregated and billed under
+     * this price interval.
+     */
+    usage_customer_ids: Array<string> | null;
   }
 
   export namespace PriceInterval {
@@ -3606,6 +3639,11 @@ export namespace SubscriptionPriceIntervalsResponse {
      */
     end_date: string | null;
 
+    /**
+     * An additional filter to apply to usage queries.
+     */
+    filter: string | null;
+
     /**
      * The fixed fee quantity transitions for this price interval. This is only
      * relevant for fixed fees.
@@ -3631,6 +3669,12 @@ export namespace SubscriptionPriceIntervalsResponse {
      * for this price.
      */
     start_date: string;
+
+    /**
+     * A list of customer IDs whose usage events will be aggregated and billed under
+     * this price interval.
+     */
+    usage_customer_ids: Array<string> | null;
   }
 
   export namespace PriceInterval {
@@ -4210,6 +4254,11 @@ export namespace SubscriptionSchedulePlanChangeResponse {
      */
     end_date: string | null;
 
+    /**
+     * An additional filter to apply to usage queries.
+     */
+    filter: string | null;
+
     /**
      * The fixed fee quantity transitions for this price interval. This is only
      * relevant for fixed fees.
@@ -4235,6 +4284,12 @@ export namespace SubscriptionSchedulePlanChangeResponse {
      * for this price.
      */
     start_date: string;
+
+    /**
+     * A list of customer IDs whose usage events will be aggregated and billed under
+     * this price interval.
+     */
+    usage_customer_ids: Array<string> | null;
   }
 
   export namespace PriceInterval {
@@ -4814,6 +4869,11 @@ export namespace SubscriptionTriggerPhaseResponse {
      */
     end_date: string | null;
 
+    /**
+     * An additional filter to apply to usage queries.
+     */
+    filter: string | null;
+
     /**
      * The fixed fee quantity transitions for this price interval. This is only
      * relevant for fixed fees.
@@ -4839,6 +4899,12 @@ export namespace SubscriptionTriggerPhaseResponse {
      * for this price.
      */
     start_date: string;
+
+    /**
+     * A list of customer IDs whose usage events will be aggregated and billed under
+     * this price interval.
+     */
+    usage_customer_ids: Array<string> | null;
   }
 
   export namespace PriceInterval {
@@ -5418,6 +5484,11 @@ export namespace SubscriptionUnscheduleCancellationResponse {
      */
     end_date: string | null;
 
+    /**
+     * An additional filter to apply to usage queries.
+     */
+    filter: string | null;
+
     /**
      * The fixed fee quantity transitions for this price interval. This is only
      * relevant for fixed fees.
@@ -5443,6 +5514,12 @@ export namespace SubscriptionUnscheduleCancellationResponse {
      * for this price.
      */
     start_date: string;
+
+    /**
+     * A list of customer IDs whose usage events will be aggregated and billed under
+     * this price interval.
+     */
+    usage_customer_ids: Array<string> | null;
   }
 
   export namespace PriceInterval {
@@ -6022,6 +6099,11 @@ export namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
      */
     end_date: string | null;
 
+    /**
+     * An additional filter to apply to usage queries.
+     */
+    filter: string | null;
+
     /**
      * The fixed fee quantity transitions for this price interval. This is only
      * relevant for fixed fees.
@@ -6047,6 +6129,12 @@ export namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
      * for this price.
      */
     start_date: string;
+
+    /**
+     * A list of customer IDs whose usage events will be aggregated and billed under
+     * this price interval.
+     */
+    usage_customer_ids: Array<string> | null;
   }
 
   export namespace PriceInterval {
@@ -6626,6 +6714,11 @@ export namespace SubscriptionUnschedulePendingPlanChangesResponse {
      */
     end_date: string | null;
 
+    /**
+     * An additional filter to apply to usage queries.
+     */
+    filter: string | null;
+
     /**
      * The fixed fee quantity transitions for this price interval. This is only
      * relevant for fixed fees.
@@ -6651,6 +6744,12 @@ export namespace SubscriptionUnschedulePendingPlanChangesResponse {
      * for this price.
      */
     start_date: string;
+
+    /**
+     * A list of customer IDs whose usage events will be aggregated and billed under
+     * this price interval.
+     */
+    usage_customer_ids: Array<string> | null;
   }
 
   export namespace PriceInterval {
@@ -7230,6 +7329,11 @@ export namespace SubscriptionUpdateFixedFeeQuantityResponse {
      */
     end_date: string | null;
 
+    /**
+     * An additional filter to apply to usage queries.
+     */
+    filter: string | null;
+
     /**
      * The fixed fee quantity transitions for this price interval. This is only
      * relevant for fixed fees.
@@ -7255,6 +7359,12 @@ export namespace SubscriptionUpdateFixedFeeQuantityResponse {
      * for this price.
      */
     start_date: string;
+
+    /**
+     * A list of customer IDs whose usage events will be aggregated and billed under
+     * this price interval.
+     */
+    usage_customer_ids: Array<string> | null;
   }
 
   export namespace PriceInterval {
@@ -7834,6 +7944,11 @@ export namespace SubscriptionUpdateTrialResponse {
      */
     end_date: string | null;
 
+    /**
+     * An additional filter to apply to usage queries.
+     */
+    filter: string | null;
+
     /**
      * The fixed fee quantity transitions for this price interval. This is only
      * relevant for fixed fees.
@@ -7859,6 +7974,12 @@ export namespace SubscriptionUpdateTrialResponse {
      * for this price.
      */
     start_date: string;
+
+    /**
+     * A list of customer IDs whose usage events will be aggregated and billed under
+     * this price interval.
+     */
+    usage_customer_ids: Array<string> | null;
   }
 
   export namespace PriceInterval {
@@ -13402,6 +13523,14 @@ export namespace SubscriptionPriceIntervalsParams {
      */
     external_price_id?: string | null;
 
+    /**
+     * An additional filter to apply to usage queries. This filter must be expressed as
+     * a boolean
+     * [computed property](/extensibility/advanced-metrics#computed-properties). If
+     * null, usage queries will not include any additional filter.
+     */
+    filter?: string | null;
+
     /**
      * A list of fixed fee quantity transitions to initialize on the price interval.
      */
@@ -13457,6 +13586,16 @@ export namespace SubscriptionPriceIntervalsParams {
      * The id of the price to add to the subscription.
      */
     price_id?: string | null;
+
+    /**
+     * A list of customer IDs whose usage events will be aggregated and billed under
+     * this subscription. By default, a subscription only considers usage events
+     * associated with its attached customer's customer_id. When usage_customer_ids is
+     * provided, the subscription includes usage events from the specified customers
+     * only. Provided usage_customer_ids must be either the customer for this
+     * subscription itself, or any of that customer's children.
+     */
+    usage_customer_ids?: Array<string> | null;
   }
 
   export namespace Add {
@@ -17009,6 +17148,14 @@ export namespace SubscriptionPriceIntervalsParams {
      */
     end_date?: (string & {}) | Shared.BillingCycleRelativeDate | null;
 
+    /**
+     * An additional filter to apply to usage queries. This filter must be expressed as
+     * a boolean
+     * [computed property](/extensibility/advanced-metrics#computed-properties). If
+     * null, usage queries will not include any additional filter.
+     */
+    filter?: string | null;
+
     /**
      * A list of fixed fee quantity transitions to use for this price interval. Note
      * that this list will overwrite all existing fixed fee quantity transitions on the
@@ -17021,6 +17168,16 @@ export namespace SubscriptionPriceIntervalsParams {
      * will not be updated.
      */
     start_date?: (string & {}) | Shared.BillingCycleRelativeDate;
+
+    /**
+     * A list of customer IDs whose usage events will be aggregated and billed under
+     * this subscription. By default, a subscription only considers usage events
+     * associated with its attached customer's customer_id. When usage_customer_ids is
+     * provided, the subscription includes usage events from the specified customers
+     * only. Provided usage_customer_ids must be either the customer for this
+     * subscription itself, or any of that customer's children.
+     */
+    usage_customer_ids?: Array<string> | null;
   }
 
   export namespace Edit {

src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.62.0'; // x-release-please-version
+export const VERSION = '4.63.0'; // x-release-please-version