stripe 15.5.0.pre.beta.2 → 15.6.0.pre.alpha.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 (207) hide show
  1. checksums.yaml +4 -4
  2. data/API_VERSION +1 -1
  3. data/CHANGELOG.md +117 -1
  4. data/OPENAPI_VERSION +1 -1
  5. data/README.md +6 -4
  6. data/VERSION +1 -1
  7. data/lib/stripe/api_requestor.rb +20 -18
  8. data/lib/stripe/api_version.rb +1 -1
  9. data/lib/stripe/errors.rb +26 -23
  10. data/lib/stripe/event_types.rb +83 -0
  11. data/lib/stripe/events/v2_billing_cadence_billed_event.rb +21 -0
  12. data/lib/stripe/events/v2_billing_cadence_canceled_event.rb +21 -0
  13. data/lib/stripe/events/v2_billing_cadence_created_event.rb +23 -0
  14. data/lib/stripe/events/v2_billing_cadence_errored_event.rb +21 -0
  15. data/lib/stripe/events/v2_billing_license_fee_created_event.rb +21 -0
  16. data/lib/stripe/events/v2_billing_license_fee_updated_event.rb +21 -0
  17. data/lib/stripe/events/v2_billing_license_fee_version_created_event.rb +23 -0
  18. data/lib/stripe/events/v2_billing_licensed_item_created_event.rb +21 -0
  19. data/lib/stripe/events/v2_billing_licensed_item_updated_event.rb +21 -0
  20. data/lib/stripe/events/v2_billing_metered_item_created_event.rb +21 -0
  21. data/lib/stripe/events/v2_billing_metered_item_updated_event.rb +21 -0
  22. data/lib/stripe/events/v2_billing_pricing_plan_component_created_event.rb +23 -0
  23. data/lib/stripe/events/v2_billing_pricing_plan_component_updated_event.rb +23 -0
  24. data/lib/stripe/events/v2_billing_pricing_plan_created_event.rb +21 -0
  25. data/lib/stripe/events/v2_billing_pricing_plan_subscription_collection_awaiting_customer_action_event.rb +21 -0
  26. data/lib/stripe/events/v2_billing_pricing_plan_subscription_collection_current_event.rb +21 -0
  27. data/lib/stripe/events/v2_billing_pricing_plan_subscription_collection_past_due_event.rb +21 -0
  28. data/lib/stripe/events/v2_billing_pricing_plan_subscription_collection_paused_event.rb +21 -0
  29. data/lib/stripe/events/v2_billing_pricing_plan_subscription_collection_unpaid_event.rb +21 -0
  30. data/lib/stripe/events/v2_billing_pricing_plan_subscription_servicing_activated_event.rb +21 -0
  31. data/lib/stripe/events/v2_billing_pricing_plan_subscription_servicing_canceled_event.rb +21 -0
  32. data/lib/stripe/events/v2_billing_pricing_plan_subscription_servicing_paused_event.rb +21 -0
  33. data/lib/stripe/events/v2_billing_pricing_plan_updated_event.rb +21 -0
  34. data/lib/stripe/events/v2_billing_pricing_plan_version_created_event.rb +23 -0
  35. data/lib/stripe/events/v2_billing_rate_card_created_event.rb +23 -0
  36. data/lib/stripe/events/v2_billing_rate_card_rate_created_event.rb +23 -0
  37. data/lib/stripe/events/v2_billing_rate_card_subscription_activated_event.rb +21 -0
  38. data/lib/stripe/events/v2_billing_rate_card_subscription_canceled_event.rb +21 -0
  39. data/lib/stripe/events/v2_billing_rate_card_subscription_collection_awaiting_customer_action_event.rb +21 -0
  40. data/lib/stripe/events/v2_billing_rate_card_subscription_collection_current_event.rb +21 -0
  41. data/lib/stripe/events/v2_billing_rate_card_subscription_collection_past_due_event.rb +21 -0
  42. data/lib/stripe/events/v2_billing_rate_card_subscription_collection_paused_event.rb +21 -0
  43. data/lib/stripe/events/v2_billing_rate_card_subscription_collection_unpaid_event.rb +21 -0
  44. data/lib/stripe/events/v2_billing_rate_card_subscription_servicing_activated_event.rb +21 -0
  45. data/lib/stripe/events/v2_billing_rate_card_subscription_servicing_canceled_event.rb +21 -0
  46. data/lib/stripe/events/v2_billing_rate_card_subscription_servicing_paused_event.rb +21 -0
  47. data/lib/stripe/events/v2_billing_rate_card_updated_event.rb +21 -0
  48. data/lib/stripe/events/v2_billing_rate_card_version_created_event.rb +23 -0
  49. data/lib/stripe/events/v2_core_health_api_error_firing_event.rb +13 -0
  50. data/lib/stripe/events/v2_core_health_api_error_resolved_event.rb +13 -0
  51. data/lib/stripe/events/v2_core_health_api_latency_firing_event.rb +13 -0
  52. data/lib/stripe/events/v2_core_health_api_latency_resolved_event.rb +13 -0
  53. data/lib/stripe/events/v2_core_health_authorization_rate_drop_firing_event.rb +13 -0
  54. data/lib/stripe/events/v2_core_health_authorization_rate_drop_resolved_event.rb +13 -0
  55. data/lib/stripe/events/v2_core_health_event_generation_failure_resolved_event.rb +13 -0
  56. data/lib/stripe/events/v2_core_health_fraud_rate_increased_event.rb +13 -0
  57. data/lib/stripe/events/v2_core_health_issuing_authorization_request_timeout_firing_event.rb +13 -0
  58. data/lib/stripe/events/v2_core_health_issuing_authorization_request_timeout_resolved_event.rb +13 -0
  59. data/lib/stripe/events/v2_core_health_payment_method_error_firing_event.rb +13 -0
  60. data/lib/stripe/events/v2_core_health_payment_method_error_resolved_event.rb +13 -0
  61. data/lib/stripe/events/v2_core_health_traffic_volume_drop_firing_event.rb +13 -0
  62. data/lib/stripe/events/v2_core_health_traffic_volume_drop_resolved_event.rb +13 -0
  63. data/lib/stripe/events/v2_core_health_webhook_latency_firing_event.rb +13 -0
  64. data/lib/stripe/events/v2_core_health_webhook_latency_resolved_event.rb +13 -0
  65. data/lib/stripe/events/v2_reporting_report_run_created_event.rb +21 -0
  66. data/lib/stripe/events/v2_reporting_report_run_failed_event.rb +21 -0
  67. data/lib/stripe/events/v2_reporting_report_run_succeeded_event.rb +21 -0
  68. data/lib/stripe/events/v2_reporting_report_run_updated_event.rb +21 -0
  69. data/lib/stripe/object_types.rb +27 -0
  70. data/lib/stripe/resources/account.rb +2 -2
  71. data/lib/stripe/resources/account_session.rb +94 -13
  72. data/lib/stripe/resources/balance.rb +2 -7
  73. data/lib/stripe/resources/balance_settings.rb +72 -65
  74. data/lib/stripe/resources/billing/alert.rb +128 -1
  75. data/lib/stripe/resources/billing/alert_triggered.rb +6 -0
  76. data/lib/stripe/resources/billing/credit_balance_summary.rb +50 -0
  77. data/lib/stripe/resources/billing/credit_balance_transaction.rb +50 -0
  78. data/lib/stripe/resources/billing/credit_grant.rb +61 -2
  79. data/lib/stripe/resources/billing/meter.rb +2 -2
  80. data/lib/stripe/resources/billing/meter_usage_row.rb +1 -1
  81. data/lib/stripe/resources/billing_portal/configuration.rb +12 -2
  82. data/lib/stripe/resources/charge.rb +36 -5
  83. data/lib/stripe/resources/checkout/session.rb +237 -6
  84. data/lib/stripe/resources/credit_note.rb +3 -3
  85. data/lib/stripe/resources/dispute.rb +1 -1
  86. data/lib/stripe/resources/file.rb +1 -1
  87. data/lib/stripe/resources/file_link.rb +1 -1
  88. data/lib/stripe/resources/invoice.rb +55 -1
  89. data/lib/stripe/resources/invoice_item.rb +48 -0
  90. data/lib/stripe/resources/invoice_line_item.rb +52 -0
  91. data/lib/stripe/resources/invoice_payment.rb +1 -1
  92. data/lib/stripe/resources/mandate.rb +65 -1
  93. data/lib/stripe/resources/payment_attempt_record.rb +86 -10
  94. data/lib/stripe/resources/payment_intent.rb +182 -4
  95. data/lib/stripe/resources/payment_link.rb +1 -1
  96. data/lib/stripe/resources/payment_method.rb +2 -0
  97. data/lib/stripe/resources/payment_record.rb +107 -14
  98. data/lib/stripe/resources/promotion_code.rb +5 -2
  99. data/lib/stripe/resources/quote_preview_invoice.rb +8 -1
  100. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +24 -0
  101. data/lib/stripe/resources/setup_attempt.rb +4 -1
  102. data/lib/stripe/resources/setup_intent.rb +194 -1
  103. data/lib/stripe/resources/subscription.rb +145 -9
  104. data/lib/stripe/resources/subscription_schedule.rb +124 -2
  105. data/lib/stripe/resources/terminal/configuration.rb +82 -0
  106. data/lib/stripe/resources/terminal/reader.rb +22 -0
  107. data/lib/stripe/resources/v2/billing/bill_setting.rb +62 -0
  108. data/lib/stripe/resources/v2/billing/bill_setting_version.rb +50 -0
  109. data/lib/stripe/resources/v2/billing/cadence.rb +182 -0
  110. data/lib/stripe/resources/v2/billing/collection_setting.rb +148 -0
  111. data/lib/stripe/resources/v2/billing/collection_setting_version.rb +136 -0
  112. data/lib/stripe/resources/v2/billing/custom_pricing_unit.rb +35 -0
  113. data/lib/stripe/resources/v2/billing/intent.rb +59 -0
  114. data/lib/stripe/resources/v2/billing/intent_action.rb +200 -0
  115. data/lib/stripe/resources/v2/billing/license_fee.rb +79 -0
  116. data/lib/stripe/resources/v2/billing/license_fee_subscription.rb +36 -0
  117. data/lib/stripe/resources/v2/billing/license_fee_version.rb +56 -0
  118. data/lib/stripe/resources/v2/billing/licensed_item.rb +44 -0
  119. data/lib/stripe/resources/v2/billing/metered_item.rb +58 -0
  120. data/lib/stripe/resources/v2/billing/pricing_plan.rb +43 -0
  121. data/lib/stripe/resources/v2/billing/pricing_plan_component.rb +58 -0
  122. data/lib/stripe/resources/v2/billing/pricing_plan_subscription.rb +63 -0
  123. data/lib/stripe/resources/v2/billing/pricing_plan_version.rb +30 -0
  124. data/lib/stripe/resources/v2/billing/profile.rb +38 -0
  125. data/lib/stripe/resources/v2/billing/rate_card.rb +53 -0
  126. data/lib/stripe/resources/v2/billing/rate_card_rate.rb +71 -0
  127. data/lib/stripe/resources/v2/billing/rate_card_subscription.rb +63 -0
  128. data/lib/stripe/resources/v2/billing/rate_card_version.rb +26 -0
  129. data/lib/stripe/resources/v2/billing/service_action.rb +117 -0
  130. data/lib/stripe/resources/v2/core/account.rb +8 -0
  131. data/lib/stripe/resources/v2/core/claimable_sandbox.rb +57 -0
  132. data/lib/stripe/resources/v2/event.rb +2 -0
  133. data/lib/stripe/resources/v2/money_management/financial_account.rb +4 -2
  134. data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +1 -1
  135. data/lib/stripe/resources/v2/money_management/transaction.rb +2 -0
  136. data/lib/stripe/resources/v2/money_management/transaction_entry.rb +2 -0
  137. data/lib/stripe/resources/v2/reporting/report.rb +64 -0
  138. data/lib/stripe/resources/v2/reporting/report_run.rb +89 -0
  139. data/lib/stripe/resources/v2/tax/automatic_rule.rb +31 -0
  140. data/lib/stripe/resources.rb +85 -0
  141. data/lib/stripe/services/account_session_service.rb +64 -13
  142. data/lib/stripe/services/balance_settings_service.rb +44 -41
  143. data/lib/stripe/services/billing/alert_service.rb +75 -1
  144. data/lib/stripe/services/billing/credit_balance_summary_service.rb +13 -1
  145. data/lib/stripe/services/billing/credit_grant_service.rb +29 -2
  146. data/lib/stripe/services/billing/meter_service.rb +1 -1
  147. data/lib/stripe/services/billing_portal/configuration_service.rb +10 -2
  148. data/lib/stripe/services/checkout/session_service.rb +166 -5
  149. data/lib/stripe/services/credit_note_preview_lines_service.rb +1 -1
  150. data/lib/stripe/services/credit_note_service.rb +2 -2
  151. data/lib/stripe/services/customer_service.rb +4 -4
  152. data/lib/stripe/services/file_link_service.rb +1 -1
  153. data/lib/stripe/services/file_service.rb +1 -1
  154. data/lib/stripe/services/invoice_payment_service.rb +1 -1
  155. data/lib/stripe/services/invoice_service.rb +47 -0
  156. data/lib/stripe/services/mandate_service.rb +40 -0
  157. data/lib/stripe/services/payment_attempt_record_service.rb +4 -1
  158. data/lib/stripe/services/payment_intent_service.rb +157 -3
  159. data/lib/stripe/services/payment_link_service.rb +1 -1
  160. data/lib/stripe/services/payment_record_service.rb +25 -5
  161. data/lib/stripe/services/quote_service.rb +4 -4
  162. data/lib/stripe/services/setup_intent_service.rb +153 -0
  163. data/lib/stripe/services/subscription_schedule_service.rb +100 -2
  164. data/lib/stripe/services/subscription_service.rb +134 -9
  165. data/lib/stripe/services/terminal/configuration_service.rb +64 -0
  166. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +22 -0
  167. data/lib/stripe/services/v1_services.rb +5 -5
  168. data/lib/stripe/services/v2/billing/bill_setting_service.rb +214 -0
  169. data/lib/stripe/services/v2/billing/bill_settings/version_service.rb +45 -0
  170. data/lib/stripe/services/v2/billing/cadence_service.rb +428 -0
  171. data/lib/stripe/services/v2/billing/collection_setting_service.rb +518 -0
  172. data/lib/stripe/services/v2/billing/collection_settings/version_service.rb +45 -0
  173. data/lib/stripe/services/v2/billing/custom_pricing_unit_service.rb +108 -0
  174. data/lib/stripe/services/v2/billing/intent_service.rb +465 -0
  175. data/lib/stripe/services/v2/billing/intents/action_service.rb +45 -0
  176. data/lib/stripe/services/v2/billing/license_fee_service.rb +250 -0
  177. data/lib/stripe/services/v2/billing/license_fee_subscription_service.rb +23 -0
  178. data/lib/stripe/services/v2/billing/license_fees/version_service.rb +45 -0
  179. data/lib/stripe/services/v2/billing/licensed_item_service.rb +149 -0
  180. data/lib/stripe/services/v2/billing/metered_item_service.rb +176 -0
  181. data/lib/stripe/services/v2/billing/pricing_plan_service.rb +142 -0
  182. data/lib/stripe/services/v2/billing/pricing_plan_subscription_service.rb +76 -0
  183. data/lib/stripe/services/v2/billing/pricing_plans/component_service.rb +162 -0
  184. data/lib/stripe/services/v2/billing/pricing_plans/version_service.rb +45 -0
  185. data/lib/stripe/services/v2/billing/profile_service.rb +144 -0
  186. data/lib/stripe/services/v2/billing/rate_card_service.rb +151 -0
  187. data/lib/stripe/services/v2/billing/rate_card_subscription_service.rb +144 -0
  188. data/lib/stripe/services/v2/billing/rate_cards/rate_service.rb +161 -0
  189. data/lib/stripe/services/v2/billing/rate_cards/version_service.rb +45 -0
  190. data/lib/stripe/services/v2/billing/service_action_service.rb +259 -0
  191. data/lib/stripe/services/v2/billing_service.rb +19 -2
  192. data/lib/stripe/services/v2/core/account_service.rb +16 -2
  193. data/lib/stripe/services/v2/core/claimable_sandbox_service.rb +50 -0
  194. data/lib/stripe/services/v2/core_service.rb +4 -3
  195. data/lib/stripe/services/v2/money_management/financial_account_service.rb +4 -1
  196. data/lib/stripe/services/v2/money_management_service.rb +3 -3
  197. data/lib/stripe/services/v2/reporting/report_run_service.rb +88 -0
  198. data/lib/stripe/services/v2/reporting/report_service.rb +25 -0
  199. data/lib/stripe/services/v2/reporting_service.rb +16 -0
  200. data/lib/stripe/services/v2/tax/automatic_rule_service.rb +99 -0
  201. data/lib/stripe/services/v2/tax_service.rb +15 -0
  202. data/lib/stripe/services/v2_services.rb +3 -1
  203. data/lib/stripe/services.rb +29 -0
  204. data/lib/stripe/stripe_service.rb +3 -1
  205. data/lib/stripe/version.rb +1 -1
  206. metadata +116 -3
  207. data/rbi/stripe.rbi +0 -199145
