orb-billing 1.0.1

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

@@ -0,0 +1,74 @@
+"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.BulkBPSPriceOverride = exports.BulkBPSPriceOverrideModelType = void 0;
+var utils_1 = require("../../../internal/utils");
+var bulkbpsconfig_1 = require("./bulkbpsconfig");
+var class_transformer_1 = require("class-transformer");
+var BulkBPSPriceOverrideModelType;
+(function (BulkBPSPriceOverrideModelType) {
+    BulkBPSPriceOverrideModelType["BulkBps"] = "bulk_bps";
+})(BulkBPSPriceOverrideModelType = exports.BulkBPSPriceOverrideModelType || (exports.BulkBPSPriceOverrideModelType = {}));
+/**
+ * Bulk BPS price override
+ */
+var BulkBPSPriceOverride = /** @class */ (function (_super) {
+    __extends(BulkBPSPriceOverride, _super);
+    function BulkBPSPriceOverride() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "bulk_bps_config" }),
+        (0, class_transformer_1.Type)(function () { return bulkbpsconfig_1.BulkBpsConfig; }),
+        __metadata("design:type", bulkbpsconfig_1.BulkBpsConfig)
+    ], BulkBPSPriceOverride.prototype, "bulkBpsConfig", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "id" }),
+        __metadata("design:type", String)
+    ], BulkBPSPriceOverride.prototype, "id", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "maximum_amount" }),
+        __metadata("design:type", String)
+    ], BulkBPSPriceOverride.prototype, "maximumAmount", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "minimum_amount" }),
+        __metadata("design:type", String)
+    ], BulkBPSPriceOverride.prototype, "minimumAmount", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "model_type" }),
+        __metadata("design:type", String)
+    ], BulkBPSPriceOverride.prototype, "modelType", void 0);
+    return BulkBPSPriceOverride;
+}(utils_1.SpeakeasyBase));
+exports.BulkBPSPriceOverride = BulkBPSPriceOverride;

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

@@ -0,0 +1,6 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+export declare class BulkBpsTier extends SpeakeasyBase {
+    bps: number;
+    maximumAmount?: string;
+    perUnitMaximum?: string;
+}

package/dist/sdk/models/shared/bulkbpstier.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.BulkBpsTier = void 0;
+var utils_1 = require("../../../internal/utils");
+var class_transformer_1 = require("class-transformer");
+var BulkBpsTier = /** @class */ (function (_super) {
+    __extends(BulkBpsTier, _super);
+    function BulkBpsTier() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "bps" }),
+        __metadata("design:type", Number)
+    ], BulkBpsTier.prototype, "bps", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "maximum_amount" }),
+        __metadata("design:type", String)
+    ], BulkBpsTier.prototype, "maximumAmount", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "per_unit_maximum" }),
+        __metadata("design:type", String)
+    ], BulkBpsTier.prototype, "perUnitMaximum", void 0);
+    return BulkBpsTier;
+}(utils_1.SpeakeasyBase));
+exports.BulkBpsTier = BulkBpsTier;

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

@@ -0,0 +1,8 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+import { BulkTier } from "./bulktier";
+/**
+ * Provided when model_type is `bulk`
+ */
+export declare class BulkConfig extends SpeakeasyBase {
+    tiers?: BulkTier[];
+}

package/dist/sdk/models/shared/bulkconfig.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.BulkConfig = void 0;
+var utils_1 = require("../../../internal/utils");
+var bulktier_1 = require("./bulktier");
+var class_transformer_1 = require("class-transformer");
+/**
+ * Provided when model_type is `bulk`
+ */
+var BulkConfig = /** @class */ (function (_super) {
+    __extends(BulkConfig, _super);
+    function BulkConfig() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)({ elemType: bulktier_1.BulkTier }),
+        (0, class_transformer_1.Expose)({ name: "tiers" }),
+        (0, class_transformer_1.Type)(function () { return bulktier_1.BulkTier; }),
+        __metadata("design:type", Array)
+    ], BulkConfig.prototype, "tiers", void 0);
+    return BulkConfig;
+}(utils_1.SpeakeasyBase));
+exports.BulkConfig = BulkConfig;

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

@@ -0,0 +1,24 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+import { BulkConfig } from "./bulkconfig";
+export declare enum BulkPriceOverrideModelType {
+    Bulk = "bulk"
+}
+/**
+ * Bulk price override
+ */
+export declare class BulkPriceOverride extends SpeakeasyBase {
+    /**
+     * Provided when model_type is `bulk`
+     */
+    bulkConfig: BulkConfig;
+    id: string;
+    /**
+     * The subscription's override maximum amount for this price.
+     */
+    maximumAmount?: string;
+    /**
+     * The subscription's override minimum amount for this price.
+     */
+    minimumAmount?: string;
+    modelType: BulkPriceOverrideModelType;
+}

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

