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
|
@@ -17,7 +17,7 @@ export declare class Subscriptions extends APIResource {
|
|
|
17
17
|
*
|
|
18
18
|
* The default configuration for subscriptions in Orb is **In-advance billing** and
|
|
19
19
|
* **Beginning of month alignment** (see
|
|
20
|
-
* [Subscription](
|
|
20
|
+
* [Subscription](/core-concepts##subscription) for more details).
|
|
21
21
|
*
|
|
22
22
|
* In order to change the alignment behavior, Orb also supports billing
|
|
23
23
|
* subscriptions on the day of the month they are created. If
|
|
@@ -42,9 +42,10 @@ export declare class Subscriptions extends APIResource {
|
|
|
42
42
|
* subscription being created. This is useful when a customer has prices that
|
|
43
43
|
* differ from the default prices for a specific plan.
|
|
44
44
|
*
|
|
45
|
-
*
|
|
46
|
-
* Subscription Overrides Version 2. You can find your
|
|
47
|
-
* Version at the bottom of your [Plans page](https://app.withorb.com/plans)
|
|
45
|
+
* <Note>
|
|
46
|
+
* This feature is only available for accounts that have migrated to Subscription Overrides Version 2. You can find your
|
|
47
|
+
* Subscription Overrides Version at the bottom of your [Plans page](https://app.withorb.com/plans)
|
|
48
|
+
* </Note>
|
|
48
49
|
*
|
|
49
50
|
* ### Adding Prices
|
|
50
51
|
*
|
|
@@ -52,17 +53,17 @@ export declare class Subscriptions extends APIResource {
|
|
|
52
53
|
* the list must specify an existing add-on price with a `price_id` or
|
|
53
54
|
* `external_price_id` field, or create a new add-on price by including an object
|
|
54
55
|
* with the key `price`, identical to what would be used in the request body for
|
|
55
|
-
* the [create price endpoint](
|
|
56
|
-
* [Price resource](
|
|
57
|
-
* model configurations possible in this object.
|
|
56
|
+
* the [create price endpoint](/api-reference/price/create-price). See the
|
|
57
|
+
* [Price resource](/product-catalog/price-configuration) for the specification of
|
|
58
|
+
* different price model configurations possible in this object.
|
|
58
59
|
*
|
|
59
60
|
* If the plan has phases, each object in the list must include a number with
|
|
60
61
|
* `plan_phase_order` key to indicate which phase the price should be added to.
|
|
61
62
|
*
|
|
62
63
|
* An object in the list can specify an optional `start_date` and optional
|
|
63
64
|
* `end_date`. This is equivalent to creating a price interval with the
|
|
64
|
-
* [add/edit price intervals endpoint](
|
|
65
|
-
* unspecified, the start or end date of the phase or subscription will be used.
|
|
65
|
+
* [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
|
|
66
|
+
* If unspecified, the start or end date of the phase or subscription will be used.
|
|
66
67
|
*
|
|
67
68
|
* An object in the list can specify an optional `minimum_amount`,
|
|
68
69
|
* `maximum_amount`, or `discounts`. This will create adjustments which apply only
|
|
@@ -87,14 +88,15 @@ export declare class Subscriptions extends APIResource {
|
|
|
87
88
|
* either referencing an existing add-on price with a `price_id` or
|
|
88
89
|
* `external_price_id` field, or by creating a new add-on price by including an
|
|
89
90
|
* object with the key `price`, identical to what would be used in the request body
|
|
90
|
-
* for the [create price endpoint](
|
|
91
|
-
* [Price resource](
|
|
92
|
-
* model configurations possible in this object.
|
|
91
|
+
* for the [create price endpoint](/api-reference/price/create-price). See the
|
|
92
|
+
* [Price resource](/product-catalog/price-configuration) for the specification of
|
|
93
|
+
* different price model configurations possible in this object.
|
|
93
94
|
*
|
|
94
95
|
* For fixed fees, an object in the list can supply a `fixed_price_quantity`
|
|
95
96
|
* instead of a `price`, `price_id`, or `external_price_id` field. This will update
|
|
96
97
|
* only the quantity for the price, similar to the
|
|
97
|
-
* [Update price quantity](
|
|
98
|
+
* [Update price quantity](/api-reference/subscription/update-price-quantity)
|
|
99
|
+
* endpoint.
|
|
98
100
|
*
|
|
99
101
|
* The replacement price will have the same phase, if applicable, and the same
|
|
100
102
|
* start and end dates as the price it replaces.
|
|
@@ -113,7 +115,7 @@ export declare class Subscriptions extends APIResource {
|
|
|
113
115
|
* To add adjustments, provide a list of objects with the key `add_adjustments`. An
|
|
114
116
|
* object in the list must include an object with the key `adjustment`, identical
|
|
115
117
|
* to the adjustment object in the
|
|
116
|
-
* [add/edit price intervals endpoint](
|
|
118
|
+
* [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
|
|
117
119
|
*
|
|
118
120
|
* If the plan has phases, each object in the list must include a number with
|
|
119
121
|
* `plan_phase_order` key to indicate which phase the adjustment should be added
|
|
@@ -136,17 +138,17 @@ export declare class Subscriptions extends APIResource {
|
|
|
136
138
|
* replace with the `replaces_adjustment_id` key, and it must specify an adjustment
|
|
137
139
|
* to replace it with by including an object with the key `adjustment`, identical
|
|
138
140
|
* to the adjustment object in the
|
|
139
|
-
* [add/edit price intervals endpoint](
|
|
141
|
+
* [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
|
|
140
142
|
*
|
|
141
143
|
* The replacement adjustment will have the same phase, if applicable, and the same
|
|
142
144
|
* start and end dates as the adjustment it replaces.
|
|
143
145
|
*
|
|
144
146
|
* ## Price overrides (DEPRECATED)
|
|
145
147
|
*
|
|
146
|
-
*
|
|
147
|
-
* prices. (See
|
|
148
|
-
* [Customize your customer's subscriptions](
|
|
149
|
-
*
|
|
148
|
+
* <Note>
|
|
149
|
+
* Price overrides are being phased out in favor adding/removing/replacing prices. (See
|
|
150
|
+
* [Customize your customer's subscriptions](/api-reference/subscription/create-subscription))
|
|
151
|
+
* </Note>
|
|
150
152
|
*
|
|
151
153
|
* Price overrides are used to update some or all prices in a plan for the specific
|
|
152
154
|
* subscription being created. This is useful when a new customer has negotiated a
|
|
@@ -155,9 +157,9 @@ export declare class Subscriptions extends APIResource {
|
|
|
155
157
|
* To override prices, provide a list of objects with the key `price_overrides`.
|
|
156
158
|
* The price object in the list of overrides is expected to contain the existing
|
|
157
159
|
* price id, the `model_type` and configuration. (See the
|
|
158
|
-
* [Price resource](
|
|
159
|
-
* model configurations.) The numerical values can be updated, but
|
|
160
|
-
* metric, cadence, type, and name of a price can not be overridden.
|
|
160
|
+
* [Price resource](/product-catalog/price-configuration) for the specification of
|
|
161
|
+
* different price model configurations.) The numerical values can be updated, but
|
|
162
|
+
* the billable metric, cadence, type, and name of a price can not be overridden.
|
|
161
163
|
*
|
|
162
164
|
* ### Maximums and Minimums
|
|
163
165
|
*
|
|
@@ -271,9 +273,9 @@ export declare class Subscriptions extends APIResource {
|
|
|
271
273
|
update(subscriptionId: string, body: SubscriptionUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Subscription>;
|
|
272
274
|
/**
|
|
273
275
|
* This endpoint returns a list of all subscriptions for an account as a
|
|
274
|
-
* [paginated](
|
|
276
|
+
* [paginated](/api-reference/pagination) list, ordered starting from the most
|
|
275
277
|
* recently created subscription. For a full discussion of the subscription
|
|
276
|
-
* resource, see [Subscription](
|
|
278
|
+
* resource, see [Subscription](/core-concepts##subscription).
|
|
277
279
|
*
|
|
278
280
|
* Subscriptions can be filtered for a specific customer by using either the
|
|
279
281
|
* customer_id or external_customer_id query parameters. To filter subscriptions
|
|
@@ -343,11 +345,11 @@ export declare class Subscriptions extends APIResource {
|
|
|
343
345
|
* current period. If the cancellation is before the most recently issued invoice,
|
|
344
346
|
* Orb will void the intervening invoice and generate a new one based on the new
|
|
345
347
|
* dates for the subscription. See the section on
|
|
346
|
-
* [cancellation behaviors](
|
|
348
|
+
* [cancellation behaviors](/product-catalog/creating-subscriptions#cancellation-behaviors).
|
|
347
349
|
*/
|
|
348
350
|
cancel(subscriptionId: string, body: SubscriptionCancelParams, options?: Core.RequestOptions): Core.APIPromise<SubscriptionCancelResponse>;
|
|
349
351
|
/**
|
|
350
|
-
* This endpoint is used to fetch a [Subscription](
|
|
352
|
+
* This endpoint is used to fetch a [Subscription](/core-concepts##subscription)
|
|
351
353
|
* given an identifier.
|
|
352
354
|
*/
|
|
353
355
|
fetch(subscriptionId: string, options?: Core.RequestOptions): Core.APIPromise<Subscription>;
|
|
@@ -366,7 +368,7 @@ export declare class Subscriptions extends APIResource {
|
|
|
366
368
|
fetchCosts(subscriptionId: string, query?: SubscriptionFetchCostsParams, options?: Core.RequestOptions): Core.APIPromise<SubscriptionFetchCostsResponse>;
|
|
367
369
|
fetchCosts(subscriptionId: string, options?: Core.RequestOptions): Core.APIPromise<SubscriptionFetchCostsResponse>;
|
|
368
370
|
/**
|
|
369
|
-
* This endpoint returns a [paginated](
|
|
371
|
+
* This endpoint returns a [paginated](/api-reference/pagination) list of all plans
|
|
370
372
|
* associated with a subscription along with their start and end dates. This list
|
|
371
373
|
* contains the subscription's initial plan along with past and future plan
|
|
372
374
|
* changes.
|
|
@@ -573,9 +575,9 @@ export declare class Subscriptions extends APIResource {
|
|
|
573
575
|
fetchUsage(subscriptionId: string, options?: Core.RequestOptions): Core.APIPromise<SubscriptionUsage>;
|
|
574
576
|
/**
|
|
575
577
|
* This endpoint is used to add and edit subscription
|
|
576
|
-
* [price intervals](
|
|
577
|
-
* subscription’s price intervals, you can
|
|
578
|
-
* [flexibly and atomically control the billing behavior of a subscription](
|
|
578
|
+
* [price intervals](/api-reference/price-interval/add-or-edit-price-intervals). By
|
|
579
|
+
* making modifications to a subscription’s price intervals, you can
|
|
580
|
+
* [flexibly and atomically control the billing behavior of a subscription](/product-catalog/modifying-subscriptions).
|
|
579
581
|
*
|
|
580
582
|
* ## Adding price intervals
|
|
581
583
|
*
|
|
@@ -691,9 +693,10 @@ export declare class Subscriptions extends APIResource {
|
|
|
691
693
|
* subscription when you schedule the plan change. This is useful when a customer
|
|
692
694
|
* has prices that differ from the default prices for a specific plan.
|
|
693
695
|
*
|
|
694
|
-
*
|
|
695
|
-
* Subscription Overrides Version 2. You can find your
|
|
696
|
-
* Version at the bottom of your [Plans page](https://app.withorb.com/plans)
|
|
696
|
+
* <Note>
|
|
697
|
+
* This feature is only available for accounts that have migrated to Subscription Overrides Version 2. You can find your
|
|
698
|
+
* Subscription Overrides Version at the bottom of your [Plans page](https://app.withorb.com/plans)
|
|
699
|
+
* </Note>
|
|
697
700
|
*
|
|
698
701
|
* ### Adding Prices
|
|
699
702
|
*
|
|
@@ -701,17 +704,17 @@ export declare class Subscriptions extends APIResource {
|
|
|
701
704
|
* the list must specify an existing add-on price with a `price_id` or
|
|
702
705
|
* `external_price_id` field, or create a new add-on price by including an object
|
|
703
706
|
* with the key `price`, identical to what would be used in the request body for
|
|
704
|
-
* the [create price endpoint](
|
|
705
|
-
* [Price resource](
|
|
706
|
-
* model configurations possible in this object.
|
|
707
|
+
* the [create price endpoint](/api-reference/price/create-price). See the
|
|
708
|
+
* [Price resource](/product-catalog/price-configuration) for the specification of
|
|
709
|
+
* different price model configurations possible in this object.
|
|
707
710
|
*
|
|
708
711
|
* If the plan has phases, each object in the list must include a number with
|
|
709
712
|
* `plan_phase_order` key to indicate which phase the price should be added to.
|
|
710
713
|
*
|
|
711
714
|
* An object in the list can specify an optional `start_date` and optional
|
|
712
715
|
* `end_date`. This is equivalent to creating a price interval with the
|
|
713
|
-
* [add/edit price intervals endpoint](
|
|
714
|
-
* unspecified, the start or end date of the phase or subscription will be used.
|
|
716
|
+
* [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
|
|
717
|
+
* If unspecified, the start or end date of the phase or subscription will be used.
|
|
715
718
|
*
|
|
716
719
|
* An object in the list can specify an optional `minimum_amount`,
|
|
717
720
|
* `maximum_amount`, or `discounts`. This will create adjustments which apply only
|
|
@@ -736,14 +739,15 @@ export declare class Subscriptions extends APIResource {
|
|
|
736
739
|
* either referencing an existing add-on price with a `price_id` or
|
|
737
740
|
* `external_price_id` field, or by creating a new add-on price by including an
|
|
738
741
|
* object with the key `price`, identical to what would be used in the request body
|
|
739
|
-
* for the [create price endpoint](
|
|
740
|
-
* [Price resource](
|
|
741
|
-
* model configurations possible in this object.
|
|
742
|
+
* for the [create price endpoint](/api-reference/price/create-price). See the
|
|
743
|
+
* [Price resource](/product-catalog/price-configuration) for the specification of
|
|
744
|
+
* different price model configurations possible in this object.
|
|
742
745
|
*
|
|
743
746
|
* For fixed fees, an object in the list can supply a `fixed_price_quantity`
|
|
744
747
|
* instead of a `price`, `price_id`, or `external_price_id` field. This will update
|
|
745
748
|
* only the quantity for the price, similar to the
|
|
746
|
-
* [Update price quantity](
|
|
749
|
+
* [Update price quantity](/api-reference/subscription/update-price-quantity)
|
|
750
|
+
* endpoint.
|
|
747
751
|
*
|
|
748
752
|
* The replacement price will have the same phase, if applicable, and the same
|
|
749
753
|
* start and end dates as the price it replaces.
|
|
@@ -762,7 +766,7 @@ export declare class Subscriptions extends APIResource {
|
|
|
762
766
|
* To add adjustments, provide a list of objects with the key `add_adjustments`. An
|
|
763
767
|
* object in the list must include an object with the key `adjustment`, identical
|
|
764
768
|
* to the adjustment object in the
|
|
765
|
-
* [add/edit price intervals endpoint](
|
|
769
|
+
* [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
|
|
766
770
|
*
|
|
767
771
|
* If the plan has phases, each object in the list must include a number with
|
|
768
772
|
* `plan_phase_order` key to indicate which phase the adjustment should be added
|
|
@@ -785,17 +789,17 @@ export declare class Subscriptions extends APIResource {
|
|
|
785
789
|
* replace with the `replaces_adjustment_id` key, and it must specify an adjustment
|
|
786
790
|
* to replace it with by including an object with the key `adjustment`, identical
|
|
787
791
|
* to the adjustment object in the
|
|
788
|
-
* [add/edit price intervals endpoint](
|
|
792
|
+
* [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
|
|
789
793
|
*
|
|
790
794
|
* The replacement adjustment will have the same phase, if applicable, and the same
|
|
791
795
|
* start and end dates as the adjustment it replaces.
|
|
792
796
|
*
|
|
793
797
|
* ## Price overrides (DEPRECATED)
|
|
794
798
|
*
|
|
795
|
-
*
|
|
796
|
-
* prices. (See
|
|
797
|
-
* [Customize your customer's subscriptions](
|
|
798
|
-
*
|
|
799
|
+
* <Note>
|
|
800
|
+
* Price overrides are being phased out in favor adding/removing/replacing prices. (See
|
|
801
|
+
* [Customize your customer's subscriptions](/api-reference/subscription/schedule-plan-change))
|
|
802
|
+
* </Note>
|
|
799
803
|
*
|
|
800
804
|
* Price overrides are used to update some or all prices in a plan for the specific
|
|
801
805
|
* subscription being created. This is useful when a new customer has negotiated a
|
|
@@ -804,9 +808,9 @@ export declare class Subscriptions extends APIResource {
|
|
|
804
808
|
* To override prices, provide a list of objects with the key `price_overrides`.
|
|
805
809
|
* The price object in the list of overrides is expected to contain the existing
|
|
806
810
|
* price id, the `model_type` and configuration. (See the
|
|
807
|
-
* [Price resource](
|
|
808
|
-
* model configurations.) The numerical values can be updated, but
|
|
809
|
-
* metric, cadence, type, and name of a price can not be overridden.
|
|
811
|
+
* [Price resource](/product-catalog/price-configuration) for the specification of
|
|
812
|
+
* different price model configurations.) The numerical values can be updated, but
|
|
813
|
+
* the billable metric, cadence, type, and name of a price can not be overridden.
|
|
810
814
|
*
|
|
811
815
|
* ### Maximums, and minimums
|
|
812
816
|
*
|
|
@@ -826,7 +830,7 @@ export declare class Subscriptions extends APIResource {
|
|
|
826
830
|
* By default, Orb calculates the prorated difference in any fixed fees when making
|
|
827
831
|
* a plan change, adjusting the customer balance as needed. For details on this
|
|
828
832
|
* behavior, see
|
|
829
|
-
* [Modifying subscriptions](
|
|
833
|
+
* [Modifying subscriptions](/product-catalog/modifying-subscriptions#prorations-for-in-advance-fees).
|
|
830
834
|
*/
|
|
831
835
|
schedulePlanChange(subscriptionId: string, body: SubscriptionSchedulePlanChangeParams, options?: Core.RequestOptions): Core.APIPromise<SubscriptionSchedulePlanChangeResponse>;
|
|
832
836
|
/**
|
|
@@ -900,8 +904,8 @@ export declare class SubscriptionsPage extends Page<Subscription> {
|
|
|
900
904
|
export declare class SubscriptionFetchScheduleResponsesPage extends Page<SubscriptionFetchScheduleResponse> {
|
|
901
905
|
}
|
|
902
906
|
/**
|
|
903
|
-
* A [subscription](
|
|
904
|
-
*
|
|
907
|
+
* A [subscription](/core-concepts#subscription) represents the purchase of a plan
|
|
908
|
+
* by a customer.
|
|
905
909
|
*
|
|
906
910
|
* By default, subscriptions begin on the day that they're created and renew
|
|
907
911
|
* automatically for each billing cycle at the cadence that's configured in the
|
|
@@ -966,7 +970,7 @@ export interface Subscription {
|
|
|
966
970
|
* it's often desirable to have these match existing identifiers in your system. To
|
|
967
971
|
* avoid having to denormalize Orb ID information, you can pass in an
|
|
968
972
|
* `external_customer_id` with your own identifier. See
|
|
969
|
-
* [Customer ID Aliases](
|
|
973
|
+
* [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
|
|
970
974
|
* information about how these aliases work in Orb.
|
|
971
975
|
*
|
|
972
976
|
* In addition to having an identifier in your system, a customer may exist in a
|
|
@@ -975,9 +979,8 @@ export interface Subscription {
|
|
|
975
979
|
*
|
|
976
980
|
* A customer also has a timezone (from the standard
|
|
977
981
|
* [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
|
|
978
|
-
* your account's timezone. See
|
|
979
|
-
*
|
|
980
|
-
* on what this timezone parameter influences within Orb.
|
|
982
|
+
* your account's timezone. See [Timezone localization](/essentials/timezones) for
|
|
983
|
+
* information on what this timezone parameter influences within Orb.
|
|
981
984
|
*/
|
|
982
985
|
customer: CustomersAPI.Customer;
|
|
983
986
|
/**
|
|
@@ -1018,9 +1021,9 @@ export interface Subscription {
|
|
|
1018
1021
|
*/
|
|
1019
1022
|
net_terms: number;
|
|
1020
1023
|
/**
|
|
1021
|
-
* The [Plan](
|
|
1022
|
-
*
|
|
1023
|
-
*
|
|
1024
|
+
* The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
|
1025
|
+
* subscribed to by a customer. Plans define the billing behavior of the
|
|
1026
|
+
* subscription. You can see more about how to configure prices in the
|
|
1024
1027
|
* [Price resource](/reference/price).
|
|
1025
1028
|
*/
|
|
1026
1029
|
plan: PlansAPI.Plan;
|
|
@@ -1374,229 +1377,8 @@ export declare namespace Subscription {
|
|
|
1374
1377
|
* is serialized differently in a given Price object. The model_type field
|
|
1375
1378
|
* determines the key for the configuration object that is present.
|
|
1376
1379
|
*
|
|
1377
|
-
*
|
|
1378
|
-
*
|
|
1379
|
-
* With unit pricing, each unit costs a fixed amount.
|
|
1380
|
-
*
|
|
1381
|
-
* ```json
|
|
1382
|
-
* {
|
|
1383
|
-
* ...
|
|
1384
|
-
* "model_type": "unit",
|
|
1385
|
-
* "unit_config": {
|
|
1386
|
-
* "unit_amount": "0.50"
|
|
1387
|
-
* }
|
|
1388
|
-
* ...
|
|
1389
|
-
* }
|
|
1390
|
-
* ```
|
|
1391
|
-
*
|
|
1392
|
-
* ## Tiered pricing
|
|
1393
|
-
*
|
|
1394
|
-
* In tiered pricing, the cost of a given unit depends on the tier range that it
|
|
1395
|
-
* falls into, where each tier range is defined by an upper and lower bound. For
|
|
1396
|
-
* example, the first ten units may cost $0.50 each and all units thereafter may
|
|
1397
|
-
* cost $0.10 each.
|
|
1398
|
-
*
|
|
1399
|
-
* ```json
|
|
1400
|
-
* {
|
|
1401
|
-
* ...
|
|
1402
|
-
* "model_type": "tiered",
|
|
1403
|
-
* "tiered_config": {
|
|
1404
|
-
* "tiers": [
|
|
1405
|
-
* {
|
|
1406
|
-
* "first_unit": 1,
|
|
1407
|
-
* "last_unit": 10,
|
|
1408
|
-
* "unit_amount": "0.50"
|
|
1409
|
-
* },
|
|
1410
|
-
* {
|
|
1411
|
-
* "first_unit": 11,
|
|
1412
|
-
* "last_unit": null,
|
|
1413
|
-
* "unit_amount": "0.10"
|
|
1414
|
-
* }
|
|
1415
|
-
* ]
|
|
1416
|
-
* }
|
|
1417
|
-
* ...
|
|
1418
|
-
* ```
|
|
1419
|
-
*
|
|
1420
|
-
* ## Bulk pricing
|
|
1421
|
-
*
|
|
1422
|
-
* Bulk pricing applies when the number of units determine the cost of all units.
|
|
1423
|
-
* For example, if you've bought less than 10 units, they may each be $0.50 for a
|
|
1424
|
-
* total of $5.00. Once you've bought more than 10 units, all units may now be
|
|
1425
|
-
* priced at $0.40 (i.e. 101 units total would be $40.40).
|
|
1426
|
-
*
|
|
1427
|
-
* ```json
|
|
1428
|
-
* {
|
|
1429
|
-
* ...
|
|
1430
|
-
* "model_type": "bulk",
|
|
1431
|
-
* "bulk_config": {
|
|
1432
|
-
* "tiers": [
|
|
1433
|
-
* {
|
|
1434
|
-
* "maximum_units": 10,
|
|
1435
|
-
* "unit_amount": "0.50"
|
|
1436
|
-
* },
|
|
1437
|
-
* {
|
|
1438
|
-
* "maximum_units": 1000,
|
|
1439
|
-
* "unit_amount": "0.40"
|
|
1440
|
-
* }
|
|
1441
|
-
* ]
|
|
1442
|
-
* }
|
|
1443
|
-
* ...
|
|
1444
|
-
* }
|
|
1445
|
-
* ```
|
|
1446
|
-
*
|
|
1447
|
-
* ## Package pricing
|
|
1448
|
-
*
|
|
1449
|
-
* Package pricing defines the size or granularity of a unit for billing purposes.
|
|
1450
|
-
* For example, if the package size is set to 5, then 4 units will be billed as 5
|
|
1451
|
-
* and 6 units will be billed at 10.
|
|
1452
|
-
*
|
|
1453
|
-
* ```json
|
|
1454
|
-
* {
|
|
1455
|
-
* ...
|
|
1456
|
-
* "model_type": "package",
|
|
1457
|
-
* "package_config": {
|
|
1458
|
-
* "package_amount": "0.80",
|
|
1459
|
-
* "package_size": 10
|
|
1460
|
-
* }
|
|
1461
|
-
* ...
|
|
1462
|
-
* }
|
|
1463
|
-
* ```
|
|
1464
|
-
*
|
|
1465
|
-
* ## BPS pricing
|
|
1466
|
-
*
|
|
1467
|
-
* BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
|
|
1468
|
-
* percent (the number of basis points to charge), as well as a cap per event to
|
|
1469
|
-
* assess. For example, this would allow you to assess a fee of 0.25% on every
|
|
1470
|
-
* payment you process, with a maximum charge of $25 per payment.
|
|
1471
|
-
*
|
|
1472
|
-
* ```json
|
|
1473
|
-
* {
|
|
1474
|
-
* ...
|
|
1475
|
-
* "model_type": "bps",
|
|
1476
|
-
* "bps_config": {
|
|
1477
|
-
* "bps": 125,
|
|
1478
|
-
* "per_unit_maximum": "11.00"
|
|
1479
|
-
* }
|
|
1480
|
-
* ...
|
|
1481
|
-
* }
|
|
1482
|
-
* ```
|
|
1483
|
-
*
|
|
1484
|
-
* ## Bulk BPS pricing
|
|
1485
|
-
*
|
|
1486
|
-
* Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
|
|
1487
|
-
* total quantity across all events. Similar to bulk pricing, the BPS parameters of
|
|
1488
|
-
* a given event depends on the tier range that the billing period falls into. Each
|
|
1489
|
-
* tier range is defined by an upper bound. For example, after $1.5M of payment
|
|
1490
|
-
* volume is reached, each individual payment may have a lower cap or a smaller
|
|
1491
|
-
* take-rate.
|
|
1492
|
-
*
|
|
1493
|
-
* ```json
|
|
1494
|
-
* ...
|
|
1495
|
-
* "model_type": "bulk_bps",
|
|
1496
|
-
* "bulk_bps_config": {
|
|
1497
|
-
* "tiers": [
|
|
1498
|
-
* {
|
|
1499
|
-
* "maximum_amount": "1000000.00",
|
|
1500
|
-
* "bps": 125,
|
|
1501
|
-
* "per_unit_maximum": "19.00"
|
|
1502
|
-
* },
|
|
1503
|
-
* {
|
|
1504
|
-
* "maximum_amount": null,
|
|
1505
|
-
* "bps": 115,
|
|
1506
|
-
* "per_unit_maximum": "4.00"
|
|
1507
|
-
* }
|
|
1508
|
-
* ]
|
|
1509
|
-
* }
|
|
1510
|
-
* ...
|
|
1511
|
-
* }
|
|
1512
|
-
* ```
|
|
1513
|
-
*
|
|
1514
|
-
* ## Tiered BPS pricing
|
|
1515
|
-
*
|
|
1516
|
-
* Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
|
|
1517
|
-
* event's applicable parameter is a function of its marginal addition to the
|
|
1518
|
-
* period total. Similar to tiered pricing, the BPS parameters of a given event
|
|
1519
|
-
* depends on the tier range that it falls into, where each tier range is defined
|
|
1520
|
-
* by an upper and lower bound. For example, the first few payments may have a 0.8
|
|
1521
|
-
* BPS take-rate and all payments after a specific volume may incur a take-rate of
|
|
1522
|
-
* 0.5 BPS each.
|
|
1523
|
-
*
|
|
1524
|
-
* ```json
|
|
1525
|
-
* ...
|
|
1526
|
-
* "model_type": "tiered_bps",
|
|
1527
|
-
* "tiered_bps_config": {
|
|
1528
|
-
* "tiers": [
|
|
1529
|
-
* {
|
|
1530
|
-
* "minimum_amount": "0",
|
|
1531
|
-
* "maximum_amount": "1000000.00",
|
|
1532
|
-
* "bps": 125,
|
|
1533
|
-
* "per_unit_maximum": "19.00"
|
|
1534
|
-
* },
|
|
1535
|
-
* {
|
|
1536
|
-
* "minimum_amount": "1000000.00",
|
|
1537
|
-
* "maximum_amount": null,
|
|
1538
|
-
* "bps": 115,
|
|
1539
|
-
* "per_unit_maximum": "4.00"
|
|
1540
|
-
* }
|
|
1541
|
-
* ]
|
|
1542
|
-
* }
|
|
1543
|
-
* ...
|
|
1544
|
-
* }
|
|
1545
|
-
* ```
|
|
1546
|
-
*
|
|
1547
|
-
* ## Matrix pricing
|
|
1548
|
-
*
|
|
1549
|
-
* Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
|
|
1550
|
-
* `dimensions` defines the two event property values evaluated in this pricing
|
|
1551
|
-
* model. In a one-dimensional matrix, the second value is `null`. Every
|
|
1552
|
-
* configuration has a list of `matrix_values` which give the unit prices for
|
|
1553
|
-
* specified property values. In a one-dimensional matrix, the matrix values will
|
|
1554
|
-
* have `dimension_values` where the second value of the pair is null. If an event
|
|
1555
|
-
* does not match any of the dimension values in the matrix, it will resort to the
|
|
1556
|
-
* `default_unit_amount`.
|
|
1557
|
-
*
|
|
1558
|
-
* ```json
|
|
1559
|
-
* {
|
|
1560
|
-
* "model_type": "matrix"
|
|
1561
|
-
* "matrix_config": {
|
|
1562
|
-
* "default_unit_amount": "3.00",
|
|
1563
|
-
* "dimensions": [
|
|
1564
|
-
* "cluster_name",
|
|
1565
|
-
* "region"
|
|
1566
|
-
* ],
|
|
1567
|
-
* "matrix_values": [
|
|
1568
|
-
* {
|
|
1569
|
-
* "dimension_values": [
|
|
1570
|
-
* "alpha",
|
|
1571
|
-
* "west"
|
|
1572
|
-
* ],
|
|
1573
|
-
* "unit_amount": "2.00"
|
|
1574
|
-
* },
|
|
1575
|
-
* ...
|
|
1576
|
-
* ]
|
|
1577
|
-
* }
|
|
1578
|
-
* }
|
|
1579
|
-
* ```
|
|
1580
|
-
*
|
|
1581
|
-
* ## Fixed fees
|
|
1582
|
-
*
|
|
1583
|
-
* Fixed fees are prices that are applied independent of usage quantities, and
|
|
1584
|
-
* follow unit pricing. They also have an additional parameter
|
|
1585
|
-
* `fixed_price_quantity`. If the Price represents a fixed cost, this represents
|
|
1586
|
-
* the quantity of units applied.
|
|
1587
|
-
*
|
|
1588
|
-
* ```json
|
|
1589
|
-
* {
|
|
1590
|
-
* ...
|
|
1591
|
-
* "id": "price_id",
|
|
1592
|
-
* "model_type": "unit",
|
|
1593
|
-
* "unit_config": {
|
|
1594
|
-
* "unit_amount": "2.00"
|
|
1595
|
-
* },
|
|
1596
|
-
* "fixed_price_quantity": 3.0
|
|
1597
|
-
* ...
|
|
1598
|
-
* }
|
|
1599
|
-
* ```
|
|
1380
|
+
* For more on the types of prices, see
|
|
1381
|
+
* [the core concepts documentation](/core-concepts#plan-and-price)
|
|
1600
1382
|
*/
|
|
1601
1383
|
price: PricesAPI.Price;
|
|
1602
1384
|
/**
|
|
@@ -1722,7 +1504,7 @@ export interface SubscriptionCreateResponse {
|
|
|
1722
1504
|
* it's often desirable to have these match existing identifiers in your system. To
|
|
1723
1505
|
* avoid having to denormalize Orb ID information, you can pass in an
|
|
1724
1506
|
* `external_customer_id` with your own identifier. See
|
|
1725
|
-
* [Customer ID Aliases](
|
|
1507
|
+
* [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
|
|
1726
1508
|
* information about how these aliases work in Orb.
|
|
1727
1509
|
*
|
|
1728
1510
|
* In addition to having an identifier in your system, a customer may exist in a
|
|
@@ -1731,9 +1513,8 @@ export interface SubscriptionCreateResponse {
|
|
|
1731
1513
|
*
|
|
1732
1514
|
* A customer also has a timezone (from the standard
|
|
1733
1515
|
* [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
|
|
1734
|
-
* your account's timezone. See
|
|
1735
|
-
*
|
|
1736
|
-
* on what this timezone parameter influences within Orb.
|
|
1516
|
+
* your account's timezone. See [Timezone localization](/essentials/timezones) for
|
|
1517
|
+
* information on what this timezone parameter influences within Orb.
|
|
1737
1518
|
*/
|
|
1738
1519
|
customer: CustomersAPI.Customer;
|
|
1739
1520
|
/**
|
|
@@ -1774,9 +1555,9 @@ export interface SubscriptionCreateResponse {
|
|
|
1774
1555
|
*/
|
|
1775
1556
|
net_terms: number;
|
|
1776
1557
|
/**
|
|
1777
|
-
* The [Plan](
|
|
1778
|
-
*
|
|
1779
|
-
*
|
|
1558
|
+
* The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
|
1559
|
+
* subscribed to by a customer. Plans define the billing behavior of the
|
|
1560
|
+
* subscription. You can see more about how to configure prices in the
|
|
1780
1561
|
* [Price resource](/reference/price).
|
|
1781
1562
|
*/
|
|
1782
1563
|
plan: PlansAPI.Plan;
|
|
@@ -2130,229 +1911,8 @@ export declare namespace SubscriptionCreateResponse {
|
|
|
2130
1911
|
* is serialized differently in a given Price object. The model_type field
|
|
2131
1912
|
* determines the key for the configuration object that is present.
|
|
2132
1913
|
*
|
|
2133
|
-
*
|
|
2134
|
-
*
|
|
2135
|
-
* With unit pricing, each unit costs a fixed amount.
|
|
2136
|
-
*
|
|
2137
|
-
* ```json
|
|
2138
|
-
* {
|
|
2139
|
-
* ...
|
|
2140
|
-
* "model_type": "unit",
|
|
2141
|
-
* "unit_config": {
|
|
2142
|
-
* "unit_amount": "0.50"
|
|
2143
|
-
* }
|
|
2144
|
-
* ...
|
|
2145
|
-
* }
|
|
2146
|
-
* ```
|
|
2147
|
-
*
|
|
2148
|
-
* ## Tiered pricing
|
|
2149
|
-
*
|
|
2150
|
-
* In tiered pricing, the cost of a given unit depends on the tier range that it
|
|
2151
|
-
* falls into, where each tier range is defined by an upper and lower bound. For
|
|
2152
|
-
* example, the first ten units may cost $0.50 each and all units thereafter may
|
|
2153
|
-
* cost $0.10 each.
|
|
2154
|
-
*
|
|
2155
|
-
* ```json
|
|
2156
|
-
* {
|
|
2157
|
-
* ...
|
|
2158
|
-
* "model_type": "tiered",
|
|
2159
|
-
* "tiered_config": {
|
|
2160
|
-
* "tiers": [
|
|
2161
|
-
* {
|
|
2162
|
-
* "first_unit": 1,
|
|
2163
|
-
* "last_unit": 10,
|
|
2164
|
-
* "unit_amount": "0.50"
|
|
2165
|
-
* },
|
|
2166
|
-
* {
|
|
2167
|
-
* "first_unit": 11,
|
|
2168
|
-
* "last_unit": null,
|
|
2169
|
-
* "unit_amount": "0.10"
|
|
2170
|
-
* }
|
|
2171
|
-
* ]
|
|
2172
|
-
* }
|
|
2173
|
-
* ...
|
|
2174
|
-
* ```
|
|
2175
|
-
*
|
|
2176
|
-
* ## Bulk pricing
|
|
2177
|
-
*
|
|
2178
|
-
* Bulk pricing applies when the number of units determine the cost of all units.
|
|
2179
|
-
* For example, if you've bought less than 10 units, they may each be $0.50 for a
|
|
2180
|
-
* total of $5.00. Once you've bought more than 10 units, all units may now be
|
|
2181
|
-
* priced at $0.40 (i.e. 101 units total would be $40.40).
|
|
2182
|
-
*
|
|
2183
|
-
* ```json
|
|
2184
|
-
* {
|
|
2185
|
-
* ...
|
|
2186
|
-
* "model_type": "bulk",
|
|
2187
|
-
* "bulk_config": {
|
|
2188
|
-
* "tiers": [
|
|
2189
|
-
* {
|
|
2190
|
-
* "maximum_units": 10,
|
|
2191
|
-
* "unit_amount": "0.50"
|
|
2192
|
-
* },
|
|
2193
|
-
* {
|
|
2194
|
-
* "maximum_units": 1000,
|
|
2195
|
-
* "unit_amount": "0.40"
|
|
2196
|
-
* }
|
|
2197
|
-
* ]
|
|
2198
|
-
* }
|
|
2199
|
-
* ...
|
|
2200
|
-
* }
|
|
2201
|
-
* ```
|
|
2202
|
-
*
|
|
2203
|
-
* ## Package pricing
|
|
2204
|
-
*
|
|
2205
|
-
* Package pricing defines the size or granularity of a unit for billing purposes.
|
|
2206
|
-
* For example, if the package size is set to 5, then 4 units will be billed as 5
|
|
2207
|
-
* and 6 units will be billed at 10.
|
|
2208
|
-
*
|
|
2209
|
-
* ```json
|
|
2210
|
-
* {
|
|
2211
|
-
* ...
|
|
2212
|
-
* "model_type": "package",
|
|
2213
|
-
* "package_config": {
|
|
2214
|
-
* "package_amount": "0.80",
|
|
2215
|
-
* "package_size": 10
|
|
2216
|
-
* }
|
|
2217
|
-
* ...
|
|
2218
|
-
* }
|
|
2219
|
-
* ```
|
|
2220
|
-
*
|
|
2221
|
-
* ## BPS pricing
|
|
2222
|
-
*
|
|
2223
|
-
* BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
|
|
2224
|
-
* percent (the number of basis points to charge), as well as a cap per event to
|
|
2225
|
-
* assess. For example, this would allow you to assess a fee of 0.25% on every
|
|
2226
|
-
* payment you process, with a maximum charge of $25 per payment.
|
|
2227
|
-
*
|
|
2228
|
-
* ```json
|
|
2229
|
-
* {
|
|
2230
|
-
* ...
|
|
2231
|
-
* "model_type": "bps",
|
|
2232
|
-
* "bps_config": {
|
|
2233
|
-
* "bps": 125,
|
|
2234
|
-
* "per_unit_maximum": "11.00"
|
|
2235
|
-
* }
|
|
2236
|
-
* ...
|
|
2237
|
-
* }
|
|
2238
|
-
* ```
|
|
2239
|
-
*
|
|
2240
|
-
* ## Bulk BPS pricing
|
|
2241
|
-
*
|
|
2242
|
-
* Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
|
|
2243
|
-
* total quantity across all events. Similar to bulk pricing, the BPS parameters of
|
|
2244
|
-
* a given event depends on the tier range that the billing period falls into. Each
|
|
2245
|
-
* tier range is defined by an upper bound. For example, after $1.5M of payment
|
|
2246
|
-
* volume is reached, each individual payment may have a lower cap or a smaller
|
|
2247
|
-
* take-rate.
|
|
2248
|
-
*
|
|
2249
|
-
* ```json
|
|
2250
|
-
* ...
|
|
2251
|
-
* "model_type": "bulk_bps",
|
|
2252
|
-
* "bulk_bps_config": {
|
|
2253
|
-
* "tiers": [
|
|
2254
|
-
* {
|
|
2255
|
-
* "maximum_amount": "1000000.00",
|
|
2256
|
-
* "bps": 125,
|
|
2257
|
-
* "per_unit_maximum": "19.00"
|
|
2258
|
-
* },
|
|
2259
|
-
* {
|
|
2260
|
-
* "maximum_amount": null,
|
|
2261
|
-
* "bps": 115,
|
|
2262
|
-
* "per_unit_maximum": "4.00"
|
|
2263
|
-
* }
|
|
2264
|
-
* ]
|
|
2265
|
-
* }
|
|
2266
|
-
* ...
|
|
2267
|
-
* }
|
|
2268
|
-
* ```
|
|
2269
|
-
*
|
|
2270
|
-
* ## Tiered BPS pricing
|
|
2271
|
-
*
|
|
2272
|
-
* Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
|
|
2273
|
-
* event's applicable parameter is a function of its marginal addition to the
|
|
2274
|
-
* period total. Similar to tiered pricing, the BPS parameters of a given event
|
|
2275
|
-
* depends on the tier range that it falls into, where each tier range is defined
|
|
2276
|
-
* by an upper and lower bound. For example, the first few payments may have a 0.8
|
|
2277
|
-
* BPS take-rate and all payments after a specific volume may incur a take-rate of
|
|
2278
|
-
* 0.5 BPS each.
|
|
2279
|
-
*
|
|
2280
|
-
* ```json
|
|
2281
|
-
* ...
|
|
2282
|
-
* "model_type": "tiered_bps",
|
|
2283
|
-
* "tiered_bps_config": {
|
|
2284
|
-
* "tiers": [
|
|
2285
|
-
* {
|
|
2286
|
-
* "minimum_amount": "0",
|
|
2287
|
-
* "maximum_amount": "1000000.00",
|
|
2288
|
-
* "bps": 125,
|
|
2289
|
-
* "per_unit_maximum": "19.00"
|
|
2290
|
-
* },
|
|
2291
|
-
* {
|
|
2292
|
-
* "minimum_amount": "1000000.00",
|
|
2293
|
-
* "maximum_amount": null,
|
|
2294
|
-
* "bps": 115,
|
|
2295
|
-
* "per_unit_maximum": "4.00"
|
|
2296
|
-
* }
|
|
2297
|
-
* ]
|
|
2298
|
-
* }
|
|
2299
|
-
* ...
|
|
2300
|
-
* }
|
|
2301
|
-
* ```
|
|
2302
|
-
*
|
|
2303
|
-
* ## Matrix pricing
|
|
2304
|
-
*
|
|
2305
|
-
* Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
|
|
2306
|
-
* `dimensions` defines the two event property values evaluated in this pricing
|
|
2307
|
-
* model. In a one-dimensional matrix, the second value is `null`. Every
|
|
2308
|
-
* configuration has a list of `matrix_values` which give the unit prices for
|
|
2309
|
-
* specified property values. In a one-dimensional matrix, the matrix values will
|
|
2310
|
-
* have `dimension_values` where the second value of the pair is null. If an event
|
|
2311
|
-
* does not match any of the dimension values in the matrix, it will resort to the
|
|
2312
|
-
* `default_unit_amount`.
|
|
2313
|
-
*
|
|
2314
|
-
* ```json
|
|
2315
|
-
* {
|
|
2316
|
-
* "model_type": "matrix"
|
|
2317
|
-
* "matrix_config": {
|
|
2318
|
-
* "default_unit_amount": "3.00",
|
|
2319
|
-
* "dimensions": [
|
|
2320
|
-
* "cluster_name",
|
|
2321
|
-
* "region"
|
|
2322
|
-
* ],
|
|
2323
|
-
* "matrix_values": [
|
|
2324
|
-
* {
|
|
2325
|
-
* "dimension_values": [
|
|
2326
|
-
* "alpha",
|
|
2327
|
-
* "west"
|
|
2328
|
-
* ],
|
|
2329
|
-
* "unit_amount": "2.00"
|
|
2330
|
-
* },
|
|
2331
|
-
* ...
|
|
2332
|
-
* ]
|
|
2333
|
-
* }
|
|
2334
|
-
* }
|
|
2335
|
-
* ```
|
|
2336
|
-
*
|
|
2337
|
-
* ## Fixed fees
|
|
2338
|
-
*
|
|
2339
|
-
* Fixed fees are prices that are applied independent of usage quantities, and
|
|
2340
|
-
* follow unit pricing. They also have an additional parameter
|
|
2341
|
-
* `fixed_price_quantity`. If the Price represents a fixed cost, this represents
|
|
2342
|
-
* the quantity of units applied.
|
|
2343
|
-
*
|
|
2344
|
-
* ```json
|
|
2345
|
-
* {
|
|
2346
|
-
* ...
|
|
2347
|
-
* "id": "price_id",
|
|
2348
|
-
* "model_type": "unit",
|
|
2349
|
-
* "unit_config": {
|
|
2350
|
-
* "unit_amount": "2.00"
|
|
2351
|
-
* },
|
|
2352
|
-
* "fixed_price_quantity": 3.0
|
|
2353
|
-
* ...
|
|
2354
|
-
* }
|
|
2355
|
-
* ```
|
|
1914
|
+
* For more on the types of prices, see
|
|
1915
|
+
* [the core concepts documentation](/core-concepts#plan-and-price)
|
|
2356
1916
|
*/
|
|
2357
1917
|
price: PricesAPI.Price;
|
|
2358
1918
|
/**
|
|
@@ -2423,7 +1983,7 @@ export interface SubscriptionCancelResponse {
|
|
|
2423
1983
|
* it's often desirable to have these match existing identifiers in your system. To
|
|
2424
1984
|
* avoid having to denormalize Orb ID information, you can pass in an
|
|
2425
1985
|
* `external_customer_id` with your own identifier. See
|
|
2426
|
-
* [Customer ID Aliases](
|
|
1986
|
+
* [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
|
|
2427
1987
|
* information about how these aliases work in Orb.
|
|
2428
1988
|
*
|
|
2429
1989
|
* In addition to having an identifier in your system, a customer may exist in a
|
|
@@ -2432,9 +1992,8 @@ export interface SubscriptionCancelResponse {
|
|
|
2432
1992
|
*
|
|
2433
1993
|
* A customer also has a timezone (from the standard
|
|
2434
1994
|
* [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
|
|
2435
|
-
* your account's timezone. See
|
|
2436
|
-
*
|
|
2437
|
-
* on what this timezone parameter influences within Orb.
|
|
1995
|
+
* your account's timezone. See [Timezone localization](/essentials/timezones) for
|
|
1996
|
+
* information on what this timezone parameter influences within Orb.
|
|
2438
1997
|
*/
|
|
2439
1998
|
customer: CustomersAPI.Customer;
|
|
2440
1999
|
/**
|
|
@@ -2475,9 +2034,9 @@ export interface SubscriptionCancelResponse {
|
|
|
2475
2034
|
*/
|
|
2476
2035
|
net_terms: number;
|
|
2477
2036
|
/**
|
|
2478
|
-
* The [Plan](
|
|
2479
|
-
*
|
|
2480
|
-
*
|
|
2037
|
+
* The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
|
2038
|
+
* subscribed to by a customer. Plans define the billing behavior of the
|
|
2039
|
+
* subscription. You can see more about how to configure prices in the
|
|
2481
2040
|
* [Price resource](/reference/price).
|
|
2482
2041
|
*/
|
|
2483
2042
|
plan: PlansAPI.Plan;
|
|
@@ -2831,229 +2390,8 @@ export declare namespace SubscriptionCancelResponse {
|
|
|
2831
2390
|
* is serialized differently in a given Price object. The model_type field
|
|
2832
2391
|
* determines the key for the configuration object that is present.
|
|
2833
2392
|
*
|
|
2834
|
-
*
|
|
2835
|
-
*
|
|
2836
|
-
* With unit pricing, each unit costs a fixed amount.
|
|
2837
|
-
*
|
|
2838
|
-
* ```json
|
|
2839
|
-
* {
|
|
2840
|
-
* ...
|
|
2841
|
-
* "model_type": "unit",
|
|
2842
|
-
* "unit_config": {
|
|
2843
|
-
* "unit_amount": "0.50"
|
|
2844
|
-
* }
|
|
2845
|
-
* ...
|
|
2846
|
-
* }
|
|
2847
|
-
* ```
|
|
2848
|
-
*
|
|
2849
|
-
* ## Tiered pricing
|
|
2850
|
-
*
|
|
2851
|
-
* In tiered pricing, the cost of a given unit depends on the tier range that it
|
|
2852
|
-
* falls into, where each tier range is defined by an upper and lower bound. For
|
|
2853
|
-
* example, the first ten units may cost $0.50 each and all units thereafter may
|
|
2854
|
-
* cost $0.10 each.
|
|
2855
|
-
*
|
|
2856
|
-
* ```json
|
|
2857
|
-
* {
|
|
2858
|
-
* ...
|
|
2859
|
-
* "model_type": "tiered",
|
|
2860
|
-
* "tiered_config": {
|
|
2861
|
-
* "tiers": [
|
|
2862
|
-
* {
|
|
2863
|
-
* "first_unit": 1,
|
|
2864
|
-
* "last_unit": 10,
|
|
2865
|
-
* "unit_amount": "0.50"
|
|
2866
|
-
* },
|
|
2867
|
-
* {
|
|
2868
|
-
* "first_unit": 11,
|
|
2869
|
-
* "last_unit": null,
|
|
2870
|
-
* "unit_amount": "0.10"
|
|
2871
|
-
* }
|
|
2872
|
-
* ]
|
|
2873
|
-
* }
|
|
2874
|
-
* ...
|
|
2875
|
-
* ```
|
|
2876
|
-
*
|
|
2877
|
-
* ## Bulk pricing
|
|
2878
|
-
*
|
|
2879
|
-
* Bulk pricing applies when the number of units determine the cost of all units.
|
|
2880
|
-
* For example, if you've bought less than 10 units, they may each be $0.50 for a
|
|
2881
|
-
* total of $5.00. Once you've bought more than 10 units, all units may now be
|
|
2882
|
-
* priced at $0.40 (i.e. 101 units total would be $40.40).
|
|
2883
|
-
*
|
|
2884
|
-
* ```json
|
|
2885
|
-
* {
|
|
2886
|
-
* ...
|
|
2887
|
-
* "model_type": "bulk",
|
|
2888
|
-
* "bulk_config": {
|
|
2889
|
-
* "tiers": [
|
|
2890
|
-
* {
|
|
2891
|
-
* "maximum_units": 10,
|
|
2892
|
-
* "unit_amount": "0.50"
|
|
2893
|
-
* },
|
|
2894
|
-
* {
|
|
2895
|
-
* "maximum_units": 1000,
|
|
2896
|
-
* "unit_amount": "0.40"
|
|
2897
|
-
* }
|
|
2898
|
-
* ]
|
|
2899
|
-
* }
|
|
2900
|
-
* ...
|
|
2901
|
-
* }
|
|
2902
|
-
* ```
|
|
2903
|
-
*
|
|
2904
|
-
* ## Package pricing
|
|
2905
|
-
*
|
|
2906
|
-
* Package pricing defines the size or granularity of a unit for billing purposes.
|
|
2907
|
-
* For example, if the package size is set to 5, then 4 units will be billed as 5
|
|
2908
|
-
* and 6 units will be billed at 10.
|
|
2909
|
-
*
|
|
2910
|
-
* ```json
|
|
2911
|
-
* {
|
|
2912
|
-
* ...
|
|
2913
|
-
* "model_type": "package",
|
|
2914
|
-
* "package_config": {
|
|
2915
|
-
* "package_amount": "0.80",
|
|
2916
|
-
* "package_size": 10
|
|
2917
|
-
* }
|
|
2918
|
-
* ...
|
|
2919
|
-
* }
|
|
2920
|
-
* ```
|
|
2921
|
-
*
|
|
2922
|
-
* ## BPS pricing
|
|
2923
|
-
*
|
|
2924
|
-
* BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
|
|
2925
|
-
* percent (the number of basis points to charge), as well as a cap per event to
|
|
2926
|
-
* assess. For example, this would allow you to assess a fee of 0.25% on every
|
|
2927
|
-
* payment you process, with a maximum charge of $25 per payment.
|
|
2928
|
-
*
|
|
2929
|
-
* ```json
|
|
2930
|
-
* {
|
|
2931
|
-
* ...
|
|
2932
|
-
* "model_type": "bps",
|
|
2933
|
-
* "bps_config": {
|
|
2934
|
-
* "bps": 125,
|
|
2935
|
-
* "per_unit_maximum": "11.00"
|
|
2936
|
-
* }
|
|
2937
|
-
* ...
|
|
2938
|
-
* }
|
|
2939
|
-
* ```
|
|
2940
|
-
*
|
|
2941
|
-
* ## Bulk BPS pricing
|
|
2942
|
-
*
|
|
2943
|
-
* Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
|
|
2944
|
-
* total quantity across all events. Similar to bulk pricing, the BPS parameters of
|
|
2945
|
-
* a given event depends on the tier range that the billing period falls into. Each
|
|
2946
|
-
* tier range is defined by an upper bound. For example, after $1.5M of payment
|
|
2947
|
-
* volume is reached, each individual payment may have a lower cap or a smaller
|
|
2948
|
-
* take-rate.
|
|
2949
|
-
*
|
|
2950
|
-
* ```json
|
|
2951
|
-
* ...
|
|
2952
|
-
* "model_type": "bulk_bps",
|
|
2953
|
-
* "bulk_bps_config": {
|
|
2954
|
-
* "tiers": [
|
|
2955
|
-
* {
|
|
2956
|
-
* "maximum_amount": "1000000.00",
|
|
2957
|
-
* "bps": 125,
|
|
2958
|
-
* "per_unit_maximum": "19.00"
|
|
2959
|
-
* },
|
|
2960
|
-
* {
|
|
2961
|
-
* "maximum_amount": null,
|
|
2962
|
-
* "bps": 115,
|
|
2963
|
-
* "per_unit_maximum": "4.00"
|
|
2964
|
-
* }
|
|
2965
|
-
* ]
|
|
2966
|
-
* }
|
|
2967
|
-
* ...
|
|
2968
|
-
* }
|
|
2969
|
-
* ```
|
|
2970
|
-
*
|
|
2971
|
-
* ## Tiered BPS pricing
|
|
2972
|
-
*
|
|
2973
|
-
* Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
|
|
2974
|
-
* event's applicable parameter is a function of its marginal addition to the
|
|
2975
|
-
* period total. Similar to tiered pricing, the BPS parameters of a given event
|
|
2976
|
-
* depends on the tier range that it falls into, where each tier range is defined
|
|
2977
|
-
* by an upper and lower bound. For example, the first few payments may have a 0.8
|
|
2978
|
-
* BPS take-rate and all payments after a specific volume may incur a take-rate of
|
|
2979
|
-
* 0.5 BPS each.
|
|
2980
|
-
*
|
|
2981
|
-
* ```json
|
|
2982
|
-
* ...
|
|
2983
|
-
* "model_type": "tiered_bps",
|
|
2984
|
-
* "tiered_bps_config": {
|
|
2985
|
-
* "tiers": [
|
|
2986
|
-
* {
|
|
2987
|
-
* "minimum_amount": "0",
|
|
2988
|
-
* "maximum_amount": "1000000.00",
|
|
2989
|
-
* "bps": 125,
|
|
2990
|
-
* "per_unit_maximum": "19.00"
|
|
2991
|
-
* },
|
|
2992
|
-
* {
|
|
2993
|
-
* "minimum_amount": "1000000.00",
|
|
2994
|
-
* "maximum_amount": null,
|
|
2995
|
-
* "bps": 115,
|
|
2996
|
-
* "per_unit_maximum": "4.00"
|
|
2997
|
-
* }
|
|
2998
|
-
* ]
|
|
2999
|
-
* }
|
|
3000
|
-
* ...
|
|
3001
|
-
* }
|
|
3002
|
-
* ```
|
|
3003
|
-
*
|
|
3004
|
-
* ## Matrix pricing
|
|
3005
|
-
*
|
|
3006
|
-
* Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
|
|
3007
|
-
* `dimensions` defines the two event property values evaluated in this pricing
|
|
3008
|
-
* model. In a one-dimensional matrix, the second value is `null`. Every
|
|
3009
|
-
* configuration has a list of `matrix_values` which give the unit prices for
|
|
3010
|
-
* specified property values. In a one-dimensional matrix, the matrix values will
|
|
3011
|
-
* have `dimension_values` where the second value of the pair is null. If an event
|
|
3012
|
-
* does not match any of the dimension values in the matrix, it will resort to the
|
|
3013
|
-
* `default_unit_amount`.
|
|
3014
|
-
*
|
|
3015
|
-
* ```json
|
|
3016
|
-
* {
|
|
3017
|
-
* "model_type": "matrix"
|
|
3018
|
-
* "matrix_config": {
|
|
3019
|
-
* "default_unit_amount": "3.00",
|
|
3020
|
-
* "dimensions": [
|
|
3021
|
-
* "cluster_name",
|
|
3022
|
-
* "region"
|
|
3023
|
-
* ],
|
|
3024
|
-
* "matrix_values": [
|
|
3025
|
-
* {
|
|
3026
|
-
* "dimension_values": [
|
|
3027
|
-
* "alpha",
|
|
3028
|
-
* "west"
|
|
3029
|
-
* ],
|
|
3030
|
-
* "unit_amount": "2.00"
|
|
3031
|
-
* },
|
|
3032
|
-
* ...
|
|
3033
|
-
* ]
|
|
3034
|
-
* }
|
|
3035
|
-
* }
|
|
3036
|
-
* ```
|
|
3037
|
-
*
|
|
3038
|
-
* ## Fixed fees
|
|
3039
|
-
*
|
|
3040
|
-
* Fixed fees are prices that are applied independent of usage quantities, and
|
|
3041
|
-
* follow unit pricing. They also have an additional parameter
|
|
3042
|
-
* `fixed_price_quantity`. If the Price represents a fixed cost, this represents
|
|
3043
|
-
* the quantity of units applied.
|
|
3044
|
-
*
|
|
3045
|
-
* ```json
|
|
3046
|
-
* {
|
|
3047
|
-
* ...
|
|
3048
|
-
* "id": "price_id",
|
|
3049
|
-
* "model_type": "unit",
|
|
3050
|
-
* "unit_config": {
|
|
3051
|
-
* "unit_amount": "2.00"
|
|
3052
|
-
* },
|
|
3053
|
-
* "fixed_price_quantity": 3.0
|
|
3054
|
-
* ...
|
|
3055
|
-
* }
|
|
3056
|
-
* ```
|
|
2393
|
+
* For more on the types of prices, see
|
|
2394
|
+
* [the core concepts documentation](/core-concepts#plan-and-price)
|
|
3057
2395
|
*/
|
|
3058
2396
|
price: PricesAPI.Price;
|
|
3059
2397
|
/**
|
|
@@ -3106,229 +2444,8 @@ export declare namespace SubscriptionFetchCostsResponse {
|
|
|
3106
2444
|
* is serialized differently in a given Price object. The model_type field
|
|
3107
2445
|
* determines the key for the configuration object that is present.
|
|
3108
2446
|
*
|
|
3109
|
-
*
|
|
3110
|
-
*
|
|
3111
|
-
* With unit pricing, each unit costs a fixed amount.
|
|
3112
|
-
*
|
|
3113
|
-
* ```json
|
|
3114
|
-
* {
|
|
3115
|
-
* ...
|
|
3116
|
-
* "model_type": "unit",
|
|
3117
|
-
* "unit_config": {
|
|
3118
|
-
* "unit_amount": "0.50"
|
|
3119
|
-
* }
|
|
3120
|
-
* ...
|
|
3121
|
-
* }
|
|
3122
|
-
* ```
|
|
3123
|
-
*
|
|
3124
|
-
* ## Tiered pricing
|
|
3125
|
-
*
|
|
3126
|
-
* In tiered pricing, the cost of a given unit depends on the tier range that it
|
|
3127
|
-
* falls into, where each tier range is defined by an upper and lower bound. For
|
|
3128
|
-
* example, the first ten units may cost $0.50 each and all units thereafter may
|
|
3129
|
-
* cost $0.10 each.
|
|
3130
|
-
*
|
|
3131
|
-
* ```json
|
|
3132
|
-
* {
|
|
3133
|
-
* ...
|
|
3134
|
-
* "model_type": "tiered",
|
|
3135
|
-
* "tiered_config": {
|
|
3136
|
-
* "tiers": [
|
|
3137
|
-
* {
|
|
3138
|
-
* "first_unit": 1,
|
|
3139
|
-
* "last_unit": 10,
|
|
3140
|
-
* "unit_amount": "0.50"
|
|
3141
|
-
* },
|
|
3142
|
-
* {
|
|
3143
|
-
* "first_unit": 11,
|
|
3144
|
-
* "last_unit": null,
|
|
3145
|
-
* "unit_amount": "0.10"
|
|
3146
|
-
* }
|
|
3147
|
-
* ]
|
|
3148
|
-
* }
|
|
3149
|
-
* ...
|
|
3150
|
-
* ```
|
|
3151
|
-
*
|
|
3152
|
-
* ## Bulk pricing
|
|
3153
|
-
*
|
|
3154
|
-
* Bulk pricing applies when the number of units determine the cost of all units.
|
|
3155
|
-
* For example, if you've bought less than 10 units, they may each be $0.50 for a
|
|
3156
|
-
* total of $5.00. Once you've bought more than 10 units, all units may now be
|
|
3157
|
-
* priced at $0.40 (i.e. 101 units total would be $40.40).
|
|
3158
|
-
*
|
|
3159
|
-
* ```json
|
|
3160
|
-
* {
|
|
3161
|
-
* ...
|
|
3162
|
-
* "model_type": "bulk",
|
|
3163
|
-
* "bulk_config": {
|
|
3164
|
-
* "tiers": [
|
|
3165
|
-
* {
|
|
3166
|
-
* "maximum_units": 10,
|
|
3167
|
-
* "unit_amount": "0.50"
|
|
3168
|
-
* },
|
|
3169
|
-
* {
|
|
3170
|
-
* "maximum_units": 1000,
|
|
3171
|
-
* "unit_amount": "0.40"
|
|
3172
|
-
* }
|
|
3173
|
-
* ]
|
|
3174
|
-
* }
|
|
3175
|
-
* ...
|
|
3176
|
-
* }
|
|
3177
|
-
* ```
|
|
3178
|
-
*
|
|
3179
|
-
* ## Package pricing
|
|
3180
|
-
*
|
|
3181
|
-
* Package pricing defines the size or granularity of a unit for billing purposes.
|
|
3182
|
-
* For example, if the package size is set to 5, then 4 units will be billed as 5
|
|
3183
|
-
* and 6 units will be billed at 10.
|
|
3184
|
-
*
|
|
3185
|
-
* ```json
|
|
3186
|
-
* {
|
|
3187
|
-
* ...
|
|
3188
|
-
* "model_type": "package",
|
|
3189
|
-
* "package_config": {
|
|
3190
|
-
* "package_amount": "0.80",
|
|
3191
|
-
* "package_size": 10
|
|
3192
|
-
* }
|
|
3193
|
-
* ...
|
|
3194
|
-
* }
|
|
3195
|
-
* ```
|
|
3196
|
-
*
|
|
3197
|
-
* ## BPS pricing
|
|
3198
|
-
*
|
|
3199
|
-
* BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
|
|
3200
|
-
* percent (the number of basis points to charge), as well as a cap per event to
|
|
3201
|
-
* assess. For example, this would allow you to assess a fee of 0.25% on every
|
|
3202
|
-
* payment you process, with a maximum charge of $25 per payment.
|
|
3203
|
-
*
|
|
3204
|
-
* ```json
|
|
3205
|
-
* {
|
|
3206
|
-
* ...
|
|
3207
|
-
* "model_type": "bps",
|
|
3208
|
-
* "bps_config": {
|
|
3209
|
-
* "bps": 125,
|
|
3210
|
-
* "per_unit_maximum": "11.00"
|
|
3211
|
-
* }
|
|
3212
|
-
* ...
|
|
3213
|
-
* }
|
|
3214
|
-
* ```
|
|
3215
|
-
*
|
|
3216
|
-
* ## Bulk BPS pricing
|
|
3217
|
-
*
|
|
3218
|
-
* Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
|
|
3219
|
-
* total quantity across all events. Similar to bulk pricing, the BPS parameters of
|
|
3220
|
-
* a given event depends on the tier range that the billing period falls into. Each
|
|
3221
|
-
* tier range is defined by an upper bound. For example, after $1.5M of payment
|
|
3222
|
-
* volume is reached, each individual payment may have a lower cap or a smaller
|
|
3223
|
-
* take-rate.
|
|
3224
|
-
*
|
|
3225
|
-
* ```json
|
|
3226
|
-
* ...
|
|
3227
|
-
* "model_type": "bulk_bps",
|
|
3228
|
-
* "bulk_bps_config": {
|
|
3229
|
-
* "tiers": [
|
|
3230
|
-
* {
|
|
3231
|
-
* "maximum_amount": "1000000.00",
|
|
3232
|
-
* "bps": 125,
|
|
3233
|
-
* "per_unit_maximum": "19.00"
|
|
3234
|
-
* },
|
|
3235
|
-
* {
|
|
3236
|
-
* "maximum_amount": null,
|
|
3237
|
-
* "bps": 115,
|
|
3238
|
-
* "per_unit_maximum": "4.00"
|
|
3239
|
-
* }
|
|
3240
|
-
* ]
|
|
3241
|
-
* }
|
|
3242
|
-
* ...
|
|
3243
|
-
* }
|
|
3244
|
-
* ```
|
|
3245
|
-
*
|
|
3246
|
-
* ## Tiered BPS pricing
|
|
3247
|
-
*
|
|
3248
|
-
* Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
|
|
3249
|
-
* event's applicable parameter is a function of its marginal addition to the
|
|
3250
|
-
* period total. Similar to tiered pricing, the BPS parameters of a given event
|
|
3251
|
-
* depends on the tier range that it falls into, where each tier range is defined
|
|
3252
|
-
* by an upper and lower bound. For example, the first few payments may have a 0.8
|
|
3253
|
-
* BPS take-rate and all payments after a specific volume may incur a take-rate of
|
|
3254
|
-
* 0.5 BPS each.
|
|
3255
|
-
*
|
|
3256
|
-
* ```json
|
|
3257
|
-
* ...
|
|
3258
|
-
* "model_type": "tiered_bps",
|
|
3259
|
-
* "tiered_bps_config": {
|
|
3260
|
-
* "tiers": [
|
|
3261
|
-
* {
|
|
3262
|
-
* "minimum_amount": "0",
|
|
3263
|
-
* "maximum_amount": "1000000.00",
|
|
3264
|
-
* "bps": 125,
|
|
3265
|
-
* "per_unit_maximum": "19.00"
|
|
3266
|
-
* },
|
|
3267
|
-
* {
|
|
3268
|
-
* "minimum_amount": "1000000.00",
|
|
3269
|
-
* "maximum_amount": null,
|
|
3270
|
-
* "bps": 115,
|
|
3271
|
-
* "per_unit_maximum": "4.00"
|
|
3272
|
-
* }
|
|
3273
|
-
* ]
|
|
3274
|
-
* }
|
|
3275
|
-
* ...
|
|
3276
|
-
* }
|
|
3277
|
-
* ```
|
|
3278
|
-
*
|
|
3279
|
-
* ## Matrix pricing
|
|
3280
|
-
*
|
|
3281
|
-
* Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
|
|
3282
|
-
* `dimensions` defines the two event property values evaluated in this pricing
|
|
3283
|
-
* model. In a one-dimensional matrix, the second value is `null`. Every
|
|
3284
|
-
* configuration has a list of `matrix_values` which give the unit prices for
|
|
3285
|
-
* specified property values. In a one-dimensional matrix, the matrix values will
|
|
3286
|
-
* have `dimension_values` where the second value of the pair is null. If an event
|
|
3287
|
-
* does not match any of the dimension values in the matrix, it will resort to the
|
|
3288
|
-
* `default_unit_amount`.
|
|
3289
|
-
*
|
|
3290
|
-
* ```json
|
|
3291
|
-
* {
|
|
3292
|
-
* "model_type": "matrix"
|
|
3293
|
-
* "matrix_config": {
|
|
3294
|
-
* "default_unit_amount": "3.00",
|
|
3295
|
-
* "dimensions": [
|
|
3296
|
-
* "cluster_name",
|
|
3297
|
-
* "region"
|
|
3298
|
-
* ],
|
|
3299
|
-
* "matrix_values": [
|
|
3300
|
-
* {
|
|
3301
|
-
* "dimension_values": [
|
|
3302
|
-
* "alpha",
|
|
3303
|
-
* "west"
|
|
3304
|
-
* ],
|
|
3305
|
-
* "unit_amount": "2.00"
|
|
3306
|
-
* },
|
|
3307
|
-
* ...
|
|
3308
|
-
* ]
|
|
3309
|
-
* }
|
|
3310
|
-
* }
|
|
3311
|
-
* ```
|
|
3312
|
-
*
|
|
3313
|
-
* ## Fixed fees
|
|
3314
|
-
*
|
|
3315
|
-
* Fixed fees are prices that are applied independent of usage quantities, and
|
|
3316
|
-
* follow unit pricing. They also have an additional parameter
|
|
3317
|
-
* `fixed_price_quantity`. If the Price represents a fixed cost, this represents
|
|
3318
|
-
* the quantity of units applied.
|
|
3319
|
-
*
|
|
3320
|
-
* ```json
|
|
3321
|
-
* {
|
|
3322
|
-
* ...
|
|
3323
|
-
* "id": "price_id",
|
|
3324
|
-
* "model_type": "unit",
|
|
3325
|
-
* "unit_config": {
|
|
3326
|
-
* "unit_amount": "2.00"
|
|
3327
|
-
* },
|
|
3328
|
-
* "fixed_price_quantity": 3.0
|
|
3329
|
-
* ...
|
|
3330
|
-
* }
|
|
3331
|
-
* ```
|
|
2447
|
+
* For more on the types of prices, see
|
|
2448
|
+
* [the core concepts documentation](/core-concepts#plan-and-price)
|
|
3332
2449
|
*/
|
|
3333
2450
|
price: PricesAPI.Price;
|
|
3334
2451
|
/**
|
|
@@ -3410,7 +2527,7 @@ export interface SubscriptionPriceIntervalsResponse {
|
|
|
3410
2527
|
* it's often desirable to have these match existing identifiers in your system. To
|
|
3411
2528
|
* avoid having to denormalize Orb ID information, you can pass in an
|
|
3412
2529
|
* `external_customer_id` with your own identifier. See
|
|
3413
|
-
* [Customer ID Aliases](
|
|
2530
|
+
* [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
|
|
3414
2531
|
* information about how these aliases work in Orb.
|
|
3415
2532
|
*
|
|
3416
2533
|
* In addition to having an identifier in your system, a customer may exist in a
|
|
@@ -3419,9 +2536,8 @@ export interface SubscriptionPriceIntervalsResponse {
|
|
|
3419
2536
|
*
|
|
3420
2537
|
* A customer also has a timezone (from the standard
|
|
3421
2538
|
* [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
|
|
3422
|
-
* your account's timezone. See
|
|
3423
|
-
*
|
|
3424
|
-
* on what this timezone parameter influences within Orb.
|
|
2539
|
+
* your account's timezone. See [Timezone localization](/essentials/timezones) for
|
|
2540
|
+
* information on what this timezone parameter influences within Orb.
|
|
3425
2541
|
*/
|
|
3426
2542
|
customer: CustomersAPI.Customer;
|
|
3427
2543
|
/**
|
|
@@ -3462,9 +2578,9 @@ export interface SubscriptionPriceIntervalsResponse {
|
|
|
3462
2578
|
*/
|
|
3463
2579
|
net_terms: number;
|
|
3464
2580
|
/**
|
|
3465
|
-
* The [Plan](
|
|
3466
|
-
*
|
|
3467
|
-
*
|
|
2581
|
+
* The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
|
2582
|
+
* subscribed to by a customer. Plans define the billing behavior of the
|
|
2583
|
+
* subscription. You can see more about how to configure prices in the
|
|
3468
2584
|
* [Price resource](/reference/price).
|
|
3469
2585
|
*/
|
|
3470
2586
|
plan: PlansAPI.Plan;
|
|
@@ -3818,229 +2934,8 @@ export declare namespace SubscriptionPriceIntervalsResponse {
|
|
|
3818
2934
|
* is serialized differently in a given Price object. The model_type field
|
|
3819
2935
|
* determines the key for the configuration object that is present.
|
|
3820
2936
|
*
|
|
3821
|
-
*
|
|
3822
|
-
*
|
|
3823
|
-
* With unit pricing, each unit costs a fixed amount.
|
|
3824
|
-
*
|
|
3825
|
-
* ```json
|
|
3826
|
-
* {
|
|
3827
|
-
* ...
|
|
3828
|
-
* "model_type": "unit",
|
|
3829
|
-
* "unit_config": {
|
|
3830
|
-
* "unit_amount": "0.50"
|
|
3831
|
-
* }
|
|
3832
|
-
* ...
|
|
3833
|
-
* }
|
|
3834
|
-
* ```
|
|
3835
|
-
*
|
|
3836
|
-
* ## Tiered pricing
|
|
3837
|
-
*
|
|
3838
|
-
* In tiered pricing, the cost of a given unit depends on the tier range that it
|
|
3839
|
-
* falls into, where each tier range is defined by an upper and lower bound. For
|
|
3840
|
-
* example, the first ten units may cost $0.50 each and all units thereafter may
|
|
3841
|
-
* cost $0.10 each.
|
|
3842
|
-
*
|
|
3843
|
-
* ```json
|
|
3844
|
-
* {
|
|
3845
|
-
* ...
|
|
3846
|
-
* "model_type": "tiered",
|
|
3847
|
-
* "tiered_config": {
|
|
3848
|
-
* "tiers": [
|
|
3849
|
-
* {
|
|
3850
|
-
* "first_unit": 1,
|
|
3851
|
-
* "last_unit": 10,
|
|
3852
|
-
* "unit_amount": "0.50"
|
|
3853
|
-
* },
|
|
3854
|
-
* {
|
|
3855
|
-
* "first_unit": 11,
|
|
3856
|
-
* "last_unit": null,
|
|
3857
|
-
* "unit_amount": "0.10"
|
|
3858
|
-
* }
|
|
3859
|
-
* ]
|
|
3860
|
-
* }
|
|
3861
|
-
* ...
|
|
3862
|
-
* ```
|
|
3863
|
-
*
|
|
3864
|
-
* ## Bulk pricing
|
|
3865
|
-
*
|
|
3866
|
-
* Bulk pricing applies when the number of units determine the cost of all units.
|
|
3867
|
-
* For example, if you've bought less than 10 units, they may each be $0.50 for a
|
|
3868
|
-
* total of $5.00. Once you've bought more than 10 units, all units may now be
|
|
3869
|
-
* priced at $0.40 (i.e. 101 units total would be $40.40).
|
|
3870
|
-
*
|
|
3871
|
-
* ```json
|
|
3872
|
-
* {
|
|
3873
|
-
* ...
|
|
3874
|
-
* "model_type": "bulk",
|
|
3875
|
-
* "bulk_config": {
|
|
3876
|
-
* "tiers": [
|
|
3877
|
-
* {
|
|
3878
|
-
* "maximum_units": 10,
|
|
3879
|
-
* "unit_amount": "0.50"
|
|
3880
|
-
* },
|
|
3881
|
-
* {
|
|
3882
|
-
* "maximum_units": 1000,
|
|
3883
|
-
* "unit_amount": "0.40"
|
|
3884
|
-
* }
|
|
3885
|
-
* ]
|
|
3886
|
-
* }
|
|
3887
|
-
* ...
|
|
3888
|
-
* }
|
|
3889
|
-
* ```
|
|
3890
|
-
*
|
|
3891
|
-
* ## Package pricing
|
|
3892
|
-
*
|
|
3893
|
-
* Package pricing defines the size or granularity of a unit for billing purposes.
|
|
3894
|
-
* For example, if the package size is set to 5, then 4 units will be billed as 5
|
|
3895
|
-
* and 6 units will be billed at 10.
|
|
3896
|
-
*
|
|
3897
|
-
* ```json
|
|
3898
|
-
* {
|
|
3899
|
-
* ...
|
|
3900
|
-
* "model_type": "package",
|
|
3901
|
-
* "package_config": {
|
|
3902
|
-
* "package_amount": "0.80",
|
|
3903
|
-
* "package_size": 10
|
|
3904
|
-
* }
|
|
3905
|
-
* ...
|
|
3906
|
-
* }
|
|
3907
|
-
* ```
|
|
3908
|
-
*
|
|
3909
|
-
* ## BPS pricing
|
|
3910
|
-
*
|
|
3911
|
-
* BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
|
|
3912
|
-
* percent (the number of basis points to charge), as well as a cap per event to
|
|
3913
|
-
* assess. For example, this would allow you to assess a fee of 0.25% on every
|
|
3914
|
-
* payment you process, with a maximum charge of $25 per payment.
|
|
3915
|
-
*
|
|
3916
|
-
* ```json
|
|
3917
|
-
* {
|
|
3918
|
-
* ...
|
|
3919
|
-
* "model_type": "bps",
|
|
3920
|
-
* "bps_config": {
|
|
3921
|
-
* "bps": 125,
|
|
3922
|
-
* "per_unit_maximum": "11.00"
|
|
3923
|
-
* }
|
|
3924
|
-
* ...
|
|
3925
|
-
* }
|
|
3926
|
-
* ```
|
|
3927
|
-
*
|
|
3928
|
-
* ## Bulk BPS pricing
|
|
3929
|
-
*
|
|
3930
|
-
* Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
|
|
3931
|
-
* total quantity across all events. Similar to bulk pricing, the BPS parameters of
|
|
3932
|
-
* a given event depends on the tier range that the billing period falls into. Each
|
|
3933
|
-
* tier range is defined by an upper bound. For example, after $1.5M of payment
|
|
3934
|
-
* volume is reached, each individual payment may have a lower cap or a smaller
|
|
3935
|
-
* take-rate.
|
|
3936
|
-
*
|
|
3937
|
-
* ```json
|
|
3938
|
-
* ...
|
|
3939
|
-
* "model_type": "bulk_bps",
|
|
3940
|
-
* "bulk_bps_config": {
|
|
3941
|
-
* "tiers": [
|
|
3942
|
-
* {
|
|
3943
|
-
* "maximum_amount": "1000000.00",
|
|
3944
|
-
* "bps": 125,
|
|
3945
|
-
* "per_unit_maximum": "19.00"
|
|
3946
|
-
* },
|
|
3947
|
-
* {
|
|
3948
|
-
* "maximum_amount": null,
|
|
3949
|
-
* "bps": 115,
|
|
3950
|
-
* "per_unit_maximum": "4.00"
|
|
3951
|
-
* }
|
|
3952
|
-
* ]
|
|
3953
|
-
* }
|
|
3954
|
-
* ...
|
|
3955
|
-
* }
|
|
3956
|
-
* ```
|
|
3957
|
-
*
|
|
3958
|
-
* ## Tiered BPS pricing
|
|
3959
|
-
*
|
|
3960
|
-
* Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
|
|
3961
|
-
* event's applicable parameter is a function of its marginal addition to the
|
|
3962
|
-
* period total. Similar to tiered pricing, the BPS parameters of a given event
|
|
3963
|
-
* depends on the tier range that it falls into, where each tier range is defined
|
|
3964
|
-
* by an upper and lower bound. For example, the first few payments may have a 0.8
|
|
3965
|
-
* BPS take-rate and all payments after a specific volume may incur a take-rate of
|
|
3966
|
-
* 0.5 BPS each.
|
|
3967
|
-
*
|
|
3968
|
-
* ```json
|
|
3969
|
-
* ...
|
|
3970
|
-
* "model_type": "tiered_bps",
|
|
3971
|
-
* "tiered_bps_config": {
|
|
3972
|
-
* "tiers": [
|
|
3973
|
-
* {
|
|
3974
|
-
* "minimum_amount": "0",
|
|
3975
|
-
* "maximum_amount": "1000000.00",
|
|
3976
|
-
* "bps": 125,
|
|
3977
|
-
* "per_unit_maximum": "19.00"
|
|
3978
|
-
* },
|
|
3979
|
-
* {
|
|
3980
|
-
* "minimum_amount": "1000000.00",
|
|
3981
|
-
* "maximum_amount": null,
|
|
3982
|
-
* "bps": 115,
|
|
3983
|
-
* "per_unit_maximum": "4.00"
|
|
3984
|
-
* }
|
|
3985
|
-
* ]
|
|
3986
|
-
* }
|
|
3987
|
-
* ...
|
|
3988
|
-
* }
|
|
3989
|
-
* ```
|
|
3990
|
-
*
|
|
3991
|
-
* ## Matrix pricing
|
|
3992
|
-
*
|
|
3993
|
-
* Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
|
|
3994
|
-
* `dimensions` defines the two event property values evaluated in this pricing
|
|
3995
|
-
* model. In a one-dimensional matrix, the second value is `null`. Every
|
|
3996
|
-
* configuration has a list of `matrix_values` which give the unit prices for
|
|
3997
|
-
* specified property values. In a one-dimensional matrix, the matrix values will
|
|
3998
|
-
* have `dimension_values` where the second value of the pair is null. If an event
|
|
3999
|
-
* does not match any of the dimension values in the matrix, it will resort to the
|
|
4000
|
-
* `default_unit_amount`.
|
|
4001
|
-
*
|
|
4002
|
-
* ```json
|
|
4003
|
-
* {
|
|
4004
|
-
* "model_type": "matrix"
|
|
4005
|
-
* "matrix_config": {
|
|
4006
|
-
* "default_unit_amount": "3.00",
|
|
4007
|
-
* "dimensions": [
|
|
4008
|
-
* "cluster_name",
|
|
4009
|
-
* "region"
|
|
4010
|
-
* ],
|
|
4011
|
-
* "matrix_values": [
|
|
4012
|
-
* {
|
|
4013
|
-
* "dimension_values": [
|
|
4014
|
-
* "alpha",
|
|
4015
|
-
* "west"
|
|
4016
|
-
* ],
|
|
4017
|
-
* "unit_amount": "2.00"
|
|
4018
|
-
* },
|
|
4019
|
-
* ...
|
|
4020
|
-
* ]
|
|
4021
|
-
* }
|
|
4022
|
-
* }
|
|
4023
|
-
* ```
|
|
4024
|
-
*
|
|
4025
|
-
* ## Fixed fees
|
|
4026
|
-
*
|
|
4027
|
-
* Fixed fees are prices that are applied independent of usage quantities, and
|
|
4028
|
-
* follow unit pricing. They also have an additional parameter
|
|
4029
|
-
* `fixed_price_quantity`. If the Price represents a fixed cost, this represents
|
|
4030
|
-
* the quantity of units applied.
|
|
4031
|
-
*
|
|
4032
|
-
* ```json
|
|
4033
|
-
* {
|
|
4034
|
-
* ...
|
|
4035
|
-
* "id": "price_id",
|
|
4036
|
-
* "model_type": "unit",
|
|
4037
|
-
* "unit_config": {
|
|
4038
|
-
* "unit_amount": "2.00"
|
|
4039
|
-
* },
|
|
4040
|
-
* "fixed_price_quantity": 3.0
|
|
4041
|
-
* ...
|
|
4042
|
-
* }
|
|
4043
|
-
* ```
|
|
2937
|
+
* For more on the types of prices, see
|
|
2938
|
+
* [the core concepts documentation](/core-concepts#plan-and-price)
|
|
4044
2939
|
*/
|
|
4045
2940
|
price: PricesAPI.Price;
|
|
4046
2941
|
/**
|
|
@@ -4111,7 +3006,7 @@ export interface SubscriptionSchedulePlanChangeResponse {
|
|
|
4111
3006
|
* it's often desirable to have these match existing identifiers in your system. To
|
|
4112
3007
|
* avoid having to denormalize Orb ID information, you can pass in an
|
|
4113
3008
|
* `external_customer_id` with your own identifier. See
|
|
4114
|
-
* [Customer ID Aliases](
|
|
3009
|
+
* [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
|
|
4115
3010
|
* information about how these aliases work in Orb.
|
|
4116
3011
|
*
|
|
4117
3012
|
* In addition to having an identifier in your system, a customer may exist in a
|
|
@@ -4120,9 +3015,8 @@ export interface SubscriptionSchedulePlanChangeResponse {
|
|
|
4120
3015
|
*
|
|
4121
3016
|
* A customer also has a timezone (from the standard
|
|
4122
3017
|
* [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
|
|
4123
|
-
* your account's timezone. See
|
|
4124
|
-
*
|
|
4125
|
-
* on what this timezone parameter influences within Orb.
|
|
3018
|
+
* your account's timezone. See [Timezone localization](/essentials/timezones) for
|
|
3019
|
+
* information on what this timezone parameter influences within Orb.
|
|
4126
3020
|
*/
|
|
4127
3021
|
customer: CustomersAPI.Customer;
|
|
4128
3022
|
/**
|
|
@@ -4163,9 +3057,9 @@ export interface SubscriptionSchedulePlanChangeResponse {
|
|
|
4163
3057
|
*/
|
|
4164
3058
|
net_terms: number;
|
|
4165
3059
|
/**
|
|
4166
|
-
* The [Plan](
|
|
4167
|
-
*
|
|
4168
|
-
*
|
|
3060
|
+
* The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
|
3061
|
+
* subscribed to by a customer. Plans define the billing behavior of the
|
|
3062
|
+
* subscription. You can see more about how to configure prices in the
|
|
4169
3063
|
* [Price resource](/reference/price).
|
|
4170
3064
|
*/
|
|
4171
3065
|
plan: PlansAPI.Plan;
|
|
@@ -4519,229 +3413,8 @@ export declare namespace SubscriptionSchedulePlanChangeResponse {
|
|
|
4519
3413
|
* is serialized differently in a given Price object. The model_type field
|
|
4520
3414
|
* determines the key for the configuration object that is present.
|
|
4521
3415
|
*
|
|
4522
|
-
*
|
|
4523
|
-
*
|
|
4524
|
-
* With unit pricing, each unit costs a fixed amount.
|
|
4525
|
-
*
|
|
4526
|
-
* ```json
|
|
4527
|
-
* {
|
|
4528
|
-
* ...
|
|
4529
|
-
* "model_type": "unit",
|
|
4530
|
-
* "unit_config": {
|
|
4531
|
-
* "unit_amount": "0.50"
|
|
4532
|
-
* }
|
|
4533
|
-
* ...
|
|
4534
|
-
* }
|
|
4535
|
-
* ```
|
|
4536
|
-
*
|
|
4537
|
-
* ## Tiered pricing
|
|
4538
|
-
*
|
|
4539
|
-
* In tiered pricing, the cost of a given unit depends on the tier range that it
|
|
4540
|
-
* falls into, where each tier range is defined by an upper and lower bound. For
|
|
4541
|
-
* example, the first ten units may cost $0.50 each and all units thereafter may
|
|
4542
|
-
* cost $0.10 each.
|
|
4543
|
-
*
|
|
4544
|
-
* ```json
|
|
4545
|
-
* {
|
|
4546
|
-
* ...
|
|
4547
|
-
* "model_type": "tiered",
|
|
4548
|
-
* "tiered_config": {
|
|
4549
|
-
* "tiers": [
|
|
4550
|
-
* {
|
|
4551
|
-
* "first_unit": 1,
|
|
4552
|
-
* "last_unit": 10,
|
|
4553
|
-
* "unit_amount": "0.50"
|
|
4554
|
-
* },
|
|
4555
|
-
* {
|
|
4556
|
-
* "first_unit": 11,
|
|
4557
|
-
* "last_unit": null,
|
|
4558
|
-
* "unit_amount": "0.10"
|
|
4559
|
-
* }
|
|
4560
|
-
* ]
|
|
4561
|
-
* }
|
|
4562
|
-
* ...
|
|
4563
|
-
* ```
|
|
4564
|
-
*
|
|
4565
|
-
* ## Bulk pricing
|
|
4566
|
-
*
|
|
4567
|
-
* Bulk pricing applies when the number of units determine the cost of all units.
|
|
4568
|
-
* For example, if you've bought less than 10 units, they may each be $0.50 for a
|
|
4569
|
-
* total of $5.00. Once you've bought more than 10 units, all units may now be
|
|
4570
|
-
* priced at $0.40 (i.e. 101 units total would be $40.40).
|
|
4571
|
-
*
|
|
4572
|
-
* ```json
|
|
4573
|
-
* {
|
|
4574
|
-
* ...
|
|
4575
|
-
* "model_type": "bulk",
|
|
4576
|
-
* "bulk_config": {
|
|
4577
|
-
* "tiers": [
|
|
4578
|
-
* {
|
|
4579
|
-
* "maximum_units": 10,
|
|
4580
|
-
* "unit_amount": "0.50"
|
|
4581
|
-
* },
|
|
4582
|
-
* {
|
|
4583
|
-
* "maximum_units": 1000,
|
|
4584
|
-
* "unit_amount": "0.40"
|
|
4585
|
-
* }
|
|
4586
|
-
* ]
|
|
4587
|
-
* }
|
|
4588
|
-
* ...
|
|
4589
|
-
* }
|
|
4590
|
-
* ```
|
|
4591
|
-
*
|
|
4592
|
-
* ## Package pricing
|
|
4593
|
-
*
|
|
4594
|
-
* Package pricing defines the size or granularity of a unit for billing purposes.
|
|
4595
|
-
* For example, if the package size is set to 5, then 4 units will be billed as 5
|
|
4596
|
-
* and 6 units will be billed at 10.
|
|
4597
|
-
*
|
|
4598
|
-
* ```json
|
|
4599
|
-
* {
|
|
4600
|
-
* ...
|
|
4601
|
-
* "model_type": "package",
|
|
4602
|
-
* "package_config": {
|
|
4603
|
-
* "package_amount": "0.80",
|
|
4604
|
-
* "package_size": 10
|
|
4605
|
-
* }
|
|
4606
|
-
* ...
|
|
4607
|
-
* }
|
|
4608
|
-
* ```
|
|
4609
|
-
*
|
|
4610
|
-
* ## BPS pricing
|
|
4611
|
-
*
|
|
4612
|
-
* BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
|
|
4613
|
-
* percent (the number of basis points to charge), as well as a cap per event to
|
|
4614
|
-
* assess. For example, this would allow you to assess a fee of 0.25% on every
|
|
4615
|
-
* payment you process, with a maximum charge of $25 per payment.
|
|
4616
|
-
*
|
|
4617
|
-
* ```json
|
|
4618
|
-
* {
|
|
4619
|
-
* ...
|
|
4620
|
-
* "model_type": "bps",
|
|
4621
|
-
* "bps_config": {
|
|
4622
|
-
* "bps": 125,
|
|
4623
|
-
* "per_unit_maximum": "11.00"
|
|
4624
|
-
* }
|
|
4625
|
-
* ...
|
|
4626
|
-
* }
|
|
4627
|
-
* ```
|
|
4628
|
-
*
|
|
4629
|
-
* ## Bulk BPS pricing
|
|
4630
|
-
*
|
|
4631
|
-
* Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
|
|
4632
|
-
* total quantity across all events. Similar to bulk pricing, the BPS parameters of
|
|
4633
|
-
* a given event depends on the tier range that the billing period falls into. Each
|
|
4634
|
-
* tier range is defined by an upper bound. For example, after $1.5M of payment
|
|
4635
|
-
* volume is reached, each individual payment may have a lower cap or a smaller
|
|
4636
|
-
* take-rate.
|
|
4637
|
-
*
|
|
4638
|
-
* ```json
|
|
4639
|
-
* ...
|
|
4640
|
-
* "model_type": "bulk_bps",
|
|
4641
|
-
* "bulk_bps_config": {
|
|
4642
|
-
* "tiers": [
|
|
4643
|
-
* {
|
|
4644
|
-
* "maximum_amount": "1000000.00",
|
|
4645
|
-
* "bps": 125,
|
|
4646
|
-
* "per_unit_maximum": "19.00"
|
|
4647
|
-
* },
|
|
4648
|
-
* {
|
|
4649
|
-
* "maximum_amount": null,
|
|
4650
|
-
* "bps": 115,
|
|
4651
|
-
* "per_unit_maximum": "4.00"
|
|
4652
|
-
* }
|
|
4653
|
-
* ]
|
|
4654
|
-
* }
|
|
4655
|
-
* ...
|
|
4656
|
-
* }
|
|
4657
|
-
* ```
|
|
4658
|
-
*
|
|
4659
|
-
* ## Tiered BPS pricing
|
|
4660
|
-
*
|
|
4661
|
-
* Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
|
|
4662
|
-
* event's applicable parameter is a function of its marginal addition to the
|
|
4663
|
-
* period total. Similar to tiered pricing, the BPS parameters of a given event
|
|
4664
|
-
* depends on the tier range that it falls into, where each tier range is defined
|
|
4665
|
-
* by an upper and lower bound. For example, the first few payments may have a 0.8
|
|
4666
|
-
* BPS take-rate and all payments after a specific volume may incur a take-rate of
|
|
4667
|
-
* 0.5 BPS each.
|
|
4668
|
-
*
|
|
4669
|
-
* ```json
|
|
4670
|
-
* ...
|
|
4671
|
-
* "model_type": "tiered_bps",
|
|
4672
|
-
* "tiered_bps_config": {
|
|
4673
|
-
* "tiers": [
|
|
4674
|
-
* {
|
|
4675
|
-
* "minimum_amount": "0",
|
|
4676
|
-
* "maximum_amount": "1000000.00",
|
|
4677
|
-
* "bps": 125,
|
|
4678
|
-
* "per_unit_maximum": "19.00"
|
|
4679
|
-
* },
|
|
4680
|
-
* {
|
|
4681
|
-
* "minimum_amount": "1000000.00",
|
|
4682
|
-
* "maximum_amount": null,
|
|
4683
|
-
* "bps": 115,
|
|
4684
|
-
* "per_unit_maximum": "4.00"
|
|
4685
|
-
* }
|
|
4686
|
-
* ]
|
|
4687
|
-
* }
|
|
4688
|
-
* ...
|
|
4689
|
-
* }
|
|
4690
|
-
* ```
|
|
4691
|
-
*
|
|
4692
|
-
* ## Matrix pricing
|
|
4693
|
-
*
|
|
4694
|
-
* Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
|
|
4695
|
-
* `dimensions` defines the two event property values evaluated in this pricing
|
|
4696
|
-
* model. In a one-dimensional matrix, the second value is `null`. Every
|
|
4697
|
-
* configuration has a list of `matrix_values` which give the unit prices for
|
|
4698
|
-
* specified property values. In a one-dimensional matrix, the matrix values will
|
|
4699
|
-
* have `dimension_values` where the second value of the pair is null. If an event
|
|
4700
|
-
* does not match any of the dimension values in the matrix, it will resort to the
|
|
4701
|
-
* `default_unit_amount`.
|
|
4702
|
-
*
|
|
4703
|
-
* ```json
|
|
4704
|
-
* {
|
|
4705
|
-
* "model_type": "matrix"
|
|
4706
|
-
* "matrix_config": {
|
|
4707
|
-
* "default_unit_amount": "3.00",
|
|
4708
|
-
* "dimensions": [
|
|
4709
|
-
* "cluster_name",
|
|
4710
|
-
* "region"
|
|
4711
|
-
* ],
|
|
4712
|
-
* "matrix_values": [
|
|
4713
|
-
* {
|
|
4714
|
-
* "dimension_values": [
|
|
4715
|
-
* "alpha",
|
|
4716
|
-
* "west"
|
|
4717
|
-
* ],
|
|
4718
|
-
* "unit_amount": "2.00"
|
|
4719
|
-
* },
|
|
4720
|
-
* ...
|
|
4721
|
-
* ]
|
|
4722
|
-
* }
|
|
4723
|
-
* }
|
|
4724
|
-
* ```
|
|
4725
|
-
*
|
|
4726
|
-
* ## Fixed fees
|
|
4727
|
-
*
|
|
4728
|
-
* Fixed fees are prices that are applied independent of usage quantities, and
|
|
4729
|
-
* follow unit pricing. They also have an additional parameter
|
|
4730
|
-
* `fixed_price_quantity`. If the Price represents a fixed cost, this represents
|
|
4731
|
-
* the quantity of units applied.
|
|
4732
|
-
*
|
|
4733
|
-
* ```json
|
|
4734
|
-
* {
|
|
4735
|
-
* ...
|
|
4736
|
-
* "id": "price_id",
|
|
4737
|
-
* "model_type": "unit",
|
|
4738
|
-
* "unit_config": {
|
|
4739
|
-
* "unit_amount": "2.00"
|
|
4740
|
-
* },
|
|
4741
|
-
* "fixed_price_quantity": 3.0
|
|
4742
|
-
* ...
|
|
4743
|
-
* }
|
|
4744
|
-
* ```
|
|
3416
|
+
* For more on the types of prices, see
|
|
3417
|
+
* [the core concepts documentation](/core-concepts#plan-and-price)
|
|
4745
3418
|
*/
|
|
4746
3419
|
price: PricesAPI.Price;
|
|
4747
3420
|
/**
|
|
@@ -4812,7 +3485,7 @@ export interface SubscriptionTriggerPhaseResponse {
|
|
|
4812
3485
|
* it's often desirable to have these match existing identifiers in your system. To
|
|
4813
3486
|
* avoid having to denormalize Orb ID information, you can pass in an
|
|
4814
3487
|
* `external_customer_id` with your own identifier. See
|
|
4815
|
-
* [Customer ID Aliases](
|
|
3488
|
+
* [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
|
|
4816
3489
|
* information about how these aliases work in Orb.
|
|
4817
3490
|
*
|
|
4818
3491
|
* In addition to having an identifier in your system, a customer may exist in a
|
|
@@ -4821,9 +3494,8 @@ export interface SubscriptionTriggerPhaseResponse {
|
|
|
4821
3494
|
*
|
|
4822
3495
|
* A customer also has a timezone (from the standard
|
|
4823
3496
|
* [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
|
|
4824
|
-
* your account's timezone. See
|
|
4825
|
-
*
|
|
4826
|
-
* on what this timezone parameter influences within Orb.
|
|
3497
|
+
* your account's timezone. See [Timezone localization](/essentials/timezones) for
|
|
3498
|
+
* information on what this timezone parameter influences within Orb.
|
|
4827
3499
|
*/
|
|
4828
3500
|
customer: CustomersAPI.Customer;
|
|
4829
3501
|
/**
|
|
@@ -4864,9 +3536,9 @@ export interface SubscriptionTriggerPhaseResponse {
|
|
|
4864
3536
|
*/
|
|
4865
3537
|
net_terms: number;
|
|
4866
3538
|
/**
|
|
4867
|
-
* The [Plan](
|
|
4868
|
-
*
|
|
4869
|
-
*
|
|
3539
|
+
* The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
|
3540
|
+
* subscribed to by a customer. Plans define the billing behavior of the
|
|
3541
|
+
* subscription. You can see more about how to configure prices in the
|
|
4870
3542
|
* [Price resource](/reference/price).
|
|
4871
3543
|
*/
|
|
4872
3544
|
plan: PlansAPI.Plan;
|
|
@@ -5220,229 +3892,8 @@ export declare namespace SubscriptionTriggerPhaseResponse {
|
|
|
5220
3892
|
* is serialized differently in a given Price object. The model_type field
|
|
5221
3893
|
* determines the key for the configuration object that is present.
|
|
5222
3894
|
*
|
|
5223
|
-
*
|
|
5224
|
-
*
|
|
5225
|
-
* With unit pricing, each unit costs a fixed amount.
|
|
5226
|
-
*
|
|
5227
|
-
* ```json
|
|
5228
|
-
* {
|
|
5229
|
-
* ...
|
|
5230
|
-
* "model_type": "unit",
|
|
5231
|
-
* "unit_config": {
|
|
5232
|
-
* "unit_amount": "0.50"
|
|
5233
|
-
* }
|
|
5234
|
-
* ...
|
|
5235
|
-
* }
|
|
5236
|
-
* ```
|
|
5237
|
-
*
|
|
5238
|
-
* ## Tiered pricing
|
|
5239
|
-
*
|
|
5240
|
-
* In tiered pricing, the cost of a given unit depends on the tier range that it
|
|
5241
|
-
* falls into, where each tier range is defined by an upper and lower bound. For
|
|
5242
|
-
* example, the first ten units may cost $0.50 each and all units thereafter may
|
|
5243
|
-
* cost $0.10 each.
|
|
5244
|
-
*
|
|
5245
|
-
* ```json
|
|
5246
|
-
* {
|
|
5247
|
-
* ...
|
|
5248
|
-
* "model_type": "tiered",
|
|
5249
|
-
* "tiered_config": {
|
|
5250
|
-
* "tiers": [
|
|
5251
|
-
* {
|
|
5252
|
-
* "first_unit": 1,
|
|
5253
|
-
* "last_unit": 10,
|
|
5254
|
-
* "unit_amount": "0.50"
|
|
5255
|
-
* },
|
|
5256
|
-
* {
|
|
5257
|
-
* "first_unit": 11,
|
|
5258
|
-
* "last_unit": null,
|
|
5259
|
-
* "unit_amount": "0.10"
|
|
5260
|
-
* }
|
|
5261
|
-
* ]
|
|
5262
|
-
* }
|
|
5263
|
-
* ...
|
|
5264
|
-
* ```
|
|
5265
|
-
*
|
|
5266
|
-
* ## Bulk pricing
|
|
5267
|
-
*
|
|
5268
|
-
* Bulk pricing applies when the number of units determine the cost of all units.
|
|
5269
|
-
* For example, if you've bought less than 10 units, they may each be $0.50 for a
|
|
5270
|
-
* total of $5.00. Once you've bought more than 10 units, all units may now be
|
|
5271
|
-
* priced at $0.40 (i.e. 101 units total would be $40.40).
|
|
5272
|
-
*
|
|
5273
|
-
* ```json
|
|
5274
|
-
* {
|
|
5275
|
-
* ...
|
|
5276
|
-
* "model_type": "bulk",
|
|
5277
|
-
* "bulk_config": {
|
|
5278
|
-
* "tiers": [
|
|
5279
|
-
* {
|
|
5280
|
-
* "maximum_units": 10,
|
|
5281
|
-
* "unit_amount": "0.50"
|
|
5282
|
-
* },
|
|
5283
|
-
* {
|
|
5284
|
-
* "maximum_units": 1000,
|
|
5285
|
-
* "unit_amount": "0.40"
|
|
5286
|
-
* }
|
|
5287
|
-
* ]
|
|
5288
|
-
* }
|
|
5289
|
-
* ...
|
|
5290
|
-
* }
|
|
5291
|
-
* ```
|
|
5292
|
-
*
|
|
5293
|
-
* ## Package pricing
|
|
5294
|
-
*
|
|
5295
|
-
* Package pricing defines the size or granularity of a unit for billing purposes.
|
|
5296
|
-
* For example, if the package size is set to 5, then 4 units will be billed as 5
|
|
5297
|
-
* and 6 units will be billed at 10.
|
|
5298
|
-
*
|
|
5299
|
-
* ```json
|
|
5300
|
-
* {
|
|
5301
|
-
* ...
|
|
5302
|
-
* "model_type": "package",
|
|
5303
|
-
* "package_config": {
|
|
5304
|
-
* "package_amount": "0.80",
|
|
5305
|
-
* "package_size": 10
|
|
5306
|
-
* }
|
|
5307
|
-
* ...
|
|
5308
|
-
* }
|
|
5309
|
-
* ```
|
|
5310
|
-
*
|
|
5311
|
-
* ## BPS pricing
|
|
5312
|
-
*
|
|
5313
|
-
* BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
|
|
5314
|
-
* percent (the number of basis points to charge), as well as a cap per event to
|
|
5315
|
-
* assess. For example, this would allow you to assess a fee of 0.25% on every
|
|
5316
|
-
* payment you process, with a maximum charge of $25 per payment.
|
|
5317
|
-
*
|
|
5318
|
-
* ```json
|
|
5319
|
-
* {
|
|
5320
|
-
* ...
|
|
5321
|
-
* "model_type": "bps",
|
|
5322
|
-
* "bps_config": {
|
|
5323
|
-
* "bps": 125,
|
|
5324
|
-
* "per_unit_maximum": "11.00"
|
|
5325
|
-
* }
|
|
5326
|
-
* ...
|
|
5327
|
-
* }
|
|
5328
|
-
* ```
|
|
5329
|
-
*
|
|
5330
|
-
* ## Bulk BPS pricing
|
|
5331
|
-
*
|
|
5332
|
-
* Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
|
|
5333
|
-
* total quantity across all events. Similar to bulk pricing, the BPS parameters of
|
|
5334
|
-
* a given event depends on the tier range that the billing period falls into. Each
|
|
5335
|
-
* tier range is defined by an upper bound. For example, after $1.5M of payment
|
|
5336
|
-
* volume is reached, each individual payment may have a lower cap or a smaller
|
|
5337
|
-
* take-rate.
|
|
5338
|
-
*
|
|
5339
|
-
* ```json
|
|
5340
|
-
* ...
|
|
5341
|
-
* "model_type": "bulk_bps",
|
|
5342
|
-
* "bulk_bps_config": {
|
|
5343
|
-
* "tiers": [
|
|
5344
|
-
* {
|
|
5345
|
-
* "maximum_amount": "1000000.00",
|
|
5346
|
-
* "bps": 125,
|
|
5347
|
-
* "per_unit_maximum": "19.00"
|
|
5348
|
-
* },
|
|
5349
|
-
* {
|
|
5350
|
-
* "maximum_amount": null,
|
|
5351
|
-
* "bps": 115,
|
|
5352
|
-
* "per_unit_maximum": "4.00"
|
|
5353
|
-
* }
|
|
5354
|
-
* ]
|
|
5355
|
-
* }
|
|
5356
|
-
* ...
|
|
5357
|
-
* }
|
|
5358
|
-
* ```
|
|
5359
|
-
*
|
|
5360
|
-
* ## Tiered BPS pricing
|
|
5361
|
-
*
|
|
5362
|
-
* Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
|
|
5363
|
-
* event's applicable parameter is a function of its marginal addition to the
|
|
5364
|
-
* period total. Similar to tiered pricing, the BPS parameters of a given event
|
|
5365
|
-
* depends on the tier range that it falls into, where each tier range is defined
|
|
5366
|
-
* by an upper and lower bound. For example, the first few payments may have a 0.8
|
|
5367
|
-
* BPS take-rate and all payments after a specific volume may incur a take-rate of
|
|
5368
|
-
* 0.5 BPS each.
|
|
5369
|
-
*
|
|
5370
|
-
* ```json
|
|
5371
|
-
* ...
|
|
5372
|
-
* "model_type": "tiered_bps",
|
|
5373
|
-
* "tiered_bps_config": {
|
|
5374
|
-
* "tiers": [
|
|
5375
|
-
* {
|
|
5376
|
-
* "minimum_amount": "0",
|
|
5377
|
-
* "maximum_amount": "1000000.00",
|
|
5378
|
-
* "bps": 125,
|
|
5379
|
-
* "per_unit_maximum": "19.00"
|
|
5380
|
-
* },
|
|
5381
|
-
* {
|
|
5382
|
-
* "minimum_amount": "1000000.00",
|
|
5383
|
-
* "maximum_amount": null,
|
|
5384
|
-
* "bps": 115,
|
|
5385
|
-
* "per_unit_maximum": "4.00"
|
|
5386
|
-
* }
|
|
5387
|
-
* ]
|
|
5388
|
-
* }
|
|
5389
|
-
* ...
|
|
5390
|
-
* }
|
|
5391
|
-
* ```
|
|
5392
|
-
*
|
|
5393
|
-
* ## Matrix pricing
|
|
5394
|
-
*
|
|
5395
|
-
* Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
|
|
5396
|
-
* `dimensions` defines the two event property values evaluated in this pricing
|
|
5397
|
-
* model. In a one-dimensional matrix, the second value is `null`. Every
|
|
5398
|
-
* configuration has a list of `matrix_values` which give the unit prices for
|
|
5399
|
-
* specified property values. In a one-dimensional matrix, the matrix values will
|
|
5400
|
-
* have `dimension_values` where the second value of the pair is null. If an event
|
|
5401
|
-
* does not match any of the dimension values in the matrix, it will resort to the
|
|
5402
|
-
* `default_unit_amount`.
|
|
5403
|
-
*
|
|
5404
|
-
* ```json
|
|
5405
|
-
* {
|
|
5406
|
-
* "model_type": "matrix"
|
|
5407
|
-
* "matrix_config": {
|
|
5408
|
-
* "default_unit_amount": "3.00",
|
|
5409
|
-
* "dimensions": [
|
|
5410
|
-
* "cluster_name",
|
|
5411
|
-
* "region"
|
|
5412
|
-
* ],
|
|
5413
|
-
* "matrix_values": [
|
|
5414
|
-
* {
|
|
5415
|
-
* "dimension_values": [
|
|
5416
|
-
* "alpha",
|
|
5417
|
-
* "west"
|
|
5418
|
-
* ],
|
|
5419
|
-
* "unit_amount": "2.00"
|
|
5420
|
-
* },
|
|
5421
|
-
* ...
|
|
5422
|
-
* ]
|
|
5423
|
-
* }
|
|
5424
|
-
* }
|
|
5425
|
-
* ```
|
|
5426
|
-
*
|
|
5427
|
-
* ## Fixed fees
|
|
5428
|
-
*
|
|
5429
|
-
* Fixed fees are prices that are applied independent of usage quantities, and
|
|
5430
|
-
* follow unit pricing. They also have an additional parameter
|
|
5431
|
-
* `fixed_price_quantity`. If the Price represents a fixed cost, this represents
|
|
5432
|
-
* the quantity of units applied.
|
|
5433
|
-
*
|
|
5434
|
-
* ```json
|
|
5435
|
-
* {
|
|
5436
|
-
* ...
|
|
5437
|
-
* "id": "price_id",
|
|
5438
|
-
* "model_type": "unit",
|
|
5439
|
-
* "unit_config": {
|
|
5440
|
-
* "unit_amount": "2.00"
|
|
5441
|
-
* },
|
|
5442
|
-
* "fixed_price_quantity": 3.0
|
|
5443
|
-
* ...
|
|
5444
|
-
* }
|
|
5445
|
-
* ```
|
|
3895
|
+
* For more on the types of prices, see
|
|
3896
|
+
* [the core concepts documentation](/core-concepts#plan-and-price)
|
|
5446
3897
|
*/
|
|
5447
3898
|
price: PricesAPI.Price;
|
|
5448
3899
|
/**
|
|
@@ -5513,7 +3964,7 @@ export interface SubscriptionUnscheduleCancellationResponse {
|
|
|
5513
3964
|
* it's often desirable to have these match existing identifiers in your system. To
|
|
5514
3965
|
* avoid having to denormalize Orb ID information, you can pass in an
|
|
5515
3966
|
* `external_customer_id` with your own identifier. See
|
|
5516
|
-
* [Customer ID Aliases](
|
|
3967
|
+
* [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
|
|
5517
3968
|
* information about how these aliases work in Orb.
|
|
5518
3969
|
*
|
|
5519
3970
|
* In addition to having an identifier in your system, a customer may exist in a
|
|
@@ -5522,9 +3973,8 @@ export interface SubscriptionUnscheduleCancellationResponse {
|
|
|
5522
3973
|
*
|
|
5523
3974
|
* A customer also has a timezone (from the standard
|
|
5524
3975
|
* [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
|
|
5525
|
-
* your account's timezone. See
|
|
5526
|
-
*
|
|
5527
|
-
* on what this timezone parameter influences within Orb.
|
|
3976
|
+
* your account's timezone. See [Timezone localization](/essentials/timezones) for
|
|
3977
|
+
* information on what this timezone parameter influences within Orb.
|
|
5528
3978
|
*/
|
|
5529
3979
|
customer: CustomersAPI.Customer;
|
|
5530
3980
|
/**
|
|
@@ -5565,9 +4015,9 @@ export interface SubscriptionUnscheduleCancellationResponse {
|
|
|
5565
4015
|
*/
|
|
5566
4016
|
net_terms: number;
|
|
5567
4017
|
/**
|
|
5568
|
-
* The [Plan](
|
|
5569
|
-
*
|
|
5570
|
-
*
|
|
4018
|
+
* The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
|
4019
|
+
* subscribed to by a customer. Plans define the billing behavior of the
|
|
4020
|
+
* subscription. You can see more about how to configure prices in the
|
|
5571
4021
|
* [Price resource](/reference/price).
|
|
5572
4022
|
*/
|
|
5573
4023
|
plan: PlansAPI.Plan;
|
|
@@ -5921,229 +4371,8 @@ export declare namespace SubscriptionUnscheduleCancellationResponse {
|
|
|
5921
4371
|
* is serialized differently in a given Price object. The model_type field
|
|
5922
4372
|
* determines the key for the configuration object that is present.
|
|
5923
4373
|
*
|
|
5924
|
-
*
|
|
5925
|
-
*
|
|
5926
|
-
* With unit pricing, each unit costs a fixed amount.
|
|
5927
|
-
*
|
|
5928
|
-
* ```json
|
|
5929
|
-
* {
|
|
5930
|
-
* ...
|
|
5931
|
-
* "model_type": "unit",
|
|
5932
|
-
* "unit_config": {
|
|
5933
|
-
* "unit_amount": "0.50"
|
|
5934
|
-
* }
|
|
5935
|
-
* ...
|
|
5936
|
-
* }
|
|
5937
|
-
* ```
|
|
5938
|
-
*
|
|
5939
|
-
* ## Tiered pricing
|
|
5940
|
-
*
|
|
5941
|
-
* In tiered pricing, the cost of a given unit depends on the tier range that it
|
|
5942
|
-
* falls into, where each tier range is defined by an upper and lower bound. For
|
|
5943
|
-
* example, the first ten units may cost $0.50 each and all units thereafter may
|
|
5944
|
-
* cost $0.10 each.
|
|
5945
|
-
*
|
|
5946
|
-
* ```json
|
|
5947
|
-
* {
|
|
5948
|
-
* ...
|
|
5949
|
-
* "model_type": "tiered",
|
|
5950
|
-
* "tiered_config": {
|
|
5951
|
-
* "tiers": [
|
|
5952
|
-
* {
|
|
5953
|
-
* "first_unit": 1,
|
|
5954
|
-
* "last_unit": 10,
|
|
5955
|
-
* "unit_amount": "0.50"
|
|
5956
|
-
* },
|
|
5957
|
-
* {
|
|
5958
|
-
* "first_unit": 11,
|
|
5959
|
-
* "last_unit": null,
|
|
5960
|
-
* "unit_amount": "0.10"
|
|
5961
|
-
* }
|
|
5962
|
-
* ]
|
|
5963
|
-
* }
|
|
5964
|
-
* ...
|
|
5965
|
-
* ```
|
|
5966
|
-
*
|
|
5967
|
-
* ## Bulk pricing
|
|
5968
|
-
*
|
|
5969
|
-
* Bulk pricing applies when the number of units determine the cost of all units.
|
|
5970
|
-
* For example, if you've bought less than 10 units, they may each be $0.50 for a
|
|
5971
|
-
* total of $5.00. Once you've bought more than 10 units, all units may now be
|
|
5972
|
-
* priced at $0.40 (i.e. 101 units total would be $40.40).
|
|
5973
|
-
*
|
|
5974
|
-
* ```json
|
|
5975
|
-
* {
|
|
5976
|
-
* ...
|
|
5977
|
-
* "model_type": "bulk",
|
|
5978
|
-
* "bulk_config": {
|
|
5979
|
-
* "tiers": [
|
|
5980
|
-
* {
|
|
5981
|
-
* "maximum_units": 10,
|
|
5982
|
-
* "unit_amount": "0.50"
|
|
5983
|
-
* },
|
|
5984
|
-
* {
|
|
5985
|
-
* "maximum_units": 1000,
|
|
5986
|
-
* "unit_amount": "0.40"
|
|
5987
|
-
* }
|
|
5988
|
-
* ]
|
|
5989
|
-
* }
|
|
5990
|
-
* ...
|
|
5991
|
-
* }
|
|
5992
|
-
* ```
|
|
5993
|
-
*
|
|
5994
|
-
* ## Package pricing
|
|
5995
|
-
*
|
|
5996
|
-
* Package pricing defines the size or granularity of a unit for billing purposes.
|
|
5997
|
-
* For example, if the package size is set to 5, then 4 units will be billed as 5
|
|
5998
|
-
* and 6 units will be billed at 10.
|
|
5999
|
-
*
|
|
6000
|
-
* ```json
|
|
6001
|
-
* {
|
|
6002
|
-
* ...
|
|
6003
|
-
* "model_type": "package",
|
|
6004
|
-
* "package_config": {
|
|
6005
|
-
* "package_amount": "0.80",
|
|
6006
|
-
* "package_size": 10
|
|
6007
|
-
* }
|
|
6008
|
-
* ...
|
|
6009
|
-
* }
|
|
6010
|
-
* ```
|
|
6011
|
-
*
|
|
6012
|
-
* ## BPS pricing
|
|
6013
|
-
*
|
|
6014
|
-
* BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
|
|
6015
|
-
* percent (the number of basis points to charge), as well as a cap per event to
|
|
6016
|
-
* assess. For example, this would allow you to assess a fee of 0.25% on every
|
|
6017
|
-
* payment you process, with a maximum charge of $25 per payment.
|
|
6018
|
-
*
|
|
6019
|
-
* ```json
|
|
6020
|
-
* {
|
|
6021
|
-
* ...
|
|
6022
|
-
* "model_type": "bps",
|
|
6023
|
-
* "bps_config": {
|
|
6024
|
-
* "bps": 125,
|
|
6025
|
-
* "per_unit_maximum": "11.00"
|
|
6026
|
-
* }
|
|
6027
|
-
* ...
|
|
6028
|
-
* }
|
|
6029
|
-
* ```
|
|
6030
|
-
*
|
|
6031
|
-
* ## Bulk BPS pricing
|
|
6032
|
-
*
|
|
6033
|
-
* Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
|
|
6034
|
-
* total quantity across all events. Similar to bulk pricing, the BPS parameters of
|
|
6035
|
-
* a given event depends on the tier range that the billing period falls into. Each
|
|
6036
|
-
* tier range is defined by an upper bound. For example, after $1.5M of payment
|
|
6037
|
-
* volume is reached, each individual payment may have a lower cap or a smaller
|
|
6038
|
-
* take-rate.
|
|
6039
|
-
*
|
|
6040
|
-
* ```json
|
|
6041
|
-
* ...
|
|
6042
|
-
* "model_type": "bulk_bps",
|
|
6043
|
-
* "bulk_bps_config": {
|
|
6044
|
-
* "tiers": [
|
|
6045
|
-
* {
|
|
6046
|
-
* "maximum_amount": "1000000.00",
|
|
6047
|
-
* "bps": 125,
|
|
6048
|
-
* "per_unit_maximum": "19.00"
|
|
6049
|
-
* },
|
|
6050
|
-
* {
|
|
6051
|
-
* "maximum_amount": null,
|
|
6052
|
-
* "bps": 115,
|
|
6053
|
-
* "per_unit_maximum": "4.00"
|
|
6054
|
-
* }
|
|
6055
|
-
* ]
|
|
6056
|
-
* }
|
|
6057
|
-
* ...
|
|
6058
|
-
* }
|
|
6059
|
-
* ```
|
|
6060
|
-
*
|
|
6061
|
-
* ## Tiered BPS pricing
|
|
6062
|
-
*
|
|
6063
|
-
* Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
|
|
6064
|
-
* event's applicable parameter is a function of its marginal addition to the
|
|
6065
|
-
* period total. Similar to tiered pricing, the BPS parameters of a given event
|
|
6066
|
-
* depends on the tier range that it falls into, where each tier range is defined
|
|
6067
|
-
* by an upper and lower bound. For example, the first few payments may have a 0.8
|
|
6068
|
-
* BPS take-rate and all payments after a specific volume may incur a take-rate of
|
|
6069
|
-
* 0.5 BPS each.
|
|
6070
|
-
*
|
|
6071
|
-
* ```json
|
|
6072
|
-
* ...
|
|
6073
|
-
* "model_type": "tiered_bps",
|
|
6074
|
-
* "tiered_bps_config": {
|
|
6075
|
-
* "tiers": [
|
|
6076
|
-
* {
|
|
6077
|
-
* "minimum_amount": "0",
|
|
6078
|
-
* "maximum_amount": "1000000.00",
|
|
6079
|
-
* "bps": 125,
|
|
6080
|
-
* "per_unit_maximum": "19.00"
|
|
6081
|
-
* },
|
|
6082
|
-
* {
|
|
6083
|
-
* "minimum_amount": "1000000.00",
|
|
6084
|
-
* "maximum_amount": null,
|
|
6085
|
-
* "bps": 115,
|
|
6086
|
-
* "per_unit_maximum": "4.00"
|
|
6087
|
-
* }
|
|
6088
|
-
* ]
|
|
6089
|
-
* }
|
|
6090
|
-
* ...
|
|
6091
|
-
* }
|
|
6092
|
-
* ```
|
|
6093
|
-
*
|
|
6094
|
-
* ## Matrix pricing
|
|
6095
|
-
*
|
|
6096
|
-
* Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
|
|
6097
|
-
* `dimensions` defines the two event property values evaluated in this pricing
|
|
6098
|
-
* model. In a one-dimensional matrix, the second value is `null`. Every
|
|
6099
|
-
* configuration has a list of `matrix_values` which give the unit prices for
|
|
6100
|
-
* specified property values. In a one-dimensional matrix, the matrix values will
|
|
6101
|
-
* have `dimension_values` where the second value of the pair is null. If an event
|
|
6102
|
-
* does not match any of the dimension values in the matrix, it will resort to the
|
|
6103
|
-
* `default_unit_amount`.
|
|
6104
|
-
*
|
|
6105
|
-
* ```json
|
|
6106
|
-
* {
|
|
6107
|
-
* "model_type": "matrix"
|
|
6108
|
-
* "matrix_config": {
|
|
6109
|
-
* "default_unit_amount": "3.00",
|
|
6110
|
-
* "dimensions": [
|
|
6111
|
-
* "cluster_name",
|
|
6112
|
-
* "region"
|
|
6113
|
-
* ],
|
|
6114
|
-
* "matrix_values": [
|
|
6115
|
-
* {
|
|
6116
|
-
* "dimension_values": [
|
|
6117
|
-
* "alpha",
|
|
6118
|
-
* "west"
|
|
6119
|
-
* ],
|
|
6120
|
-
* "unit_amount": "2.00"
|
|
6121
|
-
* },
|
|
6122
|
-
* ...
|
|
6123
|
-
* ]
|
|
6124
|
-
* }
|
|
6125
|
-
* }
|
|
6126
|
-
* ```
|
|
6127
|
-
*
|
|
6128
|
-
* ## Fixed fees
|
|
6129
|
-
*
|
|
6130
|
-
* Fixed fees are prices that are applied independent of usage quantities, and
|
|
6131
|
-
* follow unit pricing. They also have an additional parameter
|
|
6132
|
-
* `fixed_price_quantity`. If the Price represents a fixed cost, this represents
|
|
6133
|
-
* the quantity of units applied.
|
|
6134
|
-
*
|
|
6135
|
-
* ```json
|
|
6136
|
-
* {
|
|
6137
|
-
* ...
|
|
6138
|
-
* "id": "price_id",
|
|
6139
|
-
* "model_type": "unit",
|
|
6140
|
-
* "unit_config": {
|
|
6141
|
-
* "unit_amount": "2.00"
|
|
6142
|
-
* },
|
|
6143
|
-
* "fixed_price_quantity": 3.0
|
|
6144
|
-
* ...
|
|
6145
|
-
* }
|
|
6146
|
-
* ```
|
|
4374
|
+
* For more on the types of prices, see
|
|
4375
|
+
* [the core concepts documentation](/core-concepts#plan-and-price)
|
|
6147
4376
|
*/
|
|
6148
4377
|
price: PricesAPI.Price;
|
|
6149
4378
|
/**
|
|
@@ -6214,7 +4443,7 @@ export interface SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
|
|
|
6214
4443
|
* it's often desirable to have these match existing identifiers in your system. To
|
|
6215
4444
|
* avoid having to denormalize Orb ID information, you can pass in an
|
|
6216
4445
|
* `external_customer_id` with your own identifier. See
|
|
6217
|
-
* [Customer ID Aliases](
|
|
4446
|
+
* [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
|
|
6218
4447
|
* information about how these aliases work in Orb.
|
|
6219
4448
|
*
|
|
6220
4449
|
* In addition to having an identifier in your system, a customer may exist in a
|
|
@@ -6223,9 +4452,8 @@ export interface SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
|
|
|
6223
4452
|
*
|
|
6224
4453
|
* A customer also has a timezone (from the standard
|
|
6225
4454
|
* [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
|
|
6226
|
-
* your account's timezone. See
|
|
6227
|
-
*
|
|
6228
|
-
* on what this timezone parameter influences within Orb.
|
|
4455
|
+
* your account's timezone. See [Timezone localization](/essentials/timezones) for
|
|
4456
|
+
* information on what this timezone parameter influences within Orb.
|
|
6229
4457
|
*/
|
|
6230
4458
|
customer: CustomersAPI.Customer;
|
|
6231
4459
|
/**
|
|
@@ -6266,9 +4494,9 @@ export interface SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
|
|
|
6266
4494
|
*/
|
|
6267
4495
|
net_terms: number;
|
|
6268
4496
|
/**
|
|
6269
|
-
* The [Plan](
|
|
6270
|
-
*
|
|
6271
|
-
*
|
|
4497
|
+
* The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
|
4498
|
+
* subscribed to by a customer. Plans define the billing behavior of the
|
|
4499
|
+
* subscription. You can see more about how to configure prices in the
|
|
6272
4500
|
* [Price resource](/reference/price).
|
|
6273
4501
|
*/
|
|
6274
4502
|
plan: PlansAPI.Plan;
|
|
@@ -6622,229 +4850,8 @@ export declare namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
|
|
|
6622
4850
|
* is serialized differently in a given Price object. The model_type field
|
|
6623
4851
|
* determines the key for the configuration object that is present.
|
|
6624
4852
|
*
|
|
6625
|
-
*
|
|
6626
|
-
*
|
|
6627
|
-
* With unit pricing, each unit costs a fixed amount.
|
|
6628
|
-
*
|
|
6629
|
-
* ```json
|
|
6630
|
-
* {
|
|
6631
|
-
* ...
|
|
6632
|
-
* "model_type": "unit",
|
|
6633
|
-
* "unit_config": {
|
|
6634
|
-
* "unit_amount": "0.50"
|
|
6635
|
-
* }
|
|
6636
|
-
* ...
|
|
6637
|
-
* }
|
|
6638
|
-
* ```
|
|
6639
|
-
*
|
|
6640
|
-
* ## Tiered pricing
|
|
6641
|
-
*
|
|
6642
|
-
* In tiered pricing, the cost of a given unit depends on the tier range that it
|
|
6643
|
-
* falls into, where each tier range is defined by an upper and lower bound. For
|
|
6644
|
-
* example, the first ten units may cost $0.50 each and all units thereafter may
|
|
6645
|
-
* cost $0.10 each.
|
|
6646
|
-
*
|
|
6647
|
-
* ```json
|
|
6648
|
-
* {
|
|
6649
|
-
* ...
|
|
6650
|
-
* "model_type": "tiered",
|
|
6651
|
-
* "tiered_config": {
|
|
6652
|
-
* "tiers": [
|
|
6653
|
-
* {
|
|
6654
|
-
* "first_unit": 1,
|
|
6655
|
-
* "last_unit": 10,
|
|
6656
|
-
* "unit_amount": "0.50"
|
|
6657
|
-
* },
|
|
6658
|
-
* {
|
|
6659
|
-
* "first_unit": 11,
|
|
6660
|
-
* "last_unit": null,
|
|
6661
|
-
* "unit_amount": "0.10"
|
|
6662
|
-
* }
|
|
6663
|
-
* ]
|
|
6664
|
-
* }
|
|
6665
|
-
* ...
|
|
6666
|
-
* ```
|
|
6667
|
-
*
|
|
6668
|
-
* ## Bulk pricing
|
|
6669
|
-
*
|
|
6670
|
-
* Bulk pricing applies when the number of units determine the cost of all units.
|
|
6671
|
-
* For example, if you've bought less than 10 units, they may each be $0.50 for a
|
|
6672
|
-
* total of $5.00. Once you've bought more than 10 units, all units may now be
|
|
6673
|
-
* priced at $0.40 (i.e. 101 units total would be $40.40).
|
|
6674
|
-
*
|
|
6675
|
-
* ```json
|
|
6676
|
-
* {
|
|
6677
|
-
* ...
|
|
6678
|
-
* "model_type": "bulk",
|
|
6679
|
-
* "bulk_config": {
|
|
6680
|
-
* "tiers": [
|
|
6681
|
-
* {
|
|
6682
|
-
* "maximum_units": 10,
|
|
6683
|
-
* "unit_amount": "0.50"
|
|
6684
|
-
* },
|
|
6685
|
-
* {
|
|
6686
|
-
* "maximum_units": 1000,
|
|
6687
|
-
* "unit_amount": "0.40"
|
|
6688
|
-
* }
|
|
6689
|
-
* ]
|
|
6690
|
-
* }
|
|
6691
|
-
* ...
|
|
6692
|
-
* }
|
|
6693
|
-
* ```
|
|
6694
|
-
*
|
|
6695
|
-
* ## Package pricing
|
|
6696
|
-
*
|
|
6697
|
-
* Package pricing defines the size or granularity of a unit for billing purposes.
|
|
6698
|
-
* For example, if the package size is set to 5, then 4 units will be billed as 5
|
|
6699
|
-
* and 6 units will be billed at 10.
|
|
6700
|
-
*
|
|
6701
|
-
* ```json
|
|
6702
|
-
* {
|
|
6703
|
-
* ...
|
|
6704
|
-
* "model_type": "package",
|
|
6705
|
-
* "package_config": {
|
|
6706
|
-
* "package_amount": "0.80",
|
|
6707
|
-
* "package_size": 10
|
|
6708
|
-
* }
|
|
6709
|
-
* ...
|
|
6710
|
-
* }
|
|
6711
|
-
* ```
|
|
6712
|
-
*
|
|
6713
|
-
* ## BPS pricing
|
|
6714
|
-
*
|
|
6715
|
-
* BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
|
|
6716
|
-
* percent (the number of basis points to charge), as well as a cap per event to
|
|
6717
|
-
* assess. For example, this would allow you to assess a fee of 0.25% on every
|
|
6718
|
-
* payment you process, with a maximum charge of $25 per payment.
|
|
6719
|
-
*
|
|
6720
|
-
* ```json
|
|
6721
|
-
* {
|
|
6722
|
-
* ...
|
|
6723
|
-
* "model_type": "bps",
|
|
6724
|
-
* "bps_config": {
|
|
6725
|
-
* "bps": 125,
|
|
6726
|
-
* "per_unit_maximum": "11.00"
|
|
6727
|
-
* }
|
|
6728
|
-
* ...
|
|
6729
|
-
* }
|
|
6730
|
-
* ```
|
|
6731
|
-
*
|
|
6732
|
-
* ## Bulk BPS pricing
|
|
6733
|
-
*
|
|
6734
|
-
* Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
|
|
6735
|
-
* total quantity across all events. Similar to bulk pricing, the BPS parameters of
|
|
6736
|
-
* a given event depends on the tier range that the billing period falls into. Each
|
|
6737
|
-
* tier range is defined by an upper bound. For example, after $1.5M of payment
|
|
6738
|
-
* volume is reached, each individual payment may have a lower cap or a smaller
|
|
6739
|
-
* take-rate.
|
|
6740
|
-
*
|
|
6741
|
-
* ```json
|
|
6742
|
-
* ...
|
|
6743
|
-
* "model_type": "bulk_bps",
|
|
6744
|
-
* "bulk_bps_config": {
|
|
6745
|
-
* "tiers": [
|
|
6746
|
-
* {
|
|
6747
|
-
* "maximum_amount": "1000000.00",
|
|
6748
|
-
* "bps": 125,
|
|
6749
|
-
* "per_unit_maximum": "19.00"
|
|
6750
|
-
* },
|
|
6751
|
-
* {
|
|
6752
|
-
* "maximum_amount": null,
|
|
6753
|
-
* "bps": 115,
|
|
6754
|
-
* "per_unit_maximum": "4.00"
|
|
6755
|
-
* }
|
|
6756
|
-
* ]
|
|
6757
|
-
* }
|
|
6758
|
-
* ...
|
|
6759
|
-
* }
|
|
6760
|
-
* ```
|
|
6761
|
-
*
|
|
6762
|
-
* ## Tiered BPS pricing
|
|
6763
|
-
*
|
|
6764
|
-
* Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
|
|
6765
|
-
* event's applicable parameter is a function of its marginal addition to the
|
|
6766
|
-
* period total. Similar to tiered pricing, the BPS parameters of a given event
|
|
6767
|
-
* depends on the tier range that it falls into, where each tier range is defined
|
|
6768
|
-
* by an upper and lower bound. For example, the first few payments may have a 0.8
|
|
6769
|
-
* BPS take-rate and all payments after a specific volume may incur a take-rate of
|
|
6770
|
-
* 0.5 BPS each.
|
|
6771
|
-
*
|
|
6772
|
-
* ```json
|
|
6773
|
-
* ...
|
|
6774
|
-
* "model_type": "tiered_bps",
|
|
6775
|
-
* "tiered_bps_config": {
|
|
6776
|
-
* "tiers": [
|
|
6777
|
-
* {
|
|
6778
|
-
* "minimum_amount": "0",
|
|
6779
|
-
* "maximum_amount": "1000000.00",
|
|
6780
|
-
* "bps": 125,
|
|
6781
|
-
* "per_unit_maximum": "19.00"
|
|
6782
|
-
* },
|
|
6783
|
-
* {
|
|
6784
|
-
* "minimum_amount": "1000000.00",
|
|
6785
|
-
* "maximum_amount": null,
|
|
6786
|
-
* "bps": 115,
|
|
6787
|
-
* "per_unit_maximum": "4.00"
|
|
6788
|
-
* }
|
|
6789
|
-
* ]
|
|
6790
|
-
* }
|
|
6791
|
-
* ...
|
|
6792
|
-
* }
|
|
6793
|
-
* ```
|
|
6794
|
-
*
|
|
6795
|
-
* ## Matrix pricing
|
|
6796
|
-
*
|
|
6797
|
-
* Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
|
|
6798
|
-
* `dimensions` defines the two event property values evaluated in this pricing
|
|
6799
|
-
* model. In a one-dimensional matrix, the second value is `null`. Every
|
|
6800
|
-
* configuration has a list of `matrix_values` which give the unit prices for
|
|
6801
|
-
* specified property values. In a one-dimensional matrix, the matrix values will
|
|
6802
|
-
* have `dimension_values` where the second value of the pair is null. If an event
|
|
6803
|
-
* does not match any of the dimension values in the matrix, it will resort to the
|
|
6804
|
-
* `default_unit_amount`.
|
|
6805
|
-
*
|
|
6806
|
-
* ```json
|
|
6807
|
-
* {
|
|
6808
|
-
* "model_type": "matrix"
|
|
6809
|
-
* "matrix_config": {
|
|
6810
|
-
* "default_unit_amount": "3.00",
|
|
6811
|
-
* "dimensions": [
|
|
6812
|
-
* "cluster_name",
|
|
6813
|
-
* "region"
|
|
6814
|
-
* ],
|
|
6815
|
-
* "matrix_values": [
|
|
6816
|
-
* {
|
|
6817
|
-
* "dimension_values": [
|
|
6818
|
-
* "alpha",
|
|
6819
|
-
* "west"
|
|
6820
|
-
* ],
|
|
6821
|
-
* "unit_amount": "2.00"
|
|
6822
|
-
* },
|
|
6823
|
-
* ...
|
|
6824
|
-
* ]
|
|
6825
|
-
* }
|
|
6826
|
-
* }
|
|
6827
|
-
* ```
|
|
6828
|
-
*
|
|
6829
|
-
* ## Fixed fees
|
|
6830
|
-
*
|
|
6831
|
-
* Fixed fees are prices that are applied independent of usage quantities, and
|
|
6832
|
-
* follow unit pricing. They also have an additional parameter
|
|
6833
|
-
* `fixed_price_quantity`. If the Price represents a fixed cost, this represents
|
|
6834
|
-
* the quantity of units applied.
|
|
6835
|
-
*
|
|
6836
|
-
* ```json
|
|
6837
|
-
* {
|
|
6838
|
-
* ...
|
|
6839
|
-
* "id": "price_id",
|
|
6840
|
-
* "model_type": "unit",
|
|
6841
|
-
* "unit_config": {
|
|
6842
|
-
* "unit_amount": "2.00"
|
|
6843
|
-
* },
|
|
6844
|
-
* "fixed_price_quantity": 3.0
|
|
6845
|
-
* ...
|
|
6846
|
-
* }
|
|
6847
|
-
* ```
|
|
4853
|
+
* For more on the types of prices, see
|
|
4854
|
+
* [the core concepts documentation](/core-concepts#plan-and-price)
|
|
6848
4855
|
*/
|
|
6849
4856
|
price: PricesAPI.Price;
|
|
6850
4857
|
/**
|
|
@@ -6915,7 +4922,7 @@ export interface SubscriptionUnschedulePendingPlanChangesResponse {
|
|
|
6915
4922
|
* it's often desirable to have these match existing identifiers in your system. To
|
|
6916
4923
|
* avoid having to denormalize Orb ID information, you can pass in an
|
|
6917
4924
|
* `external_customer_id` with your own identifier. See
|
|
6918
|
-
* [Customer ID Aliases](
|
|
4925
|
+
* [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
|
|
6919
4926
|
* information about how these aliases work in Orb.
|
|
6920
4927
|
*
|
|
6921
4928
|
* In addition to having an identifier in your system, a customer may exist in a
|
|
@@ -6924,9 +4931,8 @@ export interface SubscriptionUnschedulePendingPlanChangesResponse {
|
|
|
6924
4931
|
*
|
|
6925
4932
|
* A customer also has a timezone (from the standard
|
|
6926
4933
|
* [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
|
|
6927
|
-
* your account's timezone. See
|
|
6928
|
-
*
|
|
6929
|
-
* on what this timezone parameter influences within Orb.
|
|
4934
|
+
* your account's timezone. See [Timezone localization](/essentials/timezones) for
|
|
4935
|
+
* information on what this timezone parameter influences within Orb.
|
|
6930
4936
|
*/
|
|
6931
4937
|
customer: CustomersAPI.Customer;
|
|
6932
4938
|
/**
|
|
@@ -6967,9 +4973,9 @@ export interface SubscriptionUnschedulePendingPlanChangesResponse {
|
|
|
6967
4973
|
*/
|
|
6968
4974
|
net_terms: number;
|
|
6969
4975
|
/**
|
|
6970
|
-
* The [Plan](
|
|
6971
|
-
*
|
|
6972
|
-
*
|
|
4976
|
+
* The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
|
4977
|
+
* subscribed to by a customer. Plans define the billing behavior of the
|
|
4978
|
+
* subscription. You can see more about how to configure prices in the
|
|
6973
4979
|
* [Price resource](/reference/price).
|
|
6974
4980
|
*/
|
|
6975
4981
|
plan: PlansAPI.Plan;
|
|
@@ -7323,229 +5329,8 @@ export declare namespace SubscriptionUnschedulePendingPlanChangesResponse {
|
|
|
7323
5329
|
* is serialized differently in a given Price object. The model_type field
|
|
7324
5330
|
* determines the key for the configuration object that is present.
|
|
7325
5331
|
*
|
|
7326
|
-
*
|
|
7327
|
-
*
|
|
7328
|
-
* With unit pricing, each unit costs a fixed amount.
|
|
7329
|
-
*
|
|
7330
|
-
* ```json
|
|
7331
|
-
* {
|
|
7332
|
-
* ...
|
|
7333
|
-
* "model_type": "unit",
|
|
7334
|
-
* "unit_config": {
|
|
7335
|
-
* "unit_amount": "0.50"
|
|
7336
|
-
* }
|
|
7337
|
-
* ...
|
|
7338
|
-
* }
|
|
7339
|
-
* ```
|
|
7340
|
-
*
|
|
7341
|
-
* ## Tiered pricing
|
|
7342
|
-
*
|
|
7343
|
-
* In tiered pricing, the cost of a given unit depends on the tier range that it
|
|
7344
|
-
* falls into, where each tier range is defined by an upper and lower bound. For
|
|
7345
|
-
* example, the first ten units may cost $0.50 each and all units thereafter may
|
|
7346
|
-
* cost $0.10 each.
|
|
7347
|
-
*
|
|
7348
|
-
* ```json
|
|
7349
|
-
* {
|
|
7350
|
-
* ...
|
|
7351
|
-
* "model_type": "tiered",
|
|
7352
|
-
* "tiered_config": {
|
|
7353
|
-
* "tiers": [
|
|
7354
|
-
* {
|
|
7355
|
-
* "first_unit": 1,
|
|
7356
|
-
* "last_unit": 10,
|
|
7357
|
-
* "unit_amount": "0.50"
|
|
7358
|
-
* },
|
|
7359
|
-
* {
|
|
7360
|
-
* "first_unit": 11,
|
|
7361
|
-
* "last_unit": null,
|
|
7362
|
-
* "unit_amount": "0.10"
|
|
7363
|
-
* }
|
|
7364
|
-
* ]
|
|
7365
|
-
* }
|
|
7366
|
-
* ...
|
|
7367
|
-
* ```
|
|
7368
|
-
*
|
|
7369
|
-
* ## Bulk pricing
|
|
7370
|
-
*
|
|
7371
|
-
* Bulk pricing applies when the number of units determine the cost of all units.
|
|
7372
|
-
* For example, if you've bought less than 10 units, they may each be $0.50 for a
|
|
7373
|
-
* total of $5.00. Once you've bought more than 10 units, all units may now be
|
|
7374
|
-
* priced at $0.40 (i.e. 101 units total would be $40.40).
|
|
7375
|
-
*
|
|
7376
|
-
* ```json
|
|
7377
|
-
* {
|
|
7378
|
-
* ...
|
|
7379
|
-
* "model_type": "bulk",
|
|
7380
|
-
* "bulk_config": {
|
|
7381
|
-
* "tiers": [
|
|
7382
|
-
* {
|
|
7383
|
-
* "maximum_units": 10,
|
|
7384
|
-
* "unit_amount": "0.50"
|
|
7385
|
-
* },
|
|
7386
|
-
* {
|
|
7387
|
-
* "maximum_units": 1000,
|
|
7388
|
-
* "unit_amount": "0.40"
|
|
7389
|
-
* }
|
|
7390
|
-
* ]
|
|
7391
|
-
* }
|
|
7392
|
-
* ...
|
|
7393
|
-
* }
|
|
7394
|
-
* ```
|
|
7395
|
-
*
|
|
7396
|
-
* ## Package pricing
|
|
7397
|
-
*
|
|
7398
|
-
* Package pricing defines the size or granularity of a unit for billing purposes.
|
|
7399
|
-
* For example, if the package size is set to 5, then 4 units will be billed as 5
|
|
7400
|
-
* and 6 units will be billed at 10.
|
|
7401
|
-
*
|
|
7402
|
-
* ```json
|
|
7403
|
-
* {
|
|
7404
|
-
* ...
|
|
7405
|
-
* "model_type": "package",
|
|
7406
|
-
* "package_config": {
|
|
7407
|
-
* "package_amount": "0.80",
|
|
7408
|
-
* "package_size": 10
|
|
7409
|
-
* }
|
|
7410
|
-
* ...
|
|
7411
|
-
* }
|
|
7412
|
-
* ```
|
|
7413
|
-
*
|
|
7414
|
-
* ## BPS pricing
|
|
7415
|
-
*
|
|
7416
|
-
* BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
|
|
7417
|
-
* percent (the number of basis points to charge), as well as a cap per event to
|
|
7418
|
-
* assess. For example, this would allow you to assess a fee of 0.25% on every
|
|
7419
|
-
* payment you process, with a maximum charge of $25 per payment.
|
|
7420
|
-
*
|
|
7421
|
-
* ```json
|
|
7422
|
-
* {
|
|
7423
|
-
* ...
|
|
7424
|
-
* "model_type": "bps",
|
|
7425
|
-
* "bps_config": {
|
|
7426
|
-
* "bps": 125,
|
|
7427
|
-
* "per_unit_maximum": "11.00"
|
|
7428
|
-
* }
|
|
7429
|
-
* ...
|
|
7430
|
-
* }
|
|
7431
|
-
* ```
|
|
7432
|
-
*
|
|
7433
|
-
* ## Bulk BPS pricing
|
|
7434
|
-
*
|
|
7435
|
-
* Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
|
|
7436
|
-
* total quantity across all events. Similar to bulk pricing, the BPS parameters of
|
|
7437
|
-
* a given event depends on the tier range that the billing period falls into. Each
|
|
7438
|
-
* tier range is defined by an upper bound. For example, after $1.5M of payment
|
|
7439
|
-
* volume is reached, each individual payment may have a lower cap or a smaller
|
|
7440
|
-
* take-rate.
|
|
7441
|
-
*
|
|
7442
|
-
* ```json
|
|
7443
|
-
* ...
|
|
7444
|
-
* "model_type": "bulk_bps",
|
|
7445
|
-
* "bulk_bps_config": {
|
|
7446
|
-
* "tiers": [
|
|
7447
|
-
* {
|
|
7448
|
-
* "maximum_amount": "1000000.00",
|
|
7449
|
-
* "bps": 125,
|
|
7450
|
-
* "per_unit_maximum": "19.00"
|
|
7451
|
-
* },
|
|
7452
|
-
* {
|
|
7453
|
-
* "maximum_amount": null,
|
|
7454
|
-
* "bps": 115,
|
|
7455
|
-
* "per_unit_maximum": "4.00"
|
|
7456
|
-
* }
|
|
7457
|
-
* ]
|
|
7458
|
-
* }
|
|
7459
|
-
* ...
|
|
7460
|
-
* }
|
|
7461
|
-
* ```
|
|
7462
|
-
*
|
|
7463
|
-
* ## Tiered BPS pricing
|
|
7464
|
-
*
|
|
7465
|
-
* Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
|
|
7466
|
-
* event's applicable parameter is a function of its marginal addition to the
|
|
7467
|
-
* period total. Similar to tiered pricing, the BPS parameters of a given event
|
|
7468
|
-
* depends on the tier range that it falls into, where each tier range is defined
|
|
7469
|
-
* by an upper and lower bound. For example, the first few payments may have a 0.8
|
|
7470
|
-
* BPS take-rate and all payments after a specific volume may incur a take-rate of
|
|
7471
|
-
* 0.5 BPS each.
|
|
7472
|
-
*
|
|
7473
|
-
* ```json
|
|
7474
|
-
* ...
|
|
7475
|
-
* "model_type": "tiered_bps",
|
|
7476
|
-
* "tiered_bps_config": {
|
|
7477
|
-
* "tiers": [
|
|
7478
|
-
* {
|
|
7479
|
-
* "minimum_amount": "0",
|
|
7480
|
-
* "maximum_amount": "1000000.00",
|
|
7481
|
-
* "bps": 125,
|
|
7482
|
-
* "per_unit_maximum": "19.00"
|
|
7483
|
-
* },
|
|
7484
|
-
* {
|
|
7485
|
-
* "minimum_amount": "1000000.00",
|
|
7486
|
-
* "maximum_amount": null,
|
|
7487
|
-
* "bps": 115,
|
|
7488
|
-
* "per_unit_maximum": "4.00"
|
|
7489
|
-
* }
|
|
7490
|
-
* ]
|
|
7491
|
-
* }
|
|
7492
|
-
* ...
|
|
7493
|
-
* }
|
|
7494
|
-
* ```
|
|
7495
|
-
*
|
|
7496
|
-
* ## Matrix pricing
|
|
7497
|
-
*
|
|
7498
|
-
* Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
|
|
7499
|
-
* `dimensions` defines the two event property values evaluated in this pricing
|
|
7500
|
-
* model. In a one-dimensional matrix, the second value is `null`. Every
|
|
7501
|
-
* configuration has a list of `matrix_values` which give the unit prices for
|
|
7502
|
-
* specified property values. In a one-dimensional matrix, the matrix values will
|
|
7503
|
-
* have `dimension_values` where the second value of the pair is null. If an event
|
|
7504
|
-
* does not match any of the dimension values in the matrix, it will resort to the
|
|
7505
|
-
* `default_unit_amount`.
|
|
7506
|
-
*
|
|
7507
|
-
* ```json
|
|
7508
|
-
* {
|
|
7509
|
-
* "model_type": "matrix"
|
|
7510
|
-
* "matrix_config": {
|
|
7511
|
-
* "default_unit_amount": "3.00",
|
|
7512
|
-
* "dimensions": [
|
|
7513
|
-
* "cluster_name",
|
|
7514
|
-
* "region"
|
|
7515
|
-
* ],
|
|
7516
|
-
* "matrix_values": [
|
|
7517
|
-
* {
|
|
7518
|
-
* "dimension_values": [
|
|
7519
|
-
* "alpha",
|
|
7520
|
-
* "west"
|
|
7521
|
-
* ],
|
|
7522
|
-
* "unit_amount": "2.00"
|
|
7523
|
-
* },
|
|
7524
|
-
* ...
|
|
7525
|
-
* ]
|
|
7526
|
-
* }
|
|
7527
|
-
* }
|
|
7528
|
-
* ```
|
|
7529
|
-
*
|
|
7530
|
-
* ## Fixed fees
|
|
7531
|
-
*
|
|
7532
|
-
* Fixed fees are prices that are applied independent of usage quantities, and
|
|
7533
|
-
* follow unit pricing. They also have an additional parameter
|
|
7534
|
-
* `fixed_price_quantity`. If the Price represents a fixed cost, this represents
|
|
7535
|
-
* the quantity of units applied.
|
|
7536
|
-
*
|
|
7537
|
-
* ```json
|
|
7538
|
-
* {
|
|
7539
|
-
* ...
|
|
7540
|
-
* "id": "price_id",
|
|
7541
|
-
* "model_type": "unit",
|
|
7542
|
-
* "unit_config": {
|
|
7543
|
-
* "unit_amount": "2.00"
|
|
7544
|
-
* },
|
|
7545
|
-
* "fixed_price_quantity": 3.0
|
|
7546
|
-
* ...
|
|
7547
|
-
* }
|
|
7548
|
-
* ```
|
|
5332
|
+
* For more on the types of prices, see
|
|
5333
|
+
* [the core concepts documentation](/core-concepts#plan-and-price)
|
|
7549
5334
|
*/
|
|
7550
5335
|
price: PricesAPI.Price;
|
|
7551
5336
|
/**
|
|
@@ -7616,7 +5401,7 @@ export interface SubscriptionUpdateFixedFeeQuantityResponse {
|
|
|
7616
5401
|
* it's often desirable to have these match existing identifiers in your system. To
|
|
7617
5402
|
* avoid having to denormalize Orb ID information, you can pass in an
|
|
7618
5403
|
* `external_customer_id` with your own identifier. See
|
|
7619
|
-
* [Customer ID Aliases](
|
|
5404
|
+
* [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
|
|
7620
5405
|
* information about how these aliases work in Orb.
|
|
7621
5406
|
*
|
|
7622
5407
|
* In addition to having an identifier in your system, a customer may exist in a
|
|
@@ -7625,9 +5410,8 @@ export interface SubscriptionUpdateFixedFeeQuantityResponse {
|
|
|
7625
5410
|
*
|
|
7626
5411
|
* A customer also has a timezone (from the standard
|
|
7627
5412
|
* [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
|
|
7628
|
-
* your account's timezone. See
|
|
7629
|
-
*
|
|
7630
|
-
* on what this timezone parameter influences within Orb.
|
|
5413
|
+
* your account's timezone. See [Timezone localization](/essentials/timezones) for
|
|
5414
|
+
* information on what this timezone parameter influences within Orb.
|
|
7631
5415
|
*/
|
|
7632
5416
|
customer: CustomersAPI.Customer;
|
|
7633
5417
|
/**
|
|
@@ -7668,9 +5452,9 @@ export interface SubscriptionUpdateFixedFeeQuantityResponse {
|
|
|
7668
5452
|
*/
|
|
7669
5453
|
net_terms: number;
|
|
7670
5454
|
/**
|
|
7671
|
-
* The [Plan](
|
|
7672
|
-
*
|
|
7673
|
-
*
|
|
5455
|
+
* The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
|
5456
|
+
* subscribed to by a customer. Plans define the billing behavior of the
|
|
5457
|
+
* subscription. You can see more about how to configure prices in the
|
|
7674
5458
|
* [Price resource](/reference/price).
|
|
7675
5459
|
*/
|
|
7676
5460
|
plan: PlansAPI.Plan;
|
|
@@ -8024,229 +5808,8 @@ export declare namespace SubscriptionUpdateFixedFeeQuantityResponse {
|
|
|
8024
5808
|
* is serialized differently in a given Price object. The model_type field
|
|
8025
5809
|
* determines the key for the configuration object that is present.
|
|
8026
5810
|
*
|
|
8027
|
-
*
|
|
8028
|
-
*
|
|
8029
|
-
* With unit pricing, each unit costs a fixed amount.
|
|
8030
|
-
*
|
|
8031
|
-
* ```json
|
|
8032
|
-
* {
|
|
8033
|
-
* ...
|
|
8034
|
-
* "model_type": "unit",
|
|
8035
|
-
* "unit_config": {
|
|
8036
|
-
* "unit_amount": "0.50"
|
|
8037
|
-
* }
|
|
8038
|
-
* ...
|
|
8039
|
-
* }
|
|
8040
|
-
* ```
|
|
8041
|
-
*
|
|
8042
|
-
* ## Tiered pricing
|
|
8043
|
-
*
|
|
8044
|
-
* In tiered pricing, the cost of a given unit depends on the tier range that it
|
|
8045
|
-
* falls into, where each tier range is defined by an upper and lower bound. For
|
|
8046
|
-
* example, the first ten units may cost $0.50 each and all units thereafter may
|
|
8047
|
-
* cost $0.10 each.
|
|
8048
|
-
*
|
|
8049
|
-
* ```json
|
|
8050
|
-
* {
|
|
8051
|
-
* ...
|
|
8052
|
-
* "model_type": "tiered",
|
|
8053
|
-
* "tiered_config": {
|
|
8054
|
-
* "tiers": [
|
|
8055
|
-
* {
|
|
8056
|
-
* "first_unit": 1,
|
|
8057
|
-
* "last_unit": 10,
|
|
8058
|
-
* "unit_amount": "0.50"
|
|
8059
|
-
* },
|
|
8060
|
-
* {
|
|
8061
|
-
* "first_unit": 11,
|
|
8062
|
-
* "last_unit": null,
|
|
8063
|
-
* "unit_amount": "0.10"
|
|
8064
|
-
* }
|
|
8065
|
-
* ]
|
|
8066
|
-
* }
|
|
8067
|
-
* ...
|
|
8068
|
-
* ```
|
|
8069
|
-
*
|
|
8070
|
-
* ## Bulk pricing
|
|
8071
|
-
*
|
|
8072
|
-
* Bulk pricing applies when the number of units determine the cost of all units.
|
|
8073
|
-
* For example, if you've bought less than 10 units, they may each be $0.50 for a
|
|
8074
|
-
* total of $5.00. Once you've bought more than 10 units, all units may now be
|
|
8075
|
-
* priced at $0.40 (i.e. 101 units total would be $40.40).
|
|
8076
|
-
*
|
|
8077
|
-
* ```json
|
|
8078
|
-
* {
|
|
8079
|
-
* ...
|
|
8080
|
-
* "model_type": "bulk",
|
|
8081
|
-
* "bulk_config": {
|
|
8082
|
-
* "tiers": [
|
|
8083
|
-
* {
|
|
8084
|
-
* "maximum_units": 10,
|
|
8085
|
-
* "unit_amount": "0.50"
|
|
8086
|
-
* },
|
|
8087
|
-
* {
|
|
8088
|
-
* "maximum_units": 1000,
|
|
8089
|
-
* "unit_amount": "0.40"
|
|
8090
|
-
* }
|
|
8091
|
-
* ]
|
|
8092
|
-
* }
|
|
8093
|
-
* ...
|
|
8094
|
-
* }
|
|
8095
|
-
* ```
|
|
8096
|
-
*
|
|
8097
|
-
* ## Package pricing
|
|
8098
|
-
*
|
|
8099
|
-
* Package pricing defines the size or granularity of a unit for billing purposes.
|
|
8100
|
-
* For example, if the package size is set to 5, then 4 units will be billed as 5
|
|
8101
|
-
* and 6 units will be billed at 10.
|
|
8102
|
-
*
|
|
8103
|
-
* ```json
|
|
8104
|
-
* {
|
|
8105
|
-
* ...
|
|
8106
|
-
* "model_type": "package",
|
|
8107
|
-
* "package_config": {
|
|
8108
|
-
* "package_amount": "0.80",
|
|
8109
|
-
* "package_size": 10
|
|
8110
|
-
* }
|
|
8111
|
-
* ...
|
|
8112
|
-
* }
|
|
8113
|
-
* ```
|
|
8114
|
-
*
|
|
8115
|
-
* ## BPS pricing
|
|
8116
|
-
*
|
|
8117
|
-
* BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
|
|
8118
|
-
* percent (the number of basis points to charge), as well as a cap per event to
|
|
8119
|
-
* assess. For example, this would allow you to assess a fee of 0.25% on every
|
|
8120
|
-
* payment you process, with a maximum charge of $25 per payment.
|
|
8121
|
-
*
|
|
8122
|
-
* ```json
|
|
8123
|
-
* {
|
|
8124
|
-
* ...
|
|
8125
|
-
* "model_type": "bps",
|
|
8126
|
-
* "bps_config": {
|
|
8127
|
-
* "bps": 125,
|
|
8128
|
-
* "per_unit_maximum": "11.00"
|
|
8129
|
-
* }
|
|
8130
|
-
* ...
|
|
8131
|
-
* }
|
|
8132
|
-
* ```
|
|
8133
|
-
*
|
|
8134
|
-
* ## Bulk BPS pricing
|
|
8135
|
-
*
|
|
8136
|
-
* Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
|
|
8137
|
-
* total quantity across all events. Similar to bulk pricing, the BPS parameters of
|
|
8138
|
-
* a given event depends on the tier range that the billing period falls into. Each
|
|
8139
|
-
* tier range is defined by an upper bound. For example, after $1.5M of payment
|
|
8140
|
-
* volume is reached, each individual payment may have a lower cap or a smaller
|
|
8141
|
-
* take-rate.
|
|
8142
|
-
*
|
|
8143
|
-
* ```json
|
|
8144
|
-
* ...
|
|
8145
|
-
* "model_type": "bulk_bps",
|
|
8146
|
-
* "bulk_bps_config": {
|
|
8147
|
-
* "tiers": [
|
|
8148
|
-
* {
|
|
8149
|
-
* "maximum_amount": "1000000.00",
|
|
8150
|
-
* "bps": 125,
|
|
8151
|
-
* "per_unit_maximum": "19.00"
|
|
8152
|
-
* },
|
|
8153
|
-
* {
|
|
8154
|
-
* "maximum_amount": null,
|
|
8155
|
-
* "bps": 115,
|
|
8156
|
-
* "per_unit_maximum": "4.00"
|
|
8157
|
-
* }
|
|
8158
|
-
* ]
|
|
8159
|
-
* }
|
|
8160
|
-
* ...
|
|
8161
|
-
* }
|
|
8162
|
-
* ```
|
|
8163
|
-
*
|
|
8164
|
-
* ## Tiered BPS pricing
|
|
8165
|
-
*
|
|
8166
|
-
* Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
|
|
8167
|
-
* event's applicable parameter is a function of its marginal addition to the
|
|
8168
|
-
* period total. Similar to tiered pricing, the BPS parameters of a given event
|
|
8169
|
-
* depends on the tier range that it falls into, where each tier range is defined
|
|
8170
|
-
* by an upper and lower bound. For example, the first few payments may have a 0.8
|
|
8171
|
-
* BPS take-rate and all payments after a specific volume may incur a take-rate of
|
|
8172
|
-
* 0.5 BPS each.
|
|
8173
|
-
*
|
|
8174
|
-
* ```json
|
|
8175
|
-
* ...
|
|
8176
|
-
* "model_type": "tiered_bps",
|
|
8177
|
-
* "tiered_bps_config": {
|
|
8178
|
-
* "tiers": [
|
|
8179
|
-
* {
|
|
8180
|
-
* "minimum_amount": "0",
|
|
8181
|
-
* "maximum_amount": "1000000.00",
|
|
8182
|
-
* "bps": 125,
|
|
8183
|
-
* "per_unit_maximum": "19.00"
|
|
8184
|
-
* },
|
|
8185
|
-
* {
|
|
8186
|
-
* "minimum_amount": "1000000.00",
|
|
8187
|
-
* "maximum_amount": null,
|
|
8188
|
-
* "bps": 115,
|
|
8189
|
-
* "per_unit_maximum": "4.00"
|
|
8190
|
-
* }
|
|
8191
|
-
* ]
|
|
8192
|
-
* }
|
|
8193
|
-
* ...
|
|
8194
|
-
* }
|
|
8195
|
-
* ```
|
|
8196
|
-
*
|
|
8197
|
-
* ## Matrix pricing
|
|
8198
|
-
*
|
|
8199
|
-
* Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
|
|
8200
|
-
* `dimensions` defines the two event property values evaluated in this pricing
|
|
8201
|
-
* model. In a one-dimensional matrix, the second value is `null`. Every
|
|
8202
|
-
* configuration has a list of `matrix_values` which give the unit prices for
|
|
8203
|
-
* specified property values. In a one-dimensional matrix, the matrix values will
|
|
8204
|
-
* have `dimension_values` where the second value of the pair is null. If an event
|
|
8205
|
-
* does not match any of the dimension values in the matrix, it will resort to the
|
|
8206
|
-
* `default_unit_amount`.
|
|
8207
|
-
*
|
|
8208
|
-
* ```json
|
|
8209
|
-
* {
|
|
8210
|
-
* "model_type": "matrix"
|
|
8211
|
-
* "matrix_config": {
|
|
8212
|
-
* "default_unit_amount": "3.00",
|
|
8213
|
-
* "dimensions": [
|
|
8214
|
-
* "cluster_name",
|
|
8215
|
-
* "region"
|
|
8216
|
-
* ],
|
|
8217
|
-
* "matrix_values": [
|
|
8218
|
-
* {
|
|
8219
|
-
* "dimension_values": [
|
|
8220
|
-
* "alpha",
|
|
8221
|
-
* "west"
|
|
8222
|
-
* ],
|
|
8223
|
-
* "unit_amount": "2.00"
|
|
8224
|
-
* },
|
|
8225
|
-
* ...
|
|
8226
|
-
* ]
|
|
8227
|
-
* }
|
|
8228
|
-
* }
|
|
8229
|
-
* ```
|
|
8230
|
-
*
|
|
8231
|
-
* ## Fixed fees
|
|
8232
|
-
*
|
|
8233
|
-
* Fixed fees are prices that are applied independent of usage quantities, and
|
|
8234
|
-
* follow unit pricing. They also have an additional parameter
|
|
8235
|
-
* `fixed_price_quantity`. If the Price represents a fixed cost, this represents
|
|
8236
|
-
* the quantity of units applied.
|
|
8237
|
-
*
|
|
8238
|
-
* ```json
|
|
8239
|
-
* {
|
|
8240
|
-
* ...
|
|
8241
|
-
* "id": "price_id",
|
|
8242
|
-
* "model_type": "unit",
|
|
8243
|
-
* "unit_config": {
|
|
8244
|
-
* "unit_amount": "2.00"
|
|
8245
|
-
* },
|
|
8246
|
-
* "fixed_price_quantity": 3.0
|
|
8247
|
-
* ...
|
|
8248
|
-
* }
|
|
8249
|
-
* ```
|
|
5811
|
+
* For more on the types of prices, see
|
|
5812
|
+
* [the core concepts documentation](/core-concepts#plan-and-price)
|
|
8250
5813
|
*/
|
|
8251
5814
|
price: PricesAPI.Price;
|
|
8252
5815
|
/**
|
|
@@ -8317,7 +5880,7 @@ export interface SubscriptionUpdateTrialResponse {
|
|
|
8317
5880
|
* it's often desirable to have these match existing identifiers in your system. To
|
|
8318
5881
|
* avoid having to denormalize Orb ID information, you can pass in an
|
|
8319
5882
|
* `external_customer_id` with your own identifier. See
|
|
8320
|
-
* [Customer ID Aliases](
|
|
5883
|
+
* [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
|
|
8321
5884
|
* information about how these aliases work in Orb.
|
|
8322
5885
|
*
|
|
8323
5886
|
* In addition to having an identifier in your system, a customer may exist in a
|
|
@@ -8326,9 +5889,8 @@ export interface SubscriptionUpdateTrialResponse {
|
|
|
8326
5889
|
*
|
|
8327
5890
|
* A customer also has a timezone (from the standard
|
|
8328
5891
|
* [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
|
|
8329
|
-
* your account's timezone. See
|
|
8330
|
-
*
|
|
8331
|
-
* on what this timezone parameter influences within Orb.
|
|
5892
|
+
* your account's timezone. See [Timezone localization](/essentials/timezones) for
|
|
5893
|
+
* information on what this timezone parameter influences within Orb.
|
|
8332
5894
|
*/
|
|
8333
5895
|
customer: CustomersAPI.Customer;
|
|
8334
5896
|
/**
|
|
@@ -8369,9 +5931,9 @@ export interface SubscriptionUpdateTrialResponse {
|
|
|
8369
5931
|
*/
|
|
8370
5932
|
net_terms: number;
|
|
8371
5933
|
/**
|
|
8372
|
-
* The [Plan](
|
|
8373
|
-
*
|
|
8374
|
-
*
|
|
5934
|
+
* The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
|
5935
|
+
* subscribed to by a customer. Plans define the billing behavior of the
|
|
5936
|
+
* subscription. You can see more about how to configure prices in the
|
|
8375
5937
|
* [Price resource](/reference/price).
|
|
8376
5938
|
*/
|
|
8377
5939
|
plan: PlansAPI.Plan;
|
|
@@ -8725,229 +6287,8 @@ export declare namespace SubscriptionUpdateTrialResponse {
|
|
|
8725
6287
|
* is serialized differently in a given Price object. The model_type field
|
|
8726
6288
|
* determines the key for the configuration object that is present.
|
|
8727
6289
|
*
|
|
8728
|
-
*
|
|
8729
|
-
*
|
|
8730
|
-
* With unit pricing, each unit costs a fixed amount.
|
|
8731
|
-
*
|
|
8732
|
-
* ```json
|
|
8733
|
-
* {
|
|
8734
|
-
* ...
|
|
8735
|
-
* "model_type": "unit",
|
|
8736
|
-
* "unit_config": {
|
|
8737
|
-
* "unit_amount": "0.50"
|
|
8738
|
-
* }
|
|
8739
|
-
* ...
|
|
8740
|
-
* }
|
|
8741
|
-
* ```
|
|
8742
|
-
*
|
|
8743
|
-
* ## Tiered pricing
|
|
8744
|
-
*
|
|
8745
|
-
* In tiered pricing, the cost of a given unit depends on the tier range that it
|
|
8746
|
-
* falls into, where each tier range is defined by an upper and lower bound. For
|
|
8747
|
-
* example, the first ten units may cost $0.50 each and all units thereafter may
|
|
8748
|
-
* cost $0.10 each.
|
|
8749
|
-
*
|
|
8750
|
-
* ```json
|
|
8751
|
-
* {
|
|
8752
|
-
* ...
|
|
8753
|
-
* "model_type": "tiered",
|
|
8754
|
-
* "tiered_config": {
|
|
8755
|
-
* "tiers": [
|
|
8756
|
-
* {
|
|
8757
|
-
* "first_unit": 1,
|
|
8758
|
-
* "last_unit": 10,
|
|
8759
|
-
* "unit_amount": "0.50"
|
|
8760
|
-
* },
|
|
8761
|
-
* {
|
|
8762
|
-
* "first_unit": 11,
|
|
8763
|
-
* "last_unit": null,
|
|
8764
|
-
* "unit_amount": "0.10"
|
|
8765
|
-
* }
|
|
8766
|
-
* ]
|
|
8767
|
-
* }
|
|
8768
|
-
* ...
|
|
8769
|
-
* ```
|
|
8770
|
-
*
|
|
8771
|
-
* ## Bulk pricing
|
|
8772
|
-
*
|
|
8773
|
-
* Bulk pricing applies when the number of units determine the cost of all units.
|
|
8774
|
-
* For example, if you've bought less than 10 units, they may each be $0.50 for a
|
|
8775
|
-
* total of $5.00. Once you've bought more than 10 units, all units may now be
|
|
8776
|
-
* priced at $0.40 (i.e. 101 units total would be $40.40).
|
|
8777
|
-
*
|
|
8778
|
-
* ```json
|
|
8779
|
-
* {
|
|
8780
|
-
* ...
|
|
8781
|
-
* "model_type": "bulk",
|
|
8782
|
-
* "bulk_config": {
|
|
8783
|
-
* "tiers": [
|
|
8784
|
-
* {
|
|
8785
|
-
* "maximum_units": 10,
|
|
8786
|
-
* "unit_amount": "0.50"
|
|
8787
|
-
* },
|
|
8788
|
-
* {
|
|
8789
|
-
* "maximum_units": 1000,
|
|
8790
|
-
* "unit_amount": "0.40"
|
|
8791
|
-
* }
|
|
8792
|
-
* ]
|
|
8793
|
-
* }
|
|
8794
|
-
* ...
|
|
8795
|
-
* }
|
|
8796
|
-
* ```
|
|
8797
|
-
*
|
|
8798
|
-
* ## Package pricing
|
|
8799
|
-
*
|
|
8800
|
-
* Package pricing defines the size or granularity of a unit for billing purposes.
|
|
8801
|
-
* For example, if the package size is set to 5, then 4 units will be billed as 5
|
|
8802
|
-
* and 6 units will be billed at 10.
|
|
8803
|
-
*
|
|
8804
|
-
* ```json
|
|
8805
|
-
* {
|
|
8806
|
-
* ...
|
|
8807
|
-
* "model_type": "package",
|
|
8808
|
-
* "package_config": {
|
|
8809
|
-
* "package_amount": "0.80",
|
|
8810
|
-
* "package_size": 10
|
|
8811
|
-
* }
|
|
8812
|
-
* ...
|
|
8813
|
-
* }
|
|
8814
|
-
* ```
|
|
8815
|
-
*
|
|
8816
|
-
* ## BPS pricing
|
|
8817
|
-
*
|
|
8818
|
-
* BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
|
|
8819
|
-
* percent (the number of basis points to charge), as well as a cap per event to
|
|
8820
|
-
* assess. For example, this would allow you to assess a fee of 0.25% on every
|
|
8821
|
-
* payment you process, with a maximum charge of $25 per payment.
|
|
8822
|
-
*
|
|
8823
|
-
* ```json
|
|
8824
|
-
* {
|
|
8825
|
-
* ...
|
|
8826
|
-
* "model_type": "bps",
|
|
8827
|
-
* "bps_config": {
|
|
8828
|
-
* "bps": 125,
|
|
8829
|
-
* "per_unit_maximum": "11.00"
|
|
8830
|
-
* }
|
|
8831
|
-
* ...
|
|
8832
|
-
* }
|
|
8833
|
-
* ```
|
|
8834
|
-
*
|
|
8835
|
-
* ## Bulk BPS pricing
|
|
8836
|
-
*
|
|
8837
|
-
* Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
|
|
8838
|
-
* total quantity across all events. Similar to bulk pricing, the BPS parameters of
|
|
8839
|
-
* a given event depends on the tier range that the billing period falls into. Each
|
|
8840
|
-
* tier range is defined by an upper bound. For example, after $1.5M of payment
|
|
8841
|
-
* volume is reached, each individual payment may have a lower cap or a smaller
|
|
8842
|
-
* take-rate.
|
|
8843
|
-
*
|
|
8844
|
-
* ```json
|
|
8845
|
-
* ...
|
|
8846
|
-
* "model_type": "bulk_bps",
|
|
8847
|
-
* "bulk_bps_config": {
|
|
8848
|
-
* "tiers": [
|
|
8849
|
-
* {
|
|
8850
|
-
* "maximum_amount": "1000000.00",
|
|
8851
|
-
* "bps": 125,
|
|
8852
|
-
* "per_unit_maximum": "19.00"
|
|
8853
|
-
* },
|
|
8854
|
-
* {
|
|
8855
|
-
* "maximum_amount": null,
|
|
8856
|
-
* "bps": 115,
|
|
8857
|
-
* "per_unit_maximum": "4.00"
|
|
8858
|
-
* }
|
|
8859
|
-
* ]
|
|
8860
|
-
* }
|
|
8861
|
-
* ...
|
|
8862
|
-
* }
|
|
8863
|
-
* ```
|
|
8864
|
-
*
|
|
8865
|
-
* ## Tiered BPS pricing
|
|
8866
|
-
*
|
|
8867
|
-
* Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
|
|
8868
|
-
* event's applicable parameter is a function of its marginal addition to the
|
|
8869
|
-
* period total. Similar to tiered pricing, the BPS parameters of a given event
|
|
8870
|
-
* depends on the tier range that it falls into, where each tier range is defined
|
|
8871
|
-
* by an upper and lower bound. For example, the first few payments may have a 0.8
|
|
8872
|
-
* BPS take-rate and all payments after a specific volume may incur a take-rate of
|
|
8873
|
-
* 0.5 BPS each.
|
|
8874
|
-
*
|
|
8875
|
-
* ```json
|
|
8876
|
-
* ...
|
|
8877
|
-
* "model_type": "tiered_bps",
|
|
8878
|
-
* "tiered_bps_config": {
|
|
8879
|
-
* "tiers": [
|
|
8880
|
-
* {
|
|
8881
|
-
* "minimum_amount": "0",
|
|
8882
|
-
* "maximum_amount": "1000000.00",
|
|
8883
|
-
* "bps": 125,
|
|
8884
|
-
* "per_unit_maximum": "19.00"
|
|
8885
|
-
* },
|
|
8886
|
-
* {
|
|
8887
|
-
* "minimum_amount": "1000000.00",
|
|
8888
|
-
* "maximum_amount": null,
|
|
8889
|
-
* "bps": 115,
|
|
8890
|
-
* "per_unit_maximum": "4.00"
|
|
8891
|
-
* }
|
|
8892
|
-
* ]
|
|
8893
|
-
* }
|
|
8894
|
-
* ...
|
|
8895
|
-
* }
|
|
8896
|
-
* ```
|
|
8897
|
-
*
|
|
8898
|
-
* ## Matrix pricing
|
|
8899
|
-
*
|
|
8900
|
-
* Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
|
|
8901
|
-
* `dimensions` defines the two event property values evaluated in this pricing
|
|
8902
|
-
* model. In a one-dimensional matrix, the second value is `null`. Every
|
|
8903
|
-
* configuration has a list of `matrix_values` which give the unit prices for
|
|
8904
|
-
* specified property values. In a one-dimensional matrix, the matrix values will
|
|
8905
|
-
* have `dimension_values` where the second value of the pair is null. If an event
|
|
8906
|
-
* does not match any of the dimension values in the matrix, it will resort to the
|
|
8907
|
-
* `default_unit_amount`.
|
|
8908
|
-
*
|
|
8909
|
-
* ```json
|
|
8910
|
-
* {
|
|
8911
|
-
* "model_type": "matrix"
|
|
8912
|
-
* "matrix_config": {
|
|
8913
|
-
* "default_unit_amount": "3.00",
|
|
8914
|
-
* "dimensions": [
|
|
8915
|
-
* "cluster_name",
|
|
8916
|
-
* "region"
|
|
8917
|
-
* ],
|
|
8918
|
-
* "matrix_values": [
|
|
8919
|
-
* {
|
|
8920
|
-
* "dimension_values": [
|
|
8921
|
-
* "alpha",
|
|
8922
|
-
* "west"
|
|
8923
|
-
* ],
|
|
8924
|
-
* "unit_amount": "2.00"
|
|
8925
|
-
* },
|
|
8926
|
-
* ...
|
|
8927
|
-
* ]
|
|
8928
|
-
* }
|
|
8929
|
-
* }
|
|
8930
|
-
* ```
|
|
8931
|
-
*
|
|
8932
|
-
* ## Fixed fees
|
|
8933
|
-
*
|
|
8934
|
-
* Fixed fees are prices that are applied independent of usage quantities, and
|
|
8935
|
-
* follow unit pricing. They also have an additional parameter
|
|
8936
|
-
* `fixed_price_quantity`. If the Price represents a fixed cost, this represents
|
|
8937
|
-
* the quantity of units applied.
|
|
8938
|
-
*
|
|
8939
|
-
* ```json
|
|
8940
|
-
* {
|
|
8941
|
-
* ...
|
|
8942
|
-
* "id": "price_id",
|
|
8943
|
-
* "model_type": "unit",
|
|
8944
|
-
* "unit_config": {
|
|
8945
|
-
* "unit_amount": "2.00"
|
|
8946
|
-
* },
|
|
8947
|
-
* "fixed_price_quantity": 3.0
|
|
8948
|
-
* ...
|
|
8949
|
-
* }
|
|
8950
|
-
* ```
|
|
6290
|
+
* For more on the types of prices, see
|
|
6291
|
+
* [the core concepts documentation](/core-concepts#plan-and-price)
|
|
8951
6292
|
*/
|
|
8952
6293
|
price: PricesAPI.Price;
|
|
8953
6294
|
/**
|
|
@@ -9017,8 +6358,8 @@ export interface SubscriptionCreateParams {
|
|
|
9017
6358
|
/**
|
|
9018
6359
|
* An additional filter to apply to usage queries. This filter must be expressed as
|
|
9019
6360
|
* a boolean
|
|
9020
|
-
* [computed property](
|
|
9021
|
-
*
|
|
6361
|
+
* [computed property](/extensibility/advanced-metrics#computed-properties). If
|
|
6362
|
+
* null, usage queries will not include any additional filter.
|
|
9022
6363
|
*/
|
|
9023
6364
|
filter?: string | null;
|
|
9024
6365
|
/**
|
|
@@ -16095,8 +13436,7 @@ export interface SubscriptionSchedulePlanChangeParams {
|
|
|
16095
13436
|
billing_cycle_anchor_configuration?: SubscriptionSchedulePlanChangeParams.BillingCycleAnchorConfiguration | null;
|
|
16096
13437
|
/**
|
|
16097
13438
|
* The date that the plan change should take effect. This parameter can only be
|
|
16098
|
-
* passed if the `change_option` is `requested_date`.
|
|
16099
|
-
* passed, the plan change will happen at midnight in the customer's timezone.
|
|
13439
|
+
* passed if the `change_option` is `requested_date`.
|
|
16100
13440
|
*/
|
|
16101
13441
|
change_date?: string | null;
|
|
16102
13442
|
/**
|
|
@@ -16119,8 +13459,8 @@ export interface SubscriptionSchedulePlanChangeParams {
|
|
|
16119
13459
|
/**
|
|
16120
13460
|
* An additional filter to apply to usage queries. This filter must be expressed as
|
|
16121
13461
|
* a boolean
|
|
16122
|
-
* [computed property](
|
|
16123
|
-
*
|
|
13462
|
+
* [computed property](/extensibility/advanced-metrics#computed-properties). If
|
|
13463
|
+
* null, usage queries will not include any additional filter.
|
|
16124
13464
|
*/
|
|
16125
13465
|
filter?: string | null;
|
|
16126
13466
|
/**
|