@paid-ai/paid-node 1.7.0 → 1.8.0

package/dist/esm/api/resources/webhooks/client/Client.mjs

@@ -29,7 +29,7 @@ export class Webhooks {
         this._options = _options;
     }
     /**
-     * List customer-facing billing webhooks for the authenticated organization.
+     * List customer-facing billing webhooks for the authenticated organization, along with whether the organization has generated a signing secret.
      *
      * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -237,6 +237,74 @@ export class Webhooks {
             }
         });
     }
+    /**
+     * Generate a new HMAC signing secret used by every webhook in this organization and return it exactly once. The previous secret is invalidated immediately on next delivery.
+     *
+     * @param {Paid.RotateWebhookSecretRequest} request
+     * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.webhooks.rotateWebhookSecret()
+     */
+    rotateWebhookSecret(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__rotateWebhookSecret(request, requestOptions));
+    }
+    __rotateWebhookSecret() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PaidEnvironment.Default, "webhooks/rotate-secret"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Paid.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Paid.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Paid.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PaidError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.PaidError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.PaidTimeoutError("Timeout exceeded when calling POST /webhooks/rotate-secret.");
+                case "unknown":
+                    throw new errors.PaidError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
             return `Bearer ${yield core.Supplier.get(this._options.token)}`;

package/dist/esm/api/resources/webhooks/client/requests/RotateWebhookSecretRequest.d.mts

@@ -0,0 +1,5 @@
+/**
+ * @example
+ *     {}
+ */
+export type RotateWebhookSecretRequest = {};

package/dist/esm/api/resources/webhooks/client/requests/RotateWebhookSecretRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/webhooks/client/requests/index.d.mts

@@ -1,2 +1,3 @@
+export type { RotateWebhookSecretRequest } from "./RotateWebhookSecretRequest.mjs";
 export type { TestWebhookRequest } from "./TestWebhookRequest.mjs";
 export type { UpdateWebhookRequest } from "./UpdateWebhookRequest.mjs";

package/dist/esm/api/resources/webhooks/types/TestWebhookRequestWebhookName.d.mts