@@ -28,7 +28,7 @@ module Stripe
28
28
  end
29
29
 
30
30
  class AdaptivePricing < Stripe::StripeObject
31
- # Whether Adaptive Pricing is enabled.
31
+ # If enabled, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions).
32
32
  attr_reader :enabled
33
33
  end
34
34
 
@@ -795,8 +795,30 @@ module Stripe
795
795
  end
796
796
 
797
797
  class Pix < Stripe::StripeObject
798
+ class MandateOptions < Stripe::StripeObject
799
+ # Amount to be charged for future payments.
800
+ attr_reader :amount
801
+ # Determines if the amount includes the IOF tax.
802
+ attr_reader :amount_includes_iof
803
+ # Type of amount.
804
+ attr_reader :amount_type
805
+ # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
806
+ attr_reader :currency
807
+ # Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
808
+ attr_reader :end_date
809
+ # Schedule at which the future payments will be charged.
810
+ attr_reader :payment_schedule
811
+ # Subscription name displayed to buyers in their bank app.
812
+ attr_reader :reference
813
+ # Start date of the mandate, in `YYYY-MM-DD`.
814
+ attr_reader :start_date
815
+ end
816
+ # Determines if the amount includes the IOF tax.
817
+ attr_reader :amount_includes_iof
798
818
  # The number of seconds after which Pix payment will expire.
