orb-billing 1.19.5 → 1.20.0

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

@@ -1,27 +0,0 @@
-import { SpeakeasyBase } from "../../../internal/utils";
-export declare enum UsageDiscountIntervalDiscountType {
-    Usage = "usage"
-}
-export declare class UsageDiscountInterval extends SpeakeasyBase {
-    /**
-     * The price ids that this discount interval applies to.
-     */
-    appliesToPriceIds: string[];
-    /**
-     * The price interval ids that this discount interval applies to.
-     */
-    appliesToPriceIntervalIds: string[];
-    discountType: UsageDiscountIntervalDiscountType;
-    /**
-     * The end date of the discount interval.
-     */
-    endDate: Date;
-    /**
-     * The start date of the discount interval.
-     */
-    startDate: Date;
-    /**
-     * Only available if discount_type is `usage`. Number of usage units that this discount is for
-     */
-    usageDiscount: any;
-}

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

@@ -1,82 +0,0 @@
-"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.UsageDiscountInterval = exports.UsageDiscountIntervalDiscountType = void 0;
-var utils_1 = require("../../../internal/utils");
-var class_transformer_1 = require("class-transformer");
-var UsageDiscountIntervalDiscountType;
-(function (UsageDiscountIntervalDiscountType) {
-    UsageDiscountIntervalDiscountType["Usage"] = "usage";
-})(UsageDiscountIntervalDiscountType = exports.UsageDiscountIntervalDiscountType || (exports.UsageDiscountIntervalDiscountType = {}));
-var UsageDiscountInterval = /** @class */ (function (_super) {
-    __extends(UsageDiscountInterval, _super);
-    function UsageDiscountInterval() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "applies_to_price_ids" }),
-        __metadata("design:type", Array)
-    ], UsageDiscountInterval.prototype, "appliesToPriceIds", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "applies_to_price_interval_ids" }),
-        __metadata("design:type", Array)
-    ], UsageDiscountInterval.prototype, "appliesToPriceIntervalIds", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "discount_type" }),
-        __metadata("design:type", String)
-    ], UsageDiscountInterval.prototype, "discountType", 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)
-    ], UsageDiscountInterval.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)
-    ], UsageDiscountInterval.prototype, "startDate", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "usage_discount" }),
-        __metadata("design:type", Object)
-    ], UsageDiscountInterval.prototype, "usageDiscount", void 0);
-    return UsageDiscountInterval;
-}(utils_1.SpeakeasyBase));
-exports.UsageDiscountInterval = UsageDiscountInterval;

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

@@ -1,30 +0,0 @@
-import { SpeakeasyBase } from "../../../internal/utils";
-import { AffectedBlock } from "./affectedblock";
-import { CustomerMinified } from "./customerminified";
-export declare enum VoidInitiatedLedgerEntryEntryStatus {
-    Committed = "committed",
-    Pending = "pending"
-}
-export declare enum VoidInitiatedLedgerEntryEntryType {
-    VoidInitiated = "void_initiated"
-}
-/**
- * The [Credit Ledger Entry resource](/guides/product-catalog/prepurchase) models prepaid credits within Orb.
- */
-export declare class VoidInitiatedLedgerEntry extends SpeakeasyBase {
-    amount: any;
-    createdAt: Date;
-    creditBlock: AffectedBlock;
-    customer: CustomerMinified;
-    description: string;
-    endingBalance: any;
-    entryStatus: VoidInitiatedLedgerEntryEntryStatus;
-    entryType: VoidInitiatedLedgerEntryEntryType;
-    id: string;
-    ledgerSequenceNumber: number;
-    metadata: Record<string, string>;
-    newBlockExpiryDate: Date;
-    startingBalance: any;
-    voidAmount: any;
-    voidReason: string;
-}

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

