orb-billing 1.19.5 → 1.20.0

package/docs/models/shared/thresholdtotalamountprice.md

@@ -1,225 +0,0 @@
-# ThresholdTotalAmountPrice
-
-The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in
-the form of an invoice line item. Prices take a quantity and determine an amount to bill.
-
-Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a
-given Price object. The model_type field determines the key for the configuration object that is present.
-
-## Unit pricing
-With unit pricing, each unit costs a fixed amount.
-```json
-{
-    ...
-    "model_type": "unit",
-    "unit_config": {
-        "unit_amount": "0.50"
-    }
-    ...
-}
-```
-
-## Tiered pricing
-In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is
-defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter
-may cost $0.10 each.
-```json
-{
-    ...
-    "model_type": "tiered",
-    "tiered_config": {
-        "tiers": [
-            {
-                "first_unit": 1,
-                "last_unit": 10,
-                "unit_amount": "0.50"
-            },
-            {
-                "first_unit": 11,
-                "last_unit": null,
-                "unit_amount": "0.10"
-            }
-        ]
-    }
-    ...
-```
-
-## Bulk pricing
-Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less
-than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may
-now be priced at $0.40 (i.e. 101 units total would be $40.40).
-```json
-{
-    ...
-    "model_type": "bulk",
-    "bulk_config": {
-        "tiers": [
-            {
-                "maximum_units": 10,
-                "unit_amount": "0.50"
-            },
-            {
-                "maximum_units": 1000,
-                "unit_amount": "0.40"
-            }
-        ]
-    }
-    ...
-}
-```
-
-## Package pricing
-Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is
-set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
-```json
-{
-    ...
-    "model_type": "package",
-    "package_config": {
-        "package_amount": "0.80",
-        "package_size": 10
-    }
-    ...
-}
-```
-
-## BPS pricing
-BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points
-to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on
-every payment you process, with a maximum charge of $25 per payment.
-```json
-{
-    ...
-    "model_type": "bps",
-    "bps_config": {
-       "bps": 125,
-       "per_unit_maximum": "11.00"
-    }
-    ...
- }
-```
-
-## Bulk BPS pricing
-Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events.
-Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period
-falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached,
-each individual payment may have a lower cap or a smaller take-rate.
-```json
-    ...
-    "model_type": "bulk_bps",
-    "bulk_bps_config": {
-        "tiers": [
-           {
-                "maximum_amount": "1000000.00",
-                "bps": 125,
-                "per_unit_maximum": "19.00"
-           },
-          {
-                "maximum_amount": null,
-                "bps": 115,
-                "per_unit_maximum": "4.00"
-            }
-        ]
-    }
-    ...
-}
-```
-
-## Tiered BPS pricing
-Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a
-function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given
-event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound.
-For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may
-incur a take-rate of 0.5 BPS each.
-```json
-    ...
-    "model_type": "tiered_bps",
-    "tiered_bps_config": {
-        "tiers": [
-           {
-                "minimum_amount": "0",
-                "maximum_amount": "1000000.00",
-                "bps": 125,
-                "per_unit_maximum": "19.00"
-           },
-          {
-                "minimum_amount": "1000000.00",
-                "maximum_amount": null,
-                "bps": 115,
-                "per_unit_maximum": "4.00"
-            }
-        ]
-    }
-    ...
-}
-```
-
-## Matrix pricing
-Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. `dimensions` defines the two event
-property values evaluated in this pricing model. In a one-dimensional matrix, the second value is `null`. Every
-configuration has a list of `matrix_values` which give the unit prices for specified property values. In a
-one-dimensional matrix, the matrix values will have `dimension_values` where the second value of the pair is null.
-If an event does not match any of the dimension values in the matrix, it will resort to the `default_unit_amount`.
-```json
-{
-    "model_type": "matrix"
-    "matrix_config": {
-        "default_unit_amount": "3.00",
-        "dimensions": [
-            "cluster_name",
-            "region"
-        ],
-        "matrix_values": [
-            {
-                "dimension_values": [
-                    "alpha",
-                    "west"
-                ],
-                "unit_amount": "2.00"
-            },
-            ...
-        ]
-    }
-}
-```
-
-### Fixed fees
-Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an
-additional parameter `fixed_price_quantity`. If the Price represents a fixed cost, this represents the quantity of
-units applied.
-```json
-{
-    ...
-    "id": "price_id",
-    "model_type": "unit",
-    "unit_config": {
-       "unit_amount": "2.00"
-    },
-    "fixed_price_quantity": 3.0
-    ...
-}
-```
-
-
-## Fields
-
-| Field                                                                                           | Type                                                                                            | Required                                                                                        | Description                                                                                     |
-| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| `billableMetric`                                                                                | [BillableMetricTiny](../../models/shared/billablemetrictiny.md)                                 | :heavy_check_mark:                                                                              | N/A                                                                                             |
-| `cadence`                                                                                       | [ThresholdTotalAmountPriceCadence](../../models/shared/thresholdtotalamountpricecadence.md)     | :heavy_check_mark:                                                                              | N/A                                                                                             |
-| `createdAt`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)   | :heavy_check_mark:                                                                              | N/A                                                                                             |
-| `currency`                                                                                      | *string*                                                                                        | :heavy_check_mark:                                                                              | N/A                                                                                             |
-| `discount`                                                                                      | *any*                                                                                           | :heavy_minus_sign:                                                                              | N/A                                                                                             |
-| `externalPriceId`                                                                               | *string*                                                                                        | :heavy_check_mark:                                                                              | N/A                                                                                             |
-| `fixedPriceQuantity`                                                                            | *number*                                                                                        | :heavy_check_mark:                                                                              | N/A                                                                                             |
-| `id`                                                                                            | *string*                                                                                        | :heavy_check_mark:                                                                              | N/A                                                                                             |
-| `item`                                                                                          | [ItemSlim](../../models/shared/itemslim.md)                                                     | :heavy_check_mark:                                                                              | N/A                                                                                             |
-| `maximum`                                                                                       | [Maximum](../../models/shared/maximum.md)                                                       | :heavy_minus_sign:                                                                              | N/A                                                                                             |
-| `maximumAmount`                                                                                 | *string*                                                                                        | :heavy_minus_sign:                                                                              | N/A                                                                                             |
-| `minimum`                                                                                       | [Minimum](../../models/shared/minimum.md)                                                       | :heavy_minus_sign:                                                                              | N/A                                                                                             |
-| `minimumAmount`                                                                                 | *string*                                                                                        | :heavy_minus_sign:                                                                              | N/A                                                                                             |
-| `modelType`                                                                                     | [ThresholdTotalAmountPriceModelType](../../models/shared/thresholdtotalamountpricemodeltype.md) | :heavy_check_mark:                                                                              | N/A                                                                                             |
-| `name`                                                                                          | *string*                                                                                        | :heavy_check_mark:                                                                              | N/A                                                                                             |
-| `planPhaseOrder`                                                                                | *number*                                                                                        | :heavy_check_mark:                                                                              | N/A                                                                                             |
-| `priceType`                                                                                     | [ThresholdTotalAmountPricePriceType](../../models/shared/thresholdtotalamountpricepricetype.md) | :heavy_check_mark:                                                                              | N/A                                                                                             |
-| `thresholdTotalAmountConfig`                                                                    | Record<string, *any*>                                                                           | :heavy_check_mark:                                                                              | N/A                                                                                             |

