orb-billing 4.48.0 → 4.50.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 +16 -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 +16 -18
- package/resources/customers/customers.d.ts.map +1 -1
- package/resources/customers/customers.js +11 -11
- package/resources/customers/customers.js.map +1 -1
- package/resources/customers/customers.mjs +11 -11
- package/resources/customers/customers.mjs.map +1 -1
- package/resources/events/backfills.d.ts +19 -19
- package/resources/events/backfills.js +4 -4
- package/resources/events/backfills.mjs +4 -4
- 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 +12 -454
- 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 +14 -14
- 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 +153 -2813
- 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 +16 -18
- package/src/resources/events/backfills.ts +19 -19
- 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 +12 -454
- 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 +14 -14
- package/src/resources/prices/external-price-id.ts +2 -2
- package/src/resources/prices/prices.ts +14 -235
- package/src/resources/subscriptions.ts +153 -2813
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/items.d.ts
CHANGED
|
@@ -3,7 +3,7 @@ import * as Core from "../core.js";
|
|
|
3
3
|
import { Page, type PageParams } from "../pagination.js";
|
|
4
4
|
export declare class Items extends APIResource {
|
|
5
5
|
/**
|
|
6
|
-
* This endpoint is used to create an [Item](
|
|
6
|
+
* This endpoint is used to create an [Item](/core-concepts#item).
|
|
7
7
|
*/
|
|
8
8
|
create(body: ItemCreateParams, options?: Core.RequestOptions): Core.APIPromise<Item>;
|
|
9
9
|
/**
|
package/resources/items.js
CHANGED
|
@@ -7,7 +7,7 @@ const core_1 = require("../core.js");
|
|
|
7
7
|
const pagination_1 = require("../pagination.js");
|
|
8
8
|
class Items extends resource_1.APIResource {
|
|
9
9
|
/**
|
|
10
|
-
* This endpoint is used to create an [Item](
|
|
10
|
+
* This endpoint is used to create an [Item](/core-concepts#item).
|
|
11
11
|
*/
|
|
12
12
|
create(body, options) {
|
|
13
13
|
return this._client.post('/items', { body, ...options });
|
package/resources/items.mjs
CHANGED
|
@@ -4,7 +4,7 @@ import { isRequestOptions } from "../core.mjs";
|
|
|
4
4
|
import { Page } from "../pagination.mjs";
|
|
5
5
|
export class Items extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
* This endpoint is used to create an [Item](
|
|
7
|
+
* This endpoint is used to create an [Item](/core-concepts#item).
|
|
8
8
|
*/
|
|
9
9
|
create(body, options) {
|
|
10
10
|
return this._client.post('/items', { body, ...options });
|
package/resources/metrics.d.ts
CHANGED
|
@@ -4,9 +4,8 @@ import * as ItemsAPI from "./items.js";
|
|
|
4
4
|
import { Page, type PageParams } from "../pagination.js";
|
|
5
5
|
export declare class Metrics extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
* This endpoint is used to create a [metric](
|
|
8
|
-
*
|
|
9
|
-
* [SQL support](../guides/extensibility/advanced-metrics#sql-support) for a
|
|
7
|
+
* This endpoint is used to create a [metric](/core-concepts###metric) using a SQL
|
|
8
|
+
* string. See [SQL support](/extensibility/advanced-metrics#sql-support) for a
|
|
10
9
|
* description of constructing SQL queries with examples.
|
|
11
10
|
*/
|
|
12
11
|
create(body: MetricCreateParams, options?: Core.RequestOptions): Core.APIPromise<BillableMetric>;
|
|
@@ -17,14 +16,14 @@ export declare class Metrics extends APIResource {
|
|
|
17
16
|
*/
|
|
18
17
|
update(metricId: string, body: MetricUpdateParams, options?: Core.RequestOptions): Core.APIPromise<BillableMetric>;
|
|
19
18
|
/**
|
|
20
|
-
* This endpoint is used to fetch [metric](
|
|
21
|
-
*
|
|
22
|
-
*
|
|
19
|
+
* This endpoint is used to fetch [metric](/core-concepts##metric) details given a
|
|
20
|
+
* metric identifier. It returns information about the metrics including its name,
|
|
21
|
+
* description, and item.
|
|
23
22
|
*/
|
|
24
23
|
list(query?: MetricListParams, options?: Core.RequestOptions): Core.PagePromise<BillableMetricsPage, BillableMetric>;
|
|
25
24
|
list(options?: Core.RequestOptions): Core.PagePromise<BillableMetricsPage, BillableMetric>;
|
|
26
25
|
/**
|
|
27
|
-
* This endpoint is used to list [metrics](
|
|
26
|
+
* This endpoint is used to list [metrics](/core-concepts#metric). It returns
|
|
28
27
|
* information about the metrics including its name, description, and item.
|
|
29
28
|
*/
|
|
30
29
|
fetch(metricId: string, options?: Core.RequestOptions): Core.APIPromise<BillableMetric>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"metrics.d.ts","sourceRoot":"","sources":["../src/resources/metrics.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEtD,qBAAa,OAAQ,SAAQ,WAAW;IACtC
|
|
1
|
+
{"version":3,"file":"metrics.d.ts","sourceRoot":"","sources":["../src/resources/metrics.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEtD,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;IAIhG;;;;OAIG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;IAIlC;;;;OAIG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,gBAAgB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,mBAAmB,EAAE,cAAc,CAAC;IACxD,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,mBAAmB,EAAE,cAAc,CAAC;IAW1F;;;OAGG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;CAGxF;AAED,qBAAa,mBAAoB,SAAQ,IAAI,CAAC,cAAc,CAAC;CAAG;AAEhE;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC;IAEpB;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC;CACzC;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;CACjD;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;CACjD;AAED,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,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;CACnC;AAID,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,mBAAmB,IAAI,mBAAmB,EAC1C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
|
package/resources/metrics.js
CHANGED
|
@@ -7,9 +7,8 @@ const core_1 = require("../core.js");
|
|
|
7
7
|
const pagination_1 = require("../pagination.js");
|
|
8
8
|
class Metrics extends resource_1.APIResource {
|
|
9
9
|
/**
|
|
10
|
-
* This endpoint is used to create a [metric](
|
|
11
|
-
*
|
|
12
|
-
* [SQL support](../guides/extensibility/advanced-metrics#sql-support) for a
|
|
10
|
+
* This endpoint is used to create a [metric](/core-concepts###metric) using a SQL
|
|
11
|
+
* string. See [SQL support](/extensibility/advanced-metrics#sql-support) for a
|
|
13
12
|
* description of constructing SQL queries with examples.
|
|
14
13
|
*/
|
|
15
14
|
create(body, options) {
|
|
@@ -30,7 +29,7 @@ class Metrics extends resource_1.APIResource {
|
|
|
30
29
|
return this._client.getAPIList('/metrics', BillableMetricsPage, { query, ...options });
|
|
31
30
|
}
|
|
32
31
|
/**
|
|
33
|
-
* This endpoint is used to list [metrics](
|
|
32
|
+
* This endpoint is used to list [metrics](/core-concepts#metric). It returns
|
|
34
33
|
* information about the metrics including its name, description, and item.
|
|
35
34
|
*/
|
|
36
35
|
fetch(metricId, options) {
|
package/resources/metrics.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../src/resources/metrics.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAG3C,iDAAsD;AAEtD,MAAa,OAAQ,SAAQ,sBAAW;IACtC
|
|
1
|
+
{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../src/resources/metrics.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAG3C,iDAAsD;AAEtD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;OAIG;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;IAED;;;;OAIG;IACH,MAAM,CACJ,QAAgB,EAChB,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,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,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAgB,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAlDD,0BAkDC;AAED,MAAa,mBAAoB,SAAQ,iBAAoB;CAAG;AAAhE,kDAAgE;AAgFhE,OAAO,CAAC,mBAAmB,GAAG,mBAAmB,CAAC"}
|
package/resources/metrics.mjs
CHANGED
|
@@ -4,9 +4,8 @@ import { isRequestOptions } from "../core.mjs";
|
|
|
4
4
|
import { Page } from "../pagination.mjs";
|
|
5
5
|
export class Metrics extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
* This endpoint is used to create a [metric](
|
|
8
|
-
*
|
|
9
|
-
* [SQL support](../guides/extensibility/advanced-metrics#sql-support) for a
|
|
7
|
+
* This endpoint is used to create a [metric](/core-concepts###metric) using a SQL
|
|
8
|
+
* string. See [SQL support](/extensibility/advanced-metrics#sql-support) for a
|
|
10
9
|
* description of constructing SQL queries with examples.
|
|
11
10
|
*/
|
|
12
11
|
create(body, options) {
|
|
@@ -27,7 +26,7 @@ export class Metrics extends APIResource {
|
|
|
27
26
|
return this._client.getAPIList('/metrics', BillableMetricsPage, { query, ...options });
|
|
28
27
|
}
|
|
29
28
|
/**
|
|
30
|
-
* This endpoint is used to list [metrics](
|
|
29
|
+
* This endpoint is used to list [metrics](/core-concepts#metric). It returns
|
|
31
30
|
* information about the metrics including its name, description, and item.
|
|
32
31
|
*/
|
|
33
32
|
fetch(metricId, options) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"metrics.mjs","sourceRoot":"","sources":["../src/resources/metrics.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC
|
|
1
|
+
{"version":3,"file":"metrics.mjs","sourceRoot":"","sources":["../src/resources/metrics.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;OAIG;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;IAED;;;;OAIG;IACH,MAAM,CACJ,QAAgB,EAChB,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,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,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;OAGG;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,mBAAoB,SAAQ,IAAoB;CAAG;AAgFhE,OAAO,CAAC,mBAAmB,GAAG,mBAAmB,CAAC"}
|
|
@@ -10,10 +10,10 @@ export declare class ExternalPlanID extends APIResource {
|
|
|
10
10
|
*/
|
|
11
11
|
update(otherExternalPlanId: string, body: ExternalPlanIDUpdateParams, options?: Core.RequestOptions): Core.APIPromise<PlansAPI.Plan>;
|
|
12
12
|
/**
|
|
13
|
-
* This endpoint is used to fetch [plan](
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
13
|
+
* This endpoint is used to fetch [plan](/core-concepts##plan-and-price) details
|
|
14
|
+
* given an external_plan_id identifier. It returns information about the prices
|
|
15
|
+
* included in the plan and their configuration, as well as the product that the
|
|
16
|
+
* plan is attached to.
|
|
17
17
|
*
|
|
18
18
|
* If multiple plans are found to contain the specified external_plan_id, the
|
|
19
19
|
* active plans will take priority over archived ones, and among those, the
|
|
@@ -22,10 +22,10 @@ export declare class ExternalPlanID extends APIResource {
|
|
|
22
22
|
* ## Serialized prices
|
|
23
23
|
*
|
|
24
24
|
* Orb supports a few different pricing models out of the box. Each of these models
|
|
25
|
-
* is serialized differently in a given [Price](
|
|
25
|
+
* is serialized differently in a given [Price](/core-concepts#plan-and-price)
|
|
26
26
|
* object. The `model_type` field determines the key for the configuration object
|
|
27
27
|
* that is present. A detailed explanation of price types can be found in the
|
|
28
|
-
* [Price schema](
|
|
28
|
+
* [Price schema](/core-concepts#plan-and-price). "
|
|
29
29
|
*/
|
|
30
30
|
fetch(externalPlanId: string, options?: Core.RequestOptions): Core.APIPromise<PlansAPI.Plan>;
|
|
31
31
|
}
|
|
@@ -14,10 +14,10 @@ class ExternalPlanID extends resource_1.APIResource {
|
|
|
14
14
|
return this._client.put(`/plans/external_plan_id/${otherExternalPlanId}`, { body, ...options });
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* This endpoint is used to fetch [plan](
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
17
|
+
* This endpoint is used to fetch [plan](/core-concepts##plan-and-price) details
|
|
18
|
+
* given an external_plan_id identifier. It returns information about the prices
|
|
19
|
+
* included in the plan and their configuration, as well as the product that the
|
|
20
|
+
* plan is attached to.
|
|
21
21
|
*
|
|
22
22
|
* If multiple plans are found to contain the specified external_plan_id, the
|
|
23
23
|
* active plans will take priority over archived ones, and among those, the
|
|
@@ -26,10 +26,10 @@ class ExternalPlanID extends resource_1.APIResource {
|
|
|
26
26
|
* ## Serialized prices
|
|
27
27
|
*
|
|
28
28
|
* Orb supports a few different pricing models out of the box. Each of these models
|
|
29
|
-
* is serialized differently in a given [Price](
|
|
29
|
+
* is serialized differently in a given [Price](/core-concepts#plan-and-price)
|
|
30
30
|
* object. The `model_type` field determines the key for the configuration object
|
|
31
31
|
* that is present. A detailed explanation of price types can be found in the
|
|
32
|
-
* [Price schema](
|
|
32
|
+
* [Price schema](/core-concepts#plan-and-price). "
|
|
33
33
|
*/
|
|
34
34
|
fetch(externalPlanId, options) {
|
|
35
35
|
return this._client.get(`/plans/external_plan_id/${externalPlanId}`, options);
|
|
@@ -11,10 +11,10 @@ export class ExternalPlanID extends APIResource {
|
|
|
11
11
|
return this._client.put(`/plans/external_plan_id/${otherExternalPlanId}`, { body, ...options });
|
|
12
12
|
}
|
|
13
13
|
/**
|
|
14
|
-
* This endpoint is used to fetch [plan](
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
14
|
+
* This endpoint is used to fetch [plan](/core-concepts##plan-and-price) details
|
|
15
|
+
* given an external_plan_id identifier. It returns information about the prices
|
|
16
|
+
* included in the plan and their configuration, as well as the product that the
|
|
17
|
+
* plan is attached to.
|
|
18
18
|
*
|
|
19
19
|
* If multiple plans are found to contain the specified external_plan_id, the
|
|
20
20
|
* active plans will take priority over archived ones, and among those, the
|
|
@@ -23,10 +23,10 @@ export class ExternalPlanID extends APIResource {
|
|
|
23
23
|
* ## Serialized prices
|
|
24
24
|
*
|
|
25
25
|
* Orb supports a few different pricing models out of the box. Each of these models
|
|
26
|
-
* is serialized differently in a given [Price](
|
|
26
|
+
* is serialized differently in a given [Price](/core-concepts#plan-and-price)
|
|
27
27
|
* object. The `model_type` field determines the key for the configuration object
|
|
28
28
|
* that is present. A detailed explanation of price types can be found in the
|
|
29
|
-
* [Price schema](
|
|
29
|
+
* [Price schema](/core-concepts#plan-and-price). "
|
|
30
30
|
*/
|
|
31
31
|
fetch(externalPlanId, options) {
|
|
32
32
|
return this._client.get(`/plans/external_plan_id/${externalPlanId}`, options);
|
|
@@ -19,27 +19,27 @@ export declare class Plans extends APIResource {
|
|
|
19
19
|
*/
|
|
20
20
|
update(planId: string, body: PlanUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Plan>;
|
|
21
21
|
/**
|
|
22
|
-
* This endpoint returns a list of all [plans](
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
* [`pagination_metadata`](
|
|
26
|
-
* the next page of results if they exist.
|
|
22
|
+
* This endpoint returns a list of all [plans](/core-concepts#plan-and-price) for
|
|
23
|
+
* an account in a list format. The list of plans is ordered starting from the most
|
|
24
|
+
* recently created plan. The response also includes
|
|
25
|
+
* [`pagination_metadata`](/api-reference/pagination), which lets the caller
|
|
26
|
+
* retrieve the next page of results if they exist.
|
|
27
27
|
*/
|
|
28
28
|
list(query?: PlanListParams, options?: Core.RequestOptions): Core.PagePromise<PlansPage, Plan>;
|
|
29
29
|
list(options?: Core.RequestOptions): Core.PagePromise<PlansPage, Plan>;
|
|
30
30
|
/**
|
|
31
|
-
* This endpoint is used to fetch [plan](
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
31
|
+
* This endpoint is used to fetch [plan](/core-concepts#plan-and-price) details
|
|
32
|
+
* given a plan identifier. It returns information about the prices included in the
|
|
33
|
+
* plan and their configuration, as well as the product that the plan is attached
|
|
34
|
+
* to.
|
|
35
35
|
*
|
|
36
36
|
* ## Serialized prices
|
|
37
37
|
*
|
|
38
38
|
* Orb supports a few different pricing models out of the box. Each of these models
|
|
39
|
-
* is serialized differently in a given [Price](
|
|
39
|
+
* is serialized differently in a given [Price](/core-concepts#plan-and-price)
|
|
40
40
|
* object. The `model_type` field determines the key for the configuration object
|
|
41
41
|
* that is present. A detailed explanation of price types can be found in the
|
|
42
|
-
* [Price schema](
|
|
42
|
+
* [Price schema](/core-concepts#plan-and-price).
|
|
43
43
|
*
|
|
44
44
|
* ## Phases
|
|
45
45
|
*
|
|
@@ -51,9 +51,9 @@ export declare class Plans extends APIResource {
|
|
|
51
51
|
export declare class PlansPage extends Page<Plan> {
|
|
52
52
|
}
|
|
53
53
|
/**
|
|
54
|
-
* The [Plan](
|
|
55
|
-
*
|
|
56
|
-
*
|
|
54
|
+
* The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
|
55
|
+
* subscribed to by a customer. Plans define the billing behavior of the
|
|
56
|
+
* subscription. You can see more about how to configure prices in the
|
|
57
57
|
* [Price resource](/reference/price).
|
|
58
58
|
*/
|
|
59
59
|
export interface Plan {
|
package/resources/plans/plans.js
CHANGED
|
@@ -57,18 +57,18 @@ class Plans extends resource_1.APIResource {
|
|
|
57
57
|
return this._client.getAPIList('/plans', PlansPage, { query, ...options });
|
|
58
58
|
}
|
|
59
59
|
/**
|
|
60
|
-
* This endpoint is used to fetch [plan](
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
*
|
|
60
|
+
* This endpoint is used to fetch [plan](/core-concepts#plan-and-price) details
|
|
61
|
+
* given a plan identifier. It returns information about the prices included in the
|
|
62
|
+
* plan and their configuration, as well as the product that the plan is attached
|
|
63
|
+
* to.
|
|
64
64
|
*
|
|
65
65
|
* ## Serialized prices
|
|
66
66
|
*
|
|
67
67
|
* Orb supports a few different pricing models out of the box. Each of these models
|
|
68
|
-
* is serialized differently in a given [Price](
|
|
68
|
+
* is serialized differently in a given [Price](/core-concepts#plan-and-price)
|
|
69
69
|
* object. The `model_type` field determines the key for the configuration object
|
|
70
70
|
* that is present. A detailed explanation of price types can be found in the
|
|
71
|
-
* [Price schema](
|
|
71
|
+
* [Price schema](/core-concepts#plan-and-price).
|
|
72
72
|
*
|
|
73
73
|
* ## Phases
|
|
74
74
|
*
|
|
@@ -31,18 +31,18 @@ export class Plans extends APIResource {
|
|
|
31
31
|
return this._client.getAPIList('/plans', PlansPage, { query, ...options });
|
|
32
32
|
}
|
|
33
33
|
/**
|
|
34
|
-
* This endpoint is used to fetch [plan](
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
34
|
+
* This endpoint is used to fetch [plan](/core-concepts#plan-and-price) details
|
|
35
|
+
* given a plan identifier. It returns information about the prices included in the
|
|
36
|
+
* plan and their configuration, as well as the product that the plan is attached
|
|
37
|
+
* to.
|
|
38
38
|
*
|
|
39
39
|
* ## Serialized prices
|
|
40
40
|
*
|
|
41
41
|
* Orb supports a few different pricing models out of the box. Each of these models
|
|
42
|
-
* is serialized differently in a given [Price](
|
|
42
|
+
* is serialized differently in a given [Price](/core-concepts#plan-and-price)
|
|
43
43
|
* object. The `model_type` field determines the key for the configuration object
|
|
44
44
|
* that is present. A detailed explanation of price types can be found in the
|
|
45
|
-
* [Price schema](
|
|
45
|
+
* [Price schema](/core-concepts#plan-and-price).
|
|
46
46
|
*
|
|
47
47
|
* ## Phases
|
|
48
48
|
*
|
|
@@ -10,8 +10,8 @@ export declare class ExternalPriceID extends APIResource {
|
|
|
10
10
|
update(externalPriceId: string, body: ExternalPriceIDUpdateParams, options?: Core.RequestOptions): Core.APIPromise<PricesAPI.Price>;
|
|
11
11
|
/**
|
|
12
12
|
* This endpoint returns a price given an external price id. See the
|
|
13
|
-
* [price creation API](
|
|
14
|
-
* external price aliases.
|
|
13
|
+
* [price creation API](/api-reference/price/create-price) for more information
|
|
14
|
+
* about external price aliases.
|
|
15
15
|
*/
|
|
16
16
|
fetch(externalPriceId: string, options?: Core.RequestOptions): Core.APIPromise<PricesAPI.Price>;
|
|
17
17
|
}
|
|
@@ -14,8 +14,8 @@ class ExternalPriceID extends resource_1.APIResource {
|
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
16
|
* This endpoint returns a price given an external price id. See the
|
|
17
|
-
* [price creation API](
|
|
18
|
-
* external price aliases.
|
|
17
|
+
* [price creation API](/api-reference/price/create-price) for more information
|
|
18
|
+
* about external price aliases.
|
|
19
19
|
*/
|
|
20
20
|
fetch(externalPriceId, options) {
|
|
21
21
|
return this._client.get(`/prices/external_price_id/${externalPriceId}`, options);
|
|
@@ -11,8 +11,8 @@ export class ExternalPriceID extends APIResource {
|
|
|
11
11
|
}
|
|
12
12
|
/**
|
|
13
13
|
* This endpoint returns a price given an external price id. See the
|
|
14
|
-
* [price creation API](
|
|
15
|
-
* external price aliases.
|
|
14
|
+
* [price creation API](/api-reference/price/create-price) for more information
|
|
15
|
+
* about external price aliases.
|
|
16
16
|
*/
|
|
17
17
|
fetch(externalPriceId, options) {
|
|
18
18
|
return this._client.get(`/prices/external_price_id/${externalPriceId}`, options);
|