stripe 19.3.0 → 19.4.0-alpha.1

package/types/PaymentRecords.d.ts

@@ -279,8 +279,12 @@ declare module 'stripe' {
 
         giropay?: PaymentMethodDetails.Giropay;
 
+        gopay?: PaymentMethodDetails.Gopay;
+
         grabpay?: PaymentMethodDetails.Grabpay;
 
+        id_bank_transfer?: PaymentMethodDetails.IdBankTransfer;
+
         ideal?: PaymentMethodDetails.Ideal;
 
         interac_present?: PaymentMethodDetails.InteracPresent;
@@ -322,10 +326,18 @@ declare module 'stripe' {
 
         paypal?: PaymentMethodDetails.Paypal;
 
+        paypay?: PaymentMethodDetails.Paypay;
+
+        payto?: PaymentMethodDetails.Payto;
+
         pix?: PaymentMethodDetails.Pix;
 
         promptpay?: PaymentMethodDetails.Promptpay;
 
+        qris?: PaymentMethodDetails.Qris;
+
+        rechnung?: PaymentMethodDetails.Rechnung;
+
         revolut_pay?: PaymentMethodDetails.RevolutPay;
 
         samsung_pay?: PaymentMethodDetails.SamsungPay;
@@ -336,10 +348,14 @@ declare module 'stripe' {
 
         sepa_debit?: PaymentMethodDetails.SepaDebit;
 
+        shopeepay?: PaymentMethodDetails.Shopeepay;
+
         sofort?: PaymentMethodDetails.Sofort;
 
         stripe_account?: PaymentMethodDetails.StripeAccount;
 
+        stripe_balance?: PaymentMethodDetails.StripeBalance;
+
         swish?: PaymentMethodDetails.Swish;
 
         twint?: PaymentMethodDetails.Twint;
@@ -544,6 +560,11 @@ declare module 'stripe' {
                */
               brand: string | null;
 
+              /**
+               * The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
+               */
+              brand_product?: string | null;
+
               /**
                * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
                */
@@ -1292,6 +1313,8 @@ declare module 'stripe' {
           verified_name: string | null;
         }
 
+        interface Gopay {}
+
         interface Grabpay {
           /**
            * Unique transaction id generated by GrabPay
@@ -1299,6 +1322,37 @@ declare module 'stripe' {
           transaction_id: string | null;
         }
 
+        interface IdBankTransfer {
+          /**
+           * Account number of the bank account to transfer funds to.
+           */
+          account_number: string;
+
+          /**
+           * Bank where the account is located.
+           */
+          bank: IdBankTransfer.Bank;
+
+          /**
+           * Local bank code of the bank.
+           */
+          bank_code?: string;
+
+          /**
+           * Name of the bank associated with the bank account.
+           */
+          bank_name?: string;
+
+          /**
+           * Merchant name and billing details name, for the customer to check for the correct merchant when performing the bank transfer.
+           */
+          display_name?: string;
+        }
+
+        namespace IdBankTransfer {
+          type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
+        }
+
         interface Ideal {
           /**
            * The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
@@ -1861,10 +1915,36 @@ declare module 'stripe' {
            */
           seller_protection: Paypal.SellerProtection | null;
 
+          /**
+           * The shipping address for the customer, as supplied by the merchant at the point of payment
+           * execution. This shipping address will not be updated if the merchant updates the shipping
+           * address on the PaymentIntent after the PaymentIntent was successfully confirmed.
+           */
+          shipping?: Stripe.Address | null;
+
           /**
            * A unique ID generated by PayPal for this transaction.
            */
           transaction_id: string | null;
+
+          /**
+           * The shipping address for the customer, as supplied by the merchant at the point of payment
+           * execution. This shipping address will not be updated if the merchant updates the shipping
+           * address on the PaymentIntent after the PaymentIntent was successfully confirmed.
+           */
+          verified_address?: Stripe.Address | null;
+
+          /**
+           * Owner's verified email. Values are verified or provided by PayPal directly
+           * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
+           */
+          verified_email?: string | null;
+
+          /**
+           * Owner's verified full name. Values are verified or provided by PayPal directly
+           * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
+           */
+          verified_name?: string | null;
         }
 
         namespace Paypal {
@@ -1887,11 +1967,40 @@ declare module 'stripe' {
           }
         }
 
+        interface Paypay {}
+
+        interface Payto {
+          /**
+           * Bank-State-Branch number of the bank account.
+           */
+          bsb_number: string | null;
+
+          /**
+           * Last four digits of the bank account number.
+           */
+          last4: string | null;
+
+          /**
+           * ID of the mandate used to make this payment.
+           */
+          mandate?: string;
+
+          /**
+           * The PayID alias for the bank account.
+           */
+          pay_id: string | null;
+        }
+
         interface Pix {
           /**
            * Unique transaction id generated by BCB
            */
           bank_transaction_id?: string | null;
+
+          /**
+           * ID of the multi use Mandate generated by the PaymentIntent
+           */
+          mandate?: string;
         }
 
         interface Promptpay {
@@ -1901,6 +2010,15 @@ declare module 'stripe' {
           reference: string | null;
         }
 
+        interface Qris {}
+
+        interface Rechnung {
+          /**
+           * Payment portal URL.
+           */
+          payment_portal_url: string | null;
+        }
+
         interface RevolutPay {
           funding?: RevolutPay.Funding;
 
@@ -1927,6 +2045,11 @@ declare module 'stripe' {
                */
               brand: string | null;
 
+              /**
+               * The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
+               */
+              brand_product?: string | null;
+
               /**
                * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
                */
@@ -2023,6 +2146,8 @@ declare module 'stripe' {
           mandate: string | null;
         }
 
+        interface Shopeepay {}
+
         interface Sofort {
           /**
            * Bank code of bank associated with the bank account.
@@ -2085,6 +2210,22 @@ declare module 'stripe' {
 
         interface StripeAccount {}
 
+        interface StripeBalance {
+          /**
+           * The connected account ID whose Stripe balance to use as the source of payment
+           */
+          account?: string | null;
+
+          /**
+           * The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
+           */
+          source_type: StripeBalance.SourceType;
+        }
+
+        namespace StripeBalance {
+          type SourceType = 'bank_account' | 'card' | 'fpx';
+        }
+
         interface Swish {
           /**
            * Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer

package/types/Persons.d.ts

@@ -404,6 +404,7 @@ declare module 'stripe' {
             | 'invalid_url_website_other'
             | 'invalid_value_other'
             | 'unsupported_business_type'
+            | 'verification_data_not_found'
             | 'verification_directors_mismatch'
             | 'verification_document_address_mismatch'
             | 'verification_document_address_missing'
@@ -612,6 +613,7 @@ declare module 'stripe' {
             | 'invalid_url_website_other'
             | 'invalid_value_other'
             | 'unsupported_business_type'
+            | 'verification_data_not_found'
             | 'verification_directors_mismatch'
             | 'verification_document_address_mismatch'
             | 'verification_document_address_missing'

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;
+        }
+      }
+    }
+  }
+}

package/types/Privacy/RedactionJobs.d.ts

@@ -0,0 +1,111 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Privacy {
+      /**
+       * The Redaction Job object redacts Stripe objects. You can use it
+       * to coordinate the removal of personal information from selected
+       * objects, making them permanently inaccessible in the Stripe Dashboard
+       * and API.
+       */
+      interface RedactionJob {
+        /**
+         * 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';
+
+        /**
+         * 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;
+
+        /**
+         * The objects to redact in this job.
+         */
+        objects?: RedactionJob.Objects | null;
+
+        /**
+         * The status of the job.
+         */
+        status: RedactionJob.Status;
+
+        /**
+         * Validation behavior determines how a job validates objects for redaction eligibility. Default is `error`.
+         */
+        validation_behavior: RedactionJob.ValidationBehavior | null;
+      }
+
+      namespace RedactionJob {
+        interface Objects {
+          /**
+           * Charge object identifiers usually starting with `ch_`
+           */
+          charges: Array<string> | null;
+
+          /**
+           * CheckoutSession object identifiers starting with `cs_`
+           */
+          checkout_sessions: Array<string> | null;
+
+          /**
+           * Customer object identifiers starting with `cus_`
+           */
+          customers: Array<string> | null;
+
+          /**
+           * Identity VerificationSessions object identifiers starting with `vs_`
+           */
+          identity_verification_sessions: Array<string> | null;
+
+          /**
+           * Invoice object identifiers starting with `in_`
+           */
+          invoices: Array<string> | null;
+
+          /**
+           * Issuing Cardholder object identifiers starting with `ich_`
+           */
+          issuing_cardholders: Array<string> | null;
+
+          /**
+           * PaymentIntent object identifiers starting with `pi_`
+           */
+          payment_intents: Array<string> | null;
+
+          /**
+           * Fraud ValueListItem object identifiers starting with `rsli_`
+           */
+          radar_value_list_items: Array<string> | null;
+
+          /**
+           * SetupIntent object identifiers starting with `seti_`
+           */
+          setup_intents: Array<string> | null;
+        }
+
+        type Status =
+          | 'canceled'
+          | 'canceling'
+          | 'created'
+          | 'failed'
+          | 'ready'
+          | 'redacting'
+          | 'succeeded'
+          | 'validating';
+
+        type ValidationBehavior = 'error' | 'fix';
+      }
+    }
+  }
+}