799
819
  attr_reader :expires_after_seconds
820
+ # Attribute for field mandate_options
821
+ attr_reader :mandate_options
800
822
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
801
823
  #
802
824
  # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
@@ -1120,6 +1142,52 @@ module Stripe
1120
1142
  attr_reader :link
1121
1143
  end
1122
1144
 
1145
+ class CheckoutItem < Stripe::StripeObject
1146
+ class PricingPlanSubscriptionItem < Stripe::StripeObject
1147
+ class ComponentConfigurations < Stripe::StripeObject
1148
+ class LicenseFeeComponent < Stripe::StripeObject
1149
+ # Attribute for field quantity
1150
+ attr_reader :quantity
1151
+ end
1152
+ # Attribute for field type
1153
+ attr_reader :type
1154
+ # Attribute for field license_fee_component
1155
+ attr_reader :license_fee_component
1156
+ end
1157
+ # Attribute for field pricing_plan
1158
+ attr_reader :pricing_plan
1159
+ # Attribute for field pricing_plan_version
1160
+ attr_reader :pricing_plan_version
1161
+ # Attribute for field metadata
1162
+ attr_reader :metadata
1163
+ # Attribute for field component_configurations
1164
+ attr_reader :component_configurations
1165
+ # Attribute for field pricing_plan_subscription
1166
+ attr_reader :pricing_plan_subscription
1167
+ # Attribute for field billing_cadence
1168
+ attr_reader :billing_cadence
1169
+ end
1170
+
1171
+ class RateCardSubscriptionItem < Stripe::StripeObject
1172
+ # Attribute for field rate_card
1173
+ attr_reader :rate_card
1174
+ # Attribute for field metadata
1175
+ attr_reader :metadata
1176
+ # Attribute for field rate_card_version
1177
+ attr_reader :rate_card_version
1178
+ # Attribute for field billing_cadence
1179
+ attr_reader :billing_cadence
1180
+ # Attribute for field rate_card_subscription
1181
+ attr_reader :rate_card_subscription
1182
+ end
1183
+ # Attribute for field type
1184
+ attr_reader :type
1185
+ # Attribute for field rate_card_subscription_item
1186
+ attr_reader :rate_card_subscription_item
1187
+ # Attribute for field pricing_plan_subscription_item
1188
+ attr_reader :pricing_plan_subscription_item
1189
+ end
1190
+
1123
1191
  class ListParams < Stripe::RequestParams
