stripe 18.2.1 → 18.3.0-beta.2

package/types/PaymentRecordsResource.d.ts

@@ -0,0 +1,455 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface PaymentRecordRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface PaymentRecordReportPaymentParams {
+      /**
+       * The amount you initially requested for this payment.
+       */
+      amount_requested: PaymentRecordReportPaymentParams.AmountRequested;
+
+      /**
+       * When the reported payment was initiated. Measured in seconds since the Unix epoch.
+       */
+      initiated_at: number;
+
+      /**
+       * Information about the Payment Method debited for this payment.
+       */
+      payment_method_details: PaymentRecordReportPaymentParams.PaymentMethodDetails;
+
+      /**
+       * Customer information for this payment.
+       */
+      customer_details?: PaymentRecordReportPaymentParams.CustomerDetails;
+
+      /**
+       * Indicates whether the customer was present in your checkout flow during this payment.
+       */
+      customer_presence?: PaymentRecordReportPaymentParams.CustomerPresence;
+
+      /**
+       * An arbitrary string attached to the object. Often useful for displaying to users.
+       */
+      description?: string;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * Information about the payment attempt failure.
+       */
+      failed?: PaymentRecordReportPaymentParams.Failed;
+
+      /**
+       * Information about the payment attempt guarantee.
+       */
+      guaranteed?: PaymentRecordReportPaymentParams.Guaranteed;
+
+      /**
+       * 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>;
+
+      /**
+       * The outcome of the reported payment.
+       */
+      outcome?: PaymentRecordReportPaymentParams.Outcome;
+
+      /**
+       * An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
+       */
+      payment_reference?: string;
+
+      /**
+       * Shipping information for this payment.
+       */
+      shipping_details?: PaymentRecordReportPaymentParams.ShippingDetails;
+    }
+
+    namespace PaymentRecordReportPaymentParams {
+      interface AmountRequested {
+        /**
+         * 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;
+
+        /**
+         * A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) for example, 100 cents for 1 USD or 100 for 100 JPY, a zero-decimal currency.
+         */
+        value: number;
+      }
+
+      interface CustomerDetails {
+        /**
+         * The customer who made the payment.
+         */
+        customer?: string;
+
+        /**
+         * The customer's phone number.
+         */
+        email?: string;
+
+        /**
+         * The customer's name.
+         */
+        name?: string;
+
+        /**
+         * The customer's phone number.
+         */
+        phone?: string;
+      }
+
+      type CustomerPresence = 'off_session' | 'on_session';
+
+      interface Failed {
+        /**
+         * When the reported payment failed. Measured in seconds since the Unix epoch.
+         */
+        failed_at: number;
+      }
+
+      interface Guaranteed {
+        /**
+         * When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
+         */
+        guaranteed_at: number;
+      }
+
+      type Outcome = 'failed' | 'guaranteed';
+
+      interface PaymentMethodDetails {
+        /**
+         * The billing details associated with the method of payment.
+         */
+        billing_details?: PaymentMethodDetails.BillingDetails;
+
+        /**
+         * Information about the custom (user-defined) payment method used to make this payment.
+         */
+        custom?: PaymentMethodDetails.Custom;
+
+        /**
+         * ID of the Stripe Payment Method used to make this payment.
+         */
+        payment_method?: string;
+
+        /**
+         * The type of the payment method details. An additional hash is included on the payment_method_details with a name matching this value. It contains additional information specific to the type.
+         */
+        type?: 'custom';
+      }
+
+      namespace PaymentMethodDetails {
+        interface BillingDetails {
+          /**
+           * The billing address associated with the method of payment.
+           */
+          address?: Stripe.AddressParam;
+
+          /**
+           * The billing email associated with the method of payment.
+           */
+          email?: string;
+
+          /**
+           * The billing name associated with the method of payment.
+           */
+          name?: string;
+
+          /**
+           * The billing phone number associated with the method of payment.
+           */
+          phone?: string;
+        }
+
+        interface Custom {
+          /**
+           * Display name for the custom (user-defined) payment method type used to make this payment.
+           */
+          display_name?: string;
+
+          /**
+           * The custom payment method type associated with this payment.
+           */
+          type?: string;
+        }
+      }
+
+      interface ShippingDetails {
+        /**
+         * The physical shipping address.
+         */
+        address?: Stripe.AddressParam;
+
+        /**
+         * The shipping recipient's name.
+         */
+        name?: string;
+
+        /**
+         * The shipping recipient's phone number.
+         */
+        phone?: string;
+      }
+    }
+
+    interface PaymentRecordReportPaymentAttemptParams {
+      /**
+       * When the reported payment was initiated. Measured in seconds since the Unix epoch.
+       */
+      initiated_at: number;
+
+      /**
+       * An arbitrary string attached to the object. Often useful for displaying to users.
+       */
+      description?: string;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * Information about the payment attempt failure.
+       */
+      failed?: PaymentRecordReportPaymentAttemptParams.Failed;
+
+      /**
+       * Information about the payment attempt guarantee.
+       */
+      guaranteed?: PaymentRecordReportPaymentAttemptParams.Guaranteed;
+
+      /**
+       * 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>;
+
+      /**
+       * The outcome of the reported payment.
+       */
+      outcome?: PaymentRecordReportPaymentAttemptParams.Outcome;
+
+      /**
+       * Information about the Payment Method debited for this payment.
+       */
+      payment_method_details?: PaymentRecordReportPaymentAttemptParams.PaymentMethodDetails;
+
+      /**
+       * Shipping information for this payment.
+       */
+      shipping_details?: PaymentRecordReportPaymentAttemptParams.ShippingDetails;
+    }
+
+    namespace PaymentRecordReportPaymentAttemptParams {
+      interface Failed {
+        /**
+         * When the reported payment failed. Measured in seconds since the Unix epoch.
+         */
+        failed_at: number;
+      }
+
+      interface Guaranteed {
+        /**
+         * When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
+         */
+        guaranteed_at: number;
+      }
+
+      type Outcome = 'failed' | 'guaranteed';
+
+      interface PaymentMethodDetails {
+        /**
+         * The billing details associated with the method of payment.
+         */
+        billing_details?: PaymentMethodDetails.BillingDetails;
+
+        /**
+         * Information about the custom (user-defined) payment method used to make this payment.
+         */
+        custom?: PaymentMethodDetails.Custom;
+
+        /**
+         * ID of the Stripe Payment Method used to make this payment.
+         */
+        payment_method?: string;
+
+        /**
+         * The type of the payment method details. An additional hash is included on the payment_method_details with a name matching this value. It contains additional information specific to the type.
+         */
+        type?: 'custom';
+      }
+
+      namespace PaymentMethodDetails {
+        interface BillingDetails {
+          /**
+           * The billing address associated with the method of payment.
+           */
+          address?: Stripe.AddressParam;
+
+          /**
+           * The billing email associated with the method of payment.
+           */
+          email?: string;
+
+          /**
+           * The billing name associated with the method of payment.
+           */
+          name?: string;
+
+          /**
+           * The billing phone number associated with the method of payment.
+           */
+          phone?: string;
+        }
+
+        interface Custom {
+          /**
+           * Display name for the custom (user-defined) payment method type used to make this payment.
+           */
+          display_name?: string;
+
+          /**
+           * The custom payment method type associated with this payment.
+           */
+          type?: string;
+        }
+      }
+
+      interface ShippingDetails {
+        /**
+         * The physical shipping address.
+         */
+        address?: Stripe.AddressParam;
+
+        /**
+         * The shipping recipient's name.
+         */
+        name?: string;
+
+        /**
+         * The shipping recipient's phone number.
+         */
+        phone?: string;
+      }
+    }
+
+    interface PaymentRecordReportPaymentAttemptCanceledParams {
+      /**
+       * When the reported payment was canceled. Measured in seconds since the Unix epoch.
+       */
+      canceled_at: number;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
+    }
+
+    interface PaymentRecordReportPaymentAttemptFailedParams {
+      /**
+       * When the reported payment failed. Measured in seconds since the Unix epoch.
+       */
+      failed_at: number;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
+    }
+
+    interface PaymentRecordReportPaymentAttemptGuaranteedParams {
+      /**
+       * When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
+       */
+      guaranteed_at: number;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
+    }
+
+    class PaymentRecordsResource {
+      /**
+       * Retrieves a Payment Record with the given ID
+       */
+      retrieve(
+        id: string,
+        params?: PaymentRecordRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.PaymentRecord>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.PaymentRecord>>;
+
+      /**
+       * Report a new Payment Record. You may report a Payment Record as it is
+       *  initialized and later report updates through the other report_* methods, or report Payment
+       *  Records in a terminal state directly, through this method.
+       */
+      reportPayment(
+        params: PaymentRecordReportPaymentParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.PaymentRecord>>;
+
+      /**
+       * Report a new payment attempt on the specified Payment Record. A new payment
+       *  attempt can only be specified if all other payment attempts are canceled or failed.
+       */
+      reportPaymentAttempt(
+        id: string,
+        params: PaymentRecordReportPaymentAttemptParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.PaymentRecord>>;
+
+      /**
+       * Report that the most recent payment attempt on the specified Payment Record
+       *  was canceled.
+       */
+      reportPaymentAttemptCanceled(
+        id: string,
+        params: PaymentRecordReportPaymentAttemptCanceledParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.PaymentRecord>>;
+
+      /**
+       * Report that the most recent payment attempt on the specified Payment Record
+       *  failed or errored.
+       */
+      reportPaymentAttemptFailed(
+        id: string,
+        params: PaymentRecordReportPaymentAttemptFailedParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.PaymentRecord>>;
+
+      /**
+       * Report that the most recent payment attempt on the specified Payment Record
+       *  was guaranteed.
+       */
+      reportPaymentAttemptGuaranteed(
+        id: string,
+        params: PaymentRecordReportPaymentAttemptGuaranteedParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.PaymentRecord>>;
+    }
+  }
+}

package/types/Payouts.d.ts

@@ -112,6 +112,11 @@ declare module 'stripe' {
        */
       original_payout: string | Stripe.Payout | null;
 
+      /**
+       * ID of the v2 FinancialAccount the funds are sent to.
+       */
+      payout_method?: string | null;
+
       /**
        * If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout.
        */

package/types/PayoutsResource.d.ts

@@ -38,6 +38,11 @@ declare module 'stripe' {
        */
       method?: PayoutCreateParams.Method;
 
+      /**
+       * The ID of a v2 FinancialAccount to send funds to.
+       */
+      payout_method?: string;
+
       /**
        * The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of `bank_account`, `card`, or `fpx`.
        */

package/types/Prices.d.ts

@@ -93,6 +93,11 @@ declare module 'stripe' {
        */
       metadata: Stripe.Metadata;
 
+      /**
+       * Subscriptions using this price will be migrated to use the new referenced price.
+       */
+      migrate_to?: Price.MigrateTo | null;
+
       /**
        * A brief description of the price, hidden from customers.
        */
@@ -239,6 +244,23 @@ declare module 'stripe' {
         preset: number | null;
       }
 
+      interface MigrateTo {
+        /**
+         * The behavior controlling at what point in the subscription lifecycle to migrate the price
+         */
+        behavior: 'at_cycle_end';
+
+        /**
+         * The unix timestamp after at which subscriptions will start to migrate to the new price.
+         */
+        effective_after: number;
+
+        /**
+         * The id of the price being migrated to
+         */
+        price: string;
+      }
+
       interface Recurring {
         /**
          * The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.

package/types/PricesResource.d.ts

@@ -361,6 +361,11 @@ declare module 'stripe' {
        */
       metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
 
+      /**
+       * If specified, subscriptions using this price will be updated to use the new referenced price.
+       */
+      migrate_to?: Stripe.Emptyable<PriceUpdateParams.MigrateTo>;
+
       /**
        * A brief description of the price, hidden from customers.
        */
@@ -458,6 +463,23 @@ declare module 'stripe' {
         }
       }
 
+      interface MigrateTo {
+        /**
+         * The behavior controlling the point in the subscription lifecycle after which to migrate the price. Currently must be `at_cycle_end`.
+         */
+        behavior: 'at_cycle_end';
+
+        /**
+         * The time after which subscriptions should start using the new price.
+         */
+        effective_after?: number;
+
+        /**
+         * The ID of the price object.
+         */
+        price: string;
+      }
+
       type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
     }
 

package/types/Privacy/RedactionJobValidationErrors.d.ts

@@ -0,0 +1,60 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Privacy {
+      /**
+       * The Redaction Job validation error object contains information about
+       * errors that affect the ability to redact a specific object in a
+       * redaction job.
+       */
+      interface RedactionJobValidationError {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'privacy.redaction_job_validation_error';
+
+        /**
+         * A code indicating the reason for the error.
+         */
+        code: RedactionJobValidationError.Code;
+
+        /**
+         * If the error is related to a specific object, this field includes the object's identifier and object type.
+         */
+        erroring_object: RedactionJobValidationError.ErroringObject | null;
+
+        /**
+         * A human-readable message providing more details about the error.
+         */
+        message: string;
+      }
+
+      namespace RedactionJobValidationError {
+        type Code =
+          | 'invalid_cascading_source'
+          | 'invalid_file_purpose'
+          | 'invalid_state'
+          | 'locked_by_other_job'
+          | 'too_many_objects';
+
+        interface ErroringObject {
+          /**
+           * Unique identifier for the object.
+           */
+          id: string;
+
+          /**
+           * Erroring object type
+           */
+          object_type: string;
+        }
+      }
+    }
+  }
+}