orb-billing 1.0.1

package/dist/sdk/models/shared/subscription.d.ts

@@ -0,0 +1,95 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+import { Customer } from "./customer";
+import { FixedFeeQuantitySchedule } from "./fixedfeequantityschedule";
+import { Plan } from "./plan";
+import { SubscriptionStatus } from "./subscriptionstatus";
+/**
+ * User specified key-value pairs. If no metadata was specified at subscription creation time, this defaults to an empty dictionary.
+ */
+export declare class SubscriptionMetadata extends SpeakeasyBase {
+}
+export declare class SubscriptionRedeemedCoupon extends SpeakeasyBase {
+    couponId?: string;
+    /**
+     * The effective end time for the coupon, after which point  it'll no longer apply to invoices for this subscription.
+     */
+    endDate?: Date;
+    /**
+     * The effective start time of this coupon - that is, when its corresponding discount starts applying.
+     */
+    startDate?: Date;
+}
+/**
+ * A subscription represents a customer's recurring relationship with your business.
+ *
+ * @remarks
+ *
+ * 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.
+ */
+export declare class Subscription extends SpeakeasyBase {
+    /**
+     * The current plan phase that is active, only if the subscription's plan has phases.
+     */
+    activePlanPhaseOrder?: number;
+    /**
+     * 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.
+     */
+    autoCollection?: boolean;
+    /**
+     * 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.
+     */
+    billingCycleDay: number;
+    createdAt: Date;
+    /**
+     * 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.
+     */
+    currentBillingPeriodEndDate?: Date;
+    /**
+     * The start 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.
+     */
+    currentBillingPeriodStartDate?: Date;
+    /**
+     * A customer is a buyer of your products, and the other party to the billing relationship.
+     *
+     * @remarks
+     *
+     * In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an `external_customer_id` with your own identifier. See [Customer ID Aliases](../guides/events-and-metrics/customer-aliases) for further information about how these aliases work in Orb.
+     *
+     * In addition to having an identifier in your system, a customer may exist in a payment provider solution like Stripe. Use the `payment_provider_id` and the `payment_provider` enum field to express this mapping.
+     *
+     * A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which defaults to your account's timezone. See [Timezone localization](../guides/product-catalog/timezones.md) for information on what this timezone parameter influences within Orb.
+     */
+    customer: Customer;
+    /**
+     * Determines the default memo on this subscriptions' invoices. Note that if this is not provided, it is determined by the plan configuration.
+     */
+    defaultInvoiceMemo?: string;
+    /**
+     * The date Orb stops billing for this subscription.
+     */
+    endDate: Date;
+    /**
+     * List of all fixed fee quantities associated with this subscription, with their start and end dates. This list contains the initial quantity along with quantity changes.
+     */
+    fixedFeeQuantitySchedule: FixedFeeQuantitySchedule[];
+    id: string;
+    /**
+     * User specified key-value pairs. If no metadata was specified at subscription creation time, this defaults to an empty dictionary.
+     */
+    metadata: SubscriptionMetadata;
+    /**
+     * 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.
+     */
+    netTerms?: number;
+    plan: Plan;
+    redeemedCoupon?: SubscriptionRedeemedCoupon;
+    /**
+     * The date Orb starts billing for this subscription.
+     */
+    startDate: Date;
+    status: SubscriptionStatus;
+}

package/dist/sdk/models/shared/subscription.js