package/docs/models/shared/thresholdtotalamountpricecadence.md

@@ -1,11 +0,0 @@
-# ThresholdTotalAmountPriceCadence
-
-
-## Values
-
-| Name        | Value       |
-| ----------- | ----------- |
-| `OneTime`   | one_time    |
-| `Monthly`   | monthly     |
-| `Quarterly` | quarterly   |
-| `Annual`    | annual      |

package/docs/models/shared/thresholdtotalamountpricemodeltype.md

@@ -1,8 +0,0 @@
-# ThresholdTotalAmountPriceModelType
-
-
-## Values
-
-| Name                   | Value                  |
-| ---------------------- | ---------------------- |
-| `ThresholdTotalAmount` | threshold_total_amount |

package/docs/models/shared/thresholdtotalamountpricepricetype.md

@@ -1,9 +0,0 @@
-# ThresholdTotalAmountPricePriceType
-
-
-## Values
-
-| Name         | Value        |
-| ------------ | ------------ |
-| `UsagePrice` | usage_price  |
-| `FixedPrice` | fixed_price  |

package/docs/models/shared/tier.md

@@ -1,10 +0,0 @@
-# Tier
-
-
-## Fields
-
-| Field                                                                  | Type                                                                   | Required                                                               | Description                                                            |
-| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
-| `firstUnit`                                                            | *any*                                                                  | :heavy_check_mark:                                                     | Inclusive tier starting value                                          |
-| `lastUnit`                                                             | *any*                                                                  | :heavy_minus_sign:                                                     | Exclusive tier ending value. If null, this is treated as the last tier |
-| `unitAmount`                                                           | *string*                                                               | :heavy_check_mark:                                                     | Amount per unit                                                        |

package/docs/models/shared/tierconfig.md