1124
1192
  class Created < Stripe::RequestParams
1125
1193
  # Minimum value to filter by (exclusive)
@@ -1203,7 +1271,7 @@ module Stripe
1203
1271
 
1204
1272
  class CreateParams < Stripe::RequestParams
1205
1273
  class AdaptivePricing < Stripe::RequestParams
1206
- # Set to `true` to enable [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing). Defaults to your [dashboard setting](https://dashboard.stripe.com/settings/adaptive-pricing).
1274
+ # If set to `true`, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions). Defaults to your [dashboard setting](https://dashboard.stripe.com/settings/adaptive-pricing).
1207
1275
  attr_accessor :enabled
1208
1276
 
1209
1277
  def initialize(enabled: nil)
@@ -1258,6 +1326,81 @@ module Stripe
1258
1326
  end
1259
1327
  end
1260
1328
 
1329
+ class CheckoutItem < Stripe::RequestParams
1330
+ class PricingPlanSubscriptionItem < Stripe::RequestParams
1331
+ class ComponentConfigurations < Stripe::RequestParams
1332
+ class LicenseFeeComponent < Stripe::RequestParams
1333
+ # Attribute for param field quantity
1334
+ attr_accessor :quantity
1335
+
1336
+ def initialize(quantity: nil)
1337
+ @quantity = quantity
1338
+ end
1339
+ end
1340
+ # Attribute for param field type
1341
+ attr_accessor :type
1342
+ # Attribute for param field license_fee_component
1343
+ attr_accessor :license_fee_component
1344
+
1345
+ def initialize(type: nil, license_fee_component: nil)
1346
+ @type = type
1347
+ @license_fee_component = license_fee_component
1348
+ end
1349
+ end
1350
+ # Attribute for param field pricing_plan
1351
+ attr_accessor :pricing_plan
1352
+ # Attribute for param field pricing_plan_version
1353
+ attr_accessor :pricing_plan_version
1354
+ # Attribute for param field metadata
1355
+ attr_accessor :metadata
1356
+ # Attribute for param field component_configurations
1357
+ attr_accessor :component_configurations
1358
+
1359
+ def initialize(
1360
+ pricing_plan: nil,
1361
+ pricing_plan_version: nil,
1362
+ metadata: nil,
1363
+ component_configurations: nil
1364
+ )
1365
+ @pricing_plan = pricing_plan
1366
+ @pricing_plan_version = pricing_plan_version
1367
+ @metadata = metadata
1368
+ @component_configurations = component_configurations
1369
+ end
1370
+ end
1371
+
1372
+ class RateCardSubscriptionItem < Stripe::RequestParams
1373
+ # Attribute for param field rate_card
1374
+ attr_accessor :rate_card
1375
+ # Attribute for param field metadata
1376
+ attr_accessor :metadata
1377
+ # Attribute for param field rate_card_version
1378
+ attr_accessor :rate_card_version
1379
+
1380
+ def initialize(rate_card: nil, metadata: nil, rate_card_version: nil)
1381
+ @rate_card = rate_card
1382
+ @metadata = metadata
1383
+ @rate_card_version = rate_card_version
1384
+ end
1385
+ end
1386
+ # Attribute for param field type
1387
+ attr_accessor :type
1388
+ # Attribute for param field rate_card_subscription_item
1389
+ attr_accessor :rate_card_subscription_item
1390
+ # Attribute for param field pricing_plan_subscription_item
1391
+ attr_accessor :pricing_plan_subscription_item
1392
+
1393
+ def initialize(
1394
+ type: nil,
1395
+ rate_card_subscription_item: nil,
1396
+ pricing_plan_subscription_item: nil
1397
+ )
1398
+ @type = type
1399
+ @rate_card_subscription_item = rate_card_subscription_item
1400
+ @pricing_plan_subscription_item = pricing_plan_subscription_item
1401
+ end
1402
+ end
1403
+
1261
1404
  class ConsentCollection < Stripe::RequestParams
