stripe 17.5.0 → 17.6.0-beta.2

package/types/Issuing/DisputeSettlementDetails.d.ts

@@ -0,0 +1,73 @@
+// 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;
+
+        /**
+         * The ID of the linked card network settlement.
+         */
+        settlement: string | null;
+      }
+
+      namespace DisputeSettlementDetail {
+        type EventType = 'filing' | 'loss' | 'representment' | 'win';
+
+        type Network = 'maestro' | 'mastercard' | 'visa';
+      }
+    }
+  }
+}

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,103 @@
+// 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: 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: 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: number;
+
+        /**
+         * The Settlement Identification Number assigned by the network.
+         */
+        network_settlement_identifier: string;
+
+        /**
+         * One of `international` or `uk_national_net`.
+         */
+        settlement_service: string;
+
+        /**
+         * The current processing status of this settlement.
+         */
+        status: Settlement.Status;
+
+        /**
+         * The total number of transactions reflected in this settlement.
+         */
+        transaction_count: number;
+
+        /**
+         * The total transaction amount reflected in this settlement.
+         */
+        transaction_volume: number;
+      }
+
+      namespace Settlement {
+        type Network = 'maestro' | 'visa';
+
+        type Status = 'complete' | 'pending';
+      }
+    }
+  }
+}

package/types/Issuing/Transactions.d.ts

@@ -98,6 +98,8 @@ declare module 'stripe' {
          */
         purchase_details?: Transaction.PurchaseDetails | null;
 
+        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.
          */
@@ -176,7 +178,7 @@ declare module 'stripe' {
           /**
            * The seller's tax identification number. Currently populated for French merchants only.
            */
-          tax_id?: string | null;
+          tax_id: string | null;
 
           /**
            * An ID assigned by the seller to the location of the sale.

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,11 +53,25 @@ 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.
        */
@@ -68,6 +84,14 @@ declare module 'stripe' {
     }
 
     namespace LineItem {
+      interface AdjustableQuantity {
+        enabled: boolean;
+
+        maximum: number | null;
+
+        minimum: number | null;
+      }
+
       interface Discount {
         /**
          * The amount discounted.
@@ -83,6 +107,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.

package/types/Mandates.d.ts

@@ -108,6 +108,8 @@ declare module 'stripe' {
 
         paypal?: PaymentMethodDetails.Paypal;
 
+        payto?: PaymentMethodDetails.Payto;
+
         revolut_pay?: PaymentMethodDetails.RevolutPay;
 
         sepa_debit?: PaymentMethodDetails.SepaDebit;
@@ -209,10 +211,85 @@ 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 RevolutPay {}

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