orb-billing 1.0.1 → 1.19.2

package/docs/models/shared/unitconfig.md

@@ -0,0 +1,9 @@
+# UnitConfig
+
+
+## Fields
+
+| Field                                 | Type                                  | Required                              | Description                           |
+| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
+| `scalingFactor`                       | *any*                                 | :heavy_minus_sign:                    | Multiplier to scale rated quantity by |
+| `unitAmount`                          | *string*                              | :heavy_check_mark:                    | Rate per unit of usage                |

package/docs/models/shared/unitprice.md

@@ -0,0 +1,225 @@
+# UnitPrice
+
+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`                                                                                     | [UnitPriceCadence](../../models/shared/unitpricecadence.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`                                                                                   | [UnitPriceModelType](../../models/shared/unitpricemodeltype.md)                               | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `name`                                                                                        | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `planPhaseOrder`                                                                              | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `priceType`                                                                                   | [UnitPricePriceType](../../models/shared/unitpricepricetype.md)                               | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `unitConfig`                                                                                  | [UnitConfig](../../models/shared/unitconfig.md)                                               | :heavy_check_mark:                                                                            | N/A                                                                                           |

package/docs/models/shared/unitpricecadence.md

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

package/docs/models/shared/unitpricemodeltype.md

@@ -0,0 +1,8 @@
+# UnitPriceModelType
+
+
+## Values
+
+| Name   | Value  |
+| ------ | ------ |
+| `Unit` | unit   |

package/docs/models/shared/unitpricepricetype.md

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

package/docs/models/shared/unschedulefixedfeequantitychangeparams.md

@@ -0,0 +1,8 @@
+# UnscheduleFixedFeeQuantityChangeParams
+
+
+## Fields
+
+| Field                                                               | Type                                                                | Required                                                            | Description                                                         |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `priceId`                                                           | *string*                                                            | :heavy_check_mark:                                                  | Price for which the updates should be cleared. Must be a fixed fee. |

package/docs/models/shared/upcominginvoice.md