@@ -0,0 +1,207 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Subscription = exports.SubscriptionRedeemedCoupon = exports.SubscriptionMetadata = void 0;
+var utils_1 = require("../../../internal/utils");
+var customer_1 = require("./customer");
+var fixedfeequantityschedule_1 = require("./fixedfeequantityschedule");
+var plan_1 = require("./plan");
+var subscriptionstatus_1 = require("./subscriptionstatus");
+var class_transformer_1 = require("class-transformer");
+/**
+ * User specified key-value pairs. If no metadata was specified at subscription creation time, this defaults to an empty dictionary.
+ */
+var SubscriptionMetadata = /** @class */ (function (_super) {
+    __extends(SubscriptionMetadata, _super);
+    function SubscriptionMetadata() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return SubscriptionMetadata;
+}(utils_1.SpeakeasyBase));
+exports.SubscriptionMetadata = SubscriptionMetadata;
+var SubscriptionRedeemedCoupon = /** @class */ (function (_super) {
+    __extends(SubscriptionRedeemedCoupon, _super);
+    function SubscriptionRedeemedCoupon() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "coupon_id" }),
+        __metadata("design:type", String)
+    ], SubscriptionRedeemedCoupon.prototype, "couponId", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "end_date" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], SubscriptionRedeemedCoupon.prototype, "endDate", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "start_date" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], SubscriptionRedeemedCoupon.prototype, "startDate", void 0);
+    return SubscriptionRedeemedCoupon;
+}(utils_1.SpeakeasyBase));
+exports.SubscriptionRedeemedCoupon = SubscriptionRedeemedCoupon;
+/**
+ * A subscription represents a customer's recurring relationship with your business.
+ *
+ * @remarks
+ *
+ * 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.
+ */
+var Subscription = /** @class */ (function (_super) {
+    __extends(Subscription, _super);
+    function Subscription() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "active_plan_phase_order" }),
+        __metadata("design:type", Number)
+    ], Subscription.prototype, "activePlanPhaseOrder", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "auto_collection" }),
+        __metadata("design:type", Boolean)
+    ], Subscription.prototype, "autoCollection", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "billing_cycle_day" }),
+        __metadata("design:type", Number)
+    ], Subscription.prototype, "billingCycleDay", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "created_at" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], Subscription.prototype, "createdAt", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "current_billing_period_end_date" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], Subscription.prototype, "currentBillingPeriodEndDate", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "current_billing_period_start_date" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], Subscription.prototype, "currentBillingPeriodStartDate", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "customer" }),
+        (0, class_transformer_1.Type)(function () { return customer_1.Customer; }),
+        __metadata("design:type", customer_1.Customer)
+    ], Subscription.prototype, "customer", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "default_invoice_memo" }),
+        __metadata("design:type", String)
+    ], Subscription.prototype, "defaultInvoiceMemo", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "end_date" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], Subscription.prototype, "endDate", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)({ elemType: fixedfeequantityschedule_1.FixedFeeQuantitySchedule }),
+        (0, class_transformer_1.Expose)({ name: "fixed_fee_quantity_schedule" }),
+        (0, class_transformer_1.Type)(function () { return fixedfeequantityschedule_1.FixedFeeQuantitySchedule; }),
+        __metadata("design:type", Array)
+    ], Subscription.prototype, "fixedFeeQuantitySchedule", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "id" }),
+        __metadata("design:type", String)
+    ], Subscription.prototype, "id", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "metadata" }),
+        (0, class_transformer_1.Type)(function () { return SubscriptionMetadata; }),
+        __metadata("design:type", SubscriptionMetadata)
+    ], Subscription.prototype, "metadata", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "net_terms" }),
+        __metadata("design:type", Number)
+    ], Subscription.prototype, "netTerms", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "plan" }),
+        (0, class_transformer_1.Type)(function () { return plan_1.Plan; }),
+        __metadata("design:type", plan_1.Plan)
+    ], Subscription.prototype, "plan", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "redeemed_coupon" }),
+        (0, class_transformer_1.Type)(function () { return SubscriptionRedeemedCoupon; }),
+        __metadata("design:type", SubscriptionRedeemedCoupon)
+    ], Subscription.prototype, "redeemedCoupon", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "start_date" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], Subscription.prototype, "startDate", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "status" }),
+        __metadata("design:type", String)
+    ], Subscription.prototype, "status", void 0);
+    return Subscription;
+}(utils_1.SpeakeasyBase));
+exports.Subscription = Subscription;

package/dist/sdk/models/shared/subscriptioncancellation.d.ts

@@ -0,0 +1,12 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+import { CancelOption } from "./canceloption";
+export declare class SubscriptionCancellation extends SpeakeasyBase {
+    /**
+     * Determines the timing of subscription cancellation
+     */
+    cancelOption: CancelOption;
+    /**
+     * The date that the cancellation should take effect. This parameter can only be passed if the `cancel_option` is `requested_date`.
+     */
+    cancellationDate?: Date;
+}

package/dist/sdk/models/shared/subscriptioncancellation.js

@@ -0,0 +1,55 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionCancellation = void 0;
+var utils_1 = require("../../../internal/utils");
+var canceloption_1 = require("./canceloption");
+var class_transformer_1 = require("class-transformer");
+var SubscriptionCancellation = /** @class */ (function (_super) {
+    __extends(SubscriptionCancellation, _super);
+    function SubscriptionCancellation() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "cancel_option" }),
+        __metadata("design:type", String)
+    ], SubscriptionCancellation.prototype, "cancelOption", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "cancellation_date" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], SubscriptionCancellation.prototype, "cancellationDate", void 0);
+    return SubscriptionCancellation;
+}(utils_1.SpeakeasyBase));
+exports.SubscriptionCancellation = SubscriptionCancellation;

package/dist/sdk/models/shared/subscriptioncost.d.ts

@@ -0,0 +1,15 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+import { PerPriceCost } from "./perpricecost";
+export declare class SubscriptionCost extends SpeakeasyBase {
+    perPriceCosts: PerPriceCost[];
+    /**
+     * Total costs for the timeframe, excluding any minimums and discounts.
+     */
+    subtotal: string;
+    timeframeEnd: Date;
+    timeframeStart: Date;
+    /**
+     * Total costs for the timeframe, including any minimums and discounts.
+     */
+    total: string;
+}

package/dist/sdk/models/shared/subscriptioncost.js

