stripe 19.2.1 → 19.3.0-alpha.2

package/types/Issuing/DisputeSettlementDetails.d.ts

@@ -0,0 +1,85 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Issuing {
+      /**
+       * Represents a record from the card network of a money movement or change in state for an Issuing dispute. These records are included in the settlement reports that we receive from networks and expose to users as Settlement objects.
+       */
+      interface DisputeSettlementDetail {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'issuing.dispute_settlement_detail';
+
+        /**
+         * Disputed amount in the card's currency and in the smallest currency unit. Usually the amount of the transaction, but can differ (usually because of currency fluctuation).
+         */
+        amount: number;
+
+        /**
+         * The card used to make the original transaction.
+         */
+        card: string;
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * The currency the original transaction was made in. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
+        currency: string;
+
+        /**
+         * The ID of the linked dispute.
+         */
+        dispute: string;
+
+        /**
+         * The type of event corresponding to this dispute settlement detail, representing the stage in the dispute network lifecycle.
+         */
+        event_type: DisputeSettlementDetail.EventType;
+
+        /**
+         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+         */
+        livemode: boolean;
+
+        /**
+         * The card network for this dispute settlement detail. One of ["visa", "mastercard", "maestro"]
+         */
+        network: DisputeSettlementDetail.Network;
+
+        /**
+         * Details about the transaction, such as processing dates, set by the card network.
+         */
+        network_data: DisputeSettlementDetail.NetworkData | null;
+
+        /**
+         * The ID of the linked card network settlement.
+         */
+        settlement: string | null;
+      }
+
+      namespace DisputeSettlementDetail {
+        type EventType = 'filing' | 'loss' | 'representment' | 'win';
+
+        type Network = 'maestro' | 'mastercard' | 'visa';
+
+        interface NetworkData {
+          /**
+           * The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.
+           */
+          processing_date: string | null;
+        }
+      }
+    }
+  }
+}

package/types/Issuing/DisputeSettlementDetailsResource.d.ts

@@ -0,0 +1,52 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Issuing {
+      interface DisputeSettlementDetailRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface DisputeSettlementDetailListParams extends PaginationParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Select the Issuing dispute settlement details for the given settlement.
+         */
+        settlement?: string;
+      }
+
+      class DisputeSettlementDetailsResource {
+        /**
+         * Retrieves an Issuing DisputeSettlementDetail object.
+         */
+        retrieve(
+          id: string,
+          params?: DisputeSettlementDetailRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Issuing.DisputeSettlementDetail>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Issuing.DisputeSettlementDetail>>;
+
+        /**
+         * Returns a list of Issuing DisputeSettlementDetail objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
+         */
+        list(
+          params?: DisputeSettlementDetailListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Issuing.DisputeSettlementDetail>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Issuing.DisputeSettlementDetail>;
+      }
+    }
+  }
+}

package/types/Issuing/FraudLiabilityDebits.d.ts

@@ -0,0 +1,52 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Issuing {
+      /**
+       * A fraud liability debit occurs when Stripe debits a platform's account for fraud losses on Issuing transactions.
+       */
+      interface FraudLiabilityDebit {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'issuing.fraud_liability_debit';
+
+        /**
+         * Debited amount. This is equal to the disputed amount and is given in the card's currency and in the smallest currency unit.
+         */
+        amount: number;
+
+        /**
+         * ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this debit.
+         */
+        balance_transaction: string | Stripe.BalanceTransaction | null;
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * The currency of the debit. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
+        currency: string;
+
+        /**
+         * The ID of the linked dispute.
+         */
+        dispute: string;
+
+        /**
+         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+         */
+        livemode: boolean;
+      }
+    }
+  }
+}

package/types/Issuing/FraudLiabilityDebitsResource.d.ts

