stripe 19.3.1 → 19.4.0-alpha.2

package/types/Mandates.d.ts

@@ -85,7 +85,17 @@ declare module 'stripe' {
         type Type = 'offline' | 'online';
       }
 
-      interface MultiUse {}
+      interface MultiUse {
+        /**
+         * The amount of the payment on a multi use mandate.
+         */
+        amount?: number;
+
+        /**
+         * The currency of the payment on a multi use mandate.
+         */
+        currency?: string;
+      }
 
       interface PaymentMethodDetails {
         acss_debit?: PaymentMethodDetails.AcssDebit;
@@ -114,6 +124,10 @@ declare module 'stripe' {
 
         paypal?: PaymentMethodDetails.Paypal;
 
+        payto?: PaymentMethodDetails.Payto;
+
+        pix?: PaymentMethodDetails.Pix;
+
         revolut_pay?: PaymentMethodDetails.RevolutPay;
 
         sepa_debit?: PaymentMethodDetails.SepaDebit;
@@ -221,10 +235,130 @@ declare module 'stripe' {
            */
           billing_agreement_id: string | null;
 
+          /**
+           * Uniquely identifies this particular PayPal account. You can use this attribute to check whether two PayPal accounts are the same.
+           */
+          fingerprint?: string | null;
+
           /**
            * PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
            */
           payer_id: string | null;
+
+          /**
+           * Owner's verified email. Values are verified or provided by PayPal directly
+           * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
+           */
+          verified_email?: string | null;
+        }
+
+        interface Payto {
+          /**
+           * Amount that will be collected. It is required when `amount_type` is `fixed`.
+           */
+          amount: number | null;
+
+          /**
+           * The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
+           */
+          amount_type: Payto.AmountType;
+
+          /**
+           * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
+           */
+          end_date: string | null;
+
+          /**
+           * The periodicity at which payments will be collected.
+           */
+          payment_schedule: Payto.PaymentSchedule;
+
+          /**
+           * The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
+           */
+          payments_per_period: number | null;
+
+          /**
+           * The purpose for which payments are made. Defaults to retail.
+           */
+          purpose: Payto.Purpose | null;
+
+          /**
+           * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
+           */
+          start_date: string | null;
+        }
+
+        namespace Payto {
+          type AmountType = 'fixed' | 'maximum';
+
+          type PaymentSchedule =
+            | 'adhoc'
+            | 'annual'
+            | 'daily'
+            | 'fortnightly'
+            | 'monthly'
+            | 'quarterly'
+            | 'semi_annual'
+            | 'weekly';
+
+          type Purpose =
+            | 'dependant_support'
+            | 'government'
+            | 'loan'
+            | 'mortgage'
+            | 'other'
+            | 'pension'
+            | 'personal'
+            | 'retail'
+            | 'salary'
+            | 'tax'
+            | 'utility';
+        }
+
+        interface Pix {
+          /**
+           * Determines if the amount includes the IOF tax.
+           */
+          amount_includes_iof?: Pix.AmountIncludesIof;
+
+          /**
+           * Type of amount.
+           */
+          amount_type?: Pix.AmountType;
+
+          /**
+           * Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
+           */
+          end_date?: string;
+
+          /**
+           * Schedule at which the future payments will be charged.
+           */
+          payment_schedule?: Pix.PaymentSchedule;
+
+          /**
+           * Subscription name displayed to buyers in their bank app.
+           */
+          reference?: string;
+
+          /**
+           * Start date of the mandate, in `YYYY-MM-DD`.
+           */
+          start_date?: string;
+        }
+
+        namespace Pix {
+          type AmountIncludesIof = 'always' | 'never';
+
+          type AmountType = 'fixed' | 'maximum';
+
+          type PaymentSchedule =
+            | 'halfyearly'
+            | 'monthly'
+            | 'quarterly'
+            | 'weekly'
+            | 'yearly';
         }
 
         interface RevolutPay {}

package/types/MandatesResource.d.ts

@@ -9,6 +9,29 @@ declare module 'stripe' {
       expand?: Array<string>;
     }
 
+    interface MandateListParams extends PaginationParams {
+      payment_method: string;
+
+      /**
+       * The status of the mandates to retrieve. Status indicates whether or not you can use it to initiate a payment, and can have a value of `active`, `pending`, or `inactive`.
+       */
+      status: MandateListParams.Status;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * The Stripe account ID that the mandates are intended for. Learn more about the [use case for connected accounts payments](https://stripe.com/docs/payments/connected-accounts).
+       */
+      on_behalf_of?: string;
+    }
+
+    namespace MandateListParams {
+      type Status = 'active' | 'inactive' | 'pending';
+    }
+
     class MandatesResource {
       /**
        * Retrieves a Mandate object.
@@ -22,6 +45,14 @@ declare module 'stripe' {
         id: string,
         options?: RequestOptions
       ): Promise<Stripe.Response<Stripe.Mandate>>;
+
+      /**
+       * Retrieves a list of Mandates for a given PaymentMethod.
+       */
+      list(
+        params: MandateListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.Mandate>;
     }
   }
 }

package/types/Margins.d.ts

@@ -0,0 +1,56 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * A (partner) margin represents a specific discount distributed in partner reseller programs to business partners who
+     * resell products and services and earn a discount (margin) for doing so.
+     */
+    interface Margin {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'margin';
+
+      /**
+       * Whether the margin can be applied to invoices, invoice items, or invoice line items. Defaults to `true`.
+       */
+      active: boolean;
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+       */
+      livemode: boolean;
+
+      /**
+       * Set of [key-value pairs](https://stripe.com/docs/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: Stripe.Metadata | null;
+
+      /**
+       * Name of the margin that's displayed on, for example, invoices.
+       */
+      name: string | null;
+
+      /**
+       * Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.
+       */
+      percent_off: number;
+
+      /**
+       * Time at which the object was last updated. Measured in seconds since the Unix epoch.
+       */
+      updated: number;
+    }
+  }
+}

