orb-billing 1.0.1 → 1.19.5

package/docs/models/shared/editcustomerpaymentprovider.md

@@ -0,0 +1,16 @@
+# EditCustomerPaymentProvider
+
+This is used for creating charges or invoices in an external system via Orb. When not in test mode:
+- the connection must first be configured in the Orb webapp. 
+- if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, `bill.com`, `netsuite`), any product mappings must first be configured with the Orb team.
+
+
+## Values
+
+| Name            | Value           |
+| --------------- | --------------- |
+| `Quickbooks`    | quickbooks      |
+| `BillCom`       | bill.com        |
+| `StripeCharge`  | stripe_charge   |
+| `StripeInvoice` | stripe_invoice  |
+| `Netsuite`      | netsuite        |

package/docs/models/shared/editplan.md

@@ -0,0 +1,9 @@
+# EditPlan
+
+
+## Fields
+
+| Field                                                                                                                                                                                 | Type                                                                                                                                                                                  | Required                                                                                                                                                                              | Description                                                                                                                                                                           |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `externalPlanId`                                                                                                                                                                      | *string*                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                    | An optional user-defined ID for this plan resource, used throughout the system as an alias for this Plan. Use this field to identify a plan by an existing identifier in your system. |
+| `metadata`                                                                                                                                                                            | [EditPlanMetadata](../../models/shared/editplanmetadata.md)                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                    | N/A                                                                                                                                                                                   |

package/docs/models/shared/editplanmetadata.md

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

package/docs/models/shared/editpriceintervalparams.md

@@ -0,0 +1,11 @@
+# EditPriceIntervalParams
+
+
+## Fields
+
+| Field                                                                                                                                                                          | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    | Example                                                                                                                                                                        |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `endDate`                                                                                                                                                                      | *any*                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                             | The updated end date of this price interval. If not specified, the start date will not be updated.                                                                             |                                                                                                                                                                                |
+| `fixedFeeQuantityTransitions`                                                                                                                                                  | [PriceIntervalFixedFeeQuantityTransitionParams](../../models/shared/priceintervalfixedfeequantitytransitionparams.md)[]                                                        | :heavy_minus_sign:                                                                                                                                                             | A list of fixed fee quantity transitions to use for this price interval. Note that this list will overwrite all existing fixed fee quantity transitions on the price interval. |                                                                                                                                                                                |
+| `priceIntervalId`                                                                                                                                                              | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The id of the price interval to edit.                                                                                                                                          | sdfs6wdjvn7ujokd                                                                                                                                                               |
+| `startDate`                                                                                                                                                                    | *any*                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                             | The updated start date of this price interval. If not specified, the start date will not be updated.                                                                           |                                                                                                                                                                                |

package/docs/models/shared/editpriceintervalparamsenddateenddate.md

@@ -0,0 +1,11 @@
+# EditPriceIntervalParamsEndDateEndDate
+
+The updated end date of this price interval. If not specified, the start date will not be updated.
+
+
+## Values
+
+| Name          | Value         |
+| ------------- | ------------- |
+| `StartOfTerm` | start_of_term |
+| `EndOfTerm`   | end_of_term   |

package/docs/models/shared/editpriceintervalparamsstartdatestartdate.md

@@ -0,0 +1,11 @@
+# EditPriceIntervalParamsStartDateStartDate
+
+The updated start date of this price interval. If not specified, the start date will not be updated.
+
+
+## Values
+
+| Name          | Value         |
+| ------------- | ------------- |
+| `StartOfTerm` | start_of_term |
+| `EndOfTerm`   | end_of_term   |

package/docs/models/shared/event.md

