stripe 20.0.0 → 20.1.0-alpha.1

package/types/V2/Payments/OffSessionPaymentsResource.d.ts

@@ -0,0 +1,401 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Payments {
+        interface OffSessionPaymentCreateParams {
+          /**
+           * The “presentment amount” to be collected from the customer.
+           */
+          amount: Amount;
+
+          /**
+           * The frequency of the underlying payment.
+           */
+          cadence: OffSessionPaymentCreateParams.Cadence;
+
+          /**
+           * ID of the Customer to which this OffSessionPayment belongs.
+           */
+          customer: string;
+
+          /**
+           * Set of [key-value pairs](https://docs.corp.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. Learn more about
+           * [storing information in metadata](https://docs.corp.stripe.com/payments/payment-intents#storing-information-in-metadata).
+           */
+          metadata: Stripe.MetadataParam;
+
+          /**
+           * ID of the payment method used in this OffSessionPayment.
+           */
+          payment_method: string;
+
+          /**
+           * Provides industry-specific information about the amount.
+           */
+          amount_details?: OffSessionPaymentCreateParams.AmountDetails;
+
+          /**
+           * Details about the capture configuration for the OffSessionPayment.
+           */
+          capture?: OffSessionPaymentCreateParams.Capture;
+
+          /**
+           * Whether the OffSessionPayment should be captured automatically or manually.
+           */
+          capture_method?: OffSessionPaymentCreateParams.CaptureMethod;
+
+          /**
+           * The account (if any) for which the funds of the OffSessionPayment are intended.
+           */
+          on_behalf_of?: string;
+
+          /**
+           * Payment method options for the off-session payment.
+           */
+          payment_method_options?: OffSessionPaymentCreateParams.PaymentMethodOptions;
+
+          /**
+           * Details about the payments orchestration configuration.
+           */
+          payments_orchestration?: OffSessionPaymentCreateParams.PaymentsOrchestration;
+
+          /**
+           * Details about the OffSessionPayment retries.
+           */
+          retry_details?: OffSessionPaymentCreateParams.RetryDetails;
+
+          /**
+           * Text that appears on the customer's statement as the statement descriptor for a
+           * non-card charge. This value overrides the account's default statement descriptor.
+           * For information about requirements, including the 22-character limit, see the
+           * [Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
+           */
+          statement_descriptor?: string;
+
+          /**
+           * Provides information about a card charge. Concatenated to the account's
+           * [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
+           * to form the complete statement descriptor that appears on the customer's statement.
+           */
+          statement_descriptor_suffix?: string;
+
+          /**
+           * Test clock that can be used to advance the retry attempts in a sandbox.
+           */
+          test_clock?: string;
+
+          /**
+           * The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for [connected accounts](https://docs.corp.stripe.com/payments/connected-accounts).
+           */
+          transfer_data?: OffSessionPaymentCreateParams.TransferData;
+        }
+
+        namespace OffSessionPaymentCreateParams {
+          interface AmountDetails {
+            /**
+             * The amount the total transaction was discounted for.
+             */
+            discount_amount?: number;
+
+            /**
+             * A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
+             */
+            line_items: Array<AmountDetails.LineItem>;
+
+            /**
+             * Contains information about the shipping portion of the amount.
+             */
+            shipping?: AmountDetails.Shipping;
+
+            /**
+             * Contains information about the tax portion of the amount.
+             */
+            tax?: AmountDetails.Tax;
+          }
+
+          namespace AmountDetails {
+            interface LineItem {
+              /**
+               * The amount an item was discounted for. Positive integer.
+               */
+              discount_amount?: number;
+
+              /**
+               * Unique identifier of the product. At most 12 characters long.
+               */
+              product_code?: string;
+
+              /**
+               * Name of the product. At most 100 characters long.
+               */
+              product_name: string;
+
+              /**
+               * Number of items of the product. Positive integer.
+               */
+              quantity: number;
+
+              /**
+               * Contains information about the tax on the item.
+               */
+              tax?: LineItem.Tax;
+
+              /**
+               * Cost of the product. Non-negative integer.
+               */
+              unit_cost: number;
+            }
+
+            namespace LineItem {
+              interface Tax {
+                /**
+                 * Total portion of the amount that is for tax.
+                 */
+                total_tax_amount?: number;
+              }
+            }
+
+            interface Shipping {
+              /**
+               * Portion of the amount that is for shipping.
+               */
+              amount?: number;
+
+              /**
+               * The postal code that represents the shipping source.
+               */
+              from_postal_code?: string;
+
+              /**
+               * The postal code that represents the shipping destination.
+               */
+              to_postal_code?: string;
+            }
+
+            interface Tax {
+              /**
+               * Total portion of the amount that is for tax.
+               */
+              total_tax_amount?: number;
+            }
+          }
+
+          type Cadence = 'recurring' | 'unscheduled';
+
+          interface Capture {
+            /**
+             * The method to use to capture the payment.
+             */
+            capture_method: Capture.CaptureMethod;
+          }
+
+          namespace Capture {
+            type CaptureMethod = 'automatic' | 'manual';
+          }
+
+          type CaptureMethod = 'automatic' | 'manual';
+
+          interface PaymentMethodOptions {
+            /**
+             * Payment method options for the card payment type.
+             */
+            card?: PaymentMethodOptions.Card;
+          }
+
+          namespace PaymentMethodOptions {
+            interface Card {
+              /**
+               * If you are making a Credential On File transaction with a previously saved card, you should pass the Network Transaction ID
+               * from a prior initial authorization on Stripe (from a successful SetupIntent or a PaymentIntent with `setup_future_usage` set),
+               * or one that you have obtained from another payment processor. This is a token from the network which uniquely identifies the transaction.
+               * Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data.
+               * Note that you should pass in a Network Transaction ID if you have one, regardless of whether this is a
+               * Customer-Initiated Transaction (CIT) or a Merchant-Initiated Transaction (MIT).
+               */
+              network_transaction_id: string;
+            }
+          }
+
+          interface PaymentsOrchestration {
+            /**
+             * True when you want to enable payments orchestration for this off-session payment. False otherwise.
+             */
+            enabled: boolean;
+          }
+
+          interface RetryDetails {
+            /**
+             * The pre-configured retry policy to use for the payment.
+             */
+            retry_policy?: string;
+
+            /**
+             * Indicates the strategy for how you want Stripe to retry the payment.
+             */
+            retry_strategy: RetryDetails.RetryStrategy;
+          }
+
+          namespace RetryDetails {
+            type RetryStrategy = 'heuristic' | 'none' | 'scheduled' | 'smart';
+          }
+
+          interface TransferData {
+            /**
+             * The amount transferred to the destination account. This transfer will occur
+             * automatically after the payment succeeds. If no amount is specified, by default
+             * the entire payment amount is transferred to the destination account. The amount
+             * must be less than or equal to the
+             * [amount_requested](https://docs.corp.stripe.com/api/v2/off-session-payments/object?api-version=2025-05-28.preview#v2_off_session_payment_object-amount_requested),
+             * and must be a positive integer representing how much to transfer in the smallest
+             * currency unit (e.g., 100 cents to charge $1.00).
+             */
+            amount?: number;
+
+            /**
+             * The account (if any) that the payment is attributed to for tax reporting, and
+             * where funds from the payment are transferred to after payment success.
+             */
+            destination: string;
+          }
+        }
+      }
+
+      namespace Payments {
+        interface OffSessionPaymentRetrieveParams {}
+      }
+
+      namespace Payments {
+        interface OffSessionPaymentListParams {
+          /**
+           * The page size limit. If not provided, the default is 20.
+           */
+          limit?: number;
+        }
+      }
+
+      namespace Payments {
+        interface OffSessionPaymentCancelParams {}
+      }
+
+      namespace Payments {
+        interface OffSessionPaymentCaptureParams {
+          /**
+           * The amount to capture.
+           */
+          amount_to_capture: number;
+
+          /**
+           * Set of [key-value pairs](https://docs.corp.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. Learn more about
+           * [storing information in metadata](https://docs.corp.stripe.com/payments/payment-intents#storing-information-in-metadata).
+           */
+          metadata: Stripe.MetadataParam;
+
+          /**
+           * Text that appears on the customer's statement as the statement descriptor for a
+           * non-card charge. This value overrides the account's default statement descriptor.
+           * For information about requirements, including the 22-character limit, see the
+           * [Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
+           */
+          statement_descriptor?: string;
+
+          /**
+           * Provides information about a card charge. Concatenated to the account's
+           * [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static)
+           * to form the complete statement descriptor that appears on the customer's statement.
+           */
+          statement_descriptor_suffix?: string;
+
+          /**
+           * The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for [connected accounts](https://docs.corp.stripe.com/payments/connected-accounts).
+           */
+          transfer_data?: OffSessionPaymentCaptureParams.TransferData;
+        }
+
+        namespace OffSessionPaymentCaptureParams {
+          interface TransferData {
+            /**
+             * The amount transferred to the destination account. This transfer will occur
+             * automatically after the payment succeeds. If no amount is specified, by default
+             * the entire payment amount is transferred to the destination account. The amount
+             * must be less than or equal to the
+             * [amount_requested](https://docs.corp.stripe.com/api/v2/off-session-payments/object?api-version=2025-05-28.preview#v2_off_session_payment_object-amount_requested),
+             * and must be a positive integer representing how much to transfer in the smallest
+             * currency unit (e.g., 100 cents to charge $1.00).
+             */
+            amount?: number;
+
+            /**
+             * The account (if any) that the payment is attributed to for tax reporting, and
+             * where funds from the payment are transferred to after payment success.
+             */
+            destination: string;
+          }
+        }
+      }
+
+      namespace Payments {
+        class OffSessionPaymentsResource {
+          /**
+           * Creates an OffSessionPayment object.
+           */
+          create(
+            params: OffSessionPaymentCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
+
+          /**
+           * Retrieves the details of an OffSessionPayment that has previously been created.
+           */
+          retrieve(
+            id: string,
+            params?: OffSessionPaymentRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
+
+          /**
+           * Returns a list of OffSessionPayments matching a filter.
+           */
+          list(
+            params?: OffSessionPaymentListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.Payments.OffSessionPayment>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.Payments.OffSessionPayment>;
+
+          /**
+           * Cancel an OffSessionPayment that has previously been created.
+           */
+          cancel(
+            id: string,
+            params?: OffSessionPaymentCancelParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
+          cancel(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
+
+          /**
+           * Captures an OffSessionPayment that has previously been created.
+           */
+          capture(
+            id: string,
+            params: OffSessionPaymentCaptureParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Payments.OffSessionPayment>>;
+        }
+      }
+    }
+  }
+}

package/types/V2/Reporting/ReportRuns.d.ts

@@ -0,0 +1,154 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Reporting {
+        /**
+         * The `ReportRun` object represents an instance of a `Report` generated with specific
+         * run parameters. Once the object is created, Stripe begins processing the report. When
+         * the report has finished running, it will give you a reference to the results.
+         */
+        interface ReportRun {
+          /**
+           * The unique identifier of the `ReportRun` object.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.reporting.report_run';
+
+          /**
+           * Time at which the object was created.
+           */
+          created: 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;
+
+          /**
+           * The unique identifier of the `Report` object which was run.
+           */
+          report: string;
+
+          /**
+           * The human-readable name of the `Report` which was run.
+           */
+          report_name: string;
+
+          /**
+           * The parameters used to customize the generation of the report.
+           */
+          report_parameters: ReportRun.ReportParameters;
+
+          /**
+           * Details how to retrieve the results of a successfully completed `ReportRun`.
+           */
+          result?: ReportRun.Result;
+
+          /**
+           * The options specified for customizing the output file of the `ReportRun`.
+           */
+          result_options?: ReportRun.ResultOptions;
+
+          /**
+           * The current status of the `ReportRun`.
+           */
+          status: ReportRun.Status;
+
+          /**
+           * Additional details about the current state of the `ReportRun`. The field is currently only populated when a `ReportRun`
+           * is in the `failed` state, providing more information about why the report failed to generate successfully.
+           */
+          status_details: {
+            [key: string]: ReportRun.StatusDetails;
+          };
+        }
+
+        namespace ReportRun {
+          type ReportParameters = {
+            [key: string]: unknown;
+          };
+
+          interface Result {
+            /**
+             * Contains metadata about the file produced by the `ReportRun`, including
+             * its content type, size, and a URL to download its contents.
+             */
+            file: Result.File;
+
+            /**
+             * The type of the `ReportRun` result.
+             */
+            type: 'file';
+          }
+
+          namespace Result {
+            interface File {
+              /**
+               * The content type of the file.
+               */
+              content_type: File.ContentType;
+
+              /**
+               * A pre-signed URL that allows secure, time-limited access to download the file.
+               */
+              download_url: File.DownloadUrl;
+
+              /**
+               * The total size of the file in bytes.
+               */
+              size: number;
+            }
+
+            namespace File {
+              type ContentType = 'csv' | 'zip';
+
+              interface DownloadUrl {
+                /**
+                 * The time that the URL expires.
+                 */
+                expires_at?: string;
+
+                /**
+                 * The URL that can be used for accessing the file.
+                 */
+                url: string;
+              }
+            }
+          }
+
+          interface ResultOptions {
+            /**
+             * If set, the generated report file will be compressed into a ZIP folder.
+             * This is useful for reducing file size and download time for large reports.
+             */
+            compress_file?: boolean;
+          }
+
+          type Status = 'failed' | 'running' | 'succeeded';
+
+          interface StatusDetails {
+            /**
+             * Error code categorizing the reason the `ReportRun` failed.
+             */
+            error_code?: StatusDetails.ErrorCode;
+
+            /**
+             * Error message with additional details about the failure.
+             */
+            error_message?: string;
+          }
+
+          namespace StatusDetails {
+            type ErrorCode = 'file_size_above_limit' | 'internal_error';
+          }
+        }
+      }
+    }
+  }
+}

