@metronome/sdk 1.0.0 → 2.1.0

package/resources/v1/payments.d.mts

@@ -0,0 +1,117 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as Shared from "../shared.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { BodyCursorPage, type BodyCursorPageParams, PagePromise } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Payments extends APIResource {
+    /**
+     * Fetch all payment attempts for the given invoice.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const payment of client.v1.payments.list({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *   statuses: ['pending', 'requires_intervention'],
+     * })) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(body: PaymentListParams, options?: RequestOptions): PagePromise<PaymentsBodyCursorPage, Payment>;
+    /**
+     * Trigger a new attempt by canceling any existing attempts for this invoice and
+     * creating a new Payment. This will trigger another attempt to charge the
+     * Customer's configured Payment Gateway. Payment can only be attempted if all of
+     * the following are true:
+     *
+     * - The Metronome Invoice is finalized
+     * - PLG Invoicing is configured for the Customer
+     * - You cannot attempt payments for invoices that have already been `paid` or
+     *   `voided`.
+     *
+     * Attempting to payment on an ineligible Invoice or Customer will result in a
+     * `400` response.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.payments.attempt({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     * });
+     * ```
+     */
+    attempt(body: PaymentAttemptParams, options?: RequestOptions): APIPromise<PaymentAttemptResponse>;
+    /**
+     * Cancel an existing payment attempt for an invoice.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.payments.cancel({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     * });
+     * ```
+     */
+    cancel(body: PaymentCancelParams, options?: RequestOptions): APIPromise<PaymentCancelResponse>;
+}
+export type PaymentsBodyCursorPage = BodyCursorPage<Payment>;
+export interface Payment {
+    id: string;
+    amount?: number;
+    amount_paid?: number;
+    contract_id?: string;
+    created_at?: string;
+    customer_id?: string;
+    error_message?: string;
+    fiat_credit_type?: Shared.CreditTypeData;
+    invoice_id?: string;
+    payment_gateway?: Payment.PaymentGateway;
+    status?: PaymentStatus;
+    updated_at?: string;
+}
+export declare namespace Payment {
+    interface PaymentGateway {
+        stripe: PaymentGateway.Stripe;
+        type: 'stripe';
+    }
+    namespace PaymentGateway {
+        interface Stripe {
+            payment_intent_id: string;
+            error?: Stripe.Error;
+            payment_method_id?: string;
+        }
+        namespace Stripe {
+            interface Error {
+                code?: string;
+                decline_code?: string;
+                type?: string;
+            }
+        }
+    }
+}
+export type PaymentStatus = 'pending' | 'requires_intervention' | 'paid' | 'canceled';
+export interface PaymentAttemptResponse {
+    data: Payment;
+}
+export interface PaymentCancelResponse {
+    data: Payment;
+}
+export interface PaymentListParams extends BodyCursorPageParams {
+    customer_id: string;
+    invoice_id: string;
+    statuses?: Array<PaymentStatus>;
+}
+export interface PaymentAttemptParams {
+    customer_id: string;
+    invoice_id: string;
+}
+export interface PaymentCancelParams {
+    customer_id: string;
+    invoice_id: string;
+}
+export declare namespace Payments {
+    export { type Payment as Payment, type PaymentStatus as PaymentStatus, type PaymentAttemptResponse as PaymentAttemptResponse, type PaymentCancelResponse as PaymentCancelResponse, type PaymentsBodyCursorPage as PaymentsBodyCursorPage, type PaymentListParams as PaymentListParams, type PaymentAttemptParams as PaymentAttemptParams, type PaymentCancelParams as PaymentCancelParams, };
+}
+//# sourceMappingURL=payments.d.mts.map