@@ -0,0 +1,46 @@
+# UpcomingInvoice
+
+
+## Fields
+
+| Field                                                                                                                                                                                                                                       | Type                                                                                                                                                                                                                                        | Required                                                                                                                                                                                                                                    | Description                                                                                                                                                                                                                                 | Example                                                                                                                                                                                                                                     |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `amountDue`                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                          | This is the final amount required to be charged to the customer and reflects the application of the customer balance to the `total` of the invoice.                                                                                         | 8.00                                                                                                                                                                                                                                        |
+| `autoCollection`                                                                                                                                                                                                                            | [AutoCollection](../../models/shared/autocollection.md)                                                                                                                                                                                     | :heavy_check_mark:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                             |
+| `billingAddress`                                                                                                                                                                                                                            | [Address](../../models/shared/address.md)                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                             |
+| `createdAt`                                                                                                                                                                                                                                 | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                          | The creation time of the resource in Orb.                                                                                                                                                                                                   | 2022-05-01T07:01:31+00:00                                                                                                                                                                                                                   |
+| `creditNotes`                                                                                                                                                                                                                               | [CreditNoteSummary](../../models/shared/creditnotesummary.md)[]                                                                                                                                                                             | :heavy_check_mark:                                                                                                                                                                                                                          | A list of credit notes associated with the invoice                                                                                                                                                                                          |                                                                                                                                                                                                                                             |
+| `currency`                                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                          | An ISO 4217 currency string or `credits`                                                                                                                                                                                                    | USD                                                                                                                                                                                                                                         |
+| `customer`                                                                                                                                                                                                                                  | [CustomerMinified](../../models/shared/customerminified.md)                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                             |
+| `customerBalanceTransactions`                                                                                                                                                                                                               | [CustomerBalanceTransaction](../../models/shared/customerbalancetransaction.md)[]                                                                                                                                                           | :heavy_check_mark:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                             |
+| `customerTaxId`                                                                                                                                                                                                                             | [CustomerTaxId](../../models/shared/customertaxid.md)                                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                             |
+| `discount`                                                                                                                                                                                                                                  | *any*                                                                                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                             |
+| `discounts`                                                                                                                                                                                                                                 | *any*[]                                                                                                                                                                                                                                     | :heavy_check_mark:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                             |
+| `dueDate`                                                                                                                                                                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                          | When the invoice payment is due.                                                                                                                                                                                                            | 2022-05-30T07:00:00+00:00                                                                                                                                                                                                                   |
+| `eligibleToIssueAt`                                                                                                                                                                                                                         | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                          | If the invoice has a status of `draft`, this will be the time that the invoice will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is true, the invoice will automatically begin issuing at this time.              |                                                                                                                                                                                                                                             |
+| `hostedInvoiceUrl`                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                          | A URL for the invoice portal.                                                                                                                                                                                                               |                                                                                                                                                                                                                                             |
+| `id`                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                             |
+| `invoiceNumber`                                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                          | Automatically generated invoice number to help track and reconcile invoices. Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per account or customer.                                                               | JYEFHK-00001                                                                                                                                                                                                                                |
+| `invoicePdf`                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                          | The link to download the PDF representation of the `Invoice`.                                                                                                                                                                               | https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb                                                                                                                                                                         |
+| `issueFailedAt`                                                                                                                                                                                                                             | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                          | If the invoice failed to issue, this will be the last time it failed to issue (even if it is now in a different state.)                                                                                                                     |                                                                                                                                                                                                                                             |
+| `issuedAt`                                                                                                                                                                                                                                  | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                          | If the invoice has been issued, this will be the time it transitioned to `issued` (even if it is now in a different state.)                                                                                                                 |                                                                                                                                                                                                                                             |
+| `lineItems`                                                                                                                                                                                                                                 | [InvoiceLineItem](../../models/shared/invoicelineitem.md)[]                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                          | The breakdown of prices in this invoice.                                                                                                                                                                                                    |                                                                                                                                                                                                                                             |
+| `maximum`                                                                                                                                                                                                                                   | [Maximum](../../models/shared/maximum.md)                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                             |
+| `maximumAmount`                                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                             |
+| `memo`                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                          | Free-form text which is available on the invoice PDF and the Orb invoice portal.                                                                                                                                                            |                                                                                                                                                                                                                                             |
+| `metadata`                                                                                                                                                                                                                                  | [UpcomingInvoiceMetadata](../../models/shared/upcominginvoicemetadata.md)                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                             |
+| `minimum`                                                                                                                                                                                                                                   | [Minimum](../../models/shared/minimum.md)                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                             |
+| `minimumAmount`                                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                             |
+| `paidAt`                                                                                                                                                                                                                                    | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                          | If the invoice has a status of `paid`, this gives a timestamp when the invoice was paid.                                                                                                                                                    |                                                                                                                                                                                                                                             |
+| `paymentFailedAt`                                                                                                                                                                                                                           | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                          | If payment was attempted on this invoice but failed, this will be the time of the most recent attempt.                                                                                                                                      |                                                                                                                                                                                                                                             |
+| `paymentStartedAt`                                                                                                                                                                                                                          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                          | If payment was attempted on this invoice, this will be the start time of the most recent attempt. This field is especially useful for delayed-notification payment mechanisms (like bank transfers), where payment can take 3 days or more. |                                                                                                                                                                                                                                             |
+| `scheduledIssueAt`                                                                                                                                                                                                                          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                          | If the invoice is in draft, this timestamp will reflect when the invoice is scheduled to be issued.                                                                                                                                         |                                                                                                                                                                                                                                             |
+| `shippingAddress`                                                                                                                                                                                                                           | [Address](../../models/shared/address.md)                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                             |
+| `status`                                                                                                                                                                                                                                    | [UpcomingInvoiceStatus](../../models/shared/upcominginvoicestatus.md)                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                             |
+| `subscription`                                                                                                                                                                                                                              | [SubscriptionMinified](../../models/shared/subscriptionminified.md)                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                             |
+| `subtotal`                                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                          | The total before any discounts and minimums are applied.                                                                                                                                                                                    | 8.00                                                                                                                                                                                                                                        |
+| `syncFailedAt`                                                                                                                                                                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                          | If the invoice failed to sync, this will be the last time an external invoicing provider sync was attempted. This field will always be `null` for invoices using Orb Invoicing.                                                             |                                                                                                                                                                                                                                             |
+| `targetDate`                                                                                                                                                                                                                                | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                          | The scheduled date of the invoice                                                                                                                                                                                                           | 2022-05-01T07:00:00+00:00                                                                                                                                                                                                                   |
+| `total`                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                          | The total after any minimums and discounts have been applied.                                                                                                                                                                               | 8.00                                                                                                                                                                                                                                        |
+| `voidedAt`                                                                                                                                                                                                                                  | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                          | If the invoice has a status of `void`, this gives a timestamp when the invoice was voided.                                                                                                                                                  |                                                                                                                                                                                                                                             |
+| `willAutoIssue`                                                                                                                                                                                                                             | *boolean*                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                          | This is true if the invoice will be automatically issued in the future, and false otherwise.                                                                                                                                                |                                                                                                                                                                                                                                             |