package/types/V2/Reporting/ReportRunsResource.d.ts

@@ -0,0 +1,75 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Reporting {
+        interface ReportRunCreateParams {
+          /**
+           * The unique identifier of the `Report` being requested.
+           */
+          report: string;
+
+          /**
+           * A map of parameter names to values, specifying how the report should be customized.
+           * The accepted parameters depend on the specific `Report` being run.
+           */
+          report_parameters: ReportRunCreateParams.ReportParameters;
+
+          /**
+           * Optional settings to customize the results of the `ReportRun`.
+           */
+          result_options?: ReportRunCreateParams.ResultOptions;
+        }
+
+        namespace ReportRunCreateParams {
+          type ReportParameters = {
+            [key: string]: unknown;
+          };
+
+          interface ResultOptions {
+            /**
+             * If set, the generated report file will be compressed into a ZIP folder.
+             * This is useful for reducing file size and download time for large reports.
+             */
+            compress_file?: boolean;
+          }
+        }
+      }
+
+      namespace Reporting {
+        interface ReportRunRetrieveParams {}
+      }
+
+      namespace Reporting {
+        class ReportRunsResource {
+          /**
+           * Initiates the generation of a `ReportRun` based on the specified report template
+           * and user-provided parameters. It's the starting point for obtaining report data,
+           * and returns a `ReportRun` object which can be used to track the progress and retrieve
+           * the results of the report.
+           * @throws Stripe.RateLimitError
+           */
+          create(
+            params: ReportRunCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Reporting.ReportRun>>;
+
+          /**
+           * Fetches the current state and details of a previously created `ReportRun`. If the `ReportRun`
+           * has succeeded, the endpoint will provide details for how to retrieve the results.
+           */
+          retrieve(
+            id: string,
+            params?: ReportRunRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Reporting.ReportRun>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Reporting.ReportRun>>;
+        }
+      }
+    }
+  }
+}