orb-billing 4.62.0 → 4.63.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 4.63.0 (2025-02-27)
4
+
5
+ Full Changelog: [v4.62.0...v4.63.0](https://github.com/orbcorp/orb-node/compare/v4.62.0...v4.63.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([#528](https://github.com/orbcorp/orb-node/issues/528)) ([7ae6783](https://github.com/orbcorp/orb-node/commit/7ae678312ced9035bc41c45f3957c57bb4a9c966))
10
+
3
11
  ## 4.62.0 (2025-02-25)
4
12
 
5
13
  Full Changelog: [v4.61.0...v4.62.0](https://github.com/orbcorp/orb-node/compare/v4.61.0...v4.62.0)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "orb-billing",
3
- "version": "4.62.0",
3
+ "version": "4.63.0",
4
4
  "description": "The official TypeScript library for the Orb API",
5
5
  "author": "Orb <team@withorb.com>",
6
6
  "types": "./index.d.ts",
@@ -18,7 +18,8 @@ export declare class TopUps extends APIResource {
18
18
  list(customerId: string, query?: TopUpListParams, options?: Core.RequestOptions): Core.PagePromise<TopUpListResponsesPage, TopUpListResponse>;
19
19
  list(customerId: string, options?: Core.RequestOptions): Core.PagePromise<TopUpListResponsesPage, TopUpListResponse>;
20
20
  /**
21
- * Delete top-up
21
+ * This deactivates the top-up and voids any invoices associated with pending
22
+ * credit blocks purchased through the top-up.
22
23
  */
23
24
  delete(customerId: string, topUpId: string, options?: Core.RequestOptions): Core.APIPromise<void>;
24
25
  /**
@@ -32,7 +33,8 @@ export declare class TopUps extends APIResource {
32
33
  */
33
34
  createByExternalId(externalCustomerId: string, body: TopUpCreateByExternalIDParams, options?: Core.RequestOptions): Core.APIPromise<TopUpCreateByExternalIDResponse>;
34
35
  /**
35
- * Delete top-up by external ID
36
+ * This deactivates the top-up and voids any invoices associated with pending
37
+ * credit blocks purchased through the top-up.
36
38
  */
37
39
  deleteByExternalId(externalCustomerId: string, topUpId: string, options?: Core.RequestOptions): Core.APIPromise<void>;
38
40
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"top-ups.d.ts","sourceRoot":"","sources":["../../../src/resources/customers/credits/top-ups.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAE5D,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;OAQG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAIvC;;OAEG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,eAAe,EACvB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,sBAAsB,EAAE,iBAAiB,CAAC;IAC9D,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,sBAAsB,EAAE,iBAAiB,CAAC;IAe9D;;OAEG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAOjG;;;;;;;;OAQG;IACH,kBAAkB,CAChB,kBAAkB,EAAE,MAAM,EAC1B,IAAI,EAAE,6BAA6B,EACnC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,+BAA+B,CAAC;IAOnD;;OAEG;IACH,kBAAkB,CAChB,kBAAkB,EAAE,MAAM,EAC1B,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAOxB;;OAEG;IACH,gBAAgB,CACd,kBAAkB,EAAE,MAAM,EAC1B,KAAK,CAAC,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,kCAAkC,EAAE,6BAA6B,CAAC;IACtF,gBAAgB,CACd,kBAAkB,EAAE,MAAM,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,kCAAkC,EAAE,6BAA6B,CAAC;CAevF;AAED,qBAAa,sBAAuB,SAAQ,IAAI,CAAC,iBAAiB,CAAC;CAAG;AAEtE,qBAAa,kCAAmC,SAAQ,IAAI,CAAC,6BAA6B,CAAC;CAAG;AAE9F,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,EAAE,mBAAmB,CAAC,eAAe,CAAC;IAEtD;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,IAAI,CAAC;CAC7C;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,eAAe;QAC9B;;;WAGG;QACH,eAAe,EAAE,OAAO,CAAC;QAEzB;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;;WAGG;QACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;KACtC;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,EAAE,iBAAiB,CAAC,eAAe,CAAC;IAEpD;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,IAAI,CAAC;CAC7C;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,eAAe;QAC9B;;;WAGG;QACH,eAAe,EAAE,OAAO,CAAC;QAEzB;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;;WAGG;QACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;KACtC;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,EAAE,+BAA+B,CAAC,eAAe,CAAC;IAElE;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,IAAI,CAAC;CAC7C;AAED,yBAAiB,+BAA+B,CAAC;IAC/C;;OAEG;IACH,UAAiB,eAAe;QAC9B;;;WAGG;QACH,eAAe,EAAE,OAAO,CAAC;QAEzB;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;;WAGG;QACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;KACtC;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,EAAE,6BAA6B,CAAC,eAAe,CAAC;IAEhE;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,IAAI,CAAC;CAC7C;AAED,yBAAiB,6BAA6B,CAAC;IAC7C;;OAEG;IACH,UAAiB,eAAe;QAC9B;;;WAGG;QACH,eAAe,EAAE,OAAO,CAAC;QAEzB;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;;WAGG;QACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;KACtC;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,EAAE,iBAAiB,CAAC,eAAe,CAAC;IAEpD;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,IAAI,CAAC;CAC7C;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,eAAe;QAC9B;;;WAGG;QACH,eAAe,EAAE,OAAO,CAAC;QAEzB;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;;WAGG;QACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;KACtC;CACF;AAED,MAAM,WAAW,eAAgB,SAAQ,UAAU;CAAG;AAEtD,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,EAAE,6BAA6B,CAAC,eAAe,CAAC;IAEhE;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,IAAI,CAAC;CAC7C;AAED,yBAAiB,6BAA6B,CAAC;IAC7C;;OAEG;IACH,UAAiB,eAAe;QAC9B;;;WAGG;QACH,eAAe,EAAE,OAAO,CAAC;QAEzB;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;;WAGG;QACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;KACtC;CACF;AAED,MAAM,WAAW,2BAA4B,SAAQ,UAAU;CAAG;AAKlE,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,sBAAsB,IAAI,sBAAsB,EAChD,kCAAkC,IAAI,kCAAkC,EACxE,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
1
+ {"version":3,"file":"top-ups.d.ts","sourceRoot":"","sources":["../../../src/resources/customers/credits/top-ups.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAE5D,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;OAQG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAIvC;;OAEG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,eAAe,EACvB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,sBAAsB,EAAE,iBAAiB,CAAC;IAC9D,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,sBAAsB,EAAE,iBAAiB,CAAC;IAe9D;;;OAGG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAOjG;;;;;;;;OAQG;IACH,kBAAkB,CAChB,kBAAkB,EAAE,MAAM,EAC1B,IAAI,EAAE,6BAA6B,EACnC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,+BAA+B,CAAC;IAOnD;;;OAGG;IACH,kBAAkB,CAChB,kBAAkB,EAAE,MAAM,EAC1B,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAOxB;;OAEG;IACH,gBAAgB,CACd,kBAAkB,EAAE,MAAM,EAC1B,KAAK,CAAC,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,kCAAkC,EAAE,6BAA6B,CAAC;IACtF,gBAAgB,CACd,kBAAkB,EAAE,MAAM,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,kCAAkC,EAAE,6BAA6B,CAAC;CAevF;AAED,qBAAa,sBAAuB,SAAQ,IAAI,CAAC,iBAAiB,CAAC;CAAG;AAEtE,qBAAa,kCAAmC,SAAQ,IAAI,CAAC,6BAA6B,CAAC;CAAG;AAE9F,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,EAAE,mBAAmB,CAAC,eAAe,CAAC;IAEtD;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,IAAI,CAAC;CAC7C;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,eAAe;QAC9B;;;WAGG;QACH,eAAe,EAAE,OAAO,CAAC;QAEzB;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;;WAGG;QACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;KACtC;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,EAAE,iBAAiB,CAAC,eAAe,CAAC;IAEpD;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,IAAI,CAAC;CAC7C;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,eAAe;QAC9B;;;WAGG;QACH,eAAe,EAAE,OAAO,CAAC;QAEzB;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;;WAGG;QACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;KACtC;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,EAAE,+BAA+B,CAAC,eAAe,CAAC;IAElE;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,IAAI,CAAC;CAC7C;AAED,yBAAiB,+BAA+B,CAAC;IAC/C;;OAEG;IACH,UAAiB,eAAe;QAC9B;;;WAGG;QACH,eAAe,EAAE,OAAO,CAAC;QAEzB;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;;WAGG;QACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;KACtC;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,EAAE,6BAA6B,CAAC,eAAe,CAAC;IAEhE;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,IAAI,CAAC;CAC7C;AAED,yBAAiB,6BAA6B,CAAC;IAC7C;;OAEG;IACH,UAAiB,eAAe;QAC9B;;;WAGG;QACH,eAAe,EAAE,OAAO,CAAC;QAEzB;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;;WAGG;QACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;KACtC;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,EAAE,iBAAiB,CAAC,eAAe,CAAC;IAEpD;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,IAAI,CAAC;CAC7C;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,eAAe;QAC9B;;;WAGG;QACH,eAAe,EAAE,OAAO,CAAC;QAEzB;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;;WAGG;QACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;KACtC;CACF;AAED,MAAM,WAAW,eAAgB,SAAQ,UAAU;CAAG;AAEtD,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,EAAE,6BAA6B,CAAC,eAAe,CAAC;IAEhE;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,IAAI,CAAC;CAC7C;AAED,yBAAiB,6BAA6B,CAAC;IAC7C;;OAEG;IACH,UAAiB,eAAe;QAC9B;;;WAGG;QACH,eAAe,EAAE,OAAO,CAAC;QAEzB;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;;WAGG;QACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;KACtC;CACF;AAED,MAAM,WAAW,2BAA4B,SAAQ,UAAU;CAAG;AAKlE,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,sBAAsB,IAAI,sBAAsB,EAChD,kCAAkC,IAAI,kCAAkC,EACxE,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
@@ -28,7 +28,8 @@ class TopUps extends resource_1.APIResource {
28
28
  });
29
29
  }
30
30
  /**
31
- * Delete top-up
31
+ * This deactivates the top-up and voids any invoices associated with pending
32
+ * credit blocks purchased through the top-up.
32
33
  */
33
34
  delete(customerId, topUpId, options) {
34
35
  return this._client.delete(`/customers/${customerId}/credits/top_ups/${topUpId}`, {
@@ -52,7 +53,8 @@ class TopUps extends resource_1.APIResource {
52
53
  });
53
54
  }
54
55
  /**
55
- * Delete top-up by external ID
56
+ * This deactivates the top-up and voids any invoices associated with pending
57
+ * credit blocks purchased through the top-up.
56
58
  */
57
59
  deleteByExternalId(externalCustomerId, topUpId, options) {
58
60
  return this._client.delete(`/customers/external_customer_id/${externalCustomerId}/credits/top_ups/${topUpId}`, { ...options, headers: { Accept: '*/*', ...options?.headers } });
@@ -1 +1 @@
1
- {"version":3,"file":"top-ups.js","sourceRoot":"","sources":["../../../src/resources/customers/credits/top-ups.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAChD,2CAAiD;AAEjD,uDAA4D;AAE5D,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;OAQG;IACH,MAAM,CACJ,UAAkB,EAClB,IAAuB,EACvB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,UAAU,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAcD,IAAI,CACF,UAAkB,EAClB,QAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,UAAU,kBAAkB,EAAE,sBAAsB,EAAE;YACjG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,UAAkB,EAAE,OAAe,EAAE,OAA6B;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,UAAU,oBAAoB,OAAO,EAAE,EAAE;YAChF,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,kBAAkB,CAChB,kBAA0B,EAC1B,IAAmC,EACnC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mCAAmC,kBAAkB,kBAAkB,EAAE;YAChG,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,kBAAkB,CAChB,kBAA0B,EAC1B,OAAe,EACf,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CACxB,mCAAmC,kBAAkB,oBAAoB,OAAO,EAAE,EAClF,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,CAChE,CAAC;IACJ,CAAC;IAcD,gBAAgB,CACd,kBAA0B,EAC1B,QAA2D,EAAE,EAC7D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7D;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,mCAAmC,kBAAkB,kBAAkB,EACvE,kCAAkC,EAClC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AAlHD,wBAkHC;AAED,MAAa,sBAAuB,SAAQ,iBAAuB;CAAG;AAAtE,wDAAsE;AAEtE,MAAa,kCAAmC,SAAQ,iBAAmC;CAAG;AAA9F,gFAA8F;AAoc9F,MAAM,CAAC,sBAAsB,GAAG,sBAAsB,CAAC;AACvD,MAAM,CAAC,kCAAkC,GAAG,kCAAkC,CAAC"}
1
+ {"version":3,"file":"top-ups.js","sourceRoot":"","sources":["../../../src/resources/customers/credits/top-ups.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAChD,2CAAiD;AAEjD,uDAA4D;AAE5D,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;OAQG;IACH,MAAM,CACJ,UAAkB,EAClB,IAAuB,EACvB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,UAAU,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAcD,IAAI,CACF,UAAkB,EAClB,QAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,UAAU,kBAAkB,EAAE,sBAAsB,EAAE;YACjG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,UAAkB,EAAE,OAAe,EAAE,OAA6B;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,UAAU,oBAAoB,OAAO,EAAE,EAAE;YAChF,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,kBAAkB,CAChB,kBAA0B,EAC1B,IAAmC,EACnC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mCAAmC,kBAAkB,kBAAkB,EAAE;YAChG,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,kBAAkB,CAChB,kBAA0B,EAC1B,OAAe,EACf,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CACxB,mCAAmC,kBAAkB,oBAAoB,OAAO,EAAE,EAClF,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,CAChE,CAAC;IACJ,CAAC;IAcD,gBAAgB,CACd,kBAA0B,EAC1B,QAA2D,EAAE,EAC7D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7D;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,mCAAmC,kBAAkB,kBAAkB,EACvE,kCAAkC,EAClC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AApHD,wBAoHC;AAED,MAAa,sBAAuB,SAAQ,iBAAuB;CAAG;AAAtE,wDAAsE;AAEtE,MAAa,kCAAmC,SAAQ,iBAAmC;CAAG;AAA9F,gFAA8F;AAoc9F,MAAM,CAAC,sBAAsB,GAAG,sBAAsB,CAAC;AACvD,MAAM,CAAC,kCAAkC,GAAG,kCAAkC,CAAC"}
@@ -25,7 +25,8 @@ export class TopUps extends APIResource {
25
25
  });
26
26
  }
27
27
  /**
28
- * Delete top-up
28
+ * This deactivates the top-up and voids any invoices associated with pending
29
+ * credit blocks purchased through the top-up.
29
30
  */
30
31
  delete(customerId, topUpId, options) {
31
32
  return this._client.delete(`/customers/${customerId}/credits/top_ups/${topUpId}`, {
@@ -49,7 +50,8 @@ export class TopUps extends APIResource {
49
50
  });
50
51
  }
51
52
  /**
52
- * Delete top-up by external ID
53
+ * This deactivates the top-up and voids any invoices associated with pending
54
+ * credit blocks purchased through the top-up.
53
55
  */
54
56
  deleteByExternalId(externalCustomerId, topUpId, options) {
55
57
  return this._client.delete(`/customers/external_customer_id/${externalCustomerId}/credits/top_ups/${topUpId}`, { ...options, headers: { Accept: '*/*', ...options?.headers } });
@@ -1 +1 @@
1
- {"version":3,"file":"top-ups.mjs","sourceRoot":"","sources":["../../../src/resources/customers/credits/top-ups.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;OAQG;IACH,MAAM,CACJ,UAAkB,EAClB,IAAuB,EACvB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,UAAU,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAcD,IAAI,CACF,UAAkB,EAClB,QAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,UAAU,kBAAkB,EAAE,sBAAsB,EAAE;YACjG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,UAAkB,EAAE,OAAe,EAAE,OAA6B;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,UAAU,oBAAoB,OAAO,EAAE,EAAE;YAChF,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,kBAAkB,CAChB,kBAA0B,EAC1B,IAAmC,EACnC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mCAAmC,kBAAkB,kBAAkB,EAAE;YAChG,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,kBAAkB,CAChB,kBAA0B,EAC1B,OAAe,EACf,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CACxB,mCAAmC,kBAAkB,oBAAoB,OAAO,EAAE,EAClF,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,CAChE,CAAC;IACJ,CAAC;IAcD,gBAAgB,CACd,kBAA0B,EAC1B,QAA2D,EAAE,EAC7D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7D;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,mCAAmC,kBAAkB,kBAAkB,EACvE,kCAAkC,EAClC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,sBAAuB,SAAQ,IAAuB;CAAG;AAEtE,MAAM,OAAO,kCAAmC,SAAQ,IAAmC;CAAG;AAoc9F,MAAM,CAAC,sBAAsB,GAAG,sBAAsB,CAAC;AACvD,MAAM,CAAC,kCAAkC,GAAG,kCAAkC,CAAC"}
1
+ {"version":3,"file":"top-ups.mjs","sourceRoot":"","sources":["../../../src/resources/customers/credits/top-ups.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;OAQG;IACH,MAAM,CACJ,UAAkB,EAClB,IAAuB,EACvB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,UAAU,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAcD,IAAI,CACF,UAAkB,EAClB,QAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,UAAU,kBAAkB,EAAE,sBAAsB,EAAE;YACjG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,UAAkB,EAAE,OAAe,EAAE,OAA6B;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,UAAU,oBAAoB,OAAO,EAAE,EAAE;YAChF,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,kBAAkB,CAChB,kBAA0B,EAC1B,IAAmC,EACnC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mCAAmC,kBAAkB,kBAAkB,EAAE;YAChG,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,kBAAkB,CAChB,kBAA0B,EAC1B,OAAe,EACf,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CACxB,mCAAmC,kBAAkB,oBAAoB,OAAO,EAAE,EAClF,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,CAChE,CAAC;IACJ,CAAC;IAcD,gBAAgB,CACd,kBAA0B,EAC1B,QAA2D,EAAE,EAC7D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7D;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,mCAAmC,kBAAkB,kBAAkB,EACvE,kCAAkC,EAClC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,sBAAuB,SAAQ,IAAuB;CAAG;AAEtE,MAAM,OAAO,kCAAmC,SAAQ,IAAmC;CAAG;AAoc9F,MAAM,CAAC,sBAAsB,GAAG,sBAAsB,CAAC;AACvD,MAAM,CAAC,kCAAkC,GAAG,kCAAkC,CAAC"}
@@ -1364,6 +1364,10 @@ export declare namespace Subscription {
1364
1364
  * this price.
1365
1365
  */
1366
1366
  end_date: string | null;
1367
+ /**
1368
+ * An additional filter to apply to usage queries.
1369
+ */
1370
+ filter: string | null;
1367
1371
  /**
1368
1372
  * The fixed fee quantity transitions for this price interval. This is only
1369
1373
  * relevant for fixed fees.
@@ -1387,6 +1391,11 @@ export declare namespace Subscription {
1387
1391
  * for this price.
1388
1392
  */
1389
1393
  start_date: string;
1394
+ /**
1395
+ * A list of customer IDs whose usage events will be aggregated and billed under
1396
+ * this price interval.
1397
+ */
1398
+ usage_customer_ids: Array<string> | null;
1390
1399
  }
1391
1400
  namespace PriceInterval {
1392
1401
  interface FixedFeeQuantityTransition {
@@ -1898,6 +1907,10 @@ export declare namespace SubscriptionCreateResponse {
1898
1907
  * this price.
1899
1908
  */
1900
1909
  end_date: string | null;
1910
+ /**
1911
+ * An additional filter to apply to usage queries.
1912
+ */
1913
+ filter: string | null;
1901
1914
  /**
1902
1915
  * The fixed fee quantity transitions for this price interval. This is only
1903
1916
  * relevant for fixed fees.
@@ -1921,6 +1934,11 @@ export declare namespace SubscriptionCreateResponse {
1921
1934
  * for this price.
1922
1935
  */
1923
1936
  start_date: string;
1937
+ /**
1938
+ * A list of customer IDs whose usage events will be aggregated and billed under
1939
+ * this price interval.
1940
+ */
1941
+ usage_customer_ids: Array<string> | null;
1924
1942
  }
1925
1943
  namespace PriceInterval {
1926
1944
  interface FixedFeeQuantityTransition {
@@ -2377,6 +2395,10 @@ export declare namespace SubscriptionCancelResponse {
2377
2395
  * this price.
2378
2396
  */
2379
2397
  end_date: string | null;
2398
+ /**
2399
+ * An additional filter to apply to usage queries.
2400
+ */
2401
+ filter: string | null;
2380
2402
  /**
2381
2403
  * The fixed fee quantity transitions for this price interval. This is only
2382
2404
  * relevant for fixed fees.
@@ -2400,6 +2422,11 @@ export declare namespace SubscriptionCancelResponse {
2400
2422
  * for this price.
2401
2423
  */
2402
2424
  start_date: string;
2425
+ /**
2426
+ * A list of customer IDs whose usage events will be aggregated and billed under
2427
+ * this price interval.
2428
+ */
2429
+ usage_customer_ids: Array<string> | null;
2403
2430
  }
2404
2431
  namespace PriceInterval {
2405
2432
  interface FixedFeeQuantityTransition {
@@ -2916,6 +2943,10 @@ export declare namespace SubscriptionPriceIntervalsResponse {
2916
2943
  * this price.
2917
2944
  */
2918
2945
  end_date: string | null;
2946
+ /**
2947
+ * An additional filter to apply to usage queries.
2948
+ */
2949
+ filter: string | null;
2919
2950
  /**
2920
2951
  * The fixed fee quantity transitions for this price interval. This is only
2921
2952
  * relevant for fixed fees.
@@ -2939,6 +2970,11 @@ export declare namespace SubscriptionPriceIntervalsResponse {
2939
2970
  * for this price.
2940
2971
  */
2941
2972
  start_date: string;
2973
+ /**
2974
+ * A list of customer IDs whose usage events will be aggregated and billed under
2975
+ * this price interval.
2976
+ */
2977
+ usage_customer_ids: Array<string> | null;
2942
2978
  }
2943
2979
  namespace PriceInterval {
2944
2980
  interface FixedFeeQuantityTransition {
@@ -3395,6 +3431,10 @@ export declare namespace SubscriptionSchedulePlanChangeResponse {
3395
3431
  * this price.
3396
3432
  */
3397
3433
  end_date: string | null;
3434
+ /**
3435
+ * An additional filter to apply to usage queries.
3436
+ */
3437
+ filter: string | null;
3398
3438
  /**
3399
3439
  * The fixed fee quantity transitions for this price interval. This is only
3400
3440
  * relevant for fixed fees.
@@ -3418,6 +3458,11 @@ export declare namespace SubscriptionSchedulePlanChangeResponse {
3418
3458
  * for this price.
3419
3459
  */
3420
3460
  start_date: string;
3461
+ /**
3462
+ * A list of customer IDs whose usage events will be aggregated and billed under
3463
+ * this price interval.
3464
+ */
3465
+ usage_customer_ids: Array<string> | null;
3421
3466
  }
3422
3467
  namespace PriceInterval {
3423
3468
  interface FixedFeeQuantityTransition {
@@ -3874,6 +3919,10 @@ export declare namespace SubscriptionTriggerPhaseResponse {
3874
3919
  * this price.
3875
3920
  */
3876
3921
  end_date: string | null;
3922
+ /**
3923
+ * An additional filter to apply to usage queries.
3924
+ */
3925
+ filter: string | null;
3877
3926
  /**
3878
3927
  * The fixed fee quantity transitions for this price interval. This is only
3879
3928
  * relevant for fixed fees.
@@ -3897,6 +3946,11 @@ export declare namespace SubscriptionTriggerPhaseResponse {
3897
3946
  * for this price.
3898
3947
  */
3899
3948
  start_date: string;
3949
+ /**
3950
+ * A list of customer IDs whose usage events will be aggregated and billed under
3951
+ * this price interval.
3952
+ */
3953
+ usage_customer_ids: Array<string> | null;
3900
3954
  }
3901
3955
  namespace PriceInterval {
3902
3956
  interface FixedFeeQuantityTransition {
@@ -4353,6 +4407,10 @@ export declare namespace SubscriptionUnscheduleCancellationResponse {
4353
4407
  * this price.
4354
4408
  */
4355
4409
  end_date: string | null;
4410
+ /**
4411
+ * An additional filter to apply to usage queries.
4412
+ */
4413
+ filter: string | null;
4356
4414
  /**
4357
4415
  * The fixed fee quantity transitions for this price interval. This is only
4358
4416
  * relevant for fixed fees.
@@ -4376,6 +4434,11 @@ export declare namespace SubscriptionUnscheduleCancellationResponse {
4376
4434
  * for this price.
4377
4435
  */
4378
4436
  start_date: string;
4437
+ /**
4438
+ * A list of customer IDs whose usage events will be aggregated and billed under
4439
+ * this price interval.
4440
+ */
4441
+ usage_customer_ids: Array<string> | null;
4379
4442
  }
4380
4443
  namespace PriceInterval {
4381
4444
  interface FixedFeeQuantityTransition {
@@ -4832,6 +4895,10 @@ export declare namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
4832
4895
  * this price.
4833
4896
  */
4834
4897
  end_date: string | null;
4898
+ /**
4899
+ * An additional filter to apply to usage queries.
4900
+ */
4901
+ filter: string | null;
4835
4902
  /**
4836
4903
  * The fixed fee quantity transitions for this price interval. This is only
4837
4904
  * relevant for fixed fees.
@@ -4855,6 +4922,11 @@ export declare namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
4855
4922
  * for this price.
4856
4923
  */
4857
4924
  start_date: string;
4925
+ /**
4926
+ * A list of customer IDs whose usage events will be aggregated and billed under
4927
+ * this price interval.
4928
+ */
4929
+ usage_customer_ids: Array<string> | null;
4858
4930
  }
4859
4931
  namespace PriceInterval {
4860
4932
  interface FixedFeeQuantityTransition {
@@ -5311,6 +5383,10 @@ export declare namespace SubscriptionUnschedulePendingPlanChangesResponse {
5311
5383
  * this price.
5312
5384
  */
5313
5385
  end_date: string | null;
5386
+ /**
5387
+ * An additional filter to apply to usage queries.
5388
+ */
5389
+ filter: string | null;
5314
5390
  /**
5315
5391
  * The fixed fee quantity transitions for this price interval. This is only
5316
5392
  * relevant for fixed fees.
@@ -5334,6 +5410,11 @@ export declare namespace SubscriptionUnschedulePendingPlanChangesResponse {
5334
5410
  * for this price.
5335
5411
  */
5336
5412
  start_date: string;
5413
+ /**
5414
+ * A list of customer IDs whose usage events will be aggregated and billed under
5415
+ * this price interval.
5416
+ */
5417
+ usage_customer_ids: Array<string> | null;
5337
5418
  }
5338
5419
  namespace PriceInterval {
5339
5420
  interface FixedFeeQuantityTransition {
@@ -5790,6 +5871,10 @@ export declare namespace SubscriptionUpdateFixedFeeQuantityResponse {
5790
5871
  * this price.
5791
5872
  */
5792
5873
  end_date: string | null;
5874
+ /**
5875
+ * An additional filter to apply to usage queries.
5876
+ */
5877
+ filter: string | null;
5793
5878
  /**
5794
5879
  * The fixed fee quantity transitions for this price interval. This is only
5795
5880
  * relevant for fixed fees.
@@ -5813,6 +5898,11 @@ export declare namespace SubscriptionUpdateFixedFeeQuantityResponse {
5813
5898
  * for this price.
5814
5899
  */
5815
5900
  start_date: string;
5901
+ /**
5902
+ * A list of customer IDs whose usage events will be aggregated and billed under
5903
+ * this price interval.
5904
+ */
5905
+ usage_customer_ids: Array<string> | null;
5816
5906
  }
5817
5907
  namespace PriceInterval {
5818
5908
  interface FixedFeeQuantityTransition {
@@ -6269,6 +6359,10 @@ export declare namespace SubscriptionUpdateTrialResponse {
6269
6359
  * this price.
6270
6360
  */
6271
6361
  end_date: string | null;
6362
+ /**
6363
+ * An additional filter to apply to usage queries.
6364
+ */
6365
+ filter: string | null;
6272
6366
  /**
6273
6367
  * The fixed fee quantity transitions for this price interval. This is only
6274
6368
  * relevant for fixed fees.
@@ -6292,6 +6386,11 @@ export declare namespace SubscriptionUpdateTrialResponse {
6292
6386
  * for this price.
6293
6387
  */
6294
6388
  start_date: string;
6389
+ /**
6390
+ * A list of customer IDs whose usage events will be aggregated and billed under
6391
+ * this price interval.
6392
+ */
6393
+ usage_customer_ids: Array<string> | null;
6295
6394
  }
6296
6395
  namespace PriceInterval {
6297
6396
  interface FixedFeeQuantityTransition {
@@ -10840,6 +10939,13 @@ export declare namespace SubscriptionPriceIntervalsParams {
10840
10939
  * The external price id of the price to add to the subscription.
10841
10940
  */
10842
10941
  external_price_id?: string | null;
10942
+ /**
10943
+ * An additional filter to apply to usage queries. This filter must be expressed as
10944
+ * a boolean
10945
+ * [computed property](/extensibility/advanced-metrics#computed-properties). If
10946
+ * null, usage queries will not include any additional filter.
10947
+ */
10948
+ filter?: string | null;
10843
10949
  /**
10844
10950
  * A list of fixed fee quantity transitions to initialize on the price interval.
10845
10951
  */
@@ -10862,6 +10968,15 @@ export declare namespace SubscriptionPriceIntervalsParams {
10862
10968
  * The id of the price to add to the subscription.
10863
10969
  */
10864
10970
  price_id?: string | null;
10971
+ /**
10972
+ * A list of customer IDs whose usage events will be aggregated and billed under
10973
+ * this subscription. By default, a subscription only considers usage events
10974
+ * associated with its attached customer's customer_id. When usage_customer_ids is
10975
+ * provided, the subscription includes usage events from the specified customers
10976
+ * only. Provided usage_customer_ids must be either the customer for this
10977
+ * subscription itself, or any of that customer's children.
10978
+ */
10979
+ usage_customer_ids?: Array<string> | null;
10865
10980
  }
10866
10981
  namespace Add {
10867
10982
  /**
@@ -13805,6 +13920,13 @@ export declare namespace SubscriptionPriceIntervalsParams {
13805
13920
  * will not be updated.
13806
13921
  */
13807
13922
  end_date?: (string & {}) | Shared.BillingCycleRelativeDate | null;
13923
+ /**
13924
+ * An additional filter to apply to usage queries. This filter must be expressed as
13925
+ * a boolean
13926
+ * [computed property](/extensibility/advanced-metrics#computed-properties). If
13927
+ * null, usage queries will not include any additional filter.
13928
+ */
13929
+ filter?: string | null;
13808
13930
  /**
13809
13931
  * A list of fixed fee quantity transitions to use for this price interval. Note
13810
13932
  * that this list will overwrite all existing fixed fee quantity transitions on the
@@ -13816,6 +13938,15 @@ export declare namespace SubscriptionPriceIntervalsParams {
13816
13938
  * will not be updated.
13817
13939
  */
13818
13940
  start_date?: (string & {}) | Shared.BillingCycleRelativeDate;
13941
+ /**
13942
+ * A list of customer IDs whose usage events will be aggregated and billed under
13943
+ * this subscription. By default, a subscription only considers usage events
13944
+ * associated with its attached customer's customer_id. When usage_customer_ids is
13945
+ * provided, the subscription includes usage events from the specified customers
13946
+ * only. Provided usage_customer_ids must be either the customer for this
13947
+ * subscription itself, or any of that customer's children.
13948
+ */
13949
+ usage_customer_ids?: Array<string> | null;
13819
13950
  }
13820
13951
  namespace Edit {
13821
13952
  interface FixedFeeQuantityTransition {