orb-billing 4.49.0 → 4.51.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (98) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/package.json +1 -1
  3. package/resources/alerts.d.ts +5 -8
  4. package/resources/alerts.d.ts.map +1 -1
  5. package/resources/alerts.js +2 -4
  6. package/resources/alerts.js.map +1 -1
  7. package/resources/alerts.mjs +2 -4
  8. package/resources/alerts.mjs.map +1 -1
  9. package/resources/coupons/coupons.d.ts +0 -34
  10. package/resources/coupons/coupons.d.ts.map +1 -1
  11. package/resources/coupons/coupons.js.map +1 -1
  12. package/resources/coupons/coupons.mjs.map +1 -1
  13. package/resources/coupons/subscriptions.d.ts +3 -3
  14. package/resources/credit-notes.d.ts +5 -5
  15. package/resources/credit-notes.js +3 -3
  16. package/resources/credit-notes.mjs +3 -3
  17. package/resources/customers/costs.d.ts +12 -454
  18. package/resources/customers/costs.d.ts.map +1 -1
  19. package/resources/customers/credits/ledger.d.ts +14 -14
  20. package/resources/customers/customers.d.ts +19 -19
  21. package/resources/customers/customers.d.ts.map +1 -1
  22. package/resources/customers/customers.js +14 -12
  23. package/resources/customers/customers.js.map +1 -1
  24. package/resources/customers/customers.mjs +14 -12
  25. package/resources/customers/customers.mjs.map +1 -1
  26. package/resources/events/backfills.d.ts +18 -18
  27. package/resources/events/backfills.js +3 -3
  28. package/resources/events/backfills.mjs +3 -3
  29. package/resources/events/events.d.ts +6 -7
  30. package/resources/events/events.d.ts.map +1 -1
  31. package/resources/events/events.js +3 -3
  32. package/resources/events/events.js.map +1 -1
  33. package/resources/events/events.mjs +3 -3
  34. package/resources/events/events.mjs.map +1 -1
  35. package/resources/events/volume.d.ts +5 -5
  36. package/resources/events/volume.js +5 -5
  37. package/resources/events/volume.mjs +5 -5
  38. package/resources/invoice-line-items.d.ts +2 -223
  39. package/resources/invoice-line-items.d.ts.map +1 -1
  40. package/resources/invoices.d.ts +14 -456
  41. package/resources/invoices.d.ts.map +1 -1
  42. package/resources/invoices.js +3 -3
  43. package/resources/invoices.js.map +1 -1
  44. package/resources/invoices.mjs +3 -3
  45. package/resources/invoices.mjs.map +1 -1
  46. package/resources/items.d.ts +1 -1
  47. package/resources/items.js +1 -1
  48. package/resources/items.mjs +1 -1
  49. package/resources/metrics.d.ts +6 -7
  50. package/resources/metrics.d.ts.map +1 -1
  51. package/resources/metrics.js +3 -4
  52. package/resources/metrics.js.map +1 -1
  53. package/resources/metrics.mjs +3 -4
  54. package/resources/metrics.mjs.map +1 -1
  55. package/resources/plans/external-plan-id.d.ts +6 -6
  56. package/resources/plans/external-plan-id.js +6 -6
  57. package/resources/plans/external-plan-id.mjs +6 -6
  58. package/resources/plans/plans.d.ts +15 -15
  59. package/resources/plans/plans.js +6 -6
  60. package/resources/plans/plans.mjs +6 -6
  61. package/resources/prices/external-price-id.d.ts +2 -2
  62. package/resources/prices/external-price-id.js +2 -2
  63. package/resources/prices/external-price-id.mjs +2 -2
  64. package/resources/prices/prices.d.ts +14 -235
  65. package/resources/prices/prices.d.ts.map +1 -1
  66. package/resources/prices/prices.js +7 -7
  67. package/resources/prices/prices.js.map +1 -1
  68. package/resources/prices/prices.mjs +7 -7
  69. package/resources/prices/prices.mjs.map +1 -1
  70. package/resources/subscriptions.d.ts +172 -2831
  71. package/resources/subscriptions.d.ts.map +1 -1
  72. package/resources/subscriptions.js +53 -49
  73. package/resources/subscriptions.js.map +1 -1
  74. package/resources/subscriptions.mjs +53 -49
  75. package/resources/subscriptions.mjs.map +1 -1
  76. package/src/resources/alerts.ts +5 -8
  77. package/src/resources/coupons/coupons.ts +0 -34
  78. package/src/resources/coupons/subscriptions.ts +3 -3
  79. package/src/resources/credit-notes.ts +5 -5
  80. package/src/resources/customers/costs.ts +12 -454
  81. package/src/resources/customers/credits/ledger.ts +14 -14
  82. package/src/resources/customers/customers.ts +19 -19
  83. package/src/resources/events/backfills.ts +18 -18
  84. package/src/resources/events/events.ts +6 -7
  85. package/src/resources/events/volume.ts +5 -5
  86. package/src/resources/invoice-line-items.ts +2 -223
  87. package/src/resources/invoices.ts +14 -456
  88. package/src/resources/items.ts +1 -1
  89. package/src/resources/metrics.ts +6 -7
  90. package/src/resources/plans/external-plan-id.ts +6 -6
  91. package/src/resources/plans/plans.ts +15 -15
  92. package/src/resources/prices/external-price-id.ts +2 -2
  93. package/src/resources/prices/prices.ts +14 -235
  94. package/src/resources/subscriptions.ts +172 -2831
  95. package/src/version.ts +1 -1
  96. package/version.d.ts +1 -1
  97. package/version.js +1 -1
  98. package/version.mjs +1 -1
