stripe 18.2.0-beta.1 → 18.3.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (141) hide show
  1. package/CHANGELOG.md +229 -31
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +11 -11
  4. package/VERSION +1 -1
  5. package/cjs/RequestSender.js +2 -2
  6. package/cjs/StripeResource.js +1 -1
  7. package/cjs/apiVersion.js +1 -1
  8. package/cjs/resources/Subscriptions.js +4 -0
  9. package/cjs/resources/V2/Payments/OffSessionPayments.js +25 -0
  10. package/cjs/resources.js +15 -17
  11. package/cjs/stripe.core.js +1 -1
  12. package/cjs/utils.js +5 -0
  13. package/esm/RequestSender.js +2 -2
  14. package/esm/StripeResource.js +1 -1
  15. package/esm/apiVersion.js +1 -1
  16. package/esm/resources/Subscriptions.js +4 -0
  17. package/esm/resources/V2/Payments/OffSessionPayments.js +22 -0
  18. package/esm/resources.js +4 -6
  19. package/esm/stripe.core.js +1 -1
  20. package/esm/utils.js +5 -0
  21. package/package.json +1 -1
  22. package/types/AccountSessions.d.ts +65 -0
  23. package/types/AccountSessionsResource.d.ts +41 -0
  24. package/types/Accounts.d.ts +22 -15
  25. package/types/AccountsResource.d.ts +81 -57
  26. package/types/Balance.d.ts +83 -1
  27. package/types/BalanceResource.d.ts +1 -1
  28. package/types/BalanceSettings.d.ts +1 -1
  29. package/types/BalanceSettingsResource.d.ts +5 -5
  30. package/types/BalanceTransactions.d.ts +10 -0
  31. package/types/BankAccounts.d.ts +3 -3
  32. package/types/Billing/Alerts.d.ts +1 -1
  33. package/types/Billing/AlertsResource.d.ts +2 -2
  34. package/types/BillingPortal/Sessions.d.ts +1 -1
  35. package/types/Capabilities.d.ts +1 -1
  36. package/types/Cards.d.ts +2 -2
  37. package/types/Charges.d.ts +20 -0
  38. package/types/ChargesResource.d.ts +96 -4
  39. package/types/Checkout/Sessions.d.ts +123 -108
  40. package/types/Checkout/SessionsResource.d.ts +125 -116
  41. package/types/ConfirmationTokens.d.ts +4 -4
  42. package/types/CountrySpecs.d.ts +1 -1
  43. package/types/CreditNotes.d.ts +11 -5
  44. package/types/CreditNotesResource.d.ts +7 -8
  45. package/types/CustomerSessions.d.ts +3 -3
  46. package/types/CustomersResource.d.ts +7 -7
  47. package/types/Disputes.d.ts +1 -1
  48. package/types/DisputesResource.d.ts +1 -1
  49. package/types/EventTypes.d.ts +17 -17
  50. package/types/Events.d.ts +4 -1
  51. package/types/ExternalAccountsResource.d.ts +1 -1
  52. package/types/Files.d.ts +1 -1
  53. package/types/FilesResource.d.ts +1 -1
  54. package/types/FinancialConnections/Accounts.d.ts +5 -0
  55. package/types/FinancialConnections/Institutions.d.ts +5 -0
  56. package/types/Identity/VerificationReports.d.ts +17 -0
  57. package/types/Identity/VerificationSessions.d.ts +19 -2
  58. package/types/Identity/VerificationSessionsResource.d.ts +5 -5
  59. package/types/InvoiceItems.d.ts +1 -1
  60. package/types/InvoiceLineItems.d.ts +1 -1
  61. package/types/InvoicePayments.d.ts +9 -2
  62. package/types/Invoices.d.ts +7 -9
  63. package/types/InvoicesResource.d.ts +60 -18
  64. package/types/Issuing/AuthorizationsResource.d.ts +4 -4
  65. package/types/Issuing/CardsResource.d.ts +3 -0
  66. package/types/Issuing/DisputesResource.d.ts +2 -2
  67. package/types/LineItems.d.ts +2 -2
  68. package/types/Orders.d.ts +43 -83
  69. package/types/OrdersResource.d.ts +85 -119
  70. package/types/PaymentAttemptRecords.d.ts +21 -1
  71. package/types/PaymentIntentAmountDetailsLineItems.d.ts +6 -0
  72. package/types/PaymentIntents.d.ts +224 -173
  73. package/types/PaymentIntentsResource.d.ts +819 -584
  74. package/types/PaymentMethodConfigurations.d.ts +180 -0
  75. package/types/PaymentMethodConfigurationsResource.d.ts +254 -4
  76. package/types/PaymentMethodDomainsResource.d.ts +1 -1
  77. package/types/PaymentMethods.d.ts +4 -4
  78. package/types/PaymentMethodsResource.d.ts +8 -8
  79. package/types/PaymentRecords.d.ts +21 -1
  80. package/types/PaymentRecordsResource.d.ts +5 -5
  81. package/types/Payouts.d.ts +2 -2
  82. package/types/PayoutsResource.d.ts +2 -2
  83. package/types/Persons.d.ts +10 -10
  84. package/types/PlansResource.d.ts +1 -1
  85. package/types/PricesResource.d.ts +2 -2
  86. package/types/Privacy/RedactionJobValidationErrors.d.ts +35 -5
  87. package/types/Privacy/RedactionJobs.d.ts +53 -7
  88. package/types/Privacy/RedactionJobsResource.d.ts +25 -13
  89. package/types/Products.d.ts +0 -39
  90. package/types/ProductsResource.d.ts +1 -37
  91. package/types/PromotionCodesResource.d.ts +1 -1
  92. package/types/QuotePreviewInvoices.d.ts +7 -9
  93. package/types/QuotePreviewSubscriptionSchedules.d.ts +48 -2
  94. package/types/Quotes.d.ts +7 -7
  95. package/types/QuotesResource.d.ts +1 -1
  96. package/types/Radar/EarlyFraudWarningsResource.d.ts +1 -1
  97. package/types/Refunds.d.ts +6 -1
  98. package/types/Reviews.d.ts +1 -1
  99. package/types/SetupAttempts.d.ts +1 -3
  100. package/types/SetupIntents.d.ts +2 -4
  101. package/types/SetupIntentsResource.d.ts +3 -3
  102. package/types/SourcesResource.d.ts +1 -1
  103. package/types/SubscriptionItems.d.ts +21 -0
  104. package/types/SubscriptionItemsResource.d.ts +28 -0
  105. package/types/SubscriptionSchedules.d.ts +48 -2
  106. package/types/SubscriptionSchedulesResource.d.ts +100 -4
  107. package/types/Subscriptions.d.ts +32 -3
  108. package/types/SubscriptionsResource.d.ts +104 -17
  109. package/types/Tax/Associations.d.ts +19 -63
  110. package/types/Tax/CalculationLineItems.d.ts +5 -0
  111. package/types/Tax/CalculationsResource.d.ts +5 -0
  112. package/types/Tax/RegistrationsResource.d.ts +1 -1
  113. package/types/TaxRates.d.ts +2 -2
  114. package/types/Terminal/LocationsResource.d.ts +1 -1
  115. package/types/Terminal/Readers.d.ts +21 -1
  116. package/types/Terminal/ReadersResource.d.ts +20 -0
  117. package/types/Tokens.d.ts +3 -3
  118. package/types/TokensResource.d.ts +8 -8
  119. package/types/TransferReversals.d.ts +1 -1
  120. package/types/TransfersResource.d.ts +2 -2
  121. package/types/Treasury/ReceivedCredits.d.ts +2 -2
  122. package/types/V2/Core/Accounts.d.ts +5 -5
  123. package/types/V2/EventTypes.d.ts +102 -11
  124. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +1 -1
  125. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +1 -43
  126. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +1 -49
  127. package/types/V2/Payments/OffSessionPayments.d.ts +167 -0
  128. package/types/V2/Payments/OffSessionPaymentsResource.d.ts +159 -0
  129. package/types/WebhookEndpointsResource.d.ts +4 -3
  130. package/types/index.d.ts +5 -9
  131. package/types/lib.d.ts +1 -1
  132. package/types/test/typescriptTest.ts +3 -3
  133. package/cjs/resources/GiftCards/Cards.js +0 -23
  134. package/cjs/resources/GiftCards/Transactions.js +0 -33
  135. package/esm/resources/GiftCards/Cards.js +0 -20
  136. package/esm/resources/GiftCards/Transactions.js +0 -30
  137. package/types/Billing/MeterErrorReports.d.ts +0 -106
  138. package/types/GiftCards/Cards.d.ts +0 -118
  139. package/types/GiftCards/CardsResource.d.ts +0 -159
  140. package/types/GiftCards/Transactions.d.ts +0 -129
  141. package/types/GiftCards/TransactionsResource.d.ts +0 -201