@@ -1,139 +0,0 @@
-"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.VoidInitiatedLedgerEntry = exports.VoidInitiatedLedgerEntryEntryType = exports.VoidInitiatedLedgerEntryEntryStatus = void 0;
-var utils_1 = require("../../../internal/utils");
-var affectedblock_1 = require("./affectedblock");
-var customerminified_1 = require("./customerminified");
-var class_transformer_1 = require("class-transformer");
-var VoidInitiatedLedgerEntryEntryStatus;
-(function (VoidInitiatedLedgerEntryEntryStatus) {
-    VoidInitiatedLedgerEntryEntryStatus["Committed"] = "committed";
-    VoidInitiatedLedgerEntryEntryStatus["Pending"] = "pending";
-})(VoidInitiatedLedgerEntryEntryStatus = exports.VoidInitiatedLedgerEntryEntryStatus || (exports.VoidInitiatedLedgerEntryEntryStatus = {}));
-var VoidInitiatedLedgerEntryEntryType;
-(function (VoidInitiatedLedgerEntryEntryType) {
-    VoidInitiatedLedgerEntryEntryType["VoidInitiated"] = "void_initiated";
-})(VoidInitiatedLedgerEntryEntryType = exports.VoidInitiatedLedgerEntryEntryType || (exports.VoidInitiatedLedgerEntryEntryType = {}));
-/**
- * The [Credit Ledger Entry resource](/guides/product-catalog/prepurchase) models prepaid credits within Orb.
- */
-var VoidInitiatedLedgerEntry = /** @class */ (function (_super) {
-    __extends(VoidInitiatedLedgerEntry, _super);
-    function VoidInitiatedLedgerEntry() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "amount" }),
-        __metadata("design:type", Object)
-    ], VoidInitiatedLedgerEntry.prototype, "amount", 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)
-    ], VoidInitiatedLedgerEntry.prototype, "createdAt", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "credit_block" }),
-        (0, class_transformer_1.Type)(function () { return affectedblock_1.AffectedBlock; }),
-        __metadata("design:type", affectedblock_1.AffectedBlock)
-    ], VoidInitiatedLedgerEntry.prototype, "creditBlock", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "customer" }),
-        (0, class_transformer_1.Type)(function () { return customerminified_1.CustomerMinified; }),
-        __metadata("design:type", customerminified_1.CustomerMinified)
-    ], VoidInitiatedLedgerEntry.prototype, "customer", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "description" }),
-        __metadata("design:type", String)
-    ], VoidInitiatedLedgerEntry.prototype, "description", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "ending_balance" }),
-        __metadata("design:type", Object)
-    ], VoidInitiatedLedgerEntry.prototype, "endingBalance", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "entry_status" }),
-        __metadata("design:type", String)
-    ], VoidInitiatedLedgerEntry.prototype, "entryStatus", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "entry_type" }),
-        __metadata("design:type", String)
-    ], VoidInitiatedLedgerEntry.prototype, "entryType", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "id" }),
-        __metadata("design:type", String)
-    ], VoidInitiatedLedgerEntry.prototype, "id", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "ledger_sequence_number" }),
-        __metadata("design:type", Number)
-    ], VoidInitiatedLedgerEntry.prototype, "ledgerSequenceNumber", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "metadata" }),
-        __metadata("design:type", Object)
-    ], VoidInitiatedLedgerEntry.prototype, "metadata", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "new_block_expiry_date" }),
-        (0, class_transformer_1.Transform)(function (_a) {
-            var value = _a.value;
-            return new Date(value);
-        }, { toClassOnly: true }),
-        __metadata("design:type", Date)
-    ], VoidInitiatedLedgerEntry.prototype, "newBlockExpiryDate", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "starting_balance" }),
-        __metadata("design:type", Object)
-    ], VoidInitiatedLedgerEntry.prototype, "startingBalance", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "void_amount" }),
-        __metadata("design:type", Object)
-    ], VoidInitiatedLedgerEntry.prototype, "voidAmount", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "void_reason" }),
-        __metadata("design:type", String)
-    ], VoidInitiatedLedgerEntry.prototype, "voidReason", void 0);
-    return VoidInitiatedLedgerEntry;
-}(utils_1.SpeakeasyBase));
-exports.VoidInitiatedLedgerEntry = VoidInitiatedLedgerEntry;

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

