stripe 15.12.0-beta.1 → 16.0.0

package/types/Issuing/Authorizations.d.ts

@@ -66,6 +66,16 @@ declare module 'stripe' {
          */
         currency: string;
 
+        /**
+         * Fleet-specific information for authorizations using Fleet cards.
+         */
+        fleet: Authorization.Fleet | null;
+
+        /**
+         * Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed.
+         */
+        fuel: Authorization.Fuel | null;
+
         /**
          * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          */
@@ -151,6 +161,164 @@ declare module 'stripe' {
           | 'online'
           | 'swipe';
 
+        interface Fleet {
+          /**
+           * Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
+           */
+          cardholder_prompt_data: Fleet.CardholderPromptData | null;
+
+          /**
+           * The type of purchase.
+           */
+          purchase_type: Fleet.PurchaseType | null;
+
+          /**
+           * More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
+           */
+          reported_breakdown: Fleet.ReportedBreakdown | null;
+
+          /**
+           * The type of fuel service.
+           */
+          service_type: Fleet.ServiceType | null;
+        }
+
+        namespace Fleet {
+          interface CardholderPromptData {
+            /**
+             * [Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID.
+             * @deprecated
+             */
+            alphanumeric_id: string | null;
+
+            /**
+             * Driver ID.
+             */
+            driver_id: string | null;
+
+            /**
+             * Odometer reading.
+             */
+            odometer: number | null;
+
+            /**
+             * An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
+             */
+            unspecified_id: string | null;
+
+            /**
+             * User ID.
+             */
+            user_id: string | null;
+
+            /**
+             * Vehicle number.
+             */
+            vehicle_number: string | null;
+          }
+
+          type PurchaseType =
+            | 'fuel_and_non_fuel_purchase'
+            | 'fuel_purchase'
+            | 'non_fuel_purchase';
+
+          interface ReportedBreakdown {
+            /**
+             * Breakdown of fuel portion of the purchase.
+             */
+            fuel: ReportedBreakdown.Fuel | null;
+
+            /**
+             * Breakdown of non-fuel portion of the purchase.
+             */
+            non_fuel: ReportedBreakdown.NonFuel | null;
+
+            /**
+             * Information about tax included in this transaction.
+             */
+            tax: ReportedBreakdown.Tax | null;
+          }
+
+          namespace ReportedBreakdown {
+            interface Fuel {
+              /**
+               * Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes.
+               */
+              gross_amount_decimal: string | null;
+            }
+
+            interface NonFuel {
+              /**
+               * Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
+               */
+              gross_amount_decimal: string | null;
+            }
+
+            interface Tax {
+              /**
+               * Amount of state or provincial Sales Tax included in the transaction amount. `null` if not reported by merchant or not subject to tax.
+               */
+              local_amount_decimal: string | null;
+
+              /**
+               * Amount of national Sales Tax or VAT included in the transaction amount. `null` if not reported by merchant or not subject to tax.
+               */
+              national_amount_decimal: string | null;
+            }
+          }
+
+          type ServiceType =
+            | 'full_service'
+            | 'non_fuel_transaction'
+            | 'self_service';
+        }
+
+        interface Fuel {
+          /**
+           * [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
+           */
+          industry_product_code: string | null;
+
+          /**
+           * The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
+           */
+          quantity_decimal: string | null;
+
+          /**
+           * The type of fuel that was purchased.
+           */
+          type: Fuel.Type | null;
+
+          /**
+           * The units for `quantity_decimal`.
+           */
+          unit: Fuel.Unit | null;
+
+          /**
+           * The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
+           */
+          unit_cost_decimal: string | null;
+        }
+
+        namespace Fuel {
+          type Type =
+            | 'diesel'
+            | 'other'
+            | 'unleaded_plus'
+            | 'unleaded_regular'
+            | 'unleaded_super';
+
+          type Unit =
+            | 'charging_minute'
+            | 'imperial_gallon'
+            | 'kilogram'
+            | 'kilowatt_hour'
+            | 'liter'
+            | 'other'
+            | 'pound'
+            | 'us_gallon';
+        }
+
         interface MerchantData {
           /**
            * A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.
@@ -349,11 +517,16 @@ declare module 'stripe' {
           type Reason =
             | 'account_disabled'
             | 'card_active'
+            | 'card_canceled'
+            | 'card_expired'
             | 'card_inactive'
+            | 'cardholder_blocked'
             | 'cardholder_inactive'
             | 'cardholder_verification_required'
+            | 'insecure_authorization_method'
             | 'insufficient_funds'
             | 'not_allowed'
+            | 'pin_blocked'
             | 'spending_controls'
             | 'suspected_fraud'
             | 'verification_failed'

package/types/Issuing/CardholdersResource.d.ts

@@ -40,8 +40,7 @@ declare module 'stripe' {
         metadata?: Stripe.MetadataParam;
 
         /**
-         * The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards.
-         *  While phone number is optional if the cardholder will not be creating EU cards, note that this cardholder will not be eligible for 3DS without a phone number. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details.
+         * The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details.
          */
         phone_number?: string;
 

package/types/Issuing/Cards.d.ts

@@ -138,11 +138,6 @@ declare module 'stripe' {
         interface Shipping {
           address: Stripe.Address;
 
-          /**
-           * Address validation details for the shipment.
-           */
-          address_validation?: Shipping.AddressValidation | null;
-
           /**
            * The delivery company that shipped a card.
            */
@@ -200,35 +195,6 @@ declare module 'stripe' {
         }
 
         namespace Shipping {
-          interface AddressValidation {
-            /**
-             * The address validation capabilities to use.
-             */
-            mode: AddressValidation.Mode;
-
-            /**
-             * The normalized shipping address.
-             */
-            normalized_address: Stripe.Address | null;
-
-            /**
-             * The validation result for the shipping address.
-             */
-            result: AddressValidation.Result | null;
-          }
-
-          namespace AddressValidation {
-            type Mode =
-              | 'disabled'
-              | 'normalization_only'
-              | 'validation_and_normalization';
-
-            type Result =
-              | 'indeterminate'
-              | 'likely_deliverable'
-              | 'likely_undeliverable';
-          }
-
           type Carrier = 'dhl' | 'fedex' | 'royal_mail' | 'usps';
 
           interface Customs {

package/types/Issuing/CardsResource.d.ts

@@ -88,11 +88,6 @@ declare module 'stripe' {
            */
           address: Shipping.Address;
 
-          /**
-           * Address validation settings.
-           */
-          address_validation?: Shipping.AddressValidation;
-
           /**
            * Customs information for the shipment.
            */
@@ -157,20 +152,6 @@ declare module 'stripe' {
             state?: string;
           }
 
-          interface AddressValidation {
-            /**
-             * The address validation capabilities to use.
-             */
-            mode: AddressValidation.Mode;
-          }
-
-          namespace AddressValidation {
-            type Mode =
-              | 'disabled'
-              | 'normalization_only'
-              | 'validation_and_normalization';
-          }
-
           interface Customs {
             /**
              * The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe.
@@ -1165,11 +1146,6 @@ declare module 'stripe' {
          */
         pin?: CardUpdateParams.Pin;
 
-        /**
-         * Updated shipping information for the card.
-         */
-        shipping?: CardUpdateParams.Shipping;
-
         /**
          * Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
          */
@@ -1191,107 +1167,6 @@ declare module 'stripe' {
           encrypted_number?: string;
         }
 
-        interface Shipping {
-          /**
-           * The address that the card is shipped to.
-           */
-          address: Shipping.Address;
-
-          /**
-           * Address validation settings.
-           */
-          address_validation?: Shipping.AddressValidation;
-
-          /**
-           * Customs information for the shipment.
-           */
-          customs?: Shipping.Customs;
-
-          /**
-           * The name printed on the shipping label when shipping the card.
-           */
-          name: string;
-
-          /**
-           * Phone number of the recipient of the shipment.
-           */
-          phone_number?: string;
-
-          /**
-           * Whether a signature is required for card delivery.
-           */
-          require_signature?: boolean;
-
-          /**
-           * Shipment service.
-           */
-          service?: Shipping.Service;
-
-          /**
-           * Packaging options.
-           */
-          type?: Shipping.Type;
-        }
-
-        namespace Shipping {
-          interface Address {
-            /**
-             * City, district, suburb, town, or village.
-             */
-            city: string;
-
-            /**
-             * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
-             */
-            country: string;
-
-            /**
-             * Address line 1 (e.g., street, PO Box, or company name).
-             */
-            line1: string;
-
-            /**
-             * Address line 2 (e.g., apartment, suite, unit, or building).
-             */
-            line2?: string;
-
-            /**
-             * ZIP or postal code.
-             */
-            postal_code: string;
-
-            /**
-             * State, county, province, or region.
-             */
-            state?: string;
-          }
-
-          interface AddressValidation {
-            /**
-             * The address validation capabilities to use.
-             */
-            mode: AddressValidation.Mode;
-          }
-
-          namespace AddressValidation {
-            type Mode =
-              | 'disabled'
-              | 'normalization_only'
-              | 'validation_and_normalization';
-          }
-
-          interface Customs {
-            /**
-             * The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe.
-             */
-            eori_number?: string;
-          }
-
-          type Service = 'express' | 'priority' | 'standard';
-
-          type Type = 'bulk' | 'individual';
-        }
-
         interface SpendingControls {
           /**
            * Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.

package/types/Issuing/Transactions.d.ts

@@ -202,6 +202,11 @@ declare module 'stripe' {
         }
 
         interface PurchaseDetails {
+          /**
+           * Fleet-specific information for transactions using Fleet cards.
+           */
+          fleet: PurchaseDetails.Fleet | null;
+
           /**
            * Information about the flight that was purchased with this transaction.
            */
@@ -229,6 +234,102 @@ declare module 'stripe' {
         }
 
         namespace PurchaseDetails {
+          interface Fleet {
+            /**
+             * Answers to prompts presented to cardholder at point of sale.
+             */
+            cardholder_prompt_data: Fleet.CardholderPromptData | null;
+
+            /**
+             * The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
+             */
+            purchase_type: string | null;
+
+            /**
+             * More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
+             */
+            reported_breakdown: Fleet.ReportedBreakdown | null;
+
+            /**
+             * The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
+             */
+            service_type: string | null;
+          }
+
+          namespace Fleet {
+            interface CardholderPromptData {
+              /**
+               * Driver ID.
+               */
+              driver_id: string | null;
+
+              /**
+               * Odometer reading.
+               */
+              odometer: number | null;
+
+              /**
+               * An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
+               */
+              unspecified_id: string | null;
+
+              /**
+               * User ID.
+               */
+              user_id: string | null;
+
+              /**
+               * Vehicle number.
+               */
+              vehicle_number: string | null;
+            }
+
+            interface ReportedBreakdown {
+              /**
+               * Breakdown of fuel portion of the purchase.
+               */
+              fuel: ReportedBreakdown.Fuel | null;
+
+              /**
+               * Breakdown of non-fuel portion of the purchase.
+               */
+              non_fuel: ReportedBreakdown.NonFuel | null;
+
+              /**
+               * Information about tax included in this transaction.
+               */
+              tax: ReportedBreakdown.Tax | null;
+            }
+
+            namespace ReportedBreakdown {
+              interface Fuel {
+                /**
+                 * Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
+                 */
+                gross_amount_decimal: string | null;
+              }
+
+              interface NonFuel {
+                /**
+                 * Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
+                 */
+                gross_amount_decimal: string | null;
+              }
+
+              interface Tax {
+                /**
+                 * Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
+                 */
+                local_amount_decimal: string | null;
+
+                /**
+                 * Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
+                 */
+                national_amount_decimal: string | null;
+              }
+            }
+          }
+
           interface Flight {
             /**
              * The time that the flight departed.
@@ -291,13 +392,23 @@ declare module 'stripe' {
           }
 
           interface Fuel {
+            /**
+             * [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
+             */
+            industry_product_code: string | null;
+
+            /**
+             * The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
+             */
+            quantity_decimal: string | null;
+
             /**
              * The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
              */
             type: string;
 
             /**
-             * The units for `volume_decimal`. One of `liter`, `us_gallon`, or `other`.
+             * The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
              */
             unit: string;
 
@@ -305,11 +416,6 @@ declare module 'stripe' {
              * The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
              */
             unit_cost_decimal: string;
-
-            /**
-             * The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places.
-             */
-            volume_decimal: string | null;
           }
 
           interface Lodging {

package/types/LineItems.d.ts

@@ -56,13 +56,6 @@ declare module 'stripe' {
        */
       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.
        */

package/types/Mandates.d.ts

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