package/resources/v1/payments.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payments.d.mts","sourceRoot":"","sources":["../../src/resources/v1/payments.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE;OAC1D,EAAE,cAAc,EAAE;AAEzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC,sBAAsB,EAAE,OAAO,CAAC;IAQrG;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIjG;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAG/F;AAED,MAAM,MAAM,sBAAsB,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;AAE7D,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,gBAAgB,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC;IAEzC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,eAAe,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC;IAEzC,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,OAAO,CAAC;IACvB,UAAiB,cAAc;QAC7B,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC;QAE9B,IAAI,EAAE,QAAQ,CAAC;KAChB;IAED,UAAiB,cAAc,CAAC;QAC9B,UAAiB,MAAM;YACrB,iBAAiB,EAAE,MAAM,CAAC;YAE1B,KAAK,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC;YAErB,iBAAiB,CAAC,EAAE,MAAM,CAAC;SAC5B;QAED,UAAiB,MAAM,CAAC;YACtB,UAAiB,KAAK;gBACpB,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEd,YAAY,CAAC,EAAE,MAAM,CAAC;gBAEtB,IAAI,CAAC,EAAE,MAAM,CAAC;aACf;SACF;KACF;CACF;AAED,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,uBAAuB,GAAG,MAAM,GAAG,UAAU,CAAC;AAEtF,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,iBAAkB,SAAQ,oBAAoB;IAC7D,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/v1/payments.d.ts

@@ -0,0 +1,117 @@
+import { APIResource } from "../../core/resource.js";
+import * as Shared from "../shared.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { BodyCursorPage, type BodyCursorPageParams, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Payments extends APIResource {
+    /**
+     * Fetch all payment attempts for the given invoice.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const payment of client.v1.payments.list({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *   statuses: ['pending', 'requires_intervention'],
+     * })) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(body: PaymentListParams, options?: RequestOptions): PagePromise<PaymentsBodyCursorPage, Payment>;
+    /**
+     * Trigger a new attempt by canceling any existing attempts for this invoice and
+     * creating a new Payment. This will trigger another attempt to charge the
+     * Customer's configured Payment Gateway. Payment can only be attempted if all of
+     * the following are true:
+     *
+     * - The Metronome Invoice is finalized
+     * - PLG Invoicing is configured for the Customer
+     * - You cannot attempt payments for invoices that have already been `paid` or
+     *   `voided`.
+     *
+     * Attempting to payment on an ineligible Invoice or Customer will result in a
+     * `400` response.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.payments.attempt({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     * });
+     * ```
+     */
+    attempt(body: PaymentAttemptParams, options?: RequestOptions): APIPromise<PaymentAttemptResponse>;
+    /**
+     * Cancel an existing payment attempt for an invoice.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.payments.cancel({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     * });
+     * ```
+     */
+    cancel(body: PaymentCancelParams, options?: RequestOptions): APIPromise<PaymentCancelResponse>;
+}
+export type PaymentsBodyCursorPage = BodyCursorPage<Payment>;
+export interface Payment {
+    id: string;
+    amount?: number;
+    amount_paid?: number;
+    contract_id?: string;
+    created_at?: string;
+    customer_id?: string;
+    error_message?: string;
+    fiat_credit_type?: Shared.CreditTypeData;
+    invoice_id?: string;
+    payment_gateway?: Payment.PaymentGateway;
+    status?: PaymentStatus;
+    updated_at?: string;
+}
+export declare namespace Payment {
+    interface PaymentGateway {
+        stripe: PaymentGateway.Stripe;
+        type: 'stripe';
+    }
+    namespace PaymentGateway {
+        interface Stripe {
+            payment_intent_id: string;
+            error?: Stripe.Error;
+            payment_method_id?: string;
+        }
+        namespace Stripe {
+            interface Error {
+                code?: string;
+                decline_code?: string;
+                type?: string;
+            }
+        }
+    }
+}
+export type PaymentStatus = 'pending' | 'requires_intervention' | 'paid' | 'canceled';
+export interface PaymentAttemptResponse {
+    data: Payment;
+}
+export interface PaymentCancelResponse {
+    data: Payment;
+}
+export interface PaymentListParams extends BodyCursorPageParams {
+    customer_id: string;
+    invoice_id: string;
+    statuses?: Array<PaymentStatus>;
+}
+export interface PaymentAttemptParams {
+    customer_id: string;
+    invoice_id: string;
+}
+export interface PaymentCancelParams {
+    customer_id: string;
+    invoice_id: string;
+}
+export declare namespace Payments {
+    export { type Payment as Payment, type PaymentStatus as PaymentStatus, type PaymentAttemptResponse as PaymentAttemptResponse, type PaymentCancelResponse as PaymentCancelResponse, type PaymentsBodyCursorPage as PaymentsBodyCursorPage, type PaymentListParams as PaymentListParams, type PaymentAttemptParams as PaymentAttemptParams, type PaymentCancelParams as PaymentCancelParams, };
+}
+//# sourceMappingURL=payments.d.ts.map