@@ -21,7 +21,7 @@ export class Subscriptions extends APIResource {
21
21
  *
22
22
  * The default configuration for subscriptions in Orb is **In-advance billing** and
23
23
  * **Beginning of month alignment** (see
24
- * [Subscription](../guides/concepts#subscription) for more details).
24
+ * [Subscription](/core-concepts##subscription) for more details).
25
25
  *
26
26
  * In order to change the alignment behavior, Orb also supports billing
27
27
  * subscriptions on the day of the month they are created. If
@@ -46,9 +46,10 @@ export class Subscriptions extends APIResource {
46
46
  * subscription being created. This is useful when a customer has prices that
47
47
  * differ from the default prices for a specific plan.
48
48
  *
49
- * :::info This feature is only available for accounts that have migrated to
50
- * Subscription Overrides Version 2. You can find your Subscription Overrides
51
- * Version at the bottom of your [Plans page](https://app.withorb.com/plans) :::
49
+ * <Note>
50
+ * This feature is only available for accounts that have migrated to Subscription Overrides Version 2. You can find your
51
+ * Subscription Overrides Version at the bottom of your [Plans page](https://app.withorb.com/plans)
52
+ * </Note>
52
53
  *
53
54
  * ### Adding Prices
54
55
  *
@@ -56,17 +57,17 @@ export class Subscriptions extends APIResource {
56
57
  * the list must specify an existing add-on price with a `price_id` or
57
58
  * `external_price_id` field, or create a new add-on price by including an object
58
59
  * with the key `price`, identical to what would be used in the request body for
59
- * the [create price endpoint](../reference/create-price). See the
60
- * [Price resource](../reference/price) for the specification of different price
61
- * model configurations possible in this object.
60
+ * the [create price endpoint](/api-reference/price/create-price). See the
61
+ * [Price resource](/product-catalog/price-configuration) for the specification of
62
+ * different price model configurations possible in this object.
62
63
  *
63
64
  * If the plan has phases, each object in the list must include a number with
64
65
  * `plan_phase_order` key to indicate which phase the price should be added to.
65
66
  *
66
67
  * An object in the list can specify an optional `start_date` and optional
67
68
  * `end_date`. This is equivalent to creating a price interval with the
68
- * [add/edit price intervals endpoint](../reference/add-edit-price-intervals). If
69
- * unspecified, the start or end date of the phase or subscription will be used.
69
+ * [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
70
+ * If unspecified, the start or end date of the phase or subscription will be used.
70
71
  *
71
72
  * An object in the list can specify an optional `minimum_amount`,
72
73
  * `maximum_amount`, or `discounts`. This will create adjustments which apply only
@@ -91,14 +92,15 @@ export class Subscriptions extends APIResource {
91
92
  * either referencing an existing add-on price with a `price_id` or
92
93
  * `external_price_id` field, or by creating a new add-on price by including an
93
94
  * object with the key `price`, identical to what would be used in the request body
94
- * for the [create price endpoint](../reference/create-price). See the
95
- * [Price resource](../reference/price) for the specification of different price
96
- * model configurations possible in this object.
95
+ * for the [create price endpoint](/api-reference/price/create-price). See the
96
+ * [Price resource](/product-catalog/price-configuration) for the specification of
97
+ * different price model configurations possible in this object.
97
98
  *
98
99
  * For fixed fees, an object in the list can supply a `fixed_price_quantity`
99
100
  * instead of a `price`, `price_id`, or `external_price_id` field. This will update
100
101
  * only the quantity for the price, similar to the
101
- * [Update price quantity](../reference/update-fixed-fee-quantity) endpoint.
102
+ * [Update price quantity](/api-reference/subscription/update-price-quantity)
103
+ * endpoint.
102
104
  *
103
105
  * The replacement price will have the same phase, if applicable, and the same
104
106
  * start and end dates as the price it replaces.
@@ -117,7 +119,7 @@ export class Subscriptions extends APIResource {
117
119
  * To add adjustments, provide a list of objects with the key `add_adjustments`. An
118
120
  * object in the list must include an object with the key `adjustment`, identical
119
121
  * to the adjustment object in the
120
- * [add/edit price intervals endpoint](../reference/add-edit-price-intervals).
122
+ * [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
121
123
  *
122
124
  * If the plan has phases, each object in the list must include a number with
123
125
  * `plan_phase_order` key to indicate which phase the adjustment should be added
@@ -140,17 +142,17 @@ export class Subscriptions extends APIResource {
140
142
  * replace with the `replaces_adjustment_id` key, and it must specify an adjustment
141
143
  * to replace it with by including an object with the key `adjustment`, identical
142
144
  * to the adjustment object in the
143
- * [add/edit price intervals endpoint](../reference/add-edit-price-intervals).
145
+ * [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
144
146
  *
145
147
  * The replacement adjustment will have the same phase, if applicable, and the same
146
148
  * start and end dates as the adjustment it replaces.
147
149
  *
148
150
  * ## Price overrides (DEPRECATED)
149
151
  *
150
- * :::info Price overrides are being phased out in favor adding/removing/replacing
151
- * prices. (See
152
- * [Customize your customer's subscriptions](../reference/create-subscription#customize-your-customers-subscriptions))
153
- * :::
152
+ * <Note>
153
+ * Price overrides are being phased out in favor adding/removing/replacing prices. (See
154
+ * [Customize your customer's subscriptions](/api-reference/subscription/create-subscription))
155
+ * </Note>
154
156
  *
155
157
  * Price overrides are used to update some or all prices in a plan for the specific
156
158
  * subscription being created. This is useful when a new customer has negotiated a
@@ -159,9 +161,9 @@ export class Subscriptions extends APIResource {
159
161
  * To override prices, provide a list of objects with the key `price_overrides`.
160
162
  * The price object in the list of overrides is expected to contain the existing
161
163
  * price id, the `model_type` and configuration. (See the
162
- * [Price resource](../reference/price) for the specification of different price
163
- * model configurations.) The numerical values can be updated, but the billable
164
- * metric, cadence, type, and name of a price can not be overridden.
164
+ * [Price resource](/product-catalog/price-configuration) for the specification of
165
+ * different price model configurations.) The numerical values can be updated, but
166
+ * the billable metric, cadence, type, and name of a price can not be overridden.
165
167
  *
166
168
  * ### Maximums and Minimums
167
169
  *
@@ -288,9 +290,9 @@ export class Subscriptions extends APIResource {
288
290
 
289
291
  /**
290
292
  * This endpoint returns a list of all subscriptions for an account as a
291
- * [paginated](../reference/pagination) list, ordered starting from the most
293
+ * [paginated](/api-reference/pagination) list, ordered starting from the most
292
294
  * recently created subscription. For a full discussion of the subscription
293
- * resource, see [Subscription](../guides/concepts#subscription).
295
+ * resource, see [Subscription](/core-concepts##subscription).
294
296
  *
295
297
  * Subscriptions can be filtered for a specific customer by using either the
296
298
  * customer_id or external_customer_id query parameters. To filter subscriptions
@@ -373,7 +375,7 @@ export class Subscriptions extends APIResource {
373
375
  * current period. If the cancellation is before the most recently issued invoice,
374
376
  * Orb will void the intervening invoice and generate a new one based on the new
375
377
  * dates for the subscription. See the section on
376
- * [cancellation behaviors](../guides/product-catalog/creating-subscriptions.md#cancellation-behaviors).
378
+ * [cancellation behaviors](/product-catalog/creating-subscriptions#cancellation-behaviors).
377
379
  */
378
380
  cancel(
379
381
  subscriptionId: string,
@@ -384,7 +386,7 @@ export class Subscriptions extends APIResource {
384
386
  }
385
387
 
386
388
  /**
387
- * This endpoint is used to fetch a [Subscription](../guides/concepts#subscription)
389
+ * This endpoint is used to fetch a [Subscription](/core-concepts##subscription)
388
390
  * given an identifier.
389
391
  */
390
392
  fetch(subscriptionId: string, options?: Core.RequestOptions): Core.APIPromise<Subscription> {
@@ -424,7 +426,7 @@ export class Subscriptions extends APIResource {
424
426
  }
425
427
 
426
428
  /**
427
- * This endpoint returns a [paginated](../reference/pagination) list of all plans
429
+ * This endpoint returns a [paginated](/api-reference/pagination) list of all plans
428
430
  * associated with a subscription along with their start and end dates. This list
429
431
  * contains the subscription's initial plan along with past and future plan
430
432
  * changes.
@@ -668,9 +670,9 @@ export class Subscriptions extends APIResource {
668
670
 
669
671
  /**
670
672
  * This endpoint is used to add and edit subscription
671
- * [price intervals](../reference/price-interval). By making modifications to a
672
- * subscription’s price intervals, you can
673
- * [flexibly and atomically control the billing behavior of a subscription](../guides/product-catalog/modifying-subscriptions).
673
+ * [price intervals](/api-reference/price-interval/add-or-edit-price-intervals). By
674
+ * making modifications to a subscription’s price intervals, you can
675
+ * [flexibly and atomically control the billing behavior of a subscription](/product-catalog/modifying-subscriptions).
674
676
  *
675
677
  * ## Adding price intervals
676
678
  *
@@ -793,9 +795,10 @@ export class Subscriptions extends APIResource {
793
795
  * subscription when you schedule the plan change. This is useful when a customer
794
796
  * has prices that differ from the default prices for a specific plan.
795
797
  *
796
- * :::info This feature is only available for accounts that have migrated to
797
- * Subscription Overrides Version 2. You can find your Subscription Overrides
798
- * Version at the bottom of your [Plans page](https://app.withorb.com/plans) :::
798
+ * <Note>
799
+ * This feature is only available for accounts that have migrated to Subscription Overrides Version 2. You can find your
800
+ * Subscription Overrides Version at the bottom of your [Plans page](https://app.withorb.com/plans)
801
+ * </Note>
799
802
  *
800
803
  * ### Adding Prices
801
804
  *
@@ -803,17 +806,17 @@ export class Subscriptions extends APIResource {
803
806
  * the list must specify an existing add-on price with a `price_id` or
804
807
  * `external_price_id` field, or create a new add-on price by including an object
805
808
  * with the key `price`, identical to what would be used in the request body for
806
- * the [create price endpoint](../reference/create-price). See the
807
- * [Price resource](../reference/price) for the specification of different price
808
- * model configurations possible in this object.
809
+ * the [create price endpoint](/api-reference/price/create-price). See the
810
+ * [Price resource](/product-catalog/price-configuration) for the specification of
811
+ * different price model configurations possible in this object.
809
812
  *
810
813
  * If the plan has phases, each object in the list must include a number with
811
814
  * `plan_phase_order` key to indicate which phase the price should be added to.
812
815
  *
813
816
  * An object in the list can specify an optional `start_date` and optional
814
817
  * `end_date`. This is equivalent to creating a price interval with the
815
- * [add/edit price intervals endpoint](../reference/add-edit-price-intervals). If
816
- * unspecified, the start or end date of the phase or subscription will be used.
818
+ * [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
819
+ * If unspecified, the start or end date of the phase or subscription will be used.
817
820
  *
818
821
  * An object in the list can specify an optional `minimum_amount`,
819
822
  * `maximum_amount`, or `discounts`. This will create adjustments which apply only
@@ -838,14 +841,15 @@ export class Subscriptions extends APIResource {
838
841
  * either referencing an existing add-on price with a `price_id` or
839
842
  * `external_price_id` field, or by creating a new add-on price by including an
840
843
  * object with the key `price`, identical to what would be used in the request body
841
- * for the [create price endpoint](../reference/create-price). See the
842
- * [Price resource](../reference/price) for the specification of different price
843
- * model configurations possible in this object.
844
+ * for the [create price endpoint](/api-reference/price/create-price). See the
845
+ * [Price resource](/product-catalog/price-configuration) for the specification of
846
+ * different price model configurations possible in this object.
844
847
  *
845
848
  * For fixed fees, an object in the list can supply a `fixed_price_quantity`
846
849
  * instead of a `price`, `price_id`, or `external_price_id` field. This will update
847
850
  * only the quantity for the price, similar to the
848
- * [Update price quantity](../reference/update-fixed-fee-quantity) endpoint.
851
+ * [Update price quantity](/api-reference/subscription/update-price-quantity)
852
+ * endpoint.
849
853
  *
850
854
  * The replacement price will have the same phase, if applicable, and the same
851
855
  * start and end dates as the price it replaces.
@@ -864,7 +868,7 @@ export class Subscriptions extends APIResource {
864
868
  * To add adjustments, provide a list of objects with the key `add_adjustments`. An
865
869
  * object in the list must include an object with the key `adjustment`, identical
866
870
  * to the adjustment object in the
867
- * [add/edit price intervals endpoint](../reference/add-edit-price-intervals).
871
+ * [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
868
872
  *
869
873
  * If the plan has phases, each object in the list must include a number with
870
874
  * `plan_phase_order` key to indicate which phase the adjustment should be added
@@ -887,17 +891,17 @@ export class Subscriptions extends APIResource {
887
891
  * replace with the `replaces_adjustment_id` key, and it must specify an adjustment
888
892
  * to replace it with by including an object with the key `adjustment`, identical
889
893
  * to the adjustment object in the
890
- * [add/edit price intervals endpoint](../reference/add-edit-price-intervals).
894
+ * [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
891
895
  *
892
896
  * The replacement adjustment will have the same phase, if applicable, and the same
893
897
  * start and end dates as the adjustment it replaces.
894
898
  *
895
899
  * ## Price overrides (DEPRECATED)
896
900
  *
897
- * :::info Price overrides are being phased out in favor adding/removing/replacing
898
- * prices. (See
899
- * [Customize your customer's subscriptions](../reference/schedule-plan-change#customize-your-customers-subscriptions))
900
- * :::
901
+ * <Note>
902
+ * Price overrides are being phased out in favor adding/removing/replacing prices. (See
903
+ * [Customize your customer's subscriptions](/api-reference/subscription/schedule-plan-change))
904
+ * </Note>
901
905
  *
902
906
  * Price overrides are used to update some or all prices in a plan for the specific
903
907
  * subscription being created. This is useful when a new customer has negotiated a
@@ -906,9 +910,9 @@ export class Subscriptions extends APIResource {
906
910
  * To override prices, provide a list of objects with the key `price_overrides`.
907
911
  * The price object in the list of overrides is expected to contain the existing
908
912
  * price id, the `model_type` and configuration. (See the
909
- * [Price resource](../reference/price) for the specification of different price
910
- * model configurations.) The numerical values can be updated, but the billable
911
- * metric, cadence, type, and name of a price can not be overridden.
913
+ * [Price resource](/product-catalog/price-configuration) for the specification of
914
+ * different price model configurations.) The numerical values can be updated, but
915
+ * the billable metric, cadence, type, and name of a price can not be overridden.
912
916
  *
913
917
  * ### Maximums, and minimums
914
918
  *
@@ -928,7 +932,7 @@ export class Subscriptions extends APIResource {
928
932
  * By default, Orb calculates the prorated difference in any fixed fees when making
929
933
  * a plan change, adjusting the customer balance as needed. For details on this
930
934
  * behavior, see
931
- * [Modifying subscriptions](../guides/product-catalog/modifying-subscriptions.md#prorations-for-in-advance-fees).
935
+ * [Modifying subscriptions](/product-catalog/modifying-subscriptions#prorations-for-in-advance-fees).
932
936
  */
933
937
  schedulePlanChange(
934
938
  subscriptionId: string,
@@ -1055,8 +1059,8 @@ export class SubscriptionsPage extends Page<Subscription> {}
1055
1059
  export class SubscriptionFetchScheduleResponsesPage extends Page<SubscriptionFetchScheduleResponse> {}
1056
1060
 
1057
1061
  /**
1058
- * A [subscription](../guides/core-concepts.mdx#subscription) represents the
1059
- * purchase of a plan by a customer.
1062
+ * A [subscription](/core-concepts#subscription) represents the purchase of a plan
1063
+ * by a customer.
1060
1064
  *
1061
1065
  * By default, subscriptions begin on the day that they're created and renew
1062
1066
  * automatically for each billing cycle at the cadence that's configured in the
@@ -1130,7 +1134,7 @@ export interface Subscription {
1130
1134
  * it's often desirable to have these match existing identifiers in your system. To
1131
1135
  * avoid having to denormalize Orb ID information, you can pass in an
1132
1136
  * `external_customer_id` with your own identifier. See
1133
- * [Customer ID Aliases](../guides/events-and-metrics/customer-aliases) for further
1137
+ * [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
1134
1138
  * information about how these aliases work in Orb.
1135
1139
  *
1136
1140
  * In addition to having an identifier in your system, a customer may exist in a
@@ -1139,9 +1143,8 @@ export interface Subscription {
1139
1143
  *
1140
1144
  * A customer also has a timezone (from the standard
1141
1145
  * [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
1142
- * your account's timezone. See
1143
- * [Timezone localization](../guides/product-catalog/timezones.md) for information
1144
- * on what this timezone parameter influences within Orb.
1146
+ * your account's timezone. See [Timezone localization](/essentials/timezones) for
1147
+ * information on what this timezone parameter influences within Orb.
1145
1148
  */
1146
1149
  customer: CustomersAPI.Customer;
1147
1150
 
@@ -1196,9 +1199,9 @@ export interface Subscription {
1196
1199
  net_terms: number;
1197
1200
 
1198
1201
  /**
1199
- * The [Plan](../guides/core-concepts.mdx#plan-and-price) resource represents a
1200
- * plan that can be subscribed to by a customer. Plans define the billing behavior
1201
- * of the subscription. You can see more about how to configure prices in the
1202
+ * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
1203
+ * subscribed to by a customer. Plans define the billing behavior of the
1204
+ * subscription. You can see more about how to configure prices in the
1202
1205
  * [Price resource](/reference/price).
1203
1206
  */
1204
1207
  plan: PlansAPI.Plan;
@@ -1645,229 +1648,8 @@ export namespace Subscription {
1645
1648
  * is serialized differently in a given Price object. The model_type field
1646
1649
  * determines the key for the configuration object that is present.
1647
1650
  *
1648
- * ## Unit pricing
1649
- *
1650
- * With unit pricing, each unit costs a fixed amount.
1651
- *
1652
- * ```json
1653
- * {
1654
- * ...
1655
- * "model_type": "unit",
1656
- * "unit_config": {
1657
- * "unit_amount": "0.50"
1658
- * }
1659
- * ...
1660
- * }
1661
- * ```
1662
- *
1663
- * ## Tiered pricing
1664
- *
1665
- * In tiered pricing, the cost of a given unit depends on the tier range that it
1666
- * falls into, where each tier range is defined by an upper and lower bound. For
1667
- * example, the first ten units may cost $0.50 each and all units thereafter may
1668
- * cost $0.10 each.
1669
- *
1670
- * ```json
1671
- * {
1672
- * ...
1673
- * "model_type": "tiered",
1674
- * "tiered_config": {
1675
- * "tiers": [
1676
- * {
1677
- * "first_unit": 1,
1678
- * "last_unit": 10,
1679
- * "unit_amount": "0.50"
1680
- * },
1681
- * {
1682
- * "first_unit": 11,
1683
- * "last_unit": null,
1684
- * "unit_amount": "0.10"
1685
- * }
1686
- * ]
1687
- * }
1688
- * ...
1689
- * ```
1690
- *
1691
- * ## Bulk pricing
1692
- *
1693
- * Bulk pricing applies when the number of units determine the cost of all units.
1694
- * For example, if you've bought less than 10 units, they may each be $0.50 for a
1695
- * total of $5.00. Once you've bought more than 10 units, all units may now be
1696
- * priced at $0.40 (i.e. 101 units total would be $40.40).
1697
- *
1698
- * ```json
1699
- * {
1700
- * ...
1701
- * "model_type": "bulk",
1702
- * "bulk_config": {
1703
- * "tiers": [
1704
- * {
1705
- * "maximum_units": 10,
1706
- * "unit_amount": "0.50"
1707
- * },
1708
- * {
1709
- * "maximum_units": 1000,
1710
- * "unit_amount": "0.40"
1711
- * }
1712
- * ]
1713
- * }
1714
- * ...
1715
- * }
1716
- * ```
1717
- *
1718
- * ## Package pricing
1719
- *
1720
- * Package pricing defines the size or granularity of a unit for billing purposes.
1721
- * For example, if the package size is set to 5, then 4 units will be billed as 5
1722
- * and 6 units will be billed at 10.
1723
- *
1724
- * ```json
1725
- * {
1726
- * ...
1727
- * "model_type": "package",
1728
- * "package_config": {
1729
- * "package_amount": "0.80",
1730
- * "package_size": 10
1731
- * }
1732
- * ...
1733
- * }
1734
- * ```
1735
- *
1736
- * ## BPS pricing
1737
- *
1738
- * BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
1739
- * percent (the number of basis points to charge), as well as a cap per event to
1740
- * assess. For example, this would allow you to assess a fee of 0.25% on every
1741
- * payment you process, with a maximum charge of $25 per payment.
1742
- *
1743
- * ```json
1744
- * {
1745
- * ...
1746
- * "model_type": "bps",
1747
- * "bps_config": {
1748
- * "bps": 125,
1749
- * "per_unit_maximum": "11.00"
1750
- * }
1751
- * ...
1752
- * }
1753
- * ```
1754
- *
1755
- * ## Bulk BPS pricing
1756
- *
1757
- * Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
1758
- * total quantity across all events. Similar to bulk pricing, the BPS parameters of
1759
- * a given event depends on the tier range that the billing period falls into. Each
1760
- * tier range is defined by an upper bound. For example, after $1.5M of payment
1761
- * volume is reached, each individual payment may have a lower cap or a smaller
1762
- * take-rate.
1763
- *
1764
- * ```json
1765
- * ...
1766
- * "model_type": "bulk_bps",
1767
- * "bulk_bps_config": {
1768
- * "tiers": [
1769
- * {
1770
- * "maximum_amount": "1000000.00",
1771
- * "bps": 125,
1772
- * "per_unit_maximum": "19.00"
1773
- * },
1774
- * {
1775
- * "maximum_amount": null,
1776
- * "bps": 115,
1777
- * "per_unit_maximum": "4.00"
1778
- * }
1779
- * ]
1780
- * }
1781
- * ...
1782
- * }
1783
- * ```
1784
- *
1785
- * ## Tiered BPS pricing
1786
- *
1787
- * Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
1788
- * event's applicable parameter is a function of its marginal addition to the
1789
- * period total. Similar to tiered pricing, the BPS parameters of a given event
1790
- * depends on the tier range that it falls into, where each tier range is defined
1791
- * by an upper and lower bound. For example, the first few payments may have a 0.8
1792
- * BPS take-rate and all payments after a specific volume may incur a take-rate of
1793
- * 0.5 BPS each.
1794
- *
1795
- * ```json
1796
- * ...
1797
- * "model_type": "tiered_bps",
1798
- * "tiered_bps_config": {
1799
- * "tiers": [
1800
- * {
1801
- * "minimum_amount": "0",
1802
- * "maximum_amount": "1000000.00",
1803
- * "bps": 125,
1804
- * "per_unit_maximum": "19.00"
1805
- * },
1806
- * {
1807
- * "minimum_amount": "1000000.00",
1808
- * "maximum_amount": null,
1809
- * "bps": 115,
1810
- * "per_unit_maximum": "4.00"
1811
- * }
1812
- * ]
1813
- * }
1814
- * ...
1815
- * }
1816
- * ```
1817
- *
1818
- * ## Matrix pricing
1819
- *
1820
- * Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
1821
- * `dimensions` defines the two event property values evaluated in this pricing
1822
- * model. In a one-dimensional matrix, the second value is `null`. Every
1823
- * configuration has a list of `matrix_values` which give the unit prices for
1824
- * specified property values. In a one-dimensional matrix, the matrix values will
1825
- * have `dimension_values` where the second value of the pair is null. If an event
1826
- * does not match any of the dimension values in the matrix, it will resort to the
1827
- * `default_unit_amount`.
1828
- *
1829
- * ```json
1830
- * {
1831
- * "model_type": "matrix"
1832
- * "matrix_config": {
1833
- * "default_unit_amount": "3.00",
1834
- * "dimensions": [
1835
- * "cluster_name",
1836
- * "region"
1837
- * ],
1838
- * "matrix_values": [
1839
- * {
1840
- * "dimension_values": [
1841
- * "alpha",
1842
- * "west"
1843
- * ],
1844
- * "unit_amount": "2.00"
1845
- * },
1846
- * ...
1847
- * ]
1848
- * }
1849
- * }
1850
- * ```
1851
- *
1852
- * ## Fixed fees
1853
- *
1854
- * Fixed fees are prices that are applied independent of usage quantities, and
1855
- * follow unit pricing. They also have an additional parameter
1856
- * `fixed_price_quantity`. If the Price represents a fixed cost, this represents
1857
- * the quantity of units applied.
1858
- *
1859
- * ```json
1860
- * {
1861
- * ...
1862
- * "id": "price_id",
1863
- * "model_type": "unit",
1864
- * "unit_config": {
1865
- * "unit_amount": "2.00"
1866
- * },
1867
- * "fixed_price_quantity": 3.0
1868
- * ...
1869
- * }
1870
- * ```
1651
+ * For more on the types of prices, see
1652
+ * [the core concepts documentation](/core-concepts#plan-and-price)
1871
1653
  */
1872
1654
  price: PricesAPI.Price;
1873
1655
 
@@ -2038,7 +1820,7 @@ export interface SubscriptionCreateResponse {
2038
1820
  * it's often desirable to have these match existing identifiers in your system. To
2039
1821
  * avoid having to denormalize Orb ID information, you can pass in an
2040
1822
  * `external_customer_id` with your own identifier. See
2041
- * [Customer ID Aliases](../guides/events-and-metrics/customer-aliases) for further
1823
+ * [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
2042
1824
  * information about how these aliases work in Orb.
2043
1825
  *
2044
1826
  * In addition to having an identifier in your system, a customer may exist in a
@@ -2047,9 +1829,8 @@ export interface SubscriptionCreateResponse {
2047
1829
  *
2048
1830
  * A customer also has a timezone (from the standard
2049
1831
  * [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
2050
- * your account's timezone. See
2051
- * [Timezone localization](../guides/product-catalog/timezones.md) for information
2052
- * on what this timezone parameter influences within Orb.
1832
+ * your account's timezone. See [Timezone localization](/essentials/timezones) for
1833
+ * information on what this timezone parameter influences within Orb.
2053
1834
  */
2054
1835
  customer: CustomersAPI.Customer;
2055
1836
 
@@ -2104,9 +1885,9 @@ export interface SubscriptionCreateResponse {
2104
1885
  net_terms: number;
2105
1886
 
2106
1887
  /**
2107
- * The [Plan](../guides/core-concepts.mdx#plan-and-price) resource represents a
2108
- * plan that can be subscribed to by a customer. Plans define the billing behavior
2109
- * of the subscription. You can see more about how to configure prices in the
1888
+ * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
1889
+ * subscribed to by a customer. Plans define the billing behavior of the
1890
+ * subscription. You can see more about how to configure prices in the
2110
1891
  * [Price resource](/reference/price).
2111
1892
  */
2112
1893
  plan: PlansAPI.Plan;
@@ -2553,229 +2334,8 @@ export namespace SubscriptionCreateResponse {
2553
2334
  * is serialized differently in a given Price object. The model_type field
2554
2335
  * determines the key for the configuration object that is present.
2555
2336
  *
2556
- * ## Unit pricing
2557
- *
2558
- * With unit pricing, each unit costs a fixed amount.
2559
- *
2560
- * ```json
2561
- * {
2562
- * ...
2563
- * "model_type": "unit",
2564
- * "unit_config": {
2565
- * "unit_amount": "0.50"
2566
- * }
2567
- * ...
2568
- * }
2569
- * ```
2570
- *
2571
- * ## Tiered pricing
2572
- *
2573
- * In tiered pricing, the cost of a given unit depends on the tier range that it
2574
- * falls into, where each tier range is defined by an upper and lower bound. For
2575
- * example, the first ten units may cost $0.50 each and all units thereafter may
2576
- * cost $0.10 each.
2577
- *
2578
- * ```json
2579
- * {
2580
- * ...
2581
- * "model_type": "tiered",
2582
- * "tiered_config": {
2583
- * "tiers": [
2584
- * {
2585
- * "first_unit": 1,
2586
- * "last_unit": 10,
2587
- * "unit_amount": "0.50"
2588
- * },
2589
- * {
2590
- * "first_unit": 11,
2591
- * "last_unit": null,
2592
- * "unit_amount": "0.10"
2593
- * }
2594
- * ]
2595
- * }
2596
- * ...
2597
- * ```
2598
- *
2599
- * ## Bulk pricing
2600
- *
2601
- * Bulk pricing applies when the number of units determine the cost of all units.
2602
- * For example, if you've bought less than 10 units, they may each be $0.50 for a
2603
- * total of $5.00. Once you've bought more than 10 units, all units may now be
2604
- * priced at $0.40 (i.e. 101 units total would be $40.40).
2605
- *
2606
- * ```json
2607
- * {
2608
- * ...
2609
- * "model_type": "bulk",
2610
- * "bulk_config": {
2611
- * "tiers": [
2612
- * {
2613
- * "maximum_units": 10,
2614
- * "unit_amount": "0.50"
2615
- * },
2616
- * {
2617
- * "maximum_units": 1000,
2618
- * "unit_amount": "0.40"
2619
- * }
2620
- * ]
2621
- * }
2622
- * ...
2623
- * }
2624
- * ```
2625
- *
2626
- * ## Package pricing
2627
- *
2628
- * Package pricing defines the size or granularity of a unit for billing purposes.
2629
- * For example, if the package size is set to 5, then 4 units will be billed as 5
2630
- * and 6 units will be billed at 10.
2631
- *
2632
- * ```json
2633
- * {
2634
- * ...
2635
- * "model_type": "package",
2636
- * "package_config": {
2637
- * "package_amount": "0.80",
2638
- * "package_size": 10
2639
- * }
2640
- * ...
2641
- * }
2642
- * ```
2643
- *
2644
- * ## BPS pricing
2645
- *
2646
- * BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
2647
- * percent (the number of basis points to charge), as well as a cap per event to
2648
- * assess. For example, this would allow you to assess a fee of 0.25% on every
2649
- * payment you process, with a maximum charge of $25 per payment.
2650
- *
2651
- * ```json
2652
- * {
2653
- * ...
2654
- * "model_type": "bps",
2655
- * "bps_config": {
2656
- * "bps": 125,
2657
- * "per_unit_maximum": "11.00"
2658
- * }
2659
- * ...
2660
- * }
2661
- * ```
2662
- *
2663
- * ## Bulk BPS pricing
2664
- *
2665
- * Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
2666
- * total quantity across all events. Similar to bulk pricing, the BPS parameters of
2667
- * a given event depends on the tier range that the billing period falls into. Each
2668
- * tier range is defined by an upper bound. For example, after $1.5M of payment
2669
- * volume is reached, each individual payment may have a lower cap or a smaller
2670
- * take-rate.
2671
- *
2672
- * ```json
2673
- * ...
2674
- * "model_type": "bulk_bps",
2675
- * "bulk_bps_config": {
2676
- * "tiers": [
2677
- * {
2678
- * "maximum_amount": "1000000.00",
2679
- * "bps": 125,
2680
- * "per_unit_maximum": "19.00"
2681
- * },
2682
- * {
2683
- * "maximum_amount": null,
2684
- * "bps": 115,
2685
- * "per_unit_maximum": "4.00"
2686
- * }
2687
- * ]
2688
- * }
2689
- * ...
2690
- * }
2691
- * ```
2692
- *
2693
- * ## Tiered BPS pricing
2694
- *
2695
- * Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
2696
- * event's applicable parameter is a function of its marginal addition to the
2697
- * period total. Similar to tiered pricing, the BPS parameters of a given event
2698
- * depends on the tier range that it falls into, where each tier range is defined
2699
- * by an upper and lower bound. For example, the first few payments may have a 0.8
2700
- * BPS take-rate and all payments after a specific volume may incur a take-rate of
2701
- * 0.5 BPS each.
2702
- *
2703
- * ```json
2704
- * ...
2705
- * "model_type": "tiered_bps",
2706
- * "tiered_bps_config": {
2707
- * "tiers": [
2708
- * {
2709
- * "minimum_amount": "0",
2710
- * "maximum_amount": "1000000.00",
2711
- * "bps": 125,
2712
- * "per_unit_maximum": "19.00"
2713
- * },
2714
- * {
2715
- * "minimum_amount": "1000000.00",
2716
- * "maximum_amount": null,
2717
- * "bps": 115,
2718
- * "per_unit_maximum": "4.00"
2719
- * }
2720
- * ]
2721
- * }
2722
- * ...
2723
- * }
2724
- * ```
2725
- *
2726
- * ## Matrix pricing
2727
- *
2728
- * Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
2729
- * `dimensions` defines the two event property values evaluated in this pricing
2730
- * model. In a one-dimensional matrix, the second value is `null`. Every
2731
- * configuration has a list of `matrix_values` which give the unit prices for
2732
- * specified property values. In a one-dimensional matrix, the matrix values will
2733
- * have `dimension_values` where the second value of the pair is null. If an event
2734
- * does not match any of the dimension values in the matrix, it will resort to the
2735
- * `default_unit_amount`.
2736
- *
2737
- * ```json
2738
- * {
2739
- * "model_type": "matrix"
2740
- * "matrix_config": {
2741
- * "default_unit_amount": "3.00",
2742
- * "dimensions": [
2743
- * "cluster_name",
2744
- * "region"
2745
- * ],
2746
- * "matrix_values": [
2747
- * {
2748
- * "dimension_values": [
2749
- * "alpha",
2750
- * "west"
2751
- * ],
2752
- * "unit_amount": "2.00"
2753
- * },
2754
- * ...
2755
- * ]
2756
- * }
2757
- * }
2758
- * ```
2759
- *
2760
- * ## Fixed fees
2761
- *
2762
- * Fixed fees are prices that are applied independent of usage quantities, and
2763
- * follow unit pricing. They also have an additional parameter
2764
- * `fixed_price_quantity`. If the Price represents a fixed cost, this represents
2765
- * the quantity of units applied.
2766
- *
2767
- * ```json
2768
- * {
2769
- * ...
2770
- * "id": "price_id",
2771
- * "model_type": "unit",
2772
- * "unit_config": {
2773
- * "unit_amount": "2.00"
2774
- * },
2775
- * "fixed_price_quantity": 3.0
2776
- * ...
2777
- * }
2778
- * ```
2337
+ * For more on the types of prices, see
2338
+ * [the core concepts documentation](/core-concepts#plan-and-price)
2779
2339
  */
2780
2340
  price: PricesAPI.Price;
2781
2341
 
@@ -2864,7 +2424,7 @@ export interface SubscriptionCancelResponse {
2864
2424
  * it's often desirable to have these match existing identifiers in your system. To
2865
2425
  * avoid having to denormalize Orb ID information, you can pass in an
2866
2426
  * `external_customer_id` with your own identifier. See
2867
- * [Customer ID Aliases](../guides/events-and-metrics/customer-aliases) for further
2427
+ * [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
2868
2428
  * information about how these aliases work in Orb.
2869
2429
  *
2870
2430
  * In addition to having an identifier in your system, a customer may exist in a
@@ -2873,9 +2433,8 @@ export interface SubscriptionCancelResponse {
2873
2433
  *
2874
2434
  * A customer also has a timezone (from the standard
2875
2435
  * [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
2876
- * your account's timezone. See
2877
- * [Timezone localization](../guides/product-catalog/timezones.md) for information
2878
- * on what this timezone parameter influences within Orb.
2436
+ * your account's timezone. See [Timezone localization](/essentials/timezones) for
2437
+ * information on what this timezone parameter influences within Orb.
2879
2438
  */
2880
2439
  customer: CustomersAPI.Customer;
2881
2440
 
@@ -2930,9 +2489,9 @@ export interface SubscriptionCancelResponse {
2930
2489
  net_terms: number;
2931
2490
 
2932
2491
  /**
2933
- * The [Plan](../guides/core-concepts.mdx#plan-and-price) resource represents a
2934
- * plan that can be subscribed to by a customer. Plans define the billing behavior
2935
- * of the subscription. You can see more about how to configure prices in the
2492
+ * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
2493
+ * subscribed to by a customer. Plans define the billing behavior of the
2494
+ * subscription. You can see more about how to configure prices in the
2936
2495
  * [Price resource](/reference/price).
2937
2496
  */
2938
2497
  plan: PlansAPI.Plan;
@@ -3379,229 +2938,8 @@ export namespace SubscriptionCancelResponse {
3379
2938
  * is serialized differently in a given Price object. The model_type field
3380
2939
  * determines the key for the configuration object that is present.
3381
2940
  *
3382
- * ## Unit pricing
3383
- *
3384
- * With unit pricing, each unit costs a fixed amount.
3385
- *
3386
- * ```json
3387
- * {
3388
- * ...
3389
- * "model_type": "unit",
3390
- * "unit_config": {
3391
- * "unit_amount": "0.50"
3392
- * }
3393
- * ...
3394
- * }
3395
- * ```
3396
- *
3397
- * ## Tiered pricing
3398
- *
3399
- * In tiered pricing, the cost of a given unit depends on the tier range that it
3400
- * falls into, where each tier range is defined by an upper and lower bound. For
3401
- * example, the first ten units may cost $0.50 each and all units thereafter may
3402
- * cost $0.10 each.
3403
- *
3404
- * ```json
3405
- * {
3406
- * ...
3407
- * "model_type": "tiered",
3408
- * "tiered_config": {
3409
- * "tiers": [
3410
- * {
3411
- * "first_unit": 1,
3412
- * "last_unit": 10,
3413
- * "unit_amount": "0.50"
3414
- * },
3415
- * {
3416
- * "first_unit": 11,
3417
- * "last_unit": null,
3418
- * "unit_amount": "0.10"
3419
- * }
3420
- * ]
3421
- * }
3422
- * ...
3423
- * ```
3424
- *
3425
- * ## Bulk pricing
3426
- *
3427
- * Bulk pricing applies when the number of units determine the cost of all units.
3428
- * For example, if you've bought less than 10 units, they may each be $0.50 for a
3429
- * total of $5.00. Once you've bought more than 10 units, all units may now be
3430
- * priced at $0.40 (i.e. 101 units total would be $40.40).
3431
- *
3432
- * ```json
3433
- * {
3434
- * ...
3435
- * "model_type": "bulk",
3436
- * "bulk_config": {
3437
- * "tiers": [
3438
- * {
3439
- * "maximum_units": 10,
3440
- * "unit_amount": "0.50"
3441
- * },
3442
- * {
3443
- * "maximum_units": 1000,
3444
- * "unit_amount": "0.40"
3445
- * }
3446
- * ]
3447
- * }
3448
- * ...
3449
- * }
3450
- * ```
3451
- *
3452
- * ## Package pricing
3453
- *
3454
- * Package pricing defines the size or granularity of a unit for billing purposes.
3455
- * For example, if the package size is set to 5, then 4 units will be billed as 5
3456
- * and 6 units will be billed at 10.
3457
- *
3458
- * ```json
3459
- * {
3460
- * ...
3461
- * "model_type": "package",
3462
- * "package_config": {
3463
- * "package_amount": "0.80",
3464
- * "package_size": 10
3465
- * }
3466
- * ...
3467
- * }
3468
- * ```
3469
- *
3470
- * ## BPS pricing
3471
- *
3472
- * BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
3473
- * percent (the number of basis points to charge), as well as a cap per event to
3474
- * assess. For example, this would allow you to assess a fee of 0.25% on every
3475
- * payment you process, with a maximum charge of $25 per payment.
3476
- *
3477
- * ```json
3478
- * {
3479
- * ...
3480
- * "model_type": "bps",
3481
- * "bps_config": {
3482
- * "bps": 125,
3483
- * "per_unit_maximum": "11.00"
3484
- * }
3485
- * ...
3486
- * }
3487
- * ```
3488
- *
3489
- * ## Bulk BPS pricing
3490
- *
3491
- * Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
3492
- * total quantity across all events. Similar to bulk pricing, the BPS parameters of
3493
- * a given event depends on the tier range that the billing period falls into. Each
3494
- * tier range is defined by an upper bound. For example, after $1.5M of payment
3495
- * volume is reached, each individual payment may have a lower cap or a smaller
3496
- * take-rate.
3497
- *
3498
- * ```json
3499
- * ...
3500
- * "model_type": "bulk_bps",
3501
- * "bulk_bps_config": {
3502
- * "tiers": [
3503
- * {
3504
- * "maximum_amount": "1000000.00",
3505
- * "bps": 125,
3506
- * "per_unit_maximum": "19.00"
3507
- * },
3508
- * {
3509
- * "maximum_amount": null,
3510
- * "bps": 115,
3511
- * "per_unit_maximum": "4.00"
3512
- * }
3513
- * ]
3514
- * }
3515
- * ...
3516
- * }
3517
- * ```
3518
- *
3519
- * ## Tiered BPS pricing
3520
- *
3521
- * Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
3522
- * event's applicable parameter is a function of its marginal addition to the
3523
- * period total. Similar to tiered pricing, the BPS parameters of a given event
3524
- * depends on the tier range that it falls into, where each tier range is defined
3525
- * by an upper and lower bound. For example, the first few payments may have a 0.8
3526
- * BPS take-rate and all payments after a specific volume may incur a take-rate of
3527
- * 0.5 BPS each.
3528
- *
3529
- * ```json
3530
- * ...
3531
- * "model_type": "tiered_bps",
3532
- * "tiered_bps_config": {
3533
- * "tiers": [
3534
- * {
3535
- * "minimum_amount": "0",
3536
- * "maximum_amount": "1000000.00",
3537
- * "bps": 125,
3538
- * "per_unit_maximum": "19.00"
3539
- * },
3540
- * {
3541
- * "minimum_amount": "1000000.00",
3542
- * "maximum_amount": null,
3543
- * "bps": 115,
3544
- * "per_unit_maximum": "4.00"
3545
- * }
3546
- * ]
3547
- * }
3548
- * ...
3549
- * }
3550
- * ```
3551
- *
3552
- * ## Matrix pricing
3553
- *
3554
- * Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
3555
- * `dimensions` defines the two event property values evaluated in this pricing
3556
- * model. In a one-dimensional matrix, the second value is `null`. Every
3557
- * configuration has a list of `matrix_values` which give the unit prices for
3558
- * specified property values. In a one-dimensional matrix, the matrix values will
3559
- * have `dimension_values` where the second value of the pair is null. If an event
3560
- * does not match any of the dimension values in the matrix, it will resort to the
3561
- * `default_unit_amount`.
3562
- *
3563
- * ```json
3564
- * {
3565
- * "model_type": "matrix"
3566
- * "matrix_config": {
3567
- * "default_unit_amount": "3.00",
3568
- * "dimensions": [
3569
- * "cluster_name",
3570
- * "region"
3571
- * ],
3572
- * "matrix_values": [
3573
- * {
3574
- * "dimension_values": [
3575
- * "alpha",
3576
- * "west"
3577
- * ],
3578
- * "unit_amount": "2.00"
3579
- * },
3580
- * ...
3581
- * ]
3582
- * }
3583
- * }
3584
- * ```
3585
- *
3586
- * ## Fixed fees
3587
- *
3588
- * Fixed fees are prices that are applied independent of usage quantities, and
3589
- * follow unit pricing. They also have an additional parameter
3590
- * `fixed_price_quantity`. If the Price represents a fixed cost, this represents
3591
- * the quantity of units applied.
3592
- *
3593
- * ```json
3594
- * {
3595
- * ...
3596
- * "id": "price_id",
3597
- * "model_type": "unit",
3598
- * "unit_config": {
3599
- * "unit_amount": "2.00"
3600
- * },
3601
- * "fixed_price_quantity": 3.0
3602
- * ...
3603
- * }
3604
- * ```
2941
+ * For more on the types of prices, see
2942
+ * [the core concepts documentation](/core-concepts#plan-and-price)
3605
2943
  */
3606
2944
  price: PricesAPI.Price;
3607
2945
 
@@ -3669,229 +3007,8 @@ export namespace SubscriptionFetchCostsResponse {
3669
3007
  * is serialized differently in a given Price object. The model_type field
3670
3008
  * determines the key for the configuration object that is present.
3671
3009
  *
3672
- * ## Unit pricing
3673
- *
3674
- * With unit pricing, each unit costs a fixed amount.
3675
- *
3676
- * ```json
3677
- * {
3678
- * ...
3679
- * "model_type": "unit",
3680
- * "unit_config": {
3681
- * "unit_amount": "0.50"
3682
- * }
3683
- * ...
3684
- * }
3685
- * ```
3686
- *
3687
- * ## Tiered pricing
3688
- *
3689
- * In tiered pricing, the cost of a given unit depends on the tier range that it
3690
- * falls into, where each tier range is defined by an upper and lower bound. For
3691
- * example, the first ten units may cost $0.50 each and all units thereafter may
3692
- * cost $0.10 each.
3693
- *
3694
- * ```json
3695
- * {
3696
- * ...
3697
- * "model_type": "tiered",
3698
- * "tiered_config": {
3699
- * "tiers": [
3700
- * {
3701
- * "first_unit": 1,
3702
- * "last_unit": 10,
3703
- * "unit_amount": "0.50"
3704
- * },
3705
- * {
3706
- * "first_unit": 11,
3707
- * "last_unit": null,
3708
- * "unit_amount": "0.10"
3709
- * }
3710
- * ]
3711
- * }
3712
- * ...
3713
- * ```
3714
- *
3715
- * ## Bulk pricing
3716
- *
3717
- * Bulk pricing applies when the number of units determine the cost of all units.
3718
- * For example, if you've bought less than 10 units, they may each be $0.50 for a
3719
- * total of $5.00. Once you've bought more than 10 units, all units may now be
3720
- * priced at $0.40 (i.e. 101 units total would be $40.40).
3721
- *
3722
- * ```json
3723
- * {
3724
- * ...
3725
- * "model_type": "bulk",
3726
- * "bulk_config": {
3727
- * "tiers": [
3728
- * {
3729
- * "maximum_units": 10,
3730
- * "unit_amount": "0.50"
3731
- * },
3732
- * {
3733
- * "maximum_units": 1000,
3734
- * "unit_amount": "0.40"
3735
- * }
3736
- * ]
3737
- * }
3738
- * ...
3739
- * }
3740
- * ```
3741
- *
3742
- * ## Package pricing
3743
- *
3744
- * Package pricing defines the size or granularity of a unit for billing purposes.
3745
- * For example, if the package size is set to 5, then 4 units will be billed as 5
3746
- * and 6 units will be billed at 10.
3747
- *
3748
- * ```json
3749
- * {
3750
- * ...
3751
- * "model_type": "package",
3752
- * "package_config": {
3753
- * "package_amount": "0.80",
3754
- * "package_size": 10
3755
- * }
3756
- * ...
3757
- * }
3758
- * ```
3759
- *
3760
- * ## BPS pricing
3761
- *
3762
- * BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
3763
- * percent (the number of basis points to charge), as well as a cap per event to
3764
- * assess. For example, this would allow you to assess a fee of 0.25% on every
3765
- * payment you process, with a maximum charge of $25 per payment.
3766
- *
3767
- * ```json
3768
- * {
3769
- * ...
3770
- * "model_type": "bps",
3771
- * "bps_config": {
3772
- * "bps": 125,
3773
- * "per_unit_maximum": "11.00"
3774
- * }
3775
- * ...
3776
- * }
3777
- * ```
3778
- *
3779
- * ## Bulk BPS pricing
3780
- *
3781
- * Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
3782
- * total quantity across all events. Similar to bulk pricing, the BPS parameters of
3783
- * a given event depends on the tier range that the billing period falls into. Each
3784
- * tier range is defined by an upper bound. For example, after $1.5M of payment
3785
- * volume is reached, each individual payment may have a lower cap or a smaller
3786
- * take-rate.
3787
- *
3788
- * ```json
3789
- * ...
3790
- * "model_type": "bulk_bps",
3791
- * "bulk_bps_config": {
3792
- * "tiers": [
3793
- * {
3794
- * "maximum_amount": "1000000.00",
3795
- * "bps": 125,
3796
- * "per_unit_maximum": "19.00"
3797
- * },
3798
- * {
3799
- * "maximum_amount": null,
3800
- * "bps": 115,
3801
- * "per_unit_maximum": "4.00"
3802
- * }
3803
- * ]
3804
- * }
3805
- * ...
3806
- * }
3807
- * ```
3808
- *
3809
- * ## Tiered BPS pricing
3810
- *
3811
- * Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
3812
- * event's applicable parameter is a function of its marginal addition to the
3813
- * period total. Similar to tiered pricing, the BPS parameters of a given event
3814
- * depends on the tier range that it falls into, where each tier range is defined
3815
- * by an upper and lower bound. For example, the first few payments may have a 0.8
3816
- * BPS take-rate and all payments after a specific volume may incur a take-rate of
3817
- * 0.5 BPS each.
3818
- *
3819
- * ```json
3820
- * ...
3821
- * "model_type": "tiered_bps",
3822
- * "tiered_bps_config": {
3823
- * "tiers": [
3824
- * {
3825
- * "minimum_amount": "0",
3826
- * "maximum_amount": "1000000.00",
3827
- * "bps": 125,
3828
- * "per_unit_maximum": "19.00"
3829
- * },
3830
- * {
3831
- * "minimum_amount": "1000000.00",
3832
- * "maximum_amount": null,
3833
- * "bps": 115,
3834
- * "per_unit_maximum": "4.00"
3835
- * }
3836
- * ]
3837
- * }
3838
- * ...
3839
- * }
3840
- * ```
3841
- *
3842
- * ## Matrix pricing
3843
- *
3844
- * Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
3845
- * `dimensions` defines the two event property values evaluated in this pricing
3846
- * model. In a one-dimensional matrix, the second value is `null`. Every
3847
- * configuration has a list of `matrix_values` which give the unit prices for
3848
- * specified property values. In a one-dimensional matrix, the matrix values will
3849
- * have `dimension_values` where the second value of the pair is null. If an event
3850
- * does not match any of the dimension values in the matrix, it will resort to the
3851
- * `default_unit_amount`.
3852
- *
3853
- * ```json
3854
- * {
3855
- * "model_type": "matrix"
3856
- * "matrix_config": {
3857
- * "default_unit_amount": "3.00",
3858
- * "dimensions": [
3859
- * "cluster_name",
3860
- * "region"
3861
- * ],
3862
- * "matrix_values": [
3863
- * {
3864
- * "dimension_values": [
3865
- * "alpha",
3866
- * "west"
3867
- * ],
3868
- * "unit_amount": "2.00"
3869
- * },
3870
- * ...
3871
- * ]
3872
- * }
3873
- * }
3874
- * ```
3875
- *
3876
- * ## Fixed fees
3877
- *
3878
- * Fixed fees are prices that are applied independent of usage quantities, and
3879
- * follow unit pricing. They also have an additional parameter
3880
- * `fixed_price_quantity`. If the Price represents a fixed cost, this represents
3881
- * the quantity of units applied.
3882
- *
3883
- * ```json
3884
- * {
3885
- * ...
3886
- * "id": "price_id",
3887
- * "model_type": "unit",
3888
- * "unit_config": {
3889
- * "unit_amount": "2.00"
3890
- * },
3891
- * "fixed_price_quantity": 3.0
3892
- * ...
3893
- * }
3894
- * ```
3010
+ * For more on the types of prices, see
3011
+ * [the core concepts documentation](/core-concepts#plan-and-price)
3895
3012
  */
3896
3013
  price: PricesAPI.Price;
3897
3014
 
@@ -3993,7 +3110,7 @@ export interface SubscriptionPriceIntervalsResponse {
3993
3110
  * it's often desirable to have these match existing identifiers in your system. To
3994
3111
  * avoid having to denormalize Orb ID information, you can pass in an
3995
3112
  * `external_customer_id` with your own identifier. See
3996
- * [Customer ID Aliases](../guides/events-and-metrics/customer-aliases) for further
3113
+ * [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
3997
3114
  * information about how these aliases work in Orb.
3998
3115
  *
3999
3116
  * In addition to having an identifier in your system, a customer may exist in a
@@ -4002,9 +3119,8 @@ export interface SubscriptionPriceIntervalsResponse {
4002
3119
  *
4003
3120
  * A customer also has a timezone (from the standard
4004
3121
  * [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
4005
- * your account's timezone. See
4006
- * [Timezone localization](../guides/product-catalog/timezones.md) for information
4007
- * on what this timezone parameter influences within Orb.
3122
+ * your account's timezone. See [Timezone localization](/essentials/timezones) for
3123
+ * information on what this timezone parameter influences within Orb.
4008
3124
  */
4009
3125
  customer: CustomersAPI.Customer;
4010
3126
 
@@ -4059,9 +3175,9 @@ export interface SubscriptionPriceIntervalsResponse {
4059
3175
  net_terms: number;
4060
3176
 
4061
3177
  /**
4062
- * The [Plan](../guides/core-concepts.mdx#plan-and-price) resource represents a
4063
- * plan that can be subscribed to by a customer. Plans define the billing behavior
4064
- * of the subscription. You can see more about how to configure prices in the
3178
+ * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
3179
+ * subscribed to by a customer. Plans define the billing behavior of the
3180
+ * subscription. You can see more about how to configure prices in the
4065
3181
  * [Price resource](/reference/price).
4066
3182
  */
4067
3183
  plan: PlansAPI.Plan;
@@ -4508,229 +3624,8 @@ export namespace SubscriptionPriceIntervalsResponse {
4508
3624
  * is serialized differently in a given Price object. The model_type field
4509
3625
  * determines the key for the configuration object that is present.
4510
3626
  *
4511
- * ## Unit pricing
4512
- *
4513
- * With unit pricing, each unit costs a fixed amount.
4514
- *
4515
- * ```json
4516
- * {
4517
- * ...
4518
- * "model_type": "unit",
4519
- * "unit_config": {
4520
- * "unit_amount": "0.50"
4521
- * }
4522
- * ...
4523
- * }
4524
- * ```
4525
- *
4526
- * ## Tiered pricing
4527
- *
4528
- * In tiered pricing, the cost of a given unit depends on the tier range that it
4529
- * falls into, where each tier range is defined by an upper and lower bound. For
4530
- * example, the first ten units may cost $0.50 each and all units thereafter may
4531
- * cost $0.10 each.
4532
- *
4533
- * ```json
4534
- * {
4535
- * ...
4536
- * "model_type": "tiered",
4537
- * "tiered_config": {
4538
- * "tiers": [
4539
- * {
4540
- * "first_unit": 1,
4541
- * "last_unit": 10,
4542
- * "unit_amount": "0.50"
4543
- * },
4544
- * {
4545
- * "first_unit": 11,
4546
- * "last_unit": null,
4547
- * "unit_amount": "0.10"
4548
- * }
4549
- * ]
4550
- * }
4551
- * ...
4552
- * ```
4553
- *
4554
- * ## Bulk pricing
4555
- *
4556
- * Bulk pricing applies when the number of units determine the cost of all units.
4557
- * For example, if you've bought less than 10 units, they may each be $0.50 for a
4558
- * total of $5.00. Once you've bought more than 10 units, all units may now be
4559
- * priced at $0.40 (i.e. 101 units total would be $40.40).
4560
- *
4561
- * ```json
4562
- * {
4563
- * ...
4564
- * "model_type": "bulk",
4565
- * "bulk_config": {
4566
- * "tiers": [
4567
- * {
4568
- * "maximum_units": 10,
4569
- * "unit_amount": "0.50"
4570
- * },
4571
- * {
4572
- * "maximum_units": 1000,
4573
- * "unit_amount": "0.40"
4574
- * }
4575
- * ]
4576
- * }
4577
- * ...
4578
- * }
4579
- * ```
4580
- *
4581
- * ## Package pricing
4582
- *
4583
- * Package pricing defines the size or granularity of a unit for billing purposes.
4584
- * For example, if the package size is set to 5, then 4 units will be billed as 5
4585
- * and 6 units will be billed at 10.
4586
- *
4587
- * ```json
4588
- * {
4589
- * ...
4590
- * "model_type": "package",
4591
- * "package_config": {
4592
- * "package_amount": "0.80",
4593
- * "package_size": 10
4594
- * }
4595
- * ...
4596
- * }
4597
- * ```
4598
- *
4599
- * ## BPS pricing
4600
- *
4601
- * BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
4602
- * percent (the number of basis points to charge), as well as a cap per event to
4603
- * assess. For example, this would allow you to assess a fee of 0.25% on every
4604
- * payment you process, with a maximum charge of $25 per payment.
4605
- *
4606
- * ```json
4607
- * {
4608
- * ...
4609
- * "model_type": "bps",
4610
- * "bps_config": {
4611
- * "bps": 125,
4612
- * "per_unit_maximum": "11.00"
4613
- * }
4614
- * ...
4615
- * }
4616
- * ```
4617
- *
4618
- * ## Bulk BPS pricing
4619
- *
4620
- * Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
4621
- * total quantity across all events. Similar to bulk pricing, the BPS parameters of
4622
- * a given event depends on the tier range that the billing period falls into. Each
4623
- * tier range is defined by an upper bound. For example, after $1.5M of payment
4624
- * volume is reached, each individual payment may have a lower cap or a smaller
4625
- * take-rate.
4626
- *
4627
- * ```json
4628
- * ...
4629
- * "model_type": "bulk_bps",
4630
- * "bulk_bps_config": {
4631
- * "tiers": [
4632
- * {
4633
- * "maximum_amount": "1000000.00",
4634
- * "bps": 125,
4635
- * "per_unit_maximum": "19.00"
4636
- * },
4637
- * {
4638
- * "maximum_amount": null,
4639
- * "bps": 115,
4640
- * "per_unit_maximum": "4.00"
4641
- * }
4642
- * ]
4643
- * }
4644
- * ...
4645
- * }
4646
- * ```
4647
- *
4648
- * ## Tiered BPS pricing
4649
- *
4650
- * Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
4651
- * event's applicable parameter is a function of its marginal addition to the
4652
- * period total. Similar to tiered pricing, the BPS parameters of a given event
4653
- * depends on the tier range that it falls into, where each tier range is defined
4654
- * by an upper and lower bound. For example, the first few payments may have a 0.8
4655
- * BPS take-rate and all payments after a specific volume may incur a take-rate of
4656
- * 0.5 BPS each.
4657
- *
4658
- * ```json
4659
- * ...
4660
- * "model_type": "tiered_bps",
4661
- * "tiered_bps_config": {
4662
- * "tiers": [
4663
- * {
4664
- * "minimum_amount": "0",
4665
- * "maximum_amount": "1000000.00",
4666
- * "bps": 125,
4667
- * "per_unit_maximum": "19.00"
4668
- * },
4669
- * {
4670
- * "minimum_amount": "1000000.00",
4671
- * "maximum_amount": null,
4672
- * "bps": 115,
4673
- * "per_unit_maximum": "4.00"
4674
- * }
4675
- * ]
4676
- * }
4677
- * ...
4678
- * }
4679
- * ```
4680
- *
4681
- * ## Matrix pricing
4682
- *
4683
- * Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
4684
- * `dimensions` defines the two event property values evaluated in this pricing
4685
- * model. In a one-dimensional matrix, the second value is `null`. Every
4686
- * configuration has a list of `matrix_values` which give the unit prices for
4687
- * specified property values. In a one-dimensional matrix, the matrix values will
4688
- * have `dimension_values` where the second value of the pair is null. If an event
4689
- * does not match any of the dimension values in the matrix, it will resort to the
4690
- * `default_unit_amount`.
4691
- *
4692
- * ```json
4693
- * {
4694
- * "model_type": "matrix"
4695
- * "matrix_config": {
4696
- * "default_unit_amount": "3.00",
4697
- * "dimensions": [
4698
- * "cluster_name",
4699
- * "region"
4700
- * ],
4701
- * "matrix_values": [
4702
- * {
4703
- * "dimension_values": [
4704
- * "alpha",
4705
- * "west"
4706
- * ],
4707
- * "unit_amount": "2.00"
4708
- * },
4709
- * ...
4710
- * ]
4711
- * }
4712
- * }
4713
- * ```
4714
- *
4715
- * ## Fixed fees
4716
- *
4717
- * Fixed fees are prices that are applied independent of usage quantities, and
4718
- * follow unit pricing. They also have an additional parameter
4719
- * `fixed_price_quantity`. If the Price represents a fixed cost, this represents
4720
- * the quantity of units applied.
4721
- *
4722
- * ```json
4723
- * {
4724
- * ...
4725
- * "id": "price_id",
4726
- * "model_type": "unit",
4727
- * "unit_config": {
4728
- * "unit_amount": "2.00"
4729
- * },
4730
- * "fixed_price_quantity": 3.0
4731
- * ...
4732
- * }
4733
- * ```
3627
+ * For more on the types of prices, see
3628
+ * [the core concepts documentation](/core-concepts#plan-and-price)
4734
3629
  */
4735
3630
  price: PricesAPI.Price;
4736
3631
 
@@ -4819,7 +3714,7 @@ export interface SubscriptionSchedulePlanChangeResponse {
4819
3714
  * it's often desirable to have these match existing identifiers in your system. To
4820
3715
  * avoid having to denormalize Orb ID information, you can pass in an
4821
3716
  * `external_customer_id` with your own identifier. See
4822
- * [Customer ID Aliases](../guides/events-and-metrics/customer-aliases) for further
3717
+ * [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
4823
3718
  * information about how these aliases work in Orb.
4824
3719
  *
4825
3720
  * In addition to having an identifier in your system, a customer may exist in a
@@ -4828,9 +3723,8 @@ export interface SubscriptionSchedulePlanChangeResponse {
4828
3723
  *
4829
3724
  * A customer also has a timezone (from the standard
4830
3725
  * [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
4831
- * your account's timezone. See
4832
- * [Timezone localization](../guides/product-catalog/timezones.md) for information
4833
- * on what this timezone parameter influences within Orb.
3726
+ * your account's timezone. See [Timezone localization](/essentials/timezones) for
3727
+ * information on what this timezone parameter influences within Orb.
4834
3728
  */
4835
3729
  customer: CustomersAPI.Customer;
4836
3730
 
@@ -4885,9 +3779,9 @@ export interface SubscriptionSchedulePlanChangeResponse {
4885
3779
  net_terms: number;
4886
3780
 
4887
3781
  /**
4888
- * The [Plan](../guides/core-concepts.mdx#plan-and-price) resource represents a
4889
- * plan that can be subscribed to by a customer. Plans define the billing behavior
4890
- * of the subscription. You can see more about how to configure prices in the
3782
+ * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
3783
+ * subscribed to by a customer. Plans define the billing behavior of the
3784
+ * subscription. You can see more about how to configure prices in the
4891
3785
  * [Price resource](/reference/price).
4892
3786
  */
4893
3787
  plan: PlansAPI.Plan;
@@ -5334,229 +4228,8 @@ export namespace SubscriptionSchedulePlanChangeResponse {
5334
4228
  * is serialized differently in a given Price object. The model_type field
5335
4229
  * determines the key for the configuration object that is present.
5336
4230
  *
5337
- * ## Unit pricing
5338
- *
5339
- * With unit pricing, each unit costs a fixed amount.
5340
- *
5341
- * ```json
5342
- * {
5343
- * ...
5344
- * "model_type": "unit",
5345
- * "unit_config": {
5346
- * "unit_amount": "0.50"
5347
- * }
5348
- * ...
5349
- * }
5350
- * ```
5351
- *
5352
- * ## Tiered pricing
5353
- *
5354
- * In tiered pricing, the cost of a given unit depends on the tier range that it
5355
- * falls into, where each tier range is defined by an upper and lower bound. For
5356
- * example, the first ten units may cost $0.50 each and all units thereafter may
5357
- * cost $0.10 each.
5358
- *
5359
- * ```json
5360
- * {
5361
- * ...
5362
- * "model_type": "tiered",
5363
- * "tiered_config": {
5364
- * "tiers": [
5365
- * {
5366
- * "first_unit": 1,
5367
- * "last_unit": 10,
5368
- * "unit_amount": "0.50"
5369
- * },
5370
- * {
5371
- * "first_unit": 11,
5372
- * "last_unit": null,
5373
- * "unit_amount": "0.10"
5374
- * }
5375
- * ]
5376
- * }
5377
- * ...
5378
- * ```
5379
- *
5380
- * ## Bulk pricing
5381
- *
5382
- * Bulk pricing applies when the number of units determine the cost of all units.
5383
- * For example, if you've bought less than 10 units, they may each be $0.50 for a
5384
- * total of $5.00. Once you've bought more than 10 units, all units may now be
5385
- * priced at $0.40 (i.e. 101 units total would be $40.40).
5386
- *
5387
- * ```json
5388
- * {
5389
- * ...
5390
- * "model_type": "bulk",
5391
- * "bulk_config": {
5392
- * "tiers": [
5393
- * {
5394
- * "maximum_units": 10,
5395
- * "unit_amount": "0.50"
5396
- * },
5397
- * {
5398
- * "maximum_units": 1000,
5399
- * "unit_amount": "0.40"
5400
- * }
5401
- * ]
5402
- * }
5403
- * ...
5404
- * }
5405
- * ```
5406
- *
5407
- * ## Package pricing
5408
- *
5409
- * Package pricing defines the size or granularity of a unit for billing purposes.
5410
- * For example, if the package size is set to 5, then 4 units will be billed as 5
5411
- * and 6 units will be billed at 10.
5412
- *
5413
- * ```json
5414
- * {
5415
- * ...
5416
- * "model_type": "package",
5417
- * "package_config": {
5418
- * "package_amount": "0.80",
5419
- * "package_size": 10
5420
- * }
5421
- * ...
5422
- * }
5423
- * ```
5424
- *
5425
- * ## BPS pricing
5426
- *
5427
- * BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
5428
- * percent (the number of basis points to charge), as well as a cap per event to
5429
- * assess. For example, this would allow you to assess a fee of 0.25% on every
5430
- * payment you process, with a maximum charge of $25 per payment.
5431
- *
5432
- * ```json
5433
- * {
5434
- * ...
5435
- * "model_type": "bps",
5436
- * "bps_config": {
5437
- * "bps": 125,
5438
- * "per_unit_maximum": "11.00"
5439
- * }
5440
- * ...
5441
- * }
5442
- * ```
5443
- *
5444
- * ## Bulk BPS pricing
5445
- *
5446
- * Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
5447
- * total quantity across all events. Similar to bulk pricing, the BPS parameters of
5448
- * a given event depends on the tier range that the billing period falls into. Each
5449
- * tier range is defined by an upper bound. For example, after $1.5M of payment
5450
- * volume is reached, each individual payment may have a lower cap or a smaller
5451
- * take-rate.
5452
- *
5453
- * ```json
5454
- * ...
5455
- * "model_type": "bulk_bps",
5456
- * "bulk_bps_config": {
5457
- * "tiers": [
5458
- * {
5459
- * "maximum_amount": "1000000.00",
5460
- * "bps": 125,
5461
- * "per_unit_maximum": "19.00"
5462
- * },
5463
- * {
5464
- * "maximum_amount": null,
5465
- * "bps": 115,
5466
- * "per_unit_maximum": "4.00"
5467
- * }
5468
- * ]
5469
- * }
5470
- * ...
5471
- * }
5472
- * ```
5473
- *
5474
- * ## Tiered BPS pricing
5475
- *
5476
- * Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
5477
- * event's applicable parameter is a function of its marginal addition to the
5478
- * period total. Similar to tiered pricing, the BPS parameters of a given event
5479
- * depends on the tier range that it falls into, where each tier range is defined
5480
- * by an upper and lower bound. For example, the first few payments may have a 0.8
5481
- * BPS take-rate and all payments after a specific volume may incur a take-rate of
5482
- * 0.5 BPS each.
5483
- *
5484
- * ```json
5485
- * ...
5486
- * "model_type": "tiered_bps",
5487
- * "tiered_bps_config": {
5488
- * "tiers": [
5489
- * {
5490
- * "minimum_amount": "0",
5491
- * "maximum_amount": "1000000.00",
5492
- * "bps": 125,
5493
- * "per_unit_maximum": "19.00"
5494
- * },
5495
- * {
5496
- * "minimum_amount": "1000000.00",
5497
- * "maximum_amount": null,
5498
- * "bps": 115,
5499
- * "per_unit_maximum": "4.00"
5500
- * }
5501
- * ]
5502
- * }
5503
- * ...
5504
- * }
5505
- * ```
5506
- *
5507
- * ## Matrix pricing
5508
- *
5509
- * Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
5510
- * `dimensions` defines the two event property values evaluated in this pricing
5511
- * model. In a one-dimensional matrix, the second value is `null`. Every
5512
- * configuration has a list of `matrix_values` which give the unit prices for
5513
- * specified property values. In a one-dimensional matrix, the matrix values will
5514
- * have `dimension_values` where the second value of the pair is null. If an event
5515
- * does not match any of the dimension values in the matrix, it will resort to the
5516
- * `default_unit_amount`.
5517
- *
5518
- * ```json
5519
- * {
5520
- * "model_type": "matrix"
5521
- * "matrix_config": {
5522
- * "default_unit_amount": "3.00",
5523
- * "dimensions": [
5524
- * "cluster_name",
5525
- * "region"
5526
- * ],
5527
- * "matrix_values": [
5528
- * {
5529
- * "dimension_values": [
5530
- * "alpha",
5531
- * "west"
5532
- * ],
5533
- * "unit_amount": "2.00"
5534
- * },
5535
- * ...
5536
- * ]
5537
- * }
5538
- * }
5539
- * ```
5540
- *
5541
- * ## Fixed fees
5542
- *
5543
- * Fixed fees are prices that are applied independent of usage quantities, and
5544
- * follow unit pricing. They also have an additional parameter
5545
- * `fixed_price_quantity`. If the Price represents a fixed cost, this represents
5546
- * the quantity of units applied.
5547
- *
5548
- * ```json
5549
- * {
5550
- * ...
5551
- * "id": "price_id",
5552
- * "model_type": "unit",
5553
- * "unit_config": {
5554
- * "unit_amount": "2.00"
5555
- * },
5556
- * "fixed_price_quantity": 3.0
5557
- * ...
5558
- * }
5559
- * ```
4231
+ * For more on the types of prices, see
4232
+ * [the core concepts documentation](/core-concepts#plan-and-price)
5560
4233
  */
5561
4234
  price: PricesAPI.Price;
5562
4235
 
@@ -5645,7 +4318,7 @@ export interface SubscriptionTriggerPhaseResponse {
5645
4318
  * it's often desirable to have these match existing identifiers in your system. To
5646
4319
  * avoid having to denormalize Orb ID information, you can pass in an
5647
4320
  * `external_customer_id` with your own identifier. See
5648
- * [Customer ID Aliases](../guides/events-and-metrics/customer-aliases) for further
4321
+ * [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
5649
4322
  * information about how these aliases work in Orb.
5650
4323
  *
5651
4324
  * In addition to having an identifier in your system, a customer may exist in a
@@ -5654,9 +4327,8 @@ export interface SubscriptionTriggerPhaseResponse {
5654
4327
  *
5655
4328
  * A customer also has a timezone (from the standard
5656
4329
  * [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
5657
- * your account's timezone. See
5658
- * [Timezone localization](../guides/product-catalog/timezones.md) for information
5659
- * on what this timezone parameter influences within Orb.
4330
+ * your account's timezone. See [Timezone localization](/essentials/timezones) for
4331
+ * information on what this timezone parameter influences within Orb.
5660
4332
  */
5661
4333
  customer: CustomersAPI.Customer;
5662
4334
 
@@ -5711,9 +4383,9 @@ export interface SubscriptionTriggerPhaseResponse {
5711
4383
  net_terms: number;
5712
4384
 
5713
4385
  /**
5714
- * The [Plan](../guides/core-concepts.mdx#plan-and-price) resource represents a
5715
- * plan that can be subscribed to by a customer. Plans define the billing behavior
5716
- * of the subscription. You can see more about how to configure prices in the
4386
+ * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
4387
+ * subscribed to by a customer. Plans define the billing behavior of the
4388
+ * subscription. You can see more about how to configure prices in the
5717
4389
  * [Price resource](/reference/price).
5718
4390
  */
5719
4391
  plan: PlansAPI.Plan;
@@ -6160,229 +4832,8 @@ export namespace SubscriptionTriggerPhaseResponse {
6160
4832
  * is serialized differently in a given Price object. The model_type field
6161
4833
  * determines the key for the configuration object that is present.
6162
4834
  *
6163
- * ## Unit pricing
6164
- *
6165
- * With unit pricing, each unit costs a fixed amount.
6166
- *
6167
- * ```json
6168
- * {
6169
- * ...
6170
- * "model_type": "unit",
6171
- * "unit_config": {
6172
- * "unit_amount": "0.50"
6173
- * }
6174
- * ...
6175
- * }
6176
- * ```
6177
- *
6178
- * ## Tiered pricing
6179
- *
6180
- * In tiered pricing, the cost of a given unit depends on the tier range that it
6181
- * falls into, where each tier range is defined by an upper and lower bound. For
6182
- * example, the first ten units may cost $0.50 each and all units thereafter may
6183
- * cost $0.10 each.
6184
- *
6185
- * ```json
6186
- * {
6187
- * ...
6188
- * "model_type": "tiered",
6189
- * "tiered_config": {
6190
- * "tiers": [
6191
- * {
6192
- * "first_unit": 1,
6193
- * "last_unit": 10,
6194
- * "unit_amount": "0.50"
6195
- * },
6196
- * {
6197
- * "first_unit": 11,
6198
- * "last_unit": null,
6199
- * "unit_amount": "0.10"
6200
- * }
6201
- * ]
6202
- * }
6203
- * ...
6204
- * ```
6205
- *
6206
- * ## Bulk pricing
6207
- *
6208
- * Bulk pricing applies when the number of units determine the cost of all units.
6209
- * For example, if you've bought less than 10 units, they may each be $0.50 for a
6210
- * total of $5.00. Once you've bought more than 10 units, all units may now be
6211
- * priced at $0.40 (i.e. 101 units total would be $40.40).
6212
- *
6213
- * ```json
6214
- * {
6215
- * ...
6216
- * "model_type": "bulk",
6217
- * "bulk_config": {
6218
- * "tiers": [
6219
- * {
6220
- * "maximum_units": 10,
6221
- * "unit_amount": "0.50"
6222
- * },
6223
- * {
6224
- * "maximum_units": 1000,
6225
- * "unit_amount": "0.40"
6226
- * }
6227
- * ]
6228
- * }
6229
- * ...
6230
- * }
6231
- * ```
6232
- *
6233
- * ## Package pricing
6234
- *
6235
- * Package pricing defines the size or granularity of a unit for billing purposes.
6236
- * For example, if the package size is set to 5, then 4 units will be billed as 5
6237
- * and 6 units will be billed at 10.
6238
- *
6239
- * ```json
6240
- * {
6241
- * ...
6242
- * "model_type": "package",
6243
- * "package_config": {
6244
- * "package_amount": "0.80",
6245
- * "package_size": 10
6246
- * }
6247
- * ...
6248
- * }
6249
- * ```
6250
- *
6251
- * ## BPS pricing
6252
- *
6253
- * BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
6254
- * percent (the number of basis points to charge), as well as a cap per event to
6255
- * assess. For example, this would allow you to assess a fee of 0.25% on every
6256
- * payment you process, with a maximum charge of $25 per payment.
6257
- *
6258
- * ```json
6259
- * {
6260
- * ...
6261
- * "model_type": "bps",
6262
- * "bps_config": {
6263
- * "bps": 125,
6264
- * "per_unit_maximum": "11.00"
6265
- * }
6266
- * ...
6267
- * }
6268
- * ```
6269
- *
6270
- * ## Bulk BPS pricing
6271
- *
6272
- * Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
6273
- * total quantity across all events. Similar to bulk pricing, the BPS parameters of
6274
- * a given event depends on the tier range that the billing period falls into. Each
6275
- * tier range is defined by an upper bound. For example, after $1.5M of payment
6276
- * volume is reached, each individual payment may have a lower cap or a smaller
6277
- * take-rate.
6278
- *
6279
- * ```json
6280
- * ...
6281
- * "model_type": "bulk_bps",
6282
- * "bulk_bps_config": {
6283
- * "tiers": [
6284
- * {
6285
- * "maximum_amount": "1000000.00",
6286
- * "bps": 125,
6287
- * "per_unit_maximum": "19.00"
6288
- * },
6289
- * {
6290
- * "maximum_amount": null,
6291
- * "bps": 115,
6292
- * "per_unit_maximum": "4.00"
6293
- * }
6294
- * ]
6295
- * }
6296
- * ...
6297
- * }
6298
- * ```
6299
- *
6300
- * ## Tiered BPS pricing
6301
- *
6302
- * Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
6303
- * event's applicable parameter is a function of its marginal addition to the
6304
- * period total. Similar to tiered pricing, the BPS parameters of a given event
6305
- * depends on the tier range that it falls into, where each tier range is defined
6306
- * by an upper and lower bound. For example, the first few payments may have a 0.8
6307
- * BPS take-rate and all payments after a specific volume may incur a take-rate of
6308
- * 0.5 BPS each.
6309
- *
6310
- * ```json
6311
- * ...
6312
- * "model_type": "tiered_bps",
6313
- * "tiered_bps_config": {
6314
- * "tiers": [
6315
- * {
6316
- * "minimum_amount": "0",
6317
- * "maximum_amount": "1000000.00",
6318
- * "bps": 125,
6319
- * "per_unit_maximum": "19.00"
6320
- * },
6321
- * {
6322
- * "minimum_amount": "1000000.00",
6323
- * "maximum_amount": null,
6324
- * "bps": 115,
6325
- * "per_unit_maximum": "4.00"
6326
- * }
6327
- * ]
6328
- * }
6329
- * ...
6330
- * }
6331
- * ```
6332
- *
6333
- * ## Matrix pricing
6334
- *
6335
- * Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
6336
- * `dimensions` defines the two event property values evaluated in this pricing
6337
- * model. In a one-dimensional matrix, the second value is `null`. Every
6338
- * configuration has a list of `matrix_values` which give the unit prices for
6339
- * specified property values. In a one-dimensional matrix, the matrix values will
6340
- * have `dimension_values` where the second value of the pair is null. If an event
6341
- * does not match any of the dimension values in the matrix, it will resort to the
6342
- * `default_unit_amount`.
6343
- *
6344
- * ```json
6345
- * {
6346
- * "model_type": "matrix"
6347
- * "matrix_config": {
6348
- * "default_unit_amount": "3.00",
6349
- * "dimensions": [
6350
- * "cluster_name",
6351
- * "region"
6352
- * ],
6353
- * "matrix_values": [
6354
- * {
6355
- * "dimension_values": [
6356
- * "alpha",
6357
- * "west"
6358
- * ],
6359
- * "unit_amount": "2.00"
6360
- * },
6361
- * ...
6362
- * ]
6363
- * }
6364
- * }
6365
- * ```
6366
- *
6367
- * ## Fixed fees
6368
- *
6369
- * Fixed fees are prices that are applied independent of usage quantities, and
6370
- * follow unit pricing. They also have an additional parameter
6371
- * `fixed_price_quantity`. If the Price represents a fixed cost, this represents
6372
- * the quantity of units applied.
6373
- *
6374
- * ```json
6375
- * {
6376
- * ...
6377
- * "id": "price_id",
6378
- * "model_type": "unit",
6379
- * "unit_config": {
6380
- * "unit_amount": "2.00"
6381
- * },
6382
- * "fixed_price_quantity": 3.0
6383
- * ...
6384
- * }
6385
- * ```
4835
+ * For more on the types of prices, see
4836
+ * [the core concepts documentation](/core-concepts#plan-and-price)
6386
4837
  */
6387
4838
  price: PricesAPI.Price;
6388
4839
 
@@ -6471,7 +4922,7 @@ export interface SubscriptionUnscheduleCancellationResponse {
6471
4922
  * it's often desirable to have these match existing identifiers in your system. To
6472
4923
  * avoid having to denormalize Orb ID information, you can pass in an
6473
4924
  * `external_customer_id` with your own identifier. See
6474
- * [Customer ID Aliases](../guides/events-and-metrics/customer-aliases) for further
4925
+ * [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
6475
4926
  * information about how these aliases work in Orb.
6476
4927
  *
6477
4928
  * In addition to having an identifier in your system, a customer may exist in a
@@ -6480,9 +4931,8 @@ export interface SubscriptionUnscheduleCancellationResponse {
6480
4931
  *
6481
4932
  * A customer also has a timezone (from the standard
6482
4933
  * [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
6483
- * your account's timezone. See
6484
- * [Timezone localization](../guides/product-catalog/timezones.md) for information
6485
- * 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.
6486
4936
  */
6487
4937
  customer: CustomersAPI.Customer;
6488
4938
 
@@ -6537,9 +4987,9 @@ export interface SubscriptionUnscheduleCancellationResponse {
6537
4987
  net_terms: number;
6538
4988
 
6539
4989
  /**
6540
- * The [Plan](../guides/core-concepts.mdx#plan-and-price) resource represents a
6541
- * plan that can be subscribed to by a customer. Plans define the billing behavior
6542
- * of the subscription. You can see more about how to configure prices in the
4990
+ * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
4991
+ * subscribed to by a customer. Plans define the billing behavior of the
4992
+ * subscription. You can see more about how to configure prices in the
6543
4993
  * [Price resource](/reference/price).
6544
4994
  */
6545
4995
  plan: PlansAPI.Plan;
@@ -6986,229 +5436,8 @@ export namespace SubscriptionUnscheduleCancellationResponse {
6986
5436
  * is serialized differently in a given Price object. The model_type field
6987
5437
  * determines the key for the configuration object that is present.
6988
5438
  *
6989
- * ## Unit pricing
6990
- *
6991
- * With unit pricing, each unit costs a fixed amount.
6992
- *
6993
- * ```json
6994
- * {
6995
- * ...
6996
- * "model_type": "unit",
6997
- * "unit_config": {
6998
- * "unit_amount": "0.50"
6999
- * }
7000
- * ...
7001
- * }
7002
- * ```
7003
- *
7004
- * ## Tiered pricing
7005
- *
7006
- * In tiered pricing, the cost of a given unit depends on the tier range that it
7007
- * falls into, where each tier range is defined by an upper and lower bound. For
7008
- * example, the first ten units may cost $0.50 each and all units thereafter may
7009
- * cost $0.10 each.
7010
- *
7011
- * ```json
7012
- * {
7013
- * ...
7014
- * "model_type": "tiered",
7015
- * "tiered_config": {
7016
- * "tiers": [
7017
- * {
7018
- * "first_unit": 1,
7019
- * "last_unit": 10,
7020
- * "unit_amount": "0.50"
7021
- * },
7022
- * {
7023
- * "first_unit": 11,
7024
- * "last_unit": null,
7025
- * "unit_amount": "0.10"
7026
- * }
7027
- * ]
7028
- * }
7029
- * ...
7030
- * ```
7031
- *
7032
- * ## Bulk pricing
7033
- *
7034
- * Bulk pricing applies when the number of units determine the cost of all units.
7035
- * For example, if you've bought less than 10 units, they may each be $0.50 for a
7036
- * total of $5.00. Once you've bought more than 10 units, all units may now be
7037
- * priced at $0.40 (i.e. 101 units total would be $40.40).
7038
- *
7039
- * ```json
7040
- * {
7041
- * ...
7042
- * "model_type": "bulk",
7043
- * "bulk_config": {
7044
- * "tiers": [
7045
- * {
7046
- * "maximum_units": 10,
7047
- * "unit_amount": "0.50"
7048
- * },
7049
- * {
7050
- * "maximum_units": 1000,
7051
- * "unit_amount": "0.40"
7052
- * }
7053
- * ]
7054
- * }
7055
- * ...
7056
- * }
7057
- * ```
7058
- *
7059
- * ## Package pricing
7060
- *
7061
- * Package pricing defines the size or granularity of a unit for billing purposes.
7062
- * For example, if the package size is set to 5, then 4 units will be billed as 5
7063
- * and 6 units will be billed at 10.
7064
- *
7065
- * ```json
7066
- * {
7067
- * ...
7068
- * "model_type": "package",
7069
- * "package_config": {
7070
- * "package_amount": "0.80",
7071
- * "package_size": 10
7072
- * }
7073
- * ...
7074
- * }
7075
- * ```
7076
- *
7077
- * ## BPS pricing
7078
- *
7079
- * BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
7080
- * percent (the number of basis points to charge), as well as a cap per event to
7081
- * assess. For example, this would allow you to assess a fee of 0.25% on every
7082
- * payment you process, with a maximum charge of $25 per payment.
7083
- *
7084
- * ```json
7085
- * {
7086
- * ...
7087
- * "model_type": "bps",
7088
- * "bps_config": {
7089
- * "bps": 125,
7090
- * "per_unit_maximum": "11.00"
7091
- * }
7092
- * ...
7093
- * }
7094
- * ```
7095
- *
7096
- * ## Bulk BPS pricing
7097
- *
7098
- * Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
7099
- * total quantity across all events. Similar to bulk pricing, the BPS parameters of
7100
- * a given event depends on the tier range that the billing period falls into. Each
7101
- * tier range is defined by an upper bound. For example, after $1.5M of payment
7102
- * volume is reached, each individual payment may have a lower cap or a smaller
7103
- * take-rate.
7104
- *
7105
- * ```json
7106
- * ...
7107
- * "model_type": "bulk_bps",
7108
- * "bulk_bps_config": {
7109
- * "tiers": [
7110
- * {
7111
- * "maximum_amount": "1000000.00",
7112
- * "bps": 125,
7113
- * "per_unit_maximum": "19.00"
7114
- * },
7115
- * {
7116
- * "maximum_amount": null,
7117
- * "bps": 115,
7118
- * "per_unit_maximum": "4.00"
7119
- * }
7120
- * ]
7121
- * }
7122
- * ...
7123
- * }
7124
- * ```
7125
- *
7126
- * ## Tiered BPS pricing
7127
- *
7128
- * Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
7129
- * event's applicable parameter is a function of its marginal addition to the
7130
- * period total. Similar to tiered pricing, the BPS parameters of a given event
7131
- * depends on the tier range that it falls into, where each tier range is defined
7132
- * by an upper and lower bound. For example, the first few payments may have a 0.8
7133
- * BPS take-rate and all payments after a specific volume may incur a take-rate of
7134
- * 0.5 BPS each.
7135
- *
7136
- * ```json
7137
- * ...
7138
- * "model_type": "tiered_bps",
7139
- * "tiered_bps_config": {
7140
- * "tiers": [
7141
- * {
7142
- * "minimum_amount": "0",
7143
- * "maximum_amount": "1000000.00",
7144
- * "bps": 125,
7145
- * "per_unit_maximum": "19.00"
7146
- * },
7147
- * {
7148
- * "minimum_amount": "1000000.00",
7149
- * "maximum_amount": null,
7150
- * "bps": 115,
7151
- * "per_unit_maximum": "4.00"
7152
- * }
7153
- * ]
7154
- * }
7155
- * ...
7156
- * }
7157
- * ```
7158
- *
7159
- * ## Matrix pricing
7160
- *
7161
- * Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
7162
- * `dimensions` defines the two event property values evaluated in this pricing
7163
- * model. In a one-dimensional matrix, the second value is `null`. Every
7164
- * configuration has a list of `matrix_values` which give the unit prices for
7165
- * specified property values. In a one-dimensional matrix, the matrix values will
7166
- * have `dimension_values` where the second value of the pair is null. If an event
7167
- * does not match any of the dimension values in the matrix, it will resort to the
7168
- * `default_unit_amount`.
7169
- *
7170
- * ```json
7171
- * {
7172
- * "model_type": "matrix"
7173
- * "matrix_config": {
7174
- * "default_unit_amount": "3.00",
7175
- * "dimensions": [
7176
- * "cluster_name",
7177
- * "region"
7178
- * ],
7179
- * "matrix_values": [
7180
- * {
7181
- * "dimension_values": [
7182
- * "alpha",
7183
- * "west"
7184
- * ],
7185
- * "unit_amount": "2.00"
7186
- * },
7187
- * ...
7188
- * ]
7189
- * }
7190
- * }
7191
- * ```
7192
- *
7193
- * ## Fixed fees
7194
- *
7195
- * Fixed fees are prices that are applied independent of usage quantities, and
7196
- * follow unit pricing. They also have an additional parameter
7197
- * `fixed_price_quantity`. If the Price represents a fixed cost, this represents
7198
- * the quantity of units applied.
7199
- *
7200
- * ```json
7201
- * {
7202
- * ...
7203
- * "id": "price_id",
7204
- * "model_type": "unit",
7205
- * "unit_config": {
7206
- * "unit_amount": "2.00"
7207
- * },
7208
- * "fixed_price_quantity": 3.0
7209
- * ...
7210
- * }
7211
- * ```
5439
+ * For more on the types of prices, see
5440
+ * [the core concepts documentation](/core-concepts#plan-and-price)
7212
5441
  */
7213
5442
  price: PricesAPI.Price;
7214
5443
 
@@ -7297,7 +5526,7 @@ export interface SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
7297
5526
  * it's often desirable to have these match existing identifiers in your system. To
7298
5527
  * avoid having to denormalize Orb ID information, you can pass in an
7299
5528
  * `external_customer_id` with your own identifier. See
7300
- * [Customer ID Aliases](../guides/events-and-metrics/customer-aliases) for further
5529
+ * [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
7301
5530
  * information about how these aliases work in Orb.
7302
5531
  *
7303
5532
  * In addition to having an identifier in your system, a customer may exist in a
@@ -7306,9 +5535,8 @@ export interface SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
7306
5535
  *
7307
5536
  * A customer also has a timezone (from the standard
7308
5537
  * [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
7309
- * your account's timezone. See
7310
- * [Timezone localization](../guides/product-catalog/timezones.md) for information
7311
- * on what this timezone parameter influences within Orb.
5538
+ * your account's timezone. See [Timezone localization](/essentials/timezones) for
5539
+ * information on what this timezone parameter influences within Orb.
7312
5540
  */
7313
5541
  customer: CustomersAPI.Customer;
7314
5542
 
@@ -7363,9 +5591,9 @@ export interface SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
7363
5591
  net_terms: number;
7364
5592
 
7365
5593
  /**
7366
- * The [Plan](../guides/core-concepts.mdx#plan-and-price) resource represents a
7367
- * plan that can be subscribed to by a customer. Plans define the billing behavior
7368
- * of the subscription. You can see more about how to configure prices in the
5594
+ * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
5595
+ * subscribed to by a customer. Plans define the billing behavior of the
5596
+ * subscription. You can see more about how to configure prices in the
7369
5597
  * [Price resource](/reference/price).
7370
5598
  */
7371
5599
  plan: PlansAPI.Plan;
@@ -7812,229 +6040,8 @@ export namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
7812
6040
  * is serialized differently in a given Price object. The model_type field
7813
6041
  * determines the key for the configuration object that is present.
7814
6042
  *
7815
- * ## Unit pricing
7816
- *
7817
- * With unit pricing, each unit costs a fixed amount.
7818
- *
7819
- * ```json
7820
- * {
7821
- * ...
7822
- * "model_type": "unit",
7823
- * "unit_config": {
7824
- * "unit_amount": "0.50"
7825
- * }
7826
- * ...
7827
- * }
7828
- * ```
7829
- *
7830
- * ## Tiered pricing
7831
- *
7832
- * In tiered pricing, the cost of a given unit depends on the tier range that it
7833
- * falls into, where each tier range is defined by an upper and lower bound. For
7834
- * example, the first ten units may cost $0.50 each and all units thereafter may
7835
- * cost $0.10 each.
7836
- *
7837
- * ```json
7838
- * {
7839
- * ...
7840
- * "model_type": "tiered",
7841
- * "tiered_config": {
7842
- * "tiers": [
7843
- * {
7844
- * "first_unit": 1,
7845
- * "last_unit": 10,
7846
- * "unit_amount": "0.50"
7847
- * },
7848
- * {
7849
- * "first_unit": 11,
7850
- * "last_unit": null,
7851
- * "unit_amount": "0.10"
7852
- * }
7853
- * ]
7854
- * }
7855
- * ...
7856
- * ```
7857
- *
7858
- * ## Bulk pricing
7859
- *
7860
- * Bulk pricing applies when the number of units determine the cost of all units.
7861
- * For example, if you've bought less than 10 units, they may each be $0.50 for a
7862
- * total of $5.00. Once you've bought more than 10 units, all units may now be
7863
- * priced at $0.40 (i.e. 101 units total would be $40.40).
7864
- *
7865
- * ```json
7866
- * {
7867
- * ...
7868
- * "model_type": "bulk",
7869
- * "bulk_config": {
7870
- * "tiers": [
7871
- * {
7872
- * "maximum_units": 10,
7873
- * "unit_amount": "0.50"
7874
- * },
7875
- * {
7876
- * "maximum_units": 1000,
7877
- * "unit_amount": "0.40"
7878
- * }
7879
- * ]
7880
- * }
7881
- * ...
7882
- * }
7883
- * ```
7884
- *
7885
- * ## Package pricing
7886
- *
7887
- * Package pricing defines the size or granularity of a unit for billing purposes.
7888
- * For example, if the package size is set to 5, then 4 units will be billed as 5
7889
- * and 6 units will be billed at 10.
7890
- *
7891
- * ```json
7892
- * {
7893
- * ...
7894
- * "model_type": "package",
7895
- * "package_config": {
7896
- * "package_amount": "0.80",
7897
- * "package_size": 10
7898
- * }
7899
- * ...
7900
- * }
7901
- * ```
7902
- *
7903
- * ## BPS pricing
7904
- *
7905
- * BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
7906
- * percent (the number of basis points to charge), as well as a cap per event to
7907
- * assess. For example, this would allow you to assess a fee of 0.25% on every
7908
- * payment you process, with a maximum charge of $25 per payment.
7909
- *
7910
- * ```json
7911
- * {
7912
- * ...
7913
- * "model_type": "bps",
7914
- * "bps_config": {
7915
- * "bps": 125,
7916
- * "per_unit_maximum": "11.00"
7917
- * }
7918
- * ...
7919
- * }
7920
- * ```
7921
- *
7922
- * ## Bulk BPS pricing
7923
- *
7924
- * Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
7925
- * total quantity across all events. Similar to bulk pricing, the BPS parameters of
7926
- * a given event depends on the tier range that the billing period falls into. Each
7927
- * tier range is defined by an upper bound. For example, after $1.5M of payment
7928
- * volume is reached, each individual payment may have a lower cap or a smaller
7929
- * take-rate.
7930
- *
7931
- * ```json
7932
- * ...
7933
- * "model_type": "bulk_bps",
7934
- * "bulk_bps_config": {
7935
- * "tiers": [
7936
- * {
7937
- * "maximum_amount": "1000000.00",
7938
- * "bps": 125,
7939
- * "per_unit_maximum": "19.00"
7940
- * },
7941
- * {
7942
- * "maximum_amount": null,
7943
- * "bps": 115,
7944
- * "per_unit_maximum": "4.00"
7945
- * }
7946
- * ]
7947
- * }
7948
- * ...
7949
- * }
7950
- * ```
7951
- *
7952
- * ## Tiered BPS pricing
7953
- *
7954
- * Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
7955
- * event's applicable parameter is a function of its marginal addition to the
7956
- * period total. Similar to tiered pricing, the BPS parameters of a given event
7957
- * depends on the tier range that it falls into, where each tier range is defined
7958
- * by an upper and lower bound. For example, the first few payments may have a 0.8
7959
- * BPS take-rate and all payments after a specific volume may incur a take-rate of
7960
- * 0.5 BPS each.
7961
- *
7962
- * ```json
7963
- * ...
7964
- * "model_type": "tiered_bps",
7965
- * "tiered_bps_config": {
7966
- * "tiers": [
7967
- * {
7968
- * "minimum_amount": "0",
7969
- * "maximum_amount": "1000000.00",
7970
- * "bps": 125,
7971
- * "per_unit_maximum": "19.00"
7972
- * },
7973
- * {
7974
- * "minimum_amount": "1000000.00",
7975
- * "maximum_amount": null,
7976
- * "bps": 115,
7977
- * "per_unit_maximum": "4.00"
7978
- * }
7979
- * ]
7980
- * }
7981
- * ...
7982
- * }
7983
- * ```
7984
- *
7985
- * ## Matrix pricing
7986
- *
7987
- * Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
7988
- * `dimensions` defines the two event property values evaluated in this pricing
7989
- * model. In a one-dimensional matrix, the second value is `null`. Every
7990
- * configuration has a list of `matrix_values` which give the unit prices for
7991
- * specified property values. In a one-dimensional matrix, the matrix values will
7992
- * have `dimension_values` where the second value of the pair is null. If an event
7993
- * does not match any of the dimension values in the matrix, it will resort to the
7994
- * `default_unit_amount`.
7995
- *
7996
- * ```json
7997
- * {
7998
- * "model_type": "matrix"
7999
- * "matrix_config": {
8000
- * "default_unit_amount": "3.00",
8001
- * "dimensions": [
8002
- * "cluster_name",
8003
- * "region"
8004
- * ],
8005
- * "matrix_values": [
8006
- * {
8007
- * "dimension_values": [
8008
- * "alpha",
8009
- * "west"
8010
- * ],
8011
- * "unit_amount": "2.00"
8012
- * },
8013
- * ...
8014
- * ]
8015
- * }
8016
- * }
8017
- * ```
8018
- *
8019
- * ## Fixed fees
8020
- *
8021
- * Fixed fees are prices that are applied independent of usage quantities, and
8022
- * follow unit pricing. They also have an additional parameter
8023
- * `fixed_price_quantity`. If the Price represents a fixed cost, this represents
8024
- * the quantity of units applied.
8025
- *
8026
- * ```json
8027
- * {
8028
- * ...
8029
- * "id": "price_id",
8030
- * "model_type": "unit",
8031
- * "unit_config": {
8032
- * "unit_amount": "2.00"
8033
- * },
8034
- * "fixed_price_quantity": 3.0
8035
- * ...
8036
- * }
8037
- * ```
6043
+ * For more on the types of prices, see
6044
+ * [the core concepts documentation](/core-concepts#plan-and-price)
8038
6045
  */
8039
6046
  price: PricesAPI.Price;
8040
6047
 
@@ -8123,7 +6130,7 @@ export interface SubscriptionUnschedulePendingPlanChangesResponse {
8123
6130
  * it's often desirable to have these match existing identifiers in your system. To
8124
6131
  * avoid having to denormalize Orb ID information, you can pass in an
8125
6132
  * `external_customer_id` with your own identifier. See
8126
- * [Customer ID Aliases](../guides/events-and-metrics/customer-aliases) for further
6133
+ * [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
8127
6134
  * information about how these aliases work in Orb.
8128
6135
  *
8129
6136
  * In addition to having an identifier in your system, a customer may exist in a
@@ -8132,9 +6139,8 @@ export interface SubscriptionUnschedulePendingPlanChangesResponse {
8132
6139
  *
8133
6140
  * A customer also has a timezone (from the standard
8134
6141
  * [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
8135
- * your account's timezone. See
8136
- * [Timezone localization](../guides/product-catalog/timezones.md) for information
8137
- * on what this timezone parameter influences within Orb.
6142
+ * your account's timezone. See [Timezone localization](/essentials/timezones) for
6143
+ * information on what this timezone parameter influences within Orb.
8138
6144
  */
8139
6145
  customer: CustomersAPI.Customer;
8140
6146
 
@@ -8189,9 +6195,9 @@ export interface SubscriptionUnschedulePendingPlanChangesResponse {
8189
6195
  net_terms: number;
8190
6196
 
8191
6197
  /**
8192
- * The [Plan](../guides/core-concepts.mdx#plan-and-price) resource represents a
8193
- * plan that can be subscribed to by a customer. Plans define the billing behavior
8194
- * of the subscription. You can see more about how to configure prices in the
6198
+ * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
6199
+ * subscribed to by a customer. Plans define the billing behavior of the
6200
+ * subscription. You can see more about how to configure prices in the
8195
6201
  * [Price resource](/reference/price).
8196
6202
  */
8197
6203
  plan: PlansAPI.Plan;
@@ -8638,229 +6644,8 @@ export namespace SubscriptionUnschedulePendingPlanChangesResponse {
8638
6644
  * is serialized differently in a given Price object. The model_type field
8639
6645
  * determines the key for the configuration object that is present.
8640
6646
  *
8641
- * ## Unit pricing
8642
- *
8643
- * With unit pricing, each unit costs a fixed amount.
8644
- *
8645
- * ```json
8646
- * {
8647
- * ...
8648
- * "model_type": "unit",
8649
- * "unit_config": {
8650
- * "unit_amount": "0.50"
8651
- * }
8652
- * ...
8653
- * }
8654
- * ```
8655
- *
8656
- * ## Tiered pricing
8657
- *
8658
- * In tiered pricing, the cost of a given unit depends on the tier range that it
8659
- * falls into, where each tier range is defined by an upper and lower bound. For
8660
- * example, the first ten units may cost $0.50 each and all units thereafter may
8661
- * cost $0.10 each.
8662
- *
8663
- * ```json
8664
- * {
8665
- * ...
8666
- * "model_type": "tiered",
8667
- * "tiered_config": {
8668
- * "tiers": [
8669
- * {
8670
- * "first_unit": 1,
8671
- * "last_unit": 10,
8672
- * "unit_amount": "0.50"
8673
- * },
8674
- * {
8675
- * "first_unit": 11,
8676
- * "last_unit": null,
8677
- * "unit_amount": "0.10"
8678
- * }
8679
- * ]
8680
- * }
8681
- * ...
8682
- * ```
8683
- *
8684
- * ## Bulk pricing
8685
- *
8686
- * Bulk pricing applies when the number of units determine the cost of all units.
8687
- * For example, if you've bought less than 10 units, they may each be $0.50 for a
8688
- * total of $5.00. Once you've bought more than 10 units, all units may now be
8689
- * priced at $0.40 (i.e. 101 units total would be $40.40).
8690
- *
8691
- * ```json
8692
- * {
8693
- * ...
8694
- * "model_type": "bulk",
8695
- * "bulk_config": {
8696
- * "tiers": [
8697
- * {
8698
- * "maximum_units": 10,
8699
- * "unit_amount": "0.50"
8700
- * },
8701
- * {
8702
- * "maximum_units": 1000,
8703
- * "unit_amount": "0.40"
8704
- * }
8705
- * ]
8706
- * }
8707
- * ...
8708
- * }
8709
- * ```
8710
- *
8711
- * ## Package pricing
8712
- *
8713
- * Package pricing defines the size or granularity of a unit for billing purposes.
8714
- * For example, if the package size is set to 5, then 4 units will be billed as 5
8715
- * and 6 units will be billed at 10.
8716
- *
8717
- * ```json
8718
- * {
8719
- * ...
8720
- * "model_type": "package",
8721
- * "package_config": {
8722
- * "package_amount": "0.80",
8723
- * "package_size": 10
8724
- * }
8725
- * ...
8726
- * }
8727
- * ```
8728
- *
8729
- * ## BPS pricing
8730
- *
8731
- * BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
8732
- * percent (the number of basis points to charge), as well as a cap per event to
8733
- * assess. For example, this would allow you to assess a fee of 0.25% on every
8734
- * payment you process, with a maximum charge of $25 per payment.
8735
- *
8736
- * ```json
8737
- * {
8738
- * ...
8739
- * "model_type": "bps",
8740
- * "bps_config": {
8741
- * "bps": 125,
8742
- * "per_unit_maximum": "11.00"
8743
- * }
8744
- * ...
8745
- * }
8746
- * ```
8747
- *
8748
- * ## Bulk BPS pricing
8749
- *
8750
- * Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
8751
- * total quantity across all events. Similar to bulk pricing, the BPS parameters of
8752
- * a given event depends on the tier range that the billing period falls into. Each
8753
- * tier range is defined by an upper bound. For example, after $1.5M of payment
8754
- * volume is reached, each individual payment may have a lower cap or a smaller
8755
- * take-rate.
8756
- *
8757
- * ```json
8758
- * ...
8759
- * "model_type": "bulk_bps",
8760
- * "bulk_bps_config": {
8761
- * "tiers": [
8762
- * {
8763
- * "maximum_amount": "1000000.00",
8764
- * "bps": 125,
8765
- * "per_unit_maximum": "19.00"
8766
- * },
8767
- * {
8768
- * "maximum_amount": null,
8769
- * "bps": 115,
8770
- * "per_unit_maximum": "4.00"
8771
- * }
8772
- * ]
8773
- * }
8774
- * ...
8775
- * }
8776
- * ```
8777
- *
8778
- * ## Tiered BPS pricing
8779
- *
8780
- * Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
8781
- * event's applicable parameter is a function of its marginal addition to the
8782
- * period total. Similar to tiered pricing, the BPS parameters of a given event
8783
- * depends on the tier range that it falls into, where each tier range is defined
8784
- * by an upper and lower bound. For example, the first few payments may have a 0.8
8785
- * BPS take-rate and all payments after a specific volume may incur a take-rate of
8786
- * 0.5 BPS each.
8787
- *
8788
- * ```json
8789
- * ...
8790
- * "model_type": "tiered_bps",
8791
- * "tiered_bps_config": {
8792
- * "tiers": [
8793
- * {
8794
- * "minimum_amount": "0",
8795
- * "maximum_amount": "1000000.00",
8796
- * "bps": 125,
8797
- * "per_unit_maximum": "19.00"
8798
- * },
8799
- * {
8800
- * "minimum_amount": "1000000.00",
8801
- * "maximum_amount": null,
8802
- * "bps": 115,
8803
- * "per_unit_maximum": "4.00"
8804
- * }
8805
- * ]
8806
- * }
8807
- * ...
8808
- * }
8809
- * ```
8810
- *
8811
- * ## Matrix pricing
8812
- *
8813
- * Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
8814
- * `dimensions` defines the two event property values evaluated in this pricing
8815
- * model. In a one-dimensional matrix, the second value is `null`. Every
8816
- * configuration has a list of `matrix_values` which give the unit prices for
8817
- * specified property values. In a one-dimensional matrix, the matrix values will
8818
- * have `dimension_values` where the second value of the pair is null. If an event
8819
- * does not match any of the dimension values in the matrix, it will resort to the
8820
- * `default_unit_amount`.
8821
- *
8822
- * ```json
8823
- * {
8824
- * "model_type": "matrix"
8825
- * "matrix_config": {
8826
- * "default_unit_amount": "3.00",
8827
- * "dimensions": [
8828
- * "cluster_name",
8829
- * "region"
8830
- * ],
8831
- * "matrix_values": [
8832
- * {
8833
- * "dimension_values": [
8834
- * "alpha",
8835
- * "west"
8836
- * ],
8837
- * "unit_amount": "2.00"
8838
- * },
8839
- * ...
8840
- * ]
8841
- * }
8842
- * }
8843
- * ```
8844
- *
8845
- * ## Fixed fees
8846
- *
8847
- * Fixed fees are prices that are applied independent of usage quantities, and
8848
- * follow unit pricing. They also have an additional parameter
8849
- * `fixed_price_quantity`. If the Price represents a fixed cost, this represents
8850
- * the quantity of units applied.
8851
- *
8852
- * ```json
8853
- * {
8854
- * ...
8855
- * "id": "price_id",
8856
- * "model_type": "unit",
8857
- * "unit_config": {
8858
- * "unit_amount": "2.00"
8859
- * },
8860
- * "fixed_price_quantity": 3.0
8861
- * ...
8862
- * }
8863
- * ```
6647
+ * For more on the types of prices, see
6648
+ * [the core concepts documentation](/core-concepts#plan-and-price)
8864
6649
  */
8865
6650
  price: PricesAPI.Price;
8866
6651
 
@@ -8949,7 +6734,7 @@ export interface SubscriptionUpdateFixedFeeQuantityResponse {
8949
6734
  * it's often desirable to have these match existing identifiers in your system. To
8950
6735
  * avoid having to denormalize Orb ID information, you can pass in an
8951
6736
  * `external_customer_id` with your own identifier. See
8952
- * [Customer ID Aliases](../guides/events-and-metrics/customer-aliases) for further
6737
+ * [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
8953
6738
  * information about how these aliases work in Orb.
8954
6739
  *
8955
6740
  * In addition to having an identifier in your system, a customer may exist in a
@@ -8958,9 +6743,8 @@ export interface SubscriptionUpdateFixedFeeQuantityResponse {
8958
6743
  *
8959
6744
  * A customer also has a timezone (from the standard
8960
6745
  * [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
8961
- * your account's timezone. See
8962
- * [Timezone localization](../guides/product-catalog/timezones.md) for information
8963
- * on what this timezone parameter influences within Orb.
6746
+ * your account's timezone. See [Timezone localization](/essentials/timezones) for
6747
+ * information on what this timezone parameter influences within Orb.
8964
6748
  */
8965
6749
  customer: CustomersAPI.Customer;
8966
6750
 
@@ -9015,9 +6799,9 @@ export interface SubscriptionUpdateFixedFeeQuantityResponse {
9015
6799
  net_terms: number;
9016
6800
 
9017
6801
  /**
9018
- * The [Plan](../guides/core-concepts.mdx#plan-and-price) resource represents a
9019
- * plan that can be subscribed to by a customer. Plans define the billing behavior
9020
- * of the subscription. You can see more about how to configure prices in the
6802
+ * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
6803
+ * subscribed to by a customer. Plans define the billing behavior of the
6804
+ * subscription. You can see more about how to configure prices in the
9021
6805
  * [Price resource](/reference/price).
9022
6806
  */
9023
6807
  plan: PlansAPI.Plan;
@@ -9464,229 +7248,8 @@ export namespace SubscriptionUpdateFixedFeeQuantityResponse {
9464
7248
  * is serialized differently in a given Price object. The model_type field
9465
7249
  * determines the key for the configuration object that is present.
9466
7250
  *
9467
- * ## Unit pricing
9468
- *
9469
- * With unit pricing, each unit costs a fixed amount.
9470
- *
9471
- * ```json
9472
- * {
9473
- * ...
9474
- * "model_type": "unit",
9475
- * "unit_config": {
9476
- * "unit_amount": "0.50"
9477
- * }
9478
- * ...
9479
- * }
9480
- * ```
9481
- *
9482
- * ## Tiered pricing
9483
- *
9484
- * In tiered pricing, the cost of a given unit depends on the tier range that it
9485
- * falls into, where each tier range is defined by an upper and lower bound. For
9486
- * example, the first ten units may cost $0.50 each and all units thereafter may
9487
- * cost $0.10 each.
9488
- *
9489
- * ```json
9490
- * {
9491
- * ...
9492
- * "model_type": "tiered",
9493
- * "tiered_config": {
9494
- * "tiers": [
9495
- * {
9496
- * "first_unit": 1,
9497
- * "last_unit": 10,
9498
- * "unit_amount": "0.50"
9499
- * },
9500
- * {
9501
- * "first_unit": 11,
9502
- * "last_unit": null,
9503
- * "unit_amount": "0.10"
9504
- * }
9505
- * ]
9506
- * }
9507
- * ...
9508
- * ```
9509
- *
9510
- * ## Bulk pricing
9511
- *
9512
- * Bulk pricing applies when the number of units determine the cost of all units.
9513
- * For example, if you've bought less than 10 units, they may each be $0.50 for a
9514
- * total of $5.00. Once you've bought more than 10 units, all units may now be
9515
- * priced at $0.40 (i.e. 101 units total would be $40.40).
9516
- *
9517
- * ```json
9518
- * {
9519
- * ...
9520
- * "model_type": "bulk",
9521
- * "bulk_config": {
9522
- * "tiers": [
9523
- * {
9524
- * "maximum_units": 10,
9525
- * "unit_amount": "0.50"
9526
- * },
9527
- * {
9528
- * "maximum_units": 1000,
9529
- * "unit_amount": "0.40"
9530
- * }
9531
- * ]
9532
- * }
9533
- * ...
9534
- * }
9535
- * ```
9536
- *
9537
- * ## Package pricing
9538
- *
9539
- * Package pricing defines the size or granularity of a unit for billing purposes.
9540
- * For example, if the package size is set to 5, then 4 units will be billed as 5
9541
- * and 6 units will be billed at 10.
9542
- *
9543
- * ```json
9544
- * {
9545
- * ...
9546
- * "model_type": "package",
9547
- * "package_config": {
9548
- * "package_amount": "0.80",
9549
- * "package_size": 10
9550
- * }
9551
- * ...
9552
- * }
9553
- * ```
9554
- *
9555
- * ## BPS pricing
9556
- *
9557
- * BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
9558
- * percent (the number of basis points to charge), as well as a cap per event to
9559
- * assess. For example, this would allow you to assess a fee of 0.25% on every
9560
- * payment you process, with a maximum charge of $25 per payment.
9561
- *
9562
- * ```json
9563
- * {
9564
- * ...
9565
- * "model_type": "bps",
9566
- * "bps_config": {
9567
- * "bps": 125,
9568
- * "per_unit_maximum": "11.00"
9569
- * }
9570
- * ...
9571
- * }
9572
- * ```
9573
- *
9574
- * ## Bulk BPS pricing
9575
- *
9576
- * Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
9577
- * total quantity across all events. Similar to bulk pricing, the BPS parameters of
9578
- * a given event depends on the tier range that the billing period falls into. Each
9579
- * tier range is defined by an upper bound. For example, after $1.5M of payment
9580
- * volume is reached, each individual payment may have a lower cap or a smaller
9581
- * take-rate.
9582
- *
9583
- * ```json
9584
- * ...
9585
- * "model_type": "bulk_bps",
9586
- * "bulk_bps_config": {
9587
- * "tiers": [
9588
- * {
9589
- * "maximum_amount": "1000000.00",
9590
- * "bps": 125,
9591
- * "per_unit_maximum": "19.00"
9592
- * },
9593
- * {
9594
- * "maximum_amount": null,
9595
- * "bps": 115,
9596
- * "per_unit_maximum": "4.00"
9597
- * }
9598
- * ]
9599
- * }
9600
- * ...
9601
- * }
9602
- * ```
9603
- *
9604
- * ## Tiered BPS pricing
9605
- *
9606
- * Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
9607
- * event's applicable parameter is a function of its marginal addition to the
9608
- * period total. Similar to tiered pricing, the BPS parameters of a given event
9609
- * depends on the tier range that it falls into, where each tier range is defined
9610
- * by an upper and lower bound. For example, the first few payments may have a 0.8
9611
- * BPS take-rate and all payments after a specific volume may incur a take-rate of
9612
- * 0.5 BPS each.
9613
- *
9614
- * ```json
9615
- * ...
9616
- * "model_type": "tiered_bps",
9617
- * "tiered_bps_config": {
9618
- * "tiers": [
9619
- * {
9620
- * "minimum_amount": "0",
9621
- * "maximum_amount": "1000000.00",
9622
- * "bps": 125,
9623
- * "per_unit_maximum": "19.00"
9624
- * },
9625
- * {
9626
- * "minimum_amount": "1000000.00",
9627
- * "maximum_amount": null,
9628
- * "bps": 115,
9629
- * "per_unit_maximum": "4.00"
9630
- * }
9631
- * ]
9632
- * }
9633
- * ...
9634
- * }
9635
- * ```
9636
- *
9637
- * ## Matrix pricing
9638
- *
9639
- * Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
9640
- * `dimensions` defines the two event property values evaluated in this pricing
9641
- * model. In a one-dimensional matrix, the second value is `null`. Every
9642
- * configuration has a list of `matrix_values` which give the unit prices for
9643
- * specified property values. In a one-dimensional matrix, the matrix values will
9644
- * have `dimension_values` where the second value of the pair is null. If an event
9645
- * does not match any of the dimension values in the matrix, it will resort to the
9646
- * `default_unit_amount`.
9647
- *
9648
- * ```json
9649
- * {
9650
- * "model_type": "matrix"
9651
- * "matrix_config": {
9652
- * "default_unit_amount": "3.00",
9653
- * "dimensions": [
9654
- * "cluster_name",
9655
- * "region"
9656
- * ],
9657
- * "matrix_values": [
9658
- * {
9659
- * "dimension_values": [
9660
- * "alpha",
9661
- * "west"
9662
- * ],
9663
- * "unit_amount": "2.00"
9664
- * },
9665
- * ...
9666
- * ]
9667
- * }
9668
- * }
9669
- * ```
9670
- *
9671
- * ## Fixed fees
9672
- *
9673
- * Fixed fees are prices that are applied independent of usage quantities, and
9674
- * follow unit pricing. They also have an additional parameter
9675
- * `fixed_price_quantity`. If the Price represents a fixed cost, this represents
9676
- * the quantity of units applied.
9677
- *
9678
- * ```json
9679
- * {
9680
- * ...
9681
- * "id": "price_id",
9682
- * "model_type": "unit",
9683
- * "unit_config": {
9684
- * "unit_amount": "2.00"
9685
- * },
9686
- * "fixed_price_quantity": 3.0
9687
- * ...
9688
- * }
9689
- * ```
7251
+ * For more on the types of prices, see
7252
+ * [the core concepts documentation](/core-concepts#plan-and-price)
9690
7253
  */
9691
7254
  price: PricesAPI.Price;
9692
7255
 
@@ -9775,7 +7338,7 @@ export interface SubscriptionUpdateTrialResponse {
9775
7338
  * it's often desirable to have these match existing identifiers in your system. To
9776
7339
  * avoid having to denormalize Orb ID information, you can pass in an
9777
7340
  * `external_customer_id` with your own identifier. See
9778
- * [Customer ID Aliases](../guides/events-and-metrics/customer-aliases) for further
7341
+ * [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
9779
7342
  * information about how these aliases work in Orb.
9780
7343
  *
9781
7344
  * In addition to having an identifier in your system, a customer may exist in a
@@ -9784,9 +7347,8 @@ export interface SubscriptionUpdateTrialResponse {
9784
7347
  *
9785
7348
  * A customer also has a timezone (from the standard
9786
7349
  * [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
9787
- * your account's timezone. See
9788
- * [Timezone localization](../guides/product-catalog/timezones.md) for information
9789
- * on what this timezone parameter influences within Orb.
7350
+ * your account's timezone. See [Timezone localization](/essentials/timezones) for
7351
+ * information on what this timezone parameter influences within Orb.
9790
7352
  */
9791
7353
  customer: CustomersAPI.Customer;
9792
7354
 
@@ -9841,9 +7403,9 @@ export interface SubscriptionUpdateTrialResponse {
9841
7403
  net_terms: number;
9842
7404
 
9843
7405
  /**
9844
- * The [Plan](../guides/core-concepts.mdx#plan-and-price) resource represents a
9845
- * plan that can be subscribed to by a customer. Plans define the billing behavior
9846
- * of the subscription. You can see more about how to configure prices in the
7406
+ * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
7407
+ * subscribed to by a customer. Plans define the billing behavior of the
7408
+ * subscription. You can see more about how to configure prices in the
9847
7409
  * [Price resource](/reference/price).
9848
7410
  */
9849
7411
  plan: PlansAPI.Plan;
@@ -10290,229 +7852,8 @@ export namespace SubscriptionUpdateTrialResponse {
10290
7852
  * is serialized differently in a given Price object. The model_type field
10291
7853
  * determines the key for the configuration object that is present.
10292
7854
  *
10293
- * ## Unit pricing
10294
- *
10295
- * With unit pricing, each unit costs a fixed amount.
10296
- *
10297
- * ```json
10298
- * {
10299
- * ...
10300
- * "model_type": "unit",
10301
- * "unit_config": {
10302
- * "unit_amount": "0.50"
10303
- * }
10304
- * ...
10305
- * }
10306
- * ```
10307
- *
10308
- * ## Tiered pricing
10309
- *
10310
- * In tiered pricing, the cost of a given unit depends on the tier range that it
10311
- * falls into, where each tier range is defined by an upper and lower bound. For
10312
- * example, the first ten units may cost $0.50 each and all units thereafter may
10313
- * cost $0.10 each.
10314
- *
10315
- * ```json
10316
- * {
10317
- * ...
10318
- * "model_type": "tiered",
10319
- * "tiered_config": {
10320
- * "tiers": [
10321
- * {
10322
- * "first_unit": 1,
10323
- * "last_unit": 10,
10324
- * "unit_amount": "0.50"
10325
- * },
10326
- * {
10327
- * "first_unit": 11,
10328
- * "last_unit": null,
10329
- * "unit_amount": "0.10"
10330
- * }
10331
- * ]
10332
- * }
10333
- * ...
10334
- * ```
10335
- *
10336
- * ## Bulk pricing
10337
- *
10338
- * Bulk pricing applies when the number of units determine the cost of all units.
10339
- * For example, if you've bought less than 10 units, they may each be $0.50 for a
10340
- * total of $5.00. Once you've bought more than 10 units, all units may now be
10341
- * priced at $0.40 (i.e. 101 units total would be $40.40).
10342
- *
10343
- * ```json
10344
- * {
10345
- * ...
10346
- * "model_type": "bulk",
10347
- * "bulk_config": {
10348
- * "tiers": [
10349
- * {
10350
- * "maximum_units": 10,
10351
- * "unit_amount": "0.50"
10352
- * },
10353
- * {
10354
- * "maximum_units": 1000,
10355
- * "unit_amount": "0.40"
10356
- * }
10357
- * ]
10358
- * }
10359
- * ...
10360
- * }
10361
- * ```
10362
- *
10363
- * ## Package pricing
10364
- *
10365
- * Package pricing defines the size or granularity of a unit for billing purposes.
10366
- * For example, if the package size is set to 5, then 4 units will be billed as 5
10367
- * and 6 units will be billed at 10.
10368
- *
10369
- * ```json
10370
- * {
10371
- * ...
10372
- * "model_type": "package",
10373
- * "package_config": {
10374
- * "package_amount": "0.80",
10375
- * "package_size": 10
10376
- * }
10377
- * ...
10378
- * }
10379
- * ```
10380
- *
10381
- * ## BPS pricing
10382
- *
10383
- * BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
10384
- * percent (the number of basis points to charge), as well as a cap per event to
10385
- * assess. For example, this would allow you to assess a fee of 0.25% on every
10386
- * payment you process, with a maximum charge of $25 per payment.
10387
- *
10388
- * ```json
10389
- * {
10390
- * ...
10391
- * "model_type": "bps",
10392
- * "bps_config": {
10393
- * "bps": 125,
10394
- * "per_unit_maximum": "11.00"
10395
- * }
10396
- * ...
10397
- * }
10398
- * ```
10399
- *
10400
- * ## Bulk BPS pricing
10401
- *
10402
- * Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
10403
- * total quantity across all events. Similar to bulk pricing, the BPS parameters of
10404
- * a given event depends on the tier range that the billing period falls into. Each
10405
- * tier range is defined by an upper bound. For example, after $1.5M of payment
10406
- * volume is reached, each individual payment may have a lower cap or a smaller
10407
- * take-rate.
10408
- *
10409
- * ```json
10410
- * ...
10411
- * "model_type": "bulk_bps",
10412
- * "bulk_bps_config": {
10413
- * "tiers": [
10414
- * {
10415
- * "maximum_amount": "1000000.00",
10416
- * "bps": 125,
10417
- * "per_unit_maximum": "19.00"
10418
- * },
10419
- * {
10420
- * "maximum_amount": null,
10421
- * "bps": 115,
10422
- * "per_unit_maximum": "4.00"
10423
- * }
10424
- * ]
10425
- * }
10426
- * ...
10427
- * }
10428
- * ```
10429
- *
10430
- * ## Tiered BPS pricing
10431
- *
10432
- * Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
10433
- * event's applicable parameter is a function of its marginal addition to the
10434
- * period total. Similar to tiered pricing, the BPS parameters of a given event
10435
- * depends on the tier range that it falls into, where each tier range is defined
10436
- * by an upper and lower bound. For example, the first few payments may have a 0.8
10437
- * BPS take-rate and all payments after a specific volume may incur a take-rate of
10438
- * 0.5 BPS each.
10439
- *
10440
- * ```json
10441
- * ...
10442
- * "model_type": "tiered_bps",
10443
- * "tiered_bps_config": {
10444
- * "tiers": [
10445
- * {
10446
- * "minimum_amount": "0",
10447
- * "maximum_amount": "1000000.00",
10448
- * "bps": 125,
10449
- * "per_unit_maximum": "19.00"
10450
- * },
10451
- * {
10452
- * "minimum_amount": "1000000.00",
10453
- * "maximum_amount": null,
10454
- * "bps": 115,
10455
- * "per_unit_maximum": "4.00"
10456
- * }
10457
- * ]
10458
- * }
10459
- * ...
10460
- * }
10461
- * ```
10462
- *
10463
- * ## Matrix pricing
10464
- *
10465
- * Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
10466
- * `dimensions` defines the two event property values evaluated in this pricing
10467
- * model. In a one-dimensional matrix, the second value is `null`. Every
10468
- * configuration has a list of `matrix_values` which give the unit prices for
10469
- * specified property values. In a one-dimensional matrix, the matrix values will
10470
- * have `dimension_values` where the second value of the pair is null. If an event
10471
- * does not match any of the dimension values in the matrix, it will resort to the
10472
- * `default_unit_amount`.
10473
- *
10474
- * ```json
10475
- * {
10476
- * "model_type": "matrix"
10477
- * "matrix_config": {
10478
- * "default_unit_amount": "3.00",
10479
- * "dimensions": [
10480
- * "cluster_name",
10481
- * "region"
10482
- * ],
10483
- * "matrix_values": [
10484
- * {
10485
- * "dimension_values": [
10486
- * "alpha",
10487
- * "west"
10488
- * ],
10489
- * "unit_amount": "2.00"
10490
- * },
10491
- * ...
10492
- * ]
10493
- * }
10494
- * }
10495
- * ```
10496
- *
10497
- * ## Fixed fees
10498
- *
10499
- * Fixed fees are prices that are applied independent of usage quantities, and
10500
- * follow unit pricing. They also have an additional parameter
10501
- * `fixed_price_quantity`. If the Price represents a fixed cost, this represents
10502
- * the quantity of units applied.
10503
- *
10504
- * ```json
10505
- * {
10506
- * ...
10507
- * "id": "price_id",
10508
- * "model_type": "unit",
10509
- * "unit_config": {
10510
- * "unit_amount": "2.00"
10511
- * },
10512
- * "fixed_price_quantity": 3.0
10513
- * ...
10514
- * }
10515
- * ```
7855
+ * For more on the types of prices, see
7856
+ * [the core concepts documentation](/core-concepts#plan-and-price)
10516
7857
  */
10517
7858
  price: PricesAPI.Price;
10518
7859
 
@@ -10606,8 +7947,8 @@ export interface SubscriptionCreateParams {
10606
7947
  /**
10607
7948
  * An additional filter to apply to usage queries. This filter must be expressed as
10608
7949
  * a boolean
10609
- * [computed property](../guides/extensibility/advanced-metrics#computed-properties).
10610
- * If null, usage queries will not include any additional filter.
7950
+ * [computed property](/extensibility/advanced-metrics#computed-properties). If
7951
+ * null, usage queries will not include any additional filter.
10611
7952
  */
10612
7953
  filter?: string | null;
10613
7954
 
@@ -10817,7 +8158,7 @@ export namespace SubscriptionCreateParams {
10817
8158
 
10818
8159
  export interface AddPrice {
10819
8160
  /**
10820
- * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
8161
+ * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's
10821
8162
  * discounts for this price.
10822
8163
  */
10823
8164
  discounts?: Array<AddPrice.Discount> | null;
@@ -10835,14 +8176,14 @@ export namespace SubscriptionCreateParams {
10835
8176
  external_price_id?: string | null;
10836
8177
 
10837
8178
  /**
10838
- * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
10839
- * maximum amount for this price.
8179
+ * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's maximum
8180
+ * amount for this price.
10840
8181
  */
10841
8182
  maximum_amount?: string | null;
10842
8183
 
10843
8184
  /**
10844
- * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
10845
- * minimum amount for this price.
8185
+ * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's minimum
8186
+ * amount for this price.
10846
8187
  */
10847
8188
  minimum_amount?: string | null;
10848
8189
 
@@ -13382,7 +10723,7 @@ export namespace SubscriptionCreateParams {
13382
10723
  replaces_price_id: string;
13383
10724
 
13384
10725
  /**
13385
- * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
10726
+ * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's
13386
10727
  * discounts for the replacement price.
13387
10728
  */
13388
10729
  discounts?: Array<ReplacePrice.Discount> | null;
@@ -13398,14 +10739,14 @@ export namespace SubscriptionCreateParams {
13398
10739
  fixed_price_quantity?: number | null;
13399
10740
 
13400
10741
  /**
13401
- * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
13402
- * maximum amount for the replacement price.
10742
+ * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's maximum
10743
+ * amount for the replacement price.
13403
10744
  */
13404
10745
  maximum_amount?: string | null;
13405
10746
 
13406
10747
  /**
13407
- * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
13408
- * minimum amount for the replacement price.
10748
+ * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's minimum
10749
+ * amount for the replacement price.
13409
10750
  */
13410
10751
  minimum_amount?: string | null;
13411
10752
 
@@ -19361,8 +16702,8 @@ export interface SubscriptionSchedulePlanChangeParams {
19361
16702
  /**
19362
16703
  * An additional filter to apply to usage queries. This filter must be expressed as
19363
16704
  * a boolean
19364
- * [computed property](../guides/extensibility/advanced-metrics#computed-properties).
19365
- * If null, usage queries will not include any additional filter.
16705
+ * [computed property](/extensibility/advanced-metrics#computed-properties). If
16706
+ * null, usage queries will not include any additional filter.
19366
16707
  */
19367
16708
  filter?: string | null;
19368
16709
 
@@ -19563,7 +16904,7 @@ export namespace SubscriptionSchedulePlanChangeParams {
19563
16904
 
19564
16905
  export interface AddPrice {
19565
16906
  /**
19566
- * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
16907
+ * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's
19567
16908
  * discounts for this price.
19568
16909
  */
19569
16910
  discounts?: Array<AddPrice.Discount> | null;
@@ -19581,14 +16922,14 @@ export namespace SubscriptionSchedulePlanChangeParams {
19581
16922
  external_price_id?: string | null;
19582
16923
 
19583
16924
  /**
19584
- * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
19585
- * maximum amount for this price.
16925
+ * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's maximum
16926
+ * amount for this price.
19586
16927
  */
19587
16928
  maximum_amount?: string | null;
19588
16929
 
19589
16930
  /**
19590
- * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
19591
- * minimum amount for this price.
16931
+ * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's minimum
16932
+ * amount for this price.
19592
16933
  */
19593
16934
  minimum_amount?: string | null;
19594
16935
 
@@ -22128,7 +19469,7 @@ export namespace SubscriptionSchedulePlanChangeParams {
22128
19469
  replaces_price_id: string;
22129
19470
 
22130
19471
  /**
22131
- * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
19472
+ * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's
22132
19473
  * discounts for the replacement price.
22133
19474
  */
22134
19475
  discounts?: Array<ReplacePrice.Discount> | null;
@@ -22144,14 +19485,14 @@ export namespace SubscriptionSchedulePlanChangeParams {
22144
19485
  fixed_price_quantity?: number | null;
22145
19486
 
22146
19487
  /**
22147
- * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
22148
- * maximum amount for the replacement price.
19488
+ * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's maximum
19489
+ * amount for the replacement price.
22149
19490
  */
22150
19491
  maximum_amount?: string | null;
22151
19492
 
22152
19493
  /**
22153
- * @deprecated: [DEPRECATED] Use add_adjustments instead. The subscription's
22154
- * minimum amount for the replacement price.
19494
+ * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's minimum
19495
+ * amount for the replacement price.
22155
19496
  */
22156
19497
  minimum_amount?: string | null;
22157
19498