@@ -0,0 +1,74 @@
+"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.BulkPriceOverride = exports.BulkPriceOverrideModelType = void 0;
+var utils_1 = require("../../../internal/utils");
+var bulkconfig_1 = require("./bulkconfig");
+var class_transformer_1 = require("class-transformer");
+var BulkPriceOverrideModelType;
+(function (BulkPriceOverrideModelType) {
+    BulkPriceOverrideModelType["Bulk"] = "bulk";
+})(BulkPriceOverrideModelType = exports.BulkPriceOverrideModelType || (exports.BulkPriceOverrideModelType = {}));
+/**
+ * Bulk price override
+ */
+var BulkPriceOverride = /** @class */ (function (_super) {
+    __extends(BulkPriceOverride, _super);
+    function BulkPriceOverride() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "bulk_config" }),
+        (0, class_transformer_1.Type)(function () { return bulkconfig_1.BulkConfig; }),
+        __metadata("design:type", bulkconfig_1.BulkConfig)
+    ], BulkPriceOverride.prototype, "bulkConfig", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "id" }),
+        __metadata("design:type", String)
+    ], BulkPriceOverride.prototype, "id", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "maximum_amount" }),
+        __metadata("design:type", String)
+    ], BulkPriceOverride.prototype, "maximumAmount", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "minimum_amount" }),
+        __metadata("design:type", String)
+    ], BulkPriceOverride.prototype, "minimumAmount", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "model_type" }),
+        __metadata("design:type", String)
+    ], BulkPriceOverride.prototype, "modelType", void 0);
+    return BulkPriceOverride;
+}(utils_1.SpeakeasyBase));
+exports.BulkPriceOverride = BulkPriceOverride;

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

@@ -0,0 +1,5 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+export declare class BulkTier extends SpeakeasyBase {
+    maximumUnits?: string;
+    unitAmount: string;
+}

package/dist/sdk/models/shared/bulktier.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.BulkTier = void 0;
+var utils_1 = require("../../../internal/utils");
+var class_transformer_1 = require("class-transformer");
+var BulkTier = /** @class */ (function (_super) {
+    __extends(BulkTier, _super);
+    function BulkTier() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "maximum_units" }),
+        __metadata("design:type", String)
+    ], BulkTier.prototype, "maximumUnits", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "unit_amount" }),
+        __metadata("design:type", String)
+    ], BulkTier.prototype, "unitAmount", void 0);
+    return BulkTier;
+}(utils_1.SpeakeasyBase));
+exports.BulkTier = BulkTier;

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

@@ -0,0 +1,5 @@
+export declare enum Cadence {
+    Annual = "annual",
+    Monthly = "monthly",
+    Quarterly = "quarterly"
+}

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

@@ -0,0 +1,12 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Cadence = void 0;
+var Cadence;
+(function (Cadence) {
+    Cadence["Annual"] = "annual";
+    Cadence["Monthly"] = "monthly";
+    Cadence["Quarterly"] = "quarterly";
+})(Cadence = exports.Cadence || (exports.Cadence = {}));

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

@@ -0,0 +1,8 @@
+/**
+ * Determines the timing of subscription cancellation
+ */
+export declare enum CancelOption {
+    Immediate = "immediate",
+    EndOfSubscriptionTerm = "end_of_subscription_term",
+    RequestedDate = "requested_date"
+}

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

@@ -0,0 +1,15 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CancelOption = void 0;
+/**
+ * Determines the timing of subscription cancellation
+ */
+var CancelOption;
+(function (CancelOption) {
+    CancelOption["Immediate"] = "immediate";
+    CancelOption["EndOfSubscriptionTerm"] = "end_of_subscription_term";
+    CancelOption["RequestedDate"] = "requested_date";
+})(CancelOption = exports.CancelOption || (exports.CancelOption = {}));

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

@@ -0,0 +1,8 @@
+/**
+ * Determines the timing of the plan change
+ */
+export declare enum ChangeOption {
+    RequestedDate = "requested_date",
+    EndOfSubscriptionTerm = "end_of_subscription_term",
+    Immediate = "immediate"
+}

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

@@ -0,0 +1,15 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChangeOption = void 0;
+/**
+ * Determines the timing of the plan change
+ */
+var ChangeOption;
+(function (ChangeOption) {
+    ChangeOption["RequestedDate"] = "requested_date";
+    ChangeOption["EndOfSubscriptionTerm"] = "end_of_subscription_term";
+    ChangeOption["Immediate"] = "immediate";
+})(ChangeOption = exports.ChangeOption || (exports.ChangeOption = {}));

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

@@ -0,0 +1,8 @@
+/**
+ * Determines when the change takes effect. Note that if `effective_date` is specified, this defautls to `effective_date`. Otherwise, this defaults to `immediate` unless it's explicitly set to `upcoming_invoice.
+ */
+export declare enum ChangeOption1 {
+    Immediate = "immediate",
+    UpcomingInvoice = "upcoming_invoice",
+    EffectiveDate = "effective_date"
+}

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