package/resources/v1/payments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payments.d.ts","sourceRoot":"","sources":["../../src/resources/v1/payments.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE;OAC1D,EAAE,cAAc,EAAE;AAEzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC,sBAAsB,EAAE,OAAO,CAAC;IAQrG;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIjG;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAG/F;AAED,MAAM,MAAM,sBAAsB,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;AAE7D,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,gBAAgB,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC;IAEzC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,eAAe,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC;IAEzC,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,OAAO,CAAC;IACvB,UAAiB,cAAc;QAC7B,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC;QAE9B,IAAI,EAAE,QAAQ,CAAC;KAChB;IAED,UAAiB,cAAc,CAAC;QAC9B,UAAiB,MAAM;YACrB,iBAAiB,EAAE,MAAM,CAAC;YAE1B,KAAK,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC;YAErB,iBAAiB,CAAC,EAAE,MAAM,CAAC;SAC5B;QAED,UAAiB,MAAM,CAAC;YACtB,UAAiB,KAAK;gBACpB,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEd,YAAY,CAAC,EAAE,MAAM,CAAC;gBAEtB,IAAI,CAAC,EAAE,MAAM,CAAC;aACf;SACF;KACF;CACF;AAED,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,uBAAuB,GAAG,MAAM,GAAG,UAAU,CAAC;AAEtF,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,iBAAkB,SAAQ,oBAAoB;IAC7D,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/v1/payments.js

@@ -0,0 +1,71 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Payments = void 0;
+const resource_1 = require("../../core/resource.js");
+const pagination_1 = require("../../core/pagination.js");
+class Payments extends resource_1.APIResource {
+    /**
+     * Fetch all payment attempts for the given invoice.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const payment of client.v1.payments.list({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *   statuses: ['pending', 'requires_intervention'],
+     * })) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(body, options) {
+        return this._client.getAPIList('/v1/payments/list', (pagination_1.BodyCursorPage), {
+            body,
+            method: 'post',
+            ...options,
+        });
+    }
+    /**
+     * Trigger a new attempt by canceling any existing attempts for this invoice and
+     * creating a new Payment. This will trigger another attempt to charge the
+     * Customer's configured Payment Gateway. Payment can only be attempted if all of
+     * the following are true:
+     *
+     * - The Metronome Invoice is finalized
+     * - PLG Invoicing is configured for the Customer
+     * - You cannot attempt payments for invoices that have already been `paid` or
+     *   `voided`.
+     *
+     * Attempting to payment on an ineligible Invoice or Customer will result in a
+     * `400` response.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.payments.attempt({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     * });
+     * ```
+     */
+    attempt(body, options) {
+        return this._client.post('/v1/payments/attempt', { body, ...options });
+    }
+    /**
+     * Cancel an existing payment attempt for an invoice.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.payments.cancel({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     * });
+     * ```
+     */
+    cancel(body, options) {
+        return this._client.post('/v1/payments/cancel', { body, ...options });
+    }
+}
+exports.Payments = Payments;
+//# sourceMappingURL=payments.js.map

package/resources/v1/payments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payments.js","sourceRoot":"","sources":["../../src/resources/v1/payments.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,yDAA+F;AAG/F,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,IAAuB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,2BAAuB,CAAA,EAAE;YAC3E,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CAAC,IAA0B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF;AAhED,4BAgEC"}

package/resources/v1/payments.mjs

