stripe 20.2.0-alpha.1 → 20.2.0-beta.1

package/types/Reserve/Holds.d.ts

@@ -0,0 +1,104 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Reserve {
+      /**
+       * ReserveHolds are used to place a temporary ReserveHold on a merchant's funds.
+       */
+      interface Hold {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'reserve.hold';
+
+        /**
+         * Amount reserved. A positive integer representing how much is reserved in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
+         */
+        amount: number;
+
+        /**
+         * Amount in cents that can be released from this ReserveHold
+         */
+        amount_releasable?: number;
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * Indicates which party created this ReserveHold.
+         */
+        created_by: Hold.CreatedBy;
+
+        /**
+         * 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;
+
+        /**
+         * Whether there are any funds available to release on this ReserveHold. Note that if the ReserveHold is in the process of being released, this could be false, even though the funds haven't been fully released yet.
+         */
+        is_releasable?: boolean;
+
+        /**
+         * 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://docs.stripe.com/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 reason for the ReserveHold.
+         */
+        reason: Hold.Reason;
+
+        release_schedule: Hold.ReleaseSchedule;
+
+        /**
+         * The ReservePlan which produced this ReserveHold (i.e., resplan_123)
+         */
+        reserve_plan: string | Stripe.Reserve.Plan | null;
+
+        /**
+         * The Charge which funded this ReserveHold (e.g., ch_123)
+         */
+        source_charge: string | Stripe.Charge | null;
+
+        /**
+         * Which source balance type this ReserveHold reserves funds from. One of `bank_account`, `card`, or `fpx`.
+         */
+        source_type: Hold.SourceType;
+      }
+
+      namespace Hold {
+        type CreatedBy = 'application' | 'stripe';
+
+        type Reason = 'charge' | 'standalone';
+
+        interface ReleaseSchedule {
+          /**
+           * The time after which the ReserveHold is requested to be released.
+           */
+          release_after: number | null;
+
+          /**
+           * The time at which the ReserveHold is scheduled to be released, automatically set to midnight UTC of the day after `release_after`.
+           */
+          scheduled_release: number | null;
+        }
+
+        type SourceType = 'bank_account' | 'card' | 'fpx';
+      }
+    }
+  }
+}

package/types/Reserve/HoldsResource.d.ts

@@ -0,0 +1,76 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Reserve {
+      interface HoldRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface HoldListParams extends PaginationParams {
+        /**
+         * Only return ReserveHolds associated with the currency specified by this currency code. 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;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Only return ReserveHolds that are releasable.
+         */
+        is_releasable?: boolean;
+
+        reason?: HoldListParams.Reason;
+
+        /**
+         * Only return ReserveHolds associated with the ReservePlan specified by this ReservePlan ID.
+         */
+        reserve_plan?: string;
+
+        /**
+         * Only return ReserveHolds associated with the ReserveRelease specified by this ReserveRelease ID.
+         */
+        reserve_release?: string;
+
+        /**
+         * Only return ReserveHolds associated with the Charge specified by this source charge ID.
+         */
+        source_charge?: string;
+      }
+
+      namespace HoldListParams {
+        type Reason = 'charge' | 'standalone';
+      }
+
+      class HoldsResource {
+        /**
+         * Retrieve a ReserveHold.
+         */
+        retrieve(
+          id: string,
+          params?: HoldRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Reserve.Hold>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Reserve.Hold>>;
+
+        /**
+         * Returns a list of ReserveHolds previously created. The ReserveHolds are returned in sorted order, with the most recent ReserveHolds appearing first.
+         */
+        list(
+          params?: HoldListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Reserve.Hold>;
+        list(options?: RequestOptions): ApiListPromise<Stripe.Reserve.Hold>;
+      }
+    }
+  }
+}

package/types/Reserve/Plans.d.ts

@@ -0,0 +1,103 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Reserve {
+      /**
+       * ReservePlans are used to automatically place holds on a merchant's funds until the plan expires. It takes a portion of each incoming Charge (including those resulting from a Transfer from a platform account).
+       */
+      interface Plan {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'reserve.plan';
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * Indicates which party created this ReservePlan.
+         */
+        created_by: Plan.CreatedBy;
+
+        /**
+         * 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). An unset currency indicates that the plan applies to all currencies.
+         */
+        currency: string | null;
+
+        /**
+         * Time at which the ReservePlan was disabled.
+         */
+        disabled_at: number | null;
+
+        fixed_release?: Plan.FixedRelease;
+
+        /**
+         * 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://docs.stripe.com/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 percent of each Charge to reserve.
+         */
+        percent: number;
+
+        rolling_release?: Plan.RollingRelease;
+
+        /**
+         * The current status of the ReservePlan. The ReservePlan only affects charges if it is `active`.
+         */
+        status: Plan.Status;
+
+        /**
+         * The type of the ReservePlan.
+         */
+        type: Plan.Type;
+      }
+
+      namespace Plan {
+        type CreatedBy = 'application' | 'stripe';
+
+        interface FixedRelease {
+          /**
+           * The time after which all reserved funds are requested for release.
+           */
+          release_after: number;
+
+          /**
+           * The time at which reserved funds are scheduled for release, automatically set to midnight UTC of the day after `release_after`.
+           */
+          scheduled_release: number;
+        }
+
+        interface RollingRelease {
+          /**
+           * The number of days to reserve funds before releasing.
+           */
+          days_after_charge: number;
+
+          /**
+           * The time at which the ReservePlan expires.
+           */
+          expires_on: number | null;
+        }
+
+        type Status = 'active' | 'disabled' | 'expired';
+
+        type Type = 'fixed_release' | 'rolling_release';
+      }
+    }
+  }
+}