@@ -0,0 +1,15 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChangeOption1 = void 0;
+/**
+ * Determines when the change takes effect. Note that if `effective_date` is specified, this defautls to `effective_date`. Otherwise, this defaults to `immediate` unless it's explicitly set to `upcoming_invoice.
+ */
+var ChangeOption1;
+(function (ChangeOption1) {
+    ChangeOption1["Immediate"] = "immediate";
+    ChangeOption1["UpcomingInvoice"] = "upcoming_invoice";
+    ChangeOption1["EffectiveDate"] = "effective_date";
+})(ChangeOption1 = exports.ChangeOption1 || (exports.ChangeOption1 = {}));

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

@@ -0,0 +1,36 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+import { Discount } from "./discount";
+/**
+ * A coupon represents a reusable discount configuration, and have an attached redemption code that can be issued to your end users. Coupons are most often used in self-serve signup or upgrade flows in your checkout experience or billing portal.
+ *
+ * @remarks
+ *
+ * To redeem a coupon, pass the `redemption_code` property in the [create subscription](create-subscription.api.mdx) or [schedule plan change](schedule-plan-change.api.mdx) request.
+ */
+export declare class Coupon extends SpeakeasyBase {
+    /**
+     * An archived coupon can no longer be redeemed. Active coupons will have a value of null for `archived_at`; this field will be non-null for archived coupons.
+     */
+    archivedAt?: Date;
+    discount: Discount;
+    /**
+     * This allows for a coupon's discount to apply for a limited time (determined in months); a `null` value here means "unlimited time".
+     */
+    durationInMonths?: number;
+    /**
+     * Also referred to as coupon_id in this documentation.
+     */
+    id?: string;
+    /**
+     * The maximum number of redemptions allowed for this coupon before it is exhausted; `null` here means "unlimited".
+     */
+    maxRedemptions?: number;
+    /**
+     * This string can be used to redeem this coupon for a given subscription.
+     */
+    redemptionCode: string;
+    /**
+     * The number of times this coupon has been redeemed. Do not include when creating a coupon.
+     */
+    timesRedeemed?: number;
+}

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

@@ -0,0 +1,88 @@
+"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.Coupon = void 0;
+var utils_1 = require("../../../internal/utils");
+var discount_1 = require("./discount");
+var class_transformer_1 = require("class-transformer");
+/**
+ * A coupon represents a reusable discount configuration, and have an attached redemption code that can be issued to your end users. Coupons are most often used in self-serve signup or upgrade flows in your checkout experience or billing portal.
+ *
+ * @remarks
+ *
+ * To redeem a coupon, pass the `redemption_code` property in the [create subscription](create-subscription.api.mdx) or [schedule plan change](schedule-plan-change.api.mdx) request.
+ */
+var Coupon = /** @class */ (function (_super) {
+    __extends(Coupon, _super);
+    function Coupon() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "archived_at" }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return new Date(value);
+        }, { toClassOnly: true }),
+        __metadata("design:type", Date)
+    ], Coupon.prototype, "archivedAt", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "discount" }),
+        (0, class_transformer_1.Type)(function () { return discount_1.Discount; }),
+        __metadata("design:type", discount_1.Discount)
+    ], Coupon.prototype, "discount", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "duration_in_months" }),
+        __metadata("design:type", Number)
+    ], Coupon.prototype, "durationInMonths", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "id" }),
+        __metadata("design:type", String)
+    ], Coupon.prototype, "id", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "max_redemptions" }),
+        __metadata("design:type", Number)
+    ], Coupon.prototype, "maxRedemptions", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "redemption_code" }),
+        __metadata("design:type", String)
+    ], Coupon.prototype, "redemptionCode", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "times_redeemed" }),
+        __metadata("design:type", Number)
+    ], Coupon.prototype, "timesRedeemed", void 0);
+    return Coupon;
+}(utils_1.SpeakeasyBase));
+exports.Coupon = Coupon;

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

@@ -0,0 +1,10 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+import { Coupon } from "./coupon";
+import { PaginationMetadata } from "./paginationmetadata";
+/**
+ * OK
+ */
+export declare class Coupons extends SpeakeasyBase {
+    data?: Coupon[];
+    paginationMetadata?: PaginationMetadata;
+}

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

@@ -0,0 +1,57 @@
+"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.Coupons = void 0;
+var utils_1 = require("../../../internal/utils");
+var coupon_1 = require("./coupon");
+var paginationmetadata_1 = require("./paginationmetadata");
+var class_transformer_1 = require("class-transformer");
+/**
+ * OK
+ */
+var Coupons = /** @class */ (function (_super) {
+    __extends(Coupons, _super);
+    function Coupons() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)({ elemType: coupon_1.Coupon }),
+        (0, class_transformer_1.Expose)({ name: "data" }),
+        (0, class_transformer_1.Type)(function () { return coupon_1.Coupon; }),
+        __metadata("design:type", Array)
+    ], Coupons.prototype, "data", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "pagination_metadata" }),
+        (0, class_transformer_1.Type)(function () { return paginationmetadata_1.PaginationMetadata; }),
+        __metadata("design:type", paginationmetadata_1.PaginationMetadata)
+    ], Coupons.prototype, "paginationMetadata", void 0);
+    return Coupons;
+}(utils_1.SpeakeasyBase));
+exports.Coupons = Coupons;