package/docs/models/shared/upcominginvoicemetadata.md

@@ -0,0 +1,7 @@
+# UpcomingInvoiceMetadata
+
+
+## Fields
+
+| Field       | Type        | Required    | Description |
+| ----------- | ----------- | ----------- | ----------- |

package/docs/models/shared/upcominginvoicestatus.md

@@ -0,0 +1,12 @@
+# UpcomingInvoiceStatus
+
+
+## Values
+
+| Name     | Value    |
+| -------- | -------- |
+| `Issued` | issued   |
+| `Paid`   | paid     |
+| `Synced` | synced   |
+| `Void`   | void     |
+| `Draft`  | draft    |

package/docs/models/shared/updateevent.md

@@ -0,0 +1,12 @@
+# UpdateEvent
+
+
+## Fields
+
+| Field                                                                                                                                                                                           | Type                                                                                                                                                                                            | Required                                                                                                                                                                                        | Description                                                                                                                                                                                     | Example                                                                                                                                                                                         |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `customerId`                                                                                                                                                                                    | *string*                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                              | The Orb Customer identifier                                                                                                                                                                     |                                                                                                                                                                                                 |
+| `eventName`                                                                                                                                                                                     | *string*                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                              | A name to meaningfully identify the action or event type.                                                                                                                                       |                                                                                                                                                                                                 |
+| `externalCustomerId`                                                                                                                                                                            | *string*                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                              | An alias for the Orb customer, whose mapping is specified when creating the customer                                                                                                            |                                                                                                                                                                                                 |
+| `properties`                                                                                                                                                                                    | [UpdateEventProperties](../../models/shared/updateeventproperties.md)                                                                                                                           | :heavy_check_mark:                                                                                                                                                                              | A dictionary of custom properties. Values in this dictionary must be numeric, boolean, or strings. Nested dictionaries are disallowed.                                                          |                                                                                                                                                                                                 |
+| `timestamp`                                                                                                                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                   | :heavy_check_mark:                                                                                                                                                                              | An ISO 8601 format date with no timezone offset (i.e. UTC). This should represent the time that usage was recorded, and is particularly important to attribute usage to a given billing period. | 2020-12-09T16:09:53Z                                                                                                                                                                            |

package/docs/models/shared/updateeventproperties.md

@@ -0,0 +1,9 @@
+# UpdateEventProperties
+
+A dictionary of custom properties. Values in this dictionary must be numeric, boolean, or strings. Nested dictionaries are disallowed.
+
+
+## Fields
+
+| Field       | Type        | Required    | Description |
+| ----------- | ----------- | ----------- | ----------- |

package/docs/models/shared/urlnotfound.md

@@ -0,0 +1,12 @@
+# URLNotFound
+
+
+## Fields
+
+| Field                                                           | Type                                                            | Required                                                        | Description                                                     |
+| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
+| `detail`                                                        | *string*                                                        | :heavy_minus_sign:                                              | N/A                                                             |
+| `headers`                                                       | [URLNotFoundHeaders](../../models/shared/urlnotfoundheaders.md) | :heavy_minus_sign:                                              | N/A                                                             |
+| `status`                                                        | [URLNotFoundStatus](../../models/shared/urlnotfoundstatus.md)   | :heavy_check_mark:                                              | N/A                                                             |
+| `title`                                                         | *string*                                                        | :heavy_minus_sign:                                              | N/A                                                             |
+| `type`                                                          | [URLNotFoundType](../../models/shared/urlnotfoundtype.md)       | :heavy_check_mark:                                              | N/A                                                             |