package/types/{SharedPayment/GrantedTokensResource.d.ts → Reserve/PlansResource.d.ts}

@@ -2,27 +2,27 @@
 
 declare module 'stripe' {
   namespace Stripe {
-    namespace SharedPayment {
-      interface GrantedTokenRetrieveParams {
+    namespace Reserve {
+      interface PlanRetrieveParams {
         /**
          * Specifies which fields in the response should be expanded.
          */
         expand?: Array<string>;
       }
 
-      class GrantedTokensResource {
+      class PlansResource {
         /**
-         * Retrieves an existing SharedPaymentGrantedToken object
+         * Retrieve a ReservePlan.
          */
         retrieve(
           id: string,
-          params?: GrantedTokenRetrieveParams,
+          params?: PlanRetrieveParams,
           options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.SharedPayment.GrantedToken>>;
+        ): Promise<Stripe.Response<Stripe.Reserve.Plan>>;
         retrieve(
           id: string,
           options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.SharedPayment.GrantedToken>>;
+        ): Promise<Stripe.Response<Stripe.Reserve.Plan>>;
       }
     }
   }

package/types/Reserve/Releases.d.ts

@@ -0,0 +1,105 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Reserve {
+      /**
+       * ReserveReleases represent the release of funds from a ReserveHold.
+       */
+      interface Release {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'reserve.release';
+
+        /**
+         * Amount released. A positive integer representing how much is released in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
+         */
+        amount: number;
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * Indicates which party created this ReserveRelease.
+         */
+        created_by: Release.CreatedBy;
+
+        /**
+         * 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;
+
+        /**
+         * 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://docs.stripe.com/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 reason for the ReserveRelease, indicating why the funds were released.
+         */
+        reason: Release.Reason;
+
+        /**
+         * The release timestamp of the funds.
+         */
+        released_at: number;
+
+        /**
+         * The ReserveHold this ReserveRelease is associated with.
+         */
+        reserve_hold: string | Stripe.Reserve.Hold | null;
+
+        /**
+         * The ReservePlan ID this ReserveRelease is associated with. This field is only populated if a ReserveRelease is created by a ReservePlan disable operation, or from a scheduled ReservedHold expiry.
+         */
+        reserve_plan: string | Stripe.Reserve.Plan | null;
+
+        source_transaction?: Release.SourceTransaction;
+      }
+
+      namespace Release {
+        type CreatedBy = 'application' | 'stripe';
+
+        type Reason =
+          | 'bulk_hold_expiry'
+          | 'hold_released_early'
+          | 'hold_reversed'
+          | 'plan_disabled';
+
+        interface SourceTransaction {
+          /**
+           * The ID of the dispute.
+           */
+          dispute?: string | Stripe.Dispute;
+
+          /**
+           * The ID of the refund.
+           */
+          refund?: string | Stripe.Refund;
+
+          /**
+           * The type of source transaction.
+           */
+          type: SourceTransaction.Type;
+        }
+
+        namespace SourceTransaction {
+          type Type = 'dispute' | 'refund';
+        }
+      }
+    }
+  }
+}

package/types/Reserve/ReleasesResource.d.ts

@@ -0,0 +1,60 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Reserve {
+      interface ReleaseRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface ReleaseListParams extends PaginationParams {
+        /**
+         * Only return ReserveReleases associated with the currency specified by this currency code. 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;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Only return ReserveReleases associated with the ReserveHold specified by this ReserveHold ID.
+         */
+        reserve_hold?: string;
+
+        /**
+         * Only return ReserveReleases associated with the ReservePlan specified by this ReservePlan ID.
+         */
+        reserve_plan?: string;
+      }
+
+      class ReleasesResource {
+        /**
+         * Retrieve a ReserveRelease.
+         */
+        retrieve(
+          id: string,
+          params?: ReleaseRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Reserve.Release>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Reserve.Release>>;
+
+        /**
+         * Returns a list of ReserveReleases previously created. The ReserveReleases are returned in sorted order, with the most recent ReserveReleases appearing first.
+         */
+        list(
+          params?: ReleaseListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Reserve.Release>;
+        list(options?: RequestOptions): ApiListPromise<Stripe.Reserve.Release>;
+      }
+    }
+  }
+}

package/types/SetupIntents.d.ts

@@ -158,8 +158,6 @@ declare module 'stripe' {
        */
       payment_method_types: Array<string>;
 
-      setup_details?: SetupIntent.SetupDetails;
-
       /**
        * ID of the single_use Mandate generated by the SetupIntent.
        */
@@ -1162,25 +1160,6 @@ declare module 'stripe' {
         }
       }
 
-      interface SetupDetails {
-        benefit?: SetupDetails.Benefit;
-      }
-
-      namespace SetupDetails {
-        interface Benefit {
-          fr_meal_voucher?: Benefit.FrMealVoucher;
-        }
-
-        namespace Benefit {
-          interface FrMealVoucher {
-            /**
-             * The 14-digit SIRET of the meal voucher acceptor.
-             */
-            siret?: string;
-          }
-        }
-      }
-
       type Status =
         | 'canceled'
         | 'processing'

package/types/SetupIntentsResource.d.ts

@@ -111,11 +111,6 @@ declare module 'stripe' {
        */
       return_url?: string;
 
-      /**
-       * Provides industry-specific information about the SetupIntent.
-       */
-      setup_details?: SetupIntentCreateParams.SetupDetails;
-
       /**
        * If you populate this hash, this SetupIntent generates a `single_use` mandate after successful completion.
        *
@@ -1902,31 +1897,6 @@ declare module 'stripe' {
         }
       }
 
-      interface SetupDetails {
-        /**
-         * Benefit details for this SetupIntent
-         */
-        benefit?: SetupDetails.Benefit;
-      }
-
-      namespace SetupDetails {
-        interface Benefit {
-          /**
-           * French meal voucher benefit details for this SetupIntent.
-           */
-          fr_meal_voucher?: Benefit.FrMealVoucher;
-        }
-
-        namespace Benefit {
-          interface FrMealVoucher {
-            /**
-             * The 14-digit SIRET of the meal voucher acceptor.
-             */
-            siret: string;
-          }
-        }
-      }
-
       interface SingleUse {
         /**
          * Amount the customer is granting permission to collect later. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
@@ -2030,11 +2000,6 @@ declare module 'stripe' {
        * The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
        */
       payment_method_types?: Array<string>;
-
-      /**
-       * Provides industry-specific information about the SetupIntent.
-       */
-      setup_details?: SetupIntentUpdateParams.SetupDetails;
     }
 
     namespace SetupIntentUpdateParams {
@@ -3737,31 +3702,6 @@ declare module 'stripe' {
           type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
         }
       }
-
-      interface SetupDetails {
-        /**
-         * Benefit details for this SetupIntent
-         */
-        benefit?: SetupDetails.Benefit;
-      }
-
-      namespace SetupDetails {
-        interface Benefit {
-          /**
-           * French meal voucher benefit details for this SetupIntent.
-           */
-          fr_meal_voucher?: Benefit.FrMealVoucher;
-        }
-
-        namespace Benefit {
-          interface FrMealVoucher {
-            /**
-             * The 14-digit SIRET of the meal voucher acceptor.
-             */
-            siret: string;
-          }
-        }
-      }
     }
 
     interface SetupIntentListParams extends PaginationParams {
@@ -3855,11 +3795,6 @@ declare module 'stripe' {
        */
       return_url?: string;
 
-      /**
-       * Provides industry-specific information about the SetupIntent.
-       */
-      setup_details?: SetupIntentConfirmParams.SetupDetails;
-
       /**
        * Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
        */
@@ -5555,31 +5490,6 @@ declare module 'stripe' {
           type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
         }
       }
-
-      interface SetupDetails {
-        /**
-         * Benefit details for this SetupIntent
-         */
-        benefit?: SetupDetails.Benefit;
-      }
-
-      namespace SetupDetails {
-        interface Benefit {
-          /**
-           * French meal voucher benefit details for this SetupIntent.
-           */
-          fr_meal_voucher?: Benefit.FrMealVoucher;
-        }
-
-        namespace Benefit {
-          interface FrMealVoucher {
-            /**
-             * The 14-digit SIRET of the meal voucher acceptor.
-             */
-            siret: string;
-          }
-        }
-      }
     }
 
     interface SetupIntentVerifyMicrodepositsParams {

package/types/SubscriptionItems.d.ts

@@ -62,11 +62,6 @@ declare module 'stripe' {
        */
       current_period_start: number;
 
-      /**
-       * The current trial that is applied to this subscription item.
-       */
-      current_trial?: SubscriptionItem.CurrentTrial | null;
-
       /**
        * Always true for a deleted object
        */
@@ -133,14 +128,6 @@ declare module 'stripe' {
         usage_gte: number | null;
       }
 
-      interface CurrentTrial {
-        end_date: number;
-
-        start_date: number;
-
-        trial_offer: string;
-      }
-
       interface Trial {
         /**
          * List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.