orb-billing 4.49.0 → 4.51.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 +26 -0
- package/package.json +1 -1
- package/resources/alerts.d.ts +5 -8
- package/resources/alerts.d.ts.map +1 -1
- package/resources/alerts.js +2 -4
- package/resources/alerts.js.map +1 -1
- package/resources/alerts.mjs +2 -4
- package/resources/alerts.mjs.map +1 -1
- package/resources/coupons/coupons.d.ts +0 -34
- package/resources/coupons/coupons.d.ts.map +1 -1
- package/resources/coupons/coupons.js.map +1 -1
- package/resources/coupons/coupons.mjs.map +1 -1
- package/resources/coupons/subscriptions.d.ts +3 -3
- package/resources/credit-notes.d.ts +5 -5
- package/resources/credit-notes.js +3 -3
- package/resources/credit-notes.mjs +3 -3
- package/resources/customers/costs.d.ts +12 -454
- package/resources/customers/costs.d.ts.map +1 -1
- package/resources/customers/credits/ledger.d.ts +14 -14
- package/resources/customers/customers.d.ts +19 -19
- package/resources/customers/customers.d.ts.map +1 -1
- package/resources/customers/customers.js +14 -12
- package/resources/customers/customers.js.map +1 -1
- package/resources/customers/customers.mjs +14 -12
- package/resources/customers/customers.mjs.map +1 -1
- package/resources/events/backfills.d.ts +18 -18
- package/resources/events/backfills.js +3 -3
- package/resources/events/backfills.mjs +3 -3
- package/resources/events/events.d.ts +6 -7
- package/resources/events/events.d.ts.map +1 -1
- package/resources/events/events.js +3 -3
- package/resources/events/events.js.map +1 -1
- package/resources/events/events.mjs +3 -3
- package/resources/events/events.mjs.map +1 -1
- package/resources/events/volume.d.ts +5 -5
- package/resources/events/volume.js +5 -5
- package/resources/events/volume.mjs +5 -5
- package/resources/invoice-line-items.d.ts +2 -223
- package/resources/invoice-line-items.d.ts.map +1 -1
- package/resources/invoices.d.ts +14 -456
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js +3 -3
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs +3 -3
- package/resources/invoices.mjs.map +1 -1
- package/resources/items.d.ts +1 -1
- package/resources/items.js +1 -1
- package/resources/items.mjs +1 -1
- package/resources/metrics.d.ts +6 -7
- package/resources/metrics.d.ts.map +1 -1
- package/resources/metrics.js +3 -4
- package/resources/metrics.js.map +1 -1
- package/resources/metrics.mjs +3 -4
- package/resources/metrics.mjs.map +1 -1
- package/resources/plans/external-plan-id.d.ts +6 -6
- package/resources/plans/external-plan-id.js +6 -6
- package/resources/plans/external-plan-id.mjs +6 -6
- package/resources/plans/plans.d.ts +15 -15
- package/resources/plans/plans.js +6 -6
- package/resources/plans/plans.mjs +6 -6
- package/resources/prices/external-price-id.d.ts +2 -2
- package/resources/prices/external-price-id.js +2 -2
- package/resources/prices/external-price-id.mjs +2 -2
- package/resources/prices/prices.d.ts +14 -235
- package/resources/prices/prices.d.ts.map +1 -1
- package/resources/prices/prices.js +7 -7
- package/resources/prices/prices.js.map +1 -1
- package/resources/prices/prices.mjs +7 -7
- package/resources/prices/prices.mjs.map +1 -1
- package/resources/subscriptions.d.ts +172 -2831
- package/resources/subscriptions.d.ts.map +1 -1
- package/resources/subscriptions.js +53 -49
- package/resources/subscriptions.js.map +1 -1
- package/resources/subscriptions.mjs +53 -49
- package/resources/subscriptions.mjs.map +1 -1
- package/src/resources/alerts.ts +5 -8
- package/src/resources/coupons/coupons.ts +0 -34
- package/src/resources/coupons/subscriptions.ts +3 -3
- package/src/resources/credit-notes.ts +5 -5
- package/src/resources/customers/costs.ts +12 -454
- package/src/resources/customers/credits/ledger.ts +14 -14
- package/src/resources/customers/customers.ts +19 -19
- package/src/resources/events/backfills.ts +18 -18
- package/src/resources/events/events.ts +6 -7
- package/src/resources/events/volume.ts +5 -5
- package/src/resources/invoice-line-items.ts +2 -223
- package/src/resources/invoices.ts +14 -456
- package/src/resources/items.ts +1 -1
- package/src/resources/metrics.ts +6 -7
- package/src/resources/plans/external-plan-id.ts +6 -6
- package/src/resources/plans/plans.ts +15 -15
- package/src/resources/prices/external-price-id.ts +2 -2
- package/src/resources/prices/prices.ts +14 -235
- package/src/resources/subscriptions.ts +172 -2831
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,31 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 4.51.0 (2025-01-22)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v4.50.0...v4.51.0](https://github.com/orbcorp/orb-node/compare/v4.50.0...v4.51.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([#480](https://github.com/orbcorp/orb-node/issues/480)) ([fe6e3a7](https://github.com/orbcorp/orb-node/commit/fe6e3a706654bda3b1e8688c9d3a3cd6dc880a62))
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
### Chores
|
|
13
|
+
|
|
14
|
+
* **internal:** add test ([#475](https://github.com/orbcorp/orb-node/issues/475)) ([3654805](https://github.com/orbcorp/orb-node/commit/3654805e3427da36e0b1bf0c0cb08548a70ab8ee))
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
### Documentation
|
|
18
|
+
|
|
19
|
+
* update deprecation messages ([#478](https://github.com/orbcorp/orb-node/issues/478)) ([2e2382e](https://github.com/orbcorp/orb-node/commit/2e2382ee0ced57e41f44c83474dd0ac802e85d23))
|
|
20
|
+
|
|
21
|
+
## 4.50.0 (2025-01-18)
|
|
22
|
+
|
|
23
|
+
Full Changelog: [v4.49.0...v4.50.0](https://github.com/orbcorp/orb-node/compare/v4.49.0...v4.50.0)
|
|
24
|
+
|
|
25
|
+
### Features
|
|
26
|
+
|
|
27
|
+
* **api:** api update ([#471](https://github.com/orbcorp/orb-node/issues/471)) ([cf59d6c](https://github.com/orbcorp/orb-node/commit/cf59d6cee157745b4c0b5808f23ed2c7a8f056ee))
|
|
28
|
+
|
|
3
29
|
## 4.49.0 (2025-01-16)
|
|
4
30
|
|
|
5
31
|
Full Changelog: [v4.48.0...v4.49.0](https://github.com/orbcorp/orb-node/compare/v4.48.0...v4.49.0)
|
package/package.json
CHANGED
package/resources/alerts.d.ts
CHANGED
|
@@ -21,7 +21,7 @@ export declare class Alerts extends APIResource {
|
|
|
21
21
|
*
|
|
22
22
|
* The list of alerts is ordered starting from the most recently created alert.
|
|
23
23
|
* This endpoint follows Orb's
|
|
24
|
-
* [standardized pagination format](
|
|
24
|
+
* [standardized pagination format](/api-reference/pagination).
|
|
25
25
|
*/
|
|
26
26
|
list(query?: AlertListParams, options?: Core.RequestOptions): Core.PagePromise<AlertsPage, Alert>;
|
|
27
27
|
list(options?: Core.RequestOptions): Core.PagePromise<AlertsPage, Alert>;
|
|
@@ -30,8 +30,7 @@ export declare class Alerts extends APIResource {
|
|
|
30
30
|
* are three types of alerts that can be scoped to customers:
|
|
31
31
|
* `credit_balance_depleted`, `credit_balance_dropped`, and
|
|
32
32
|
* `credit_balance_recovered`. Customers can have a maximum of one of each type of
|
|
33
|
-
* alert per
|
|
34
|
-
* [credit balance currency](https://docs.withorb.com/guides/product-catalog/prepurchase).
|
|
33
|
+
* alert per [credit balance currency](/product-catalog/prepurchase).
|
|
35
34
|
* `credit_balance_dropped` alerts require a list of thresholds to be provided
|
|
36
35
|
* while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
|
|
37
36
|
* require thresholds.
|
|
@@ -42,8 +41,7 @@ export declare class Alerts extends APIResource {
|
|
|
42
41
|
* are three types of alerts that can be scoped to customers:
|
|
43
42
|
* `credit_balance_depleted`, `credit_balance_dropped`, and
|
|
44
43
|
* `credit_balance_recovered`. Customers can have a maximum of one of each type of
|
|
45
|
-
* alert per
|
|
46
|
-
* [credit balance currency](https://docs.withorb.com/guides/product-catalog/prepurchase).
|
|
44
|
+
* alert per [credit balance currency](/product-catalog/prepurchase).
|
|
47
45
|
* `credit_balance_dropped` alerts require a list of thresholds to be provided
|
|
48
46
|
* while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
|
|
49
47
|
* require thresholds.
|
|
@@ -81,9 +79,8 @@ export declare class Alerts extends APIResource {
|
|
|
81
79
|
export declare class AlertsPage extends Page<Alert> {
|
|
82
80
|
}
|
|
83
81
|
/**
|
|
84
|
-
* [Alerts within Orb](
|
|
85
|
-
*
|
|
86
|
-
* is exceeded.
|
|
82
|
+
* [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
|
|
83
|
+
* usage, or credit balance and trigger webhooks when a threshold is exceeded.
|
|
87
84
|
*
|
|
88
85
|
* Alerts created through the API can be scoped to either customers or
|
|
89
86
|
* subscriptions.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alerts.d.ts","sourceRoot":"","sources":["../src/resources/alerts.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEtD,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IAIhF;;OAEG;IACH,MAAM,CACJ,oBAAoB,EAAE,MAAM,EAC5B,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IAIzB;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC;IACjG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC;IAWxE
|
|
1
|
+
{"version":3,"file":"alerts.d.ts","sourceRoot":"","sources":["../src/resources/alerts.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEtD,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IAIhF;;OAEG;IACH,MAAM,CACJ,oBAAoB,EAAE,MAAM,EAC5B,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IAIzB;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC;IACjG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC;IAWxE;;;;;;;;;OASG;IACH,iBAAiB,CACf,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IAIzB;;;;;;;;;OASG;IACH,yBAAyB,CACvB,kBAAkB,EAAE,MAAM,EAC1B,IAAI,EAAE,oCAAoC,EAC1C,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IAIzB;;;;;;;;;;;;OAYG;IACH,qBAAqB,CACnB,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IAIzB;;;;OAIG;IACH,OAAO,CACL,oBAAoB,EAAE,MAAM,EAC5B,MAAM,CAAC,EAAE,kBAAkB,EAC3B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IACzB,OAAO,CAAC,oBAAoB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IAgB5F;;;;OAIG;IACH,MAAM,CACJ,oBAAoB,EAAE,MAAM,EAC5B,MAAM,CAAC,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IACzB,MAAM,CAAC,oBAAoB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;CAe5F;AAED,qBAAa,UAAW,SAAQ,IAAI,CAAC,KAAK,CAAC;CAAG;AAE9C;;;;;;GAMG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAExC;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,IAAI,EACA,gBAAgB,GAChB,eAAe,GACf,yBAAyB,GACzB,wBAAwB,GACxB,0BAA0B,CAAC;CAChC;AAED,yBAAiB,KAAK,CAAC;IACrB;;OAEG;IACH,UAAiB,QAAQ;QACvB,EAAE,EAAE,MAAM,CAAC;QAEX,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;KACrC;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAElB;;;;WAIG;QACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,YAAY,EAAE,MAAM,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,YAAY;QAC3B,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;;OAGG;IACH,UAAiB,SAAS;QACxB;;;;WAIG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;CAChD;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;;OAGG;IACH,UAAiB,SAAS;QACxB;;;;WAIG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EACA,gBAAgB,GAChB,eAAe,GACf,yBAAyB,GACzB,wBAAwB,GACxB,0BAA0B,CAAC;IAE/B;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,4BAA4B,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;CACnE;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;;OAGG;IACH,UAAiB,SAAS;QACxB;;;;WAIG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EACA,gBAAgB,GAChB,eAAe,GACf,yBAAyB,GACzB,wBAAwB,GACxB,0BAA0B,CAAC;IAE/B;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,oCAAoC,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;CAC3E;AAED,yBAAiB,oCAAoC,CAAC;IACpD;;;OAGG;IACH,UAAiB,SAAS;QACxB;;;;WAIG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,gCAAgC,CAAC,SAAS,CAAC,CAAC;IAE9D;;OAEG;IACH,IAAI,EACA,gBAAgB,GAChB,eAAe,GACf,yBAAyB,GACzB,wBAAwB,GACxB,0BAA0B,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,gCAAgC,CAAC;IAChD;;;OAGG;IACH,UAAiB,SAAS;QACxB;;;;WAIG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAID,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,UAAU,IAAI,UAAU,EACxB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
package/resources/alerts.js
CHANGED
|
@@ -29,8 +29,7 @@ class Alerts extends resource_1.APIResource {
|
|
|
29
29
|
* are three types of alerts that can be scoped to customers:
|
|
30
30
|
* `credit_balance_depleted`, `credit_balance_dropped`, and
|
|
31
31
|
* `credit_balance_recovered`. Customers can have a maximum of one of each type of
|
|
32
|
-
* alert per
|
|
33
|
-
* [credit balance currency](https://docs.withorb.com/guides/product-catalog/prepurchase).
|
|
32
|
+
* alert per [credit balance currency](/product-catalog/prepurchase).
|
|
34
33
|
* `credit_balance_dropped` alerts require a list of thresholds to be provided
|
|
35
34
|
* while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
|
|
36
35
|
* require thresholds.
|
|
@@ -43,8 +42,7 @@ class Alerts extends resource_1.APIResource {
|
|
|
43
42
|
* are three types of alerts that can be scoped to customers:
|
|
44
43
|
* `credit_balance_depleted`, `credit_balance_dropped`, and
|
|
45
44
|
* `credit_balance_recovered`. Customers can have a maximum of one of each type of
|
|
46
|
-
* alert per
|
|
47
|
-
* [credit balance currency](https://docs.withorb.com/guides/product-catalog/prepurchase).
|
|
45
|
+
* alert per [credit balance currency](/product-catalog/prepurchase).
|
|
48
46
|
* `credit_balance_dropped` alerts require a list of thresholds to be provided
|
|
49
47
|
* while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
|
|
50
48
|
* require thresholds.
|
package/resources/alerts.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alerts.js","sourceRoot":"","sources":["../src/resources/alerts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAE3C,iDAAsD;AAEtD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAe,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,oBAA4B,EAC5B,IAAuB,EACvB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,oBAAoB,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAiBD,IAAI,CACF,QAA+C,EAAE,EACjD,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,SAAS,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"alerts.js","sourceRoot":"","sources":["../src/resources/alerts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAE3C,iDAAsD;AAEtD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAe,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,oBAA4B,EAC5B,IAAuB,EACvB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,oBAAoB,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAiBD,IAAI,CACF,QAA+C,EAAE,EACjD,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,SAAS,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB,CACf,UAAkB,EAClB,IAAkC,EAClC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;OASG;IACH,yBAAyB,CACvB,kBAA0B,EAC1B,IAA0C,EAC1C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,kBAAkB,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,qBAAqB,CACnB,cAAsB,EACtB,IAAsC,EACtC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAaD,OAAO,CACL,oBAA4B,EAC5B,SAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;SACvD;QACD,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,oBAAoB,UAAU,EAAE;YAClE,KAAK,EAAE,EAAE,eAAe,EAAE;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAaD,MAAM,CACJ,oBAA4B,EAC5B,SAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;SACtD;QACD,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,oBAAoB,SAAS,EAAE;YACjE,KAAK,EAAE,EAAE,eAAe,EAAE;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAxJD,wBAwJC;AAED,MAAa,UAAW,SAAQ,iBAAW;CAAG;AAA9C,gCAA8C;AAuS9C,MAAM,CAAC,UAAU,GAAG,UAAU,CAAC"}
|
package/resources/alerts.mjs
CHANGED
|
@@ -26,8 +26,7 @@ export class Alerts extends APIResource {
|
|
|
26
26
|
* are three types of alerts that can be scoped to customers:
|
|
27
27
|
* `credit_balance_depleted`, `credit_balance_dropped`, and
|
|
28
28
|
* `credit_balance_recovered`. Customers can have a maximum of one of each type of
|
|
29
|
-
* alert per
|
|
30
|
-
* [credit balance currency](https://docs.withorb.com/guides/product-catalog/prepurchase).
|
|
29
|
+
* alert per [credit balance currency](/product-catalog/prepurchase).
|
|
31
30
|
* `credit_balance_dropped` alerts require a list of thresholds to be provided
|
|
32
31
|
* while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
|
|
33
32
|
* require thresholds.
|
|
@@ -40,8 +39,7 @@ export class Alerts extends APIResource {
|
|
|
40
39
|
* are three types of alerts that can be scoped to customers:
|
|
41
40
|
* `credit_balance_depleted`, `credit_balance_dropped`, and
|
|
42
41
|
* `credit_balance_recovered`. Customers can have a maximum of one of each type of
|
|
43
|
-
* alert per
|
|
44
|
-
* [credit balance currency](https://docs.withorb.com/guides/product-catalog/prepurchase).
|
|
42
|
+
* alert per [credit balance currency](/product-catalog/prepurchase).
|
|
45
43
|
* `credit_balance_dropped` alerts require a list of thresholds to be provided
|
|
46
44
|
* while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
|
|
47
45
|
* require thresholds.
|
package/resources/alerts.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alerts.mjs","sourceRoot":"","sources":["../src/resources/alerts.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;;OAEG;IACH,QAAQ,CAAC,OAAe,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,oBAA4B,EAC5B,IAAuB,EACvB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,oBAAoB,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAiBD,IAAI,CACF,QAA+C,EAAE,EACjD,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,SAAS,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"alerts.mjs","sourceRoot":"","sources":["../src/resources/alerts.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;;OAEG;IACH,QAAQ,CAAC,OAAe,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,oBAA4B,EAC5B,IAAuB,EACvB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,oBAAoB,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAiBD,IAAI,CACF,QAA+C,EAAE,EACjD,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,SAAS,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB,CACf,UAAkB,EAClB,IAAkC,EAClC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;OASG;IACH,yBAAyB,CACvB,kBAA0B,EAC1B,IAA0C,EAC1C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,kBAAkB,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,qBAAqB,CACnB,cAAsB,EACtB,IAAsC,EACtC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAaD,OAAO,CACL,oBAA4B,EAC5B,SAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;SACvD;QACD,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,oBAAoB,UAAU,EAAE;YAClE,KAAK,EAAE,EAAE,eAAe,EAAE;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAaD,MAAM,CACJ,oBAA4B,EAC5B,SAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;SACtD;QACD,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,oBAAoB,SAAS,EAAE;YACjE,KAAK,EAAE,EAAE,eAAe,EAAE;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,UAAW,SAAQ,IAAW;CAAG;AAuS9C,MAAM,CAAC,UAAU,GAAG,UAAU,CAAC"}
|
|
@@ -42,40 +42,6 @@ export declare class CouponsPage extends Page<Coupon> {
|
|
|
42
42
|
* activated using a redemption code, which applies the discount to a subscription
|
|
43
43
|
* or invoice. The duration of a coupon determines how long it remains available
|
|
44
44
|
* for use by end users.
|
|
45
|
-
*
|
|
46
|
-
* ## How to use coupons
|
|
47
|
-
*
|
|
48
|
-
* Coupons can be created using the Orb dashboard or programmatically through the
|
|
49
|
-
* API. Once a coupon is created, it can be managed and applied programmatically
|
|
50
|
-
* via the API. To redeem a coupon, use the `redemption_code` property when
|
|
51
|
-
* [creating a subscription](create-subscription.api.mdx) or when scheduling a
|
|
52
|
-
* [plan change](schedule-plan-change.api.mdx).
|
|
53
|
-
*
|
|
54
|
-
* ## When to use coupons
|
|
55
|
-
*
|
|
56
|
-
* A common use case for coupons is through self-serve signup or upgrade flows in
|
|
57
|
-
* your checkout experience or billing portal. Coupons can also be used as one-off
|
|
58
|
-
* to incentivize use for custom agreements.
|
|
59
|
-
*
|
|
60
|
-
* Coupons are effective when launching new features and encouraging existing users
|
|
61
|
-
* to upgrade to a higher tier. For example, you could create a coupon code
|
|
62
|
-
* "UPGRADE20" that offers a 20% discount on the first month of the new plan. This
|
|
63
|
-
* code can be applied during the upgrade process in your billing portal, making it
|
|
64
|
-
* straightforward for users to benefit from the new features at a reduced cost.
|
|
65
|
-
*
|
|
66
|
-
* ## Coupon scoping
|
|
67
|
-
*
|
|
68
|
-
* When a coupon is applied on a subscription, it creates a discount adjustment
|
|
69
|
-
* that applies to all of the prices on the subscription at the time of the coupon
|
|
70
|
-
* application. Notably, coupons do not scope in new price additions to a
|
|
71
|
-
* subscription automatically — if a new price is added to the subscription with a
|
|
72
|
-
* subscription edit or plan version migration, the discount created with the
|
|
73
|
-
* coupon will not apply to it automatically. If you'd like the coupon to apply to
|
|
74
|
-
* newly added prices, you can
|
|
75
|
-
* [edit the adjustment intervals](add-edit-price-intervals.api.mdx) to end the
|
|
76
|
-
* discount interval created by the coupon at the time of the migration and add a
|
|
77
|
-
* new one starting at the time of the migration that includes the newly added
|
|
78
|
-
* prices you'd like the coupon to apply to.
|
|
79
45
|
*/
|
|
80
46
|
export interface Coupon {
|
|
81
47
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"coupons.d.ts","sourceRoot":"","sources":["../../src/resources/coupons/coupons.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,gBAAgB,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,sBAAsB,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEzD,qBAAa,OAAQ,SAAQ,WAAW;IACtC,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;IAEjG;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAIxF;;;;;;;OAOG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC;IACpG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC;IAW1E;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAIjF;;;;OAIG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;CAGhF;AAED,qBAAa,WAAY,SAAQ,IAAI,CAAC,MAAM,CAAC;CAAG;AAEhD
|
|
1
|
+
{"version":3,"file":"coupons.d.ts","sourceRoot":"","sources":["../../src/resources/coupons/coupons.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,gBAAgB,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,sBAAsB,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEzD,qBAAa,OAAQ,SAAQ,WAAW;IACtC,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;IAEjG;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAIxF;;;;;;;OAOG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC;IACpG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC;IAW1E;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAIjF;;;;OAIG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;CAGhF;AAED,qBAAa,WAAY,SAAQ,IAAI,CAAC,MAAM,CAAC;CAAG;AAEhD;;;;;;GAMG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,QAAQ,EAAE,MAAM,CAAC,kBAAkB,GAAG,MAAM,CAAC,cAAc,CAAC;IAE5D;;;OAGG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,kBAAkB,CAAC,2BAA2B,GAAG,kBAAkB,CAAC,uBAAuB,CAAC;IAEtG;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,2BAA2B;QAC1C,aAAa,EAAE,YAAY,CAAC;QAE5B,mBAAmB,EAAE,MAAM,CAAC;KAC7B;IAED,UAAiB,uBAAuB;QACtC,eAAe,EAAE,MAAM,CAAC;QAExB,aAAa,EAAE,QAAQ,CAAC;KACzB;CACF;AAED,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAKD,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,WAAW,IAAI,WAAW,EAC1B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EAAE,aAAa,IAAI,aAAa,EAAE,KAAK,sBAAsB,IAAI,sBAAsB,EAAE,CAAC;CAClG"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"coupons.js","sourceRoot":"","sources":["../../src/resources/coupons/coupons.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAG9C,qEAAoD;AACpD,sDAAwE;AACxE,oDAAyD;AAEzD,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA+CnG,CAAC;IA7CC;;;OAGG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAYD,IAAI,CACF,QAAgD,EAAE,EAClD,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,UAAU,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,QAAgB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,QAAQ,UAAU,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAgB,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAhDD,0BAgDC;AAED,MAAa,WAAY,SAAQ,iBAAY;CAAG;AAAhD,kCAAgD;
|
|
1
|
+
{"version":3,"file":"coupons.js","sourceRoot":"","sources":["../../src/resources/coupons/coupons.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAG9C,qEAAoD;AACpD,sDAAwE;AACxE,oDAAyD;AAEzD,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA+CnG,CAAC;IA7CC;;;OAGG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAYD,IAAI,CACF,QAAgD,EAAE,EAClD,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,UAAU,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,QAAgB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,QAAQ,UAAU,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAgB,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAhDD,0BAgDC;AAED,MAAa,WAAY,SAAQ,iBAAY;CAAG;AAAhD,kCAAgD;AA8FhD,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;AAClC,OAAO,CAAC,aAAa,GAAG,6BAAa,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"coupons.mjs","sourceRoot":"","sources":["../../src/resources/coupons/coupons.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,KAAK,gBAAgB;OACrB,EAA0B,aAAa,EAAE;OACzC,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA+CnG,CAAC;IA7CC;;;OAGG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAYD,IAAI,CACF,QAAgD,EAAE,EAClD,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,UAAU,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,QAAgB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,QAAQ,UAAU,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAgB,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAED,MAAM,OAAO,WAAY,SAAQ,IAAY;CAAG;
|
|
1
|
+
{"version":3,"file":"coupons.mjs","sourceRoot":"","sources":["../../src/resources/coupons/coupons.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,KAAK,gBAAgB;OACrB,EAA0B,aAAa,EAAE;OACzC,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA+CnG,CAAC;IA7CC;;;OAGG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAYD,IAAI,CACF,QAAgD,EAAE,EAClD,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,UAAU,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,QAAgB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,QAAQ,UAAU,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAgB,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAED,MAAM,OAAO,WAAY,SAAQ,IAAY;CAAG;AA8FhD,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;AAClC,OAAO,CAAC,aAAa,GAAG,aAAa,CAAC"}
|
|
@@ -6,9 +6,9 @@ import { type PageParams } from "../../pagination.js";
|
|
|
6
6
|
export declare class Subscriptions extends APIResource {
|
|
7
7
|
/**
|
|
8
8
|
* This endpoint returns a list of all subscriptions that have redeemed a given
|
|
9
|
-
* coupon as a [paginated](
|
|
10
|
-
* most recently created subscription. For a full discussion of the
|
|
11
|
-
* resource, see [Subscription](
|
|
9
|
+
* coupon as a [paginated](/api-reference/pagination) list, ordered starting from
|
|
10
|
+
* the most recently created subscription. For a full discussion of the
|
|
11
|
+
* subscription resource, see [Subscription](/core-concepts#subscription).
|
|
12
12
|
*/
|
|
13
13
|
list(couponId: string, query?: SubscriptionListParams, options?: Core.RequestOptions): Core.PagePromise<SubscriptionsPage, SubscriptionsAPI.Subscription>;
|
|
14
14
|
list(couponId: string, options?: Core.RequestOptions): Core.PagePromise<SubscriptionsPage, SubscriptionsAPI.Subscription>;
|
|
@@ -4,7 +4,7 @@ import { Page, type PageParams } from "../pagination.js";
|
|
|
4
4
|
export declare class CreditNotes extends APIResource {
|
|
5
5
|
/**
|
|
6
6
|
* This endpoint is used to create a single
|
|
7
|
-
* [`Credit Note`](
|
|
7
|
+
* [`Credit Note`](/invoicing/credit-notes).
|
|
8
8
|
*/
|
|
9
9
|
create(body: CreditNoteCreateParams, options?: Core.RequestOptions): Core.APIPromise<CreditNote>;
|
|
10
10
|
/**
|
|
@@ -15,16 +15,16 @@ export declare class CreditNotes extends APIResource {
|
|
|
15
15
|
list(query?: CreditNoteListParams, options?: Core.RequestOptions): Core.PagePromise<CreditNotesPage, CreditNote>;
|
|
16
16
|
list(options?: Core.RequestOptions): Core.PagePromise<CreditNotesPage, CreditNote>;
|
|
17
17
|
/**
|
|
18
|
-
* This endpoint is used to fetch a single
|
|
19
|
-
*
|
|
18
|
+
* This endpoint is used to fetch a single [`Credit Note`](/invoicing/credit-notes)
|
|
19
|
+
* given an identifier.
|
|
20
20
|
*/
|
|
21
21
|
fetch(creditNoteId: string, options?: Core.RequestOptions): Core.APIPromise<CreditNote>;
|
|
22
22
|
}
|
|
23
23
|
export declare class CreditNotesPage extends Page<CreditNote> {
|
|
24
24
|
}
|
|
25
25
|
/**
|
|
26
|
-
* The [Credit Note](/
|
|
27
|
-
*
|
|
26
|
+
* The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
|
|
27
|
+
* been applied to a particular invoice.
|
|
28
28
|
*/
|
|
29
29
|
export interface CreditNote {
|
|
30
30
|
/**
|
|
@@ -8,7 +8,7 @@ const pagination_1 = require("../pagination.js");
|
|
|
8
8
|
class CreditNotes extends resource_1.APIResource {
|
|
9
9
|
/**
|
|
10
10
|
* This endpoint is used to create a single
|
|
11
|
-
* [`Credit Note`](
|
|
11
|
+
* [`Credit Note`](/invoicing/credit-notes).
|
|
12
12
|
*/
|
|
13
13
|
create(body, options) {
|
|
14
14
|
return this._client.post('/credit_notes', { body, ...options });
|
|
@@ -20,8 +20,8 @@ class CreditNotes extends resource_1.APIResource {
|
|
|
20
20
|
return this._client.getAPIList('/credit_notes', CreditNotesPage, { query, ...options });
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
|
-
* This endpoint is used to fetch a single
|
|
24
|
-
*
|
|
23
|
+
* This endpoint is used to fetch a single [`Credit Note`](/invoicing/credit-notes)
|
|
24
|
+
* given an identifier.
|
|
25
25
|
*/
|
|
26
26
|
fetch(creditNoteId, options) {
|
|
27
27
|
return this._client.get(`/credit_notes/${creditNoteId}`, options);
|
|
@@ -5,7 +5,7 @@ import { Page } from "../pagination.mjs";
|
|
|
5
5
|
export class CreditNotes extends APIResource {
|
|
6
6
|
/**
|
|
7
7
|
* This endpoint is used to create a single
|
|
8
|
-
* [`Credit Note`](
|
|
8
|
+
* [`Credit Note`](/invoicing/credit-notes).
|
|
9
9
|
*/
|
|
10
10
|
create(body, options) {
|
|
11
11
|
return this._client.post('/credit_notes', { body, ...options });
|
|
@@ -17,8 +17,8 @@ export class CreditNotes extends APIResource {
|
|
|
17
17
|
return this._client.getAPIList('/credit_notes', CreditNotesPage, { query, ...options });
|
|
18
18
|
}
|
|
19
19
|
/**
|
|
20
|
-
* This endpoint is used to fetch a single
|
|
21
|
-
*
|
|
20
|
+
* This endpoint is used to fetch a single [`Credit Note`](/invoicing/credit-notes)
|
|
21
|
+
* given an identifier.
|
|
22
22
|
*/
|
|
23
23
|
fetch(creditNoteId, options) {
|
|
24
24
|
return this._client.get(`/credit_notes/${creditNoteId}`, options);
|