@@ -1172,9 +1172,9 @@ declare module 'stripe' {
1172
1172
 
1173
1173
  class PaymentMethodsResource {
1174
1174
  /**
1175
- * Creates a PaymentMethod object. Read the [Stripe.js reference](https://stripe.com/docs/stripe-js/reference#stripe-create-payment-method) to learn how to create PaymentMethods via Stripe.js.
1175
+ * Creates a PaymentMethod object. Read the [Stripe.js reference](https://docs.stripe.com/docs/stripe-js/reference#stripe-create-payment-method) to learn how to create PaymentMethods via Stripe.js.
1176
1176
  *
1177
- * Instead of creating a PaymentMethod directly, we recommend using the [PaymentIntents API to accept a payment immediately or the <a href="/docs/payments/save-and-reuse">SetupIntent](https://stripe.com/docs/payments/accept-a-payment) API to collect payment method details ahead of a future payment.
1177
+ * Instead of creating a PaymentMethod directly, we recommend using the [PaymentIntents API to accept a payment immediately or the <a href="/docs/payments/save-and-reuse">SetupIntent](https://docs.stripe.com/docs/payments/accept-a-payment) API to collect payment method details ahead of a future payment.
1178
1178
  */
1179
1179
  create(
1180
1180
  params?: PaymentMethodCreateParams,
@@ -1185,7 +1185,7 @@ declare module 'stripe' {
1185
1185
  ): Promise<Stripe.Response<Stripe.PaymentMethod>>;
1186
1186
 
1187
1187
  /**
1188
- * Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use [Retrieve a Customer's PaymentMethods](https://stripe.com/docs/api/payment_methods/customer)
1188
+ * Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use [Retrieve a Customer's PaymentMethods](https://docs.stripe.com/docs/api/payment_methods/customer)
1189
1189
  */
1190
1190
  retrieve(
1191
1191
  id: string,
@@ -1207,7 +1207,7 @@ declare module 'stripe' {
1207
1207
  ): Promise<Stripe.Response<Stripe.PaymentMethod>>;
1208
1208
 
1209
1209
  /**
1210
- * Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://stripe.com/docs/api/payment_methods/customer_list) API instead.
1210
+ * Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://docs.stripe.com/docs/api/payment_methods/customer_list) API instead.
1211
1211
  */
1212
1212
  list(
1213
1213
  params?: PaymentMethodListParams,
@@ -1218,16 +1218,16 @@ declare module 'stripe' {
1218
1218
  /**
1219
1219
  * Attaches a PaymentMethod object to a Customer.
1220
1220
  *
1221
- * To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://stripe.com/docs/api/setup_intents)
1222
- * or a PaymentIntent with [setup_future_usage](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage).
1221
+ * To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://docs.stripe.com/docs/api/setup_intents)
1222
+ * or a PaymentIntent with [setup_future_usage](https://docs.stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage).
1223
1223
  * These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach
1224
1224
  * endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for
1225
1225
  * future use, which makes later declines and payment friction more likely.
1226
- * See [Optimizing cards for future payments](https://stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up
1226
+ * See [Optimizing cards for future payments](https://docs.stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up
1227
1227
  * future payments.
1228
1228
  *
1229
1229
  * To use this PaymentMethod as the default for invoice or subscription payments,
1230
- * set [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method),
1230
+ * set [invoice_settings.default_payment_method](https://docs.stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method),
1231
1231
  * on the Customer to the PaymentMethod's ID.
1232
1232
  */
1233
1233
  attach(
@@ -72,7 +72,7 @@ declare module 'stripe' {
72
72
  /**
73
73
  * 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.
74
74
  */
75
- metadata: Stripe.Metadata | null;
75
+ metadata: Stripe.Metadata;
76
76
 
77
77
  /**
78
78
  * Information about the Payment Method debited for this payment.
@@ -408,6 +408,16 @@ declare module 'stripe' {
408
408
  }
409
409
 
410
410
  interface Affirm {
411
+ /**
412
+ * ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
413
+ */
414
+ location?: string;
415
+
416
+ /**
417
+ * ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
418
+ */
419
+ reader?: string;
420
+
411
421
  /**
412
422
  * The Affirm transaction ID associated with this payment.
413
423
  */
@@ -2075,6 +2085,16 @@ declare module 'stripe' {
2075
2085
  */
2076
2086
  fingerprint: string | null;
2077
2087
 
2088
+ /**
2089
+ * ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
2090
+ */
2091
+ location?: string;
2092
+
2093
+ /**
2094
+ * ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
2095
+ */
2096
+ reader?: string;
2097
+
2078
2098
  /**
2079
2099
  * Transaction ID of this particular WeChat Pay transaction.
2080
2100
  */
@@ -58,7 +58,7 @@ declare module 'stripe' {
58
58
  /**
59
59
  * 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`.
60
60
  */
61
- metadata?: Stripe.MetadataParam;
61
+ metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
62
62
 
63
63
  /**
64
64
  * The outcome of the reported payment.
@@ -234,7 +234,7 @@ declare module 'stripe' {
234
234
  /**
235
235
  * 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`.
236
236
  */
237
- metadata?: Stripe.MetadataParam;
237
+ metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
238
238
 
239
239
  /**
240
240
  * The outcome of the reported payment.
@@ -356,7 +356,7 @@ declare module 'stripe' {
356
356
  */
357
357
  expand?: Array<string>;
358
358
 
359
- metadata?: Stripe.MetadataParam;
359
+ metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
360
360
  }
361
361
 
362
362
  interface PaymentRecordReportPaymentAttemptFailedParams {
@@ -370,7 +370,7 @@ declare module 'stripe' {
370
370
  */
371
371
  expand?: Array<string>;
372
372
 
373
- metadata?: Stripe.MetadataParam;
373
+ metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
374
374
  }
375
375
 
376
376
  interface PaymentRecordReportPaymentAttemptGuaranteedParams {
@@ -384,7 +384,7 @@ declare module 'stripe' {
384
384
  */
385
385
  expand?: Array<string>;
386
386
 
387
- metadata?: Stripe.MetadataParam;
387
+ metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
388
388
  }
389
389
 
390
390
  class PaymentRecordsResource {
@@ -5,9 +5,9 @@ declare module 'stripe' {
5
5
  /**
6
6
  * A `Payout` object is created when you receive funds from Stripe, or when you
7
7
  * initiate a payout to either a bank account or debit card of a [connected
8
- * Stripe account](https://stripe.com/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,
8
+ * Stripe account](https://docs.stripe.com/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,
9
9
  * and list all payouts. Payouts are made on [varying
10
- * schedules](https://stripe.com/docs/connect/manage-payout-schedule), depending on your country and
10
+ * schedules](https://docs.stripe.com/docs/connect/manage-payout-schedule), depending on your country and
11
11
  * industry.
12
12
  *
13
13
  * Related guide: [Receiving payouts](https://stripe.com/docs/payouts)
@@ -127,11 +127,11 @@ declare module 'stripe' {
127
127
 
128
128
  class PayoutsResource {
129
129
  /**
130
- * To send funds to your own bank account, create a new payout object. Your [Stripe balance](https://stripe.com/docs/api#balance) must cover the payout amount. If it doesn't, you receive an “Insufficient Funds” error.
130
+ * To send funds to your own bank account, create a new payout object. Your [Stripe balance](https://docs.stripe.com/api#balance) must cover the payout amount. If it doesn't, you receive an “Insufficient Funds” error.
131
131
  *
132
132
  * If your API key is in test mode, money won't actually be sent, though every other action occurs as if you're in live mode.
133
133
  *
134
- * If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The [balance object](https://stripe.com/docs/api#balance_object) details available and pending amounts by source type.
134
+ * If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The [balance object](https://docs.stripe.com/api#balance_object) details available and pending amounts by source type.
135
135
  */
136
136
  create(
137
137
  params: PayoutCreateParams,
@@ -25,9 +25,9 @@ declare module 'stripe' {
25
25
  /**
26
26
  * This is an object representing a person associated with a Stripe account.
27
27
  *
28
- * A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.
28
+ * A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.
29
29
  *
30
- * See the [Standard onboarding](https://stripe.com/connect/standard-accounts) or [Express onboarding](https://stripe.com/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](https://stripe.com/connect/handling-api-verification#person-information).
30
+ * See the [Standard onboarding](https://docs.stripe.com/connect/standard-accounts) or [Express onboarding](https://docs.stripe.com/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](https://docs.stripe.com/connect/handling-api-verification#person-information).
31
31
  */
32
32
  interface Person {
33
33
  /**
@@ -72,27 +72,27 @@ declare module 'stripe' {
72
72
  dob?: Person.Dob;
73
73
 
74
74
  /**
75
- * The person's email address. Also available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
75
+ * The person's email address. Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
76
76
  */
77
77
  email?: string | null;
78
78
 
79
79
  /**
80
- * The person's first name. Also available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
80
+ * The person's first name. Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
81
81
  */
82
82
  first_name?: string | null;
83
83
 
84
84
  /**
85
- * The Kana variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
85
+ * The Kana variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
86
86
  */
87
87
  first_name_kana?: string | null;
88
88
 
89
89
  /**
90
- * The Kanji variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
90
+ * The Kanji variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
91
91
  */
92
92
  first_name_kanji?: string | null;
93
93
 
94
94
  /**
95
- * A list of alternate names or aliases that the person is known by. Also available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
95
+ * A list of alternate names or aliases that the person is known by. Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
96
96
  */
97
97
  full_name_aliases?: Array<string>;
98
98
 
@@ -117,17 +117,17 @@ declare module 'stripe' {
117
117
  id_number_secondary_provided?: boolean;
118
118
 
119
119
  /**
120
- * The person's last name. Also available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
120
+ * The person's last name. Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
121
121
  */
122
122
  last_name?: string | null;
123
123
 
124
124
  /**
125
- * The Kana variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
125
+ * The Kana variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
126
126
  */
127
127
  last_name_kana?: string | null;
128
128
 
129
129
  /**
130
- * The Kanji variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
130
+ * The Kanji variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
131
131
  */
132
132
  last_name_kanji?: string | null;
133
133
 
@@ -248,7 +248,7 @@ declare module 'stripe' {
248
248
 
249
249
  class PlansResource {
250
250
  /**
251
- * You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
251
+ * You can now model subscriptions more flexibly using the [Prices API](https://docs.stripe.com/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
252
252
  */
253
253
  create(
254
254
  params: PlanCreateParams,
@@ -606,7 +606,7 @@ declare module 'stripe' {
606
606
  ): Promise<Stripe.Response<Stripe.Price>>;
607
607
 
608
608
  /**
609
- * Returns a list of your active prices, excluding [inline prices](https://stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
609
+ * Returns a list of your active prices, excluding [inline prices](https://docs.stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
610
610
  */
611
611
  list(
612
612
  params?: PriceListParams,
@@ -615,7 +615,7 @@ declare module 'stripe' {
615
615
  list(options?: RequestOptions): ApiListPromise<Stripe.Price>;
616
616
 
617
617
  /**
618
- * Search for prices you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
618
+ * Search for prices you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
619
619
  * Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
620
620
  * conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
621
621
  * to an hour behind during outages. Search functionality is not available to merchants in India.
@@ -4,7 +4,9 @@ declare module 'stripe' {
4
4
  namespace Stripe {
5
5
  namespace Privacy {
6
6
  /**
7
- * Validation errors
7
+ * The Redaction Job validation error object contains information about
8
+ * errors that affect the ability to redact a specific object in a
9
+ * redaction job.
8
10
  */
9
11
  interface RedactionJobValidationError {
10
12
  /**
@@ -17,14 +19,42 @@ declare module 'stripe' {
17
19
  */
18
20
  object: 'privacy.redaction_job_validation_error';
19
21
 
20
- code: string;
22
+ /**
23
+ * A code indicating the reason for the error.
24
+ */
25
+ code: RedactionJobValidationError.Code;
21
26
 
22
- erroring_object: {
23
- [key: string]: string;
24
- } | null;
27
+ /**
28
+ * If the error is related to a specific object, this field includes the object's identifier and object type.
29
+ */
30
+ erroring_object: RedactionJobValidationError.ErroringObject | null;
25
31
 
32
+ /**
33
+ * A human-readable message providing more details about the error.
34
+ */
26
35
  message: string;
27
36
  }
37
+
38
+ namespace RedactionJobValidationError {
39
+ type Code =
40
+ | 'invalid_cascading_source'
41
+ | 'invalid_file_purpose'
42
+ | 'invalid_state'
43
+ | 'locked_by_other_job'
44
+ | 'too_many_objects';
45
+
46
+ interface ErroringObject {
47
+ /**
48
+ * Unique identifier for the object.
49
+ */
50
+ id: string;
51
+
52
+ /**
53
+ * Erroring object type
54
+ */
55
+ object_type: string;
56
+ }
57
+ }
28
58
  }
29
59
  }
30
60
  }
@@ -4,8 +4,10 @@ declare module 'stripe' {
4
4
  namespace Stripe {
5
5
  namespace Privacy {
6
6
  /**
7
- * Redaction Jobs store the status of a redaction request. They are created
8
- * when a redaction request is made and track the redaction validation and execution.
7
+ * The Redaction Job object redacts Stripe objects. You can use it
8
+ * to coordinate the removal of personal information from selected
9
+ * objects, making them permanently inaccessible in the Stripe Dashboard
10
+ * and API.
9
11
  */
10
12
  interface RedactionJob {
11
13
  /**
@@ -24,41 +26,85 @@ declare module 'stripe' {
24
26
  created: number;
25
27
 
26
28
  /**
27
- * The objects at the root level that are subject to redaction.
29
+ * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
30
+ */
31
+ livemode: boolean;
32
+
33
+ /**
34
+ * The objects to redact in this job.
28
35
  */
29
36
  objects?: RedactionJob.Objects | null;
30
37
 
31
38
  /**
32
- * The status field represents the current state of the redaction job. It can take on any of the following values: VALIDATING, READY, REDACTING, SUCCEEDED, CANCELED, FAILED.
39
+ * The status of the job.
33
40
  */
34
- status: string;
41
+ status: RedactionJob.Status;
35
42
 
36
43
  /**
37
- * Default is "error". If "error", we will make sure all objects in the graph are redactable in the 1st traversal, otherwise error. If "fix", where possible, we will auto-fix any validation errors (e.g. by auto-transitioning objects to a terminal state, etc.) in the 2nd traversal before redacting
44
+ * Validation behavior determines how a job validates objects for redaction eligibility. Default is `error`.
38
45
  */
39
- validation_behavior: string | null;
46
+ validation_behavior: RedactionJob.ValidationBehavior | null;
40
47
  }
41
48
 
42
49
  namespace RedactionJob {
43
50
  interface Objects {
51
+ /**
52
+ * Charge object identifiers usually starting with `ch_`
53
+ */
44
54
  charges: Array<string> | null;
45
55
 
56
+ /**
57
+ * CheckoutSession object identifiers starting with `cs_`
58
+ */
46
59
  checkout_sessions: Array<string> | null;
47
60
 
61
+ /**
62
+ * Customer object identifiers starting with `cus_`
63
+ */
48
64
  customers: Array<string> | null;
49
65
 
66
+ /**
67
+ * Identity VerificationSessions object identifiers starting with `vs_`
68
+ */
50
69
  identity_verification_sessions: Array<string> | null;
51
70
 
71
+ /**
72
+ * Invoice object identifiers starting with `in_`
73
+ */
52
74
  invoices: Array<string> | null;
53
75
 
76
+ /**
77
+ * Issuing Cardholder object identifiers starting with `ich_`
78
+ */
54
79
  issuing_cardholders: Array<string> | null;
55
80
 
81
+ /**
82
+ * PaymentIntent object identifiers starting with `pi_`
83
+ */
56
84
  payment_intents: Array<string> | null;
57
85
 
86
+ /**
87
+ * Fraud ValueListItem object identifiers starting with `rsli_`
88
+ */
58
89
  radar_value_list_items: Array<string> | null;
59
90
 
91
+ /**
92
+ * SetupIntent object identifiers starting with `seti_`
93
+ */
60
94
  setup_intents: Array<string> | null;
61
95
  }
96
+
97
+ type Status =
98
+ | 'canceled'
99
+ | 'canceling'
100
+ | 'created'
101
+ | 'failed'
102
+ | 'ready'
103
+ | 'redacting'
104
+ | 'succeeded'
105
+ | 'validating';
106
+
107
+ type ValidationBehavior = 'error' | 'fix';
62
108
  }
63
109
  }
64
110
  }
@@ -5,7 +5,7 @@ declare module 'stripe' {
5
5
  namespace Privacy {
6
6
  interface RedactionJobCreateParams {
7
7
  /**
8
- * The objects at the root level that are subject to redaction.
8
+ * The objects to redact. These root objects and their related ones will be validated for redaction.
9
9
  */
10
10
  objects: RedactionJobCreateParams.Objects;
11
11
 
@@ -15,10 +15,7 @@ declare module 'stripe' {
15
15
  expand?: Array<string>;
16
16
 
17
17
  /**
18
- * Default is "error". If "error", we will make sure all objects in the graph are
19
- * redactable in the 1st traversal, otherwise error. If "fix", where possible, we will
20
- * auto-fix any validation errors (e.g. by auto-transitioning objects to a terminal
21
- * state, etc.) in the 2nd traversal before redacting
18
+ * Determines the validation behavior of the job. Default is `error`.
22
19
  */
23
20
  validation_behavior?: RedactionJobCreateParams.ValidationBehavior;
24
21
  }
@@ -62,6 +59,9 @@ declare module 'stripe' {
62
59
  */
63
60
  expand?: Array<string>;
64
61
 
62
+ /**
63
+ * Determines the validation behavior of the job. Default is `error`.
64
+ */
65
65
  validation_behavior?: RedactionJobUpdateParams.ValidationBehavior;
66
66
  }
67
67
 
@@ -121,7 +121,7 @@ declare module 'stripe' {
121
121
 
122
122
  class RedactionJobsResource {
123
123
  /**
124
- * Create redaction job method
124
+ * Creates a redaction job. When a job is created, it will start to validate.
125
125
  */
126
126
  create(
127
127
  params: RedactionJobCreateParams,
@@ -129,7 +129,7 @@ declare module 'stripe' {
129
129
  ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
130
130
 
131
131
  /**
132
- * Retrieve redaction job method
132
+ * Retrieves the details of a previously created redaction job.
133
133
  */
134
134
  retrieve(
135
135
  id: string,
@@ -142,7 +142,9 @@ declare module 'stripe' {
142
142
  ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
143
143
 
144
144
  /**
145
- * Update redaction job method
145
+ * Updates the properties of a redaction job without running or canceling the job.
146
+ *
147
+ * If the job to update is in a failed status, it will not automatically start to validate. Once you applied all of the changes, use the validate API to start validation again.
146
148
  */
147
149
  update(
148
150
  id: string,
@@ -151,7 +153,7 @@ declare module 'stripe' {
151
153
  ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
152
154
 
153
155
  /**
154
- * List redaction jobs method...
156
+ * Returns a list of redaction jobs.
155
157
  */
156
158
  list(
157
159
  params?: RedactionJobListParams,
@@ -162,7 +164,9 @@ declare module 'stripe' {
162
164
  ): ApiListPromise<Stripe.Privacy.RedactionJob>;
163
165
 
164
166
  /**
165
- * Cancel redaction job method
167
+ * You can cancel a redaction job when it's in one of these statuses: ready, failed.
168
+ *
169
+ * Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.
166
170
  */
167
171
  cancel(
168
172
  id: string,
@@ -175,7 +179,7 @@ declare module 'stripe' {
175
179
  ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
176
180
 
177
181
  /**
178
- * List validation errors method
182
+ * Returns a list of validation errors for the specified redaction job.
179
183
  */
180
184
  listValidationErrors(
181
185
  id: string,
@@ -188,7 +192,11 @@ declare module 'stripe' {
188
192
  ): ApiListPromise<Stripe.Privacy.RedactionJobValidationError>;
189
193
 
190
194
  /**
191
- * Run redaction job method
195
+ * Run a redaction job in a ready status.
196
+ *
197
+ * When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.
198
+ *
199
+ * The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job's validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.
192
200
  */
193
201
  run(
194
202
  id: string,
@@ -201,7 +209,11 @@ declare module 'stripe' {
201
209
  ): Promise<Stripe.Response<Stripe.Privacy.RedactionJob>>;
202
210
 
203
211
  /**
204
- * Validate redaction job method
212
+ * Validate a redaction job when it is in a failed status.
213
+ *
214
+ * When a job is created, it automatically begins to validate on the configured objects' eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job's validation_behavior is changed.
215
+ *
216
+ * The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.
205
217
  */
206
218
  validate(
207
219
  id: string,
@@ -98,11 +98,6 @@ declare module 'stripe' {
98
98
  */
99
99
  package_dimensions: Product.PackageDimensions | null;
100
100
 
101
- /**
102
- * Provisioning configuration for this product.
103
- */
104
- provisioning?: Product.Provisioning | null;
105
-
106
101
  /**
107
102
  * Whether this product is shipped (i.e., physical goods).
108
103
  */
@@ -169,40 +164,6 @@ declare module 'stripe' {
169
164
  width: number;
170
165
  }
171
166
 
172
- interface Provisioning {
173
- gift_card: Provisioning.GiftCard | null;
174
-
175
- /**
176
- * The type of provisioning, only `gift_card` currently supported.
177
- */
178
- type: 'gift_card';
179
- }
180
-
181
- namespace Provisioning {
182
- interface GiftCard {
183
- fixed_amount: GiftCard.FixedAmount | null;
184
-
185
- /**
186
- * The specific type of gift_card provisioning, only `fixed_amount` currently supported.
187
- */
188
- type: 'fixed_amount';
189
- }
190
-
191
- namespace GiftCard {
192
- interface FixedAmount {
193
- /**
194
- * The initial amount with which the provisioned gift card will be created.
195
- */
196
- amount: number;
197
-
198
- /**
199
- * 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).
200
- */
201
- currency: string;
202
- }
203
- }
204
- }
205
-
206
167
  type Type = 'good' | 'service';
207
168
  }
208
169
  }
@@ -53,11 +53,6 @@ declare module 'stripe' {
53
53
  */
54
54
  package_dimensions?: ProductCreateParams.PackageDimensions;
55
55
 
56
- /**
57
- * Provisioning configuration for this product.
58
- */
59
- provisioning?: ProductCreateParams.Provisioning;
60
-
61
56
  /**
62
57
  * Whether this product is shipped (i.e., physical goods).
63
58
  */
@@ -288,37 +283,6 @@ declare module 'stripe' {
288
283
  width: number;
289
284
  }
290
285
 
291
- interface Provisioning {
292
- gift_card?: Provisioning.GiftCard;
293
-
294
- /**
295
- * The type of provisioning, only `gift_card` currently supported.
296
- */
297
- type: 'gift_card';
298
- }
299
-
300
- namespace Provisioning {
301
- interface GiftCard {
302
- fixed_amount?: GiftCard.FixedAmount;
303
-
304
- /**
305
- * The specific type of gift_card provisioning, only `fixed_amount` currently supported.
306
- */
307
- type: 'fixed_amount';
308
- }
309
-
310
- namespace GiftCard {
311
- interface FixedAmount {
312
- /**
313
- * The initial amount with which the provisioned gift card will be created.
314
- */
315
- amount: number;
316
-
317
- currency: string;
318
- }
319
- }
320
- }
321
-
322
286
  type Type = 'good' | 'service';
323
287
  }
324
288
 
@@ -638,7 +602,7 @@ declare module 'stripe' {
638
602
  ): Promise<Stripe.Response<Stripe.ProductFeature>>;
639
603
 
640
604
  /**
641
- * Search for products you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
605
+ * Search for products you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
642
606
  * Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
643
607
  * conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
644
608
  * to an hour behind during outages. Search functionality is not available to merchants in India.