orb-billing 1.19.2 → 1.19.5

package/dist/internal/utils/utils.js

@@ -104,7 +104,7 @@ var SpeakeasyBase = /** @class */ (function () {
                     var prop = props_1_1.value;
                     if (payload && payload.hasOwnProperty(prop.key)) {
                         var value = payload[prop.key];
-                        if (isSpeakeasyBase(prop.type)) {
+                        if (isSpeakeasyBase(prop.type) && value != null) {
                             this[prop.key] = new prop.type(value);
                         }
                         else if (prop.type.name == "Array" &&

package/dist/sdk/credit.d.ts

@@ -9,10 +9,192 @@ export declare class Credit {
     constructor(sdkConfig: SDKConfiguration);
     /**
      * Create ledger entry by external ID
+     *
+     * @remarks
+     * This endpoint allows you to create a new ledger entry for a specified customer's balance. This can be used to
+     * increment balance, deduct credits, and change the expiry date of existing credits.
+     *
+     * ## Effects of adding a ledger entry
+     * 1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) will return a credit block that
+     *   represents the changes (i.e. balance changes or transfers).
+     * 2. A ledger entry will be added to the credits ledger for this customer, and therefore returned in the
+     *   [View Credits Ledger](fetch-customer-credits) response as well as serialized in the response to this request. In
+     *   the case of deductions without a specified block, multiple ledger entries may be created if the deduction spans
+     *   credit blocks.
+     * 3. If `invoice_settings` is specified, an invoice will be created that reflects the cost of the credits (based on
+     *   `amount` and `per_unit_cost_basis`).
+     *
+     * ## Adding credits
+     *   Adding credits is done by creating an entry of type `increment`. This requires the caller to specify a number of
+     *   credits as well as an optional expiry date in `YYYY-MM-DD` format. Orb also recommends specifying a description
+     *   to assist with auditing. When adding credits, the caller can also specify a cost basis per-credit, to indicate
+     *   how much in USD a customer paid for a single credit in a block. This can later be used for revenue recognition.
+     *
+     * The following snippet illustrates a sample request body to increment credits which will expire in January of 2022.
+     *
+     * ```json
+     * {
+     *   "entry_type": "increment",
+     *   "amount": 100,
+     *   "expiry_date": "2022-12-28",
+     *   "per_unit_cost_basis": "0.20",
+     *   "description": "Purchased 100 credits"
+     * }
+     * ```
+     *
+     * Note that by default, Orb will always first increment any _negative_ balance in existing blocks before adding the
+     * remaining amount to the desired credit block.
+     *
+     * ### Invoicing for credits
+     * By default, Orb manipulates the credit ledger but does not charge for credits. However, if you pass
+     * `invoice_settings` in the body of this request, Orb will also generate a one-off invoice for the customer for the
+     * credits pre-purchase. Note that you _must_ provide the `per_unit_cost_basis`, since the total charges on the
+     * invoice are calculated by multiplying the cost basis with the number of credit units added.
+     *
+     * ## Deducting Credits
+     * Orb allows you to deduct credits from a customer by creating an entry of type `decrement`. Orb matches the
+     * algorithm for automatic deductions for determining which credit blocks to decrement from. In the case that the
+     * deduction leads to multiple ledger entries, the response from this endpoint will be the final deduction. Orb also
+     * optionally allows specifying a description to assist with auditing.
+     *
+     * The following snippet illustrates a sample request body to decrement credits.
+     *
+     * ```json
+     * {
+     *   "entry_type": "decrement",
+     *   "amount": 20,
+     *   "description": "Removing excess credits"
+     * }
+     * ```
+     *
+     * ## Changing credits expiry
+     * If you'd like to change when existing credits expire, you should create a ledger entry of type `expiration_change`.
+     * For this entry, the required parameter `expiry_date` identifies the _originating_ block, and the required parameter
+     * `target_expiry_date` identifies when the transferred credits should now expire. A new credit block will be created
+     * with expiry date `target_expiry_date`, with the same cost basis data as the original credit block, if present.
+     *
+     * Note that the balance of the block with the given `expiry_date` must be at least equal to the desired transfer
+     * amount determined by the `amount` parameter.
+     *
+     * The following snippet illustrates a sample request body to extend the expiration date of credits by one year:
+     *
+     * ```json
+     * {
+     *   "entry_type": "expiration_change",
+     *   "amount": 10,
+     *   "expiry_date": "2022-12-28",
+     *   "block_id": "UiUhFWeLHPrBY4Ad",
+     *   "target_expiry_date": "2023-12-28",
+     *   "description": "Extending credit validity"
+     * }
+     * ```
+     *
+     * ## Voiding credits
+     *
+     * If you'd like to void a credit block, create a ledger entry of type `void`. For this entry, `block_id` is required
+     * to identify the block, and `amount` indicates how many credits to void, up to the block's initial balance. Pass
+     * in a `void_reason` of `refund` if the void is due to a refund.
+     *
+     * ## Amendment
+     *
+     * If you'd like to undo a decrement on a credit block, create a ledger entry of type `amendment`. For this entry, `block_id`
+     * is required to identify the block that was originally decremented from, and `amount` indicates how many credits to return
+     * to the customer, up to the block's initial balance.
      */
     addByExternalId(req: operations.CreateLedgerEntryExternalIdRequest, config?: AxiosRequestConfig): Promise<operations.CreateLedgerEntryExternalIdResponse>;
     /**
      * Create ledger entry
+     *
+     * @remarks
+     * This endpoint allows you to create a new ledger entry for a specified customer's balance. This can be used to
+     * increment balance, deduct credits, and change the expiry date of existing credits.
+     *
+     * ## Effects of adding a ledger entry
+     * 1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) will return a credit block that
+     *   represents the changes (i.e. balance changes or transfers).
+     * 2. A ledger entry will be added to the credits ledger for this customer, and therefore returned in the
+     *   [View Credits Ledger](fetch-customer-credits) response as well as serialized in the response to this request. In
+     *   the case of deductions without a specified block, multiple ledger entries may be created if the deduction spans
+     *   credit blocks.
+     * 3. If `invoice_settings` is specified, an invoice will be created that reflects the cost of the credits (based on
+     *   `amount` and `per_unit_cost_basis`).
+     *
+     * ## Adding credits
+     *   Adding credits is done by creating an entry of type `increment`. This requires the caller to specify a number of
+     *   credits as well as an optional expiry date in `YYYY-MM-DD` format. Orb also recommends specifying a description
+     *   to assist with auditing. When adding credits, the caller can also specify a cost basis per-credit, to indicate
+     *   how much in USD a customer paid for a single credit in a block. This can later be used for revenue recognition.
+     *
+     * The following snippet illustrates a sample request body to increment credits which will expire in January of 2022.
+     *
+     * ```json
+     * {
+     *   "entry_type": "increment",
+     *   "amount": 100,
+     *   "expiry_date": "2022-12-28",
+     *   "per_unit_cost_basis": "0.20",
+     *   "description": "Purchased 100 credits"
+     * }
+     * ```
+     *
+     * Note that by default, Orb will always first increment any _negative_ balance in existing blocks before adding the
+     * remaining amount to the desired credit block.
+     *
+     * ### Invoicing for credits
+     * By default, Orb manipulates the credit ledger but does not charge for credits. However, if you pass
+     * `invoice_settings` in the body of this request, Orb will also generate a one-off invoice for the customer for the
+     * credits pre-purchase. Note that you _must_ provide the `per_unit_cost_basis`, since the total charges on the
+     * invoice are calculated by multiplying the cost basis with the number of credit units added.
+     *
+     * ## Deducting Credits
+     * Orb allows you to deduct credits from a customer by creating an entry of type `decrement`. Orb matches the
+     * algorithm for automatic deductions for determining which credit blocks to decrement from. In the case that the
+     * deduction leads to multiple ledger entries, the response from this endpoint will be the final deduction. Orb also
+     * optionally allows specifying a description to assist with auditing.
+     *
+     * The following snippet illustrates a sample request body to decrement credits.
+     *
+     * ```json
+     * {
+     *   "entry_type": "decrement",
+     *   "amount": 20,
+     *   "description": "Removing excess credits"
+     * }
+     * ```
+     *
+     * ## Changing credits expiry
+     * If you'd like to change when existing credits expire, you should create a ledger entry of type `expiration_change`.
+     * For this entry, the required parameter `expiry_date` identifies the _originating_ block, and the required parameter
+     * `target_expiry_date` identifies when the transferred credits should now expire. A new credit block will be created
+     * with expiry date `target_expiry_date`, with the same cost basis data as the original credit block, if present.
+     *
+     * Note that the balance of the block with the given `expiry_date` must be at least equal to the desired transfer
+     * amount determined by the `amount` parameter.
+     *
+     * The following snippet illustrates a sample request body to extend the expiration date of credits by one year:
+     *
+     * ```json
+     * {
+     *   "entry_type": "expiration_change",
+     *   "amount": 10,
+     *   "expiry_date": "2022-12-28",
+     *   "block_id": "UiUhFWeLHPrBY4Ad",
+     *   "target_expiry_date": "2023-12-28",
+     *   "description": "Extending credit validity"
+     * }
+     * ```
+     *
+     * ## Voiding credits
+     *
+     * If you'd like to void a credit block, create a ledger entry of type `void`. For this entry, `block_id` is required
+     * to identify the block, and `amount` indicates how many credits to void, up to the block's initial balance. Pass
+     * in a `void_reason` of `refund` if the void is due to a refund.
+     *
+     * ## Amendment
+     *
+     * If you'd like to undo a decrement on a credit block, create a ledger entry of type `amendment`. For this entry, `block_id`
+     * is required to identify the block that was originally decremented from, and `amount` indicates how many credits to return
+     * to the customer, up to the block's initial balance.
      */
     create(req: operations.CreateLedgerEntryRequest, config?: AxiosRequestConfig): Promise<operations.CreateLedgerEntryResponse>;
     /**

package/dist/sdk/credit.js

@@ -103,6 +103,97 @@ var Credit = /** @class */ (function () {
     }
     /**
      * Create ledger entry by external ID
+     *
+     * @remarks
+     * This endpoint allows you to create a new ledger entry for a specified customer's balance. This can be used to
+     * increment balance, deduct credits, and change the expiry date of existing credits.
+     *
+     * ## Effects of adding a ledger entry
+     * 1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) will return a credit block that
+     *   represents the changes (i.e. balance changes or transfers).
+     * 2. A ledger entry will be added to the credits ledger for this customer, and therefore returned in the
+     *   [View Credits Ledger](fetch-customer-credits) response as well as serialized in the response to this request. In
+     *   the case of deductions without a specified block, multiple ledger entries may be created if the deduction spans
+     *   credit blocks.
+     * 3. If `invoice_settings` is specified, an invoice will be created that reflects the cost of the credits (based on
+     *   `amount` and `per_unit_cost_basis`).
+     *
+     * ## Adding credits
+     *   Adding credits is done by creating an entry of type `increment`. This requires the caller to specify a number of
+     *   credits as well as an optional expiry date in `YYYY-MM-DD` format. Orb also recommends specifying a description
+     *   to assist with auditing. When adding credits, the caller can also specify a cost basis per-credit, to indicate
+     *   how much in USD a customer paid for a single credit in a block. This can later be used for revenue recognition.
+     *
+     * The following snippet illustrates a sample request body to increment credits which will expire in January of 2022.
+     *
+     * ```json
+     * {
+     *   "entry_type": "increment",
+     *   "amount": 100,
+     *   "expiry_date": "2022-12-28",
+     *   "per_unit_cost_basis": "0.20",
+     *   "description": "Purchased 100 credits"
+     * }
+     * ```
+     *
+     * Note that by default, Orb will always first increment any _negative_ balance in existing blocks before adding the
+     * remaining amount to the desired credit block.
+     *
+     * ### Invoicing for credits
+     * By default, Orb manipulates the credit ledger but does not charge for credits. However, if you pass
+     * `invoice_settings` in the body of this request, Orb will also generate a one-off invoice for the customer for the
+     * credits pre-purchase. Note that you _must_ provide the `per_unit_cost_basis`, since the total charges on the
+     * invoice are calculated by multiplying the cost basis with the number of credit units added.
+     *
+     * ## Deducting Credits
+     * Orb allows you to deduct credits from a customer by creating an entry of type `decrement`. Orb matches the
+     * algorithm for automatic deductions for determining which credit blocks to decrement from. In the case that the
+     * deduction leads to multiple ledger entries, the response from this endpoint will be the final deduction. Orb also
+     * optionally allows specifying a description to assist with auditing.
+     *
+     * The following snippet illustrates a sample request body to decrement credits.
+     *
+     * ```json
+     * {
+     *   "entry_type": "decrement",
+     *   "amount": 20,
+     *   "description": "Removing excess credits"
+     * }
+     * ```
+     *
+     * ## Changing credits expiry
+     * If you'd like to change when existing credits expire, you should create a ledger entry of type `expiration_change`.
+     * For this entry, the required parameter `expiry_date` identifies the _originating_ block, and the required parameter
+     * `target_expiry_date` identifies when the transferred credits should now expire. A new credit block will be created
+     * with expiry date `target_expiry_date`, with the same cost basis data as the original credit block, if present.
+     *
+     * Note that the balance of the block with the given `expiry_date` must be at least equal to the desired transfer
+     * amount determined by the `amount` parameter.
+     *
+     * The following snippet illustrates a sample request body to extend the expiration date of credits by one year:
+     *
+     * ```json
+     * {
+     *   "entry_type": "expiration_change",
+     *   "amount": 10,
+     *   "expiry_date": "2022-12-28",
+     *   "block_id": "UiUhFWeLHPrBY4Ad",
+     *   "target_expiry_date": "2023-12-28",
+     *   "description": "Extending credit validity"
+     * }
+     * ```
+     *
+     * ## Voiding credits
+     *
+     * If you'd like to void a credit block, create a ledger entry of type `void`. For this entry, `block_id` is required
+     * to identify the block, and `amount` indicates how many credits to void, up to the block's initial balance. Pass
+     * in a `void_reason` of `refund` if the void is due to a refund.
+     *
+     * ## Amendment
+     *
+     * If you'd like to undo a decrement on a credit block, create a ledger entry of type `amendment`. For this entry, `block_id`
+     * is required to identify the block that was originally decremented from, and `amount` indicates how many credits to return
+     * to the customer, up to the block's initial balance.
      */
     Credit.prototype.addByExternalId = function (req, config) {
         var _a, _b;
@@ -227,6 +318,97 @@ var Credit = /** @class */ (function () {
     };
     /**
      * Create ledger entry
+     *
+     * @remarks
+     * This endpoint allows you to create a new ledger entry for a specified customer's balance. This can be used to
+     * increment balance, deduct credits, and change the expiry date of existing credits.
+     *
+     * ## Effects of adding a ledger entry
+     * 1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) will return a credit block that
+     *   represents the changes (i.e. balance changes or transfers).
+     * 2. A ledger entry will be added to the credits ledger for this customer, and therefore returned in the
+     *   [View Credits Ledger](fetch-customer-credits) response as well as serialized in the response to this request. In
+     *   the case of deductions without a specified block, multiple ledger entries may be created if the deduction spans
+     *   credit blocks.
+     * 3. If `invoice_settings` is specified, an invoice will be created that reflects the cost of the credits (based on
+     *   `amount` and `per_unit_cost_basis`).
+     *
+     * ## Adding credits
+     *   Adding credits is done by creating an entry of type `increment`. This requires the caller to specify a number of
+     *   credits as well as an optional expiry date in `YYYY-MM-DD` format. Orb also recommends specifying a description
+     *   to assist with auditing. When adding credits, the caller can also specify a cost basis per-credit, to indicate
+     *   how much in USD a customer paid for a single credit in a block. This can later be used for revenue recognition.
+     *
+     * The following snippet illustrates a sample request body to increment credits which will expire in January of 2022.
+     *
+     * ```json
+     * {
+     *   "entry_type": "increment",
+     *   "amount": 100,
+     *   "expiry_date": "2022-12-28",
+     *   "per_unit_cost_basis": "0.20",
+     *   "description": "Purchased 100 credits"
+     * }
+     * ```
+     *
+     * Note that by default, Orb will always first increment any _negative_ balance in existing blocks before adding the
+     * remaining amount to the desired credit block.
+     *
+     * ### Invoicing for credits
+     * By default, Orb manipulates the credit ledger but does not charge for credits. However, if you pass
+     * `invoice_settings` in the body of this request, Orb will also generate a one-off invoice for the customer for the
+     * credits pre-purchase. Note that you _must_ provide the `per_unit_cost_basis`, since the total charges on the
+     * invoice are calculated by multiplying the cost basis with the number of credit units added.
+     *
+     * ## Deducting Credits
+     * Orb allows you to deduct credits from a customer by creating an entry of type `decrement`. Orb matches the
+     * algorithm for automatic deductions for determining which credit blocks to decrement from. In the case that the
+     * deduction leads to multiple ledger entries, the response from this endpoint will be the final deduction. Orb also
+     * optionally allows specifying a description to assist with auditing.
+     *
+     * The following snippet illustrates a sample request body to decrement credits.
+     *
+     * ```json
+     * {
+     *   "entry_type": "decrement",
+     *   "amount": 20,
+     *   "description": "Removing excess credits"
+     * }
+     * ```
+     *
+     * ## Changing credits expiry
+     * If you'd like to change when existing credits expire, you should create a ledger entry of type `expiration_change`.
+     * For this entry, the required parameter `expiry_date` identifies the _originating_ block, and the required parameter
+     * `target_expiry_date` identifies when the transferred credits should now expire. A new credit block will be created
+     * with expiry date `target_expiry_date`, with the same cost basis data as the original credit block, if present.
+     *
+     * Note that the balance of the block with the given `expiry_date` must be at least equal to the desired transfer
+     * amount determined by the `amount` parameter.
+     *
+     * The following snippet illustrates a sample request body to extend the expiration date of credits by one year:
+     *
+     * ```json
+     * {
+     *   "entry_type": "expiration_change",
+     *   "amount": 10,
+     *   "expiry_date": "2022-12-28",
+     *   "block_id": "UiUhFWeLHPrBY4Ad",
+     *   "target_expiry_date": "2023-12-28",
+     *   "description": "Extending credit validity"
+     * }
+     * ```
+     *
+     * ## Voiding credits
+     *
+     * If you'd like to void a credit block, create a ledger entry of type `void`. For this entry, `block_id` is required
+     * to identify the block, and `amount` indicates how many credits to void, up to the block's initial balance. Pass
+     * in a `void_reason` of `refund` if the void is due to a refund.
+     *
+     * ## Amendment
+     *
+     * If you'd like to undo a decrement on a credit block, create a ledger entry of type `amendment`. For this entry, `block_id`
+     * is required to identify the block that was originally decremented from, and `amount` indicates how many credits to return
+     * to the customer, up to the block's initial balance.
      */
     Credit.prototype.create = function (req, config) {
         var _a, _b;

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

@@ -0,0 +1,28 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+export declare enum AddAmendmentCreditLedgerEntryRequestParamsEntryType {
+    Amendment = "amendment"
+}
+/**
+ * User-specified key/value pairs for the ledger entry resource.
+ */
+export declare class AddAmendmentCreditLedgerEntryRequestParamsMetadata extends SpeakeasyBase {
+}
+export declare class AddAmendmentCreditLedgerEntryRequestParams extends SpeakeasyBase {
+    /**
+     * The number of credits to effect. Note that this is required for increment, decrement or void operations.
+     */
+    amount: any;
+    /**
+     * The ID of the block to reverse a decrement from.
+     */
+    blockId: string;
+    /**
+     * 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.
+     */
+    description?: string;
+    entryType: AddAmendmentCreditLedgerEntryRequestParamsEntryType;
+    /**
+     * User-specified key/value pairs for the ledger entry resource.
+     */
+    metadata?: AddAmendmentCreditLedgerEntryRequestParamsMetadata;
+}

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

@@ -0,0 +1,81 @@
+"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.AddAmendmentCreditLedgerEntryRequestParams = exports.AddAmendmentCreditLedgerEntryRequestParamsMetadata = exports.AddAmendmentCreditLedgerEntryRequestParamsEntryType = void 0;
+var utils_1 = require("../../../internal/utils");
+var class_transformer_1 = require("class-transformer");
+var AddAmendmentCreditLedgerEntryRequestParamsEntryType;
+(function (AddAmendmentCreditLedgerEntryRequestParamsEntryType) {
+    AddAmendmentCreditLedgerEntryRequestParamsEntryType["Amendment"] = "amendment";
+})(AddAmendmentCreditLedgerEntryRequestParamsEntryType = exports.AddAmendmentCreditLedgerEntryRequestParamsEntryType || (exports.AddAmendmentCreditLedgerEntryRequestParamsEntryType = {}));
+/**
+ * User-specified key/value pairs for the ledger entry resource.
+ */
+var AddAmendmentCreditLedgerEntryRequestParamsMetadata = /** @class */ (function (_super) {
+    __extends(AddAmendmentCreditLedgerEntryRequestParamsMetadata, _super);
+    function AddAmendmentCreditLedgerEntryRequestParamsMetadata() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return AddAmendmentCreditLedgerEntryRequestParamsMetadata;
+}(utils_1.SpeakeasyBase));
+exports.AddAmendmentCreditLedgerEntryRequestParamsMetadata = AddAmendmentCreditLedgerEntryRequestParamsMetadata;
+var AddAmendmentCreditLedgerEntryRequestParams = /** @class */ (function (_super) {
+    __extends(AddAmendmentCreditLedgerEntryRequestParams, _super);
+    function AddAmendmentCreditLedgerEntryRequestParams() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "amount" }),
+        __metadata("design:type", Object)
+    ], AddAmendmentCreditLedgerEntryRequestParams.prototype, "amount", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "block_id" }),
+        __metadata("design:type", String)
+    ], AddAmendmentCreditLedgerEntryRequestParams.prototype, "blockId", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "description" }),
+        __metadata("design:type", String)
+    ], AddAmendmentCreditLedgerEntryRequestParams.prototype, "description", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "entry_type" }),
+        __metadata("design:type", String)
+    ], AddAmendmentCreditLedgerEntryRequestParams.prototype, "entryType", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "metadata" }),
+        (0, class_transformer_1.Type)(function () { return AddAmendmentCreditLedgerEntryRequestParamsMetadata; }),
+        __metadata("design:type", AddAmendmentCreditLedgerEntryRequestParamsMetadata)
+    ], AddAmendmentCreditLedgerEntryRequestParams.prototype, "metadata", void 0);
+    return AddAmendmentCreditLedgerEntryRequestParams;
+}(utils_1.SpeakeasyBase));
+exports.AddAmendmentCreditLedgerEntryRequestParams = AddAmendmentCreditLedgerEntryRequestParams;

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

