stripe 8.188.0 → 8.189.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 8.189.0 - 2021-11-16
+* [#1295](https://github.com/stripe/stripe-node/pull/1295) API Updates
+  * Add support for new resource `ShippingRate`
+  * Add support for `shipping_options` on `CheckoutSessionCreateParams` and `Checkout.Session`
+  * Add support for `shipping_rate` on `Checkout.Session`
+
 ## 8.188.0 - 2021-11-12
 * [#1293](https://github.com/stripe/stripe-node/pull/1293) API Updates
   * Add support for new value `agrobank` on enums `Charge.payment_method_details.fpx.bank`, `PaymentIntentCreateParams.payment_method_data.fpx.bank`, `PaymentIntentUpdateParams.payment_method_data.fpx.bank`, `PaymentIntentConfirmParams.payment_method_data.fpx.bank`, `PaymentMethodCreateParams.fpx.bank`, and `PaymentMethod.fpx.bank`

package/VERSION

@@ -1 +1 @@
-8.188.0
+8.189.0

package/lib/resources/ShippingRates.js

@@ -0,0 +1,31 @@
+// File generated from our OpenAPI spec
+
+'use strict';
+
+const StripeResource = require('../StripeResource');
+const stripeMethod = StripeResource.method;
+
+module.exports = StripeResource.extend({
+  path: 'shipping_rates',
+
+  create: stripeMethod({
+    method: 'POST',
+    path: '',
+  }),
+
+  retrieve: stripeMethod({
+    method: 'GET',
+    path: '/{shippingRateToken}',
+  }),
+
+  update: stripeMethod({
+    method: 'POST',
+    path: '/{shippingRateToken}',
+  }),
+
+  list: stripeMethod({
+    method: 'GET',
+    path: '',
+    methodType: 'list',
+  }),
+});

package/lib/resources.js

@@ -43,6 +43,7 @@ module.exports = {
   Reviews: require('./resources/Reviews'),
   SetupAttempts: require('./resources/SetupAttempts'),
   SetupIntents: require('./resources/SetupIntents'),
+  ShippingRates: require('./resources/ShippingRates'),
   Skus: require('./resources/SKUs'),
   Sources: require('./resources/Sources'),
   Subscriptions: require('./resources/Subscriptions'),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stripe",
-  "version": "8.188.0",
+  "version": "8.189.0",
   "description": "Stripe API wrapper",
   "keywords": [
     "stripe",

package/types/2020-08-27/Charges.d.ts

@@ -1668,7 +1668,7 @@ declare module 'stripe' {
       application_fee_amount?: number;
 
       /**
-       * Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire in _seven days_. For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation.
+       * Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation.
        */
       capture?: boolean;
 
@@ -2018,7 +2018,7 @@ declare module 'stripe' {
       /**
        * Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you [created a charge](https://stripe.com/docs/api#create_charge) with the capture option set to false.
        *
-       * Uncaptured payments expire exactly seven days after they are created. If they are not captured by that point in time, they will be marked as refunded and will no longer be capturable.
+       * Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)). If they are not captured by that point in time, they will be marked as refunded and will no longer be capturable.
        */
       capture(
         id: string,

package/types/2020-08-27/Checkout/Sessions.d.ts

@@ -169,6 +169,16 @@ declare module 'stripe' {
          */
         shipping_address_collection: Session.ShippingAddressCollection | null;
 
+        /**
+         * The shipping rate options applied to this Session.
+         */
+        shipping_options: Array<Session.ShippingOption>;
+
+        /**
+         * The ID of the ShippingRate for Checkout Sessions in `payment` mode.
+         */
+        shipping_rate: string | Stripe.ShippingRate | null;
+
         /**
          * The status of the Checkout Session, one of `open`, `complete`, or `expired`.
          */
@@ -763,6 +773,18 @@ declare module 'stripe' {
             | 'ZZ';
         }
 
+        interface ShippingOption {
+          /**
+           * A non-negative integer in cents representing how much to charge.
+           */
+          shipping_amount: number;
+
+          /**
+           * The shipping rate.
+           */
+          shipping_rate: string | Stripe.ShippingRate;
+        }
+
         type Status = 'complete' | 'expired' | 'open';
 
         type SubmitType = 'auto' | 'book' | 'donate' | 'pay';
@@ -995,7 +1017,12 @@ declare module 'stripe' {
         shipping_address_collection?: SessionCreateParams.ShippingAddressCollection;
 
         /**
-         * The shipping rate to apply to this Session. Currently, only up to one may be specified.
+         * The shipping rate options to apply to this Session.
+         */
+        shipping_options?: Array<SessionCreateParams.ShippingOption>;
+
+        /**
+         * [Deprecated] The shipping rate to apply to this Session. Only up to one may be specified.
          */
         shipping_rates?: Array<string>;
 
@@ -1849,6 +1876,119 @@ declare module 'stripe' {
             | 'ZZ';
         }
 
+        interface ShippingOption {
+          /**
+           * The ID of the Shipping Rate to use for this shipping option.
+           */
+          shipping_rate?: string;
+
+          /**
+           * Parameters to be passed to Shipping Rate creation for this shipping option
+           */
+          shipping_rate_data?: ShippingOption.ShippingRateData;
+        }
+
+        namespace ShippingOption {
+          interface ShippingRateData {
+            /**
+             * The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
+             */
+            delivery_estimate?: ShippingRateData.DeliveryEstimate;
+
+            /**
+             * The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
+             */
+            display_name: string;
+
+            /**
+             * Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
+             */
+            fixed_amount?: ShippingRateData.FixedAmount;
+
+            /**
+             * 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;
+
+            /**
+             * Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
+             */
+            tax_behavior?: ShippingRateData.TaxBehavior;
+
+            /**
+             * A [tax code](https://stripe.com/docs/tax/tax-codes) ID. The Shipping tax code is `txcd_92010001`.
+             */
+            tax_code?: string;
+
+            /**
+             * The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now.
+             */
+            type?: 'fixed_amount';
+          }
+
+          namespace ShippingRateData {
+            interface DeliveryEstimate {
+              /**
+               * The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
+               */
+              maximum?: DeliveryEstimate.Maximum;
+
+              /**
+               * The lower bound of the estimated range. If empty, represents no lower bound.
+               */
+              minimum?: DeliveryEstimate.Minimum;
+            }
+
+            namespace DeliveryEstimate {
+              interface Maximum {
+                /**
+                 * A unit of time.
+                 */
+                unit: Maximum.Unit;
+
+                /**
+                 * Must be greater than 0.
+                 */
+                value: number;
+              }
+
+              namespace Maximum {
+                type Unit = 'business_day' | 'day' | 'hour' | 'month' | 'week';
+              }
+
+              interface Minimum {
+                /**
+                 * A unit of time.
+                 */
+                unit: Minimum.Unit;
+
+                /**
+                 * Must be greater than 0.
+                 */
+                value: number;
+              }
+
+              namespace Minimum {
+                type Unit = 'business_day' | 'day' | 'hour' | 'month' | 'week';
+              }
+            }
+
+            interface FixedAmount {
+              /**
+               * A non-negative integer in cents representing how much to charge.
+               */
+              amount: 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;
+            }
+
+            type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
+          }
+        }
+
         type SubmitType = 'auto' | 'book' | 'donate' | 'pay';
 
         interface SubscriptionData {

package/types/2020-08-27/PaymentIntents.d.ts

@@ -3793,7 +3793,7 @@ declare module 'stripe' {
       /**
        * Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.
        *
-       * Uncaptured PaymentIntents will be canceled exactly seven days after they are created.
+       * Uncaptured PaymentIntents will be canceled a set number of days after they are created (7 by default).
        *
        * Learn more about [separate authorization and capture](https://stripe.com/docs/payments/capture-later).
        */

package/types/2020-08-27/ShippingRates.d.ts

@@ -0,0 +1,320 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * The ShippingRate object.
+     */
+    interface ShippingRate {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'shipping_rate';
+
+      /**
+       * Whether the shipping rate can be used for new purchases. Defaults to `true`.
+       */
+      active: boolean;
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
+       */
+      delivery_estimate: ShippingRate.DeliveryEstimate | null;
+
+      /**
+       * The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
+       */
+      display_name: string | null;
+
+      fixed_amount?: ShippingRate.FixedAmount;
+
+      /**
+       * 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;
+
+      /**
+       * Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
+       */
+      tax_behavior: ShippingRate.TaxBehavior | null;
+
+      /**
+       * A [tax code](https://stripe.com/docs/tax/tax-codes) ID. The Shipping tax code is `txcd_92010001`.
+       */
+      tax_code: string | Stripe.TaxCode | null;
+
+      /**
+       * The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now.
+       */
+      type: 'fixed_amount';
+    }
+
+    namespace ShippingRate {
+      interface DeliveryEstimate {
+        /**
+         * The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
+         */
+        maximum: DeliveryEstimate.Maximum | null;
+
+        /**
+         * The lower bound of the estimated range. If empty, represents no lower bound.
+         */
+        minimum: DeliveryEstimate.Minimum | null;
+      }
+
+      namespace DeliveryEstimate {
+        interface Maximum {
+          /**
+           * A unit of time.
+           */
+          unit: Maximum.Unit;
+
+          /**
+           * Must be greater than 0.
+           */
+          value: number;
+        }
+
+        namespace Maximum {
+          type Unit = 'business_day' | 'day' | 'hour' | 'month' | 'week';
+        }
+
+        interface Minimum {
+          /**
+           * A unit of time.
+           */
+          unit: Minimum.Unit;
+
+          /**
+           * Must be greater than 0.
+           */
+          value: number;
+        }
+
+        namespace Minimum {
+          type Unit = 'business_day' | 'day' | 'hour' | 'month' | 'week';
+        }
+      }
+
+      interface FixedAmount {
+        /**
+         * A non-negative integer in cents representing how much to charge.
+         */
+        amount: 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;
+      }
+
+      type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
+    }
+
+    interface ShippingRateCreateParams {
+      /**
+       * The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
+       */
+      display_name: string;
+
+      /**
+       * The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
+       */
+      delivery_estimate?: ShippingRateCreateParams.DeliveryEstimate;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
+       */
+      fixed_amount?: ShippingRateCreateParams.FixedAmount;
+
+      /**
+       * 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;
+
+      /**
+       * Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
+       */
+      tax_behavior?: ShippingRateCreateParams.TaxBehavior;
+
+      /**
+       * A [tax code](https://stripe.com/docs/tax/tax-codes) ID. The Shipping tax code is `txcd_92010001`.
+       */
+      tax_code?: string;
+
+      /**
+       * The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now.
+       */
+      type?: 'fixed_amount';
+    }
+
+    namespace ShippingRateCreateParams {
+      interface DeliveryEstimate {
+        /**
+         * The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
+         */
+        maximum?: DeliveryEstimate.Maximum;
+
+        /**
+         * The lower bound of the estimated range. If empty, represents no lower bound.
+         */
+        minimum?: DeliveryEstimate.Minimum;
+      }
+
+      namespace DeliveryEstimate {
+        interface Maximum {
+          /**
+           * A unit of time.
+           */
+          unit: Maximum.Unit;
+
+          /**
+           * Must be greater than 0.
+           */
+          value: number;
+        }
+
+        namespace Maximum {
+          type Unit = 'business_day' | 'day' | 'hour' | 'month' | 'week';
+        }
+
+        interface Minimum {
+          /**
+           * A unit of time.
+           */
+          unit: Minimum.Unit;
+
+          /**
+           * Must be greater than 0.
+           */
+          value: number;
+        }
+
+        namespace Minimum {
+          type Unit = 'business_day' | 'day' | 'hour' | 'month' | 'week';
+        }
+      }
+
+      interface FixedAmount {
+        /**
+         * A non-negative integer in cents representing how much to charge.
+         */
+        amount: 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;
+      }
+
+      type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
+    }
+
+    interface ShippingRateRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface ShippingRateUpdateParams {
+      /**
+       * Whether the shipping rate can be used for new purchases. 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.Emptyable<Stripe.MetadataParam>;
+    }
+
+    interface ShippingRateListParams extends PaginationParams {
+      /**
+       * Only return shipping rates that are active or inactive.
+       */
+      active?: boolean;
+
+      /**
+       * A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
+       */
+      created?: Stripe.RangeQueryParam | number;
+
+      /**
+       * Only return shipping rates for the given currency.
+       */
+      currency?: string;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    class ShippingRatesResource {
+      /**
+       * Creates a new shipping rate object.
+       */
+      create(
+        params: ShippingRateCreateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ShippingRate>>;
+
+      /**
+       * Returns the shipping rate object with the given ID.
+       */
+      retrieve(
+        id: string,
+        params?: ShippingRateRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ShippingRate>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ShippingRate>>;
+
+      /**
+       * Updates an existing shipping rate object.
+       */
+      update(
+        id: string,
+        params?: ShippingRateUpdateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ShippingRate>>;
+
+      /**
+       * Returns a list of your shipping rates.
+       */
+      list(
+        params?: ShippingRateListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.ShippingRate>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.ShippingRate>;
+    }
+  }
+}

package/types/2020-08-27/index.d.ts

@@ -81,6 +81,7 @@
 ///<reference path='./SKUs.d.ts' />
 ///<reference path='./SetupAttempts.d.ts' />
 ///<reference path='./SetupIntents.d.ts' />
+///<reference path='./ShippingRates.d.ts' />
 ///<reference path='./Sigma/ScheduledQueryRuns.d.ts' />
 ///<reference path='./SourceMandateNotifications.d.ts' />
 ///<reference path='./SourceTransactions.d.ts' />
@@ -154,6 +155,7 @@ declare module 'stripe' {
     reviews: Stripe.ReviewsResource;
     setupAttempts: Stripe.SetupAttemptsResource;
     setupIntents: Stripe.SetupIntentsResource;
+    shippingRates: Stripe.ShippingRatesResource;
     skus: Stripe.SkusResource;
     sources: Stripe.SourcesResource;
     subscriptions: Stripe.SubscriptionsResource;