stripe 15.12.0-beta.1 → 16.0.0

package/types/TestHelpers/Issuing/TransactionsResource.d.ts

@@ -383,6 +383,11 @@ declare module 'stripe' {
           }
 
           interface PurchaseDetails {
+            /**
+             * Fleet-specific information for transactions using Fleet cards.
+             */
+            fleet?: PurchaseDetails.Fleet;
+
             /**
              * Information about the flight that was purchased with this transaction.
              */
@@ -410,6 +415,112 @@ declare module 'stripe' {
           }
 
           namespace PurchaseDetails {
+            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;
+
+              /**
+               * The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
+               */
+              purchase_type?: Fleet.PurchaseType;
+
+              /**
+               * 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;
+
+              /**
+               * The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
+               */
+              service_type?: Fleet.ServiceType;
+            }
+
+            namespace Fleet {
+              interface CardholderPromptData {
+                /**
+                 * Driver ID.
+                 */
+                driver_id?: string;
+
+                /**
+                 * Odometer reading.
+                 */
+                odometer?: number;
+
+                /**
+                 * 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;
+
+                /**
+                 * User ID.
+                 */
+                user_id?: string;
+
+                /**
+                 * Vehicle number.
+                 */
+                vehicle_number?: string;
+              }
+
+              type PurchaseType =
+                | 'fuel_and_non_fuel_purchase'
+                | 'fuel_purchase'
+                | 'non_fuel_purchase';
+
+              interface ReportedBreakdown {
+                /**
+                 * Breakdown of fuel portion of the purchase.
+                 */
+                fuel?: ReportedBreakdown.Fuel;
+
+                /**
+                 * Breakdown of non-fuel portion of the purchase.
+                 */
+                non_fuel?: ReportedBreakdown.NonFuel;
+
+                /**
+                 * Information about tax included in this transaction.
+                 */
+                tax?: ReportedBreakdown.Tax;
+              }
+
+              namespace ReportedBreakdown {
+                interface Fuel {
+                  /**
+                   * Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
+                   */
+                  gross_amount_decimal?: string;
+                }
+
+                interface NonFuel {
+                  /**
+                   * Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
+                   */
+                  gross_amount_decimal?: string;
+                }
+
+                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;
+
+                  /**
+                   * 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;
+                }
+              }
+
+              type ServiceType =
+                | 'full_service'
+                | 'non_fuel_transaction'
+                | 'self_service';
+            }
+
             interface Flight {
               /**
                * The time that the flight departed.
@@ -472,13 +583,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;
+
+              /**
+               * The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
+               */
+              quantity_decimal?: string;
+
               /**
                * The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
                */
               type?: Fuel.Type;
 
               /**
-               * 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?: Fuel.Unit;
 
@@ -486,11 +607,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;
             }
 
             namespace Fuel {
@@ -501,7 +617,15 @@ declare module 'stripe' {
                 | 'unleaded_regular'
                 | 'unleaded_super';
 
-              type Unit = 'liter' | 'other' | 'us_gallon';
+              type Unit =
+                | 'charging_minute'
+                | 'imperial_gallon'
+                | 'kilogram'
+                | 'kilowatt_hour'
+                | 'liter'
+                | 'other'
+                | 'pound'
+                | 'us_gallon';
             }
 
             interface Lodging {
@@ -909,6 +1033,11 @@ declare module 'stripe' {
           }
 
           interface PurchaseDetails {
+            /**
+             * Fleet-specific information for transactions using Fleet cards.
+             */
+            fleet?: PurchaseDetails.Fleet;
+
             /**
              * Information about the flight that was purchased with this transaction.
              */
@@ -936,6 +1065,112 @@ declare module 'stripe' {
           }
 
           namespace PurchaseDetails {
+            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;
+
+              /**
+               * The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
+               */
+              purchase_type?: Fleet.PurchaseType;
+
+              /**
+               * 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;
+
+              /**
+               * The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
+               */
+              service_type?: Fleet.ServiceType;
+            }
+
+            namespace Fleet {
+              interface CardholderPromptData {
+                /**
+                 * Driver ID.
+                 */
+                driver_id?: string;
+
+                /**
+                 * Odometer reading.
+                 */
+                odometer?: number;
+
+                /**
+                 * 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;
+
+                /**
+                 * User ID.
+                 */
+                user_id?: string;
+
+                /**
+                 * Vehicle number.
+                 */
+                vehicle_number?: string;
+              }
+
+              type PurchaseType =
+                | 'fuel_and_non_fuel_purchase'
+                | 'fuel_purchase'
+                | 'non_fuel_purchase';
+
+              interface ReportedBreakdown {
+                /**
+                 * Breakdown of fuel portion of the purchase.
+                 */
+                fuel?: ReportedBreakdown.Fuel;
+
+                /**
+                 * Breakdown of non-fuel portion of the purchase.
+                 */
+                non_fuel?: ReportedBreakdown.NonFuel;
+
+                /**
+                 * Information about tax included in this transaction.
+                 */
+                tax?: ReportedBreakdown.Tax;
+              }
+
+              namespace ReportedBreakdown {
+                interface Fuel {
+                  /**
+                   * Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
+                   */
+                  gross_amount_decimal?: string;
+                }
+
+                interface NonFuel {
+                  /**
+                   * Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
+                   */
+                  gross_amount_decimal?: string;
+                }
+
+                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;
+
+                  /**
+                   * 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;
+                }
+              }
+
+              type ServiceType =
+                | 'full_service'
+                | 'non_fuel_transaction'
+                | 'self_service';
+            }
+
             interface Flight {
               /**
                * The time that the flight departed.
@@ -998,13 +1233,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;
+
+              /**
+               * The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
+               */
+              quantity_decimal?: string;
+
               /**
                * The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
                */
               type?: Fuel.Type;
 
               /**
-               * 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?: Fuel.Unit;
 
@@ -1012,11 +1257,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;
             }
 
             namespace Fuel {
@@ -1027,7 +1267,15 @@ declare module 'stripe' {
                 | 'unleaded_regular'
                 | 'unleaded_super';
 
-              type Unit = 'liter' | 'other' | 'us_gallon';
+              type Unit =
+                | 'charging_minute'
+                | 'imperial_gallon'
+                | 'kilogram'
+                | 'kilowatt_hour'
+                | 'liter'
+                | 'other'
+                | 'pound'
+                | 'us_gallon';
             }
 
             interface Lodging {

package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts

@@ -39,11 +39,6 @@ declare module 'stripe' {
            * Initiating payment method details for the object.
            */
           initiating_payment_method_details?: ReceivedCreditCreateParams.InitiatingPaymentMethodDetails;
-
-          /**
-           * Details about the network used for the ReceivedCredit.
-           */
-          network_details?: ReceivedCreditCreateParams.NetworkDetails;
         }
 
         namespace ReceivedCreditCreateParams {
@@ -79,27 +74,6 @@ declare module 'stripe' {
           }
 
           type Network = 'ach' | 'us_domestic_wire';
-
-          interface NetworkDetails {
-            /**
-             * Optional fields for `ach`.
-             */
-            ach?: NetworkDetails.Ach;
-
-            /**
-             * The type of flow that originated the ReceivedCredit.
-             */
-            type: 'ach';
-          }
-
-          namespace NetworkDetails {
-            interface Ach {
-              /**
-               * ACH Addenda record
-               */
-              addenda?: string;
-            }
-          }
         }
       }
 

package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts

@@ -39,11 +39,6 @@ declare module 'stripe' {
            * Initiating payment method details for the object.
            */
           initiating_payment_method_details?: ReceivedDebitCreateParams.InitiatingPaymentMethodDetails;
-
-          /**
-           * Details about the network used for the ReceivedDebit.
-           */
-          network_details?: ReceivedDebitCreateParams.NetworkDetails;
         }
 
         namespace ReceivedDebitCreateParams {
@@ -77,27 +72,6 @@ declare module 'stripe' {
               routing_number?: string;
             }
           }
-
-          interface NetworkDetails {
-            /**
-             * Optional fields for `ach`.
-             */
-            ach?: NetworkDetails.Ach;
-
-            /**
-             * The type of flow that originated the ReceivedDebit.
-             */
-            type: 'ach';
-          }
-
-          namespace NetworkDetails {
-            interface Ach {
-              /**
-               * Addenda record data associated with this ReceivedDebit.
-               */
-              addenda?: string;
-            }
-          }
         }
       }
 

package/types/Treasury/OutboundTransfers.d.ts

@@ -76,11 +76,6 @@ declare module 'stripe' {
          */
         metadata: Stripe.Metadata;
 
-        /**
-         * Details about the network used for the OutboundTransfer.
-         */
-        network_details?: OutboundTransfer.NetworkDetails | null;
-
         /**
          * Details about a returned OutboundTransfer. Only set when the status is `returned`.
          */
@@ -187,27 +182,6 @@ declare module 'stripe' {
           }
         }
 
-        interface NetworkDetails {
-          /**
-           * Details about an ACH transaction.
-           */
-          ach?: NetworkDetails.Ach | null;
-
-          /**
-           * The type of flow that originated the OutboundTransfer.
-           */
-          type: 'ach';
-        }
-
-        namespace NetworkDetails {
-          interface Ach {
-            /**
-             * ACH Addenda record
-             */
-            addenda: string | null;
-          }
-        }
-
         interface ReturnedDetails {
           /**
            * Reason for the return.

package/types/Treasury/OutboundTransfersResource.d.ts

@@ -44,11 +44,6 @@ declare module 'stripe' {
          */
         metadata?: Stripe.MetadataParam;
 
-        /**
-         * Details about the network used for the OutboundTransfer.
-         */
-        network_details?: OutboundTransferCreateParams.NetworkDetails;
-
         /**
          * Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is "transfer".
          */
@@ -77,27 +72,6 @@ declare module 'stripe' {
             type Network = 'ach' | 'us_domestic_wire';
           }
         }
-
-        interface NetworkDetails {
-          /**
-           * Optional fields for `ach`.
-           */
-          ach?: NetworkDetails.Ach;
-
-          /**
-           * The type of flow that originated the OutboundTransfer.
-           */
-          type: 'ach';
-        }
-
-        namespace NetworkDetails {
-          interface Ach {
-            /**
-             * Addenda record data associated with this OutboundTransfer.
-             */
-            addenda?: string;
-          }
-        }
       }
 
       interface OutboundTransferRetrieveParams {

package/types/Treasury/ReceivedCredits.d.ts

@@ -66,11 +66,6 @@ declare module 'stripe' {
          */
         network: ReceivedCredit.Network;
 
-        /**
-         * Details specific to the money movement rails.
-         */
-        network_details?: ReceivedCredit.NetworkDetails | null;
-
         /**
          * Details describing when a ReceivedCredit may be reversed.
          */
@@ -240,27 +235,6 @@ declare module 'stripe' {
 
         type Network = 'ach' | 'card' | 'stripe' | 'us_domestic_wire';
 
-        interface NetworkDetails {
-          /**
-           * Details about an ACH transaction.
-           */
-          ach?: NetworkDetails.Ach | null;
-
-          /**
-           * The type of flow that originated the ReceivedCredit.
-           */
-          type: 'ach';
-        }
-
-        namespace NetworkDetails {
-          interface Ach {
-            /**
-             * ACH Addenda record
-             */
-            addenda: string | null;
-          }
-        }
-
         interface ReversalDetails {
           /**
            * Time before which a ReceivedCredit can be reversed.

package/types/Treasury/ReceivedDebits.d.ts

@@ -66,11 +66,6 @@ declare module 'stripe' {
          */
         network: ReceivedDebit.Network;
 
-        /**
-         * Details specific to the money movement rails.
-         */
-        network_details?: ReceivedDebit.NetworkDetails | null;
-
         /**
          * Details describing when a ReceivedDebit might be reversed.
          */
@@ -194,36 +189,10 @@ declare module 'stripe' {
            * Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object.
            */
           payout: string | null;
-
-          /**
-           * The ReceivedCredit that Capital withheld from
-           */
-          received_credit_capital_withholding?: string | null;
         }
 
         type Network = 'ach' | 'card' | 'stripe';
 
-        interface NetworkDetails {
-          /**
-           * Details about an ACH transaction.
-           */
-          ach?: NetworkDetails.Ach | null;
-
-          /**
-           * The type of flow that originated the ReceivedDebit.
-           */
-          type: 'ach';
-        }
-
-        namespace NetworkDetails {
-          interface Ach {
-            /**
-             * ACH Addenda record
-             */
-            addenda: string | null;
-          }
-        }
-
         interface ReversalDetails {
           /**
            * Time before which a ReceivedDebit can be reversed.