@@ -0,0 +1,67 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { BodyCursorPage } from "../../core/pagination.mjs";
+export class Payments extends APIResource {
+    /**
+     * Fetch all payment attempts for the given invoice.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const payment of client.v1.payments.list({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *   statuses: ['pending', 'requires_intervention'],
+     * })) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(body, options) {
+        return this._client.getAPIList('/v1/payments/list', (BodyCursorPage), {
+            body,
+            method: 'post',
+            ...options,
+        });
+    }
+    /**
+     * Trigger a new attempt by canceling any existing attempts for this invoice and
+     * creating a new Payment. This will trigger another attempt to charge the
+     * Customer's configured Payment Gateway. Payment can only be attempted if all of
+     * the following are true:
+     *
+     * - The Metronome Invoice is finalized
+     * - PLG Invoicing is configured for the Customer
+     * - You cannot attempt payments for invoices that have already been `paid` or
+     *   `voided`.
+     *
+     * Attempting to payment on an ineligible Invoice or Customer will result in a
+     * `400` response.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.payments.attempt({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     * });
+     * ```
+     */
+    attempt(body, options) {
+        return this._client.post('/v1/payments/attempt', { body, ...options });
+    }
+    /**
+     * Cancel an existing payment attempt for an invoice.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.payments.cancel({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   invoice_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     * });
+     * ```
+     */
+    cancel(body, options) {
+        return this._client.post('/v1/payments/cancel', { body, ...options });
+    }
+}
+//# sourceMappingURL=payments.mjs.map

package/resources/v1/payments.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"payments.mjs","sourceRoot":"","sources":["../../src/resources/v1/payments.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,cAAc,EAA0C;AAGjE,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,IAAuB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,cAAuB,CAAA,EAAE;YAC3E,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CAAC,IAA0B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF"}

package/resources/v1/plans.d.mts