@@ -1,6 +1,7 @@
 export declare const TestWebhookRequestWebhookName: {
     readonly BillingInvoiceCreated: "billing-invoice-created";
     readonly BillingInvoicePaid: "billing-invoice-paid";
+    readonly BillingInvoicePosted: "billing-invoice-posted";
     readonly BillingCheckoutCreated: "billing-checkout-created";
     readonly BillingCheckoutCompleted: "billing-checkout-completed";
     readonly BillingCheckoutExpired: "billing-checkout-expired";
@@ -8,5 +9,6 @@ export declare const TestWebhookRequestWebhookName: {
     readonly BillingPaymentFailed: "billing-payment-failed";
     readonly BillingCreditsDepleted: "billing-credits-depleted";
     readonly BillingOverageIncurred: "billing-overage-incurred";
+    readonly BillingCreditCapReached: "billing-credit-cap-reached";
 };
 export type TestWebhookRequestWebhookName = (typeof TestWebhookRequestWebhookName)[keyof typeof TestWebhookRequestWebhookName];

package/dist/esm/api/resources/webhooks/types/TestWebhookRequestWebhookName.mjs

@@ -2,6 +2,7 @@
 export const TestWebhookRequestWebhookName = {
     BillingInvoiceCreated: "billing-invoice-created",
     BillingInvoicePaid: "billing-invoice-paid",
+    BillingInvoicePosted: "billing-invoice-posted",
     BillingCheckoutCreated: "billing-checkout-created",
     BillingCheckoutCompleted: "billing-checkout-completed",
     BillingCheckoutExpired: "billing-checkout-expired",
@@ -9,4 +10,5 @@ export const TestWebhookRequestWebhookName = {
     BillingPaymentFailed: "billing-payment-failed",
     BillingCreditsDepleted: "billing-credits-depleted",
     BillingOverageIncurred: "billing-overage-incurred",
+    BillingCreditCapReached: "billing-credit-cap-reached",
 };

package/dist/esm/api/resources/webhooks/types/UpdateWebhookRequestWebhookName.d.mts

@@ -1,6 +1,7 @@
 export declare const UpdateWebhookRequestWebhookName: {
     readonly BillingInvoiceCreated: "billing-invoice-created";
     readonly BillingInvoicePaid: "billing-invoice-paid";
+    readonly BillingInvoicePosted: "billing-invoice-posted";
     readonly BillingCheckoutCreated: "billing-checkout-created";
     readonly BillingCheckoutCompleted: "billing-checkout-completed";
     readonly BillingCheckoutExpired: "billing-checkout-expired";
@@ -8,5 +9,6 @@ export declare const UpdateWebhookRequestWebhookName: {
     readonly BillingPaymentFailed: "billing-payment-failed";
     readonly BillingCreditsDepleted: "billing-credits-depleted";
     readonly BillingOverageIncurred: "billing-overage-incurred";
+    readonly BillingCreditCapReached: "billing-credit-cap-reached";
 };
 export type UpdateWebhookRequestWebhookName = (typeof UpdateWebhookRequestWebhookName)[keyof typeof UpdateWebhookRequestWebhookName];

package/dist/esm/api/resources/webhooks/types/UpdateWebhookRequestWebhookName.mjs

@@ -2,6 +2,7 @@
 export const UpdateWebhookRequestWebhookName = {
     BillingInvoiceCreated: "billing-invoice-created",
     BillingInvoicePaid: "billing-invoice-paid",
+    BillingInvoicePosted: "billing-invoice-posted",
     BillingCheckoutCreated: "billing-checkout-created",
     BillingCheckoutCompleted: "billing-checkout-completed",
     BillingCheckoutExpired: "billing-checkout-expired",
@@ -9,4 +10,5 @@ export const UpdateWebhookRequestWebhookName = {
     BillingPaymentFailed: "billing-payment-failed",
     BillingCreditsDepleted: "billing-credits-depleted",
     BillingOverageIncurred: "billing-overage-incurred",
+    BillingCreditCapReached: "billing-credit-cap-reached",
 };

package/dist/esm/api/types/AddAttributeIntent.d.mts

@@ -0,0 +1,45 @@
+/**
+ * Advanced add with caller-authored pricing. Prefer `addFromCatalog` unless you need a raw pricing payload.
+ */
+export interface AddAttributeIntent {
+    /** Product UUID. */
+    productId: string;
+    /** Plan product UUID, when the add is from a plan. */
+    planProductId?: string;
+    /** Catalog product attribute UUID, when known. */
+    productAttributeId?: string;
+    /** Name of the new line. */
+    lineName: string;
+    /** Full pricing JSON. Prefer `addFromCatalog` or `newUnitPriceMinor` unless you are replacing the pricing shape. */
+    pricing: Record<string, unknown>;
+    quantity: number;
+    currency?: string;
+    /** How to charge the partial first period when adding an attribute mid-cycle. */
+    chargeStub?: AddAttributeIntent.ChargeStub;
+    /** How much of the credit benefit to grant for the current period. Only full is accepted today. */
+    creditGrant?: AddAttributeIntent.CreditGrant;
+    /** Recurring charges pick next-cycle vs settle-now. Usage price changes pick new usage only vs the whole current period. */
+    treatment?: AddAttributeIntent.Treatment;
+}
+export declare namespace AddAttributeIntent {
+    /** How to charge the partial first period when adding an attribute mid-cycle. */
+    const ChargeStub: {
+        readonly None: "none";
+        readonly Prorated: "prorated";
+        readonly Full: "full";
+    };
+    type ChargeStub = (typeof ChargeStub)[keyof typeof ChargeStub];
+    /** How much of the credit benefit to grant for the current period. Only full is accepted today. */
+    const CreditGrant: {
+        readonly Full: "full";
+    };
+    type CreditGrant = (typeof CreditGrant)[keyof typeof CreditGrant];
+    /** Recurring charges pick next-cycle vs settle-now. Usage price changes pick new usage only vs the whole current period. */
+    const Treatment: {
+        readonly None: "none";
+        readonly Prorate: "prorate";
+        readonly SignalsFromAmendment: "signalsFromAmendment";
+        readonly AllSignalsInPeriod: "allSignalsInPeriod";
+    };
+    type Treatment = (typeof Treatment)[keyof typeof Treatment];
+}

package/dist/esm/api/types/AddAttributeIntent.mjs

@@ -0,0 +1,21 @@
+// This file was auto-generated by Fern from our API Definition.
+export var AddAttributeIntent;
+(function (AddAttributeIntent) {
+    /** How to charge the partial first period when adding an attribute mid-cycle. */
+    AddAttributeIntent.ChargeStub = {
+        None: "none",
+        Prorated: "prorated",
+        Full: "full",
+    };
+    /** How much of the credit benefit to grant for the current period. Only full is accepted today. */
+    AddAttributeIntent.CreditGrant = {
+        Full: "full",
+    };
+    /** Recurring charges pick next-cycle vs settle-now. Usage price changes pick new usage only vs the whole current period. */
+    AddAttributeIntent.Treatment = {
+        None: "none",
+        Prorate: "prorate",
+        SignalsFromAmendment: "signalsFromAmendment",
+        AllSignalsInPeriod: "allSignalsInPeriod",
+    };
+})(AddAttributeIntent || (AddAttributeIntent = {}));

package/dist/esm/api/types/AddFromCatalogIntent.d.mts

@@ -0,0 +1,22 @@
+/**
+ * Add a catalog attribute to the order. This is the supported add path.
+ */
+export interface AddFromCatalogIntent {
+    /** Catalog product attribute id. Pricing and credit benefits are snapshotted from the catalog. */
+    productAttributeId: string;
+    /** Override quantity. Only for quantity-based charges. */
+    quantity?: number;
+    /** Override unit price. Only for per-unit pricing. Amount in cents (minor currency units). */
+    unitPriceMinor?: number;
+    /** How to charge the partial first period when adding an attribute mid-cycle. */
+    chargeStub?: AddFromCatalogIntent.ChargeStub;
+}
+export declare namespace AddFromCatalogIntent {
+    /** How to charge the partial first period when adding an attribute mid-cycle. */
+    const ChargeStub: {
+        readonly None: "none";
+        readonly Prorated: "prorated";
+        readonly Full: "full";
+    };
+    type ChargeStub = (typeof ChargeStub)[keyof typeof ChargeStub];
+}

package/dist/esm/api/types/AddFromCatalogIntent.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export var AddFromCatalogIntent;
+(function (AddFromCatalogIntent) {
+    /** How to charge the partial first period when adding an attribute mid-cycle. */
+    AddFromCatalogIntent.ChargeStub = {
+        None: "none",
+        Prorated: "prorated",
+        Full: "full",
+    };
+})(AddFromCatalogIntent || (AddFromCatalogIntent = {}));

package/dist/esm/api/types/AddMembersResponse.d.mts

@@ -0,0 +1,5 @@
+export interface AddMembersResponse {
+    added: number;
+    skipped: number;
+    skippedIds: string[];
+}

package/dist/esm/api/types/AddMembersResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/AmendmentAddAttributeOptions.d.mts

@@ -0,0 +1,9 @@
+import type * as Paid from "../index.mjs";
+/**
+ * Axes for adding an attribute mid-cycle.
+ */
+export interface AmendmentAddAttributeOptions {
+    axes: Paid.AmendmentAddAxisOptions[];
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/esm/api/types/AmendmentAddAttributeOptions.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/AmendmentAddAxisOptions.d.mts

@@ -0,0 +1,10 @@
+import type * as Paid from "../index.mjs";
+export type AmendmentAddAxisOptions = Paid.AmendmentAddAxisOptions.ChargeStub | Paid.AmendmentAddAxisOptions.CreditGrant;
+export declare namespace AmendmentAddAxisOptions {
+    interface ChargeStub extends Paid.ChargeStubAddAxisOptions {
+        axis: "chargeStub";
+    }
+    interface CreditGrant extends Paid.CreditGrantAddAxisOptions {
+        axis: "creditGrant";
+    }
+}

package/dist/esm/api/types/AmendmentAddAxisOptions.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/AmendmentAttributeOptions.d.mts

@@ -0,0 +1,14 @@
+import type * as Paid from "../index.mjs";
+export interface AmendmentAttributeOptions {
+    /** Attribute UUID. Pass this on quantity, pricing, and end intents. */
+    orderLineAttributeId: string;
+    state: Paid.AmendmentAttributeState;
+    /** True when this attribute bills from usage signals. */
+    meteredUsage: boolean;
+    /** Intents available on this attribute, with the axis choices each supports. */
+    intents: Paid.AmendmentIntentOptions[];
+    /** Set when this attribute cannot be amended, for example seat-based charges. */
+    lockedReason?: string;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/esm/api/types/AmendmentAttributeOptions.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/AmendmentAttributeState.d.mts

@@ -0,0 +1,24 @@
+import type * as Paid from "../index.mjs";
+export interface AmendmentAttributeState {
+    /** Billed quantity. Signal-driven usage reports 0. */
+    quantity: number;
+    /** Unit price in cents. Absent when no single per-unit rate exists (tiered models). */
+    unitPriceMinor?: number;
+    /** Total in cents of this attribute's currency. */
+    totalAmountMinor?: number;
+    /** Credits burned per signal unit for credit-billed usage. */
+    creditCost?: number;
+    /** Summable credits this pricing grants. Absent when nothing summable exists. */
+    creditBenefitAmount?: number;
+    /** True when the pricing grants unlimited credits, which no amount can express. */
+    hasInfiniteCreditBenefits?: boolean;
+    /** Currency of the money fields. Attributes carry their own currency; do not assume the order's. */
+    currency?: string;
+    chargeType?: Paid.AmendmentChargeType;
+    /** True for arrears-metered usage, where quantity is signal-driven. */
+    meteredUsage?: boolean;
+    /** Product UUID. */
+    productId?: string;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/esm/api/types/AmendmentAttributeState.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/AmendmentAxisChoiceValue.d.mts

@@ -0,0 +1,10 @@
+/** Resolved choice for the sibling axis. */
+export declare const AmendmentAxisChoiceValue: {
+    readonly None: "none";
+    readonly Prorate: "prorate";
+    readonly SignalsFromAmendment: "signalsFromAmendment";
+    readonly AllSignalsInPeriod: "allSignalsInPeriod";
+    readonly Prorated: "prorated";
+    readonly Full: "full";
+};
+export type AmendmentAxisChoiceValue = (typeof AmendmentAxisChoiceValue)[keyof typeof AmendmentAxisChoiceValue];

package/dist/esm/api/types/AmendmentAxisChoiceValue.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Resolved choice for the sibling axis. */
+export const AmendmentAxisChoiceValue = {
+    None: "none",
+    Prorate: "prorate",
+    SignalsFromAmendment: "signalsFromAmendment",
+    AllSignalsInPeriod: "allSignalsInPeriod",
+    Prorated: "prorated",
+    Full: "full",
+};

package/dist/esm/api/types/AmendmentAxisId.d.mts

@@ -0,0 +1,8 @@
+/** Which treatment this axis is. */
+export declare const AmendmentAxisId: {
+    readonly Money: "money";
+    readonly UsageAttribution: "usageAttribution";
+    readonly ChargeStub: "chargeStub";
+    readonly CreditGrant: "creditGrant";
+};
+export type AmendmentAxisId = (typeof AmendmentAxisId)[keyof typeof AmendmentAxisId];

package/dist/esm/api/types/AmendmentAxisId.mjs

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Which treatment this axis is. */
+export const AmendmentAxisId = {
+    Money: "money",
+    UsageAttribution: "usageAttribution",
+    ChargeStub: "chargeStub",
+    CreditGrant: "creditGrant",
+};

package/dist/esm/api/types/AmendmentAxisOptions.d.mts

@@ -0,0 +1,16 @@
+import type * as Paid from "../index.mjs";
+export type AmendmentAxisOptions = Paid.AmendmentAxisOptions.Money | Paid.AmendmentAxisOptions.UsageAttribution | Paid.AmendmentAxisOptions.ChargeStub | Paid.AmendmentAxisOptions.CreditGrant;
+export declare namespace AmendmentAxisOptions {
+    interface Money extends Paid.MoneyAxisOptions {
+        axis: "money";
+    }
+    interface UsageAttribution extends Paid.UsageAttributionAxisOptions {
+        axis: "usageAttribution";
+    }
+    interface ChargeStub extends Paid.ChargeStubAxisOptions {
+        axis: "chargeStub";
+    }
+    interface CreditGrant extends Paid.CreditGrantAxisOptions {
+        axis: "creditGrant";
+    }
+}

package/dist/esm/api/types/AmendmentAxisOptions.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/AmendmentAxisRelevance.d.mts

@@ -0,0 +1,6 @@
+/** Whether this choice always has an effect, or only when the amendment falls mid-period. */
+export declare const AmendmentAxisRelevance: {
+    readonly Always: "always";
+    readonly MidCycle: "midCycle";
+};
+export type AmendmentAxisRelevance = (typeof AmendmentAxisRelevance)[keyof typeof AmendmentAxisRelevance];

package/dist/esm/api/types/AmendmentAxisRelevance.mjs

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Whether this choice always has an effect, or only when the amendment falls mid-period. */
+export const AmendmentAxisRelevance = {
+    Always: "always",
+    MidCycle: "midCycle",
+};

package/dist/esm/api/types/AmendmentBillingType.d.mts

@@ -0,0 +1,6 @@
+/** When the charge is billed. Wire values are PascalCase. */
+export declare const AmendmentBillingType: {
+    readonly Advance: "Advance";
+    readonly Arrears: "Arrears";
+};
+export type AmendmentBillingType = (typeof AmendmentBillingType)[keyof typeof AmendmentBillingType];

package/dist/esm/api/types/AmendmentBillingType.mjs

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+/** When the charge is billed. Wire values are PascalCase. */
+export const AmendmentBillingType = {
+    Advance: "Advance",
+    Arrears: "Arrears",
+};

package/dist/esm/api/types/AmendmentChargeType.d.mts

@@ -0,0 +1,8 @@
+/** Charge type. */
+export declare const AmendmentChargeType: {
+    readonly Usage: "usage";
+    readonly Recurring: "recurring";
+    readonly OneTime: "oneTime";
+    readonly SeatBased: "seatBased";
+};
+export type AmendmentChargeType = (typeof AmendmentChargeType)[keyof typeof AmendmentChargeType];

package/dist/esm/api/types/AmendmentChargeType.mjs

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Charge type. */
+export const AmendmentChargeType = {
+    Usage: "usage",
+    Recurring: "recurring",
+    OneTime: "oneTime",
+    SeatBased: "seatBased",
+};

package/dist/esm/api/types/AmendmentCreditEffectKind.d.mts

@@ -0,0 +1,6 @@
+/** Whether this ends a superseded grant or grants credits on the added attribute. */
+export declare const AmendmentCreditEffectKind: {
+    readonly EndEntitlement: "endEntitlement";
+    readonly GrantOnActivation: "grantOnActivation";
+};
+export type AmendmentCreditEffectKind = (typeof AmendmentCreditEffectKind)[keyof typeof AmendmentCreditEffectKind];

package/dist/esm/api/types/AmendmentCreditEffectKind.mjs

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Whether this ends a superseded grant or grants credits on the added attribute. */
+export const AmendmentCreditEffectKind = {
+    EndEntitlement: "endEntitlement",
+    GrantOnActivation: "grantOnActivation",
+};

package/dist/esm/api/types/AmendmentErrorResponse.d.mts

@@ -0,0 +1,7 @@
+export interface AmendmentErrorResponse {
+    error: string;
+    code?: string;
+    details?: string;
+    /** Index of the intent in the request that caused the error, when the failure is attributable to one intent. */
+    intentIndex?: number;
+}

package/dist/esm/api/types/AmendmentErrorResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/AmendmentIntentKind.d.mts

@@ -0,0 +1,10 @@
+/** What change this entry describes. */
+export declare const AmendmentIntentKind: {
+    readonly UpdateQuantity: "updateQuantity";
+    readonly UpdatePricing: "updatePricing";
+    readonly EndAttribute: "endAttribute";
+    readonly AddAttribute: "addAttribute";
+    readonly UpdateLineTerm: "updateLineTerm";
+    readonly UpdateOrderTerm: "updateOrderTerm";
+};
+export type AmendmentIntentKind = (typeof AmendmentIntentKind)[keyof typeof AmendmentIntentKind];

package/dist/esm/api/types/AmendmentIntentKind.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+/** What change this entry describes. */
+export const AmendmentIntentKind = {
+    UpdateQuantity: "updateQuantity",
+    UpdatePricing: "updatePricing",
+    EndAttribute: "endAttribute",
+    AddAttribute: "addAttribute",
+    UpdateLineTerm: "updateLineTerm",
+    UpdateOrderTerm: "updateOrderTerm",
+};

package/dist/esm/api/types/AmendmentIntentOptions.d.mts

@@ -0,0 +1,7 @@
+import type * as Paid from "../index.mjs";
+export interface AmendmentIntentOptions {
+    kind: Paid.AmendmentIntentKind;
+    axes: Paid.AmendmentAxisOptions[];
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/esm/api/types/AmendmentIntentOptions.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/AmendmentLineOptions.d.mts

@@ -0,0 +1,12 @@
+import type * as Paid from "../index.mjs";
+export interface AmendmentLineOptions {
+    /** Line UUID. Pass this on `updateLineTerm`. */
+    orderLineId: string;
+    attributes: Paid.AmendmentAttributeOptions[];
+    /** Line-level intents, such as `updateLineTerm`. */
+    intents?: Paid.AmendmentIntentOptions[];
+    /** Set when this line cannot be amended. */
+    lockedReason?: string;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/esm/api/types/AmendmentLineOptions.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/AmendmentMoneyBilling.d.mts

@@ -0,0 +1,6 @@
+/** Whether this amount is invoiced now or at the next billing run. */
+export declare const AmendmentMoneyBilling: {
+    readonly Inline: "inline";
+    readonly NextRun: "nextRun";
+};
+export type AmendmentMoneyBilling = (typeof AmendmentMoneyBilling)[keyof typeof AmendmentMoneyBilling];

package/dist/esm/api/types/AmendmentMoneyBilling.mjs

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Whether this amount is invoiced now or at the next billing run. */
+export const AmendmentMoneyBilling = {
+    Inline: "inline",
+    NextRun: "nextRun",
+};

package/dist/esm/api/types/AmendmentOptions.d.mts

@@ -0,0 +1,26 @@
+import type * as Paid from "../index.mjs";
+export interface AmendmentOptions {
+    /** Display id of the order. */
+    orderId: string;
+    /** Pass this unchanged into preview and execute. */
+    orderVersion: number;
+    /** Order currency (ISO 4217). */
+    currency: string;
+    /** When an amendment submitted now takes effect. */
+    effectiveDate: string;
+    /** False when the order cannot be amended right now. */
+    amendable: boolean;
+    /** Machine-readable reason when `amendable` is false. */
+    notAmendableCode?: string;
+    /** Human-readable reason when `amendable` is false. */
+    notAmendableReason?: string;
+    lines: Paid.AmendmentLineOptions[];
+    addAttribute: Paid.AmendmentAddAttributeOptions;
+    /** True when an attribute added now would have a partial period before the next order anchor. When false, every `chargeStub` choice degenerates to the plain full-cycle add. */
+    stubPeriodExists?: boolean;
+    orderTerm?: Paid.AmendmentIntentOptions;
+    /** Last day of the current billing period. Natural cancel-renewal target. */
+    currentPeriodEnd?: string;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/esm/api/types/AmendmentOptions.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/AmendmentPlan.d.mts

@@ -0,0 +1,24 @@
+import type * as Paid from "../index.mjs";
+export interface AmendmentPlan {
+    /** Version of the plan format. Currently 1. */
+    planVersion: number;
+    orderId: string;
+    orderVersion: number;
+    /** When the amendment takes effect. */
+    effectiveDate: string;
+    operations: Paid.PlannedOperations;
+    /** Mid-cycle money the amendment moves. */
+    moneyEffects: Paid.AmendmentPlanMoneyEffect[] | null;
+    /** Credit entitlement changes the amendment causes. */
+    creditEffects: Paid.AmendmentPlanCreditEffect[] | null;
+    /** How un-invoiced usage is handled for repriced metered attributes. */
+    usageEffects?: Paid.AmendmentPlanUsageEffect[] | null;
+    /** The resolved choice for every treatment axis, with its source. */
+    treatmentsResolved: Paid.AmendmentPlanTreatmentResolution[] | null;
+    /** Before and after billed configuration. Not included in `planHash`. */
+    stateDiff: Paid.AmendmentPlanAttributeDiff[] | null;
+    /** Pass this to execute for two-phase drift protection. */
+    planHash: string;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/esm/api/types/AmendmentPlan.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};