orb-billing 1.21.0 → 1.22.0

package/docs/models/shared/product.md

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

package/docs/models/shared/reportingconfiguration.md

@@ -1,8 +0,0 @@
-# ReportingConfiguration
-
-
-## Fields
-
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `exempt`           | *boolean*          | :heavy_check_mark: | N/A                |

package/docs/models/shared/security.md

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

package/docs/models/shared/subscription.md

@@ -1,44 +0,0 @@
-# Subscription
-
-A [subscription](../guides/core-concepts.mdx#subscription) represents the purchase of a plan by a customer.
-
-By default, subscriptions begin on the day that they're created and renew automatically for each billing cycle at
-the cadence that's configured in the plan definition.
-
-Subscriptions also default to **beginning of month alignment**, which means the first invoice issued for the
-subscription will have pro-rated charges between the `start_date` and the first of the following month. Subsequent
-billing periods will always start and end on a month boundary (e.g. subsequent month starts for monthly billing).
-
-Depending on the plan configuration, any _flat_ recurring fees will be billed either at the beginning (in-advance)
-or end (in-arrears) of each billing cycle. Plans default to **in-advance billing**. Usage-based fees are billed in
-arrears as usage is accumulated. In the normal course of events, you can expect an invoice to contain usage-based
-charges for the previous period, and a recurring fee for the following period.
-
-
-## Fields
-
-| Field                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Required                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `activePlanPhaseOrder`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | *number*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | The current plan phase that is active, only if the subscription's plan has phases.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
-| `autoCollection`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | *boolean*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Determines whether issued invoices for this subscription will automatically be charged with the saved payment method on the due date. This property defaults to the plan's behavior.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
-| `billingCycleDay`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | *number*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | The day of the month on which the billing cycle is anchored. If the maximum number of days in a month is greater than this value, the last day of the month is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing period begins on the 30th.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
-| `createdAt`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| `currentBillingPeriodEndDate`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | The end of the current billing period. This is an exclusive timestamp, such that the instant returned is not part of the billing period. Set to null for subscriptions that are not currently active.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
-| `currentBillingPeriodStartDate`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | The start date of the current billing period. This is an inclusive timestamp; the instant returned is exactly the beginning of the billing period. Set to null if the subscription is not currently active.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
-| `customer`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | [Customer](../../models/shared/customer.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | A customer is a buyer of your products, and the other party to the billing relationship.<br/><br/>In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these<br/>match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an<br/>`external_customer_id` with your own identifier. See<br/>[Customer ID Aliases](../guides/events-and-metrics/customer-aliases) for further information about how these<br/>aliases work in Orb.<br/><br/>In addition to having an identifier in your system, a customer may exist in a payment provider solution like<br/>Stripe. Use the `payment_provider_id` and the `payment_provider` enum field to express this mapping.<br/><br/>A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which<br/>defaults to your account's timezone. See [Timezone localization](../guides/product-catalog/timezones.md) for<br/>information on what this timezone parameter influences within Orb. |
-| `defaultInvoiceMemo`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Determines the default memo on this subscriptions' invoices. Note that if this is not provided, it is determined by the plan configuration.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
-| `discountIntervals`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | *any*[]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | The discount intervals for this subscription.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
-| `endDate`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | The date Orb stops billing for this subscription.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
-| `fixedFeeQuantitySchedule`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | [FixedFeeQuantityScheduleEntry](../../models/shared/fixedfeequantityscheduleentry.md)[]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| `id`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| `invoicingThreshold`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| `maximumIntervals`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | [MaximumInterval](../../models/shared/maximuminterval.md)[]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | The maximum intervals for this subscription.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
-| `metadata`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | [SubscriptionMetadata](../../models/shared/subscriptionmetadata.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | User specified key-value pairs. If no metadata was specified at subscription creation time, this defaults to an empty dictionary.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
-| `minimumIntervals`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | [MinimumInterval](../../models/shared/minimuminterval.md)[]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | The minimum intervals for this subscription.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
-| `netTerms`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | *number*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Determines the difference between the invoice issue date for subscription invoices as the date that they are due. A value of `0` here represents that the invoice is due on issue, whereas a value of `30` represents that the customer has a month to pay the invoice.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
-| `plan`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [Plan](../../models/shared/plan.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | The [Plan](../guides/core-concepts.mdx#plan-and-price) resource represents a plan that can be subscribed to by a<br/>customer. Plans define the billing behavior of the subscription. You can see more about how to configure prices<br/>in the [Price resource](/reference/price).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| `priceIntervals`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | [PriceInterval](../../models/shared/priceinterval.md)[]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | The price intervals for this subscription.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
-| `redeemedCoupon`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | [CouponRedemption](../../models/shared/couponredemption.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| `startDate`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | The date Orb starts billing for this subscription.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
-| `status`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | [SubscriptionStatus](../../models/shared/subscriptionstatus.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-| `trialInfo`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | [SubscriptionTrialInfo](../../models/shared/subscriptiontrialinfo.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |

package/docs/models/shared/subscriptioncosts.md

@@ -1,8 +0,0 @@
-# SubscriptionCosts
-
-
-## Fields
-
-| Field                                                     | Type                                                      | Required                                                  | Description                                               |
-| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
-| `data`                                                    | [AggregatedCost](../../models/shared/aggregatedcost.md)[] | :heavy_check_mark:                                        | N/A                                                       |

package/docs/models/shared/subscriptionmetadata.md

@@ -1,9 +0,0 @@
-# SubscriptionMetadata
-
-User specified key-value pairs. If no metadata was specified at subscription creation time, this defaults to an empty dictionary.
-
-
-## Fields
-
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/shared/subscriptionminified.md

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

package/docs/models/shared/subscriptionplanchange.md

@@ -1,23 +0,0 @@
-# SubscriptionPlanChange
-
-
-## Fields
-
-| Field                                                                                                                                                                                                        | Type                                                                                                                                                                                                         | Required                                                                                                                                                                                                     | Description                                                                                                                                                                                                  | Example                                                                                                                                                                                                      |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `alignBillingWithPlanChangeDate`                                                                                                                                                                             | *boolean*                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                           | [DEPRECATED] Use billing_cycle_alignment instead. Reset billing periods to be aligned with the plan change’s effective date.                                                                                 |                                                                                                                                                                                                              |
-| `billingCycleAlignment`                                                                                                                                                                                      | [BillingCycleAlignment](../../models/shared/billingcyclealignment.md)                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                           | Reset billing periods to be aligned with the plan change’s effective date or start of the month. Defaults to `unchanged` which keeps subscription's existing billing cycle alignment.                        |                                                                                                                                                                                                              |
-| `changeDate`                                                                                                                                                                                                 | *string*                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                           | The date that the plan change should take effect. This parameter can only be passed if the `change_option` is `requested_date`.                                                                              | 2017-07-21T17:32:28Z                                                                                                                                                                                         |
-| `changeOption`                                                                                                                                                                                               | [ChangeOption](../../models/shared/changeoption.md)                                                                                                                                                          | :heavy_check_mark:                                                                                                                                                                                           | N/A                                                                                                                                                                                                          |                                                                                                                                                                                                              |
-| `couponRedemptionCode`                                                                                                                                                                                       | *string*                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                           | Redemption code to be used for this subscription. If the coupon cannot be found by its redemption code, or cannot be redeemed, an error response will be returned and the plan change will not be scheduled. |                                                                                                                                                                                                              |
-| `creditsOverageRate`                                                                                                                                                                                         | *any*                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                           | N/A                                                                                                                                                                                                          |                                                                                                                                                                                                              |
-| `discount`                                                                                                                                                                                                   | [Discount](../../models/shared/discount.md)                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                           | The subscription's override discount for the plan.                                                                                                                                                           |                                                                                                                                                                                                              |
-| `externalPlanId`                                                                                                                                                                                             | *string*                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                           | The external_plan_id of the plan that the given subscription should be switched to. Note that either this property or `plan_id` must be specified.                                                           | ZMwNQefe7J3ecf7W                                                                                                                                                                                             |
-| `initialPhaseOrder`                                                                                                                                                                                          | *number*                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                           | The phase of the plan to start with                                                                                                                                                                          | 2                                                                                                                                                                                                            |
-| `invoicingThreshold`                                                                                                                                                                                         | *string*                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                           | When this subscription's accrued usage reaches this threshold, an invoice will be issued for the subscription. If not specified, invoices will only be issued at the end of the billing period.              | 10.00                                                                                                                                                                                                        |
-| `maximumAmount`                                                                                                                                                                                              | *string*                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                           | The subscription's override maximum amount for the plan.                                                                                                                                                     | 1.23                                                                                                                                                                                                         |
-| `minimumAmount`                                                                                                                                                                                              | *string*                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                           | The subscription's override minimum amount for the plan.                                                                                                                                                     | 1.23                                                                                                                                                                                                         |
-| `perCreditOverageAmount`                                                                                                                                                                                     | *string*                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                           | N/A                                                                                                                                                                                                          |                                                                                                                                                                                                              |
-| `phaseOverrides`                                                                                                                                                                                             | [PhaseOverride](../../models/shared/phaseoverride.md)[]                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                           | N/A                                                                                                                                                                                                          |                                                                                                                                                                                                              |
-| `planId`                                                                                                                                                                                                     | *string*                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                           | The plan that the given subscription should be switched to. Note that either this property or `external_plan_id` must be specified.                                                                          | ZMwNQefe7J3ecf7W                                                                                                                                                                                             |
-| `priceOverrides`                                                                                                                                                                                             | *any*[]                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                           | Optionally provide a list of overrides for prices on the plan                                                                                                                                                |                                                                                                                                                                                                              |

package/docs/models/shared/subscriptions.md

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

package/docs/models/shared/subscriptionscheduleitem.md

@@ -1,10 +0,0 @@
-# SubscriptionScheduleItem
-
-
-## 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                                                                                           |
-| `plan`                                                                                        | [PlanMinified](../../models/shared/planminified.md)                                           | :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                                                                                           |

package/docs/models/shared/subscriptionscheduleitems.md

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

package/docs/models/shared/subscriptionstatus.md

@@ -1,10 +0,0 @@
-# SubscriptionStatus
-
-
-## Values
-
-| Name       | Value      |
-| ---------- | ---------- |
-| `Active`   | active     |
-| `Ended`    | ended      |
-| `Upcoming` | upcoming   |

package/docs/models/shared/subscriptiontrialinfo.md

@@ -1,8 +0,0 @@
-# SubscriptionTrialInfo
-
-
-## 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                                                                                           |

package/docs/models/shared/taxamount.md

@@ -1,10 +0,0 @@
-# TaxAmount
-
-
-## Fields
-
-| Field                                                   | Type                                                    | Required                                                | Description                                             |
-| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
-| `amount`                                                | *string*                                                | :heavy_check_mark:                                      | The amount of additional tax incurred by this tax rate. |
-| `taxRateDescription`                                    | *string*                                                | :heavy_check_mark:                                      | The human-readable description of the applied tax rate. |
-| `taxRatePercentage`                                     | *string*                                                | :heavy_check_mark:                                      | The tax rate percentage, out of 100.                    |

package/docs/models/shared/trialconfig.md

@@ -1,9 +0,0 @@
-# TrialConfig
-
-
-## Fields
-
-| Field                                                                           | Type                                                                            | Required                                                                        | Description                                                                     |
-| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
-| `trialPeriod`                                                                   | *number*                                                                        | :heavy_check_mark:                                                              | N/A                                                                             |
-| `trialPeriodUnit`                                                               | [TrialConfigTrialPeriodUnit](../../models/shared/trialconfigtrialperiodunit.md) | :heavy_check_mark:                                                              | N/A                                                                             |

package/docs/models/shared/trialconfigtrialperiodunit.md

@@ -1,8 +0,0 @@
-# TrialConfigTrialPeriodUnit
-
-
-## Values
-
-| Name   | Value  |
-| ------ | ------ |
-| `Days` | days   |

package/docs/models/shared/triggersubscriptionphaseparams.md

@@ -1,8 +0,0 @@
-# TriggerSubscriptionPhaseParams
-
-
-## Fields
-
-| Field                                                                                                                 | Type                                                                                                                  | Required                                                                                                              | Description                                                                                                           |
-| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
-| `effectiveDate`                                                                                                       | [RFCDate](../../types/rfcdate.md)                                                                                     | :heavy_minus_sign:                                                                                                    | The date on which the phase change should take effect. If not provided, defaults to today in the customer's timezone. |

package/docs/models/shared/unschedulefixedfeequantitychangeparams.md

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