stripe 13.6.0.pre.beta.1 → 14.0.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 +699 -1457
- data/OPENAPI_VERSION +1 -1
- data/README.md +29 -0
- data/VERSION +1 -1
- data/lib/stripe/api_requestor.rb +2 -0
- data/lib/stripe/api_version.rb +1 -1
- data/lib/stripe/errors.rb +0 -7
- data/lib/stripe/object_types.rb +0 -26
- data/lib/stripe/resources/account.rb +83 -614
- data/lib/stripe/resources/account_session.rb +1 -247
- data/lib/stripe/resources/apple_pay_domain.rb +0 -9
- data/lib/stripe/resources/application_fee.rb +1 -10
- data/lib/stripe/resources/balance.rb +0 -9
- data/lib/stripe/resources/balance_transaction.rb +2 -11
- data/lib/stripe/resources/bank_account.rb +1 -1
- data/lib/stripe/resources/billing/alert.rb +0 -9
- data/lib/stripe/resources/billing/credit_balance_summary.rb +0 -48
- data/lib/stripe/resources/billing/credit_balance_transaction.rb +0 -9
- data/lib/stripe/resources/billing/credit_grant.rb +4 -13
- data/lib/stripe/resources/billing/meter.rb +1 -10
- data/lib/stripe/resources/billing_portal/configuration.rb +0 -9
- data/lib/stripe/resources/card.rb +2 -4
- data/lib/stripe/resources/charge.rb +35 -1457
- data/lib/stripe/resources/checkout/session.rb +100 -293
- data/lib/stripe/resources/climate/order.rb +0 -9
- data/lib/stripe/resources/climate/product.rb +0 -9
- data/lib/stripe/resources/climate/supplier.rb +0 -9
- data/lib/stripe/resources/confirmation_token.rb +74 -156
- data/lib/stripe/resources/country_spec.rb +0 -9
- data/lib/stripe/resources/coupon.rb +0 -9
- data/lib/stripe/resources/credit_note.rb +14 -35
- data/lib/stripe/resources/credit_note_line_item.rb +14 -12
- data/lib/stripe/resources/customer.rb +12 -28
- data/lib/stripe/resources/customer_balance_transaction.rb +3 -1
- data/lib/stripe/resources/dispute.rb +0 -9
- data/lib/stripe/resources/entitlements/active_entitlement.rb +0 -9
- data/lib/stripe/resources/entitlements/feature.rb +0 -9
- data/lib/stripe/resources/event.rb +0 -40
- data/lib/stripe/resources/exchange_rate.rb +0 -9
- data/lib/stripe/resources/file.rb +0 -9
- data/lib/stripe/resources/file_link.rb +0 -9
- data/lib/stripe/resources/financial_connections/account.rb +0 -23
- data/lib/stripe/resources/financial_connections/session.rb +1 -65
- data/lib/stripe/resources/financial_connections/transaction.rb +0 -9
- data/lib/stripe/resources/forwarding/request.rb +0 -9
- data/lib/stripe/resources/identity/verification_report.rb +0 -9
- data/lib/stripe/resources/identity/verification_session.rb +0 -9
- data/lib/stripe/resources/invoice.rb +225 -5120
- data/lib/stripe/resources/invoice_item.rb +65 -110
- data/lib/stripe/resources/invoice_line_item.rb +106 -89
- data/lib/stripe/resources/invoice_payment.rb +53 -4
- data/lib/stripe/resources/invoice_rendering_template.rb +0 -12
- data/lib/stripe/resources/issuing/authorization.rb +0 -9
- data/lib/stripe/resources/issuing/card.rb +0 -9
- data/lib/stripe/resources/issuing/cardholder.rb +1 -11
- data/lib/stripe/resources/issuing/dispute.rb +0 -9
- data/lib/stripe/resources/issuing/personalization_design.rb +0 -9
- data/lib/stripe/resources/issuing/physical_bundle.rb +0 -9
- data/lib/stripe/resources/issuing/token.rb +0 -9
- data/lib/stripe/resources/issuing/transaction.rb +0 -15
- data/lib/stripe/resources/line_item.rb +0 -28
- data/lib/stripe/resources/mandate.rb +6 -33
- data/lib/stripe/resources/payment_intent.rb +642 -4975
- data/lib/stripe/resources/payment_link.rb +84 -15
- data/lib/stripe/resources/payment_method.rb +74 -187
- data/lib/stripe/resources/payment_method_configuration.rb +87 -214
- data/lib/stripe/resources/payment_method_domain.rb +9 -18
- data/lib/stripe/resources/payout.rb +0 -9
- data/lib/stripe/resources/person.rb +9 -9
- data/lib/stripe/resources/plan.rb +0 -15
- data/lib/stripe/resources/price.rb +2 -47
- data/lib/stripe/resources/product.rb +0 -68
- data/lib/stripe/resources/promotion_code.rb +0 -9
- data/lib/stripe/resources/quote.rb +8 -2037
- data/lib/stripe/resources/radar/early_fraud_warning.rb +0 -9
- data/lib/stripe/resources/radar/value_list.rb +0 -9
- data/lib/stripe/resources/radar/value_list_item.rb +0 -9
- data/lib/stripe/resources/refund.rb +13 -18
- data/lib/stripe/resources/reporting/report_run.rb +0 -9
- data/lib/stripe/resources/reporting/report_type.rb +0 -9
- data/lib/stripe/resources/review.rb +2 -11
- data/lib/stripe/resources/setup_attempt.rb +11 -16
- data/lib/stripe/resources/setup_intent.rb +158 -540
- data/lib/stripe/resources/shipping_rate.rb +0 -9
- data/lib/stripe/resources/sigma/scheduled_query_run.rb +0 -9
- data/lib/stripe/resources/source.rb +0 -41
- data/lib/stripe/resources/subscription.rb +14 -385
- data/lib/stripe/resources/subscription_item.rb +9 -134
- data/lib/stripe/resources/subscription_schedule.rb +14 -1135
- data/lib/stripe/resources/tax/calculation.rb +0 -9
- data/lib/stripe/resources/tax/registration.rb +1 -10
- data/lib/stripe/resources/tax/settings.rb +0 -9
- data/lib/stripe/resources/tax/transaction.rb +0 -9
- data/lib/stripe/resources/tax_code.rb +0 -9
- data/lib/stripe/resources/tax_id.rb +0 -9
- data/lib/stripe/resources/tax_rate.rb +0 -9
- data/lib/stripe/resources/terminal/configuration.rb +214 -14
- data/lib/stripe/resources/terminal/location.rb +0 -9
- data/lib/stripe/resources/terminal/reader.rb +0 -408
- data/lib/stripe/resources/test_helpers/test_clock.rb +0 -9
- data/lib/stripe/resources/token.rb +1 -10
- data/lib/stripe/resources/topup.rb +0 -9
- data/lib/stripe/resources/transfer.rb +0 -9
- data/lib/stripe/resources/treasury/credit_reversal.rb +0 -9
- data/lib/stripe/resources/treasury/debit_reversal.rb +0 -9
- data/lib/stripe/resources/treasury/financial_account.rb +4 -32
- data/lib/stripe/resources/treasury/financial_account_features.rb +0 -2
- data/lib/stripe/resources/treasury/inbound_transfer.rb +0 -9
- data/lib/stripe/resources/treasury/outbound_payment.rb +0 -9
- data/lib/stripe/resources/treasury/outbound_transfer.rb +0 -46
- data/lib/stripe/resources/treasury/received_credit.rb +1 -47
- data/lib/stripe/resources/treasury/received_debit.rb +1 -49
- data/lib/stripe/resources/treasury/transaction.rb +0 -9
- data/lib/stripe/resources/treasury/transaction_entry.rb +0 -9
- data/lib/stripe/resources/v2/event.rb +1 -0
- data/lib/stripe/resources/v2/event_destination.rb +1 -0
- data/lib/stripe/resources/webhook_endpoint.rb +0 -9
- data/lib/stripe/resources.rb +0 -25
- data/lib/stripe/services/account_external_account_service.rb +1 -1
- data/lib/stripe/services/account_service.rb +68 -509
- data/lib/stripe/services/account_session_service.rb +1 -217
- data/lib/stripe/services/balance_transaction_service.rb +1 -1
- data/lib/stripe/services/billing/credit_balance_summary_service.rb +2 -2
- data/lib/stripe/services/billing/credit_grant_service.rb +2 -2
- data/lib/stripe/services/billing/meter_service.rb +1 -1
- data/lib/stripe/services/charge_service.rb +1 -1335
- data/lib/stripe/services/checkout/session_service.rb +60 -168
- data/lib/stripe/services/credit_note_preview_lines_service.rb +0 -4
- data/lib/stripe/services/credit_note_service.rb +0 -8
- data/lib/stripe/services/customer_service.rb +0 -16
- data/lib/stripe/services/financial_connections/account_service.rb +1 -3
- data/lib/stripe/services/financial_connections/session_service.rb +1 -30
- data/lib/stripe/services/financial_connections_service.rb +1 -2
- data/lib/stripe/services/invoice_item_service.rb +34 -88
- data/lib/stripe/services/invoice_line_item_service.rb +25 -41
- data/lib/stripe/services/invoice_payment_service.rb +33 -5
- data/lib/stripe/services/invoice_service.rb +210 -3147
- data/lib/stripe/services/issuing/cardholder_service.rb +1 -2
- data/lib/stripe/services/issuing/transaction_service.rb +0 -4
- data/lib/stripe/services/issuing_service.rb +1 -5
- data/lib/stripe/services/payment_intent_service.rb +568 -4513
- data/lib/stripe/services/payment_link_service.rb +59 -6
- data/lib/stripe/services/payment_method_configuration_service.rb +62 -146
- data/lib/stripe/services/payment_method_domain_service.rb +6 -6
- data/lib/stripe/services/payment_method_service.rb +49 -119
- data/lib/stripe/services/plan_service.rb +0 -4
- data/lib/stripe/services/price_service.rb +2 -25
- data/lib/stripe/services/product_service.rb +0 -38
- data/lib/stripe/services/quote_service.rb +9 -1716
- data/lib/stripe/services/setup_intent_service.rb +158 -492
- data/lib/stripe/services/subscription_item_service.rb +5 -111
- data/lib/stripe/services/subscription_schedule_service.rb +14 -1005
- data/lib/stripe/services/subscription_service.rb +13 -323
- data/lib/stripe/services/tax/registration_service.rb +1 -1
- data/lib/stripe/services/tax_service.rb +1 -3
- data/lib/stripe/services/terminal/configuration_service.rb +170 -4
- data/lib/stripe/services/terminal/reader_service.rb +0 -177
- data/lib/stripe/services/terminal_service.rb +1 -2
- data/lib/stripe/services/test_helpers/confirmation_token_service.rb +49 -87
- data/lib/stripe/services/test_helpers/terminal/reader_service.rb +0 -43
- data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +1 -25
- data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +1 -25
- data/lib/stripe/services/token_service.rb +1 -1
- data/lib/stripe/services/treasury/financial_account_features_service.rb +1 -4
- data/lib/stripe/services/treasury/financial_account_service.rb +3 -17
- data/lib/stripe/services/treasury/outbound_transfer_service.rb +0 -24
- data/lib/stripe/services/v1_services.rb +2 -8
- data/lib/stripe/services/v2/core/event_destination_service.rb +1 -4
- data/lib/stripe/services/v2/core/event_service.rb +1 -4
- data/lib/stripe/services.rb +0 -27
- data/lib/stripe/stripe_client.rb +1 -0
- data/lib/stripe/stripe_configuration.rb +1 -3
- data/lib/stripe/util.rb +1 -7
- data/lib/stripe/version.rb +1 -1
- data/lib/stripe.rb +0 -45
- data/rbi/stripe/resources/account.rbi +1131 -1479
- data/rbi/stripe/resources/account_link.rbi +9 -9
- data/rbi/stripe/resources/account_session.rbi +118 -367
- data/rbi/stripe/resources/apple_pay_domain.rbi +8 -15
- data/rbi/stripe/resources/application_fee.rbi +15 -20
- data/rbi/stripe/resources/apps/secret.rbi +20 -20
- data/rbi/stripe/resources/balance.rbi +0 -7
- data/rbi/stripe/resources/balance_transaction.rbi +19 -24
- data/rbi/stripe/resources/bank_account.rbi +1 -1
- data/rbi/stripe/resources/billing/alert.rbi +23 -28
- data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -53
- data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +6 -13
- data/rbi/stripe/resources/billing/credit_grant.rbi +30 -37
- data/rbi/stripe/resources/billing/meter.rbi +19 -26
- data/rbi/stripe/resources/billing/meter_event.rbi +4 -4
- data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +5 -5
- data/rbi/stripe/resources/billing_portal/configuration.rbi +86 -81
- data/rbi/stripe/resources/billing_portal/session.rbi +31 -27
- data/rbi/stripe/resources/card.rbi +2 -5
- data/rbi/stripe/resources/charge.rbi +136 -1576
- data/rbi/stripe/resources/checkout/session.rbi +631 -748
- data/rbi/stripe/resources/climate/order.rbi +20 -25
- data/rbi/stripe/resources/climate/product.rbi +5 -12
- data/rbi/stripe/resources/climate/supplier.rbi +5 -12
- data/rbi/stripe/resources/confirmation_token.rbi +274 -268
- data/rbi/stripe/resources/country_spec.rbi +5 -12
- data/rbi/stripe/resources/coupon.rbi +34 -39
- data/rbi/stripe/resources/credit_note.rbi +134 -146
- data/rbi/stripe/resources/credit_note_line_item.rbi +20 -18
- data/rbi/stripe/resources/customer.rbi +172 -164
- data/rbi/stripe/resources/customer_balance_transaction.rbi +4 -1
- data/rbi/stripe/resources/customer_session.rbi +19 -15
- data/rbi/stripe/resources/dispute.rbi +92 -95
- data/rbi/stripe/resources/entitlements/active_entitlement.rbi +5 -12
- data/rbi/stripe/resources/entitlements/feature.rbi +15 -22
- data/rbi/stripe/resources/ephemeral_key.rbi +2 -2
- data/rbi/stripe/resources/event.rbi +16 -60
- data/rbi/stripe/resources/exchange_rate.rbi +5 -12
- data/rbi/stripe/resources/file.rbi +20 -25
- data/rbi/stripe/resources/file_link.rbi +23 -28
- data/rbi/stripe/resources/financial_connections/account.rbi +25 -44
- data/rbi/stripe/resources/financial_connections/session.rbi +12 -75
- data/rbi/stripe/resources/financial_connections/transaction.rbi +16 -19
- data/rbi/stripe/resources/forwarding/request.rbi +21 -24
- data/rbi/stripe/resources/identity/verification_report.rbi +18 -21
- data/rbi/stripe/resources/identity/verification_session.rbi +60 -61
- data/rbi/stripe/resources/invoice.rbi +723 -5918
- data/rbi/stripe/resources/invoice_item.rbi +138 -177
- data/rbi/stripe/resources/invoice_line_item.rbi +199 -264
- data/rbi/stripe/resources/invoice_payment.rbi +51 -7
- data/rbi/stripe/resources/invoice_rendering_template.rbi +10 -20
- data/rbi/stripe/resources/issuing/authorization.rbi +216 -199
- data/rbi/stripe/resources/issuing/card.rbi +104 -101
- data/rbi/stripe/resources/issuing/cardholder.rbi +120 -108
- data/rbi/stripe/resources/issuing/dispute.rbi +164 -151
- data/rbi/stripe/resources/issuing/personalization_design.rbi +61 -56
- data/rbi/stripe/resources/issuing/physical_bundle.rbi +7 -14
- data/rbi/stripe/resources/issuing/token.rbi +16 -21
- data/rbi/stripe/resources/issuing/transaction.rbi +180 -176
- data/rbi/stripe/resources/line_item.rbi +0 -36
- data/rbi/stripe/resources/mandate.rbi +8 -40
- data/rbi/stripe/resources/payment_intent.rbi +2252 -6482
- data/rbi/stripe/resources/payment_link.rbi +346 -211
- data/rbi/stripe/resources/payment_method.rbi +226 -330
- data/rbi/stripe/resources/payment_method_configuration.rbi +602 -685
- data/rbi/stripe/resources/payment_method_domain.rbi +26 -31
- data/rbi/stripe/resources/payout.rbi +43 -42
- data/rbi/stripe/resources/person.rbi +9 -9
- data/rbi/stripe/resources/plan.rbi +51 -63
- data/rbi/stripe/resources/price.rbi +114 -151
- data/rbi/stripe/resources/product.rbi +90 -152
- data/rbi/stripe/resources/promotion_code.rbi +42 -47
- data/rbi/stripe/resources/quote.rbi +168 -2231
- data/rbi/stripe/resources/radar/early_fraud_warning.rbi +17 -20
- data/rbi/stripe/resources/radar/value_list.rbi +24 -29
- data/rbi/stripe/resources/radar/value_list_item.rbi +18 -21
- data/rbi/stripe/resources/refund.rbi +52 -51
- data/rbi/stripe/resources/reporting/report_run.rbi +27 -30
- data/rbi/stripe/resources/reporting/report_type.rbi +2 -9
- data/rbi/stripe/resources/review.rbi +17 -22
- data/rbi/stripe/resources/setup_attempt.rbi +25 -32
- data/rbi/stripe/resources/setup_intent.rbi +900 -1102
- data/rbi/stripe/resources/shipping_rate.rbi +41 -46
- data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +5 -12
- data/rbi/stripe/resources/source.rbi +132 -179
- data/rbi/stripe/resources/subscription.rbi +363 -707
- data/rbi/stripe/resources/subscription_item.rbi +69 -177
- data/rbi/stripe/resources/subscription_schedule.rbi +289 -1447
- data/rbi/stripe/resources/tax/calculation.rbi +43 -48
- data/rbi/stripe/resources/tax/registration.rbi +217 -170
- data/rbi/stripe/resources/tax/settings.rbi +14 -21
- data/rbi/stripe/resources/tax/transaction.rbi +20 -25
- data/rbi/stripe/resources/tax_code.rbi +5 -12
- data/rbi/stripe/resources/tax_id.rbi +15 -22
- data/rbi/stripe/resources/tax_rate.rbi +34 -39
- data/rbi/stripe/resources/terminal/configuration.rbi +457 -212
- data/rbi/stripe/resources/terminal/connection_token.rbi +3 -3
- data/rbi/stripe/resources/terminal/location.rbi +28 -35
- data/rbi/stripe/resources/terminal/reader.rbi +71 -441
- data/rbi/stripe/resources/test_helpers/test_clock.rbi +12 -17
- data/rbi/stripe/resources/token.rbi +288 -263
- data/rbi/stripe/resources/topup.rbi +35 -38
- data/rbi/stripe/resources/transfer.rbi +27 -32
- data/rbi/stripe/resources/treasury/credit_reversal.rbi +10 -17
- data/rbi/stripe/resources/treasury/debit_reversal.rbi +11 -18
- data/rbi/stripe/resources/treasury/financial_account.rbi +125 -130
- data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -3
- data/rbi/stripe/resources/treasury/inbound_transfer.rbi +22 -29
- data/rbi/stripe/resources/treasury/outbound_payment.rbi +82 -79
- data/rbi/stripe/resources/treasury/outbound_transfer.rbi +44 -86
- data/rbi/stripe/resources/treasury/received_credit.rbi +18 -64
- data/rbi/stripe/resources/treasury/received_debit.rbi +17 -66
- data/rbi/stripe/resources/treasury/transaction.rbi +27 -28
- data/rbi/stripe/resources/treasury/transaction_entry.rbi +25 -26
- data/rbi/stripe/resources/v2/amount.rbi +1 -1
- data/rbi/stripe/resources/v2/event.rbi +1 -0
- data/rbi/stripe/resources/v2/event_destination.rbi +1 -0
- data/rbi/stripe/resources/webhook_endpoint.rbi +18 -25
- data/rbi/stripe/services/account_capability_service.rbi +7 -7
- data/rbi/stripe/services/account_external_account_service.rbi +52 -52
- data/rbi/stripe/services/account_link_service.rbi +9 -9
- data/rbi/stripe/services/account_login_link_service.rbi +2 -2
- data/rbi/stripe/services/account_person_service.rbi +221 -201
- data/rbi/stripe/services/account_service.rbi +1221 -1345
- data/rbi/stripe/services/account_session_service.rbi +115 -346
- data/rbi/stripe/services/apple_pay_domain_service.rbi +10 -10
- data/rbi/stripe/services/application_fee_refund_service.rbi +16 -14
- data/rbi/stripe/services/application_fee_service.rbi +18 -14
- data/rbi/stripe/services/apps/secret_service.rbi +20 -20
- data/rbi/stripe/services/balance_service.rbi +2 -2
- data/rbi/stripe/services/balance_transaction_service.rbi +22 -18
- data/rbi/stripe/services/billing/alert_service.rbi +23 -23
- data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +10 -10
- data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +8 -8
- data/rbi/stripe/services/billing/credit_grant_service.rbi +32 -30
- data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +7 -5
- data/rbi/stripe/services/billing/meter_event_service.rbi +4 -4
- data/rbi/stripe/services/billing/meter_event_summary_service.rbi +6 -6
- data/rbi/stripe/services/billing/meter_service.rbi +21 -21
- data/rbi/stripe/services/billing_portal/configuration_service.rbi +90 -76
- data/rbi/stripe/services/billing_portal/session_service.rbi +29 -27
- data/rbi/stripe/services/charge_service.rbi +96 -1464
- data/rbi/stripe/services/checkout/session_line_item_service.rbi +5 -5
- data/rbi/stripe/services/checkout/session_service.rbi +555 -591
- data/rbi/stripe/services/climate/order_service.rbi +22 -20
- data/rbi/stripe/services/climate/product_service.rbi +7 -7
- data/rbi/stripe/services/climate/supplier_service.rbi +7 -7
- data/rbi/stripe/services/confirmation_token_service.rbi +2 -2
- data/rbi/stripe/services/country_spec_service.rbi +7 -7
- data/rbi/stripe/services/coupon_service.rbi +40 -34
- data/rbi/stripe/services/credit_note_line_item_service.rbi +5 -5
- data/rbi/stripe/services/credit_note_preview_lines_service.rbi +35 -35
- data/rbi/stripe/services/credit_note_service.rbi +81 -85
- data/rbi/stripe/services/customer_balance_transaction_service.rbi +15 -15
- data/rbi/stripe/services/customer_cash_balance_service.rbi +7 -7
- data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +7 -7
- data/rbi/stripe/services/customer_funding_instructions_service.rbi +5 -5
- data/rbi/stripe/services/customer_payment_method_service.rbi +9 -9
- data/rbi/stripe/services/customer_payment_source_service.rbi +48 -44
- data/rbi/stripe/services/customer_service.rbi +143 -139
- data/rbi/stripe/services/customer_session_service.rbi +21 -15
- data/rbi/stripe/services/customer_tax_id_service.rbi +9 -9
- data/rbi/stripe/services/dispute_service.rbi +92 -90
- data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +7 -7
- data/rbi/stripe/services/entitlements/feature_service.rbi +17 -17
- data/rbi/stripe/services/ephemeral_key_service.rbi +8 -8
- data/rbi/stripe/services/event_service.rbi +18 -16
- data/rbi/stripe/services/exchange_rate_service.rbi +7 -7
- data/rbi/stripe/services/file_link_service.rbi +25 -23
- data/rbi/stripe/services/file_service.rbi +22 -20
- data/rbi/stripe/services/financial_connections/account_owner_service.rbi +5 -5
- data/rbi/stripe/services/financial_connections/account_service.rbi +22 -21
- data/rbi/stripe/services/financial_connections/session_service.rbi +16 -39
- data/rbi/stripe/services/financial_connections/transaction_service.rbi +16 -14
- data/rbi/stripe/services/financial_connections_service.rbi +0 -1
- data/rbi/stripe/services/forwarding/request_service.rbi +21 -19
- data/rbi/stripe/services/identity/verification_report_service.rbi +18 -16
- data/rbi/stripe/services/identity/verification_session_service.rbi +62 -56
- data/rbi/stripe/services/invoice_item_service.rbi +99 -155
- data/rbi/stripe/services/invoice_line_item_service.rbi +71 -82
- data/rbi/stripe/services/invoice_payment_service.rbi +39 -12
- data/rbi/stripe/services/invoice_rendering_template_service.rbi +13 -13
- data/rbi/stripe/services/invoice_service.rbi +679 -3799
- data/rbi/stripe/services/issuing/authorization_service.rbi +32 -26
- data/rbi/stripe/services/issuing/card_service.rbi +102 -86
- data/rbi/stripe/services/issuing/cardholder_service.rbi +122 -103
- data/rbi/stripe/services/issuing/dispute_service.rbi +152 -146
- data/rbi/stripe/services/issuing/personalization_design_service.rbi +52 -42
- data/rbi/stripe/services/issuing/physical_bundle_service.rbi +9 -9
- data/rbi/stripe/services/issuing/token_service.rbi +20 -16
- data/rbi/stripe/services/issuing/transaction_service.rbi +25 -23
- data/rbi/stripe/services/issuing_service.rbi +0 -3
- data/rbi/stripe/services/mandate_service.rbi +2 -2
- data/rbi/stripe/services/payment_intent_service.rbi +2312 -6081
- data/rbi/stripe/services/payment_link_line_item_service.rbi +5 -5
- data/rbi/stripe/services/payment_link_service.rbi +303 -201
- data/rbi/stripe/services/payment_method_configuration_service.rbi +616 -620
- data/rbi/stripe/services/payment_method_domain_service.rbi +25 -23
- data/rbi/stripe/services/payment_method_service.rbi +192 -249
- data/rbi/stripe/services/payout_service.rbi +45 -37
- data/rbi/stripe/services/plan_service.rbi +53 -55
- data/rbi/stripe/services/price_service.rbi +124 -129
- data/rbi/stripe/services/product_feature_service.rbi +9 -9
- data/rbi/stripe/services/product_service.rbi +94 -122
- data/rbi/stripe/services/promotion_code_service.rbi +46 -42
- data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +5 -5
- data/rbi/stripe/services/quote_line_item_service.rbi +5 -5
- data/rbi/stripe/services/quote_service.rbi +159 -1863
- data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +17 -15
- data/rbi/stripe/services/radar/value_list_item_service.rbi +20 -16
- data/rbi/stripe/services/radar/value_list_service.rbi +28 -24
- data/rbi/stripe/services/refund_service.rbi +37 -33
- data/rbi/stripe/services/reporting/report_run_service.rbi +29 -25
- data/rbi/stripe/services/reporting/report_type_service.rbi +4 -4
- data/rbi/stripe/services/review_service.rbi +17 -15
- data/rbi/stripe/services/setup_attempt_service.rbi +13 -11
- data/rbi/stripe/services/setup_intent_service.rbi +1028 -1062
- data/rbi/stripe/services/shipping_rate_service.rbi +47 -41
- data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +7 -7
- data/rbi/stripe/services/source_service.rbi +149 -133
- data/rbi/stripe/services/source_transaction_service.rbi +5 -5
- data/rbi/stripe/services/subscription_item_service.rbi +61 -159
- data/rbi/stripe/services/subscription_schedule_service.rbi +289 -1305
- data/rbi/stripe/services/subscription_service.rbi +366 -640
- data/rbi/stripe/services/tax/calculation_line_item_service.rbi +5 -5
- data/rbi/stripe/services/tax/calculation_service.rbi +40 -38
- data/rbi/stripe/services/tax/registration_service.rbi +337 -165
- data/rbi/stripe/services/tax/settings_service.rbi +16 -16
- data/rbi/stripe/services/tax/transaction_line_item_service.rbi +5 -5
- data/rbi/stripe/services/tax/transaction_service.rbi +19 -15
- data/rbi/stripe/services/tax_code_service.rbi +7 -7
- data/rbi/stripe/services/tax_id_service.rbi +17 -17
- data/rbi/stripe/services/tax_rate_service.rbi +36 -34
- data/rbi/stripe/services/tax_service.rbi +0 -2
- data/rbi/stripe/services/terminal/configuration_service.rbi +464 -204
- data/rbi/stripe/services/terminal/connection_token_service.rbi +3 -3
- data/rbi/stripe/services/terminal/location_service.rbi +30 -30
- data/rbi/stripe/services/terminal/reader_service.rbi +57 -226
- data/rbi/stripe/services/terminal_service.rbi +0 -1
- data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +157 -198
- data/rbi/stripe/services/test_helpers/customer_service.rbi +3 -3
- data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +180 -168
- data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +10 -10
- data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +11 -9
- data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +151 -145
- data/rbi/stripe/services/test_helpers/refund_service.rbi +2 -2
- data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +10 -39
- data/rbi/stripe/services/test_helpers/test_clock_service.rbi +14 -12
- data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +9 -9
- data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +20 -18
- data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +20 -18
- data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +11 -38
- data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +11 -38
- data/rbi/stripe/services/token_service.rbi +292 -258
- data/rbi/stripe/services/topup_service.rbi +37 -33
- data/rbi/stripe/services/transfer_reversal_service.rbi +18 -16
- data/rbi/stripe/services/transfer_service.rbi +29 -27
- data/rbi/stripe/services/treasury/credit_reversal_service.rbi +12 -12
- data/rbi/stripe/services/treasury/debit_reversal_service.rbi +13 -13
- data/rbi/stripe/services/treasury/financial_account_features_service.rbi +23 -26
- data/rbi/stripe/services/treasury/financial_account_service.rbi +92 -96
- data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +15 -15
- data/rbi/stripe/services/treasury/outbound_payment_service.rbi +60 -56
- data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +24 -49
- data/rbi/stripe/services/treasury/received_credit_service.rbi +11 -9
- data/rbi/stripe/services/treasury/received_debit_service.rbi +8 -8
- data/rbi/stripe/services/treasury/transaction_entry_service.rbi +25 -21
- data/rbi/stripe/services/treasury/transaction_service.rbi +31 -23
- data/rbi/stripe/services/v1_services.rbi +1 -7
- data/rbi/stripe/services/v2/billing/meter_event_service.rbi +3 -3
- data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +3 -3
- data/rbi/stripe/services/v2/core/event_destination_service.rbi +21 -24
- data/rbi/stripe/services/v2/core/event_service.rbi +3 -6
- data/rbi/stripe/services/webhook_endpoint_service.rbi +20 -20
- metadata +4 -109
- data/lib/stripe/request_signing_authenticator.rb +0 -79
- data/lib/stripe/resources/account_notice.rb +0 -132
- data/lib/stripe/resources/billing/meter_error_report.rb +0 -59
- data/lib/stripe/resources/capital/financing_offer.rb +0 -188
- data/lib/stripe/resources/capital/financing_summary.rb +0 -64
- data/lib/stripe/resources/capital/financing_transaction.rb +0 -123
- data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -27
- data/lib/stripe/resources/financial_connections/institution.rb +0 -99
- data/lib/stripe/resources/gift_cards/card.rb +0 -217
- data/lib/stripe/resources/gift_cards/transaction.rb +0 -281
- data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -611
- data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -84
- data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -95
- data/lib/stripe/resources/issuing/settlement.rb +0 -49
- data/lib/stripe/resources/margin.rb +0 -124
- data/lib/stripe/resources/order.rb +0 -2868
- data/lib/stripe/resources/payment_attempt_record.rb +0 -184
- data/lib/stripe/resources/payment_record.rb +0 -715
- data/lib/stripe/resources/quote_line.rb +0 -274
- data/lib/stripe/resources/quote_preview_invoice.rb +0 -652
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -362
- data/lib/stripe/resources/tax/association.rb +0 -89
- data/lib/stripe/resources/tax/form.rb +0 -220
- data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -40
- data/lib/stripe/resources/usage_record.rb +0 -30
- data/lib/stripe/resources/usage_record_summary.rb +0 -33
- data/lib/stripe/services/account_notice_service.rb +0 -101
- data/lib/stripe/services/capital/financing_offer_service.rb +0 -112
- data/lib/stripe/services/capital/financing_summary_service.rb +0 -28
- data/lib/stripe/services/capital/financing_transaction_service.rb +0 -79
- data/lib/stripe/services/capital_service.rb +0 -15
- data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +0 -37
- data/lib/stripe/services/financial_connections/institution_service.rb +0 -57
- data/lib/stripe/services/gift_cards/card_service.rb +0 -170
- data/lib/stripe/services/gift_cards/transaction_service.rb +0 -209
- data/lib/stripe/services/gift_cards_service.rb +0 -14
- data/lib/stripe/services/invoice_upcoming_lines_service.rb +0 -1881
- data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -504
- data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -66
- data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -83
- data/lib/stripe/services/margin_service.rb +0 -119
- data/lib/stripe/services/order_line_item_service.rb +0 -35
- data/lib/stripe/services/order_service.rb +0 -2268
- data/lib/stripe/services/payment_attempt_record_service.rb +0 -49
- data/lib/stripe/services/payment_record_service.rb +0 -542
- data/lib/stripe/services/quote_line_service.rb +0 -35
- data/lib/stripe/services/quote_preview_invoice_service.rb +0 -35
- data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -35
- data/lib/stripe/services/subscription_item_usage_record_service.rb +0 -41
- data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +0 -37
- data/lib/stripe/services/tax/association_service.rb +0 -31
- data/lib/stripe/services/tax/form_service.rb +0 -100
- data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -28
- data/rbi/stripe/resources/account_notice.rbi +0 -139
- data/rbi/stripe/resources/billing/meter_error_report.rbi +0 -71
- data/rbi/stripe/resources/capital/financing_offer.rbi +0 -190
- data/rbi/stripe/resources/capital/financing_summary.rbi +0 -74
- data/rbi/stripe/resources/capital/financing_transaction.rbi +0 -130
- data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +0 -27
- data/rbi/stripe/resources/financial_connections/institution.rbi +0 -99
- data/rbi/stripe/resources/gift_cards/card.rbi +0 -206
- data/rbi/stripe/resources/gift_cards/transaction.rbi +0 -257
- data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +0 -622
- data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +0 -83
- data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +0 -90
- data/rbi/stripe/resources/issuing/settlement.rbi +0 -62
- data/rbi/stripe/resources/margin.rbi +0 -127
- data/rbi/stripe/resources/order.rbi +0 -3036
- data/rbi/stripe/resources/payment_attempt_record.rbi +0 -215
- data/rbi/stripe/resources/payment_record.rbi +0 -722
- data/rbi/stripe/resources/quote_line.rbi +0 -350
- data/rbi/stripe/resources/quote_preview_invoice.rbi +0 -850
- data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +0 -474
- data/rbi/stripe/resources/tax/association.rbi +0 -94
- data/rbi/stripe/resources/tax/form.rbi +0 -224
- data/rbi/stripe/resources/terminal/reader_collected_data.rbi +0 -41
- data/rbi/stripe/resources/usage_record.rbi +0 -32
- data/rbi/stripe/resources/usage_record_summary.rbi +0 -38
- data/rbi/stripe/services/account_notice_service.rbi +0 -90
- data/rbi/stripe/services/capital/financing_offer_service.rbi +0 -95
- data/rbi/stripe/services/capital/financing_summary_service.rbi +0 -22
- data/rbi/stripe/services/capital/financing_transaction_service.rbi +0 -68
- data/rbi/stripe/services/capital_service.rbi +0 -11
- data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +0 -33
- data/rbi/stripe/services/financial_connections/institution_service.rbi +0 -46
- data/rbi/stripe/services/gift_cards/card_service.rbi +0 -142
- data/rbi/stripe/services/gift_cards/transaction_service.rbi +0 -174
- data/rbi/stripe/services/gift_cards_service.rbi +0 -10
- data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +0 -2023
- data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +0 -498
- data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +0 -55
- data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +0 -73
- data/rbi/stripe/services/margin_service.rbi +0 -104
- data/rbi/stripe/services/order_line_item_service.rbi +0 -31
- data/rbi/stripe/services/order_service.rbi +0 -2320
- data/rbi/stripe/services/payment_attempt_record_service.rbi +0 -36
- data/rbi/stripe/services/payment_record_service.rbi +0 -521
- data/rbi/stripe/services/quote_line_service.rbi +0 -31
- data/rbi/stripe/services/quote_preview_invoice_service.rbi +0 -31
- data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +0 -31
- data/rbi/stripe/services/subscription_item_usage_record_service.rbi +0 -37
- data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +0 -33
- data/rbi/stripe/services/tax/association_service.rbi +0 -25
- data/rbi/stripe/services/tax/form_service.rbi +0 -85
- data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +0 -22
@@ -160,25 +160,25 @@ module Stripe
|
|
160
160
|
attr_reader :updated
|
161
161
|
class ListParams < Stripe::RequestParams
|
162
162
|
# Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations).
|
163
|
-
sig { returns(T::Boolean) }
|
163
|
+
sig { returns(T.nilable(T::Boolean)) }
|
164
164
|
attr_accessor :active
|
165
165
|
# 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.
|
166
|
-
sig { returns(String) }
|
166
|
+
sig { returns(T.nilable(String)) }
|
167
167
|
attr_accessor :ending_before
|
168
168
|
# Specifies which fields in the response should be expanded.
|
169
|
-
sig { returns(T::Array[String]) }
|
169
|
+
sig { returns(T.nilable(T::Array[String])) }
|
170
170
|
attr_accessor :expand
|
171
171
|
# Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration).
|
172
|
-
sig { returns(T::Boolean) }
|
172
|
+
sig { returns(T.nilable(T::Boolean)) }
|
173
173
|
attr_accessor :is_default
|
174
174
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
175
|
-
sig { returns(Integer) }
|
175
|
+
sig { returns(T.nilable(Integer)) }
|
176
176
|
attr_accessor :limit
|
177
177
|
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
|
178
|
-
sig { returns(String) }
|
178
|
+
sig { returns(T.nilable(String)) }
|
179
179
|
attr_accessor :starting_after
|
180
180
|
sig {
|
181
|
-
params(active: T::Boolean, ending_before: String, expand: T::Array[String], is_default: T::Boolean, limit: Integer, starting_after: String).void
|
181
|
+
params(active: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), is_default: T.nilable(T::Boolean), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
|
182
182
|
}
|
183
183
|
def initialize(
|
184
184
|
active: nil,
|
@@ -192,28 +192,30 @@ module Stripe
|
|
192
192
|
class CreateParams < Stripe::RequestParams
|
193
193
|
class BusinessProfile < Stripe::RequestParams
|
194
194
|
# The messaging shown to customers in the portal.
|
195
|
-
sig { returns(T.nilable(String)) }
|
195
|
+
sig { returns(T.nilable(T.nilable(String))) }
|
196
196
|
attr_accessor :headline
|
197
197
|
# A link to the business’s publicly available privacy policy.
|
198
|
-
sig { returns(String) }
|
198
|
+
sig { returns(T.nilable(String)) }
|
199
199
|
attr_accessor :privacy_policy_url
|
200
200
|
# A link to the business’s publicly available terms of service.
|
201
|
-
sig { returns(String) }
|
201
|
+
sig { returns(T.nilable(String)) }
|
202
202
|
attr_accessor :terms_of_service_url
|
203
203
|
sig {
|
204
|
-
params(headline: T.nilable(String), privacy_policy_url: String, terms_of_service_url: String).void
|
204
|
+
params(headline: T.nilable(T.nilable(String)), privacy_policy_url: T.nilable(String), terms_of_service_url: T.nilable(String)).void
|
205
205
|
}
|
206
206
|
def initialize(headline: nil, privacy_policy_url: nil, terms_of_service_url: nil); end
|
207
207
|
end
|
208
208
|
class Features < Stripe::RequestParams
|
209
209
|
class CustomerUpdate < Stripe::RequestParams
|
210
210
|
# The types of customer updates that are supported. When empty, customers are not updateable.
|
211
|
-
sig { returns(T.nilable(T::Array[String])) }
|
211
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
|
212
212
|
attr_accessor :allowed_updates
|
213
213
|
# Whether the feature is enabled.
|
214
214
|
sig { returns(T::Boolean) }
|
215
215
|
attr_accessor :enabled
|
216
|
-
sig {
|
216
|
+
sig {
|
217
|
+
params(allowed_updates: T.nilable(T.nilable(T.any(String, T::Array[String]))), enabled: T::Boolean).void
|
218
|
+
}
|
217
219
|
def initialize(allowed_updates: nil, enabled: nil); end
|
218
220
|
end
|
219
221
|
class InvoiceHistory < Stripe::RequestParams
|
@@ -236,27 +238,29 @@ module Stripe
|
|
236
238
|
sig { returns(T::Boolean) }
|
237
239
|
attr_accessor :enabled
|
238
240
|
# Which cancellation reasons will be given as options to the customer.
|
239
|
-
sig { returns(T.nilable(T::Array[String])) }
|
241
|
+
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
|
240
242
|
attr_accessor :options
|
241
|
-
sig {
|
243
|
+
sig {
|
244
|
+
params(enabled: T::Boolean, options: T.nilable(T.any(String, T::Array[String]))).void
|
245
|
+
}
|
242
246
|
def initialize(enabled: nil, options: nil); end
|
243
247
|
end
|
244
248
|
# Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer
|
245
249
|
sig {
|
246
|
-
returns(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel::CancellationReason)
|
250
|
+
returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel::CancellationReason))
|
247
251
|
}
|
248
252
|
attr_accessor :cancellation_reason
|
249
253
|
# Whether the feature is enabled.
|
250
254
|
sig { returns(T::Boolean) }
|
251
255
|
attr_accessor :enabled
|
252
256
|
# Whether to cancel subscriptions immediately or at the end of the billing period.
|
253
|
-
sig { returns(String) }
|
257
|
+
sig { returns(T.nilable(String)) }
|
254
258
|
attr_accessor :mode
|
255
259
|
# Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. Passing `always_invoice` will result in an error. No prorations are generated when canceling a subscription at the end of its natural billing period.
|
256
|
-
sig { returns(String) }
|
260
|
+
sig { returns(T.nilable(String)) }
|
257
261
|
attr_accessor :proration_behavior
|
258
262
|
sig {
|
259
|
-
params(cancellation_reason: ::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel::CancellationReason, enabled: T::Boolean, mode: String, proration_behavior: String).void
|
263
|
+
params(cancellation_reason: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel::CancellationReason), enabled: T::Boolean, mode: T.nilable(String), proration_behavior: T.nilable(String)).void
|
260
264
|
}
|
261
265
|
def initialize(
|
262
266
|
cancellation_reason: nil,
|
@@ -286,35 +290,35 @@ module Stripe
|
|
286
290
|
end
|
287
291
|
# List of conditions. When any condition is true, the update will be scheduled at the end of the current period.
|
288
292
|
sig {
|
289
|
-
returns(T::Array[::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition])
|
293
|
+
returns(T.nilable(T::Array[::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition]))
|
290
294
|
}
|
291
295
|
attr_accessor :conditions
|
292
296
|
sig {
|
293
|
-
params(conditions: T::Array[::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition]).void
|
297
|
+
params(conditions: T.nilable(T::Array[::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition])).void
|
294
298
|
}
|
295
299
|
def initialize(conditions: nil); end
|
296
300
|
end
|
297
301
|
# The types of subscription updates that are supported. When empty, subscriptions are not updateable.
|
298
|
-
sig { returns(T.nilable(T::Array[String])) }
|
302
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
|
299
303
|
attr_accessor :default_allowed_updates
|
300
304
|
# Whether the feature is enabled.
|
301
305
|
sig { returns(T::Boolean) }
|
302
306
|
attr_accessor :enabled
|
303
307
|
# The list of up to 10 products that support subscription updates.
|
304
308
|
sig {
|
305
|
-
returns(T.nilable(T::Array[::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::Product]))
|
309
|
+
returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::Product]))))
|
306
310
|
}
|
307
311
|
attr_accessor :products
|
308
312
|
# Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.
|
309
|
-
sig { returns(String) }
|
313
|
+
sig { returns(T.nilable(String)) }
|
310
314
|
attr_accessor :proration_behavior
|
311
315
|
# Setting to control when an update should be scheduled at the end of the period instead of applying immediately.
|
312
316
|
sig {
|
313
|
-
returns(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd)
|
317
|
+
returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd))
|
314
318
|
}
|
315
319
|
attr_accessor :schedule_at_period_end
|
316
320
|
sig {
|
317
|
-
params(default_allowed_updates: T.nilable(T::Array[String]), enabled: T::Boolean, products: T.nilable(T::Array[::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::Product]), proration_behavior: String, schedule_at_period_end: ::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd).void
|
321
|
+
params(default_allowed_updates: T.nilable(T.nilable(T.any(String, T::Array[String]))), enabled: T::Boolean, products: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::Product]))), proration_behavior: T.nilable(String), schedule_at_period_end: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd)).void
|
318
322
|
}
|
319
323
|
def initialize(
|
320
324
|
default_allowed_updates: nil,
|
@@ -326,31 +330,31 @@ module Stripe
|
|
326
330
|
end
|
327
331
|
# Information about updating the customer details in the portal.
|
328
332
|
sig {
|
329
|
-
returns(::Stripe::BillingPortal::Configuration::CreateParams::Features::CustomerUpdate)
|
333
|
+
returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::CustomerUpdate))
|
330
334
|
}
|
331
335
|
attr_accessor :customer_update
|
332
336
|
# Information about showing the billing history in the portal.
|
333
337
|
sig {
|
334
|
-
returns(::Stripe::BillingPortal::Configuration::CreateParams::Features::InvoiceHistory)
|
338
|
+
returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::InvoiceHistory))
|
335
339
|
}
|
336
340
|
attr_accessor :invoice_history
|
337
341
|
# Information about updating payment methods in the portal.
|
338
342
|
sig {
|
339
|
-
returns(::Stripe::BillingPortal::Configuration::CreateParams::Features::PaymentMethodUpdate)
|
343
|
+
returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::PaymentMethodUpdate))
|
340
344
|
}
|
341
345
|
attr_accessor :payment_method_update
|
342
346
|
# Information about canceling subscriptions in the portal.
|
343
347
|
sig {
|
344
|
-
returns(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel)
|
348
|
+
returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel))
|
345
349
|
}
|
346
350
|
attr_accessor :subscription_cancel
|
347
351
|
# Information about updating subscriptions in the portal.
|
348
352
|
sig {
|
349
|
-
returns(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate)
|
353
|
+
returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate))
|
350
354
|
}
|
351
355
|
attr_accessor :subscription_update
|
352
356
|
sig {
|
353
|
-
params(customer_update: ::Stripe::BillingPortal::Configuration::CreateParams::Features::CustomerUpdate, invoice_history: ::Stripe::BillingPortal::Configuration::CreateParams::Features::InvoiceHistory, payment_method_update: ::Stripe::BillingPortal::Configuration::CreateParams::Features::PaymentMethodUpdate, subscription_cancel: ::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel, subscription_update: ::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate).void
|
357
|
+
params(customer_update: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::CustomerUpdate), invoice_history: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::InvoiceHistory), payment_method_update: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::PaymentMethodUpdate), subscription_cancel: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionCancel), subscription_update: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::Features::SubscriptionUpdate)).void
|
354
358
|
}
|
355
359
|
def initialize(
|
356
360
|
customer_update: nil,
|
@@ -368,25 +372,27 @@ module Stripe
|
|
368
372
|
def initialize(enabled: nil); end
|
369
373
|
end
|
370
374
|
# The business information shown to customers in the portal.
|
371
|
-
sig {
|
375
|
+
sig {
|
376
|
+
returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::BusinessProfile))
|
377
|
+
}
|
372
378
|
attr_accessor :business_profile
|
373
379
|
# The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
|
374
|
-
sig { returns(T.nilable(String)) }
|
380
|
+
sig { returns(T.nilable(T.nilable(String))) }
|
375
381
|
attr_accessor :default_return_url
|
376
382
|
# Specifies which fields in the response should be expanded.
|
377
|
-
sig { returns(T::Array[String]) }
|
383
|
+
sig { returns(T.nilable(T::Array[String])) }
|
378
384
|
attr_accessor :expand
|
379
385
|
# Information about the features available in the portal.
|
380
386
|
sig { returns(::Stripe::BillingPortal::Configuration::CreateParams::Features) }
|
381
387
|
attr_accessor :features
|
382
388
|
# The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).
|
383
|
-
sig { returns(::Stripe::BillingPortal::Configuration::CreateParams::LoginPage) }
|
389
|
+
sig { returns(T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::LoginPage)) }
|
384
390
|
attr_accessor :login_page
|
385
391
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
386
|
-
sig { returns(T::Hash[String, String]) }
|
392
|
+
sig { returns(T.nilable(T::Hash[String, String])) }
|
387
393
|
attr_accessor :metadata
|
388
394
|
sig {
|
389
|
-
params(business_profile: ::Stripe::BillingPortal::Configuration::CreateParams::BusinessProfile, default_return_url: T.nilable(String), expand: T::Array[String], features: ::Stripe::BillingPortal::Configuration::CreateParams::Features, login_page: ::Stripe::BillingPortal::Configuration::CreateParams::LoginPage, metadata: T::Hash[String, String]).void
|
395
|
+
params(business_profile: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::BusinessProfile), default_return_url: T.nilable(T.nilable(String)), expand: T.nilable(T::Array[String]), features: ::Stripe::BillingPortal::Configuration::CreateParams::Features, login_page: T.nilable(::Stripe::BillingPortal::Configuration::CreateParams::LoginPage), metadata: T.nilable(T::Hash[String, String])).void
|
390
396
|
}
|
391
397
|
def initialize(
|
392
398
|
business_profile: nil,
|
@@ -397,38 +403,33 @@ module Stripe
|
|
397
403
|
metadata: nil
|
398
404
|
); end
|
399
405
|
end
|
400
|
-
class RetrieveParams < Stripe::RequestParams
|
401
|
-
# Specifies which fields in the response should be expanded.
|
402
|
-
sig { returns(T::Array[String]) }
|
403
|
-
attr_accessor :expand
|
404
|
-
sig { params(expand: T::Array[String]).void }
|
405
|
-
def initialize(expand: nil); end
|
406
|
-
end
|
407
406
|
class UpdateParams < Stripe::RequestParams
|
408
407
|
class BusinessProfile < Stripe::RequestParams
|
409
408
|
# The messaging shown to customers in the portal.
|
410
|
-
sig { returns(T.nilable(String)) }
|
409
|
+
sig { returns(T.nilable(T.nilable(String))) }
|
411
410
|
attr_accessor :headline
|
412
411
|
# A link to the business’s publicly available privacy policy.
|
413
|
-
sig { returns(T.nilable(String)) }
|
412
|
+
sig { returns(T.nilable(T.nilable(String))) }
|
414
413
|
attr_accessor :privacy_policy_url
|
415
414
|
# A link to the business’s publicly available terms of service.
|
416
|
-
sig { returns(T.nilable(String)) }
|
415
|
+
sig { returns(T.nilable(T.nilable(String))) }
|
417
416
|
attr_accessor :terms_of_service_url
|
418
417
|
sig {
|
419
|
-
params(headline: T.nilable(String), privacy_policy_url: T.nilable(String), terms_of_service_url: T.nilable(String)).void
|
418
|
+
params(headline: T.nilable(T.nilable(String)), privacy_policy_url: T.nilable(T.nilable(String)), terms_of_service_url: T.nilable(T.nilable(String))).void
|
420
419
|
}
|
421
420
|
def initialize(headline: nil, privacy_policy_url: nil, terms_of_service_url: nil); end
|
422
421
|
end
|
423
422
|
class Features < Stripe::RequestParams
|
424
423
|
class CustomerUpdate < Stripe::RequestParams
|
425
424
|
# The types of customer updates that are supported. When empty, customers are not updateable.
|
426
|
-
sig { returns(T.nilable(T::Array[String])) }
|
425
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
|
427
426
|
attr_accessor :allowed_updates
|
428
427
|
# Whether the feature is enabled.
|
429
|
-
sig { returns(T::Boolean) }
|
428
|
+
sig { returns(T.nilable(T::Boolean)) }
|
430
429
|
attr_accessor :enabled
|
431
|
-
sig {
|
430
|
+
sig {
|
431
|
+
params(allowed_updates: T.nilable(T.nilable(T.any(String, T::Array[String]))), enabled: T.nilable(T::Boolean)).void
|
432
|
+
}
|
432
433
|
def initialize(allowed_updates: nil, enabled: nil); end
|
433
434
|
end
|
434
435
|
class InvoiceHistory < Stripe::RequestParams
|
@@ -451,27 +452,29 @@ module Stripe
|
|
451
452
|
sig { returns(T::Boolean) }
|
452
453
|
attr_accessor :enabled
|
453
454
|
# Which cancellation reasons will be given as options to the customer.
|
454
|
-
sig { returns(T.nilable(T::Array[String])) }
|
455
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
|
455
456
|
attr_accessor :options
|
456
|
-
sig {
|
457
|
+
sig {
|
458
|
+
params(enabled: T::Boolean, options: T.nilable(T.nilable(T.any(String, T::Array[String])))).void
|
459
|
+
}
|
457
460
|
def initialize(enabled: nil, options: nil); end
|
458
461
|
end
|
459
462
|
# Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer
|
460
463
|
sig {
|
461
|
-
returns(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionCancel::CancellationReason)
|
464
|
+
returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionCancel::CancellationReason))
|
462
465
|
}
|
463
466
|
attr_accessor :cancellation_reason
|
464
467
|
# Whether the feature is enabled.
|
465
|
-
sig { returns(T::Boolean) }
|
468
|
+
sig { returns(T.nilable(T::Boolean)) }
|
466
469
|
attr_accessor :enabled
|
467
470
|
# Whether to cancel subscriptions immediately or at the end of the billing period.
|
468
|
-
sig { returns(String) }
|
471
|
+
sig { returns(T.nilable(String)) }
|
469
472
|
attr_accessor :mode
|
470
473
|
# Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`, which is only compatible with `mode=immediately`. Passing `always_invoice` will result in an error. No prorations are generated when canceling a subscription at the end of its natural billing period.
|
471
|
-
sig { returns(String) }
|
474
|
+
sig { returns(T.nilable(String)) }
|
472
475
|
attr_accessor :proration_behavior
|
473
476
|
sig {
|
474
|
-
params(cancellation_reason: ::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionCancel::CancellationReason, enabled: T::Boolean, mode: String, proration_behavior: String).void
|
477
|
+
params(cancellation_reason: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionCancel::CancellationReason), enabled: T.nilable(T::Boolean), mode: T.nilable(String), proration_behavior: T.nilable(String)).void
|
475
478
|
}
|
476
479
|
def initialize(
|
477
480
|
cancellation_reason: nil,
|
@@ -501,35 +504,35 @@ module Stripe
|
|
501
504
|
end
|
502
505
|
# List of conditions. When any condition is true, the update will be scheduled at the end of the current period.
|
503
506
|
sig {
|
504
|
-
returns(T.nilable(T::Array[::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition]))
|
507
|
+
returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition]))))
|
505
508
|
}
|
506
509
|
attr_accessor :conditions
|
507
510
|
sig {
|
508
|
-
params(conditions: T.nilable(T::Array[::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition])).void
|
511
|
+
params(conditions: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd::Condition])))).void
|
509
512
|
}
|
510
513
|
def initialize(conditions: nil); end
|
511
514
|
end
|
512
515
|
# The types of subscription updates that are supported. When empty, subscriptions are not updateable.
|
513
|
-
sig { returns(T.nilable(T::Array[String])) }
|
516
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
|
514
517
|
attr_accessor :default_allowed_updates
|
515
518
|
# Whether the feature is enabled.
|
516
|
-
sig { returns(T::Boolean) }
|
519
|
+
sig { returns(T.nilable(T::Boolean)) }
|
517
520
|
attr_accessor :enabled
|
518
521
|
# The list of up to 10 products that support subscription updates.
|
519
522
|
sig {
|
520
|
-
returns(T.nilable(T::Array[::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::Product]))
|
523
|
+
returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::Product]))))
|
521
524
|
}
|
522
525
|
attr_accessor :products
|
523
526
|
# Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.
|
524
|
-
sig { returns(String) }
|
527
|
+
sig { returns(T.nilable(String)) }
|
525
528
|
attr_accessor :proration_behavior
|
526
529
|
# Setting to control when an update should be scheduled at the end of the period instead of applying immediately.
|
527
530
|
sig {
|
528
|
-
returns(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd)
|
531
|
+
returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd))
|
529
532
|
}
|
530
533
|
attr_accessor :schedule_at_period_end
|
531
534
|
sig {
|
532
|
-
params(default_allowed_updates: T.nilable(T::Array[String]), enabled: T::Boolean, products: T.nilable(T::Array[::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::Product]), proration_behavior: String, schedule_at_period_end: ::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd).void
|
535
|
+
params(default_allowed_updates: T.nilable(T.nilable(T.any(String, T::Array[String]))), enabled: T.nilable(T::Boolean), products: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::Product]))), proration_behavior: T.nilable(String), schedule_at_period_end: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate::ScheduleAtPeriodEnd)).void
|
533
536
|
}
|
534
537
|
def initialize(
|
535
538
|
default_allowed_updates: nil,
|
@@ -541,31 +544,31 @@ module Stripe
|
|
541
544
|
end
|
542
545
|
# Information about updating the customer details in the portal.
|
543
546
|
sig {
|
544
|
-
returns(::Stripe::BillingPortal::Configuration::UpdateParams::Features::CustomerUpdate)
|
547
|
+
returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::CustomerUpdate))
|
545
548
|
}
|
546
549
|
attr_accessor :customer_update
|
547
550
|
# Information about showing the billing history in the portal.
|
548
551
|
sig {
|
549
|
-
returns(::Stripe::BillingPortal::Configuration::UpdateParams::Features::InvoiceHistory)
|
552
|
+
returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::InvoiceHistory))
|
550
553
|
}
|
551
554
|
attr_accessor :invoice_history
|
552
555
|
# Information about updating payment methods in the portal.
|
553
556
|
sig {
|
554
|
-
returns(::Stripe::BillingPortal::Configuration::UpdateParams::Features::PaymentMethodUpdate)
|
557
|
+
returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::PaymentMethodUpdate))
|
555
558
|
}
|
556
559
|
attr_accessor :payment_method_update
|
557
560
|
# Information about canceling subscriptions in the portal.
|
558
561
|
sig {
|
559
|
-
returns(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionCancel)
|
562
|
+
returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionCancel))
|
560
563
|
}
|
561
564
|
attr_accessor :subscription_cancel
|
562
565
|
# Information about updating subscriptions in the portal.
|
563
566
|
sig {
|
564
|
-
returns(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate)
|
567
|
+
returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate))
|
565
568
|
}
|
566
569
|
attr_accessor :subscription_update
|
567
570
|
sig {
|
568
|
-
params(customer_update: ::Stripe::BillingPortal::Configuration::UpdateParams::Features::CustomerUpdate, invoice_history: ::Stripe::BillingPortal::Configuration::UpdateParams::Features::InvoiceHistory, payment_method_update: ::Stripe::BillingPortal::Configuration::UpdateParams::Features::PaymentMethodUpdate, subscription_cancel: ::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionCancel, subscription_update: ::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate).void
|
571
|
+
params(customer_update: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::CustomerUpdate), invoice_history: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::InvoiceHistory), payment_method_update: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::PaymentMethodUpdate), subscription_cancel: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionCancel), subscription_update: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features::SubscriptionUpdate)).void
|
569
572
|
}
|
570
573
|
def initialize(
|
571
574
|
customer_update: nil,
|
@@ -585,28 +588,30 @@ module Stripe
|
|
585
588
|
def initialize(enabled: nil); end
|
586
589
|
end
|
587
590
|
# Whether the configuration is active and can be used to create portal sessions.
|
588
|
-
sig { returns(T::Boolean) }
|
591
|
+
sig { returns(T.nilable(T::Boolean)) }
|
589
592
|
attr_accessor :active
|
590
593
|
# The business information shown to customers in the portal.
|
591
|
-
sig {
|
594
|
+
sig {
|
595
|
+
returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::BusinessProfile))
|
596
|
+
}
|
592
597
|
attr_accessor :business_profile
|
593
598
|
# The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
|
594
|
-
sig { returns(T.nilable(String)) }
|
599
|
+
sig { returns(T.nilable(T.nilable(String))) }
|
595
600
|
attr_accessor :default_return_url
|
596
601
|
# Specifies which fields in the response should be expanded.
|
597
|
-
sig { returns(T::Array[String]) }
|
602
|
+
sig { returns(T.nilable(T::Array[String])) }
|
598
603
|
attr_accessor :expand
|
599
604
|
# Information about the features available in the portal.
|
600
|
-
sig { returns(::Stripe::BillingPortal::Configuration::UpdateParams::Features) }
|
605
|
+
sig { returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features)) }
|
601
606
|
attr_accessor :features
|
602
607
|
# The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share).
|
603
|
-
sig { returns(::Stripe::BillingPortal::Configuration::UpdateParams::LoginPage) }
|
608
|
+
sig { returns(T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::LoginPage)) }
|
604
609
|
attr_accessor :login_page
|
605
610
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
606
|
-
sig { returns(T.nilable(T::Hash[String, String])) }
|
611
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
|
607
612
|
attr_accessor :metadata
|
608
613
|
sig {
|
609
|
-
params(active: T::Boolean, business_profile: ::Stripe::BillingPortal::Configuration::UpdateParams::BusinessProfile, default_return_url: T.nilable(String), expand: T::Array[String], features: ::Stripe::BillingPortal::Configuration::UpdateParams::Features, login_page: ::Stripe::BillingPortal::Configuration::UpdateParams::LoginPage, metadata: T.nilable(T::Hash[String, String])).void
|
614
|
+
params(active: T.nilable(T::Boolean), business_profile: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::BusinessProfile), default_return_url: T.nilable(T.nilable(String)), expand: T.nilable(T::Array[String]), features: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::Features), login_page: T.nilable(::Stripe::BillingPortal::Configuration::UpdateParams::LoginPage), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
|
610
615
|
}
|
611
616
|
def initialize(
|
612
617
|
active: nil,
|
@@ -151,9 +151,9 @@ module Stripe
|
|
151
151
|
class AfterCompletion < Stripe::RequestParams
|
152
152
|
class HostedConfirmation < Stripe::RequestParams
|
153
153
|
# A custom message to display to the customer after the flow is completed.
|
154
|
-
sig { returns(String) }
|
154
|
+
sig { returns(T.nilable(String)) }
|
155
155
|
attr_accessor :custom_message
|
156
|
-
sig { params(custom_message: String).void }
|
156
|
+
sig { params(custom_message: T.nilable(String)).void }
|
157
157
|
def initialize(custom_message: nil); end
|
158
158
|
end
|
159
159
|
class Redirect < Stripe::RequestParams
|
@@ -165,19 +165,19 @@ module Stripe
|
|
165
165
|
end
|
166
166
|
# Configuration when `after_completion.type=hosted_confirmation`.
|
167
167
|
sig {
|
168
|
-
returns(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::HostedConfirmation)
|
168
|
+
returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::HostedConfirmation))
|
169
169
|
}
|
170
170
|
attr_accessor :hosted_confirmation
|
171
171
|
# Configuration when `after_completion.type=redirect`.
|
172
172
|
sig {
|
173
|
-
returns(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::Redirect)
|
173
|
+
returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::Redirect))
|
174
174
|
}
|
175
175
|
attr_accessor :redirect
|
176
176
|
# The specified behavior after the flow is completed.
|
177
177
|
sig { returns(String) }
|
178
178
|
attr_accessor :type
|
179
179
|
sig {
|
180
|
-
params(hosted_confirmation: ::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::HostedConfirmation, redirect: ::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::Redirect, type: String).void
|
180
|
+
params(hosted_confirmation: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::HostedConfirmation), redirect: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::Redirect), type: String).void
|
181
181
|
}
|
182
182
|
def initialize(hosted_confirmation: nil, redirect: nil, type: nil); end
|
183
183
|
end
|
@@ -205,14 +205,14 @@ module Stripe
|
|
205
205
|
end
|
206
206
|
# Specify a retention strategy to be used in the cancellation flow.
|
207
207
|
sig {
|
208
|
-
returns(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel::Retention)
|
208
|
+
returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel::Retention))
|
209
209
|
}
|
210
210
|
attr_accessor :retention
|
211
211
|
# The ID of the subscription to be canceled.
|
212
212
|
sig { returns(String) }
|
213
213
|
attr_accessor :subscription
|
214
214
|
sig {
|
215
|
-
params(retention: ::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel::Retention, subscription: String).void
|
215
|
+
params(retention: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel::Retention), subscription: String).void
|
216
216
|
}
|
217
217
|
def initialize(retention: nil, subscription: nil); end
|
218
218
|
end
|
@@ -226,12 +226,12 @@ module Stripe
|
|
226
226
|
class SubscriptionUpdateConfirm < Stripe::RequestParams
|
227
227
|
class Discount < Stripe::RequestParams
|
228
228
|
# The ID of the coupon to apply to this subscription update.
|
229
|
-
sig { returns(String) }
|
229
|
+
sig { returns(T.nilable(String)) }
|
230
230
|
attr_accessor :coupon
|
231
231
|
# The ID of a promotion code to apply to this subscription update.
|
232
|
-
sig { returns(String) }
|
232
|
+
sig { returns(T.nilable(String)) }
|
233
233
|
attr_accessor :promotion_code
|
234
|
-
sig { params(coupon: String, promotion_code: String).void }
|
234
|
+
sig { params(coupon: T.nilable(String), promotion_code: T.nilable(String)).void }
|
235
235
|
def initialize(coupon: nil, promotion_code: nil); end
|
236
236
|
end
|
237
237
|
class Item < Stripe::RequestParams
|
@@ -239,17 +239,19 @@ module Stripe
|
|
239
239
|
sig { returns(String) }
|
240
240
|
attr_accessor :id
|
241
241
|
# The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
|
242
|
-
sig { returns(String) }
|
242
|
+
sig { returns(T.nilable(String)) }
|
243
243
|
attr_accessor :price
|
244
244
|
# [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
|
245
|
-
sig { returns(Integer) }
|
245
|
+
sig { returns(T.nilable(Integer)) }
|
246
246
|
attr_accessor :quantity
|
247
|
-
sig {
|
247
|
+
sig {
|
248
|
+
params(id: String, price: T.nilable(String), quantity: T.nilable(Integer)).void
|
249
|
+
}
|
248
250
|
def initialize(id: nil, price: nil, quantity: nil); end
|
249
251
|
end
|
250
252
|
# The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.
|
251
253
|
sig {
|
252
|
-
returns(T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount])
|
254
|
+
returns(T.nilable(T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount]))
|
253
255
|
}
|
254
256
|
attr_accessor :discounts
|
255
257
|
# The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
|
@@ -261,33 +263,35 @@ module Stripe
|
|
261
263
|
sig { returns(String) }
|
262
264
|
attr_accessor :subscription
|
263
265
|
sig {
|
264
|
-
params(discounts: T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount], items: T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Item], subscription: String).void
|
266
|
+
params(discounts: T.nilable(T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount]), items: T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Item], subscription: String).void
|
265
267
|
}
|
266
268
|
def initialize(discounts: nil, items: nil, subscription: nil); end
|
267
269
|
end
|
268
270
|
# Behavior after the flow is completed.
|
269
|
-
sig {
|
271
|
+
sig {
|
272
|
+
returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion))
|
273
|
+
}
|
270
274
|
attr_accessor :after_completion
|
271
275
|
# Configuration when `flow_data.type=subscription_cancel`.
|
272
276
|
sig {
|
273
|
-
returns(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel)
|
277
|
+
returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel))
|
274
278
|
}
|
275
279
|
attr_accessor :subscription_cancel
|
276
280
|
# Configuration when `flow_data.type=subscription_update`.
|
277
281
|
sig {
|
278
|
-
returns(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdate)
|
282
|
+
returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdate))
|
279
283
|
}
|
280
284
|
attr_accessor :subscription_update
|
281
285
|
# Configuration when `flow_data.type=subscription_update_confirm`.
|
282
286
|
sig {
|
283
|
-
returns(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm)
|
287
|
+
returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm))
|
284
288
|
}
|
285
289
|
attr_accessor :subscription_update_confirm
|
286
290
|
# Type of flow that the customer will go through.
|
287
291
|
sig { returns(String) }
|
288
292
|
attr_accessor :type
|
289
293
|
sig {
|
290
|
-
params(after_completion: ::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion, subscription_cancel: ::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel, subscription_update: ::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdate, subscription_update_confirm: ::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm, type: String).void
|
294
|
+
params(after_completion: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion), subscription_cancel: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel), subscription_update: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdate), subscription_update_confirm: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm), type: String).void
|
291
295
|
}
|
292
296
|
def initialize(
|
293
297
|
after_completion: nil,
|
@@ -298,28 +302,28 @@ module Stripe
|
|
298
302
|
); end
|
299
303
|
end
|
300
304
|
# The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
|
301
|
-
sig { returns(String) }
|
305
|
+
sig { returns(T.nilable(String)) }
|
302
306
|
attr_accessor :configuration
|
303
307
|
# The ID of an existing customer.
|
304
308
|
sig { returns(String) }
|
305
309
|
attr_accessor :customer
|
306
310
|
# Specifies which fields in the response should be expanded.
|
307
|
-
sig { returns(T::Array[String]) }
|
311
|
+
sig { returns(T.nilable(T::Array[String])) }
|
308
312
|
attr_accessor :expand
|
309
313
|
# Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
|
310
|
-
sig { returns(::Stripe::BillingPortal::Session::CreateParams::FlowData) }
|
314
|
+
sig { returns(T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData)) }
|
311
315
|
attr_accessor :flow_data
|
312
316
|
# The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.
|
313
|
-
sig { returns(String) }
|
317
|
+
sig { returns(T.nilable(String)) }
|
314
318
|
attr_accessor :locale
|
315
319
|
# The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
|
316
|
-
sig { returns(String) }
|
320
|
+
sig { returns(T.nilable(String)) }
|
317
321
|
attr_accessor :on_behalf_of
|
318
322
|
# The default URL to redirect customers to when they click on the portal's link to return to your website.
|
319
|
-
sig { returns(String) }
|
323
|
+
sig { returns(T.nilable(String)) }
|
320
324
|
attr_accessor :return_url
|
321
325
|
sig {
|
322
|
-
params(configuration: String, customer: String, expand: T::Array[String], flow_data: ::Stripe::BillingPortal::Session::CreateParams::FlowData, locale: String, on_behalf_of: String, return_url: String).void
|
326
|
+
params(configuration: T.nilable(String), customer: String, expand: T.nilable(T::Array[String]), flow_data: T.nilable(::Stripe::BillingPortal::Session::CreateParams::FlowData), locale: T.nilable(String), on_behalf_of: T.nilable(String), return_url: T.nilable(String)).void
|
323
327
|
}
|
324
328
|
def initialize(
|
325
329
|
configuration: nil,
|
@@ -14,7 +14,7 @@ module Stripe
|
|
14
14
|
sig { returns(T.nilable(String)) }
|
15
15
|
attr_reader :preferred
|
16
16
|
end
|
17
|
-
#
|
17
|
+
# Attribute for field account
|
18
18
|
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
|
19
19
|
attr_reader :account
|
20
20
|
# City/District/Suburb/Town/Village.
|
@@ -50,13 +50,10 @@ module Stripe
|
|
50
50
|
# Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
|
51
51
|
sig { returns(String) }
|
52
52
|
attr_reader :brand
|
53
|
-
# The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
|
54
|
-
sig { returns(T.nilable(String)) }
|
55
|
-
attr_reader :brand_product
|
56
53
|
# Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
|
57
54
|
sig { returns(T.nilable(String)) }
|
58
55
|
attr_reader :country
|
59
|
-
# Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available
|
56
|
+
# Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available when returned as an [External Account](/api/external_account_cards/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`.
|
60
57
|
sig { returns(T.nilable(String)) }
|
61
58
|
attr_reader :currency
|
62
59
|
# The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
|