1262
1405
  class PaymentMethodReuseAgreement < Stripe::RequestParams
1263
1406
  # Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's
@@ -1464,13 +1607,46 @@ module Stripe
1464
1607
  end
1465
1608
 
1466
1609
  class Discount < Stripe::RequestParams
1610
+ class CouponData < Stripe::RequestParams
1611
+ # A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
1612
+ attr_accessor :amount_off
1613
+ # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
1614
+ attr_accessor :currency
1615
+ # Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
1616
+ attr_accessor :duration
1617
+ # 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`.
1618
+ attr_accessor :metadata
1619
+ # Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
1620
+ attr_accessor :name
1621
+ # A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
1622
+ attr_accessor :percent_off
1623
+
1624
+ def initialize(
1625
+ amount_off: nil,
1626
+ currency: nil,
1627
+ duration: nil,
1628
+ metadata: nil,
1629
+ name: nil,
1630
+ percent_off: nil
1631
+ )
1632
+ @amount_off = amount_off
1633
+ @currency = currency
1634
+ @duration = duration
1635
+ @metadata = metadata
1636
+ @name = name
1637
+ @percent_off = percent_off
1638
+ end
1639
+ end
1467
1640
  # The ID of the coupon to apply to this Session.
1468
1641
  attr_accessor :coupon
1642
+ # Data used to generate a new [Coupon](https://stripe.com/docs/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.
1643
+ attr_accessor :coupon_data
1469
1644
  # The ID of a promotion code to apply to this Session.
1470
1645
  attr_accessor :promotion_code
1471
1646
 
1472
- def initialize(coupon: nil, promotion_code: nil)
1647
+ def initialize(coupon: nil, coupon_data: nil, promotion_code: nil)
1473
1648
  @coupon = coupon
