stripe 22.5.0 → 22.6.0-alpha.2

package/cjs/resources/PaymentMethods.js

@@ -50,12 +50,32 @@ class PaymentMethodResource extends StripeResource_js_1.StripeResource {
     attach(id, params, options) {
         return this._makeRequest('POST', `/v1/payment_methods/${encodeURIComponent(id)}/attach`, params, options);
     }
+    /**
+     * Retrieves a PaymentMethod's Balance.
+     */
+    checkBalance(id, params, options) {
+        return this._makeRequest('POST', `/v1/payment_methods/${encodeURIComponent(id)}/check_balance`, params, options);
+    }
     /**
      * Detaches a PaymentMethod object from a Customer. Detachment is permanent and irreversible — once detached, a PaymentMethod can no longer be used for payments or re-attached to a Customer.
      */
     detach(id, params, options) {
         return this._makeRequest('POST', `/v1/payment_methods/${encodeURIComponent(id)}/detach`, params, options);
     }
+    serializeBatchAttach(paymentMethod, params = {}, options = {}) {
+        const itemId = this._stripe._platformFunctions.uuid4();
+        const stripeVersion = options.apiVersion || this._stripe.getApiField('version');
+        const entry = {
+            id: itemId,
+            params: params,
+            stripe_version: stripeVersion,
+        };
+        entry.path_params = { payment_method: paymentMethod };
+        if (options.stripeContext) {
+            entry.context = options.stripeContext;
+        }
+        return JSON.stringify(entry);
+    }
 }
 exports.PaymentMethodResource = PaymentMethodResource;
 //# sourceMappingURL=PaymentMethods.js.map

package/cjs/resources/PaymentMethods.js.map

