stripe 16.12.0 → 17.0.0

package/types/Errors.d.ts

@@ -1,5 +1,6 @@
 declare module 'stripe' {
   namespace Stripe {
+    // rawErrorTypeEnum: The beginning of the section generated from our OpenAPI spec
     export type RawErrorType =
       | 'card_error'
       | 'invalid_request_error'
@@ -7,10 +8,13 @@ declare module 'stripe' {
       | 'idempotency_error'
       | 'rate_limit_error'
       | 'authentication_error'
-      | 'invalid_grant';
+      | 'invalid_grant'
+      | 'temporary_session_expired';
+    // rawErrorTypeEnum: The end of the section generated from our OpenAPI spec
 
     export type StripeRawError = {
       message?: string;
+      userMessage?: string;
 
       type: RawErrorType;
 
@@ -32,27 +36,35 @@ declare module 'stripe' {
     };
 
     namespace errors {
+      /** @deprecated Not for external use. */
       function generate(
         rawError: StripeRawError & {type: 'card_error'}
       ): StripeCardError;
+      /** @deprecated Not for external use. */
       function generate(
         rawError: StripeRawError & {type: 'invalid_request_error'}
       ): StripeInvalidRequestError;
+      /** @deprecated Not for external use. */
       function generate(
         rawError: StripeRawError & {type: 'api_error'}
       ): StripeAPIError;
+      /** @deprecated Not for external use. */
       function generate(
         rawError: StripeRawError & {type: 'authentication_error'}
       ): StripeAuthenticationError;
+      /** @deprecated Not for external use. */
       function generate(
         rawError: StripeRawError & {type: 'rate_limit_error'}
       ): StripeRateLimitError;
+      /** @deprecated Not for external use. */
       function generate(
         rawError: StripeRawError & {type: 'idempotency_error'}
       ): StripeIdempotencyError;
+      /** @deprecated Not for external use. */
       function generate(
         rawError: StripeRawError & {type: 'invalid_grant'}
       ): StripeInvalidGrantError;
+      /** @deprecated Not for external use. */
       function generate(
         rawError: StripeRawError & {type: RawErrorType}
       ): StripeError;
@@ -60,27 +72,35 @@ declare module 'stripe' {
       class StripeError extends Error {
         constructor(rawError: StripeRawError);
 
+        /** @deprecated Not for external use. */
         static generate(
           rawError: StripeRawError & {type: 'card_error'}
         ): StripeCardError;
+        /** @deprecated Not for external use. */
         static generate(
           rawError: StripeRawError & {type: 'invalid_request_error'}
         ): StripeInvalidRequestError;
+        /** @deprecated Not for external use. */
         static generate(
           rawError: StripeRawError & {type: 'api_error'}
         ): StripeAPIError;
+        /** @deprecated Not for external use. */
         static generate(
           rawError: StripeRawError & {type: 'authentication_error'}
         ): StripeAuthenticationError;
+        /** @deprecated Not for external use. */
         static generate(
           rawError: StripeRawError & {type: 'rate_limit_error'}
         ): StripeRateLimitError;
+        /** @deprecated Not for external use. */
         static generate(
           rawError: StripeRawError & {type: 'idempotency_error'}
         ): StripeIdempotencyError;
+        /** @deprecated Not for external use. */
         static generate(
           rawError: StripeRawError & {type: 'invalid_grant'}
         ): StripeInvalidGrantError;
+        /** @deprecated Not for external use. */
         static generate(
           rawError: StripeRawError & {type: RawErrorType}
         ): StripeError;
@@ -91,6 +111,7 @@ declare module 'stripe' {
          */
         readonly message: string;
 
+        // errorClassNameEnum: The beginning of the section generated from our OpenAPI spec
         readonly type:
           | 'StripeError'
           | 'StripeCardError'
@@ -102,7 +123,9 @@ declare module 'stripe' {
           | 'StripeConnectionError'
           | 'StripeSignatureVerificationError'
           | 'StripeIdempotencyError'
-          | 'StripeInvalidGrantError';
+          | 'StripeInvalidGrantError'
+          | 'TemporarySessionExpiredError';
+        // errorClassNameEnum: The end of the section generated from our OpenAPI spec
 
         /**
          * See the "error types" section at https://stripe.com/docs/api/errors
@@ -245,6 +268,13 @@ declare module 'stripe' {
         readonly type: 'StripeInvalidGrantError';
         readonly rawType: 'invalid_grant';
       }
+
+      // errorClassDefinitions: The beginning of the section generated from our OpenAPI spec
+      export class TemporarySessionExpiredError extends StripeError {
+        readonly type: 'TemporarySessionExpiredError';
+        readonly rawType: 'temporary_session_expired';
+      }
+      // errorClassDefinitions: The end of the section generated from our OpenAPI spec
     }
   }
 }

package/types/EventTypes.d.ts

@@ -240,7 +240,9 @@ declare module 'stripe' {
       | TreasuryReceivedCreditFailedEvent
       | TreasuryReceivedCreditSucceededEvent
       | TreasuryReceivedDebitCreatedEvent;
+  }
 
+  namespace Stripe {
     /**
      * Occurs whenever a user authorizes an application. Sent to the related application only.
      */

package/types/InvoiceLineItems.d.ts

@@ -80,6 +80,8 @@ declare module 'stripe' {
        */
       plan: Stripe.Plan | null;
 
+      pretax_credit_amounts?: Array<InvoiceLineItem.PretaxCreditAmount> | null;
+
       /**
        * The price of the line item.
        */
@@ -156,6 +158,40 @@ declare module 'stripe' {
         start: number;
       }
 
+      interface PretaxCreditAmount {
+        /**
+         * The amount, in cents (or local equivalent), of the pretax credit amount.
+         */
+        amount: number;
+
+        /**
+         * The credit balance transaction that was applied to get this pretax credit amount.
+         */
+        credit_balance_transaction?:
+          | string
+          | Stripe.Billing.CreditBalanceTransaction
+          | null;
+
+        /**
+         * The discount that was applied to get this pretax credit amount.
+         */
+        discount?: string | Stripe.Discount | Stripe.DeletedDiscount;
+
+        /**
+         * The margin that was applied to get this pretax credit amount.
+         */
+        margin?: string | Stripe.Margin;
+
+        /**
+         * Type of the pretax credit amount referenced.
+         */
+        type: PretaxCreditAmount.Type;
+      }
+
+      namespace PretaxCreditAmount {
+        type Type = 'credit_balance_transaction' | 'discount';
+      }
+
       interface ProrationDetails {
         /**
          * For a credit proration `line_item`, the original debit line_items to which the credit proration applies.

package/types/Invoices.d.ts

@@ -461,6 +461,10 @@ declare module 'stripe' {
        */
       total_excluding_tax: number | null;
 
+      total_pretax_credit_amounts?: Array<
+        Invoice.TotalPretaxCreditAmount
+      > | null;
+
       /**
        * The aggregate amounts calculated per tax rate for all line items.
        */
@@ -1396,6 +1400,40 @@ declare module 'stripe' {
         discount: string | Stripe.Discount | Stripe.DeletedDiscount;
       }
 
+      interface TotalPretaxCreditAmount {
+        /**
+         * The amount, in cents (or local equivalent), of the pretax credit amount.
+         */
+        amount: number;
+
+        /**
+         * The credit balance transaction that was applied to get this pretax credit amount.
+         */
+        credit_balance_transaction?:
+          | string
+          | Stripe.Billing.CreditBalanceTransaction
+          | null;
+
+        /**
+         * The discount that was applied to get this pretax credit amount.
+         */
+        discount?: string | Stripe.Discount | Stripe.DeletedDiscount;
+
+        /**
+         * The margin that was applied to get this pretax credit amount.
+         */
+        margin?: string | Stripe.Margin;
+
+        /**
+         * Type of the pretax credit amount referenced.
+         */
+        type: TotalPretaxCreditAmount.Type;
+      }
+
+      namespace TotalPretaxCreditAmount {
+        type Type = 'credit_balance_transaction' | 'discount';
+      }
+
       interface TotalTaxAmount {
         /**
          * The amount, in cents (or local equivalent), of the tax.

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/ProductsResource.d.ts

@@ -101,6 +101,11 @@ declare module 'stripe' {
           [key: string]: DefaultPriceData.CurrencyOptions;
         };
 
+        /**
+         * When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
+         */
+        custom_unit_amount?: DefaultPriceData.CustomUnitAmount;
+
         /**
          * The recurring components of a price such as `interval` and `interval_count`.
          */
@@ -112,7 +117,7 @@ declare module 'stripe' {
         tax_behavior?: DefaultPriceData.TaxBehavior;
 
         /**
-         * A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
+         * A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required.
          */
         unit_amount?: number;
 
@@ -203,6 +208,28 @@ declare module 'stripe' {
           }
         }
 
+        interface CustomUnitAmount {
+          /**
+           * Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
+           */
+          enabled: boolean;
+
+          /**
+           * The maximum unit amount the customer can specify for this item.
+           */
+          maximum?: number;
+
+          /**
+           * The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
+           */
+          minimum?: number;
+
+          /**
+           * The starting unit amount which can be updated by the customer.
+           */
+          preset?: number;
+        }
+
         interface Recurring {
           /**
            * Specifies billing frequency. Either `day`, `week`, `month` or `year`.

package/types/PromotionCodes.d.ts

@@ -23,7 +23,7 @@ declare module 'stripe' {
       active: boolean;
 
       /**
-       * The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer.
+       * The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).
        */
       code: string;
 

package/types/PromotionCodesResource.d.ts

@@ -14,7 +14,9 @@ declare module 'stripe' {
       active?: boolean;
 
       /**
-       * The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. If left blank, we will generate one automatically.
+       * The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).
+       *
+       * If left blank, we will generate one automatically.
        */
       code?: string;
 

package/types/SubscriptionsResource.d.ts

@@ -1972,11 +1972,11 @@ declare module 'stripe' {
       list(options?: RequestOptions): ApiListPromise<Stripe.Subscription>;
 
       /**
-       * Cancels a customer's subscription immediately. The customer will not be charged again for the subscription.
+       * Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://stripe.com/metadata).
        *
-       * Note, however, that any pending invoice items that you've created will still be charged for at the end of the period, unless manually [deleted](https://stripe.com/docs/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.
+       * Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://stripe.com/docs/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed.
        *
-       * By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
+       * By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
        */
       cancel(
         id: string,

package/types/Tax/Settings.d.ts

@@ -27,7 +27,7 @@ declare module 'stripe' {
         livemode: boolean;
 
         /**
-         * The `active` status indicates you have all required settings to calculate tax. A status can transition out of `active` when new required settings are introduced.
+         * The status of the Tax `Settings`.
          */
         status: Settings.Status;
 

package/types/Terminal/ReadersResource.d.ts

@@ -123,6 +123,11 @@ declare module 'stripe' {
 
       namespace ReaderProcessPaymentIntentParams {
         interface ProcessConfig {
+          /**
+           * This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
+           */
+          allow_redisplay?: ProcessConfig.AllowRedisplay;
+
           /**
            * Enables cancel button on transaction screens.
            */
@@ -140,6 +145,8 @@ declare module 'stripe' {
         }
 
         namespace ProcessConfig {
+          type AllowRedisplay = 'always' | 'limited' | 'unspecified';
+
           interface Tipping {
             /**
              * Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).
@@ -151,14 +158,14 @@ declare module 'stripe' {
 
       interface ReaderProcessSetupIntentParams {
         /**
-         * SetupIntent ID
+         * This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
          */
-        setup_intent: string;
+        allow_redisplay: ReaderProcessSetupIntentParams.AllowRedisplay;
 
         /**
-         * Customer Consent Collected
+         * SetupIntent ID
          */
-        customer_consent_collected?: boolean;
+        setup_intent: string;
 
         /**
          * Specifies which fields in the response should be expanded.
@@ -172,6 +179,8 @@ declare module 'stripe' {
       }
 
       namespace ReaderProcessSetupIntentParams {
+        type AllowRedisplay = 'always' | 'limited' | 'unspecified';
+
         interface ProcessConfig {
           /**
            * Enables cancel button on transaction screens.

package/types/ThinEvent.d.ts

@@ -0,0 +1,36 @@
+// This is a manually maintained file
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Event {
+      /**
+       * Object containing the reference to API resource relevant to the event.
+       */
+      interface RelatedObject {
+        /**
+         * Unique identifier for the object relevant to the event.
+         */
+        id: string;
+
+        /**
+         * Type of the object relevant to the event.
+         */
+        type: string;
+
+        /**
+         * URL to retrieve the resource.
+         */
+        url: string;
+      }
+    }
+    /**
+     * The Event object as recieved from StripeClient.parseThinEvent.
+     */
+    interface ThinEvent extends V2.EventBase {
+      /**
+       * Object containing the reference to API resource relevant to the event.
+       */
+      related_object: Event.RelatedObject | null;
+    }
+  }
+}

package/types/Treasury/ReceivedCredits.d.ts

@@ -83,7 +83,11 @@ declare module 'stripe' {
       }
 
       namespace ReceivedCredit {
-        type FailureCode = 'account_closed' | 'account_frozen' | 'other';
+        type FailureCode =
+          | 'account_closed'
+          | 'account_frozen'
+          | 'international_transaction'
+          | 'other';
 
         interface InitiatingPaymentMethodDetails {
           /**

package/types/V2/Billing/MeterEventAdjustments.d.ts

@@ -0,0 +1,65 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        /**
+         * The MeterEventAdjustment object.
+         */
+        interface MeterEventAdjustment {
+          /**
+           * The unique id of this meter event adjustment.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'billing.meter_event_adjustment';
+
+          /**
+           * Specifies which event to cancel.
+           */
+          cancel: MeterEventAdjustment.Cancel;
+
+          /**
+           * The time the adjustment was created.
+           */
+          created: string;
+
+          /**
+           * The name of the meter event. Corresponds with the `event_name` field on a meter.
+           */
+          event_name: 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;
+
+          /**
+           * Open Enum. The meter event adjustment's status.
+           */
+          status: MeterEventAdjustment.Status;
+
+          /**
+           * Open Enum. Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
+           */
+          type: 'cancel';
+        }
+
+        namespace MeterEventAdjustment {
+          interface Cancel {
+            /**
+             * Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them.
+             */
+            identifier: string;
+          }
+
+          type Status = 'complete' | 'pending';
+        }
+      }
+    }
+  }
+}

package/types/V2/Billing/MeterEventAdjustmentsResource.d.ts

@@ -0,0 +1,47 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        interface MeterEventAdjustmentCreateParams {
+          /**
+           * Specifies which event to cancel.
+           */
+          cancel: MeterEventAdjustmentCreateParams.Cancel;
+
+          /**
+           * The name of the meter event. Corresponds with the `event_name` field on a meter.
+           */
+          event_name: string;
+
+          /**
+           * Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
+           */
+          type: 'cancel';
+        }
+
+        namespace MeterEventAdjustmentCreateParams {
+          interface Cancel {
+            /**
+             * Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them.
+             */
+            identifier: string;
+          }
+        }
+      }
+
+      namespace Billing {
+        class MeterEventAdjustmentsResource {
+          /**
+           * Creates a meter event adjustment to cancel a previously sent meter event.
+           */
+          create(
+            params: MeterEventAdjustmentCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.MeterEventAdjustment>>;
+        }
+      }
+    }
+  }
+}

package/types/V2/Billing/MeterEventSessionResource.d.ts

@@ -0,0 +1,26 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        interface MeterEventSessionCreateParams {}
+      }
+
+      namespace Billing {
+        class MeterEventSessionResource {
+          /**
+           * Creates a meter event session to send usage on the high-throughput meter event stream. Authentication tokens are only valid for 15 minutes, so you will need to create a new meter event session when your token expires.
+           */
+          create(
+            params?: MeterEventSessionCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.MeterEventSession>>;
+          create(
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Billing.MeterEventSession>>;
+        }
+      }
+    }
+  }
+}

package/types/V2/Billing/MeterEventSessions.d.ts

@@ -0,0 +1,45 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        /**
+         * The MeterEventSession object.
+         */
+        interface MeterEventSession {
+          /**
+           * The unique id of this auth session.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'billing.meter_event_session';
+
+          /**
+           * The authentication token for this session.  Use this token when calling the
+           * high-throughput meter event API.
+           */
+          authentication_token: string;
+
+          /**
+           * The creation time of this session.
+           */
+          created: string;
+
+          /**
+           * The time at which this session will expire.
+           */
+          expires_at: 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;
+        }
+      }
+    }
+  }
+}