1649
+ @coupon_data = coupon_data
1474
1650
  @promotion_code = promotion_code
1475
1651
  end
1476
1652
  end
@@ -2596,8 +2772,50 @@ module Stripe
2596
2772
  end
2597
2773
 
2598
2774
  class Pix < Stripe::RequestParams
2775
+ class MandateOptions < Stripe::RequestParams
2776
+ # Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
2777
+ attr_accessor :amount
2778
+ # Determines if the amount includes the IOF tax. Defaults to `never`.
2779
+ attr_accessor :amount_includes_iof
2780
+ # Type of amount. Defaults to `maximum`.
2781
+ attr_accessor :amount_type
2782
+ # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
2783
+ attr_accessor :currency
2784
+ # Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
2785
+ attr_accessor :end_date
2786
+ # Schedule at which the future payments will be charged. Defaults to `weekly`.
2787
+ attr_accessor :payment_schedule
2788
+ # Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
2789
+ attr_accessor :reference
2790
+ # Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
2791
+ attr_accessor :start_date
2792
+
2793
+ def initialize(
2794
+ amount: nil,
2795
+ amount_includes_iof: nil,
2796
+ amount_type: nil,
2797
+ currency: nil,
2798
+ end_date: nil,
2799
+ payment_schedule: nil,
2800
+ reference: nil,
2801
+ start_date: nil
2802
+ )
2803
+ @amount = amount
2804
+ @amount_includes_iof = amount_includes_iof
2805
+ @amount_type = amount_type
2806
+ @currency = currency
2807
+ @end_date = end_date
2808
+ @payment_schedule = payment_schedule
2809
+ @reference = reference
2810
+ @start_date = start_date
2811
+ end
2812
+ end
2813
+ # Determines if the amount includes the IOF tax. Defaults to `never`.
2814
+ attr_accessor :amount_includes_iof
2599
2815
  # The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
2600
2816
  attr_accessor :expires_after_seconds
2817
+ # Additional fields for mandate creation.
2818
+ attr_accessor :mandate_options
2601
2819
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
2602
2820
  #
2603
2821
  # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
@@ -2607,8 +2825,15 @@ module Stripe
2607
2825
  # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
2608
2826
  attr_accessor :setup_future_usage
2609
2827
 
2610
- def initialize(expires_after_seconds: nil, setup_future_usage: nil)
2828
+ def initialize(
2829
+ amount_includes_iof: nil,
2830
+ expires_after_seconds: nil,
2831
+ mandate_options: nil,
2832
+ setup_future_usage: nil
2833
+ )
2834
+ @amount_includes_iof = amount_includes_iof
2611
2835
  @expires_after_seconds = expires_after_seconds
2836
+ @mandate_options = mandate_options
2612
2837
  @setup_future_usage = setup_future_usage
2613
2838
  end
2614
2839
  end
@@ -3361,7 +3586,7 @@ module Stripe
3361
3586
  #
3362
3587
  # For `subscription` mode, there is a maximum of 20 line items and optional items with recurring Prices and 20 line items and optional items with one-time Prices.
3363
3588
  attr_accessor :optional_items
3364
- # Where the user is coming from. This informs the optimizations that are applied to the session. For example, a session originating from a mobile app may behave more like a native app, depending on the platform. This parameter is currently not allowed if `ui_mode` is `custom`.
3589
+ # Where the user is coming from. This informs the optimizations that are applied to the session.
3365
3590
  attr_accessor :origin_context
3366
3591
  # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
3367
3592
  attr_accessor :payment_intent_data
@@ -3432,6 +3657,8 @@ module Stripe
3432
3657
  attr_accessor :ui_mode
3433
3658
  # Wallet-specific configuration.
3434
3659
  attr_accessor :wallet_options
3660
+ # Attribute for param field checkout_items
3661
+ attr_accessor :checkout_items
3435
3662
 
3436
3663
  def initialize(
3437
3664
  adaptive_pricing: nil,
@@ -3479,7 +3706,8 @@ module Stripe
3479
3706
  success_url: nil,
3480
3707
  tax_id_collection: nil,
3481
3708
  ui_mode: nil,
3482
- wallet_options: nil
3709
+ wallet_options: nil,
3710
+ checkout_items: nil
3483
3711
  )
3484
3712
  @adaptive_pricing = adaptive_pricing
3485
3713
  @after_expiration = after_expiration
@@ -3527,6 +3755,7 @@ module Stripe
3527
3755
  @tax_id_collection = tax_id_collection
3528
3756
  @ui_mode = ui_mode
3529
3757
  @wallet_options = wallet_options
3758
+ @checkout_items = checkout_items
3530
3759
  end
3531
3760
  end
3532
3761
 
@@ -4073,6 +4302,8 @@ module Stripe
4073
4302
  attr_reader :url
4074
4303
  # Wallet-specific configuration for this Checkout Session.
4075
4304
  attr_reader :wallet_options
4305
+ # Attribute for field checkout_items
4306
+ attr_reader :checkout_items
4076
4307
 
4077
4308
  # Creates a Checkout Session object.
4078
4309
  def self.create(params = {}, opts = {})
@@ -201,7 +201,7 @@ module Stripe
201
201
  class Refund < Stripe::RequestParams
202
202
  # Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
203
203
  attr_accessor :amount_refunded
204
- # ID of an existing refund to link this credit note to.
204
+ # ID of an existing refund to link this credit note to. Required when `type` is `refund`.
205
205
  attr_accessor :refund