@@ -1 +1 @@
-{"version":3,"file":"PaymentMethods.js","sourceRoot":"","sources":["../../src/resources/PaymentMethods.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,4DAAoD;AAepD,MAAa,qBAAsB,SAAQ,kCAAc;IACvD;;OAEG;IACH,IAAI,CACF,MAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,OAAO,EAAE;YACtE,UAAU,EAAE,MAAM;SACnB,CAAQ,CAAC;IACZ,CAAC;IACD;;;;OAIG;IACH,MAAM,CACJ,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,qBAAqB,EACrB,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC/C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC/C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,SAAS,EACtD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,SAAS,EACtD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AApGD,sDAoGC"}
+{"version":3,"file":"PaymentMethods.js","sourceRoot":"","sources":["../../src/resources/PaymentMethods.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,4DAAoD;AAiBpD,MAAa,qBAAsB,SAAQ,kCAAc;IACvD;;OAEG;IACH,IAAI,CACF,MAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,OAAO,EAAE;YACtE,UAAU,EAAE,MAAM;SACnB,CAAQ,CAAC;IACZ,CAAC;IACD;;;;OAIG;IACH,MAAM,CACJ,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,qBAAqB,EACrB,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC/C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC/C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,SAAS,EACtD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,YAAY,CACV,EAAU,EACV,MAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,gBAAgB,EAC7D,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,SAAS,EACtD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD,oBAAoB,CAClB,aAAqB,EACrB,SAAkC,EAAE,EACpC,UAAyD,EAAE;QAE3D,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC;QACvD,MAAM,aAAa,GACjB,OAAO,CAAC,UAAU,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAE5D,MAAM,KAAK,GAA4B;YACrC,EAAE,EAAE,MAAM;YACV,MAAM,EAAE,MAAM;YACd,cAAc,EAAE,aAAa;SAC9B,CAAC;QACF,KAAK,CAAC,WAAW,GAAG,EAAC,cAAc,EAAE,aAAa,EAAC,CAAC;QACpD,IAAI,OAAO,CAAC,aAAa,EAAE;YACzB,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;SACvC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;CACF;AAvID,sDAuIC"}

package/cjs/resources/PaymentPlans.d.ts

@@ -0,0 +1,427 @@
+import { StripeResource } from '../StripeResource.js';
+import { MetadataParam, OtherString, PaginationParams, Metadata } from '../shared.js';
+import { RequestOptions, ApiListPromise, Response } from '../lib.js';
+export declare class PaymentPlanResource extends StripeResource {
+    /**
+     * Returns a list of payment plans.
+     */
+    list(params?: PaymentPlanListParams, options?: RequestOptions): ApiListPromise<PaymentPlan>;
+    /**
+     * Creates a payment plan that splits a single invoice obligation into installments with their own due dates and amounts.
+     */
+    create(params: PaymentPlanCreateParams, options?: RequestOptions): Promise<Response<PaymentPlan>>;
+    /**
+     * Retrieves the payment plan with the given ID.
+     */
+    retrieve(id: string, params?: PaymentPlanRetrieveParams, options?: RequestOptions): Promise<Response<PaymentPlan>>;
+    /**
+     * Updates the schedule or metadata of an existing payment plan. Only unpaid installments can be updated.
+     */
+    update(id: string, params?: PaymentPlanUpdateParams, options?: RequestOptions): Promise<Response<PaymentPlan>>;
+}
+export interface PaymentPlan {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'payment_plan';
+    /**
+     * The list of objects this payment plan collects against.
+     */
+    collects_on: Array<PaymentPlan.CollectsOn>;
+    /**
+     * Time at which the object was created. Measured in seconds since the Unix epoch.
+     */
+    created: number;
+    /**
+     * The list of installments derived from the schedule. Each installment tracks an individual payment obligation.
+     */
+    installments: Array<PaymentPlan.Installment>;
+    /**
+     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+     */
+    livemode: boolean;
+    /**
+     * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+     */
+    metadata: Metadata | null;
+    schedule: PaymentPlan.Schedule;
+}
+export declare namespace PaymentPlan {
+    interface CollectsOn {
+        invoice_details: CollectsOn.InvoiceDetails;
+        /**
+         * The type of object this plan collects against. Currently always `invoice_details`.
+         */
+        type: string;
+    }
+    interface Installment {
+        /**
+         * Amount owed for this installment, in the smallest currency unit.
+         */
+        amount_due: number;
+        /**
+         * Amount forgiven for this installment, in the smallest currency unit.
+         */
+        amount_forgiven: number;
+        /**
+         * Amount already paid toward this installment, in the smallest currency unit.
+         */
+        amount_paid: number;
+        /**
+         * Three-letter ISO currency code.
+         */
+        currency: string;
+        /**
+         * A description of this installment.
+         */
+        description: string;
+        /**
+         * Unix timestamp when this installment is due. Omitted for installments with no due date.
+         */
+        due_date?: number;
+        /**
+         * Unique identifier for the installment.
+         */
+        id?: string;
+        /**
+         * Unix timestamp when this installment was paid.
+         */
+        paid_at?: number;
+        /**
+         * The status of this installment. One of `open`, `paid`, `past_due`, or `canceled`.
+         */
+        status: string;
+    }
+    interface Schedule {
+        amounts_due: Schedule.AmountsDue;
+        /**
+         * The type of schedule. Currently always `amounts_due`.
+         */
+        type: string;
+    }
+    namespace CollectsOn {
+        interface InvoiceDetails {
+            /**
+             * The ID of the invoice this plan collects against.
+             */
+            invoice: string;
+        }
+    }
+    namespace Schedule {
+        interface AmountsDue {
+            /**
+             * The list of installment schedule entries.
+             */
+            amounts: Array<AmountsDue.Amount>;
+        }
+        namespace AmountsDue {
+            interface Amount {
+                /**
+                 * A description of this schedule entry.
+                 */
+                description: string;
+                due_date?: Amount.DueDate;
+                fixed_amount?: Amount.FixedAmount;
+                /**
+                 * Unique identifier for this schedule entry.
+                 */
+                id?: string;
+                /**
+                 * Percentage of the invoice total for this entry (0–100). Present when type is `percentage`.
+                 */
+                percentage?: number;
+                /**
+                 * The type of this schedule entry. Either `fixed_amount` or `percentage`.
+                 */
+                type: string;
+            }
+            namespace Amount {
+                interface DueDate {
+                    /**
+                     * Unix timestamp of the due date. Present when type is `absolute`.
+                     */
+                    absolute?: number;
+                    relative?: DueDate.Relative;
+                    /**
+                     * The type of due date. Either `absolute` or `relative`.
+                     */
+                    type: string;
+                }
+                interface FixedAmount {
+                    /**
+                     * Fixed amount for this entry, in the smallest currency unit.
+                     */
+                    amount: number;
+                    /**
+                     * Three-letter ISO currency code.
+                     */
+                    currency: string;
+                }
+                namespace DueDate {
+                    interface Relative {
+                        /**
+                         * The number of intervals after the invoice is finalized that this entry is due.
+                         */
+                        count: number;
+                        /**
+                         * The interval unit: `day`, `week`, `month`, or `year`.
+                         */
+                        interval: string;
+                    }
+                }
+            }
+        }
+    }
+}
+export interface PaymentPlanCreateParams {
+    /**
+     * The invoice(s) this payment plan collects on. Currently must contain exactly one invoice entry.
+     */
+    collects_on: Array<PaymentPlanCreateParams.CollectsOn>;
+    /**
+     * The schedule defining how to split the invoice total into installments.
+     */
+    schedule: PaymentPlanCreateParams.Schedule;
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+    /**
+     * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+     */
+    metadata?: MetadataParam;
+}
+export declare namespace PaymentPlanCreateParams {
+    interface CollectsOn {
+        /**
+         * Details of the invoice this payment plan collects on.
+         */
+        invoice_details: CollectsOn.InvoiceDetails;
+        /**
+         * The type of object this plan collects on. Currently always `invoice_details`.
+         */
+        type: 'invoice_details';
+    }
+    interface Schedule {
+        /**
+         * Required when type is 'amounts_due'.
+         */
+        amounts_due: Schedule.AmountsDue;
+        /**
+         * The schedule type. Currently only 'amounts_due' is supported.
+         */
+        type: 'amounts_due';
+    }
+    namespace CollectsOn {
+        interface InvoiceDetails {
+            /**
+             * The ID of the invoice.
+             */
+            invoice: string;
+        }
+    }
+    namespace Schedule {
+        interface AmountsDue {
+            /**
+             * The list of installment entries.
+             */
+            amounts: Array<AmountsDue.Amount>;
+        }
+        namespace AmountsDue {
+            interface Amount {
+                /**
+                 * Optional description for this installment.
+                 */
+                description?: string;
+                /**
+                 * When this installment is due.
+                 */
+                due_date?: Amount.DueDate;
+                /**
+                 * Required when type is 'fixed_amount'.
+                 */
+                fixed_amount?: Amount.FixedAmount;
+                /**
+                 * Optional stable identifier for the installment entry.
+                 */
+                id?: string;
+                /**
+                 * The installment percentage of the total. Required when type is 'percentage'.
+                 */
+                percentage?: number;
+                /**
+                 * Either 'fixed_amount' or 'percentage'.
+                 */
+                type: Amount.Type;
+            }
+            namespace Amount {
+                interface DueDate {
+                    /**
+                     * Unix timestamp. Required when type is 'absolute'.
+                     */
+                    absolute?: number;
+                    /**
+                     * Required when type is 'relative'.
+                     */
+                    relative?: DueDate.Relative;
+                    /**
+                     * Either 'absolute' or 'relative'.
+                     */
+                    type: DueDate.Type;
+                }
+                interface FixedAmount {
+                    /**
+                     * The installment amount in minor units.
+                     */
+                    amount: number;
+                    /**
+                     * Three-letter ISO currency code.
+                     */
+                    currency: string;
+                }
+                type Type = 'fixed_amount' | 'percentage' | OtherString;
+                namespace DueDate {
+                    interface Relative {
+                        /**
+                         * The number of intervals after finalization.
+                         */
+                        count: number;
+                        /**
+                         * The interval unit.
+                         */
+                        interval: Relative.Interval;
+                    }
+                    type Type = 'absolute' | 'relative' | OtherString;
+                    namespace Relative {
+                        type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
+                    }
+                }
+            }
+        }
+    }
+}
+export interface PaymentPlanRetrieveParams {
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+}
+export interface PaymentPlanUpdateParams {
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+    /**
+     * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+     */
+    metadata?: MetadataParam;
+    /**
+     * The new schedule for this payment plan.
+     */
+    schedule?: PaymentPlanUpdateParams.Schedule;
+}
+export declare namespace PaymentPlanUpdateParams {
+    interface Schedule {
+        /**
+         * Required when type is 'amounts_due'.
+         */
+        amounts_due: Schedule.AmountsDue;
+        /**
+         * The schedule type. Currently only 'amounts_due' is supported.
+         */
+        type: 'amounts_due';
+    }
+    namespace Schedule {
+        interface AmountsDue {
+            /**
+             * The list of installment entries.
+             */
+            amounts: Array<AmountsDue.Amount>;
+        }
+        namespace AmountsDue {
+            interface Amount {
+                /**
+                 * Optional description for this installment.
+                 */
+                description?: string;
+                /**
+                 * When this installment is due.
+                 */
+                due_date?: Amount.DueDate;
+                /**
+                 * Required when type is 'fixed_amount'.
+                 */
+                fixed_amount?: Amount.FixedAmount;
+                /**
+                 * Optional stable identifier for the installment entry.
+                 */
+                id?: string;
+                /**
+                 * The installment percentage of the total. Required when type is 'percentage'.
+                 */
+                percentage?: number;
+                /**
+                 * Either 'fixed_amount' or 'percentage'.
+                 */
+                type: Amount.Type;
+            }
+            namespace Amount {
+                interface DueDate {
+                    /**
+                     * Unix timestamp. Required when type is 'absolute'.
+                     */
+                    absolute?: number;
+                    /**
+                     * Required when type is 'relative'.
+                     */
+                    relative?: DueDate.Relative;
+                    /**
+                     * Either 'absolute' or 'relative'.
+                     */
+                    type: DueDate.Type;
+                }
+                interface FixedAmount {
+                    /**
+                     * The installment amount in minor units.
+                     */
+                    amount: number;
+                    /**
+                     * Three-letter ISO currency code.
+                     */
+                    currency: string;
+                }
+                type Type = 'fixed_amount' | 'percentage' | OtherString;
+                namespace DueDate {
+                    interface Relative {
+                        /**
+                         * The number of intervals after finalization.
+                         */
+                        count: number;
+                        /**
+                         * The interval unit.
+                         */
+                        interval: Relative.Interval;
+                    }
+                    type Type = 'absolute' | 'relative' | OtherString;
+                    namespace Relative {
+                        type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
+                    }
+                }
+            }
+        }
+    }
+}
+export interface PaymentPlanListParams extends PaginationParams {
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+    /**
+     * Only return payment plans associated with the given invoice.
+     */
+    invoice?: string;
+}

package/cjs/resources/PaymentPlans.js

@@ -0,0 +1,35 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentPlanResource = void 0;
+const StripeResource_js_1 = require("../StripeResource.js");
+class PaymentPlanResource extends StripeResource_js_1.StripeResource {
+    /**
+     * Returns a list of payment plans.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v1/payment_plans', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Creates a payment plan that splits a single invoice obligation into installments with their own due dates and amounts.
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v1/payment_plans', params, options);
+    }
+    /**
+     * Retrieves the payment plan with the given ID.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v1/payment_plans/${encodeURIComponent(id)}`, params, options);
+    }
+    /**
+     * Updates the schedule or metadata of an existing payment plan. Only unpaid installments can be updated.
+     */
+    update(id, params, options) {
+        return this._makeRequest('POST', `/v1/payment_plans/${encodeURIComponent(id)}`, params, options);
+    }
+}
+exports.PaymentPlanResource = PaymentPlanResource;
+//# sourceMappingURL=PaymentPlans.js.map

package/cjs/resources/PaymentPlans.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PaymentPlans.js","sourceRoot":"","sources":["../../src/resources/PaymentPlans.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,4DAAoD;AASpD,MAAa,mBAAoB,SAAQ,kCAAc;IACrD;;OAEG;IACH,IAAI,CACF,MAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,OAAO,EAAE;YACpE,UAAU,EAAE,MAAM;SACnB,CAAQ,CAAC;IACZ,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,MAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,mBAAmB,EACnB,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,qBAAqB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC7C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,qBAAqB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC7C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAxDD,kDAwDC"}