orb-billing 1.19.5 → 1.20.0

package/docs/models/shared/addpriceintervalparamsstartdatestartdate.md

@@ -1,11 +0,0 @@
-# AddPriceIntervalParamsStartDateStartDate
-
-The start date of the price interval. This is the date that the price will start billing on the subscription.
-
-
-## Values
-
-| Name          | Value         |
-| ------------- | ------------- |
-| `StartOfTerm` | start_of_term |
-| `EndOfTerm`   | end_of_term   |

package/docs/models/shared/addvoidcreditledgerentryrequestparams.md

@@ -1,13 +0,0 @@
-# AddVoidCreditLedgerEntryRequestParams
-
-
-## Fields
-
-| Field                                                                                                                                                                                                                  | Type                                                                                                                                                                                                                   | Required                                                                                                                                                                                                               | Description                                                                                                                                                                                                            |
-| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `amount`                                                                                                                                                                                                               | *any*                                                                                                                                                                                                                  | :heavy_check_mark:                                                                                                                                                                                                     | The number of credits to effect. Note that this is required for increment, decrement, void, or undo operations.                                                                                                        |
-| `blockId`                                                                                                                                                                                                              | *string*                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                     | The ID of the block to void.                                                                                                                                                                                           |
-| `description`                                                                                                                                                                                                          | *string*                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                     | Optional metadata that can be specified when adding ledger results via the API. For example, this can be used to note an increment refers to trial credits, or for noting corrections as a result of an incident, etc. |
-| `entryType`                                                                                                                                                                                                            | [AddVoidCreditLedgerEntryRequestParamsEntryType](../../models/shared/addvoidcreditledgerentryrequestparamsentrytype.md)                                                                                                | :heavy_check_mark:                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                    |
-| `metadata`                                                                                                                                                                                                             | [AddVoidCreditLedgerEntryRequestParamsMetadata](../../models/shared/addvoidcreditledgerentryrequestparamsmetadata.md)                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                     | User-specified key/value pairs for the ledger entry resource.                                                                                                                                                          |
-| `voidReason`                                                                                                                                                                                                           | [AddVoidCreditLedgerEntryRequestParamsVoidReason](../../models/shared/addvoidcreditledgerentryrequestparamsvoidreason.md)                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                     | Can only be specified when `entry_type=void`. The reason for the void.                                                                                                                                                 |

package/docs/models/shared/addvoidcreditledgerentryrequestparamsentrytype.md

@@ -1,8 +0,0 @@
-# AddVoidCreditLedgerEntryRequestParamsEntryType
-
-
-## Values
-
-| Name   | Value  |
-| ------ | ------ |
-| `Void` | void   |

package/docs/models/shared/addvoidcreditledgerentryrequestparamsmetadata.md

@@ -1,9 +0,0 @@
-# AddVoidCreditLedgerEntryRequestParamsMetadata
-
-User-specified key/value pairs for the ledger entry resource.
-
-
-## Fields
-
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/shared/addvoidcreditledgerentryrequestparamsvoidreason.md

@@ -1,10 +0,0 @@
-# AddVoidCreditLedgerEntryRequestParamsVoidReason
-
-Can only be specified when `entry_type=void`. The reason for the void.
-
-
-## Values
-
-| Name     | Value    |
-| -------- | -------- |
-| `Refund` | refund   |

package/docs/models/shared/affectedblock.md

@@ -1,10 +0,0 @@
-# AffectedBlock
-
-
-## Fields
-
-| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
-| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `expiryDate`                                                                                  | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `id`                                                                                          | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `perUnitCostBasis`                                                                            | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |

package/docs/models/shared/amendmentledgerentry.md