@@ -1,10 +0,0 @@
-# TierConfig
-
-
-## Fields
-
-| Field              | Type               | Required           | Description        | Example            |
-| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
-| `firstUnit`        | *any*              | :heavy_check_mark: | N/A                |                    |
-| `lastUnit`         | *any*              | :heavy_check_mark: | N/A                |                    |
-| `unitAmount`       | *string*           | :heavy_check_mark: | N/A                | 3.00               |

package/docs/models/shared/tieredbpsconfig.md

@@ -1,8 +0,0 @@
-# TieredBpsConfig
-
-
-## Fields
-
-| Field                                                                                 | Type                                                                                  | Required                                                                              | Description                                                                           |
-| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
-| `tiers`                                                                               | [BpsTier](../../models/shared/bpstier.md)[]                                           | :heavy_check_mark:                                                                    | Tiers for a Graduated BPS pricing model, where usage is bucketed into specified tiers |

package/docs/models/shared/tieredbpsprice.md

@@ -1,225 +0,0 @@
-# TieredBpsPrice
-
-The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in
-the form of an invoice line item. Prices take a quantity and determine an amount to bill.
-
-Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a
-given Price object. The model_type field determines the key for the configuration object that is present.
-
-## Unit pricing
-With unit pricing, each unit costs a fixed amount.
-```json
-{
-    ...
-    "model_type": "unit",
-    "unit_config": {
-        "unit_amount": "0.50"
-    }
-    ...
-}
-```
-
-## Tiered pricing
-In tiered pricing, the cost of a given unit depends on the tier range that it falls into, where each tier range is
-defined by an upper and lower bound. For example, the first ten units may cost $0.50 each and all units thereafter
-may cost $0.10 each.
-```json
-{
-    ...
-    "model_type": "tiered",
-    "tiered_config": {
-        "tiers": [
-            {
-                "first_unit": 1,
-                "last_unit": 10,
-                "unit_amount": "0.50"
-            },
-            {
-                "first_unit": 11,
-                "last_unit": null,
-                "unit_amount": "0.10"
-            }
-        ]
-    }
-    ...
-```
-
-## Bulk pricing
-Bulk pricing applies when the number of units determine the cost of all units. For example, if you've bought less
-than 10 units, they may each be $0.50 for a total of $5.00. Once you've bought more than 10 units, all units may
-now be priced at $0.40 (i.e. 101 units total would be $40.40).
-```json
-{
-    ...
-    "model_type": "bulk",
-    "bulk_config": {
-        "tiers": [
-            {
-                "maximum_units": 10,
-                "unit_amount": "0.50"
-            },
-            {
-                "maximum_units": 1000,
-                "unit_amount": "0.40"
-            }
-        ]
-    }
-    ...
-}
-```
-
-## Package pricing
-Package pricing defines the size or granularity of a unit for billing purposes. For example, if the package size is
-set to 5, then 4 units will be billed as 5 and 6 units will be billed at 10.
-```json
-{
-    ...
-    "model_type": "package",
-    "package_config": {
-        "package_amount": "0.80",
-        "package_size": 10
-    }
-    ...
-}
-```
-
-## BPS pricing
-BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a percent (the number of basis points
-to charge), as well as a cap per event to assess. For example, this would allow you to assess a fee of 0.25% on
-every payment you process, with a maximum charge of $25 per payment.
-```json
-{
-    ...
-    "model_type": "bps",
-    "bps_config": {
-       "bps": 125,
-       "per_unit_maximum": "11.00"
-    }
-    ...
- }
-```
-
-## Bulk BPS pricing
-Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the total quantity across all events.
-Similar to bulk pricing, the BPS parameters of a given event depends on the tier range that the billing period
-falls into. Each tier range is defined by an upper bound. For example, after $1.5M of payment volume is reached,
-each individual payment may have a lower cap or a smaller take-rate.
-```json
-    ...
-    "model_type": "bulk_bps",
-    "bulk_bps_config": {
-        "tiers": [
-           {
-                "maximum_amount": "1000000.00",
-                "bps": 125,
-                "per_unit_maximum": "19.00"
-           },
-          {
-                "maximum_amount": null,
-                "bps": 115,
-                "per_unit_maximum": "4.00"
-            }
-        ]
-    }
-    ...
-}
-```
-
-## Tiered BPS pricing
-Tiered BPS pricing specifies BPS parameters in a graduated manner, where an event's applicable parameter is a
-function of its marginal addition to the period total. Similar to tiered pricing, the BPS parameters of a given
-event depends on the tier range that it falls into, where each tier range is defined by an upper and lower bound.
-For example, the first few payments may have a 0.8 BPS take-rate and all payments after a specific volume may
-incur a take-rate of 0.5 BPS each.
-```json
-    ...
-    "model_type": "tiered_bps",
-    "tiered_bps_config": {
-        "tiers": [
-           {
-                "minimum_amount": "0",
-                "maximum_amount": "1000000.00",
-                "bps": 125,
-                "per_unit_maximum": "19.00"
-           },
-          {
-                "minimum_amount": "1000000.00",
-                "maximum_amount": null,
-                "bps": 115,
-                "per_unit_maximum": "4.00"
-            }
-        ]
-    }
-    ...
-}
-```
-
-## Matrix pricing
-Matrix pricing defines a set of unit prices in a one or two-dimensional matrix. `dimensions` defines the two event
-property values evaluated in this pricing model. In a one-dimensional matrix, the second value is `null`. Every
-configuration has a list of `matrix_values` which give the unit prices for specified property values. In a
-one-dimensional matrix, the matrix values will have `dimension_values` where the second value of the pair is null.
-If an event does not match any of the dimension values in the matrix, it will resort to the `default_unit_amount`.
-```json
-{
-    "model_type": "matrix"
-    "matrix_config": {
-        "default_unit_amount": "3.00",
-        "dimensions": [
-            "cluster_name",
-            "region"
-        ],
-        "matrix_values": [
-            {
-                "dimension_values": [
-                    "alpha",
-                    "west"
-                ],
-                "unit_amount": "2.00"
-            },
-            ...
-        ]
-    }
-}
-```
-
-### Fixed fees
-Fixed fees are prices that are applied independent of usage quantities, and follow unit pricing. They also have an
-additional parameter `fixed_price_quantity`. If the Price represents a fixed cost, this represents the quantity of
-units applied.
-```json
-{
-    ...
-    "id": "price_id",
-    "model_type": "unit",
-    "unit_config": {
-       "unit_amount": "2.00"
-    },
-    "fixed_price_quantity": 3.0
-    ...
-}
-```
-
-
-## Fields
-
-| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
-| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `billableMetric`                                                                              | [BillableMetricTiny](../../models/shared/billablemetrictiny.md)                               | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `cadence`                                                                                     | [TieredBpsPriceCadence](../../models/shared/tieredbpspricecadence.md)                         | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `createdAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `currency`                                                                                    | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `discount`                                                                                    | *any*                                                                                         | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `externalPriceId`                                                                             | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `fixedPriceQuantity`                                                                          | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `id`                                                                                          | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `item`                                                                                        | [ItemSlim](../../models/shared/itemslim.md)                                                   | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `maximum`                                                                                     | [Maximum](../../models/shared/maximum.md)                                                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `maximumAmount`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `minimum`                                                                                     | [Minimum](../../models/shared/minimum.md)                                                     | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `minimumAmount`                                                                               | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
-| `modelType`                                                                                   | [TieredBpsPriceModelType](../../models/shared/tieredbpspricemodeltype.md)                     | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `name`                                                                                        | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `planPhaseOrder`                                                                              | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `priceType`                                                                                   | [TieredBpsPricePriceType](../../models/shared/tieredbpspricepricetype.md)                     | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `tieredBpsConfig`                                                                             | [TieredBpsConfig](../../models/shared/tieredbpsconfig.md)                                     | :heavy_check_mark:                                                                            | N/A                                                                                           |

package/docs/models/shared/tieredbpspricecadence.md

@@ -1,11 +0,0 @@
-# TieredBpsPriceCadence
-
-
-## Values
-
-| Name        | Value       |
-| ----------- | ----------- |
-| `OneTime`   | one_time    |
-| `Monthly`   | monthly     |
-| `Quarterly` | quarterly   |
-| `Annual`    | annual      |

package/docs/models/shared/tieredbpspricemodeltype.md

@@ -1,8 +0,0 @@
-# TieredBpsPriceModelType
-
-
-## Values
-
-| Name        | Value       |
-| ----------- | ----------- |
-| `TieredBps` | tiered_bps  |

package/docs/models/shared/tieredbpspricepricetype.md

@@ -1,9 +0,0 @@
-# TieredBpsPricePriceType
-
-
-## Values
-
-| Name         | Value        |
-| ------------ | ------------ |
-| `UsagePrice` | usage_price  |
-| `FixedPrice` | fixed_price  |

package/docs/models/shared/tieredconfig.md

@@ -1,8 +0,0 @@
-# TieredConfig
-
-
-## Fields
-
-| Field                                                                    | Type                                                                     | Required                                                                 | Description                                                              |
-| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
-| `tiers`                                                                  | [Tier](../../models/shared/tier.md)[]                                    | :heavy_check_mark:                                                       | Tiers for rating based on total usage quantities into the specified tier |