package/docs/models/shared/urlnotfoundheaders.md

@@ -0,0 +1,7 @@
+# URLNotFoundHeaders
+
+
+## Fields
+
+| Field       | Type        | Required    | Description |
+| ----------- | ----------- | ----------- | ----------- |

package/docs/models/shared/urlnotfoundstatus.md

@@ -0,0 +1,8 @@
+# URLNotFoundStatus
+
+
+## Values
+
+| Name                 | Value                |
+| -------------------- | -------------------- |
+| `FourHundredAndFour` | 404                  |

package/docs/models/shared/urlnotfoundtype.md

@@ -0,0 +1,8 @@
+# URLNotFoundType
+
+
+## Values
+
+| Name                                                                 | Value                                                                |
+| -------------------------------------------------------------------- | -------------------------------------------------------------------- |
+| `HttpsDocsWithorbComReferenceErrorResponsesNumber404UrlNotFound`     | https://docs.withorb.com/reference/error-responses#404-url-not-found |

package/docs/models/shared/usage.md

@@ -0,0 +1,10 @@
+# Usage
+
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `quantity`                                                                                    | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `timeframeEnd`                                                                                | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `timeframeStart`                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | N/A                                                                                           |

package/docs/models/shared/usagediscount.md

@@ -0,0 +1,10 @@
+# UsageDiscount
+
+
+## Fields
+
+| Field                                                                                                           | Type                                                                                                            | Required                                                                                                        | Description                                                                                                     |
+| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
+| `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`                                                                                                  | [UsageDiscountDiscountType](../../models/shared/usagediscountdiscounttype.md)                                   | :heavy_check_mark:                                                                                              | N/A                                                                                                             |
+| `usageDiscount`                                                                                                 | *any*                                                                                                           | :heavy_check_mark:                                                                                              | Only available if discount_type is `usage`. Number of usage units that this discount is for                     |

package/docs/models/shared/usagediscountcreationparams.md

@@ -0,0 +1,9 @@
+# UsageDiscountCreationParams
+
+
+## Fields
+
+| Field                                                                                                     | Type                                                                                                      | Required                                                                                                  | Description                                                                                               |
+| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
+| `discountType`                                                                                            | [UsageDiscountCreationParamsDiscountType](../../models/shared/usagediscountcreationparamsdiscounttype.md) | :heavy_check_mark:                                                                                        | N/A                                                                                                       |
+| `usageDiscount`                                                                                           | *any*                                                                                                     | :heavy_check_mark:                                                                                        | Only available if discount_type is `usage`. Number of usage units that this discount is for.              |

package/docs/models/shared/usagediscountcreationparamsdiscounttype.md

@@ -0,0 +1,8 @@
+# UsageDiscountCreationParamsDiscountType
+
+
+## Values
+
+| Name    | Value   |
+| ------- | ------- |
+| `Usage` | usage   |

package/docs/models/shared/usagediscountdiscounttype.md

@@ -0,0 +1,8 @@
+# UsageDiscountDiscountType
+
+
+## Values
+
+| Name    | Value   |
+| ------- | ------- |
+| `Usage` | usage   |

package/docs/models/shared/usagediscountinterval.md

@@ -0,0 +1,13 @@
+# UsageDiscountInterval
+
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `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`                                                                                | [UsageDiscountIntervalDiscountType](../../models/shared/usagediscountintervaldiscounttype.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.                                                      |
+| `usageDiscount`                                                                               | *any*                                                                                         | :heavy_check_mark:                                                                            | Only available if discount_type is `usage`. Number of usage units that this discount is for   |

package/docs/models/shared/usagediscountintervaldiscounttype.md

@@ -0,0 +1,8 @@
+# UsageDiscountIntervalDiscountType
+
+
+## Values
+
+| Name    | Value   |
+| ------- | ------- |
+| `Usage` | usage   |