@@ -1,21 +0,0 @@
-# AmendmentLedgerEntry
-
-The [Credit Ledger Entry resource](/guides/product-catalog/prepurchase) models prepaid credits within Orb.
-
-
-## Fields
-
-| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
-| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `amount`                                                                                      | *any*                                                                                         | :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                                                                                           |
-| `creditBlock`                                                                                 | [AffectedBlock](../../models/shared/affectedblock.md)                                         | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `customer`                                                                                    | [CustomerMinified](../../models/shared/customerminified.md)                                   | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `description`                                                                                 | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `endingBalance`                                                                               | *any*                                                                                         | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `entryStatus`                                                                                 | [AmendmentLedgerEntryEntryStatus](../../models/shared/amendmentledgerentryentrystatus.md)     | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `entryType`                                                                                   | [AmendmentLedgerEntryEntryType](../../models/shared/amendmentledgerentryentrytype.md)         | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `id`                                                                                          | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `ledgerSequenceNumber`                                                                        | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `metadata`                                                                                    | Record<string, *string*>                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `startingBalance`                                                                             | *any*                                                                                         | :heavy_check_mark:                                                                            | N/A                                                                                           |

package/docs/models/shared/amendmentledgerentryentrystatus.md

@@ -1,9 +0,0 @@
-# AmendmentLedgerEntryEntryStatus
-
-
-## Values
-
-| Name        | Value       |
-| ----------- | ----------- |
-| `Committed` | committed   |
-| `Pending`   | pending     |

package/docs/models/shared/amendmentledgerentryentrytype.md

@@ -1,8 +0,0 @@
-# AmendmentLedgerEntryEntryType
-
-
-## Values
-
-| Name        | Value       |
-| ----------- | ----------- |
-| `Amendment` | amendment   |

package/docs/models/shared/amountdiscount.md

@@ -1,10 +0,0 @@
-# AmountDiscount
-
-
-## Fields
-
-| Field                                                                                                           | Type                                                                                                            | Required                                                                                                        | Description                                                                                                     |
-| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
-| `amountDiscount`                                                                                                | *string*                                                                                                        | :heavy_check_mark:                                                                                              | Only available if discount_type is `amount`.                                                                    |
-| `appliesToPriceIds`                                                                                             | *string*[]                                                                                                      | :heavy_check_mark:                                                                                              | List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. |
-| `discountType`                                                                                                  | [AmountDiscountDiscountType](../../models/shared/amountdiscountdiscounttype.md)                                 | :heavy_check_mark:                                                                                              | N/A                                                                                                             |

package/docs/models/shared/amountdiscountcreationparams.md

@@ -1,9 +0,0 @@
-# AmountDiscountCreationParams
-
-
-## Fields
-
-| Field                                                                                                       | Type                                                                                                        | Required                                                                                                    | Description                                                                                                 |
-| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
-| `amountDiscount`                                                                                            | *any*                                                                                                       | :heavy_check_mark:                                                                                          | Only available if discount_type is `amount`.                                                                |
-| `discountType`                                                                                              | [AmountDiscountCreationParamsDiscountType](../../models/shared/amountdiscountcreationparamsdiscounttype.md) | :heavy_check_mark:                                                                                          | N/A                                                                                                         |

package/docs/models/shared/amountdiscountcreationparamsdiscounttype.md

@@ -1,8 +0,0 @@
-# AmountDiscountCreationParamsDiscountType
-
-
-## Values
-
-| Name     | Value    |
-| -------- | -------- |
-| `Amount` | amount   |

package/docs/models/shared/amountdiscountdiscounttype.md

@@ -1,8 +0,0 @@
-# AmountDiscountDiscountType
-
-
-## Values
-
-| Name     | Value    |
-| -------- | -------- |
-| `Amount` | amount   |

package/docs/models/shared/amountdiscountinterval.md