@@ -0,0 +1,17 @@
+# Event
+
+The [Event](../guides/core-concepts.mdx#event) resource represents a usage event that has been created for a
+customer. Events are the core of Orb's usage-based billing model, and are used to calculate the usage charges for
+a given billing period.
+
+
+## Fields
+
+| Field                                                                                                                                                                                           | Type                                                                                                                                                                                            | Required                                                                                                                                                                                        | Description                                                                                                                                                                                     | Example                                                                                                                                                                                         |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `customerId`                                                                                                                                                                                    | *string*                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                              | The Orb Customer identifier                                                                                                                                                                     |                                                                                                                                                                                                 |
+| `eventName`                                                                                                                                                                                     | *string*                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                              | A name to meaningfully identify the action or event type.                                                                                                                                       |                                                                                                                                                                                                 |
+| `externalCustomerId`                                                                                                                                                                            | *string*                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                              | An alias for the Orb customer, whose mapping is specified when creating the customer                                                                                                            |                                                                                                                                                                                                 |
+| `id`                                                                                                                                                                                            | *string*                                                                                                                                                                                        | :heavy_check_mark:                                                                                                                                                                              | A unique value, generated by the client, that is used to de-duplicate events. Exactly one event with a given idempotency key will be ingested, which allows for safe request retries.           |                                                                                                                                                                                                 |
+| `properties`                                                                                                                                                                                    | [EventProperties](../../models/shared/eventproperties.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/eventproperties.md

@@ -0,0 +1,9 @@
+# EventProperties
+
+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/events.md

@@ -0,0 +1,9 @@
+# Events
+
+
+## Fields
+
+| Field                                                           | Type                                                            | Required                                                        | Description                                                     |
+| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
+| `data`                                                          | [Event](../../models/shared/event.md)[]                         | :heavy_check_mark:                                              | N/A                                                             |
+| `paginationMetadata`                                            | [PaginationMetadata](../../models/shared/paginationmetadata.md) | :heavy_check_mark:                                              | N/A                                                             |

package/docs/models/shared/eventsearchcriteria.md

@@ -0,0 +1,9 @@
+# EventSearchCriteria
+
+
+## Fields
+
+| Field                                                                                                                                                                                                                                                              | Type                                                                                                                                                                                                                                                               | Required                                                                                                                                                                                                                                                           | Description                                                                                                                                                                                                                                                        |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `eventIds`                                                                                                                                                                                                                                                         | *string*[]                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                 | This is an explicit array of IDs to filter by. Note that an event's ID is the idempotency_key that was originally used for ingestion. Values in this array will be treated case sensitively.                                                                       |
+| `invoiceId`                                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                 | This is an issued Orb invoice ID (see also List Invoices). Orb will fetch all events that were used to calculate the invoice. In the common case, this will be a list of events whose timestamp property falls within the billing period specified by the invoice. |

package/docs/models/shared/expirationchangeledgerentry.md

@@ -0,0 +1,22 @@
+# ExpirationChangeLedgerEntry
+
+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`                                                                                           | [ExpirationChangeLedgerEntryEntryStatus](../../models/shared/expirationchangeledgerentryentrystatus.md) | :heavy_check_mark:                                                                                      | N/A                                                                                                     |
+| `entryType`                                                                                             | [ExpirationChangeLedgerEntryEntryType](../../models/shared/expirationchangeledgerentryentrytype.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                                                                                                     |
+| `newBlockExpiryDate`                                                                                    | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)           | :heavy_check_mark:                                                                                      | N/A                                                                                                     |
+| `startingBalance`                                                                                       | *any*                                                                                                   | :heavy_check_mark:                                                                                      | N/A                                                                                                     |

package/docs/models/shared/expirationchangeledgerentryentrystatus.md

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

package/docs/models/shared/expirationchangeledgerentryentrytype.md

@@ -0,0 +1,8 @@
+# ExpirationChangeLedgerEntryEntryType
+
+
+## Values
+
+| Name               | Value              |
+| ------------------ | ------------------ |
+| `ExpirationChange` | expiration_change  |

package/docs/models/shared/featurenotavailableerror.md

@@ -0,0 +1,12 @@
+# FeatureNotAvailableError
+
+
+## Fields
+
+| Field                                                                                     | Type                                                                                      | Required                                                                                  | Description                                                                               |
+| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
+| `detail`                                                                                  | *string*                                                                                  | :heavy_minus_sign:                                                                        | N/A                                                                                       |
+| `headers`                                                                                 | [FeatureNotAvailableErrorHeaders](../../models/shared/featurenotavailableerrorheaders.md) | :heavy_minus_sign:                                                                        | N/A                                                                                       |
+| `status`                                                                                  | [FeatureNotAvailableErrorStatus](../../models/shared/featurenotavailableerrorstatus.md)   | :heavy_check_mark:                                                                        | N/A                                                                                       |
+| `title`                                                                                   | *string*                                                                                  | :heavy_minus_sign:                                                                        | N/A                                                                                       |
+| `type`                                                                                    | [FeatureNotAvailableErrorType](../../models/shared/featurenotavailableerrortype.md)       | :heavy_check_mark:                                                                        | N/A                                                                                       |

package/docs/models/shared/featurenotavailableerrorheaders.md

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

package/docs/models/shared/featurenotavailableerrorstatus.md

@@ -0,0 +1,8 @@
+# FeatureNotAvailableErrorStatus
+
+
+## Values
+
+| Name          | Value         |
+| ------------- | ------------- |
+| `FourHundred` | 400           |

package/docs/models/shared/featurenotavailableerrortype.md

@@ -0,0 +1,8 @@
+# FeatureNotAvailableErrorType
+
+
+## Values
+
+| Name                                                                         | Value                                                                        |
+| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| `HttpsDocsWithorbComReferenceErrorResponsesNumber404FeatureNotAvailable`     | https://docs.withorb.com/reference/error-responses#404-feature-not-available |

package/docs/models/shared/fivehundrederror.md

@@ -0,0 +1,12 @@
+# FiveHundredError
+
+
+## Fields
+
+| Field                                                                     | Type                                                                      | Required                                                                  | Description                                                               |
+| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `detail`                                                                  | *string*                                                                  | :heavy_minus_sign:                                                        | N/A                                                                       |
+| `headers`                                                                 | [FiveHundredErrorHeaders](../../models/shared/fivehundrederrorheaders.md) | :heavy_minus_sign:                                                        | N/A                                                                       |
+| `status`                                                                  | *number*                                                                  | :heavy_check_mark:                                                        | N/A                                                                       |
+| `title`                                                                   | *string*                                                                  | :heavy_minus_sign:                                                        | N/A                                                                       |
+| `type`                                                                    | [FiveHundredErrorType](../../models/shared/fivehundrederrortype.md)       | :heavy_check_mark:                                                        | N/A                                                                       |

package/docs/models/shared/fivehundrederrorheaders.md

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

package/docs/models/shared/fivehundrederrortype.md

@@ -0,0 +1,8 @@
+# FiveHundredErrorType
+
+
+## Values
+
+| Name                                                                         | Value                                                                        |
+| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| `HttpsDocsWithorbComReferenceErrorResponsesNumber500InternalServerError`     | https://docs.withorb.com/reference/error-responses#500-internal-server-error |

package/docs/models/shared/fivetranexampleprice.md

@@ -0,0 +1,225 @@
+# FivetranExamplePrice
+
+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`                                                                                     | [FivetranExamplePriceCadence](../../models/shared/fivetranexamplepricecadence.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                                                                                           |
+| `fivetranExampleConfig`                                                                       | Record<string, *any*>                                                                         | :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`                                                                                   | [FivetranExamplePriceModelType](../../models/shared/fivetranexamplepricemodeltype.md)         | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `name`                                                                                        | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `planPhaseOrder`                                                                              | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `priceType`                                                                                   | [FivetranExamplePricePriceType](../../models/shared/fivetranexamplepricepricetype.md)         | :heavy_check_mark:                                                                            | N/A                                                                                           |

package/docs/models/shared/fivetranexamplepricecadence.md

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

package/docs/models/shared/fivetranexamplepricemodeltype.md

@@ -0,0 +1,8 @@
+# FivetranExamplePriceModelType
+
+
+## Values
+
+| Name              | Value             |
+| ----------------- | ----------------- |
+| `FivetranExample` | fivetran_example  |

package/docs/models/shared/fivetranexamplepricepricetype.md

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

package/docs/models/shared/fixedfeequantitychange.md

@@ -0,0 +1,11 @@
+# FixedFeeQuantityChange
+
+
+## Fields
+
+| Field                                                                                                                                                                                                            | Type                                                                                                                                                                                                             | Required                                                                                                                                                                                                         | Description                                                                                                                                                                                                      | Example                                                                                                                                                                                                          |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `changeOption`                                                                                                                                                                                                   | [FixedFeeQuantityChangeChangeOption](../../models/shared/fixedfeequantitychangechangeoption.md)                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                               | Determines when the change takes effect. Note that if `effective_date` is specified, this defaults to `effective_date`. Otherwise, this defaults to `immediate` unless it's explicitly set to `upcoming_invoice. |                                                                                                                                                                                                                  |
+| `effectiveDate`                                                                                                                                                                                                  | [RFCDate](../../types/rfcdate.md)                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                               | The date that the quantity change should take effect, localized to the customer's timezone. Ifthis parameter is not passed in, the quantity change is effective according to `change_option`.                    | 2022-12-21                                                                                                                                                                                                       |
+| `priceId`                                                                                                                                                                                                        | *string*                                                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                                                               | Price for which the quantity should be updated. Must be a fixed fee.                                                                                                                                             |                                                                                                                                                                                                                  |
+| `quantity`                                                                                                                                                                                                       | *any*                                                                                                                                                                                                            | :heavy_check_mark:                                                                                                                                                                                               | N/A                                                                                                                                                                                                              |                                                                                                                                                                                                                  |

package/docs/models/shared/fixedfeequantitychangechangeoption.md

@@ -0,0 +1,12 @@
+# FixedFeeQuantityChangeChangeOption
+
+Determines when the change takes effect. Note that if `effective_date` is specified, this defaults to `effective_date`. Otherwise, this defaults to `immediate` unless it's explicitly set to `upcoming_invoice.
+
+
+## Values
+
+| Name              | Value             |
+| ----------------- | ----------------- |
+| `Immediate`       | immediate         |
+| `UpcomingInvoice` | upcoming_invoice  |
+| `EffectiveDate`   | effective_date    |

package/docs/models/shared/fixedfeequantityscheduleentry.md

@@ -0,0 +1,11 @@
+# FixedFeeQuantityScheduleEntry
+
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `endDate`                                                                                     | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `priceId`                                                                                     | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `quantity`                                                                                    | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `startDate`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | N/A                                                                                           |