@@ -9,7 +9,7 @@ export declare class AddDecrementCreditLedgerEntryRequestParamsMetadata extends
 }
 export declare class AddDecrementCreditLedgerEntryRequestParams extends SpeakeasyBase {
     /**
-     * The number of credits to effect. Note that this is required for increment, decrement or void operations.
+     * The number of credits to effect. Note that this is required for increment, decrement, void, or undo operations.
      */
     amount: any;
     /**

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

@@ -10,7 +10,7 @@ export declare class AddExpirationChangeCreditLedgerEntryRequestParamsMetadata e
 }
 export declare class AddExpirationChangeCreditLedgerEntryRequestParams extends SpeakeasyBase {
     /**
-     * The number of credits to effect. Note that this is required for increment, decrement or void operations.
+     * The number of credits to effect. Note that this is required for increment, decrement, void, or undo operations.
      */
     amount?: any;
     /**

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

@@ -74,6 +74,7 @@ var AddExpirationChangeCreditLedgerEntryRequestParams = /** @class */ (function
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "expiry_date" }),
+        (0, class_transformer_1.Type)(function () { return String; }),
         (0, class_transformer_1.Transform)(function (_a) {
             var value = _a.value;
             return new types_1.RFCDate(value);
@@ -89,6 +90,7 @@ var AddExpirationChangeCreditLedgerEntryRequestParams = /** @class */ (function
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "target_expiry_date" }),
+        (0, class_transformer_1.Type)(function () { return String; }),
         (0, class_transformer_1.Transform)(function (_a) {
             var value = _a.value;
             return new types_1.RFCDate(value);

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

@@ -11,7 +11,7 @@ export declare class AddIncrementCreditLedgerEntryRequestParamsMetadata extends
 }
 export declare class AddIncrementCreditLedgerEntryRequestParams extends SpeakeasyBase {
     /**
-     * The number of credits to effect. Note that this is required for increment, decrement or void operations.
+     * The number of credits to effect. Note that this is required for increment, decrement, void, or undo operations.
      */
     amount: any;
     /**

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

@@ -65,6 +65,7 @@ var AddIncrementCreditLedgerEntryRequestParams = /** @class */ (function (_super
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "effective_date" }),
+        (0, class_transformer_1.Type)(function () { return String; }),
         (0, class_transformer_1.Transform)(function (_a) {
             var value = _a.value;
             return new types_1.RFCDate(value);
@@ -79,6 +80,7 @@ var AddIncrementCreditLedgerEntryRequestParams = /** @class */ (function (_super
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "expiry_date" }),
+        (0, class_transformer_1.Type)(function () { return String; }),
         (0, class_transformer_1.Transform)(function (_a) {
             var value = _a.value;
             return new types_1.RFCDate(value);

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

@@ -14,6 +14,10 @@ export declare enum AddVoidCreditLedgerEntryRequestParamsVoidReason {
     Refund = "refund"
 }
 export declare class AddVoidCreditLedgerEntryRequestParams extends SpeakeasyBase {
+    /**
+     * The number of credits to effect. Note that this is required for increment, decrement, void, or undo operations.
+     */
+    amount: any;
     /**
      * The ID of the block to void.
      */

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

@@ -57,6 +57,11 @@ var AddVoidCreditLedgerEntryRequestParams = /** @class */ (function (_super) {
     function AddVoidCreditLedgerEntryRequestParams() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "amount" }),
+        __metadata("design:type", Object)
+    ], AddVoidCreditLedgerEntryRequestParams.prototype, "amount", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "block_id" }),

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

@@ -44,6 +44,7 @@ var CreateInvoiceLineItemParams = /** @class */ (function (_super) {
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "end_date" }),
+        (0, class_transformer_1.Type)(function () { return String; }),
         (0, class_transformer_1.Transform)(function (_a) {
             var value = _a.value;
             return new types_1.RFCDate(value);
@@ -68,6 +69,7 @@ var CreateInvoiceLineItemParams = /** @class */ (function (_super) {
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "start_date" }),
+        (0, class_transformer_1.Type)(function () { return String; }),
         (0, class_transformer_1.Transform)(function (_a) {
             var value = _a.value;
             return new types_1.RFCDate(value);

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

@@ -53,6 +53,7 @@ var FixedFeeQuantityChange = /** @class */ (function (_super) {
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "effective_date" }),
+        (0, class_transformer_1.Type)(function () { return String; }),
         (0, class_transformer_1.Transform)(function (_a) {
             var value = _a.value;
             return new types_1.RFCDate(value);

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

@@ -1,6 +1,7 @@
 export * from "./accountingprovider";
 export * from "./accountingproviderconfig";
 export * from "./accountingsyncconfiguration";
+export * from "./addamendmentcreditledgerentryrequestparams";
 export * from "./adddecrementcreditledgerentryrequestparams";
 export * from "./addeditpriceintervalparams";
 export * from "./addexpirationchangecreditledgerentryrequestparams";

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

@@ -20,6 +20,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./accountingprovider"), exports);
 __exportStar(require("./accountingproviderconfig"), exports);
 __exportStar(require("./accountingsyncconfiguration"), exports);
+__exportStar(require("./addamendmentcreditledgerentryrequestparams"), exports);
 __exportStar(require("./adddecrementcreditledgerentryrequestparams"), exports);
 __exportStar(require("./addeditpriceintervalparams"), exports);
 __exportStar(require("./addexpirationchangecreditledgerentryrequestparams"), exports);

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

@@ -44,6 +44,7 @@ var InvoiceLineItemParams = /** @class */ (function (_super) {
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "end_date" }),
+        (0, class_transformer_1.Type)(function () { return String; }),
         (0, class_transformer_1.Transform)(function (_a) {
             var value = _a.value;
             return new types_1.RFCDate(value);
@@ -73,6 +74,7 @@ var InvoiceLineItemParams = /** @class */ (function (_super) {
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "start_date" }),
+        (0, class_transformer_1.Type)(function () { return String; }),
         (0, class_transformer_1.Transform)(function (_a) {
             var value = _a.value;
             return new types_1.RFCDate(value);

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

@@ -49,6 +49,7 @@ var MarkAsPaidRequestParams = /** @class */ (function (_super) {
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "payment_received_date" }),
+        (0, class_transformer_1.Type)(function () { return String; }),
         (0, class_transformer_1.Transform)(function (_a) {
             var value = _a.value;
             return new types_1.RFCDate(value);

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

@@ -39,6 +39,7 @@ var TriggerSubscriptionPhaseParams = /** @class */ (function (_super) {
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "effective_date" }),
+        (0, class_transformer_1.Type)(function () { return String; }),
         (0, class_transformer_1.Transform)(function (_a) {
             var value = _a.value;
             return new types_1.RFCDate(value);

package/dist/sdk/sdk.js

@@ -34,9 +34,9 @@ var SDKConfiguration = /** @class */ (function () {
     function SDKConfiguration(init) {
         this.language = "typescript";
         this.openapiDocVersion = "1.0";
-        this.sdkVersion = "1.19.2";
-        this.genVersion = "2.143.2";
-        this.userAgent = "speakeasy-sdk/typescript 1.19.2 2.143.2 1.0 orb-billing";
+        this.sdkVersion = "1.19.5";
+        this.genVersion = "2.147.0";
+        this.userAgent = "speakeasy-sdk/typescript 1.19.5 2.147.0 1.0 orb-billing";
         Object.assign(this, init);
     }
     return SDKConfiguration;

package/docs/models/shared/addamendmentcreditledgerentryrequestparams.md

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

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

package/docs/models/shared/addamendmentcreditledgerentryrequestparamsmetadata.md

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

package/docs/models/shared/adddecrementcreditledgerentryrequestparams.md

@@ -5,7 +5,7 @@
 
 | 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.                                                                                                               |
+| `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/addexpirationchangecreditledgerentryrequestparams.md

@@ -5,7 +5,7 @@
 
 | Field                                                                                                                                                                                                                  | Type                                                                                                                                                                                                                   | Required                                                                                                                                                                                                               | Description                                                                                                                                                                                                            |
 | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `amount`                                                                                                                                                                                                               | *any*                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                     | The number of credits to effect. Note that this is required for increment, decrement or void operations.                                                                                                               |
+| `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                                                                                                                                                                                                                    |

package/docs/models/shared/addincrementcreditledgerentryrequestparams.md

@@ -5,7 +5,7 @@
 
 | 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.                                                                                                                         |
+| `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                                                                                                                                                                                                                              |

package/docs/models/shared/addvoidcreditledgerentryrequestparams.md

@@ -5,6 +5,7 @@
 
 | 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.                                                                                                        |
 | `blockId`                                                                                                                                                                                                              | *string*                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                     | The ID of the block to void.                                                                                                                                                                                           |
 | `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`                                                                                                                                                                                                            | [AddVoidCreditLedgerEntryRequestParamsEntryType](../../models/shared/addvoidcreditledgerentryrequestparamsentrytype.md)                                                                                                | :heavy_check_mark:                                                                                                                                                                                                     | N/A                                                                                                                                                                                                                    |

package/docs/sdks/credit/README.md

@@ -16,7 +16,95 @@ The [Credit Ledger Entry resource](/guides/product-catalog/prepurchase) models p
 
 ## addByExternalId
 
-Create ledger entry by external ID
+This endpoint allows you to create a new ledger entry for a specified customer's balance. This can be used to
+increment balance, deduct credits, and change the expiry date of existing credits.
+
+## Effects of adding a ledger entry
+1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) will return a credit block that
+  represents the changes (i.e. balance changes or transfers).
+2. A ledger entry will be added to the credits ledger for this customer, and therefore returned in the
+  [View Credits Ledger](fetch-customer-credits) response as well as serialized in the response to this request. In
+  the case of deductions without a specified block, multiple ledger entries may be created if the deduction spans
+  credit blocks.
+3. If `invoice_settings` is specified, an invoice will be created that reflects the cost of the credits (based on
+  `amount` and `per_unit_cost_basis`).
+
+## Adding credits
+  Adding credits is done by creating an entry of type `increment`. This requires the caller to specify a number of
+  credits as well as an optional expiry date in `YYYY-MM-DD` format. Orb also recommends specifying a description
+  to assist with auditing. When adding credits, the caller can also specify a cost basis per-credit, to indicate
+  how much in USD a customer paid for a single credit in a block. This can later be used for revenue recognition.
+
+The following snippet illustrates a sample request body to increment credits which will expire in January of 2022.
+
+```json
+{
+  "entry_type": "increment",
+  "amount": 100,
+  "expiry_date": "2022-12-28",
+  "per_unit_cost_basis": "0.20",
+  "description": "Purchased 100 credits"
+}
+```
+
+Note that by default, Orb will always first increment any _negative_ balance in existing blocks before adding the
+remaining amount to the desired credit block.
+
+### Invoicing for credits
+By default, Orb manipulates the credit ledger but does not charge for credits. However, if you pass
+`invoice_settings` in the body of this request, Orb will also generate a one-off invoice for the customer for the
+credits pre-purchase. Note that you _must_ provide the `per_unit_cost_basis`, since the total charges on the
+invoice are calculated by multiplying the cost basis with the number of credit units added.
+
+## Deducting Credits
+Orb allows you to deduct credits from a customer by creating an entry of type `decrement`. Orb matches the
+algorithm for automatic deductions for determining which credit blocks to decrement from. In the case that the
+deduction leads to multiple ledger entries, the response from this endpoint will be the final deduction. Orb also
+optionally allows specifying a description to assist with auditing.
+
+The following snippet illustrates a sample request body to decrement credits.
+
+```json
+{
+  "entry_type": "decrement",
+  "amount": 20,
+  "description": "Removing excess credits"
+}
+```
+
+## Changing credits expiry
+If you'd like to change when existing credits expire, you should create a ledger entry of type `expiration_change`.
+For this entry, the required parameter `expiry_date` identifies the _originating_ block, and the required parameter
+`target_expiry_date` identifies when the transferred credits should now expire. A new credit block will be created
+with expiry date `target_expiry_date`, with the same cost basis data as the original credit block, if present.
+
+Note that the balance of the block with the given `expiry_date` must be at least equal to the desired transfer
+amount determined by the `amount` parameter.
+
+The following snippet illustrates a sample request body to extend the expiration date of credits by one year:
+
+```json
+{
+  "entry_type": "expiration_change",
+  "amount": 10,
+  "expiry_date": "2022-12-28",
+  "block_id": "UiUhFWeLHPrBY4Ad",
+  "target_expiry_date": "2023-12-28",
+  "description": "Extending credit validity"
+}
+```
+
+## Voiding credits
+
+If you'd like to void a credit block, create a ledger entry of type `void`. For this entry, `block_id` is required
+to identify the block, and `amount` indicates how many credits to void, up to the block's initial balance. Pass
+in a `void_reason` of `refund` if the void is due to a refund.
+
+## Amendment
+
+If you'd like to undo a decrement on a credit block, create a ledger entry of type `amendment`. For this entry, `block_id`
+is required to identify the block that was originally decremented from, and `amount` indicates how many credits to return
+to the customer, up to the block's initial balance.
 
 ### Example Usage
 
@@ -24,6 +112,7 @@ Create ledger entry by external ID
 import { Orb } from "orb-billing";
 import { CreateLedgerEntryExternalIdResponse } from "orb-billing/dist/sdk/models/operations";
 import {
+  AddAmendmentCreditLedgerEntryRequestParamsEntryType,
   AddDecrementCreditLedgerEntryRequestParamsEntryType,
   AddExpirationChangeCreditLedgerEntryRequestParamsEntryType,
   AddIncrementCreditLedgerEntryRequestParamsEntryType,
@@ -40,11 +129,11 @@ const sdk = new Orb({
 
 sdk.credit.addByExternalId({
   requestBody: {
-    blockId: "navigate Southwest Silver",
+    amount: "543.93",
+    blockId: "Southwest Silver",
     description: "Fully-configurable object-oriented projection",
-    entryType: AddVoidCreditLedgerEntryRequestParamsEntryType.Void,
+    entryType: AddAmendmentCreditLedgerEntryRequestParamsEntryType.Amendment,
     metadata: {},
-    voidReason: AddVoidCreditLedgerEntryRequestParamsVoidReason.Refund,
   },
   externalCustomerId: "misspend Rubidium",
 }).then((res: CreateLedgerEntryExternalIdResponse) => {
@@ -69,7 +158,95 @@ sdk.credit.addByExternalId({
 
 ## create
 
-Create ledger entry
+This endpoint allows you to create a new ledger entry for a specified customer's balance. This can be used to
+increment balance, deduct credits, and change the expiry date of existing credits.
+
+## Effects of adding a ledger entry
+1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) will return a credit block that
+  represents the changes (i.e. balance changes or transfers).
+2. A ledger entry will be added to the credits ledger for this customer, and therefore returned in the
+  [View Credits Ledger](fetch-customer-credits) response as well as serialized in the response to this request. In
+  the case of deductions without a specified block, multiple ledger entries may be created if the deduction spans
+  credit blocks.
+3. If `invoice_settings` is specified, an invoice will be created that reflects the cost of the credits (based on
+  `amount` and `per_unit_cost_basis`).
+
+## Adding credits
+  Adding credits is done by creating an entry of type `increment`. This requires the caller to specify a number of
+  credits as well as an optional expiry date in `YYYY-MM-DD` format. Orb also recommends specifying a description
+  to assist with auditing. When adding credits, the caller can also specify a cost basis per-credit, to indicate
+  how much in USD a customer paid for a single credit in a block. This can later be used for revenue recognition.
+
+The following snippet illustrates a sample request body to increment credits which will expire in January of 2022.
+
+```json
+{
+  "entry_type": "increment",
+  "amount": 100,
+  "expiry_date": "2022-12-28",
+  "per_unit_cost_basis": "0.20",
+  "description": "Purchased 100 credits"
+}
+```
+
+Note that by default, Orb will always first increment any _negative_ balance in existing blocks before adding the
+remaining amount to the desired credit block.
+
+### Invoicing for credits
+By default, Orb manipulates the credit ledger but does not charge for credits. However, if you pass
+`invoice_settings` in the body of this request, Orb will also generate a one-off invoice for the customer for the
+credits pre-purchase. Note that you _must_ provide the `per_unit_cost_basis`, since the total charges on the
+invoice are calculated by multiplying the cost basis with the number of credit units added.
+
+## Deducting Credits
+Orb allows you to deduct credits from a customer by creating an entry of type `decrement`. Orb matches the
+algorithm for automatic deductions for determining which credit blocks to decrement from. In the case that the
+deduction leads to multiple ledger entries, the response from this endpoint will be the final deduction. Orb also
+optionally allows specifying a description to assist with auditing.
+
+The following snippet illustrates a sample request body to decrement credits.
+
+```json
+{
+  "entry_type": "decrement",
+  "amount": 20,
+  "description": "Removing excess credits"
+}
+```
+
+## Changing credits expiry
+If you'd like to change when existing credits expire, you should create a ledger entry of type `expiration_change`.
+For this entry, the required parameter `expiry_date` identifies the _originating_ block, and the required parameter
+`target_expiry_date` identifies when the transferred credits should now expire. A new credit block will be created
+with expiry date `target_expiry_date`, with the same cost basis data as the original credit block, if present.
+
+Note that the balance of the block with the given `expiry_date` must be at least equal to the desired transfer
+amount determined by the `amount` parameter.
+
+The following snippet illustrates a sample request body to extend the expiration date of credits by one year:
+
+```json
+{
+  "entry_type": "expiration_change",
+  "amount": 10,
+  "expiry_date": "2022-12-28",
+  "block_id": "UiUhFWeLHPrBY4Ad",
+  "target_expiry_date": "2023-12-28",
+  "description": "Extending credit validity"
+}
+```
+
+## Voiding credits
+
+If you'd like to void a credit block, create a ledger entry of type `void`. For this entry, `block_id` is required
+to identify the block, and `amount` indicates how many credits to void, up to the block's initial balance. Pass
+in a `void_reason` of `refund` if the void is due to a refund.
+
+## Amendment
+
+If you'd like to undo a decrement on a credit block, create a ledger entry of type `amendment`. For this entry, `block_id`
+is required to identify the block that was originally decremented from, and `amount` indicates how many credits to return
+to the customer, up to the block's initial balance.
 
 ### Example Usage
 
@@ -77,6 +254,7 @@ Create ledger entry
 import { Orb } from "orb-billing";
 import { CreateLedgerEntryResponse } from "orb-billing/dist/sdk/models/operations";
 import {
+  AddAmendmentCreditLedgerEntryRequestParamsEntryType,
   AddDecrementCreditLedgerEntryRequestParamsEntryType,
   AddExpirationChangeCreditLedgerEntryRequestParamsEntryType,
   AddIncrementCreditLedgerEntryRequestParamsEntryType,
@@ -94,11 +272,14 @@ const sdk = new Orb({
 sdk.credit.create({
   requestBody: {
     amount: 6384.24,
-    description: "Synchronised full-range emulation",
-    entryType: AddDecrementCreditLedgerEntryRequestParamsEntryType.Decrement,
+    blockId: "Money blue shred",
+    description: "Implemented web-enabled success",
+    entryType: AddExpirationChangeCreditLedgerEntryRequestParamsEntryType.ExpirationChange,
+    expiryDate: new RFCDate("2021-01-01"),
     metadata: {},
+    targetExpiryDate: new RFCDate("2022-05-14"),
   },
-  customerId: "blue",
+  customerId: "evolve",
 }).then((res: CreateLedgerEntryResponse) => {
   if (res.statusCode == 200) {
     // handle response

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orb-billing",
-  "version": "1.19.2",
+  "version": "1.19.5",
   "author": "orbcorp",
   "scripts": {
     "prepare": "tsc --build"