@@ -1,29 +0,0 @@
-import { SpeakeasyBase } from "../../../internal/utils";
-import { AffectedBlock } from "./affectedblock";
-import { CustomerMinified } from "./customerminified";
-export declare enum VoidLedgerEntryEntryStatus {
-    Committed = "committed",
-    Pending = "pending"
-}
-export declare enum VoidLedgerEntryEntryType {
-    Void = "void"
-}
-/**
- * The [Credit Ledger Entry resource](/guides/product-catalog/prepurchase) models prepaid credits within Orb.
- */
-export declare class VoidLedgerEntry extends SpeakeasyBase {
-    amount: any;
-    createdAt: Date;
-    creditBlock: AffectedBlock;
-    customer: CustomerMinified;
-    description: string;
-    endingBalance: any;
-    entryStatus: VoidLedgerEntryEntryStatus;
-    entryType: VoidLedgerEntryEntryType;
-    id: string;
-    ledgerSequenceNumber: number;
-    metadata: Record<string, string>;
-    startingBalance: any;
-    voidAmount: any;
-    voidReason: string;
-}

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

@@ -1,130 +0,0 @@
-"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.VoidLedgerEntry = exports.VoidLedgerEntryEntryType = exports.VoidLedgerEntryEntryStatus = void 0;
-var utils_1 = require("../../../internal/utils");
-var affectedblock_1 = require("./affectedblock");
-var customerminified_1 = require("./customerminified");
-var class_transformer_1 = require("class-transformer");
-var VoidLedgerEntryEntryStatus;
-(function (VoidLedgerEntryEntryStatus) {
-    VoidLedgerEntryEntryStatus["Committed"] = "committed";
-    VoidLedgerEntryEntryStatus["Pending"] = "pending";
-})(VoidLedgerEntryEntryStatus = exports.VoidLedgerEntryEntryStatus || (exports.VoidLedgerEntryEntryStatus = {}));
-var VoidLedgerEntryEntryType;
-(function (VoidLedgerEntryEntryType) {
-    VoidLedgerEntryEntryType["Void"] = "void";
-})(VoidLedgerEntryEntryType = exports.VoidLedgerEntryEntryType || (exports.VoidLedgerEntryEntryType = {}));
-/**
- * The [Credit Ledger Entry resource](/guides/product-catalog/prepurchase) models prepaid credits within Orb.
- */
-var VoidLedgerEntry = /** @class */ (function (_super) {
-    __extends(VoidLedgerEntry, _super);
-    function VoidLedgerEntry() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "amount" }),
-        __metadata("design:type", Object)
-    ], VoidLedgerEntry.prototype, "amount", 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)
-    ], VoidLedgerEntry.prototype, "createdAt", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "credit_block" }),
-        (0, class_transformer_1.Type)(function () { return affectedblock_1.AffectedBlock; }),
-        __metadata("design:type", affectedblock_1.AffectedBlock)
-    ], VoidLedgerEntry.prototype, "creditBlock", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "customer" }),
-        (0, class_transformer_1.Type)(function () { return customerminified_1.CustomerMinified; }),
-        __metadata("design:type", customerminified_1.CustomerMinified)
-    ], VoidLedgerEntry.prototype, "customer", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "description" }),
-        __metadata("design:type", String)
-    ], VoidLedgerEntry.prototype, "description", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "ending_balance" }),
-        __metadata("design:type", Object)
-    ], VoidLedgerEntry.prototype, "endingBalance", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "entry_status" }),
-        __metadata("design:type", String)
-    ], VoidLedgerEntry.prototype, "entryStatus", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "entry_type" }),
-        __metadata("design:type", String)
-    ], VoidLedgerEntry.prototype, "entryType", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "id" }),
-        __metadata("design:type", String)
-    ], VoidLedgerEntry.prototype, "id", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "ledger_sequence_number" }),
-        __metadata("design:type", Number)
-    ], VoidLedgerEntry.prototype, "ledgerSequenceNumber", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "metadata" }),
-        __metadata("design:type", Object)
-    ], VoidLedgerEntry.prototype, "metadata", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "starting_balance" }),
-        __metadata("design:type", Object)
-    ], VoidLedgerEntry.prototype, "startingBalance", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "void_amount" }),
-        __metadata("design:type", Object)
-    ], VoidLedgerEntry.prototype, "voidAmount", void 0);
-    __decorate([
-        (0, utils_1.SpeakeasyMetadata)(),
-        (0, class_transformer_1.Expose)({ name: "void_reason" }),
-        __metadata("design:type", String)
-    ], VoidLedgerEntry.prototype, "voidReason", void 0);
-    return VoidLedgerEntry;
-}(utils_1.SpeakeasyBase));
-exports.VoidLedgerEntry = VoidLedgerEntry;

