orb-billing 1.19.2 → 1.20.0

package/docs/sdks/subscription/README.md

@@ -83,34 +83,35 @@ the intervening invoice and generate a new one based on the new dates for the su
 
 ```typescript
 import { Orb } from "orb-billing";
-import { CancelSubscriptionResponse } from "orb-billing/dist/sdk/models/operations";
-import { CancelSubscriptionParamsCancelOption } from "orb-billing/dist/sdk/models/shared";
+import { CancelSubscriptionRequest } from "orb-billing/dist/sdk/models/operations";
+import { CancelSubscriptionParams, CancelSubscriptionParamsCancelOption } from "orb-billing/dist/sdk/models/shared";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const subscriptionId: string = "Clifton";
+const cancelSubscriptionParams: CancelSubscriptionParams = {
+  cancelOption: CancelSubscriptionParamsCancelOption.RequestedDate,
+};
+
+  const res = await sdk.subscription.cancel(subscriptionId, cancelSubscriptionParams);
 
-sdk.subscription.cancel({
-  cancelSubscriptionParams: {
-    cancelOption: CancelSubscriptionParamsCancelOption.EndOfSubscriptionTerm,
-    cancellationDate: new Date("2021-07-25T20:23:31.249Z"),
-  },
-  subscriptionId: "District Avon teal",
-}).then((res: CancelSubscriptionResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                                    | Type                                                                                         | Required                                                                                     | Description                                                                                  |
-| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
-| `request`                                                                                    | [operations.CancelSubscriptionRequest](../../models/operations/cancelsubscriptionrequest.md) | :heavy_check_mark:                                                                           | The request object to use for the request.                                                   |
-| `config`                                                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                 | :heavy_minus_sign:                                                                           | Available config options for making requests.                                                |
+| Parameter                                                                          | Type                                                                               | Required                                                                           | Description                                                                        |
+| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `subscriptionId`                                                                   | *string*                                                                           | :heavy_check_mark:                                                                 | N/A                                                                                |
+| `cancelSubscriptionParams`                                                         | [shared.CancelSubscriptionParams](../../models/shared/cancelsubscriptionparams.md) | :heavy_minus_sign:                                                                 | N/A                                                                                |
+| `config`                                                                           | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                       | :heavy_minus_sign:                                                                 | Available config options for making requests.                                      |
 
 
 ### Response
@@ -527,114 +528,56 @@ Ex. pass in `10.00` to issue an invoice when usage amounts hit $10.00 for a subs
 
 ```typescript
 import { Orb } from "orb-billing";
