dodopayments 2.8.0 → 2.9.0
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/CHANGELOG.md +17 -0
- data/README.md +1 -1
- data/lib/dodopayments/client.rb +4 -0
- data/lib/dodopayments/models/attach_product_entitlement.rb +22 -0
- data/lib/dodopayments/models/cancellation_feedback.rb +21 -0
- data/lib/dodopayments/models/checkout_session_flags.rb +12 -1
- data/lib/dodopayments/models/checkout_session_request.rb +14 -1
- data/lib/dodopayments/models/credit_entitlements/credit_ledger_entry.rb +1 -0
- data/lib/dodopayments/models/credit_overage_reset_webhook_event.rb +52 -0
- data/lib/dodopayments/models/customer_list_entitlements_params.rb +20 -0
- data/lib/dodopayments/models/customer_list_entitlements_response.rb +105 -0
- data/lib/dodopayments/models/digital_product_delivery.rb +13 -15
- data/lib/dodopayments/models/digital_product_delivery_file.rb +32 -8
- data/lib/dodopayments/models/entitlement.rb +86 -0
- data/lib/dodopayments/models/entitlement_create_params.rb +54 -0
- data/lib/dodopayments/models/entitlement_delete_params.rb +20 -0
- data/lib/dodopayments/models/entitlement_grant_created_webhook_event.rb +51 -0
- data/lib/dodopayments/models/entitlement_grant_delivered_webhook_event.rb +51 -0
- data/lib/dodopayments/models/entitlement_grant_failed_webhook_event.rb +51 -0
- data/lib/dodopayments/models/entitlement_grant_revoked_webhook_event.rb +51 -0
- data/lib/dodopayments/models/entitlement_integration_type.rb +21 -0
- data/lib/dodopayments/models/entitlement_list_params.rb +55 -0
- data/lib/dodopayments/models/entitlement_retrieve_params.rb +20 -0
- data/lib/dodopayments/models/entitlement_update_params.rb +54 -0
- data/lib/dodopayments/models/entitlements/entitlement_grant.rb +172 -0
- data/lib/dodopayments/models/entitlements/file_delete_params.rb +28 -0
- data/lib/dodopayments/models/entitlements/file_upload_params.rb +22 -0
- data/lib/dodopayments/models/entitlements/file_upload_response.rb +23 -0
- data/lib/dodopayments/models/entitlements/grant_list_params.rb +68 -0
- data/lib/dodopayments/models/entitlements/grant_revoke_params.rb +28 -0
- data/lib/dodopayments/models/entitlements/license_key_grant.rb +40 -0
- data/lib/dodopayments/models/integration_config.rb +174 -0
- data/lib/dodopayments/models/integration_config_response.rb +238 -0
- data/lib/dodopayments/models/license_key_instance_list_params.rb +9 -1
- data/lib/dodopayments/models/one_time_product_cart_item.rb +15 -1
- data/lib/dodopayments/models/payment.rb +19 -3
- data/lib/dodopayments/models/payment_create_params.rb +23 -35
- data/lib/dodopayments/models/payment_create_response.rb +3 -33
- data/lib/dodopayments/models/product.rb +12 -217
- data/lib/dodopayments/models/product_create_params.rb +25 -6
- data/lib/dodopayments/models/product_entitlement_summary.rb +57 -0
- data/lib/dodopayments/models/product_list_response.rb +3 -218
- data/lib/dodopayments/models/product_update_params.rb +21 -7
- data/lib/dodopayments/models/scheduled_plan_change.rb +99 -0
- data/lib/dodopayments/models/subscription.rb +20 -102
- data/lib/dodopayments/models/subscription_create_params.rb +27 -37
- data/lib/dodopayments/models/subscription_create_response.rb +19 -3
- data/lib/dodopayments/models/subscription_list_response.rb +3 -103
- data/lib/dodopayments/models/subscription_update_params.rb +23 -1
- data/lib/dodopayments/models/unsafe_unwrap_webhook_event.rb +11 -1
- data/lib/dodopayments/models/unwrap_webhook_event.rb +11 -1
- data/lib/dodopayments/models/update_subscription_plan_req.rb +10 -1
- data/lib/dodopayments/models/webhook_event_type.rb +1 -0
- data/lib/dodopayments/models/webhook_payload.rb +2 -154
- data/lib/dodopayments/models.rb +40 -0
- data/lib/dodopayments/resources/checkout_sessions.rb +6 -2
- data/lib/dodopayments/resources/customers.rb +20 -0
- data/lib/dodopayments/resources/entitlements/files.rb +70 -0
- data/lib/dodopayments/resources/entitlements/grants.rb +78 -0
- data/lib/dodopayments/resources/entitlements.rb +153 -0
- data/lib/dodopayments/resources/license_key_instances.rb +3 -1
- data/lib/dodopayments/resources/payments.rb +6 -2
- data/lib/dodopayments/resources/products.rb +4 -4
- data/lib/dodopayments/resources/subscriptions.rb +20 -5
- data/lib/dodopayments/resources/webhooks.rb +2 -2
- data/lib/dodopayments/version.rb +1 -1
- data/lib/dodopayments.rb +30 -0
- data/rbi/dodopayments/client.rbi +3 -0
- data/rbi/dodopayments/models/attach_product_entitlement.rbi +35 -0
- data/rbi/dodopayments/models/cancellation_feedback.rbi +45 -0
- data/rbi/dodopayments/models/checkout_session_flags.rbi +20 -3
- data/rbi/dodopayments/models/checkout_session_request.rbi +18 -0
- data/rbi/dodopayments/models/credit_entitlements/credit_ledger_entry.rbi +5 -0
- data/rbi/dodopayments/models/credit_overage_reset_webhook_event.rbi +103 -0
- data/rbi/dodopayments/models/customer_list_entitlements_params.rbi +38 -0
- data/rbi/dodopayments/models/customer_list_entitlements_response.rbi +189 -0
- data/rbi/dodopayments/models/digital_product_delivery.rbi +10 -22
- data/rbi/dodopayments/models/digital_product_delivery_file.rbi +40 -8
- data/rbi/dodopayments/models/entitlement.rbi +112 -0
- data/rbi/dodopayments/models/entitlement_create_params.rbi +112 -0
- data/rbi/dodopayments/models/entitlement_delete_params.rbi +38 -0
- data/rbi/dodopayments/models/entitlement_grant_created_webhook_event.rbi +103 -0
- data/rbi/dodopayments/models/entitlement_grant_delivered_webhook_event.rbi +103 -0
- data/rbi/dodopayments/models/entitlement_grant_failed_webhook_event.rbi +102 -0
- data/rbi/dodopayments/models/entitlement_grant_revoked_webhook_event.rbi +103 -0
- data/rbi/dodopayments/models/entitlement_integration_type.rbi +44 -0
- data/rbi/dodopayments/models/entitlement_list_params.rbi +146 -0
- data/rbi/dodopayments/models/entitlement_retrieve_params.rbi +38 -0
- data/rbi/dodopayments/models/entitlement_update_params.rbi +111 -0
- data/rbi/dodopayments/models/entitlements/entitlement_grant.rbi +235 -0
- data/rbi/dodopayments/models/entitlements/file_delete_params.rbi +48 -0
- data/rbi/dodopayments/models/entitlements/file_upload_params.rbi +40 -0
- data/rbi/dodopayments/models/entitlements/file_upload_response.rbi +34 -0
- data/rbi/dodopayments/models/entitlements/grant_list_params.rbi +145 -0
- data/rbi/dodopayments/models/entitlements/grant_revoke_params.rbi +48 -0
- data/rbi/dodopayments/models/entitlements/license_key_grant.rbi +62 -0
- data/rbi/dodopayments/models/integration_config.rbi +296 -0
- data/rbi/dodopayments/models/integration_config_response.rbi +416 -0
- data/rbi/dodopayments/models/license_key_instance_list_params.rbi +8 -0
- data/rbi/dodopayments/models/one_time_product_cart_item.rbi +24 -3
- data/rbi/dodopayments/models/payment.rbi +31 -3
- data/rbi/dodopayments/models/payment_create_params.rbi +28 -56
- data/rbi/dodopayments/models/payment_create_response.rbi +3 -68
- data/rbi/dodopayments/models/product.rbi +12 -420
- data/rbi/dodopayments/models/product_create_params.rbi +43 -7
- data/rbi/dodopayments/models/product_entitlement_summary.rbi +88 -0
- data/rbi/dodopayments/models/product_list_response.rbi +3 -430
- data/rbi/dodopayments/models/product_update_params.rbi +35 -9
- data/rbi/dodopayments/models/scheduled_plan_change.rbi +141 -0
- data/rbi/dodopayments/models/subscription.rbi +24 -149
- data/rbi/dodopayments/models/subscription_create_params.rbi +36 -68
- data/rbi/dodopayments/models/subscription_create_response.rbi +47 -3
- data/rbi/dodopayments/models/subscription_list_response.rbi +4 -167
- data/rbi/dodopayments/models/subscription_update_params.rbi +27 -0
- data/rbi/dodopayments/models/unsafe_unwrap_webhook_event.rbi +5 -0
- data/rbi/dodopayments/models/unwrap_webhook_event.rbi +5 -0
- data/rbi/dodopayments/models/update_subscription_plan_req.rbi +10 -0
- data/rbi/dodopayments/models/webhook_event_type.rbi +5 -0
- data/rbi/dodopayments/models/webhook_payload.rbi +4 -197
- data/rbi/dodopayments/models.rbi +46 -0
- data/rbi/dodopayments/resources/checkout_sessions.rbi +16 -0
- data/rbi/dodopayments/resources/customers.rbi +14 -0
- data/rbi/dodopayments/resources/entitlements/files.rbi +52 -0
- data/rbi/dodopayments/resources/entitlements/grants.rbi +65 -0
- data/rbi/dodopayments/resources/entitlements.rbi +143 -0
- data/rbi/dodopayments/resources/license_key_instances.rbi +3 -0
- data/rbi/dodopayments/resources/payments.rbi +10 -2
- data/rbi/dodopayments/resources/products.rbi +34 -7
- data/rbi/dodopayments/resources/subscriptions.rbi +31 -5
- data/rbi/dodopayments/resources/webhooks.rbi +10 -0
- data/sig/dodopayments/client.rbs +2 -0
- data/sig/dodopayments/models/attach_product_entitlement.rbs +13 -0
- data/sig/dodopayments/models/cancellation_feedback.rbs +28 -0
- data/sig/dodopayments/models/checkout_session_flags.rbs +10 -3
- data/sig/dodopayments/models/checkout_session_request.rbs +5 -0
- data/sig/dodopayments/models/credit_entitlements/credit_ledger_entry.rbs +2 -0
- data/sig/dodopayments/models/credit_overage_reset_webhook_event.rbs +45 -0
- data/sig/dodopayments/models/customer_list_entitlements_params.rbs +23 -0
- data/sig/dodopayments/models/customer_list_entitlements_response.rbs +95 -0
- data/sig/dodopayments/models/digital_product_delivery.rbs +5 -5
- data/sig/dodopayments/models/digital_product_delivery_file.rbs +32 -5
- data/sig/dodopayments/models/entitlement.rbs +67 -0
- data/sig/dodopayments/models/entitlement_create_params.rbs +46 -0
- data/sig/dodopayments/models/entitlement_delete_params.rbs +23 -0
- data/sig/dodopayments/models/entitlement_grant_created_webhook_event.rbs +45 -0
- data/sig/dodopayments/models/entitlement_grant_delivered_webhook_event.rbs +45 -0
- data/sig/dodopayments/models/entitlement_grant_failed_webhook_event.rbs +45 -0
- data/sig/dodopayments/models/entitlement_grant_revoked_webhook_event.rbs +45 -0
- data/sig/dodopayments/models/entitlement_integration_type.rbs +28 -0
- data/sig/dodopayments/models/entitlement_list_params.rbs +69 -0
- data/sig/dodopayments/models/entitlement_retrieve_params.rbs +23 -0
- data/sig/dodopayments/models/entitlement_update_params.rbs +46 -0
- data/sig/dodopayments/models/entitlements/entitlement_grant.rbs +134 -0
- data/sig/dodopayments/models/entitlements/file_delete_params.rbs +30 -0
- data/sig/dodopayments/models/entitlements/file_upload_params.rbs +25 -0
- data/sig/dodopayments/models/entitlements/file_upload_response.rbs +15 -0
- data/sig/dodopayments/models/entitlements/grant_list_params.rbs +71 -0
- data/sig/dodopayments/models/entitlements/grant_revoke_params.rbs +30 -0
- data/sig/dodopayments/models/entitlements/license_key_grant.rbs +37 -0
- data/sig/dodopayments/models/integration_config.rbs +147 -0
- data/sig/dodopayments/models/integration_config_response.rbs +206 -0
- data/sig/dodopayments/models/license_key_instance_list_params.rbs +10 -1
- data/sig/dodopayments/models/one_time_product_cart_item.rbs +14 -3
- data/sig/dodopayments/models/payment.rbs +16 -4
- data/sig/dodopayments/models/payment_create_params.rbs +16 -27
- data/sig/dodopayments/models/payment_create_response.rbs +4 -27
- data/sig/dodopayments/models/product.rbs +4 -205
- data/sig/dodopayments/models/product_create_params.rbs +4 -4
- data/sig/dodopayments/models/product_entitlement_summary.rbs +40 -0
- data/sig/dodopayments/models/product_list_response.rbs +4 -205
- data/sig/dodopayments/models/product_update_params.rbs +4 -4
- data/sig/dodopayments/models/scheduled_plan_change.rbs +73 -0
- data/sig/dodopayments/models/subscription.rbs +14 -74
- data/sig/dodopayments/models/subscription_create_params.rbs +16 -27
- data/sig/dodopayments/models/subscription_create_response.rbs +16 -4
- data/sig/dodopayments/models/subscription_list_response.rbs +4 -74
- data/sig/dodopayments/models/subscription_update_params.rbs +12 -0
- data/sig/dodopayments/models/unsafe_unwrap_webhook_event.rbs +5 -0
- data/sig/dodopayments/models/unwrap_webhook_event.rbs +5 -0
- data/sig/dodopayments/models/update_subscription_plan_req.rbs +5 -0
- data/sig/dodopayments/models/webhook_event_type.rbs +2 -0
- data/sig/dodopayments/models/webhook_payload.rbs +8 -134
- data/sig/dodopayments/models.rbs +40 -0
- data/sig/dodopayments/resources/checkout_sessions.rbs +2 -0
- data/sig/dodopayments/resources/customers.rbs +5 -0
- data/sig/dodopayments/resources/entitlements/files.rbs +20 -0
- data/sig/dodopayments/resources/entitlements/grants.rbs +24 -0
- data/sig/dodopayments/resources/entitlements.rbs +46 -0
- data/sig/dodopayments/resources/license_key_instances.rbs +1 -0
- data/sig/dodopayments/resources/payments.rbs +3 -1
- data/sig/dodopayments/resources/products.rbs +2 -2
- data/sig/dodopayments/resources/subscriptions.rbs +7 -1
- data/sig/dodopayments/resources/webhooks.rbs +10 -0
- metadata +92 -2
|
@@ -69,6 +69,17 @@ module Dodopayments
|
|
|
69
69
|
# @return [Boolean, nil]
|
|
70
70
|
optional :force_3ds, Dodopayments::Internal::Type::Boolean, nil?: true
|
|
71
71
|
|
|
72
|
+
# @!attribute mandate_min_amount_inr_paise
|
|
73
|
+
# Override the merchant-level mandate floor (in INR paise) for INR e-mandates on
|
|
74
|
+
# Indian-card recurring payments. The mandate amount sent to the processor is
|
|
75
|
+
# `max(this_floor, actual_billing_amount)`, so this is effectively the
|
|
76
|
+
# customer-facing authorization ceiling whenever billing is lower. When unset, the
|
|
77
|
+
# merchant setting applies; when that's also unset, the system default of ₹15,000
|
|
78
|
+
# applies.
|
|
79
|
+
#
|
|
80
|
+
# @return [Integer, nil]
|
|
81
|
+
optional :mandate_min_amount_inr_paise, Integer, nil?: true
|
|
82
|
+
|
|
72
83
|
# @!attribute metadata
|
|
73
84
|
# Additional metadata for the subscription Defaults to empty if not specified
|
|
74
85
|
#
|
|
@@ -84,11 +95,9 @@ module Dodopayments
|
|
|
84
95
|
# List of one time products that will be bundled with the first payment for this
|
|
85
96
|
# subscription
|
|
86
97
|
#
|
|
87
|
-
# @return [Array<Dodopayments::Models::
|
|
98
|
+
# @return [Array<Dodopayments::Models::OneTimeProductCartItem>, nil]
|
|
88
99
|
optional :one_time_product_cart,
|
|
89
|
-
-> {
|
|
90
|
-
Dodopayments::Internal::Type::ArrayOf[Dodopayments::SubscriptionCreateParams::OneTimeProductCart]
|
|
91
|
-
},
|
|
100
|
+
-> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::OneTimeProductCartItem] },
|
|
92
101
|
nil?: true
|
|
93
102
|
|
|
94
103
|
# @!attribute payment_link
|
|
@@ -112,6 +121,14 @@ module Dodopayments
|
|
|
112
121
|
# @return [Boolean, nil]
|
|
113
122
|
optional :redirect_immediately, Dodopayments::Internal::Type::Boolean
|
|
114
123
|
|
|
124
|
+
# @!attribute require_phone_number
|
|
125
|
+
# If true, the customer's phone number is required to create this subscription.
|
|
126
|
+
# Typically set alongside `payment_link=true` so merchants can enforce phone
|
|
127
|
+
# collection on the hosted payment page. Defaults to false.
|
|
128
|
+
#
|
|
129
|
+
# @return [Boolean, nil]
|
|
130
|
+
optional :require_phone_number, Dodopayments::Internal::Type::Boolean
|
|
131
|
+
|
|
115
132
|
# @!attribute return_url
|
|
116
133
|
# Optional URL to redirect after successful subscription creation
|
|
117
134
|
#
|
|
@@ -144,7 +161,7 @@ module Dodopayments
|
|
|
144
161
|
# @return [Integer, nil]
|
|
145
162
|
optional :trial_period_days, Integer, nil?: true
|
|
146
163
|
|
|
147
|
-
# @!method initialize(billing:, customer:, product_id:, quantity:, addons: nil, allowed_payment_method_types: nil, billing_currency: nil, discount_code: nil, force_3ds: nil, metadata: nil, on_demand: nil, one_time_product_cart: nil, payment_link: nil, payment_method_id: nil, redirect_immediately: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, tax_id: nil, trial_period_days: nil, request_options: {})
|
|
164
|
+
# @!method initialize(billing:, customer:, product_id:, quantity:, addons: nil, allowed_payment_method_types: nil, billing_currency: nil, discount_code: nil, force_3ds: nil, mandate_min_amount_inr_paise: nil, metadata: nil, on_demand: nil, one_time_product_cart: nil, payment_link: nil, payment_method_id: nil, redirect_immediately: nil, require_phone_number: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, tax_id: nil, trial_period_days: nil, request_options: {})
|
|
148
165
|
# Some parameter documentations has been truncated, see
|
|
149
166
|
# {Dodopayments::Models::SubscriptionCreateParams} for more details.
|
|
150
167
|
#
|
|
@@ -166,11 +183,13 @@ module Dodopayments
|
|
|
166
183
|
#
|
|
167
184
|
# @param force_3ds [Boolean, nil] Override merchant default 3DS behaviour for this subscription
|
|
168
185
|
#
|
|
186
|
+
# @param mandate_min_amount_inr_paise [Integer, nil] Override the merchant-level mandate floor (in INR paise) for INR
|
|
187
|
+
#
|
|
169
188
|
# @param metadata [Hash{Symbol=>String}] Additional metadata for the subscription
|
|
170
189
|
#
|
|
171
190
|
# @param on_demand [Dodopayments::Models::OnDemandSubscription, nil]
|
|
172
191
|
#
|
|
173
|
-
# @param one_time_product_cart [Array<Dodopayments::Models::
|
|
192
|
+
# @param one_time_product_cart [Array<Dodopayments::Models::OneTimeProductCartItem>, nil] List of one time products that will be bundled with the first payment for this s
|
|
174
193
|
#
|
|
175
194
|
# @param payment_link [Boolean, nil] If true, generates a payment link.
|
|
176
195
|
#
|
|
@@ -178,6 +197,8 @@ module Dodopayments
|
|
|
178
197
|
#
|
|
179
198
|
# @param redirect_immediately [Boolean] If true, redirects the customer immediately after payment completion
|
|
180
199
|
#
|
|
200
|
+
# @param require_phone_number [Boolean] If true, the customer's phone number is required to create this subscription.
|
|
201
|
+
#
|
|
181
202
|
# @param return_url [String, nil] Optional URL to redirect after successful subscription creation
|
|
182
203
|
#
|
|
183
204
|
# @param short_link [Boolean, nil] If true, returns a shortened payment link.
|
|
@@ -189,37 +210,6 @@ module Dodopayments
|
|
|
189
210
|
# @param trial_period_days [Integer, nil] Optional trial period in days
|
|
190
211
|
#
|
|
191
212
|
# @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
|
|
192
|
-
|
|
193
|
-
class OneTimeProductCart < Dodopayments::Internal::Type::BaseModel
|
|
194
|
-
# @!attribute product_id
|
|
195
|
-
#
|
|
196
|
-
# @return [String]
|
|
197
|
-
required :product_id, String
|
|
198
|
-
|
|
199
|
-
# @!attribute quantity
|
|
200
|
-
#
|
|
201
|
-
# @return [Integer]
|
|
202
|
-
required :quantity, Integer
|
|
203
|
-
|
|
204
|
-
# @!attribute amount
|
|
205
|
-
# Amount the customer pays if pay_what_you_want is enabled. If disabled then
|
|
206
|
-
# amount will be ignored Represented in the lowest denomination of the currency
|
|
207
|
-
# (e.g., cents for USD). For example, to charge $1.00, pass `100`.
|
|
208
|
-
#
|
|
209
|
-
# @return [Integer, nil]
|
|
210
|
-
optional :amount, Integer, nil?: true
|
|
211
|
-
|
|
212
|
-
# @!method initialize(product_id:, quantity:, amount: nil)
|
|
213
|
-
# Some parameter documentations has been truncated, see
|
|
214
|
-
# {Dodopayments::Models::SubscriptionCreateParams::OneTimeProductCart} for more
|
|
215
|
-
# details.
|
|
216
|
-
#
|
|
217
|
-
# @param product_id [String]
|
|
218
|
-
#
|
|
219
|
-
# @param quantity [Integer]
|
|
220
|
-
#
|
|
221
|
-
# @param amount [Integer, nil] Amount the customer pays if pay_what_you_want is enabled. If disabled then amoun
|
|
222
|
-
end
|
|
223
213
|
end
|
|
224
214
|
end
|
|
225
215
|
end
|
|
@@ -63,9 +63,9 @@ module Dodopayments
|
|
|
63
63
|
# @!attribute one_time_product_cart
|
|
64
64
|
# One time products associated with the purchase of subscription
|
|
65
65
|
#
|
|
66
|
-
# @return [Array<Dodopayments::Models::
|
|
66
|
+
# @return [Array<Dodopayments::Models::SubscriptionCreateResponse::OneTimeProductCart>, nil]
|
|
67
67
|
optional :one_time_product_cart,
|
|
68
|
-
-> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::
|
|
68
|
+
-> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::SubscriptionCreateResponse::OneTimeProductCart] },
|
|
69
69
|
nil?: true
|
|
70
70
|
|
|
71
71
|
# @!attribute payment_link
|
|
@@ -96,9 +96,25 @@ module Dodopayments
|
|
|
96
96
|
#
|
|
97
97
|
# @param expires_on [Time, nil] Expiry timestamp of the payment link
|
|
98
98
|
#
|
|
99
|
-
# @param one_time_product_cart [Array<Dodopayments::Models::
|
|
99
|
+
# @param one_time_product_cart [Array<Dodopayments::Models::SubscriptionCreateResponse::OneTimeProductCart>, nil] One time products associated with the purchase of subscription
|
|
100
100
|
#
|
|
101
101
|
# @param payment_link [String, nil] URL to checkout page
|
|
102
|
+
|
|
103
|
+
class OneTimeProductCart < Dodopayments::Internal::Type::BaseModel
|
|
104
|
+
# @!attribute product_id
|
|
105
|
+
#
|
|
106
|
+
# @return [String]
|
|
107
|
+
required :product_id, String
|
|
108
|
+
|
|
109
|
+
# @!attribute quantity
|
|
110
|
+
#
|
|
111
|
+
# @return [Integer]
|
|
112
|
+
required :quantity, Integer
|
|
113
|
+
|
|
114
|
+
# @!method initialize(product_id:, quantity:)
|
|
115
|
+
# @param product_id [String]
|
|
116
|
+
# @param quantity [Integer]
|
|
117
|
+
end
|
|
102
118
|
end
|
|
103
119
|
end
|
|
104
120
|
end
|
|
@@ -159,10 +159,8 @@ module Dodopayments
|
|
|
159
159
|
# @!attribute scheduled_change
|
|
160
160
|
# Scheduled plan change details, if any
|
|
161
161
|
#
|
|
162
|
-
# @return [Dodopayments::Models::
|
|
163
|
-
optional :scheduled_change,
|
|
164
|
-
-> { Dodopayments::Models::SubscriptionListResponse::ScheduledChange },
|
|
165
|
-
nil?: true
|
|
162
|
+
# @return [Dodopayments::Models::ScheduledPlanChange, nil]
|
|
163
|
+
optional :scheduled_change, -> { Dodopayments::ScheduledPlanChange }, nil?: true
|
|
166
164
|
|
|
167
165
|
# @!attribute tax_id
|
|
168
166
|
# Tax identifier provided for this subscription (if applicable)
|
|
@@ -226,107 +224,9 @@ module Dodopayments
|
|
|
226
224
|
#
|
|
227
225
|
# @param product_name [String, nil] Name of the product associated with this subscription
|
|
228
226
|
#
|
|
229
|
-
# @param scheduled_change [Dodopayments::Models::
|
|
227
|
+
# @param scheduled_change [Dodopayments::Models::ScheduledPlanChange, nil] Scheduled plan change details, if any
|
|
230
228
|
#
|
|
231
229
|
# @param tax_id [String, nil] Tax identifier provided for this subscription (if applicable)
|
|
232
|
-
|
|
233
|
-
# @see Dodopayments::Models::SubscriptionListResponse#scheduled_change
|
|
234
|
-
class ScheduledChange < Dodopayments::Internal::Type::BaseModel
|
|
235
|
-
# @!attribute id
|
|
236
|
-
# The scheduled plan change ID
|
|
237
|
-
#
|
|
238
|
-
# @return [String]
|
|
239
|
-
required :id, String
|
|
240
|
-
|
|
241
|
-
# @!attribute addons
|
|
242
|
-
# Addons included in the scheduled change
|
|
243
|
-
#
|
|
244
|
-
# @return [Array<Dodopayments::Models::SubscriptionListResponse::ScheduledChange::Addon>]
|
|
245
|
-
required :addons,
|
|
246
|
-
-> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::SubscriptionListResponse::ScheduledChange::Addon] }
|
|
247
|
-
|
|
248
|
-
# @!attribute created_at
|
|
249
|
-
# When this scheduled change was created
|
|
250
|
-
#
|
|
251
|
-
# @return [Time]
|
|
252
|
-
required :created_at, Time
|
|
253
|
-
|
|
254
|
-
# @!attribute effective_at
|
|
255
|
-
# When the change will be applied
|
|
256
|
-
#
|
|
257
|
-
# @return [Time]
|
|
258
|
-
required :effective_at, Time
|
|
259
|
-
|
|
260
|
-
# @!attribute product_id
|
|
261
|
-
# The product ID the subscription will change to
|
|
262
|
-
#
|
|
263
|
-
# @return [String]
|
|
264
|
-
required :product_id, String
|
|
265
|
-
|
|
266
|
-
# @!attribute quantity
|
|
267
|
-
# Quantity for the new plan
|
|
268
|
-
#
|
|
269
|
-
# @return [Integer]
|
|
270
|
-
required :quantity, Integer
|
|
271
|
-
|
|
272
|
-
# @!attribute product_description
|
|
273
|
-
# Description of the product being changed to
|
|
274
|
-
#
|
|
275
|
-
# @return [String, nil]
|
|
276
|
-
optional :product_description, String, nil?: true
|
|
277
|
-
|
|
278
|
-
# @!attribute product_name
|
|
279
|
-
# Name of the product being changed to
|
|
280
|
-
#
|
|
281
|
-
# @return [String, nil]
|
|
282
|
-
optional :product_name, String, nil?: true
|
|
283
|
-
|
|
284
|
-
# @!method initialize(id:, addons:, created_at:, effective_at:, product_id:, quantity:, product_description: nil, product_name: nil)
|
|
285
|
-
# Scheduled plan change details, if any
|
|
286
|
-
#
|
|
287
|
-
# @param id [String] The scheduled plan change ID
|
|
288
|
-
#
|
|
289
|
-
# @param addons [Array<Dodopayments::Models::SubscriptionListResponse::ScheduledChange::Addon>] Addons included in the scheduled change
|
|
290
|
-
#
|
|
291
|
-
# @param created_at [Time] When this scheduled change was created
|
|
292
|
-
#
|
|
293
|
-
# @param effective_at [Time] When the change will be applied
|
|
294
|
-
#
|
|
295
|
-
# @param product_id [String] The product ID the subscription will change to
|
|
296
|
-
#
|
|
297
|
-
# @param quantity [Integer] Quantity for the new plan
|
|
298
|
-
#
|
|
299
|
-
# @param product_description [String, nil] Description of the product being changed to
|
|
300
|
-
#
|
|
301
|
-
# @param product_name [String, nil] Name of the product being changed to
|
|
302
|
-
|
|
303
|
-
class Addon < Dodopayments::Internal::Type::BaseModel
|
|
304
|
-
# @!attribute addon_id
|
|
305
|
-
# The addon ID
|
|
306
|
-
#
|
|
307
|
-
# @return [String]
|
|
308
|
-
required :addon_id, String
|
|
309
|
-
|
|
310
|
-
# @!attribute name
|
|
311
|
-
# Name of the addon
|
|
312
|
-
#
|
|
313
|
-
# @return [String]
|
|
314
|
-
required :name, String
|
|
315
|
-
|
|
316
|
-
# @!attribute quantity
|
|
317
|
-
# Quantity of the addon
|
|
318
|
-
#
|
|
319
|
-
# @return [Integer]
|
|
320
|
-
required :quantity, Integer
|
|
321
|
-
|
|
322
|
-
# @!method initialize(addon_id:, name:, quantity:)
|
|
323
|
-
# @param addon_id [String] The addon ID
|
|
324
|
-
#
|
|
325
|
-
# @param name [String] Name of the addon
|
|
326
|
-
#
|
|
327
|
-
# @param quantity [Integer] Quantity of the addon
|
|
328
|
-
end
|
|
329
|
-
end
|
|
330
230
|
end
|
|
331
231
|
end
|
|
332
232
|
end
|
|
@@ -28,6 +28,20 @@ module Dodopayments
|
|
|
28
28
|
# @return [Symbol, Dodopayments::Models::SubscriptionUpdateParams::CancelReason, nil]
|
|
29
29
|
optional :cancel_reason, enum: -> { Dodopayments::SubscriptionUpdateParams::CancelReason }, nil?: true
|
|
30
30
|
|
|
31
|
+
# @!attribute cancellation_comment
|
|
32
|
+
# Free-text cancellation comment (only valid when cancelling or scheduling
|
|
33
|
+
# cancellation).
|
|
34
|
+
#
|
|
35
|
+
# @return [String, nil]
|
|
36
|
+
optional :cancellation_comment, String, nil?: true
|
|
37
|
+
|
|
38
|
+
# @!attribute cancellation_feedback
|
|
39
|
+
# Customer-supplied churn reason (only valid when cancelling or scheduling
|
|
40
|
+
# cancellation).
|
|
41
|
+
#
|
|
42
|
+
# @return [Symbol, Dodopayments::Models::CancellationFeedback, nil]
|
|
43
|
+
optional :cancellation_feedback, enum: -> { Dodopayments::CancellationFeedback }, nil?: true
|
|
44
|
+
|
|
31
45
|
# @!attribute credit_entitlement_cart
|
|
32
46
|
# Update credit entitlement cart settings
|
|
33
47
|
#
|
|
@@ -68,7 +82,10 @@ module Dodopayments
|
|
|
68
82
|
# @return [String, nil]
|
|
69
83
|
optional :tax_id, String, nil?: true
|
|
70
84
|
|
|
71
|
-
# @!method initialize(subscription_id:, billing: nil, cancel_at_next_billing_date: nil, cancel_reason: nil, credit_entitlement_cart: nil, customer_name: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, status: nil, tax_id: nil, request_options: {})
|
|
85
|
+
# @!method initialize(subscription_id:, billing: nil, cancel_at_next_billing_date: nil, cancel_reason: nil, cancellation_comment: nil, cancellation_feedback: nil, credit_entitlement_cart: nil, customer_name: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, status: nil, tax_id: nil, request_options: {})
|
|
86
|
+
# Some parameter documentations has been truncated, see
|
|
87
|
+
# {Dodopayments::Models::SubscriptionUpdateParams} for more details.
|
|
88
|
+
#
|
|
72
89
|
# @param subscription_id [String]
|
|
73
90
|
#
|
|
74
91
|
# @param billing [Dodopayments::Models::BillingAddress, nil]
|
|
@@ -77,6 +94,10 @@ module Dodopayments
|
|
|
77
94
|
#
|
|
78
95
|
# @param cancel_reason [Symbol, Dodopayments::Models::SubscriptionUpdateParams::CancelReason, nil]
|
|
79
96
|
#
|
|
97
|
+
# @param cancellation_comment [String, nil] Free-text cancellation comment (only valid when cancelling or scheduling cancell
|
|
98
|
+
#
|
|
99
|
+
# @param cancellation_feedback [Symbol, Dodopayments::Models::CancellationFeedback, nil] Customer-supplied churn reason (only valid when cancelling or scheduling cancell
|
|
100
|
+
#
|
|
80
101
|
# @param credit_entitlement_cart [Array<Dodopayments::Models::SubscriptionUpdateParams::CreditEntitlementCart>, nil] Update credit entitlement cart settings
|
|
81
102
|
#
|
|
82
103
|
# @param customer_name [String, nil]
|
|
@@ -99,6 +120,7 @@ module Dodopayments
|
|
|
99
120
|
CANCELLED_BY_CUSTOMER = :cancelled_by_customer
|
|
100
121
|
CANCELLED_BY_MERCHANT = :cancelled_by_merchant
|
|
101
122
|
CANCELLED_BY_MERCHANT_SEND_DUNNING = :cancelled_by_merchant_send_dunning
|
|
123
|
+
DODO_TEAM = :dodo_team
|
|
102
124
|
|
|
103
125
|
# @!method self.values
|
|
104
126
|
# @return [Array<Symbol>]
|
|
@@ -21,6 +21,8 @@ module Dodopayments
|
|
|
21
21
|
|
|
22
22
|
variant -> { Dodopayments::CreditOverageChargedWebhookEvent }
|
|
23
23
|
|
|
24
|
+
variant -> { Dodopayments::CreditOverageResetWebhookEvent }
|
|
25
|
+
|
|
24
26
|
variant -> { Dodopayments::CreditRolledOverWebhookEvent }
|
|
25
27
|
|
|
26
28
|
variant -> { Dodopayments::CreditRolloverForfeitedWebhookEvent }
|
|
@@ -43,6 +45,14 @@ module Dodopayments
|
|
|
43
45
|
|
|
44
46
|
variant -> { Dodopayments::DunningStartedWebhookEvent }
|
|
45
47
|
|
|
48
|
+
variant -> { Dodopayments::EntitlementGrantCreatedWebhookEvent }
|
|
49
|
+
|
|
50
|
+
variant -> { Dodopayments::EntitlementGrantDeliveredWebhookEvent }
|
|
51
|
+
|
|
52
|
+
variant -> { Dodopayments::EntitlementGrantFailedWebhookEvent }
|
|
53
|
+
|
|
54
|
+
variant -> { Dodopayments::EntitlementGrantRevokedWebhookEvent }
|
|
55
|
+
|
|
46
56
|
variant -> { Dodopayments::LicenseKeyCreatedWebhookEvent }
|
|
47
57
|
|
|
48
58
|
variant -> { Dodopayments::PaymentCancelledWebhookEvent }
|
|
@@ -74,7 +84,7 @@ module Dodopayments
|
|
|
74
84
|
variant -> { Dodopayments::SubscriptionUpdatedWebhookEvent }
|
|
75
85
|
|
|
76
86
|
# @!method self.variants
|
|
77
|
-
# @return [Array(Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent)]
|
|
87
|
+
# @return [Array(Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent)]
|
|
78
88
|
end
|
|
79
89
|
end
|
|
80
90
|
end
|
|
@@ -21,6 +21,8 @@ module Dodopayments
|
|
|
21
21
|
|
|
22
22
|
variant -> { Dodopayments::CreditOverageChargedWebhookEvent }
|
|
23
23
|
|
|
24
|
+
variant -> { Dodopayments::CreditOverageResetWebhookEvent }
|
|
25
|
+
|
|
24
26
|
variant -> { Dodopayments::CreditRolledOverWebhookEvent }
|
|
25
27
|
|
|
26
28
|
variant -> { Dodopayments::CreditRolloverForfeitedWebhookEvent }
|
|
@@ -43,6 +45,14 @@ module Dodopayments
|
|
|
43
45
|
|
|
44
46
|
variant -> { Dodopayments::DunningStartedWebhookEvent }
|
|
45
47
|
|
|
48
|
+
variant -> { Dodopayments::EntitlementGrantCreatedWebhookEvent }
|
|
49
|
+
|
|
50
|
+
variant -> { Dodopayments::EntitlementGrantDeliveredWebhookEvent }
|
|
51
|
+
|
|
52
|
+
variant -> { Dodopayments::EntitlementGrantFailedWebhookEvent }
|
|
53
|
+
|
|
54
|
+
variant -> { Dodopayments::EntitlementGrantRevokedWebhookEvent }
|
|
55
|
+
|
|
46
56
|
variant -> { Dodopayments::LicenseKeyCreatedWebhookEvent }
|
|
47
57
|
|
|
48
58
|
variant -> { Dodopayments::PaymentCancelledWebhookEvent }
|
|
@@ -74,7 +84,7 @@ module Dodopayments
|
|
|
74
84
|
variant -> { Dodopayments::SubscriptionUpdatedWebhookEvent }
|
|
75
85
|
|
|
76
86
|
# @!method self.variants
|
|
77
|
-
# @return [Array(Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent)]
|
|
87
|
+
# @return [Array(Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent)]
|
|
78
88
|
end
|
|
79
89
|
end
|
|
80
90
|
end
|
|
@@ -22,6 +22,13 @@ module Dodopayments
|
|
|
22
22
|
# @return [Integer]
|
|
23
23
|
required :quantity, Integer
|
|
24
24
|
|
|
25
|
+
# @!attribute adaptive_currency_fees_inclusive
|
|
26
|
+
# Whether adaptive currency fees should be included in the price (true) or added
|
|
27
|
+
# on top (false). If not specified, uses the subscription's stored setting.
|
|
28
|
+
#
|
|
29
|
+
# @return [Boolean, nil]
|
|
30
|
+
optional :adaptive_currency_fees_inclusive, Dodopayments::Internal::Type::Boolean, nil?: true
|
|
31
|
+
|
|
25
32
|
# @!attribute addons
|
|
26
33
|
# Addons for the new plan. Note : Leaving this empty would remove any existing
|
|
27
34
|
# addons
|
|
@@ -68,7 +75,7 @@ module Dodopayments
|
|
|
68
75
|
enum: -> { Dodopayments::UpdateSubscriptionPlanReq::OnPaymentFailure },
|
|
69
76
|
nil?: true
|
|
70
77
|
|
|
71
|
-
# @!method initialize(product_id:, proration_billing_mode:, quantity:, addons: nil, discount_code: nil, effective_at: nil, metadata: nil, on_payment_failure: nil)
|
|
78
|
+
# @!method initialize(product_id:, proration_billing_mode:, quantity:, adaptive_currency_fees_inclusive: nil, addons: nil, discount_code: nil, effective_at: nil, metadata: nil, on_payment_failure: nil)
|
|
72
79
|
# Some parameter documentations has been truncated, see
|
|
73
80
|
# {Dodopayments::Models::UpdateSubscriptionPlanReq} for more details.
|
|
74
81
|
#
|
|
@@ -78,6 +85,8 @@ module Dodopayments
|
|
|
78
85
|
#
|
|
79
86
|
# @param quantity [Integer] Number of units to subscribe for. Must be at least 1.
|
|
80
87
|
#
|
|
88
|
+
# @param adaptive_currency_fees_inclusive [Boolean, nil] Whether adaptive currency fees should be included in the price (true) or added o
|
|
89
|
+
#
|
|
81
90
|
# @param addons [Array<Dodopayments::Models::AttachAddon>, nil] Addons for the new plan.
|
|
82
91
|
#
|
|
83
92
|
# @param discount_code [String, nil] Optional discount code to apply to the new plan.
|
|
@@ -39,6 +39,7 @@ module Dodopayments
|
|
|
39
39
|
CREDIT_ROLLED_OVER = :"credit.rolled_over"
|
|
40
40
|
CREDIT_ROLLOVER_FORFEITED = :"credit.rollover_forfeited"
|
|
41
41
|
CREDIT_OVERAGE_CHARGED = :"credit.overage_charged"
|
|
42
|
+
CREDIT_OVERAGE_RESET = :"credit.overage_reset"
|
|
42
43
|
CREDIT_MANUAL_ADJUSTMENT = :"credit.manual_adjustment"
|
|
43
44
|
CREDIT_BALANCE_LOW = :"credit.balance_low"
|
|
44
45
|
ABANDONED_CHECKOUT_DETECTED = :"abandoned_checkout.detected"
|
|
@@ -414,154 +414,15 @@ module Dodopayments
|
|
|
414
414
|
end
|
|
415
415
|
end
|
|
416
416
|
|
|
417
|
-
class EntitlementGrant < Dodopayments::
|
|
418
|
-
# @!attribute id
|
|
419
|
-
#
|
|
420
|
-
# @return [String]
|
|
421
|
-
required :id, String
|
|
422
|
-
|
|
423
|
-
# @!attribute business_id
|
|
424
|
-
#
|
|
425
|
-
# @return [String]
|
|
426
|
-
required :business_id, String
|
|
427
|
-
|
|
428
|
-
# @!attribute created_at
|
|
429
|
-
#
|
|
430
|
-
# @return [Time]
|
|
431
|
-
required :created_at, Time
|
|
432
|
-
|
|
433
|
-
# @!attribute customer_id
|
|
434
|
-
#
|
|
435
|
-
# @return [String]
|
|
436
|
-
required :customer_id, String
|
|
437
|
-
|
|
438
|
-
# @!attribute entitlement_id
|
|
439
|
-
#
|
|
440
|
-
# @return [String]
|
|
441
|
-
required :entitlement_id, String
|
|
442
|
-
|
|
443
|
-
# @!attribute external_id
|
|
444
|
-
#
|
|
445
|
-
# @return [String]
|
|
446
|
-
required :external_id, String
|
|
447
|
-
|
|
417
|
+
class EntitlementGrant < Dodopayments::Models::Entitlements::EntitlementGrant
|
|
448
418
|
# @!attribute payload_type
|
|
449
419
|
#
|
|
450
420
|
# @return [Symbol, Dodopayments::Models::WebhookPayload::Data::EntitlementGrant::PayloadType]
|
|
451
421
|
required :payload_type, enum: -> { Dodopayments::WebhookPayload::Data::EntitlementGrant::PayloadType }
|
|
452
422
|
|
|
453
|
-
# @!
|
|
454
|
-
#
|
|
455
|
-
# @return [Symbol, Dodopayments::Models::WebhookPayload::Data::EntitlementGrant::Status]
|
|
456
|
-
required :status, enum: -> { Dodopayments::WebhookPayload::Data::EntitlementGrant::Status }
|
|
457
|
-
|
|
458
|
-
# @!attribute updated_at
|
|
459
|
-
#
|
|
460
|
-
# @return [Time]
|
|
461
|
-
required :updated_at, Time
|
|
462
|
-
|
|
463
|
-
# @!attribute delivered_at
|
|
464
|
-
#
|
|
465
|
-
# @return [Time, nil]
|
|
466
|
-
optional :delivered_at, Time, nil?: true
|
|
467
|
-
|
|
468
|
-
# @!attribute error_code
|
|
469
|
-
#
|
|
470
|
-
# @return [String, nil]
|
|
471
|
-
optional :error_code, String, nil?: true
|
|
472
|
-
|
|
473
|
-
# @!attribute error_message
|
|
474
|
-
#
|
|
475
|
-
# @return [String, nil]
|
|
476
|
-
optional :error_message, String, nil?: true
|
|
477
|
-
|
|
478
|
-
# @!attribute license_key
|
|
479
|
-
#
|
|
480
|
-
# @return [String, nil]
|
|
481
|
-
optional :license_key, String, nil?: true
|
|
482
|
-
|
|
483
|
-
# @!attribute license_key_activations_limit
|
|
484
|
-
#
|
|
485
|
-
# @return [Integer, nil]
|
|
486
|
-
optional :license_key_activations_limit, Integer, nil?: true
|
|
487
|
-
|
|
488
|
-
# @!attribute license_key_activations_used
|
|
489
|
-
#
|
|
490
|
-
# @return [Integer, nil]
|
|
491
|
-
optional :license_key_activations_used, Integer, nil?: true
|
|
492
|
-
|
|
493
|
-
# @!attribute license_key_expires_at
|
|
494
|
-
#
|
|
495
|
-
# @return [Time, nil]
|
|
496
|
-
optional :license_key_expires_at, Time, nil?: true
|
|
497
|
-
|
|
498
|
-
# @!attribute license_key_status
|
|
499
|
-
#
|
|
500
|
-
# @return [String, nil]
|
|
501
|
-
optional :license_key_status, String, nil?: true
|
|
502
|
-
|
|
503
|
-
# @!attribute metadata
|
|
504
|
-
#
|
|
505
|
-
# @return [Object, nil]
|
|
506
|
-
optional :metadata, Dodopayments::Internal::Type::Unknown
|
|
507
|
-
|
|
508
|
-
# @!attribute oauth_expires_at
|
|
509
|
-
#
|
|
510
|
-
# @return [Time, nil]
|
|
511
|
-
optional :oauth_expires_at, Time, nil?: true
|
|
512
|
-
|
|
513
|
-
# @!attribute oauth_url
|
|
514
|
-
#
|
|
515
|
-
# @return [String, nil]
|
|
516
|
-
optional :oauth_url, String, nil?: true
|
|
517
|
-
|
|
518
|
-
# @!attribute payment_id
|
|
519
|
-
#
|
|
520
|
-
# @return [String, nil]
|
|
521
|
-
optional :payment_id, String, nil?: true
|
|
522
|
-
|
|
523
|
-
# @!attribute revocation_reason
|
|
524
|
-
#
|
|
525
|
-
# @return [String, nil]
|
|
526
|
-
optional :revocation_reason, String, nil?: true
|
|
527
|
-
|
|
528
|
-
# @!attribute revoked_at
|
|
529
|
-
#
|
|
530
|
-
# @return [Time, nil]
|
|
531
|
-
optional :revoked_at, Time, nil?: true
|
|
532
|
-
|
|
533
|
-
# @!attribute subscription_id
|
|
534
|
-
#
|
|
535
|
-
# @return [String, nil]
|
|
536
|
-
optional :subscription_id, String, nil?: true
|
|
537
|
-
|
|
538
|
-
# @!method initialize(id:, business_id:, created_at:, customer_id:, entitlement_id:, external_id:, payload_type:, status:, updated_at:, delivered_at: nil, error_code: nil, error_message: nil, license_key: nil, license_key_activations_limit: nil, license_key_activations_used: nil, license_key_expires_at: nil, license_key_status: nil, metadata: nil, oauth_expires_at: nil, oauth_url: nil, payment_id: nil, revocation_reason: nil, revoked_at: nil, subscription_id: nil)
|
|
539
|
-
# @param id [String]
|
|
540
|
-
# @param business_id [String]
|
|
541
|
-
# @param created_at [Time]
|
|
542
|
-
# @param customer_id [String]
|
|
543
|
-
# @param entitlement_id [String]
|
|
544
|
-
# @param external_id [String]
|
|
423
|
+
# @!method initialize(payload_type:)
|
|
545
424
|
# @param payload_type [Symbol, Dodopayments::Models::WebhookPayload::Data::EntitlementGrant::PayloadType]
|
|
546
|
-
# @param status [Symbol, Dodopayments::Models::WebhookPayload::Data::EntitlementGrant::Status]
|
|
547
|
-
# @param updated_at [Time]
|
|
548
|
-
# @param delivered_at [Time, nil]
|
|
549
|
-
# @param error_code [String, nil]
|
|
550
|
-
# @param error_message [String, nil]
|
|
551
|
-
# @param license_key [String, nil]
|
|
552
|
-
# @param license_key_activations_limit [Integer, nil]
|
|
553
|
-
# @param license_key_activations_used [Integer, nil]
|
|
554
|
-
# @param license_key_expires_at [Time, nil]
|
|
555
|
-
# @param license_key_status [String, nil]
|
|
556
|
-
# @param metadata [Object]
|
|
557
|
-
# @param oauth_expires_at [Time, nil]
|
|
558
|
-
# @param oauth_url [String, nil]
|
|
559
|
-
# @param payment_id [String, nil]
|
|
560
|
-
# @param revocation_reason [String, nil]
|
|
561
|
-
# @param revoked_at [Time, nil]
|
|
562
|
-
# @param subscription_id [String, nil]
|
|
563
425
|
|
|
564
|
-
# @see Dodopayments::Models::WebhookPayload::Data::EntitlementGrant#payload_type
|
|
565
426
|
module PayloadType
|
|
566
427
|
extend Dodopayments::Internal::Type::Enum
|
|
567
428
|
|
|
@@ -570,19 +431,6 @@ module Dodopayments
|
|
|
570
431
|
# @!method self.values
|
|
571
432
|
# @return [Array<Symbol>]
|
|
572
433
|
end
|
|
573
|
-
|
|
574
|
-
# @see Dodopayments::Models::WebhookPayload::Data::EntitlementGrant#status
|
|
575
|
-
module Status
|
|
576
|
-
extend Dodopayments::Internal::Type::Enum
|
|
577
|
-
|
|
578
|
-
PENDING = :Pending
|
|
579
|
-
DELIVERED = :Delivered
|
|
580
|
-
FAILED = :Failed
|
|
581
|
-
REVOKED = :Revoked
|
|
582
|
-
|
|
583
|
-
# @!method self.values
|
|
584
|
-
# @return [Array<Symbol>]
|
|
585
|
-
end
|
|
586
434
|
end
|
|
587
435
|
|
|
588
436
|
# @!method self.variants
|