package/docs/models/shared/addamendmentcreditledgerentryrequestparams.md

@@ -1,12 +0,0 @@
-# AddAmendmentCreditLedgerEntryRequestParams
-
-
-## Fields
-
-| Field                                                                                                                                                                                                                  | Type                                                                                                                                                                                                                   | Required                                                                                                                                                                                                               | Description                                                                                                                                                                                                            |
-| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `amount`                                                                                                                                                                                                               | *any*                                                                                                                                                                                                                  | :heavy_check_mark:                                                                                                                                                                                                     | The number of credits to effect. Note that this is required for increment, decrement or void operations.                                                                                                               |
-| `blockId`                                                                                                                                                                                                              | *string*                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                     | The ID of the block to reverse a decrement from.                                                                                                                                                                       |
-| `description`                                                                                                                                                                                                          | *string*                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                     | Optional metadata that can be specified when adding ledger results via the API. For example, this can be used to note an increment refers to trial credits, or for noting corrections as a result of an incident, etc. |
-| `entryType`                                                                                                                                                                                                            | [AddAmendmentCreditLedgerEntryRequestParamsEntryType](../../models/shared/addamendmentcreditledgerentryrequestparamsentrytype.md)                                                                                      | :heavy_check_mark:                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                    |
-| `metadata`                                                                                                                                                                                                             | [AddAmendmentCreditLedgerEntryRequestParamsMetadata](../../models/shared/addamendmentcreditledgerentryrequestparamsmetadata.md)                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                     | User-specified key/value pairs for the ledger entry resource.                                                                                                                                                          |

package/docs/models/shared/addamendmentcreditledgerentryrequestparamsentrytype.md

@@ -1,8 +0,0 @@
-# AddAmendmentCreditLedgerEntryRequestParamsEntryType
-
-
-## Values
-
-| Name        | Value       |
-| ----------- | ----------- |
-| `Amendment` | amendment   |

package/docs/models/shared/addamendmentcreditledgerentryrequestparamsmetadata.md

@@ -1,9 +0,0 @@
-# AddAmendmentCreditLedgerEntryRequestParamsMetadata
-
-User-specified key/value pairs for the ledger entry resource.
-
-
-## Fields
-
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/shared/adddecrementcreditledgerentryrequestparams.md