-import { CreateSubscriptionResponse } from "orb-billing/dist/sdk/models/operations";
-import {
-  DiscountDiscountType,
-  NewSubscriptionExternalMarketplace,
-  OverrideBpsPriceModelType,
-  OverrideBulkBpsPriceModelType,
-  OverrideBulkPriceModelType,
-  OverrideFivetranExamplePriceModelType,
-  OverrideMatrixPriceModelType,
-  OverridePackagePriceModelType,
-  OverridePackageWithAllocationPriceModelType,
-  OverrideTestRatingFunctionPriceModelType,
-  OverrideThresholdTotalAmountPriceModelType,
-  OverrideTieredBpsPriceModelType,
-  OverrideTieredPackagePriceModelType,
-  OverrideTieredPriceModelType,
-  OverrideTieredWithMinimumPriceModelType,
-  OverrideUnitPriceModelType,
-} from "orb-billing/dist/sdk/models/shared";
+import { DiscountDiscountType, NewSubscriptionExternalMarketplace } from "orb-billing/dist/sdk/models/shared";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.subscription.create({
-  alignBillingWithSubscriptionStartDate: false,
-  autoCollection: false,
-  awsRegion: "bluetooth Extended",
-  couponRedemptionCode: "blue",
-  creditsOverageRate: "abnormally deposit evolve",
-  customerId: "fuchsia Gasoline Screen",
-  defaultInvoiceMemo: "physical Ameliorated",
-  discount: {
-    amountDiscount: "after",
-    appliesToPriceIds: [
-      "overriding",
-    ],
-    discountType: DiscountDiscountType.Percentage,
-    percentageDiscount: 0.15,
-    trialAmountDiscount: "Buckinghamshire functionalities Grocery",
-    usageDiscount: 5853.65,
-  },
-  endDate: new Date("2021-04-21T13:24:01.462Z"),
-  externalCustomerId: "Direct metrics",
-  externalMarketplace: NewSubscriptionExternalMarketplace.Google,
-  externalMarketplaceReportingId: "Interactions Senior Mouse",
-  externalPlanId: "ZMwNQefe7J3ecf7W",
-  initialPhaseOrder: 15552,
-  invoicingThreshold: "array Edinburg Investor",
-  maximumAmount: "1.23",
-  metadata: {},
-  minimumAmount: "1.23",
-  netTerms: 550483,
-  perCreditOverageAmount: "likewise payment 1080p",
-  phaseOverrides: [
-    {
-      discount: {
-        amountDiscount: "woman",
-        appliesToPriceIds: [
-          "Indiana",
-        ],
-        discountType: DiscountDiscountType.Usage,
-        percentageDiscount: "0.15",
-        trialAmountDiscount: "Neptunium round Lake",
-        usageDiscount: 9976.91,
-      },
-      maximumAmount: "1.23",
-      minimumAmount: "1.23",
-      order: 588497,
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
     },
-  ],
-  planId: "ZMwNQefe7J3ecf7W",
-  priceOverrides: [
-    {
-      discount: {
-        amountDiscount: "convergence",
-        appliesToPriceIds: [
-          "Recycled",
-        ],
-        discountType: DiscountDiscountType.Amount,
-        percentageDiscount: "0.15",
-        trialAmountDiscount: "Pop",
-        usageDiscount: 2881.04,
-      },
-      fixedPriceQuantity: "2",
-      id: "<ID>",
-      maximumAmount: "1.23",
-      minimumAmount: "1.23",
-      modelType: OverrideTieredPriceModelType.Tiered,
-      tieredConfig: {
-        tiers: [
-          {
-            firstUnit: "overriding networks",
-            lastUnit: 7402.79,
-            unitAmount: "female",
-          },
-        ],
-      },
+  });
+
+  const res = await sdk.subscription.create({
+    creditsOverageRate: "online",
+    discount: {
+      appliesToPriceIds: [
+        "h74gfhdjvn7ujokd",
+        "7hfgtgjnbvc3ujkl",
+      ],
+      discountType: DiscountDiscountType.Usage,
+      percentageDiscount: 0.15,
+      usageDiscount: "Extended",
     },
-  ],
-  startDate: new Date("2022-09-10T18:00:27.193Z"),
-}).then((res: CreateSubscriptionResponse) => {
+    externalPlanId: "ZMwNQefe7J3ecf7W",
+    maximumAmount: "1.23",
+    metadata: {},
+    minimumAmount: "1.23",
+    phaseOverrides: [
+      {
+        discount: {
+          appliesToPriceIds: [
+            "h74gfhdjvn7ujokd",
+            "7hfgtgjnbvc3ujkl",
+          ],
+          discountType: DiscountDiscountType.Percentage,
+          percentageDiscount: 0.15,
+          usageDiscount: "blue",
+        },
+        maximumAmount: "1.23",
+        minimumAmount: "1.23",
+        order: 996706,
+      },
+    ],
+    planId: "ZMwNQefe7J3ecf7W",
+    priceOverrides: [
+      "grey",
+    ],
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -658,29 +601,30 @@ This endpoint is used to fetch a [Subscription](../guides/concepts#subscription)
 
 ```typescript
 import { Orb } from "orb-billing";
-import { FetchSubscriptionResponse } from "orb-billing/dist/sdk/models/operations";
+import { FetchSubscriptionRequest } from "orb-billing/dist/sdk/models/operations";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const subscriptionId: string = "grateful";
+
+  const res = await sdk.subscription.fetch(subscriptionId);
 
-sdk.subscription.fetch({
-  subscriptionId: "Total Honda Southeast",
-}).then((res: FetchSubscriptionResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                                  | Type                                                                                       | Required                                                                                   | Description                                                                                |
-| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
-| `request`                                                                                  | [operations.FetchSubscriptionRequest](../../models/operations/fetchsubscriptionrequest.md) | :heavy_check_mark:                                                                         | The request object to use for the request.                                                 |
-| `config`                                                                                   | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                               | :heavy_minus_sign:                                                                         | Available config options for making requests.                                              |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `subscriptionId`                                             | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
 
 
 ### Response
@@ -702,25 +646,25 @@ when a customer's subscription has started and stopped on the same day).
 
 ```typescript
 import { Orb } from "orb-billing";
-import { FetchSubscriptionCostsResponse, FetchSubscriptionCostsViewModeViewMode } from "orb-billing/dist/sdk/models/operations";
+import { FetchSubscriptionCostsViewModeViewMode } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+
+  const res = await sdk.subscription.fetchCosts({
+    subscriptionId: "disintermediate",
+    timeframeEnd: new Date("2022-03-01T05:00:00Z"),
+    timeframeStart: new Date("2022-02-01T05:00:00Z"),
+  });
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.subscription.fetchCosts({
-  groupBy: "disintermediate",
-  subscriptionId: "Coupe North Handmade",
-  timeframeEnd: new Date("2022-03-01T05:00:00Z"),
-  timeframeStart: new Date("2022-02-01T05:00:00Z"),
-  viewMode: FetchSubscriptionCostsViewModeViewMode.Periodic,
-}).then((res: FetchSubscriptionCostsResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -746,27 +690,22 @@ changes.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { FetchSubscriptionScheduleResponse } from "orb-billing/dist/sdk/models/operations";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.subscription.fetchSchedule({
-  cursor: "Minnesota compressing",
-  limit: 174664,
-  startDateGt: new Date("2021-03-05T20:30:37.349Z"),
-  startDateGte: new Date("2023-05-06T19:17:54.059Z"),
-  startDateLt: new Date("2023-06-09T04:53:17.044Z"),
-  startDateLte: new Date("2021-10-11T01:47:28.675Z"),
-  subscriptionId: "next deposit",
-}).then((res: FetchSubscriptionScheduleResponse) => {
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+
+  const res = await sdk.subscription.fetchSchedule({
+    subscriptionId: "Minnesota compressing",
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -947,35 +886,26 @@ your request might provide the following parameters:
 import { Orb } from "orb-billing";
 import {
   FetchSubscriptionUsageGranularityGranularity,
-  FetchSubscriptionUsageResponse,
   FetchSubscriptionUsageViewModeViewMode,
 } from "orb-billing/dist/sdk/models/operations";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.subscription.fetchUsage({
-  billableMetricId: "Directives",
-  cursor: "than",
-  firstDimensionKey: "Louisiana",
-  firstDimensionValue: "Powlowski program Games",
-  granularity: FetchSubscriptionUsageGranularityGranularity.Day,
-  groupBy: "Licensed concept Southeast",
-  limit: 816258,
-  secondDimensionKey: "reward even",
-  secondDimensionValue: "Electronic Chicken",
-  subscriptionId: "Diesel GB 1080p",
-  timeframeEnd: new Date("2022-03-01T05:00:00Z"),
-  timeframeStart: new Date("2022-02-01T05:00:00Z"),
-  viewMode: FetchSubscriptionUsageViewModeViewMode.Periodic,
-}).then((res: FetchSubscriptionUsageResponse) => {
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+
+  const res = await sdk.subscription.fetchUsage({
+    subscriptionId: "Directives",
+    timeframeEnd: new Date("2022-03-01T05:00:00Z"),
+    timeframeStart: new Date("2022-02-01T05:00:00Z"),
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -1004,29 +934,21 @@ passing in the `customer_id` query parameter or the `external_customer_id` query
 
 ```typescript
 import { Orb } from "orb-billing";
-import { ListSubscriptionsResponse, ListSubscriptionsStatusStatus } from "orb-billing/dist/sdk/models/operations";
+import { ListSubscriptionsStatusStatus } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+
+  const res = await sdk.subscription.list({});
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.subscription.list({
-  createdAtGt: new Date("2023-04-22T14:13:10.937Z"),
-  createdAtGte: new Date("2021-04-20T09:15:20.369Z"),
-  createdAtLt: new Date("2022-08-23T06:18:16.401Z"),
-  createdAtLte: new Date("2021-10-10T03:01:48.624Z"),
-  cursor: "Canada that orchid",
-  customerId: "West",
-  externalCustomerId: "boil primary synthesize",
-  limit: 559247,
-  status: ListSubscriptionsStatusStatus.Ended,
-}).then((res: ListSubscriptionsResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -1077,113 +999,78 @@ customer balance as needed. For details on this behavior, see
 
 ```typescript
 import { Orb } from "orb-billing";
-import { SchedulePlanChangeResponse } from "orb-billing/dist/sdk/models/operations";
+import { SchedulePlanChangeRequest } from "orb-billing/dist/sdk/models/operations";
 import {
   BillingCycleAlignment,
   ChangeOption,
+  Discount,
   DiscountDiscountType,
-  OverrideBpsPriceModelType,
-  OverrideBulkBpsPriceModelType,
-  OverrideBulkPriceModelType,
-  OverrideFivetranExamplePriceModelType,
-  OverrideMatrixPriceModelType,
-  OverridePackagePriceModelType,
-  OverridePackageWithAllocationPriceModelType,
-  OverrideTestRatingFunctionPriceModelType,
-  OverrideThresholdTotalAmountPriceModelType,
-  OverrideTieredBpsPriceModelType,
-  OverrideTieredPackagePriceModelType,
-  OverrideTieredPriceModelType,
-  OverrideTieredWithMinimumPriceModelType,
-  OverrideUnitPriceModelType,
+  PhaseOverride,
+  SubscriptionPlanChange,
 } from "orb-billing/dist/sdk/models/shared";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.subscription.schedulePlanChange({
-  subscriptionPlanChange: {
-    alignBillingWithPlanChangeDate: false,
-    billingCycleAlignment: BillingCycleAlignment.StartOfMonth,
-    changeDate: "2017-07-21T17:32:28Z",
-    changeOption: ChangeOption.Immediate,
-    couponRedemptionCode: "panel Orchestrator Bicycle",
-    creditsOverageRate: "update",
-    discount: {
-      amountDiscount: "meter Director National",
-      appliesToPriceIds: [
-        "gee",
-      ],
-      discountType: DiscountDiscountType.Percentage,
-      percentageDiscount: "0.15",
-      trialAmountDiscount: "Forint Soap Coordinator",
-      usageDiscount: "North frisk Massachusetts",
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
     },
-    externalPlanId: "ZMwNQefe7J3ecf7W",
-    initialPhaseOrder: 2,
-    invoicingThreshold: "10.00",
-    maximumAmount: "1.23",
-    minimumAmount: "1.23",
-    perCreditOverageAmount: "transition East",
-    phaseOverrides: [
-      {
-        discount: {
-          amountDiscount: "Ball dynamic",
-          appliesToPriceIds: [
-            "male",
-          ],
-          discountType: DiscountDiscountType.Usage,
-          percentageDiscount: "0.15",
-          trialAmountDiscount: "enim Tricycle Beatrice",
-          usageDiscount: 1429.24,
-        },
-        maximumAmount: "1.23",
-        minimumAmount: "1.23",
-        order: 828995,
-      },
-    ],
-    planId: "ZMwNQefe7J3ecf7W",
-    priceOverrides: [
-      {
-        discount: {
-          amountDiscount: "South provided",
-          appliesToPriceIds: [
-            "Trans",
-          ],
-          discountType: DiscountDiscountType.Percentage,
-          percentageDiscount: 0.15,
-          trialAmountDiscount: "Automotive auxiliary SUV",
-          usageDiscount: 8926.19,
-        },
-        fixedPriceQuantity: "2",
-        id: "<ID>",
-        maximumAmount: "1.23",
-        minimumAmount: "1.23",
-        modelType: OverrideUnitPriceModelType.Unit,
-        unitConfig: {
-          scalingFactor: 8132.3,
-          unitAmount: "consequently",
-        },
-      },
+  });
+const subscriptionId: string = "Consultant";
+const subscriptionPlanChange: SubscriptionPlanChange = {
+  changeDate: "2017-07-21T17:32:28Z",
+  changeOption: ChangeOption.EndOfSubscriptionTerm,
+  creditsOverageRate: "Ohio",
+  discount: {
+    appliesToPriceIds: [
+      "h74gfhdjvn7ujokd",
+      "7hfgtgjnbvc3ujkl",
     ],
+    discountType: DiscountDiscountType.Usage,
+    percentageDiscount: 0.15,
+    usageDiscount: "Bicycle",
   },
-  subscriptionId: "rewind Oriental Computers",
-}).then((res: SchedulePlanChangeResponse) => {
+  externalPlanId: "ZMwNQefe7J3ecf7W",
+  initialPhaseOrder: 2,
+  invoicingThreshold: "10.00",
+  maximumAmount: "1.23",
+  minimumAmount: "1.23",
+  phaseOverrides: [
+    {
+      discount: {
+        appliesToPriceIds: [
+          "h74gfhdjvn7ujokd",
+          "7hfgtgjnbvc3ujkl",
+        ],
+        discountType: DiscountDiscountType.Usage,
+        percentageDiscount: 0.15,
+        usageDiscount: "East",
+      },
+      maximumAmount: "1.23",
+      minimumAmount: "1.23",
+      order: 476080,
+    },
+  ],
+  planId: "ZMwNQefe7J3ecf7W",
+  priceOverrides: [
+    "update",
+  ],
+};
+
+  const res = await sdk.subscription.schedulePlanChange(subscriptionId, subscriptionPlanChange);
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                                    | Type                                                                                         | Required                                                                                     | Description                                                                                  |
-| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
-| `request`                                                                                    | [operations.SchedulePlanChangeRequest](../../models/operations/scheduleplanchangerequest.md) | :heavy_check_mark:                                                                           | The request object to use for the request.                                                   |
-| `config`                                                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                 | :heavy_minus_sign:                                                                           | Available config options for making requests.                                                |
+| Parameter                                                                      | Type                                                                           | Required                                                                       | Description                                                                    |
+| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
+| `subscriptionId`                                                               | *string*                                                                       | :heavy_check_mark:                                                             | N/A                                                                            |
+| `subscriptionPlanChange`                                                       | [shared.SubscriptionPlanChange](../../models/shared/subscriptionplanchange.md) | :heavy_minus_sign:                                                             | N/A                                                                            |
+| `config`                                                                       | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                   | :heavy_minus_sign:                                                             | Available config options for making requests.                                  |
 
 
 ### Response
@@ -1199,33 +1086,34 @@ Manually trigger a phase, effective the given date (or the current time, if not
 
 ```typescript
 import { Orb } from "orb-billing";
-import { TriggerPhaseResponse } from "orb-billing/dist/sdk/models/operations";
+import { TriggerPhaseRequest } from "orb-billing/dist/sdk/models/operations";
+import { TriggerSubscriptionPhaseParams } from "orb-billing/dist/sdk/models/shared";
 import { RFCDate } from "orb-billing/dist/sdk/types";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const subscriptionId: string = "global";
+const triggerSubscriptionPhaseParams: TriggerSubscriptionPhaseParams = {};
+
+  const res = await sdk.subscription.triggerPhase(subscriptionId, triggerSubscriptionPhaseParams);
 
-sdk.subscription.triggerPhase({
-  triggerSubscriptionPhaseParams: {
-    effectiveDate: new RFCDate("2021-11-18"),
-  },
-  subscriptionId: "Medford",
-}).then((res: TriggerPhaseResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                        | Type                                                                             | Required                                                                         | Description                                                                      |
-| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
-| `request`                                                                        | [operations.TriggerPhaseRequest](../../models/operations/triggerphaserequest.md) | :heavy_check_mark:                                                               | The request object to use for the request.                                       |
-| `config`                                                                         | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                     | :heavy_minus_sign:                                                               | Available config options for making requests.                                    |
+| Parameter                                                                                      | Type                                                                                           | Required                                                                                       | Description                                                                                    |
+| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| `subscriptionId`                                                                               | *string*                                                                                       | :heavy_check_mark:                                                                             | N/A                                                                                            |
+| `triggerSubscriptionPhaseParams`                                                               | [shared.TriggerSubscriptionPhaseParams](../../models/shared/triggersubscriptionphaseparams.md) | :heavy_minus_sign:                                                                             | N/A                                                                                            |
+| `config`                                                                                       | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                   | :heavy_minus_sign:                                                                             | Available config options for making requests.                                                  |
 
 
 ### Response
@@ -1244,29 +1132,30 @@ on auto-renew, ensuring that the subscription does not end at the currently sche
 
 ```typescript
 import { Orb } from "orb-billing";
-import { UnscheduleCancellationResponse } from "orb-billing/dist/sdk/models/operations";
+import { UnscheduleCancellationRequest } from "orb-billing/dist/sdk/models/operations";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const subscriptionId: string = "Steel";
+
+  const res = await sdk.subscription.unscheduleCancellation(subscriptionId);
 
-sdk.subscription.unscheduleCancellation({
-  subscriptionId: "Balanced",
-}).then((res: UnscheduleCancellationResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                                            | Type                                                                                                 | Required                                                                                             | Description                                                                                          |
-| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
-| `request`                                                                                            | [operations.UnscheduleCancellationRequest](../../models/operations/unschedulecancellationrequest.md) | :heavy_check_mark:                                                                                   | The request object to use for the request.                                                           |
-| `config`                                                                                             | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                         | :heavy_minus_sign:                                                                                   | Available config options for making requests.                                                        |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `subscriptionId`                                             | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
 
 
 ### Response
@@ -1284,32 +1173,35 @@ If there are no updates scheduled, this endpoint is a no-op.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { UnscheduleFixedFeeQuantityResponse } from "orb-billing/dist/sdk/models/operations";
+import { UnscheduleFixedFeeQuantityRequest } from "orb-billing/dist/sdk/models/operations";
+import { UnscheduleFixedFeeQuantityChangeParams } from "orb-billing/dist/sdk/models/shared";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const subscriptionId: string = "East";
+const unscheduleFixedFeeQuantityChangeParams: UnscheduleFixedFeeQuantityChangeParams = {
+  priceId: "Grocery New",
+};
+
+  const res = await sdk.subscription.unscheduleFixedFeeQuantity(subscriptionId, unscheduleFixedFeeQuantityChangeParams);
 
-sdk.subscription.unscheduleFixedFeeQuantity({
-  unscheduleFixedFeeQuantityChangeParams: {
-    priceId: "turquoise",
-  },
-  subscriptionId: "Digitized withdrawal",
-}).then((res: UnscheduleFixedFeeQuantityResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                                                    | Type                                                                                                         | Required                                                                                                     | Description                                                                                                  |
-| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                    | [operations.UnscheduleFixedFeeQuantityRequest](../../models/operations/unschedulefixedfeequantityrequest.md) | :heavy_check_mark:                                                                                           | The request object to use for the request.                                                                   |
-| `config`                                                                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                 | :heavy_minus_sign:                                                                                           | Available config options for making requests.                                                                |
+| Parameter                                                                                                      | Type                                                                                                           | Required                                                                                                       | Description                                                                                                    |
+| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
+| `subscriptionId`                                                                                               | *string*                                                                                                       | :heavy_check_mark:                                                                                             | N/A                                                                                                            |
+| `unscheduleFixedFeeQuantityChangeParams`                                                                       | [shared.UnscheduleFixedFeeQuantityChangeParams](../../models/shared/unschedulefixedfeequantitychangeparams.md) | :heavy_minus_sign:                                                                                             | N/A                                                                                                            |
+| `config`                                                                                                       | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                   | :heavy_minus_sign:                                                                                             | Available config options for making requests.                                                                  |
 
 
 ### Response
@@ -1325,29 +1217,30 @@ This endpoint can be used to unschedule any pending plan changes on an existing
 
 ```typescript
 import { Orb } from "orb-billing";
-import { UnschedulePlanChangeResponse } from "orb-billing/dist/sdk/models/operations";
+import { UnschedulePlanChangeRequest } from "orb-billing/dist/sdk/models/operations";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const subscriptionId: string = "embrace";
+
+  const res = await sdk.subscription.unschedulePlanChange(subscriptionId);
 
-sdk.subscription.unschedulePlanChange({
-  subscriptionId: "Carolina",
-}).then((res: UnschedulePlanChangeResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                                        | Type                                                                                             | Required                                                                                         | Description                                                                                      |
-| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
-| `request`                                                                                        | [operations.UnschedulePlanChangeRequest](../../models/operations/unscheduleplanchangerequest.md) | :heavy_check_mark:                                                                               | The request object to use for the request.                                                       |
-| `config`                                                                                         | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                     | :heavy_minus_sign:                                                                               | Available config options for making requests.                                                    |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `subscriptionId`                                             | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
 
 
 ### Response
@@ -1373,37 +1266,38 @@ of the billing period.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { UpdateFixedFeeQuantityResponse } from "orb-billing/dist/sdk/models/operations";
-import { FixedFeeQuantityChangeChangeOption } from "orb-billing/dist/sdk/models/shared";
+import { UpdateFixedFeeQuantityRequest } from "orb-billing/dist/sdk/models/operations";
+import { FixedFeeQuantityChange, FixedFeeQuantityChangeChangeOption } from "orb-billing/dist/sdk/models/shared";
 import { RFCDate } from "orb-billing/dist/sdk/types";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.subscription.updateFixedFeeQuantity({
-  fixedFeeQuantityChange: {
-    changeOption: FixedFeeQuantityChangeChangeOption.Immediate,
-    effectiveDate: new RFCDate("2022-12-21"),
-    priceId: "squiggly",
-    quantity: "archive Bronze trusty",
-  },
-  subscriptionId: "Loan Clothing",
-}).then((res: UpdateFixedFeeQuantityResponse) => {
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const subscriptionId: string = "Falls";
+const fixedFeeQuantityChange: FixedFeeQuantityChange = {
+  effectiveDate: new RFCDate("2022-12-21"),
+  priceId: "laborum archive Bronze",
+  quantity: "trusty",
+};
+
+  const res = await sdk.subscription.updateFixedFeeQuantity(subscriptionId, fixedFeeQuantityChange);
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                                            | Type                                                                                                 | Required                                                                                             | Description                                                                                          |
-| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
-| `request`                                                                                            | [operations.UpdateFixedFeeQuantityRequest](../../models/operations/updatefixedfeequantityrequest.md) | :heavy_check_mark:                                                                                   | The request object to use for the request.                                                           |
-| `config`                                                                                             | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                         | :heavy_minus_sign:                                                                                   | Available config options for making requests.                                                        |
+| Parameter                                                                      | Type                                                                           | Required                                                                       | Description                                                                    |
+| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
+| `subscriptionId`                                                               | *string*                                                                       | :heavy_check_mark:                                                             | N/A                                                                            |
+| `fixedFeeQuantityChange`                                                       | [shared.FixedFeeQuantityChange](../../models/shared/fixedfeequantitychange.md) | :heavy_minus_sign:                                                             | N/A                                                                            |
+| `config`                                                                       | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                   | :heavy_minus_sign:                                                             | Available config options for making requests.                                  |
 
 
 ### Response