@@ -6,7 +6,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagin
 import { RequestOptions } from "../../internal/request-options.mjs";
 export declare class Plans extends APIResource {
     /**
-     * List all available plans.
+     * List all available plans. This is a Plans (deprecated) endpoint. New clients
+     * should implement using Contracts.
      *
      * @example
      * ```ts
@@ -18,7 +19,8 @@ export declare class Plans extends APIResource {
      */
     list(query?: PlanListParams | null | undefined, options?: RequestOptions): PagePromise<PlanListResponsesCursorPage, PlanListResponse>;
     /**
-     * Fetch high level details of a specific plan.
+     * Fetch high level details of a specific plan. This is a Plans (deprecated)
+     * endpoint. New clients should implement using Contracts.
      *
      * @example
      * ```ts
@@ -29,7 +31,8 @@ export declare class Plans extends APIResource {
      */
     getDetails(params: PlanGetDetailsParams, options?: RequestOptions): APIPromise<PlanGetDetailsResponse>;
     /**
-     * Fetches a list of charges of a specific plan.
+     * Fetches a list of charges of a specific plan. This is a Plans (deprecated)
+     * endpoint. New clients should implement using Contracts.
      *
      * @example
      * ```ts
@@ -44,7 +47,8 @@ export declare class Plans extends APIResource {
     listCharges(params: PlanListChargesParams, options?: RequestOptions): PagePromise<PlanListChargesResponsesCursorPage, PlanListChargesResponse>;
     /**
      * Fetches a list of customers on a specific plan (by default, only currently
-     * active plans are included)
+     * active plans are included). This is a Plans (deprecated) endpoint. New clients
+     * should implement using Contracts.
      *
      * @example
      * ```ts

package/resources/v1/plans.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"plans.d.mts","sourceRoot":"","sources":["../../src/resources/v1/plans.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2BAA2B,EAAE,gBAAgB,CAAC;IAI7D;;;;;;;;;OASG;IACH,UAAU,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAKtG;;;;;;;;;;;;OAYG;IACH,WAAW,CACT,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kCAAkC,EAAE,uBAAuB,CAAC;IAS3E;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,yBAAyB,CAAC;CAQhF;AAED,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAEvE,MAAM,MAAM,kCAAkC,GAAG,UAAU,CAAC,uBAAuB,CAAC,CAAC;AAErF,MAAM,MAAM,oCAAoC,GAAG,UAAU,CAAC,yBAAyB,CAAC,CAAC;AAEzF,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEzC,IAAI,EAAE,MAAM,CAAC;IAEb,aAAa,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAE9C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAErC,aAAa,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;CAC/C;AAED,yBAAiB,UAAU,CAAC;IAC1B,UAAiB,WAAW;QAC1B,cAAc,EAAE,MAAM,CAAC;QAEvB,0BAA0B,EAAE,MAAM,CAAC,cAAc,CAAC;QAElD,WAAW,EAAE,MAAM,CAAC;QAEpB,uBAAuB,EAAE,MAAM,CAAC,cAAc,CAAC;QAE/C,kBAAkB,EAAE,MAAM,CAAC;QAE3B,IAAI,EAAE,MAAM,CAAC;QAEb,QAAQ,EAAE,MAAM,CAAC;QAEjB,YAAY,EAAE,OAAO,CAAC;QAEtB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC9B;IAED,UAAiB,OAAO;QACtB,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC,IAAI,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,WAAW;QAC1B,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC,gBAAgB,EAAE,MAAM,CAAC,cAAc,CAAC;QAExC;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB,yBAAyB,EAAE,MAAM,CAAC;KACnC;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAC3C;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,OAAO,GAAG,OAAO,GAAG,WAAW,GAAG,SAAS,GAAG,MAAM,CAAC;IAElE,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;IAEnC;;OAEG;IACH,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEzC,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,KAAK,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAE7C,UAAU,EAAE,MAAM,CAAC;IAEnB,YAAY,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,uBAAuB,CAAC,cAAc,CAAC;CAC1D;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,MAAM,CAAC;QAEd,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KACzC;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,gBAAgB,EAAE,YAAY,CAAC,cAAc,CAAC;IAE9C,YAAY,EAAE,yBAAyB,CAAC,WAAW,CAAC;CACrD;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,WAAW;QAC1B,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,aAAa,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEzC,gBAAgB,EAAE,MAAM,CAAC;QAEzB,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC/B;CACF;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;CAAG;AAE3D,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC;CAClD;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
+{"version":3,"file":"plans.d.mts","sourceRoot":"","sources":["../../src/resources/v1/plans.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2BAA2B,EAAE,gBAAgB,CAAC;IAI7D;;;;;;;;;;OAUG;IACH,UAAU,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAKtG;;;;;;;;;;;;;OAaG;IACH,WAAW,CACT,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kCAAkC,EAAE,uBAAuB,CAAC;IAS3E;;;;;;;;;;;;;;OAcG;IACH,aAAa,CACX,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,yBAAyB,CAAC;CAQhF;AAED,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAEvE,MAAM,MAAM,kCAAkC,GAAG,UAAU,CAAC,uBAAuB,CAAC,CAAC;AAErF,MAAM,MAAM,oCAAoC,GAAG,UAAU,CAAC,yBAAyB,CAAC,CAAC;AAEzF,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEzC,IAAI,EAAE,MAAM,CAAC;IAEb,aAAa,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAE9C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAErC,aAAa,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;CAC/C;AAED,yBAAiB,UAAU,CAAC;IAC1B,UAAiB,WAAW;QAC1B,cAAc,EAAE,MAAM,CAAC;QAEvB,0BAA0B,EAAE,MAAM,CAAC,cAAc,CAAC;QAElD,WAAW,EAAE,MAAM,CAAC;QAEpB,uBAAuB,EAAE,MAAM,CAAC,cAAc,CAAC;QAE/C,kBAAkB,EAAE,MAAM,CAAC;QAE3B,IAAI,EAAE,MAAM,CAAC;QAEb,QAAQ,EAAE,MAAM,CAAC;QAEjB,YAAY,EAAE,OAAO,CAAC;QAEtB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC9B;IAED,UAAiB,OAAO;QACtB,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC,IAAI,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,WAAW;QAC1B,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC,gBAAgB,EAAE,MAAM,CAAC,cAAc,CAAC;QAExC;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB,yBAAyB,EAAE,MAAM,CAAC;KACnC;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAC3C;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,OAAO,GAAG,OAAO,GAAG,WAAW,GAAG,SAAS,GAAG,MAAM,CAAC;IAElE,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;IAEnC;;OAEG;IACH,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEzC,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,KAAK,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAE7C,UAAU,EAAE,MAAM,CAAC;IAEnB,YAAY,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,uBAAuB,CAAC,cAAc,CAAC;CAC1D;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,MAAM,CAAC;QAEd,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KACzC;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,gBAAgB,EAAE,YAAY,CAAC,cAAc,CAAC;IAE9C,YAAY,EAAE,yBAAyB,CAAC,WAAW,CAAC;CACrD;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,WAAW;QAC1B,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,aAAa,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEzC,gBAAgB,EAAE,MAAM,CAAC;QAEzB,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC/B;CACF;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;CAAG;AAE3D,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC;CAClD;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/v1/plans.d.ts

@@ -6,7 +6,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagin
 import { RequestOptions } from "../../internal/request-options.js";
 export declare class Plans extends APIResource {
     /**
-     * List all available plans.
+     * List all available plans. This is a Plans (deprecated) endpoint. New clients
+     * should implement using Contracts.
      *
      * @example
      * ```ts
@@ -18,7 +19,8 @@ export declare class Plans extends APIResource {
      */
     list(query?: PlanListParams | null | undefined, options?: RequestOptions): PagePromise<PlanListResponsesCursorPage, PlanListResponse>;
     /**
-     * Fetch high level details of a specific plan.
+     * Fetch high level details of a specific plan. This is a Plans (deprecated)
+     * endpoint. New clients should implement using Contracts.
      *
      * @example
      * ```ts
@@ -29,7 +31,8 @@ export declare class Plans extends APIResource {
      */
     getDetails(params: PlanGetDetailsParams, options?: RequestOptions): APIPromise<PlanGetDetailsResponse>;
     /**
-     * Fetches a list of charges of a specific plan.
+     * Fetches a list of charges of a specific plan. This is a Plans (deprecated)
+     * endpoint. New clients should implement using Contracts.
      *
      * @example
      * ```ts
@@ -44,7 +47,8 @@ export declare class Plans extends APIResource {
     listCharges(params: PlanListChargesParams, options?: RequestOptions): PagePromise<PlanListChargesResponsesCursorPage, PlanListChargesResponse>;
     /**
      * Fetches a list of customers on a specific plan (by default, only currently
-     * active plans are included)
+     * active plans are included). This is a Plans (deprecated) endpoint. New clients
+     * should implement using Contracts.
      *
      * @example
      * ```ts

package/resources/v1/plans.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plans.d.ts","sourceRoot":"","sources":["../../src/resources/v1/plans.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2BAA2B,EAAE,gBAAgB,CAAC;IAI7D;;;;;;;;;OASG;IACH,UAAU,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAKtG;;;;;;;;;;;;OAYG;IACH,WAAW,CACT,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kCAAkC,EAAE,uBAAuB,CAAC;IAS3E;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,yBAAyB,CAAC;CAQhF;AAED,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAEvE,MAAM,MAAM,kCAAkC,GAAG,UAAU,CAAC,uBAAuB,CAAC,CAAC;AAErF,MAAM,MAAM,oCAAoC,GAAG,UAAU,CAAC,yBAAyB,CAAC,CAAC;AAEzF,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEzC,IAAI,EAAE,MAAM,CAAC;IAEb,aAAa,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAE9C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAErC,aAAa,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;CAC/C;AAED,yBAAiB,UAAU,CAAC;IAC1B,UAAiB,WAAW;QAC1B,cAAc,EAAE,MAAM,CAAC;QAEvB,0BAA0B,EAAE,MAAM,CAAC,cAAc,CAAC;QAElD,WAAW,EAAE,MAAM,CAAC;QAEpB,uBAAuB,EAAE,MAAM,CAAC,cAAc,CAAC;QAE/C,kBAAkB,EAAE,MAAM,CAAC;QAE3B,IAAI,EAAE,MAAM,CAAC;QAEb,QAAQ,EAAE,MAAM,CAAC;QAEjB,YAAY,EAAE,OAAO,CAAC;QAEtB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC9B;IAED,UAAiB,OAAO;QACtB,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC,IAAI,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,WAAW;QAC1B,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC,gBAAgB,EAAE,MAAM,CAAC,cAAc,CAAC;QAExC;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB,yBAAyB,EAAE,MAAM,CAAC;KACnC;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAC3C;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,OAAO,GAAG,OAAO,GAAG,WAAW,GAAG,SAAS,GAAG,MAAM,CAAC;IAElE,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;IAEnC;;OAEG;IACH,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEzC,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,KAAK,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAE7C,UAAU,EAAE,MAAM,CAAC;IAEnB,YAAY,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,uBAAuB,CAAC,cAAc,CAAC;CAC1D;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,MAAM,CAAC;QAEd,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KACzC;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,gBAAgB,EAAE,YAAY,CAAC,cAAc,CAAC;IAE9C,YAAY,EAAE,yBAAyB,CAAC,WAAW,CAAC;CACrD;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,WAAW;QAC1B,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,aAAa,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEzC,gBAAgB,EAAE,MAAM,CAAC;QAEzB,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC/B;CACF;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;CAAG;AAE3D,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC;CAClD;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
+{"version":3,"file":"plans.d.ts","sourceRoot":"","sources":["../../src/resources/v1/plans.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2BAA2B,EAAE,gBAAgB,CAAC;IAI7D;;;;;;;;;;OAUG;IACH,UAAU,CAAC,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAKtG;;;;;;;;;;;;;OAaG;IACH,WAAW,CACT,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kCAAkC,EAAE,uBAAuB,CAAC;IAS3E;;;;;;;;;;;;;;OAcG;IACH,aAAa,CACX,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,yBAAyB,CAAC;CAQhF;AAED,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAEvE,MAAM,MAAM,kCAAkC,GAAG,UAAU,CAAC,uBAAuB,CAAC,CAAC;AAErF,MAAM,MAAM,oCAAoC,GAAG,UAAU,CAAC,yBAAyB,CAAC,CAAC;AAEzF,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEzC,IAAI,EAAE,MAAM,CAAC;IAEb,aAAa,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAE9C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAErC,aAAa,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;CAC/C;AAED,yBAAiB,UAAU,CAAC;IAC1B,UAAiB,WAAW;QAC1B,cAAc,EAAE,MAAM,CAAC;QAEvB,0BAA0B,EAAE,MAAM,CAAC,cAAc,CAAC;QAElD,WAAW,EAAE,MAAM,CAAC;QAEpB,uBAAuB,EAAE,MAAM,CAAC,cAAc,CAAC;QAE/C,kBAAkB,EAAE,MAAM,CAAC;QAE3B,IAAI,EAAE,MAAM,CAAC;QAEb,QAAQ,EAAE,MAAM,CAAC;QAEjB,YAAY,EAAE,OAAO,CAAC;QAEtB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC9B;IAED,UAAiB,OAAO;QACtB,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC,IAAI,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,WAAW;QAC1B,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;QAEnC,gBAAgB,EAAE,MAAM,CAAC,cAAc,CAAC;QAExC;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB,yBAAyB,EAAE,MAAM,CAAC;KACnC;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAC3C;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,OAAO,GAAG,OAAO,GAAG,WAAW,GAAG,SAAS,GAAG,MAAM,CAAC;IAElE,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;IAEnC;;OAEG;IACH,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEzC,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,KAAK,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAE7C,UAAU,EAAE,MAAM,CAAC;IAEnB,YAAY,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,uBAAuB,CAAC,cAAc,CAAC;CAC1D;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,MAAM,CAAC;QAEd,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KACzC;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,gBAAgB,EAAE,YAAY,CAAC,cAAc,CAAC;IAE9C,YAAY,EAAE,yBAAyB,CAAC,WAAW,CAAC;CACrD;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,WAAW;QAC1B,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,aAAa,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEzC,gBAAgB,EAAE,MAAM,CAAC;QAEzB,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC/B;CACF;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;CAAG;AAE3D,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC;CAClD;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/v1/plans.js

@@ -7,7 +7,8 @@ const pagination_1 = require("../../core/pagination.js");
 const path_1 = require("../../internal/utils/path.js");
 class Plans extends resource_1.APIResource {
     /**
-     * List all available plans.
+     * List all available plans. This is a Plans (deprecated) endpoint. New clients
+     * should implement using Contracts.
      *
      * @example
      * ```ts
@@ -21,7 +22,8 @@ class Plans extends resource_1.APIResource {
         return this._client.getAPIList('/v1/plans', (pagination_1.CursorPage), { query, ...options });
     }
     /**
-     * Fetch high level details of a specific plan.
+     * Fetch high level details of a specific plan. This is a Plans (deprecated)
+     * endpoint. New clients should implement using Contracts.
      *
      * @example
      * ```ts
@@ -35,7 +37,8 @@ class Plans extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/v1/planDetails/${plan_id}`, options);
     }
     /**
-     * Fetches a list of charges of a specific plan.
+     * Fetches a list of charges of a specific plan. This is a Plans (deprecated)
+     * endpoint. New clients should implement using Contracts.
      *
      * @example
      * ```ts
@@ -53,7 +56,8 @@ class Plans extends resource_1.APIResource {
     }
     /**
      * Fetches a list of customers on a specific plan (by default, only currently
-     * active plans are included)
+     * active plans are included). This is a Plans (deprecated) endpoint. New clients
+     * should implement using Contracts.
      *
      * @example
      * ```ts

package/resources/v1/plans.js.map

@@ -1 +1 @@
-{"version":3,"file":"plans.js","sourceRoot":"","sources":["../../src/resources/v1/plans.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,yDAAuF;AAEvF,uDAAiD;AAEjD,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,uBAA4B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CAAC,MAA4B,EAAE,OAAwB;QAC/D,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,WAAW,CACT,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,mBAAmB,OAAO,UAAU,EACxC,CAAA,uBAAmC,CAAA,EACnC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,mBAAmB,OAAO,YAAY,EAC1C,CAAA,uBAAqC,CAAA,EACrC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AApFD,sBAoFC"}
+{"version":3,"file":"plans.js","sourceRoot":"","sources":["../../src/resources/v1/plans.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,yDAAuF;AAEvF,uDAAiD;AAEjD,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,uBAA4B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU,CAAC,MAA4B,EAAE,OAAwB;QAC/D,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,WAAW,CACT,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,mBAAmB,OAAO,UAAU,EACxC,CAAA,uBAAmC,CAAA,EACnC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,aAAa,CACX,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,mBAAmB,OAAO,YAAY,EAC1C,CAAA,uBAAqC,CAAA,EACrC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AAxFD,sBAwFC"}

package/resources/v1/plans.mjs

@@ -4,7 +4,8 @@ import { CursorPage } from "../../core/pagination.mjs";
 import { path } from "../../internal/utils/path.mjs";
 export class Plans extends APIResource {
     /**
-     * List all available plans.
+     * List all available plans. This is a Plans (deprecated) endpoint. New clients
+     * should implement using Contracts.
      *
      * @example
      * ```ts
@@ -18,7 +19,8 @@ export class Plans extends APIResource {
         return this._client.getAPIList('/v1/plans', (CursorPage), { query, ...options });
     }
     /**
-     * Fetch high level details of a specific plan.
+     * Fetch high level details of a specific plan. This is a Plans (deprecated)
+     * endpoint. New clients should implement using Contracts.
      *
      * @example
      * ```ts
@@ -32,7 +34,8 @@ export class Plans extends APIResource {
         return this._client.get(path `/v1/planDetails/${plan_id}`, options);
     }
     /**
-     * Fetches a list of charges of a specific plan.
+     * Fetches a list of charges of a specific plan. This is a Plans (deprecated)
+     * endpoint. New clients should implement using Contracts.
      *
      * @example
      * ```ts
@@ -50,7 +53,8 @@ export class Plans extends APIResource {
     }
     /**
      * Fetches a list of customers on a specific plan (by default, only currently
-     * active plans are included)
+     * active plans are included). This is a Plans (deprecated) endpoint. New clients
+     * should implement using Contracts.
      *
      * @example
      * ```ts

package/resources/v1/plans.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"plans.mjs","sourceRoot":"","sources":["../../src/resources/v1/plans.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,UAA4B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CAAC,MAA4B,EAAE,OAAwB;QAC/D,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,WAAW,CACT,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,mBAAmB,OAAO,UAAU,EACxC,CAAA,UAAmC,CAAA,EACnC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,mBAAmB,OAAO,YAAY,EAC1C,CAAA,UAAqC,CAAA,EACrC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"plans.mjs","sourceRoot":"","sources":["../../src/resources/v1/plans.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,UAA4B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU,CAAC,MAA4B,EAAE,OAAwB;QAC/D,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,WAAW,CACT,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,mBAAmB,OAAO,UAAU,EACxC,CAAA,UAAmC,CAAA,EACnC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,aAAa,CACX,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,mBAAmB,OAAO,YAAY,EAC1C,CAAA,UAAqC,CAAA,EACrC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF"}