@@ -1,11 +0,0 @@
-# AddDecrementCreditLedgerEntryRequestParams
-
-
-## Fields
-
-| Field                                                                                                                                                                                                                  | Type                                                                                                                                                                                                                   | Required                                                                                                                                                                                                               | Description                                                                                                                                                                                                            |
-| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `amount`                                                                                                                                                                                                               | *any*                                                                                                                                                                                                                  | :heavy_check_mark:                                                                                                                                                                                                     | The number of credits to effect. Note that this is required for increment, decrement, void, or undo operations.                                                                                                        |
-| `description`                                                                                                                                                                                                          | *string*                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                     | Optional metadata that can be specified when adding ledger results via the API. For example, this can be used to note an increment refers to trial credits, or for noting corrections as a result of an incident, etc. |
-| `entryType`                                                                                                                                                                                                            | [AddDecrementCreditLedgerEntryRequestParamsEntryType](../../models/shared/adddecrementcreditledgerentryrequestparamsentrytype.md)                                                                                      | :heavy_check_mark:                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                    |
-| `metadata`                                                                                                                                                                                                             | [AddDecrementCreditLedgerEntryRequestParamsMetadata](../../models/shared/adddecrementcreditledgerentryrequestparamsmetadata.md)                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                     | User-specified key/value pairs for the ledger entry resource.                                                                                                                                                          |

package/docs/models/shared/adddecrementcreditledgerentryrequestparamsentrytype.md

@@ -1,8 +0,0 @@
-# AddDecrementCreditLedgerEntryRequestParamsEntryType
-
-
-## Values
-
-| Name        | Value       |
-| ----------- | ----------- |
-| `Decrement` | decrement   |

package/docs/models/shared/adddecrementcreditledgerentryrequestparamsmetadata.md

@@ -1,9 +0,0 @@
-# AddDecrementCreditLedgerEntryRequestParamsMetadata
-
-User-specified key/value pairs for the ledger entry resource.
-
-
-## Fields
-
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/shared/addexpirationchangecreditledgerentryrequestparams.md

@@ -1,14 +0,0 @@
-# AddExpirationChangeCreditLedgerEntryRequestParams
-
-
-## Fields
-
-| Field                                                                                                                                                                                                                  | Type                                                                                                                                                                                                                   | Required                                                                                                                                                                                                               | Description                                                                                                                                                                                                            |
-| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `amount`                                                                                                                                                                                                               | *any*                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                     | The number of credits to effect. Note that this is required for increment, decrement, void, or undo operations.                                                                                                        |
-| `blockId`                                                                                                                                                                                                              | *string*                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                     | The ID of the block affected by an expiration_change, used to differentiate between multiple blocks with the same `expiry_date`.                                                                                       |
-| `description`                                                                                                                                                                                                          | *string*                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                     | Optional metadata that can be specified when adding ledger results via the API. For example, this can be used to note an increment refers to trial credits, or for noting corrections as a result of an incident, etc. |
-| `entryType`                                                                                                                                                                                                            | [AddExpirationChangeCreditLedgerEntryRequestParamsEntryType](../../models/shared/addexpirationchangecreditledgerentryrequestparamsentrytype.md)                                                                        | :heavy_check_mark:                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                    |
-| `expiryDate`                                                                                                                                                                                                           | [RFCDate](../../types/rfcdate.md)                                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                                                                     | A future date (specified in YYYY-MM-DD format) that identifies the origination credit block to expire                                                                                                                  |
-| `metadata`                                                                                                                                                                                                             | [AddExpirationChangeCreditLedgerEntryRequestParamsMetadata](../../models/shared/addexpirationchangecreditledgerentryrequestparamsmetadata.md)                                                                          | :heavy_minus_sign:                                                                                                                                                                                                     | User-specified key/value pairs for the ledger entry resource.                                                                                                                                                          |
-| `targetExpiryDate`                                                                                                                                                                                                     | [RFCDate](../../types/rfcdate.md)                                                                                                                                                                                      | :heavy_check_mark:                                                                                                                                                                                                     | A future date (specified in YYYY-MM-DD format) used for expiration change, denoting when credits transferred (as part of a partial block expiration) should expire.                                                    |

package/docs/models/shared/addexpirationchangecreditledgerentryrequestparamsentrytype.md

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