@@ -0,0 +1,75 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionCost = void 0;
+var utils_1 = require("../../../internal/utils");
+var perpricecost_1 = require("./perpricecost");
+var class_transformer_1 = require("class-transformer");
+var SubscriptionCost = /** @class */ (function (_super) {
+    __extends(SubscriptionCost, _super);
+    function SubscriptionCost() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)({ elemType: perpricecost_1.PerPriceCost }),
+        (0, class_transformer_1.Expose)({ name: "per_price_costs" }),
+        (0, class_transformer_1.Type)(function () { return perpricecost_1.PerPriceCost; }),
+        __metadata("design:type", Array)
+    ], SubscriptionCost.prototype, "perPriceCosts", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "subtotal" }),
+        __metadata("design:type", String)
+    ], SubscriptionCost.prototype, "subtotal", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "timeframe_end" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], SubscriptionCost.prototype, "timeframeEnd", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "timeframe_start" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], SubscriptionCost.prototype, "timeframeStart", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "total" }),
+        __metadata("design:type", String)
+    ], SubscriptionCost.prototype, "total", void 0);
+    return SubscriptionCost;
+}(utils_1.SpeakeasyBase));
+exports.SubscriptionCost = SubscriptionCost;

package/dist/sdk/models/shared/subscriptioncosts.d.ts

@@ -0,0 +1,8 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+import { SubscriptionCost } from "./subscriptioncost";
+/**
+ * OK
+ */
+export declare class SubscriptionCosts extends SpeakeasyBase {
+    data: SubscriptionCost[];
+}

package/dist/sdk/models/shared/subscriptioncosts.js

@@ -0,0 +1,50 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionCosts = void 0;
+var utils_1 = require("../../../internal/utils");
+var subscriptioncost_1 = require("./subscriptioncost");
+var class_transformer_1 = require("class-transformer");
+/**
+ * OK
+ */
+var SubscriptionCosts = /** @class */ (function (_super) {
+    __extends(SubscriptionCosts, _super);
+    function SubscriptionCosts() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)({ elemType: subscriptioncost_1.SubscriptionCost }),
+        (0, class_transformer_1.Expose)({ name: "data" }),
+        (0, class_transformer_1.Type)(function () { return subscriptioncost_1.SubscriptionCost; }),
+        __metadata("design:type", Array)
+    ], SubscriptionCosts.prototype, "data", void 0);
+    return SubscriptionCosts;
+}(utils_1.SpeakeasyBase));
+exports.SubscriptionCosts = SubscriptionCosts;

package/dist/sdk/models/shared/subscriptionminified.d.ts

@@ -0,0 +1,7 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+/**
+ * The associated subscription for this invoice.
+ */
+export declare class SubscriptionMinified extends SpeakeasyBase {
+    id: string;
+}

package/dist/sdk/models/shared/subscriptionminified.js

@@ -0,0 +1,48 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionMinified = void 0;
+var utils_1 = require("../../../internal/utils");
+var class_transformer_1 = require("class-transformer");
+/**
+ * The associated subscription for this invoice.
+ */
+var SubscriptionMinified = /** @class */ (function (_super) {
+    __extends(SubscriptionMinified, _super);
+    function SubscriptionMinified() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "id" }),
+        __metadata("design:type", String)
+    ], SubscriptionMinified.prototype, "id", void 0);
+    return SubscriptionMinified;
+}(utils_1.SpeakeasyBase));
+exports.SubscriptionMinified = SubscriptionMinified;

package/dist/sdk/models/shared/subscriptionplanchange.d.ts

@@ -0,0 +1,54 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+import { ChangeOption } from "./changeoption";
+/**
+ * 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.
+ */
+export declare enum SubscriptionPlanChangeBillingCycleAlignment {
+    Unchanged = "unchanged",
+    PlanChangeDate = "plan_change_date",
+    StartOfMonth = "start_of_month"
+}
+export declare class SubscriptionPlanChange extends SpeakeasyBase {
+    /**
+     * [DEPRECATED] Use billing_cycle_alignment instead. Reset billing periods to be aligned with the plan change’s effective date.
+     *
+     * @deprecated this field will be removed in a future release, please migrate away from it as soon as possible
+     */
+    alignBillingWithPlanChangeDate?: boolean;
+    /**
+     * 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.
+     */
+    billingCycleAlignment?: SubscriptionPlanChangeBillingCycleAlignment;
+    /**
+     * The date that the plan change should take effect. This parameter can only be passed if the `change_option` is `requested_date`.
+     */
+    changeDate?: Date;
+    /**
+     * Determines the timing of the plan change
+     */
+    changeOption: ChangeOption;
+    /**
+     * 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.
+     */
+    couponRedemptionCode?: string;
+    /**
+     * 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.
+     */
+    externalPlanId?: string;
+    /**
+     * The subscription's override maximum amount for the plan.
+     */
+    maximumAmount?: string;
+    /**
+     * The subscription's override minimum amount for the plan.
+     */
+    minimumAmount?: string;
+    /**
+     * The plan that the given subscription should be switched to. Note that either this property or `external_plan_id` must be specified.
+     */
+    planId?: string;
+    /**
+     * Optionally provide a list of overrides for prices on the plan
+     */
+    priceOverrides?: any[];
+}