206
206
 
207
207
  def initialize(amount_refunded: nil, refund: nil)
@@ -356,7 +356,7 @@ module Stripe
356
356
  class Refund < Stripe::RequestParams
357
357
  # Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
358
358
  attr_accessor :amount_refunded
359
- # ID of an existing refund to link this credit note to.
359
+ # ID of an existing refund to link this credit note to. Required when `type` is `refund`.
360
360
  attr_accessor :refund
361
361
 
362
362
  def initialize(amount_refunded: nil, refund: nil)
@@ -496,7 +496,7 @@ module Stripe
496
496
  class Refund < Stripe::RequestParams
497
497
  # Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
498
498
  attr_accessor :amount_refunded
499
- # ID of an existing refund to link this credit note to.
499
+ # ID of an existing refund to link this credit note to. Required when `type` is `refund`.
500
500
  attr_accessor :refund
501
501
 
502
502
  def initialize(amount_refunded: nil, refund: nil)
@@ -634,7 +634,7 @@ module Stripe
634
634
  attr_reader :reason
635
635
  # Attribute for field smart_disputes
636
636
  attr_reader :smart_disputes
637
- # Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, or `lost`.
637
+ # The current status of a dispute. Possible values include:`warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, `lost`, or `prevented`.
638
638
  attr_reader :status
639
639
 
640
640
  # Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.
@@ -68,7 +68,7 @@ module Stripe
68
68
 
69
69
  class CreateParams < Stripe::RequestParams
70
70
  class FileLinkData < Stripe::RequestParams
71
- # Set this to `true` to create a file link for the newly created file. Creating a link is only possible when the file's `purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `issuing_regulatory_reporting`, `pci_document`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.
71
+ # Set this to `true` to create a file link for the newly created file. Creating a link is only possible when the file's `purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `issuing_regulatory_reporting`, `pci_document`, `tax_document_user_upload`, `terminal_android_apk`, or `terminal_reader_splashscreen`.
72
72
  attr_accessor :create
73
73
  # The link isn't available after this future timestamp.
74
74
  attr_accessor :expires_at
@@ -72,7 +72,7 @@ module Stripe
72
72
  attr_accessor :expand
73
73
  # The link isn't usable after this future timestamp.
74
74
  attr_accessor :expires_at
75
- # The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `financial_account_statement`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.
75
+ # The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `financial_account_statement`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, `terminal_android_apk`, or `terminal_reader_splashscreen`.
76
76
  attr_accessor :file
77
77
  # 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`.
78
78
  attr_accessor :metadata
@@ -179,7 +179,7 @@ module Stripe
179
179
  attr_reader :message
180
180
  # For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
181
181
  attr_reader :network_advice_code
182
- # For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.
182
+ # For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
183
183
  attr_reader :network_decline_code
184
184
  # If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
185
185
  attr_reader :param
@@ -234,6 +234,11 @@ module Stripe
234
234
  end
235
235
 
236
236
  class Parent < Stripe::StripeObject
237
+ class BillingCadenceDetails < Stripe::StripeObject
238
+ # The billing cadence that generated this invoice
239
+ attr_reader :billing_cadence
240
+ end
241
+
237
242
  class QuoteDetails < Stripe::StripeObject
238
243
  # The quote that generated this invoice
239
244
  attr_reader :quote
@@ -256,6 +261,8 @@ module Stripe
256
261
  # Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
257
262
  attr_reader :subscription_proration_date
258
263
  end
264
+ # Details about the billing cadence that generated this invoice
265
+ attr_reader :billing_cadence_details
259
266
  # Details about the quote that generated this invoice
260
267
  attr_reader :quote_details
261
268
  # Details about the subscription that generated this invoice
@@ -3467,6 +3474,41 @@ module Stripe
3467
3474
  end
3468
3475
  end
3469
3476
 
3477
+ class Period < Stripe::RequestParams
3478
+ class End < Stripe::RequestParams
3479
+ # A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
3480
+ attr_accessor :timestamp
3481
+ # Select how to calculate the end of the invoice item period.
3482
+ attr_accessor :type
3483
+
3484
+ def initialize(timestamp: nil, type: nil)
3485
+ @timestamp = timestamp
3486
+ @type = type
3487
+ end
3488
+ end
3489
+
3490
+ class Start < Stripe::RequestParams
3491
+ # A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
3492
+ attr_accessor :timestamp
3493
+ # Select how to calculate the start of the invoice item period.
3494
+ attr_accessor :type
3495
+
3496
+ def initialize(timestamp: nil, type: nil)
3497
+ @timestamp = timestamp
3498
+ @type = type
3499
+ end
3500
+ end
3501
+ # End of the invoice item period.
3502
+ attr_accessor :end
3503
+ # Start of the invoice item period.
3504
+ attr_accessor :start
3505
+
3506
+ def initialize(end_: nil, start: nil)
3507
+ @end = end_
3508
+ @start = start
3509
+ end
3510
+ end
3511
+
3470
3512
  class PriceData < Stripe::RequestParams
3471
3513
  # 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).
3472
3514
  attr_accessor :currency
@@ -3495,6 +3537,10 @@ module Stripe
3495
3537
  end
3496
3538
  # The coupons to redeem into discounts for the item.
3497
3539
  attr_accessor :discounts