package/docs/models/shared/addexpirationchangecreditledgerentryrequestparamsmetadata.md

@@ -1,9 +0,0 @@
-# AddExpirationChangeCreditLedgerEntryRequestParamsMetadata
-
-User-specified key/value pairs for the ledger entry resource.
-
-
-## Fields
-
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/shared/addincrementcreditledgerentryrequestparams.md

@@ -1,15 +0,0 @@
-# AddIncrementCreditLedgerEntryRequestParams
-
-
-## Fields
-
-| Field                                                                                                                                                                                                                            | Type                                                                                                                                                                                                                             | Required                                                                                                                                                                                                                         | Description                                                                                                                                                                                                                      |
-| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `amount`                                                                                                                                                                                                                         | *any*                                                                                                                                                                                                                            | :heavy_check_mark:                                                                                                                                                                                                               | The number of credits to effect. Note that this is required for increment, decrement, void, or undo operations.                                                                                                                  |
-| `description`                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                               | Optional metadata that can be specified when adding ledger results via the API. For example, this can be used to note an increment refers to trial credits, or for noting corrections as a result of an incident, etc.           |
-| `effectiveDate`                                                                                                                                                                                                                  | [RFCDate](../../types/rfcdate.md)                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                               | A future date (specified in YYYY-MM-DD format) that denotes when this credit balance should become available for use.                                                                                                            |
-| `entryType`                                                                                                                                                                                                                      | [AddIncrementCreditLedgerEntryRequestParamsEntryType](../../models/shared/addincrementcreditledgerentryrequestparamsentrytype.md)                                                                                                | :heavy_check_mark:                                                                                                                                                                                                               | N/A                                                                                                                                                                                                                              |
-| `expiryDate`                                                                                                                                                                                                                     | [RFCDate](../../types/rfcdate.md)                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                               | A future date (specified in YYYY-MM-DD format) that denotes when this credit balance should expire.                                                                                                                              |
-| `invoiceSettings`                                                                                                                                                                                                                | [IncrementCreditLedgerEntryInvoiceSettings](../../models/shared/incrementcreditledgerentryinvoicesettings.md)                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                               | Passing `invoice_settings` automatically generates an invoice for the newly added credits. If `invoice_settings` is passed, you must specify per_unit_cost_basis, as the calculation of the invoice total is done on that basis. |
-| `metadata`                                                                                                                                                                                                                       | [AddIncrementCreditLedgerEntryRequestParamsMetadata](../../models/shared/addincrementcreditledgerentryrequestparamsmetadata.md)                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                               | User-specified key/value pairs for the ledger entry resource.                                                                                                                                                                    |
-| `perUnitCostBasis`                                                                                                                                                                                                               | *string*                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                               | Can only be specified when entry_type=increment. How much, in USD, a customer paid for a single credit in this block                                                                                                             |

package/docs/models/shared/addincrementcreditledgerentryrequestparamsentrytype.md

@@ -1,8 +0,0 @@
-# AddIncrementCreditLedgerEntryRequestParamsEntryType
-
-
-## Values
-
-| Name        | Value       |
-| ----------- | ----------- |
-| `Increment` | increment   |

package/docs/models/shared/addincrementcreditledgerentryrequestparamsmetadata.md

@@ -1,9 +0,0 @@
-# AddIncrementCreditLedgerEntryRequestParamsMetadata
-
-User-specified key/value pairs for the ledger entry resource.
-
-
-## Fields
-
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/shared/addpriceintervalparamsenddateenddate.md

@@ -1,11 +0,0 @@
-# AddPriceIntervalParamsEndDateEndDate
-
-The end date of the price interval. This is the date that the price will stop billing on the subscription.
-
-
-## Values
-
-| Name          | Value         |
-| ------------- | ------------- |
-| `StartOfTerm` | start_of_term |
-| `EndOfTerm`   | end_of_term   |