@@ -1,13 +0,0 @@
-# AmountDiscountInterval
-
-
-## Fields
-
-| Field                                                                                           | Type                                                                                            | Required                                                                                        | Description                                                                                     |
-| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| `amountDiscount`                                                                                | *string*                                                                                        | :heavy_check_mark:                                                                              | Only available if discount_type is `amount`.                                                    |
-| `appliesToPriceIds`                                                                             | *string*[]                                                                                      | :heavy_check_mark:                                                                              | The price ids that this discount interval applies to.                                           |
-| `appliesToPriceIntervalIds`                                                                     | *string*[]                                                                                      | :heavy_check_mark:                                                                              | The price interval ids that this discount interval applies to.                                  |
-| `discountType`                                                                                  | [AmountDiscountIntervalDiscountType](../../models/shared/amountdiscountintervaldiscounttype.md) | :heavy_check_mark:                                                                              | N/A                                                                                             |
-| `endDate`                                                                                       | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)   | :heavy_check_mark:                                                                              | The end date of the discount interval.                                                          |
-| `startDate`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)   | :heavy_check_mark:                                                                              | The start date of the discount interval.                                                        |

package/docs/models/shared/amountdiscountintervaldiscounttype.md

@@ -1,8 +0,0 @@
-# AmountDiscountIntervalDiscountType
-
-
-## Values
-
-| Name     | Value    |
-| -------- | -------- |
-| `Amount` | amount   |

package/docs/models/shared/billablemetricsimple.md

@@ -1,9 +0,0 @@
-# BillableMetricSimple
-
-
-## Fields
-
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `id`               | *string*           | :heavy_check_mark: | N/A                |
-| `name`             | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/shared/billablemetrictiny.md

@@ -1,8 +0,0 @@
-# BillableMetricTiny
-
-
-## Fields
-
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `id`               | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/shared/bpsconfig.md

@@ -1,9 +0,0 @@
-# BpsConfig
-
-
-## Fields
-
-| Field                                                   | Type                                                    | Required                                                | Description                                             |
-| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
-| `bps`                                                   | *any*                                                   | :heavy_check_mark:                                      | Basis point take rate per event                         |
-| `perUnitMaximum`                                        | *string*                                                | :heavy_minus_sign:                                      | Optional currency amount maximum to cap spend per event |

package/docs/models/shared/bpsprice.md

@@ -1,225 +0,0 @@
-# BpsPrice
-
-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                                                                                           |
-| `bpsConfig`                                                                                   | [BpsConfig](../../models/shared/bpsconfig.md)                                                 | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `cadence`                                                                                     | [BpsPriceCadence](../../models/shared/bpspricecadence.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`                                                                                   | [BpsPriceModelType](../../models/shared/bpspricemodeltype.md)                                 | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `name`                                                                                        | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `planPhaseOrder`                                                                              | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
-| `priceType`                                                                                   | [BpsPricePriceType](../../models/shared/bpspricepricetype.md)                                 | :heavy_check_mark:                                                                            | N/A                                                                                           |

package/docs/models/shared/bpspricecadence.md

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

package/docs/models/shared/bpspricemodeltype.md

@@ -1,8 +0,0 @@
-# BpsPriceModelType
-
-
-## Values
-
-| Name  | Value |
-| ----- | ----- |
-| `Bps` | bps   |

package/docs/models/shared/bpspricepricetype.md

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

package/docs/models/shared/bpstier.md

@@ -1,11 +0,0 @@
-# BpsTier
-
-
-## Fields
-
-| Field                         | Type                          | Required                      | Description                   |
-| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
-| `bps`                         | *any*                         | :heavy_check_mark:            | Per-event basis point rate    |
-| `maximumAmount`               | *string*                      | :heavy_minus_sign:            | Exclusive tier ending value   |
-| `minimumAmount`               | *string*                      | :heavy_check_mark:            | Inclusive tier starting value |
-| `perUnitMaximum`              | *string*                      | :heavy_minus_sign:            | Per unit maximum to charge    |

package/docs/models/shared/bulkbpsconfig.md

@@ -1,8 +0,0 @@
-# BulkBpsConfig
-
-
-## Fields
-
-| Field                                                                                                   | Type                                                                                                    | Required                                                                                                | Description                                                                                             |
-| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
-| `tiers`                                                                                                 | [BulkBpsTier](../../models/shared/bulkbpstier.md)[]                                                     | :heavy_check_mark:                                                                                      | Tiers for a bulk BPS pricing model where all usage is aggregated to a single tier based on total volume |