stripe 17.3.0.pre.alpha.2 → 18.1.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.
- checksums.yaml +4 -4
- data/lib/stripe/api_version.rb +1 -1
- data/lib/stripe/object_types.rb +2 -0
- data/lib/stripe/params/account_create_params.rb +27 -10
- data/lib/stripe/params/account_person_create_params.rb +9 -9
- data/lib/stripe/params/account_person_update_params.rb +9 -9
- data/lib/stripe/params/account_update_params.rb +27 -10
- data/lib/stripe/params/balance_transfer_create_params.rb +66 -0
- data/lib/stripe/params/billing/analytics/meter_usage_retrieve_params.rb +2 -2
- data/lib/stripe/params/charge_capture_params.rb +941 -2
- data/lib/stripe/params/charge_update_params.rb +941 -2
- data/lib/stripe/params/checkout/session_create_params.rb +3 -3
- data/lib/stripe/params/customer_balance_transaction_list_params.rb +21 -1
- data/lib/stripe/params/customer_session_create_params.rb +1 -1
- data/lib/stripe/params/invoice_create_preview_params.rb +28 -1
- data/lib/stripe/params/invoice_payment_list_params.rb +22 -0
- data/lib/stripe/params/issuing/authorization_create_params.rb +16 -1
- data/lib/stripe/params/order_create_params.rb +938 -1
- data/lib/stripe/params/order_update_params.rb +938 -1
- data/lib/stripe/params/payment_intent_capture_params.rb +962 -13
- data/lib/stripe/params/payment_intent_confirm_params.rb +2017 -123
- data/lib/stripe/params/payment_intent_create_params.rb +2017 -123
- data/lib/stripe/params/payment_intent_increment_authorization_params.rb +29 -13
- data/lib/stripe/params/payment_intent_update_params.rb +2017 -123
- data/lib/stripe/params/payment_method_list_params.rb +8 -0
- data/lib/stripe/params/quote_create_params.rb +18 -18
- data/lib/stripe/params/quote_update_params.rb +18 -18
- data/lib/stripe/params/radar/account_evaluation_create_params.rb +81 -0
- data/lib/stripe/params/radar/account_evaluation_retrieve_params.rb +15 -0
- data/lib/stripe/params/radar/account_evaluation_update_params.rb +18 -0
- data/lib/stripe/params/setup_intent_confirm_params.rb +3 -3
- data/lib/stripe/params/setup_intent_create_params.rb +3 -3
- data/lib/stripe/params/setup_intent_update_params.rb +3 -3
- data/lib/stripe/params/subscription_schedule_amend_params.rb +28 -1
- data/lib/stripe/params/tax/registration_create_params.rb +1 -1
- data/lib/stripe/params/terminal/configuration_create_params.rb +9 -9
- data/lib/stripe/params/terminal/configuration_update_params.rb +9 -9
- data/lib/stripe/params/test_helpers/issuing/authorization_create_params.rb +16 -1
- data/lib/stripe/params/token_create_params.rb +18 -18
- data/lib/stripe/params/transfer_create_params.rb +5 -5
- data/lib/stripe/params.rb +4 -0
- data/lib/stripe/resources/account.rb +19 -1
- data/lib/stripe/resources/application_fee.rb +2 -2
- data/lib/stripe/resources/balance_transfer.rb +139 -0
- data/lib/stripe/resources/bank_account.rb +2 -2
- data/lib/stripe/resources/billing/analytics/meter_usage_row.rb +2 -2
- data/lib/stripe/resources/billing_portal/configuration.rb +2 -0
- data/lib/stripe/resources/capital/financing_offer.rb +6 -6
- data/lib/stripe/resources/capital/financing_summary.rb +7 -7
- data/lib/stripe/resources/charge.rb +5 -3
- data/lib/stripe/resources/checkout/session.rb +3 -3
- data/lib/stripe/resources/confirmation_token.rb +1 -1
- data/lib/stripe/resources/delegated_checkout/requested_session.rb +50 -50
- data/lib/stripe/resources/financial_connections/account.rb +22 -0
- data/lib/stripe/resources/invoice.rb +1 -1
- data/lib/stripe/resources/issuing/card.rb +18 -0
- data/lib/stripe/resources/mandate.rb +3 -3
- data/lib/stripe/resources/payment_attempt_record.rb +8 -6
- data/lib/stripe/resources/payment_intent.rb +38 -26
- data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +13 -7
- data/lib/stripe/resources/payment_method.rb +1 -1
- data/lib/stripe/resources/payment_record.rb +8 -6
- data/lib/stripe/resources/person.rb +36 -36
- data/lib/stripe/resources/quote.rb +27 -27
- data/lib/stripe/resources/quote_preview_invoice.rb +1 -1
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +9 -9
- data/lib/stripe/resources/radar/account_evaluation.rb +116 -0
- data/lib/stripe/resources/refund.rb +31 -0
- data/lib/stripe/resources/setup_attempt.rb +1 -1
- data/lib/stripe/resources/setup_intent.rb +3 -3
- data/lib/stripe/resources/subscription.rb +9 -9
- data/lib/stripe/resources/subscription_schedule.rb +9 -9
- data/lib/stripe/resources/transfer.rb +4 -4
- data/lib/stripe/resources.rb +2 -0
- data/lib/stripe/services/balance_transfer_service.rb +17 -0
- data/lib/stripe/services/radar/account_evaluation_service.rb +41 -0
- data/lib/stripe/services/radar_service.rb +2 -1
- data/lib/stripe/services/v1_services.rb +2 -1
- data/lib/stripe/services.rb +2 -0
- data/lib/stripe/util.rb +2 -5
- data/lib/stripe/version.rb +1 -1
- data/rbi/stripe.rbi +17737 -652
- metadata +10 -2
|
@@ -3,8 +3,12 @@
|
|
|
3
3
|
|
|
4
4
|
module Stripe
|
|
5
5
|
class PaymentMethodListParams < ::Stripe::RequestParams
|
|
6
|
+
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
|
|
7
|
+
attr_accessor :allow_redisplay
|
|
6
8
|
# The ID of the customer whose PaymentMethods will be retrieved.
|
|
7
9
|
attr_accessor :customer
|
|
10
|
+
# The ID of the Account whose PaymentMethods will be retrieved.
|
|
11
|
+
attr_accessor :customer_account
|
|
8
12
|
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
|
|
9
13
|
attr_accessor :ending_before
|
|
10
14
|
# Specifies which fields in the response should be expanded.
|
|
@@ -17,14 +21,18 @@ module Stripe
|
|
|
17
21
|
attr_accessor :type
|
|
18
22
|
|
|
19
23
|
def initialize(
|
|
24
|
+
allow_redisplay: nil,
|
|
20
25
|
customer: nil,
|
|
26
|
+
customer_account: nil,
|
|
21
27
|
ending_before: nil,
|
|
22
28
|
expand: nil,
|
|
23
29
|
limit: nil,
|
|
24
30
|
starting_after: nil,
|
|
25
31
|
type: nil
|
|
26
32
|
)
|
|
33
|
+
@allow_redisplay = allow_redisplay
|
|
27
34
|
@customer = customer
|
|
35
|
+
@customer_account = customer_account
|
|
28
36
|
@ending_before = ending_before
|
|
29
37
|
@expand = expand
|
|
30
38
|
@limit = limit
|
|
@@ -896,6 +896,8 @@ module Stripe
|
|
|
896
896
|
attr_accessor :billing_cycle_anchor
|
|
897
897
|
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
|
898
898
|
attr_accessor :billing_mode
|
|
899
|
+
# Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.
|
|
900
|
+
attr_accessor :billing_schedules
|
|
899
901
|
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
|
|
900
902
|
attr_accessor :description
|
|
901
903
|
# When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.
|
|
@@ -906,6 +908,8 @@ module Stripe
|
|
|
906
908
|
attr_accessor :from_subscription
|
|
907
909
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
|
908
910
|
attr_accessor :metadata
|
|
911
|
+
# Configures how the subscription schedule handles billing for phase transitions when the quote is accepted. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
912
|
+
attr_accessor :phase_effective_at
|
|
909
913
|
# If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
|
|
910
914
|
attr_accessor :prebilling
|
|
911
915
|
# Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
|
|
@@ -918,41 +922,37 @@ module Stripe
|
|
|
918
922
|
attr_accessor :proration_behavior
|
|
919
923
|
# Integer representing the number of trial period days before the customer is charged for the first time.
|
|
920
924
|
attr_accessor :trial_period_days
|
|
921
|
-
# Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.
|
|
922
|
-
attr_accessor :billing_schedules
|
|
923
|
-
# Configures how the subscription schedule handles billing for phase transitions when the quote is accepted. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
924
|
-
attr_accessor :phase_effective_at
|
|
925
925
|
|
|
926
926
|
def initialize(
|
|
927
927
|
bill_on_acceptance: nil,
|
|
928
928
|
billing_behavior: nil,
|
|
929
929
|
billing_cycle_anchor: nil,
|
|
930
930
|
billing_mode: nil,
|
|
931
|
+
billing_schedules: nil,
|
|
931
932
|
description: nil,
|
|
932
933
|
effective_date: nil,
|
|
933
934
|
end_behavior: nil,
|
|
934
935
|
from_subscription: nil,
|
|
935
936
|
metadata: nil,
|
|
937
|
+
phase_effective_at: nil,
|
|
936
938
|
prebilling: nil,
|
|
937
939
|
proration_behavior: nil,
|
|
938
|
-
trial_period_days: nil
|
|
939
|
-
billing_schedules: nil,
|
|
940
|
-
phase_effective_at: nil
|
|
940
|
+
trial_period_days: nil
|
|
941
941
|
)
|
|
942
942
|
@bill_on_acceptance = bill_on_acceptance
|
|
943
943
|
@billing_behavior = billing_behavior
|
|
944
944
|
@billing_cycle_anchor = billing_cycle_anchor
|
|
945
945
|
@billing_mode = billing_mode
|
|
946
|
+
@billing_schedules = billing_schedules
|
|
946
947
|
@description = description
|
|
947
948
|
@effective_date = effective_date
|
|
948
949
|
@end_behavior = end_behavior
|
|
949
950
|
@from_subscription = from_subscription
|
|
950
951
|
@metadata = metadata
|
|
952
|
+
@phase_effective_at = phase_effective_at
|
|
951
953
|
@prebilling = prebilling
|
|
952
954
|
@proration_behavior = proration_behavior
|
|
953
955
|
@trial_period_days = trial_period_days
|
|
954
|
-
@billing_schedules = billing_schedules
|
|
955
|
-
@phase_effective_at = phase_effective_at
|
|
956
956
|
end
|
|
957
957
|
end
|
|
958
958
|
|
|
@@ -1151,12 +1151,16 @@ module Stripe
|
|
|
1151
1151
|
attr_accessor :bill_on_acceptance
|
|
1152
1152
|
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
|
|
1153
1153
|
attr_accessor :billing_behavior
|
|
1154
|
+
# Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.
|
|
1155
|
+
attr_accessor :billing_schedules
|
|
1154
1156
|
# The customer the Subscription Data override applies to. This is only relevant when `applies_to.type=new_reference`.
|
|
1155
1157
|
attr_accessor :customer
|
|
1156
1158
|
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
|
|
1157
1159
|
attr_accessor :description
|
|
1158
1160
|
# Behavior of the subscription schedule and underlying subscription when it ends.
|
|
1159
1161
|
attr_accessor :end_behavior
|
|
1162
|
+
# Configures how the subscription schedule handles billing for phase transitions when the quote is accepted. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
1163
|
+
attr_accessor :phase_effective_at
|
|
1160
1164
|
# Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
|
|
1161
1165
|
#
|
|
1162
1166
|
# When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
|
|
@@ -1165,31 +1169,27 @@ module Stripe
|
|
|
1165
1169
|
#
|
|
1166
1170
|
# Prorations can be disabled by passing `none`.
|
|
1167
1171
|
attr_accessor :proration_behavior
|
|
1168
|
-
# Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.
|
|
1169
|
-
attr_accessor :billing_schedules
|
|
1170
|
-
# Configures how the subscription schedule handles billing for phase transitions when the quote is accepted. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
1171
|
-
attr_accessor :phase_effective_at
|
|
1172
1172
|
|
|
1173
1173
|
def initialize(
|
|
1174
1174
|
applies_to: nil,
|
|
1175
1175
|
bill_on_acceptance: nil,
|
|
1176
1176
|
billing_behavior: nil,
|
|
1177
|
+
billing_schedules: nil,
|
|
1177
1178
|
customer: nil,
|
|
1178
1179
|
description: nil,
|
|
1179
1180
|
end_behavior: nil,
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
phase_effective_at: nil
|
|
1181
|
+
phase_effective_at: nil,
|
|
1182
|
+
proration_behavior: nil
|
|
1183
1183
|
)
|
|
1184
1184
|
@applies_to = applies_to
|
|
1185
1185
|
@bill_on_acceptance = bill_on_acceptance
|
|
1186
1186
|
@billing_behavior = billing_behavior
|
|
1187
|
+
@billing_schedules = billing_schedules
|
|
1187
1188
|
@customer = customer
|
|
1188
1189
|
@description = description
|
|
1189
1190
|
@end_behavior = end_behavior
|
|
1190
|
-
@proration_behavior = proration_behavior
|
|
1191
|
-
@billing_schedules = billing_schedules
|
|
1192
1191
|
@phase_effective_at = phase_effective_at
|
|
1192
|
+
@proration_behavior = proration_behavior
|
|
1193
1193
|
end
|
|
1194
1194
|
end
|
|
1195
1195
|
|
|
@@ -879,6 +879,8 @@ module Stripe
|
|
|
879
879
|
attr_accessor :billing_behavior
|
|
880
880
|
# When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.
|
|
881
881
|
attr_accessor :billing_cycle_anchor
|
|
882
|
+
# Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.
|
|
883
|
+
attr_accessor :billing_schedules
|
|
882
884
|
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
|
|
883
885
|
attr_accessor :description
|
|
884
886
|
# When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.
|
|
@@ -887,6 +889,8 @@ module Stripe
|
|
|
887
889
|
attr_accessor :end_behavior
|
|
888
890
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
|
889
891
|
attr_accessor :metadata
|
|
892
|
+
# Configures how the subscription schedule handles billing for phase transitions when the quote is accepted. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
893
|
+
attr_accessor :phase_effective_at
|
|
890
894
|
# If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
|
|
891
895
|
attr_accessor :prebilling
|
|
892
896
|
# Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
|
|
@@ -899,37 +903,33 @@ module Stripe
|
|
|
899
903
|
attr_accessor :proration_behavior
|
|
900
904
|
# Integer representing the number of trial period days before the customer is charged for the first time.
|
|
901
905
|
attr_accessor :trial_period_days
|
|
902
|
-
# Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.
|
|
903
|
-
attr_accessor :billing_schedules
|
|
904
|
-
# Configures how the subscription schedule handles billing for phase transitions when the quote is accepted. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
905
|
-
attr_accessor :phase_effective_at
|
|
906
906
|
|
|
907
907
|
def initialize(
|
|
908
908
|
bill_on_acceptance: nil,
|
|
909
909
|
billing_behavior: nil,
|
|
910
910
|
billing_cycle_anchor: nil,
|
|
911
|
+
billing_schedules: nil,
|
|
911
912
|
description: nil,
|
|
912
913
|
effective_date: nil,
|
|
913
914
|
end_behavior: nil,
|
|
914
915
|
metadata: nil,
|
|
916
|
+
phase_effective_at: nil,
|
|
915
917
|
prebilling: nil,
|
|
916
918
|
proration_behavior: nil,
|
|
917
|
-
trial_period_days: nil
|
|
918
|
-
billing_schedules: nil,
|
|
919
|
-
phase_effective_at: nil
|
|
919
|
+
trial_period_days: nil
|
|
920
920
|
)
|
|
921
921
|
@bill_on_acceptance = bill_on_acceptance
|
|
922
922
|
@billing_behavior = billing_behavior
|
|
923
923
|
@billing_cycle_anchor = billing_cycle_anchor
|
|
924
|
+
@billing_schedules = billing_schedules
|
|
924
925
|
@description = description
|
|
925
926
|
@effective_date = effective_date
|
|
926
927
|
@end_behavior = end_behavior
|
|
927
928
|
@metadata = metadata
|
|
929
|
+
@phase_effective_at = phase_effective_at
|
|
928
930
|
@prebilling = prebilling
|
|
929
931
|
@proration_behavior = proration_behavior
|
|
930
932
|
@trial_period_days = trial_period_days
|
|
931
|
-
@billing_schedules = billing_schedules
|
|
932
|
-
@phase_effective_at = phase_effective_at
|
|
933
933
|
end
|
|
934
934
|
end
|
|
935
935
|
|
|
@@ -1128,12 +1128,16 @@ module Stripe
|
|
|
1128
1128
|
attr_accessor :bill_on_acceptance
|
|
1129
1129
|
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
|
|
1130
1130
|
attr_accessor :billing_behavior
|
|
1131
|
+
# Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.
|
|
1132
|
+
attr_accessor :billing_schedules
|
|
1131
1133
|
# The customer the Subscription Data override applies to.
|
|
1132
1134
|
attr_accessor :customer
|
|
1133
1135
|
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
|
|
1134
1136
|
attr_accessor :description
|
|
1135
1137
|
# Behavior of the subscription schedule and underlying subscription when it ends.
|
|
1136
1138
|
attr_accessor :end_behavior
|
|
1139
|
+
# Configures how the subscription schedule handles billing for phase transitions when the quote is accepted. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
1140
|
+
attr_accessor :phase_effective_at
|
|
1137
1141
|
# Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
|
|
1138
1142
|
#
|
|
1139
1143
|
# When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
|
|
@@ -1142,31 +1146,27 @@ module Stripe
|
|
|
1142
1146
|
#
|
|
1143
1147
|
# Prorations can be disabled by passing `none`.
|
|
1144
1148
|
attr_accessor :proration_behavior
|
|
1145
|
-
# Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.
|
|
1146
|
-
attr_accessor :billing_schedules
|
|
1147
|
-
# Configures how the subscription schedule handles billing for phase transitions when the quote is accepted. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
|
|
1148
|
-
attr_accessor :phase_effective_at
|
|
1149
1149
|
|
|
1150
1150
|
def initialize(
|
|
1151
1151
|
applies_to: nil,
|
|
1152
1152
|
bill_on_acceptance: nil,
|
|
1153
1153
|
billing_behavior: nil,
|
|
1154
|
+
billing_schedules: nil,
|
|
1154
1155
|
customer: nil,
|
|
1155
1156
|
description: nil,
|
|
1156
1157
|
end_behavior: nil,
|
|
1157
|
-
|
|
1158
|
-
|
|
1159
|
-
phase_effective_at: nil
|
|
1158
|
+
phase_effective_at: nil,
|
|
1159
|
+
proration_behavior: nil
|
|
1160
1160
|
)
|
|
1161
1161
|
@applies_to = applies_to
|
|
1162
1162
|
@bill_on_acceptance = bill_on_acceptance
|
|
1163
1163
|
@billing_behavior = billing_behavior
|
|
1164
|
+
@billing_schedules = billing_schedules
|
|
1164
1165
|
@customer = customer
|
|
1165
1166
|
@description = description
|
|
1166
1167
|
@end_behavior = end_behavior
|
|
1167
|
-
@proration_behavior = proration_behavior
|
|
1168
|
-
@billing_schedules = billing_schedules
|
|
1169
1168
|
@phase_effective_at = phase_effective_at
|
|
1169
|
+
@proration_behavior = proration_behavior
|
|
1170
1170
|
end
|
|
1171
1171
|
end
|
|
1172
1172
|
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# File generated from our OpenAPI spec
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
module Stripe
|
|
5
|
+
module Radar
|
|
6
|
+
class AccountEvaluationCreateParams < ::Stripe::RequestParams
|
|
7
|
+
class LoginInitiated < ::Stripe::RequestParams
|
|
8
|
+
class ClientDeviceMetadataDetails < ::Stripe::RequestParams
|
|
9
|
+
# ID for the Radar Session associated with the account evaluation.
|
|
10
|
+
attr_accessor :radar_session
|
|
11
|
+
|
|
12
|
+
def initialize(radar_session: nil)
|
|
13
|
+
@radar_session = radar_session
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
# Client device metadata details (e.g., radar_session).
|
|
17
|
+
attr_accessor :client_device_metadata_details
|
|
18
|
+
# Stripe customer ID
|
|
19
|
+
attr_accessor :customer
|
|
20
|
+
|
|
21
|
+
def initialize(client_device_metadata_details: nil, customer: nil)
|
|
22
|
+
@client_device_metadata_details = client_device_metadata_details
|
|
23
|
+
@customer = customer
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
class RegistrationInitiated < ::Stripe::RequestParams
|
|
28
|
+
class ClientDeviceMetadataDetails < ::Stripe::RequestParams
|
|
29
|
+
# ID for the Radar Session associated with the account evaluation.
|
|
30
|
+
attr_accessor :radar_session
|
|
31
|
+
|
|
32
|
+
def initialize(radar_session: nil)
|
|
33
|
+
@radar_session = radar_session
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
class CustomerData < ::Stripe::RequestParams
|
|
38
|
+
# Customer email
|
|
39
|
+
attr_accessor :email
|
|
40
|
+
# Customer name
|
|
41
|
+
attr_accessor :name
|
|
42
|
+
# Customer phone
|
|
43
|
+
attr_accessor :phone
|
|
44
|
+
|
|
45
|
+
def initialize(email: nil, name: nil, phone: nil)
|
|
46
|
+
@email = email
|
|
47
|
+
@name = name
|
|
48
|
+
@phone = phone
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
# Client device metadata details (e.g., radar_session).
|
|
52
|
+
attr_accessor :client_device_metadata_details
|
|
53
|
+
# Stripe customer ID
|
|
54
|
+
attr_accessor :customer
|
|
55
|
+
# Customer data
|
|
56
|
+
attr_accessor :customer_data
|
|
57
|
+
|
|
58
|
+
def initialize(client_device_metadata_details: nil, customer: nil, customer_data: nil)
|
|
59
|
+
@client_device_metadata_details = client_device_metadata_details
|
|
60
|
+
@customer = customer
|
|
61
|
+
@customer_data = customer_data
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
# Specifies which fields in the response should be expanded.
|
|
65
|
+
attr_accessor :expand
|
|
66
|
+
# Event payload for login_initiated.
|
|
67
|
+
attr_accessor :login_initiated
|
|
68
|
+
# Event payload for registration_initiated.
|
|
69
|
+
attr_accessor :registration_initiated
|
|
70
|
+
# The type of evaluation requested.
|
|
71
|
+
attr_accessor :type
|
|
72
|
+
|
|
73
|
+
def initialize(expand: nil, login_initiated: nil, registration_initiated: nil, type: nil)
|
|
74
|
+
@expand = expand
|
|
75
|
+
@login_initiated = login_initiated
|
|
76
|
+
@registration_initiated = registration_initiated
|
|
77
|
+
@type = type
|
|
78
|
+
end
|
|
79
|
+
end
|
|
80
|
+
end
|
|
81
|
+
end
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# File generated from our OpenAPI spec
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
module Stripe
|
|
5
|
+
module Radar
|
|
6
|
+
class AccountEvaluationRetrieveParams < ::Stripe::RequestParams
|
|
7
|
+
# Specifies which fields in the response should be expanded.
|
|
8
|
+
attr_accessor :expand
|
|
9
|
+
|
|
10
|
+
def initialize(expand: nil)
|
|
11
|
+
@expand = expand
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# File generated from our OpenAPI spec
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
module Stripe
|
|
5
|
+
module Radar
|
|
6
|
+
class AccountEvaluationUpdateParams < ::Stripe::RequestParams
|
|
7
|
+
# Specifies which fields in the response should be expanded.
|
|
8
|
+
attr_accessor :expand
|
|
9
|
+
# The type of event to report.
|
|
10
|
+
attr_accessor :type
|
|
11
|
+
|
|
12
|
+
def initialize(expand: nil, type: nil)
|
|
13
|
+
@expand = expand
|
|
14
|
+
@type = type
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
@@ -985,15 +985,15 @@ module Stripe
|
|
|
985
985
|
class MandateOptions < ::Stripe::RequestParams
|
|
986
986
|
# Amount that will be collected. It is required when `amount_type` is `fixed`.
|
|
987
987
|
attr_accessor :amount
|
|
988
|
-
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
|
|
988
|
+
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`.
|
|
989
989
|
attr_accessor :amount_type
|
|
990
990
|
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
|
991
991
|
attr_accessor :end_date
|
|
992
|
-
# The periodicity at which payments will be collected.
|
|
992
|
+
# The periodicity at which payments will be collected. Defaults to `adhoc`.
|
|
993
993
|
attr_accessor :payment_schedule
|
|
994
994
|
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
|
|
995
995
|
attr_accessor :payments_per_period
|
|
996
|
-
# The purpose for which payments are made.
|
|
996
|
+
# The purpose for which payments are made. Has a default value based on your merchant category code.
|
|
997
997
|
attr_accessor :purpose
|
|
998
998
|
# Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
|
999
999
|
attr_accessor :start_date
|
|
@@ -999,15 +999,15 @@ module Stripe
|
|
|
999
999
|
class MandateOptions < ::Stripe::RequestParams
|
|
1000
1000
|
# Amount that will be collected. It is required when `amount_type` is `fixed`.
|
|
1001
1001
|
attr_accessor :amount
|
|
1002
|
-
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
|
|
1002
|
+
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`.
|
|
1003
1003
|
attr_accessor :amount_type
|
|
1004
1004
|
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
|
1005
1005
|
attr_accessor :end_date
|
|
1006
|
-
# The periodicity at which payments will be collected.
|
|
1006
|
+
# The periodicity at which payments will be collected. Defaults to `adhoc`.
|
|
1007
1007
|
attr_accessor :payment_schedule
|
|
1008
1008
|
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
|
|
1009
1009
|
attr_accessor :payments_per_period
|
|
1010
|
-
# The purpose for which payments are made.
|
|
1010
|
+
# The purpose for which payments are made. Has a default value based on your merchant category code.
|
|
1011
1011
|
attr_accessor :purpose
|
|
1012
1012
|
# Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
|
1013
1013
|
attr_accessor :start_date
|
|
@@ -946,15 +946,15 @@ module Stripe
|
|
|
946
946
|
class MandateOptions < ::Stripe::RequestParams
|
|
947
947
|
# Amount that will be collected. It is required when `amount_type` is `fixed`.
|
|
948
948
|
attr_accessor :amount
|
|
949
|
-
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
|
|
949
|
+
# The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`.
|
|
950
950
|
attr_accessor :amount_type
|
|
951
951
|
# Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
|
|
952
952
|
attr_accessor :end_date
|
|
953
|
-
# The periodicity at which payments will be collected.
|
|
953
|
+
# The periodicity at which payments will be collected. Defaults to `adhoc`.
|
|
954
954
|
attr_accessor :payment_schedule
|
|
955
955
|
# The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
|
|
956
956
|
attr_accessor :payments_per_period
|
|
957
|
-
# The purpose for which payments are made.
|
|
957
|
+
# The purpose for which payments are made. Has a default value based on your merchant category code.
|
|
958
958
|
attr_accessor :purpose
|
|
959
959
|
# Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
|
|
960
960
|
attr_accessor :start_date
|
|
@@ -77,6 +77,29 @@ module Stripe
|
|
|
77
77
|
end
|
|
78
78
|
end
|
|
79
79
|
|
|
80
|
+
class BillingSchedulesAction < ::Stripe::RequestParams
|
|
81
|
+
class AppliesTo < ::Stripe::RequestParams
|
|
82
|
+
# The ID of the price object.
|
|
83
|
+
attr_accessor :price
|
|
84
|
+
# Controls which subscription items the billing schedule applies to.
|
|
85
|
+
attr_accessor :type
|
|
86
|
+
|
|
87
|
+
def initialize(price: nil, type: nil)
|
|
88
|
+
@price = price
|
|
89
|
+
@type = type
|
|
90
|
+
end
|
|
91
|
+
end
|
|
92
|
+
# Specify which subscription items the billing schedule applies to.
|
|
93
|
+
attr_accessor :applies_to
|
|
94
|
+
# Select the action.
|
|
95
|
+
attr_accessor :type
|
|
96
|
+
|
|
97
|
+
def initialize(applies_to: nil, type: nil)
|
|
98
|
+
@applies_to = applies_to
|
|
99
|
+
@type = type
|
|
100
|
+
end
|
|
101
|
+
end
|
|
102
|
+
|
|
80
103
|
class DiscountAction < ::Stripe::RequestParams
|
|
81
104
|
class Add < ::Stripe::RequestParams
|
|
82
105
|
class DiscountEnd < ::Stripe::RequestParams
|
|
@@ -429,6 +452,8 @@ module Stripe
|
|
|
429
452
|
attr_accessor :set_schedule_end
|
|
430
453
|
# Settings related to subscription trials.
|
|
431
454
|
attr_accessor :trial_settings
|
|
455
|
+
# Actions to apply to the billing schedules.
|
|
456
|
+
attr_accessor :billing_schedules_actions
|
|
432
457
|
|
|
433
458
|
def initialize(
|
|
434
459
|
amendment_end: nil,
|
|
@@ -440,7 +465,8 @@ module Stripe
|
|
|
440
465
|
proration_behavior: nil,
|
|
441
466
|
set_pause_collection: nil,
|
|
442
467
|
set_schedule_end: nil,
|
|
443
|
-
trial_settings: nil
|
|
468
|
+
trial_settings: nil,
|
|
469
|
+
billing_schedules_actions: nil
|
|
444
470
|
)
|
|
445
471
|
@amendment_end = amendment_end
|
|
446
472
|
@amendment_start = amendment_start
|
|
@@ -452,6 +478,7 @@ module Stripe
|
|
|
452
478
|
@set_pause_collection = set_pause_collection
|
|
453
479
|
@set_schedule_end = set_schedule_end
|
|
454
480
|
@trial_settings = trial_settings
|
|
481
|
+
@billing_schedules_actions = billing_schedules_actions
|
|
455
482
|
end
|
|
456
483
|
end
|
|
457
484
|
|
|
@@ -1449,7 +1449,7 @@ module Stripe
|
|
|
1449
1449
|
|
|
1450
1450
|
class Us < ::Stripe::RequestParams
|
|
1451
1451
|
class LocalAmusementTax < ::Stripe::RequestParams
|
|
1452
|
-
# A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `06613` (Bloomington), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `48892` (Midlothian), `64343` (River Grove), and `68081` (Schiller Park).
|
|
1452
|
+
# A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `02154` (Arlington Heights), `06613` (Bloomington), `10906` (Campton Hills), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `48892` (Midlothian), `64343` (River Grove), and `68081` (Schiller Park).
|
|
1453
1453
|
attr_accessor :jurisdiction
|
|
1454
1454
|
|
|
1455
1455
|
def initialize(jurisdiction: nil)
|
|
@@ -5,7 +5,7 @@ module Stripe
|
|
|
5
5
|
module Terminal
|
|
6
6
|
class ConfigurationCreateParams < ::Stripe::RequestParams
|
|
7
7
|
class BbposWisepad3 < ::Stripe::RequestParams
|
|
8
|
-
# A File ID representing an image you
|
|
8
|
+
# A File ID representing an image you want to display on the reader.
|
|
9
9
|
attr_accessor :splashscreen
|
|
10
10
|
|
|
11
11
|
def initialize(splashscreen: nil)
|
|
@@ -53,7 +53,7 @@ module Stripe
|
|
|
53
53
|
end
|
|
54
54
|
|
|
55
55
|
class StripeS700 < ::Stripe::RequestParams
|
|
56
|
-
# A File ID representing an image you
|
|
56
|
+
# A File ID representing an image you want to display on the reader.
|
|
57
57
|
attr_accessor :splashscreen
|
|
58
58
|
|
|
59
59
|
def initialize(splashscreen: nil)
|
|
@@ -486,7 +486,7 @@ module Stripe
|
|
|
486
486
|
end
|
|
487
487
|
|
|
488
488
|
class VerifoneP400 < ::Stripe::RequestParams
|
|
489
|
-
# A File ID representing an image you
|
|
489
|
+
# A File ID representing an image you want to display on the reader.
|
|
490
490
|
attr_accessor :splashscreen
|
|
491
491
|
|
|
492
492
|
def initialize(splashscreen: nil)
|
|
@@ -572,9 +572,9 @@ module Stripe
|
|
|
572
572
|
@type = type
|
|
573
573
|
end
|
|
574
574
|
end
|
|
575
|
-
# An object containing device type specific settings for BBPOS WisePad 3 readers
|
|
575
|
+
# An object containing device type specific settings for BBPOS WisePad 3 readers.
|
|
576
576
|
attr_accessor :bbpos_wisepad3
|
|
577
|
-
# An object containing device type specific settings for BBPOS WisePOS E readers
|
|
577
|
+
# An object containing device type specific settings for BBPOS WisePOS E readers.
|
|
578
578
|
attr_accessor :bbpos_wisepos_e
|
|
579
579
|
# Specifies which fields in the response should be expanded.
|
|
580
580
|
attr_accessor :expand
|
|
@@ -584,13 +584,13 @@ module Stripe
|
|
|
584
584
|
attr_accessor :offline
|
|
585
585
|
# Configurations for reader security settings.
|
|
586
586
|
attr_accessor :reader_security
|
|
587
|
-
# Reboot time settings for readers that support customized reboot time configuration.
|
|
587
|
+
# Reboot time settings for readers. that support customized reboot time configuration.
|
|
588
588
|
attr_accessor :reboot_window
|
|
589
|
-
# An object containing device type specific settings for Stripe S700 readers
|
|
589
|
+
# An object containing device type specific settings for Stripe S700 readers.
|
|
590
590
|
attr_accessor :stripe_s700
|
|
591
|
-
# Tipping configurations for readers supporting on-reader tips
|
|
591
|
+
# Tipping configurations for readers. supporting on-reader tips
|
|
592
592
|
attr_accessor :tipping
|
|
593
|
-
# An object containing device type specific settings for Verifone P400 readers
|
|
593
|
+
# An object containing device type specific settings for Verifone P400 readers.
|
|
594
594
|
attr_accessor :verifone_p400
|
|
595
595
|
# Configurations for connecting to a WiFi network.
|
|
596
596
|
attr_accessor :wifi
|
|
@@ -5,7 +5,7 @@ module Stripe
|
|
|
5
5
|
module Terminal
|
|
6
6
|
class ConfigurationUpdateParams < ::Stripe::RequestParams
|
|
7
7
|
class BbposWisepad3 < ::Stripe::RequestParams
|
|
8
|
-
# A File ID representing an image you
|
|
8
|
+
# A File ID representing an image you want to display on the reader.
|
|
9
9
|
attr_accessor :splashscreen
|
|
10
10
|
|
|
11
11
|
def initialize(splashscreen: nil)
|
|
@@ -53,7 +53,7 @@ module Stripe
|
|
|
53
53
|
end
|
|
54
54
|
|
|
55
55
|
class StripeS700 < ::Stripe::RequestParams
|
|
56
|
-
# A File ID representing an image you
|
|
56
|
+
# A File ID representing an image you want to display on the reader.
|
|
57
57
|
attr_accessor :splashscreen
|
|
58
58
|
|
|
59
59
|
def initialize(splashscreen: nil)
|
|
@@ -486,7 +486,7 @@ module Stripe
|
|
|
486
486
|
end
|
|
487
487
|
|
|
488
488
|
class VerifoneP400 < ::Stripe::RequestParams
|
|
489
|
-
# A File ID representing an image you
|
|
489
|
+
# A File ID representing an image you want to display on the reader.
|
|
490
490
|
attr_accessor :splashscreen
|
|
491
491
|
|
|
492
492
|
def initialize(splashscreen: nil)
|
|
@@ -572,9 +572,9 @@ module Stripe
|
|
|
572
572
|
@type = type
|
|
573
573
|
end
|
|
574
574
|
end
|
|
575
|
-
# An object containing device type specific settings for BBPOS WisePad 3 readers
|
|
575
|
+
# An object containing device type specific settings for BBPOS WisePad 3 readers.
|
|
576
576
|
attr_accessor :bbpos_wisepad3
|
|
577
|
-
# An object containing device type specific settings for BBPOS WisePOS E readers
|
|
577
|
+
# An object containing device type specific settings for BBPOS WisePOS E readers.
|
|
578
578
|
attr_accessor :bbpos_wisepos_e
|
|
579
579
|
# Specifies which fields in the response should be expanded.
|
|
580
580
|
attr_accessor :expand
|
|
@@ -584,13 +584,13 @@ module Stripe
|
|
|
584
584
|
attr_accessor :offline
|
|
585
585
|
# Configurations for reader security settings.
|
|
586
586
|
attr_accessor :reader_security
|
|
587
|
-
# Reboot time settings for readers that support customized reboot time configuration.
|
|
587
|
+
# Reboot time settings for readers. that support customized reboot time configuration.
|
|
588
588
|
attr_accessor :reboot_window
|
|
589
|
-
# An object containing device type specific settings for Stripe S700 readers
|
|
589
|
+
# An object containing device type specific settings for Stripe S700 readers.
|
|
590
590
|
attr_accessor :stripe_s700
|
|
591
|
-
# Tipping configurations for readers supporting on-reader tips
|
|
591
|
+
# Tipping configurations for readers. supporting on-reader tips
|
|
592
592
|
attr_accessor :tipping
|
|
593
|
-
# An object containing device type specific settings for Verifone P400 readers
|
|
593
|
+
# An object containing device type specific settings for Verifone P400 readers.
|
|
594
594
|
attr_accessor :verifone_p400
|
|
595
595
|
# Configurations for connecting to a WiFi network.
|
|
596
596
|
attr_accessor :wifi
|