3540
+ # 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`.
3541
+ attr_accessor :metadata
3542
+ # The period associated with this invoice item. Defaults to the period of the underlying subscription that surrounds the start of the phase.
3543
+ attr_accessor :period
3498
3544
  # The ID of the price object. One of `price` or `price_data` is required.
3499
3545
  attr_accessor :price
3500
3546
  # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
@@ -3506,12 +3552,16 @@ module Stripe
3506
3552
 
3507
3553
  def initialize(
3508
3554
  discounts: nil,
3555
+ metadata: nil,
3556
+ period: nil,
3509
3557
  price: nil,
3510
3558
  price_data: nil,
3511
3559
  quantity: nil,
3512
3560
  tax_rates: nil
3513
3561
  )
3514
3562
  @discounts = discounts
3563
+ @metadata = metadata
3564
+ @period = period
3515
3565
  @price = price
3516
3566
  @price_data = price_data
3517
3567
  @quantity = quantity
@@ -4233,6 +4283,8 @@ module Stripe
4233
4283
  end
4234
4284
  # Settings for automatic tax lookup for this invoice preview.
4235
4285
  attr_accessor :automatic_tax
4286
+ # The identifier of the billing cadence for which you’d like to retrieve the upcoming invoice.Cannot be provided when `subscription`, `schedule`, `subscription_details` or `schedule_details` are provided.
4287
+ attr_accessor :billing_cadence
4236
4288
  # The currency to preview this invoice in. Defaults to that of `customer` if not specified.
4237
4289
  attr_accessor :currency
4238
4290
  # The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
@@ -4264,6 +4316,7 @@ module Stripe
4264
4316
 
4265
4317
  def initialize(
4266
4318
  automatic_tax: nil,
4319
+ billing_cadence: nil,
4267
4320
  currency: nil,
4268
4321
  customer: nil,
4269
4322
  customer_account: nil,
@@ -4280,6 +4333,7 @@ module Stripe
4280
4333
  subscription_details: nil
4281
4334
  )
4282
4335
  @automatic_tax = automatic_tax
4336
+ @billing_cadence = billing_cadence
4283
4337
  @currency = currency
4284
4338
  @customer = customer
4285
4339
  @customer_account = customer_account
@@ -22,12 +22,38 @@ module Stripe
22
22
  end
23
23
 
24
24
  class Parent < Stripe::StripeObject
25
+ class LicenseFeeSubscriptionDetails < Stripe::StripeObject
26
+ # The license fee subscription that generated this invoice item
27
+ attr_reader :license_fee_subscription
28
+ # The license fee version that generated this invoice item
29
+ attr_reader :license_fee_version
30
+ # The pricing plan subscription that manages the license fee subscription
31
+ attr_reader :pricing_plan_subscription
32
+ # The pricing plan version at the time this invoice item was generated
33
+ attr_reader :pricing_plan_version
34
+ end
35
+
36
+ class RateCardSubscriptionDetails < Stripe::StripeObject
37
+ # The pricing plan subscription that manages the rate card subscription
38
+ attr_reader :pricing_plan_subscription
39
+ # The pricing plan version at the time this invoice item was generated
40
+ attr_reader :pricing_plan_version
41
+ # The rate card subscription that generated this invoice item
42
+ attr_reader :rate_card_subscription
43
+ # The rate card version that generated this invoice item
44
+ attr_reader :rate_card_version
45
+ end
46
+
25
47
  class SubscriptionDetails < Stripe::StripeObject
26
48
  # The subscription that generated this invoice item
27
49
  attr_reader :subscription
28
50
  # The subscription item that generated this invoice item
29
51
  attr_reader :subscription_item
30
52
  end
53
+ # Details about the license fee subscription that generated this invoice item
54
+ attr_reader :license_fee_subscription_details
55
+ # Details about the rate card subscription that generated this invoice item
56
+ attr_reader :rate_card_subscription_details
31
57
  # Details about the subscription that generated this invoice item
32
58
  attr_reader :subscription_details
33
59
  # The type of parent that generated this invoice item
@@ -42,14 +68,36 @@ module Stripe
42
68
  end
43
69
 
44
70
  class Pricing < Stripe::StripeObject
71
+ class LicenseFeeDetails < Stripe::StripeObject
72
+ # The ID of the license fee this item is associated with
73
+ attr_reader :license_fee
74
+ # The version of the license fee this item is associated with
75
+ attr_reader :license_fee_version
76
+ # The ID of the licensed item this item is associated with
77
+ attr_reader :licensed_item
78
+ end
79
+
45
80
  class PriceDetails < Stripe::StripeObject
46
81
  # The ID of the price this item is associated with.
47
82
  attr_reader :price
48
83
  # The ID of the product this item is associated with.
49
84
  attr_reader :product
50
85
  end
86
+
87
+ class RateCardRateDetails < Stripe::StripeObject
88
+ # The ID of billable item this item is associated with
89
+ attr_reader :metered_item
90
+ # The ID of the rate card this item is associated with
91
+ attr_reader :rate_card
92
+ # The ID of the rate card rate this item is associated with
93
+ attr_reader :rate_card_rate
94
+ end
95
+ # Attribute for field license_fee_details
96
+ attr_reader :license_fee_details
51
97
  # Attribute for field price_details
52
98
  attr_reader :price_details
99
+ # Attribute for field rate_card_rate_details
100
+ attr_reader :rate_card_rate_details
53
101
  # The type of the pricing details.
54
102
  attr_reader :type
55
103
  # The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.