package/types/MarginsResource.d.ts

@@ -0,0 +1,114 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface MarginCreateParams {
+      /**
+       * Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.
+       */
+      percent_off: number;
+
+      /**
+       * Whether the margin can be applied to invoices, invoice items, or invoice line items or not. Defaults to `true`.
+       */
+      active?: boolean;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * Set of [key-value pairs](https://stripe.com/docs/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?: Stripe.MetadataParam;
+
+      /**
+       * Name of the margin, which is displayed to customers, such as on invoices.
+       */
+      name?: string;
+    }
+
+    interface MarginRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface MarginUpdateParams {
+      /**
+       * Whether the margin can be applied to invoices, invoice items, or invoice line items or not.
+       */
+      active?: boolean;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * Set of [key-value pairs](https://stripe.com/docs/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?: Stripe.MetadataParam;
+
+      /**
+       * Name of the margin, which is displayed to customers, such as on invoices.
+       */
+      name?: string;
+    }
+
+    interface MarginListParams extends PaginationParams {
+      /**
+       * Only return margins that are active or inactive. For example, pass `true` to only list active margins.
+       */
+      active?: boolean;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    class MarginsResource {
+      /**
+       * Create a margin object to be used with invoices, invoice items, and invoice line items for a customer to represent a partner discount. A margin has a percent_off which is the percent that will be taken off the subtotal after all items and other discounts and promotions) of any invoices for a customer. Calculation of prorations do not include any partner margins applied on the original invoice item.
+       */
+      create(
+        params: MarginCreateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Margin>>;
+
+      /**
+       * Retrieve a margin object with the given ID.
+       */
+      retrieve(
+        id: string,
+        params?: MarginRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Margin>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Margin>>;
+
+      /**
+       * Update the specified margin object. Certain fields of the margin object are not editable.
+       */
+      update(
+        id: string,
+        params?: MarginUpdateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Margin>>;
+
+      /**
+       * Retrieve a list of your margins.
+       */
+      list(
+        params?: MarginListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.Margin>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.Margin>;
+    }
+  }
+}