@@ -0,0 +1,52 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Issuing {
+      interface FraudLiabilityDebitRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface FraudLiabilityDebitListParams extends PaginationParams {
+        /**
+         * Only return Issuing Fraud Liability Debits that were created during the given date interval.
+         */
+        created?: Stripe.RangeQueryParam | number;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class FraudLiabilityDebitsResource {
+        /**
+         * Retrieves an Issuing FraudLiabilityDebit object.
+         */
+        retrieve(
+          id: string,
+          params?: FraudLiabilityDebitRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Issuing.FraudLiabilityDebit>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Issuing.FraudLiabilityDebit>>;
+
+        /**
+         * Returns a list of Issuing FraudLiabilityDebit objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
+         */
+        list(
+          params?: FraudLiabilityDebitListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Issuing.FraudLiabilityDebit>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Issuing.FraudLiabilityDebit>;
+      }
+    }
+  }
+}

package/types/Issuing/Settlements.d.ts

@@ -0,0 +1,113 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Issuing {
+      /**
+       * When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.
+       */
+      interface Settlement {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'issuing.settlement';
+
+        /**
+         * The Bank Identification Number reflecting this settlement record.
+         */
+        bin: string;
+
+        /**
+         * The date that the transactions are cleared and posted to user's accounts.
+         */
+        clearing_date: number;
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
+        currency: string;
+
+        /**
+         * The total interchange received as reimbursement for the transactions.
+         */
+        interchange_fees_amount: 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;
+
+        /**
+         * The total net amount required to settle with the network.
+         */
+        net_total_amount: number;
+
+        /**
+         * The card network for this settlement report. One of ["visa", "maestro"]
+         */
+        network: Settlement.Network;
+
+        /**
+         * The total amount of fees owed to the network.
+         */
+        network_fees_amount: number;
+
+        /**
+         * The Settlement Identification Number assigned by the network.
+         */
+        network_settlement_identifier: string;
+
+        /**
+         * The total amount of any additional fees assessed by the card network.
+         */
+        other_fees_amount?: number;
+
+        /**
+         * The total number of additional fees assessed by the card network.
+         */
+        other_fees_count?: number;
+
+        /**
+         * One of `international` or `uk_national_net`.
+         */
+        settlement_service: string;
+
+        /**
+         * The current processing status of this settlement.
+         */
+        status: Settlement.Status;
+
+        /**
+         * The total transaction amount reflected in this settlement.
+         */
+        transaction_amount: number;
+
+        /**
+         * The total number of transactions reflected in this settlement.
+         */
+        transaction_count: number;
+      }
+
+      namespace Settlement {
+        type Network = 'maestro' | 'visa';
+
+        type Status = 'complete' | 'pending';
+      }
+    }
+  }
+}

package/types/Issuing/Transactions.d.ts

@@ -98,6 +98,11 @@ declare module 'stripe' {
          */
         purchase_details?: Transaction.PurchaseDetails | null;
 
+        /**
+         * The ID of the [settlement](https://stripe.com/docs/api/issuing/settlements) to which this transaction belongs.
+         */
+        settlement?: string | Stripe.Issuing.Settlement | null;
+
         /**
          * [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null.
          */

package/types/Issuing/TransactionsResource.d.ts

@@ -43,6 +43,11 @@ declare module 'stripe' {
          */
         expand?: Array<string>;
 
+        /**
+         * Only return transactions that are associated with the given settlement.
+         */
+        settlement?: string;
+
         /**
          * Only return transactions that have the given type. One of `capture` or `refund`.
          */

package/types/LineItems.d.ts

@@ -16,6 +16,8 @@ declare module 'stripe' {
        */
       object: 'item';
 
+      adjustable_quantity?: LineItem.AdjustableQuantity | null;
+
       /**
        * Total discount amount applied. If no discounts were applied, defaults to 0.
        */
@@ -51,16 +53,35 @@ declare module 'stripe' {
        */
       discounts?: Array<LineItem.Discount>;
 
+      display?: LineItem.Display;
+
+      /**
+       * 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;
+
       /**
        * The price used to generate the line item.
        */
       price: Stripe.Price | null;
 
+      /**
+       * The ID of the product for this line item.
+       *
+       * This will always be the same as `price.product`.
+       */
+      product?: string | Stripe.Product | Stripe.DeletedProduct;
+
       /**
        * The quantity of products being purchased.
        */
       quantity: number | null;
 
+      /**
+       * The tax calculation identifiers of the line item.
+       */
+      tax_calculation_reference?: LineItem.TaxCalculationReference | null;
+
       /**
        * The taxes applied to the line item.
        */
@@ -68,6 +89,14 @@ declare module 'stripe' {
     }
 
     namespace LineItem {
+      interface AdjustableQuantity {
+        enabled: boolean;
+
+        maximum: number | null;
+
+        minimum: number | null;
+      }
+
       interface Discount {
         /**
          * The amount discounted.
@@ -83,6 +112,14 @@ declare module 'stripe' {
         discount: Stripe.Discount;
       }
 
+      interface Display {
+        description: string | null;
+
+        images: Array<string>;
+
+        name: string;
+      }
+
       interface Tax {
         /**
          * Amount of tax applied for this rate.
@@ -125,6 +162,18 @@ declare module 'stripe' {
           | 'taxable_basis_reduced'
           | 'zero_rated';
       }
+
+      interface TaxCalculationReference {
+        /**
+         * The calculation identifier for tax calculation response.
+         */
+        calculation_id: string | null;
+
+        /**
+         * The calculation identifier for tax calculation response line item.
+         */
+        calculation_item_id: string | null;
+      }
     }
   }
 }

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>;
     }
   }
 }