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
@@ -7,22 +7,22 @@ module Stripe
|
|
7
7
|
attr_reader :line_items
|
8
8
|
class ListParams < Stripe::RequestParams
|
9
9
|
# Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links).
|
10
|
-
sig { returns(T::Boolean) }
|
10
|
+
sig { returns(T.nilable(T::Boolean)) }
|
11
11
|
attr_accessor :active
|
12
12
|
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
|
13
|
-
sig { returns(String) }
|
13
|
+
sig { returns(T.nilable(String)) }
|
14
14
|
attr_accessor :ending_before
|
15
15
|
# Specifies which fields in the response should be expanded.
|
16
|
-
sig { returns(T::Array[String]) }
|
16
|
+
sig { returns(T.nilable(T::Array[String])) }
|
17
17
|
attr_accessor :expand
|
18
18
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
19
|
-
sig { returns(Integer) }
|
19
|
+
sig { returns(T.nilable(Integer)) }
|
20
20
|
attr_accessor :limit
|
21
21
|
# 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.
|
22
|
-
sig { returns(String) }
|
22
|
+
sig { returns(T.nilable(String)) }
|
23
23
|
attr_accessor :starting_after
|
24
24
|
sig {
|
25
|
-
params(active: T::Boolean, ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String).void
|
25
|
+
params(active: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
|
26
26
|
}
|
27
27
|
def initialize(
|
28
28
|
active: nil,
|
@@ -36,9 +36,9 @@ module Stripe
|
|
36
36
|
class AfterCompletion < Stripe::RequestParams
|
37
37
|
class HostedConfirmation < Stripe::RequestParams
|
38
38
|
# A custom message to display to the customer after the purchase is complete.
|
39
|
-
sig { returns(String) }
|
39
|
+
sig { returns(T.nilable(String)) }
|
40
40
|
attr_accessor :custom_message
|
41
|
-
sig { params(custom_message: String).void }
|
41
|
+
sig { params(custom_message: T.nilable(String)).void }
|
42
42
|
def initialize(custom_message: nil); end
|
43
43
|
end
|
44
44
|
class Redirect < Stripe::RequestParams
|
@@ -50,29 +50,31 @@ module Stripe
|
|
50
50
|
end
|
51
51
|
# Configuration when `type=hosted_confirmation`.
|
52
52
|
sig {
|
53
|
-
returns(::Stripe::PaymentLinkService::CreateParams::AfterCompletion::HostedConfirmation)
|
53
|
+
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion::HostedConfirmation))
|
54
54
|
}
|
55
55
|
attr_accessor :hosted_confirmation
|
56
56
|
# Configuration when `type=redirect`.
|
57
|
-
sig {
|
57
|
+
sig {
|
58
|
+
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion::Redirect))
|
59
|
+
}
|
58
60
|
attr_accessor :redirect
|
59
61
|
# The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.
|
60
62
|
sig { returns(String) }
|
61
63
|
attr_accessor :type
|
62
64
|
sig {
|
63
|
-
params(hosted_confirmation: ::Stripe::PaymentLinkService::CreateParams::AfterCompletion::HostedConfirmation, redirect: ::Stripe::PaymentLinkService::CreateParams::AfterCompletion::Redirect, type: String).void
|
65
|
+
params(hosted_confirmation: T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion::HostedConfirmation), redirect: T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion::Redirect), type: String).void
|
64
66
|
}
|
65
67
|
def initialize(hosted_confirmation: nil, redirect: nil, type: nil); end
|
66
68
|
end
|
67
69
|
class AutomaticTax < Stripe::RequestParams
|
68
70
|
class Liability < Stripe::RequestParams
|
69
71
|
# The connected account being referenced when `type` is `account`.
|
70
|
-
sig { returns(String) }
|
72
|
+
sig { returns(T.nilable(String)) }
|
71
73
|
attr_accessor :account
|
72
74
|
# Type of the account referenced in the request.
|
73
75
|
sig { returns(String) }
|
74
76
|
attr_accessor :type
|
75
|
-
sig { params(account: String, type: String).void }
|
77
|
+
sig { params(account: T.nilable(String), type: String).void }
|
76
78
|
def initialize(account: nil, type: nil); end
|
77
79
|
end
|
78
80
|
# Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
|
@@ -81,10 +83,12 @@ module Stripe
|
|
81
83
|
sig { returns(T::Boolean) }
|
82
84
|
attr_accessor :enabled
|
83
85
|
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
|
84
|
-
sig {
|
86
|
+
sig {
|
87
|
+
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::AutomaticTax::Liability))
|
88
|
+
}
|
85
89
|
attr_accessor :liability
|
86
90
|
sig {
|
87
|
-
params(enabled: T::Boolean, liability: ::Stripe::PaymentLinkService::CreateParams::AutomaticTax::Liability).void
|
91
|
+
params(enabled: T::Boolean, liability: T.nilable(::Stripe::PaymentLinkService::CreateParams::AutomaticTax::Liability)).void
|
88
92
|
}
|
89
93
|
def initialize(enabled: nil, liability: nil); end
|
90
94
|
end
|
@@ -99,20 +103,20 @@ module Stripe
|
|
99
103
|
end
|
100
104
|
# Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.
|
101
105
|
sig {
|
102
|
-
returns(::Stripe::PaymentLinkService::CreateParams::ConsentCollection::PaymentMethodReuseAgreement)
|
106
|
+
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::ConsentCollection::PaymentMethodReuseAgreement))
|
103
107
|
}
|
104
108
|
attr_accessor :payment_method_reuse_agreement
|
105
109
|
# If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
|
106
110
|
# Session will determine whether to display an option to opt into promotional communication
|
107
111
|
# from the merchant depending on the customer's locale. Only available to US merchants.
|
108
|
-
sig { returns(String) }
|
112
|
+
sig { returns(T.nilable(String)) }
|
109
113
|
attr_accessor :promotions
|
110
114
|
# If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.
|
111
115
|
# There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).
|
112
|
-
sig { returns(String) }
|
116
|
+
sig { returns(T.nilable(String)) }
|
113
117
|
attr_accessor :terms_of_service
|
114
118
|
sig {
|
115
|
-
params(payment_method_reuse_agreement: ::Stripe::PaymentLinkService::CreateParams::ConsentCollection::PaymentMethodReuseAgreement, promotions: String, terms_of_service: String).void
|
119
|
+
params(payment_method_reuse_agreement: T.nilable(::Stripe::PaymentLinkService::CreateParams::ConsentCollection::PaymentMethodReuseAgreement), promotions: T.nilable(String), terms_of_service: T.nilable(String)).void
|
116
120
|
}
|
117
121
|
def initialize(
|
118
122
|
payment_method_reuse_agreement: nil,
|
@@ -132,15 +136,18 @@ module Stripe
|
|
132
136
|
sig { params(label: String, value: String).void }
|
133
137
|
def initialize(label: nil, value: nil); end
|
134
138
|
end
|
139
|
+
# The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
|
140
|
+
sig { returns(T.nilable(String)) }
|
141
|
+
attr_accessor :default_value
|
135
142
|
# The options available for the customer to select. Up to 200 options allowed.
|
136
143
|
sig {
|
137
144
|
returns(T::Array[::Stripe::PaymentLinkService::CreateParams::CustomField::Dropdown::Option])
|
138
145
|
}
|
139
146
|
attr_accessor :options
|
140
147
|
sig {
|
141
|
-
params(options: T::Array[::Stripe::PaymentLinkService::CreateParams::CustomField::Dropdown::Option]).void
|
148
|
+
params(default_value: T.nilable(String), options: T::Array[::Stripe::PaymentLinkService::CreateParams::CustomField::Dropdown::Option]).void
|
142
149
|
}
|
143
|
-
def initialize(options: nil); end
|
150
|
+
def initialize(default_value: nil, options: nil); end
|
144
151
|
end
|
145
152
|
class Label < Stripe::RequestParams
|
146
153
|
# Custom text for the label, displayed to the customer. Up to 50 characters.
|
@@ -153,27 +160,39 @@ module Stripe
|
|
153
160
|
def initialize(custom: nil, type: nil); end
|
154
161
|
end
|
155
162
|
class Numeric < Stripe::RequestParams
|
163
|
+
# The value that will pre-fill the field on the payment page.
|
164
|
+
sig { returns(T.nilable(String)) }
|
165
|
+
attr_accessor :default_value
|
156
166
|
# The maximum character length constraint for the customer's input.
|
157
|
-
sig { returns(Integer) }
|
167
|
+
sig { returns(T.nilable(Integer)) }
|
158
168
|
attr_accessor :maximum_length
|
159
169
|
# The minimum character length requirement for the customer's input.
|
160
|
-
sig { returns(Integer) }
|
170
|
+
sig { returns(T.nilable(Integer)) }
|
161
171
|
attr_accessor :minimum_length
|
162
|
-
sig {
|
163
|
-
|
172
|
+
sig {
|
173
|
+
params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
|
174
|
+
}
|
175
|
+
def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
|
164
176
|
end
|
165
177
|
class Text < Stripe::RequestParams
|
178
|
+
# The value that will pre-fill the field on the payment page.
|
179
|
+
sig { returns(T.nilable(String)) }
|
180
|
+
attr_accessor :default_value
|
166
181
|
# The maximum character length constraint for the customer's input.
|
167
|
-
sig { returns(Integer) }
|
182
|
+
sig { returns(T.nilable(Integer)) }
|
168
183
|
attr_accessor :maximum_length
|
169
184
|
# The minimum character length requirement for the customer's input.
|
170
|
-
sig { returns(Integer) }
|
185
|
+
sig { returns(T.nilable(Integer)) }
|
171
186
|
attr_accessor :minimum_length
|
172
|
-
sig {
|
173
|
-
|
187
|
+
sig {
|
188
|
+
params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
|
189
|
+
}
|
190
|
+
def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
|
174
191
|
end
|
175
192
|
# Configuration for `type=dropdown` fields.
|
176
|
-
sig {
|
193
|
+
sig {
|
194
|
+
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Dropdown))
|
195
|
+
}
|
177
196
|
attr_accessor :dropdown
|
178
197
|
# String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
|
179
198
|
sig { returns(String) }
|
@@ -182,19 +201,19 @@ module Stripe
|
|
182
201
|
sig { returns(::Stripe::PaymentLinkService::CreateParams::CustomField::Label) }
|
183
202
|
attr_accessor :label
|
184
203
|
# Configuration for `type=numeric` fields.
|
185
|
-
sig { returns(::Stripe::PaymentLinkService::CreateParams::CustomField::Numeric) }
|
204
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Numeric)) }
|
186
205
|
attr_accessor :numeric
|
187
206
|
# Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
|
188
|
-
sig { returns(T::Boolean) }
|
207
|
+
sig { returns(T.nilable(T::Boolean)) }
|
189
208
|
attr_accessor :optional
|
190
209
|
# Configuration for `type=text` fields.
|
191
|
-
sig { returns(::Stripe::PaymentLinkService::CreateParams::CustomField::Text) }
|
210
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Text)) }
|
192
211
|
attr_accessor :text
|
193
212
|
# The type of the field.
|
194
213
|
sig { returns(String) }
|
195
214
|
attr_accessor :type
|
196
215
|
sig {
|
197
|
-
params(dropdown: ::Stripe::PaymentLinkService::CreateParams::CustomField::Dropdown, key: String, label: ::Stripe::PaymentLinkService::CreateParams::CustomField::Label, numeric: ::Stripe::PaymentLinkService::CreateParams::CustomField::Numeric, optional: T::Boolean, text: ::Stripe::PaymentLinkService::CreateParams::CustomField::Text, type: String).void
|
216
|
+
params(dropdown: T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Dropdown), key: String, label: ::Stripe::PaymentLinkService::CreateParams::CustomField::Label, numeric: T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Numeric), optional: T.nilable(T::Boolean), text: T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomField::Text), type: String).void
|
198
217
|
}
|
199
218
|
def initialize(
|
200
219
|
dropdown: nil,
|
@@ -237,24 +256,26 @@ module Stripe
|
|
237
256
|
end
|
238
257
|
# Custom text that should be displayed after the payment confirmation button.
|
239
258
|
sig {
|
240
|
-
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomText::AfterSubmit))
|
259
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::AfterSubmit))))
|
241
260
|
}
|
242
261
|
attr_accessor :after_submit
|
243
262
|
# Custom text that should be displayed alongside shipping address collection.
|
244
263
|
sig {
|
245
|
-
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomText::ShippingAddress))
|
264
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::ShippingAddress))))
|
246
265
|
}
|
247
266
|
attr_accessor :shipping_address
|
248
267
|
# Custom text that should be displayed alongside the payment confirmation button.
|
249
|
-
sig {
|
268
|
+
sig {
|
269
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::Submit))))
|
270
|
+
}
|
250
271
|
attr_accessor :submit
|
251
272
|
# Custom text that should be displayed in place of the default terms of service agreement text.
|
252
273
|
sig {
|
253
|
-
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomText::TermsOfServiceAcceptance))
|
274
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::TermsOfServiceAcceptance))))
|
254
275
|
}
|
255
276
|
attr_accessor :terms_of_service_acceptance
|
256
277
|
sig {
|
257
|
-
params(after_submit: T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomText::AfterSubmit), shipping_address: T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomText::ShippingAddress), submit: T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomText::Submit), terms_of_service_acceptance: T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomText::TermsOfServiceAcceptance)).void
|
278
|
+
params(after_submit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::AfterSubmit))), shipping_address: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::ShippingAddress))), submit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::Submit))), terms_of_service_acceptance: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::CustomText::TermsOfServiceAcceptance)))).void
|
258
279
|
}
|
259
280
|
def initialize(
|
260
281
|
after_submit: nil,
|
@@ -277,50 +298,50 @@ module Stripe
|
|
277
298
|
end
|
278
299
|
class Issuer < Stripe::RequestParams
|
279
300
|
# The connected account being referenced when `type` is `account`.
|
280
|
-
sig { returns(String) }
|
301
|
+
sig { returns(T.nilable(String)) }
|
281
302
|
attr_accessor :account
|
282
303
|
# Type of the account referenced in the request.
|
283
304
|
sig { returns(String) }
|
284
305
|
attr_accessor :type
|
285
|
-
sig { params(account: String, type: String).void }
|
306
|
+
sig { params(account: T.nilable(String), type: String).void }
|
286
307
|
def initialize(account: nil, type: nil); end
|
287
308
|
end
|
288
309
|
class RenderingOptions < Stripe::RequestParams
|
289
310
|
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
|
290
|
-
sig { returns(T.nilable(String)) }
|
311
|
+
sig { returns(T.nilable(T.nilable(T.any(String, String)))) }
|
291
312
|
attr_accessor :amount_tax_display
|
292
|
-
sig { params(amount_tax_display: T.nilable(String)).void }
|
313
|
+
sig { params(amount_tax_display: T.nilable(T.nilable(T.any(String, String)))).void }
|
293
314
|
def initialize(amount_tax_display: nil); end
|
294
315
|
end
|
295
316
|
# The account tax IDs associated with the invoice.
|
296
|
-
sig { returns(T.nilable(T::Array[String])) }
|
317
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
|
297
318
|
attr_accessor :account_tax_ids
|
298
319
|
# Default custom fields to be displayed on invoices for this customer.
|
299
320
|
sig {
|
300
|
-
returns(T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::CustomField]))
|
321
|
+
returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::CustomField]))))
|
301
322
|
}
|
302
323
|
attr_accessor :custom_fields
|
303
324
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
304
|
-
sig { returns(String) }
|
325
|
+
sig { returns(T.nilable(String)) }
|
305
326
|
attr_accessor :description
|
306
327
|
# Default footer to be displayed on invoices for this customer.
|
307
|
-
sig { returns(String) }
|
328
|
+
sig { returns(T.nilable(String)) }
|
308
329
|
attr_accessor :footer
|
309
330
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
310
331
|
sig {
|
311
|
-
returns(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::Issuer)
|
332
|
+
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::Issuer))
|
312
333
|
}
|
313
334
|
attr_accessor :issuer
|
314
335
|
# 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`.
|
315
|
-
sig { returns(T.nilable(T::Hash[String, String])) }
|
336
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
|
316
337
|
attr_accessor :metadata
|
317
338
|
# Default options for invoice PDF rendering for this customer.
|
318
339
|
sig {
|
319
|
-
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions))
|
340
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions))))
|
320
341
|
}
|
321
342
|
attr_accessor :rendering_options
|
322
343
|
sig {
|
323
|
-
params(account_tax_ids: T.nilable(T::Array[String]), custom_fields: T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::CustomField]), description: String, footer: String, issuer: ::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::Issuer, metadata: T.nilable(T::Hash[String, String]), rendering_options: T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions)).void
|
344
|
+
params(account_tax_ids: T.nilable(T.nilable(T.any(String, T::Array[String]))), custom_fields: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::CustomField]))), description: T.nilable(String), footer: T.nilable(String), issuer: T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::Issuer), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), rendering_options: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData::RenderingOptions)))).void
|
324
345
|
}
|
325
346
|
def initialize(
|
326
347
|
account_tax_ids: nil,
|
@@ -336,10 +357,12 @@ module Stripe
|
|
336
357
|
sig { returns(T::Boolean) }
|
337
358
|
attr_accessor :enabled
|
338
359
|
# Invoice PDF configuration.
|
339
|
-
sig {
|
360
|
+
sig {
|
361
|
+
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData))
|
362
|
+
}
|
340
363
|
attr_accessor :invoice_data
|
341
364
|
sig {
|
342
|
-
params(enabled: T::Boolean, invoice_data: ::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData).void
|
365
|
+
params(enabled: T::Boolean, invoice_data: T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation::InvoiceData)).void
|
343
366
|
}
|
344
367
|
def initialize(enabled: nil, invoice_data: nil); end
|
345
368
|
end
|
@@ -349,16 +372,20 @@ module Stripe
|
|
349
372
|
sig { returns(T::Boolean) }
|
350
373
|
attr_accessor :enabled
|
351
374
|
# The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999.
|
352
|
-
sig { returns(Integer) }
|
375
|
+
sig { returns(T.nilable(Integer)) }
|
353
376
|
attr_accessor :maximum
|
354
377
|
# The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.
|
355
|
-
sig { returns(Integer) }
|
378
|
+
sig { returns(T.nilable(Integer)) }
|
356
379
|
attr_accessor :minimum
|
357
|
-
sig {
|
380
|
+
sig {
|
381
|
+
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
|
382
|
+
}
|
358
383
|
def initialize(enabled: nil, maximum: nil, minimum: nil); end
|
359
384
|
end
|
360
385
|
# When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.
|
361
|
-
sig {
|
386
|
+
sig {
|
387
|
+
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::LineItem::AdjustableQuantity))
|
388
|
+
}
|
362
389
|
attr_accessor :adjustable_quantity
|
363
390
|
# The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.
|
364
391
|
sig { returns(String) }
|
@@ -367,19 +394,51 @@ module Stripe
|
|
367
394
|
sig { returns(Integer) }
|
368
395
|
attr_accessor :quantity
|
369
396
|
sig {
|
370
|
-
params(adjustable_quantity: ::Stripe::PaymentLinkService::CreateParams::LineItem::AdjustableQuantity, price: String, quantity: Integer).void
|
397
|
+
params(adjustable_quantity: T.nilable(::Stripe::PaymentLinkService::CreateParams::LineItem::AdjustableQuantity), price: String, quantity: Integer).void
|
398
|
+
}
|
399
|
+
def initialize(adjustable_quantity: nil, price: nil, quantity: nil); end
|
400
|
+
end
|
401
|
+
class OptionalItem < Stripe::RequestParams
|
402
|
+
class AdjustableQuantity < Stripe::RequestParams
|
403
|
+
# Set to true if the quantity can be adjusted to any non-negative integer.
|
404
|
+
sig { returns(T::Boolean) }
|
405
|
+
attr_accessor :enabled
|
406
|
+
# The maximum quantity of this item the customer can purchase. By default this value is 99.
|
407
|
+
sig { returns(T.nilable(Integer)) }
|
408
|
+
attr_accessor :maximum
|
409
|
+
# The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.
|
410
|
+
sig { returns(T.nilable(Integer)) }
|
411
|
+
attr_accessor :minimum
|
412
|
+
sig {
|
413
|
+
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
|
414
|
+
}
|
415
|
+
def initialize(enabled: nil, maximum: nil, minimum: nil); end
|
416
|
+
end
|
417
|
+
# When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order.
|
418
|
+
sig {
|
419
|
+
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::OptionalItem::AdjustableQuantity))
|
420
|
+
}
|
421
|
+
attr_accessor :adjustable_quantity
|
422
|
+
# The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.
|
423
|
+
sig { returns(String) }
|
424
|
+
attr_accessor :price
|
425
|
+
# The initial quantity of the line item created when a customer chooses to add this optional item to their order.
|
426
|
+
sig { returns(Integer) }
|
427
|
+
attr_accessor :quantity
|
428
|
+
sig {
|
429
|
+
params(adjustable_quantity: T.nilable(::Stripe::PaymentLinkService::CreateParams::OptionalItem::AdjustableQuantity), price: String, quantity: Integer).void
|
371
430
|
}
|
372
431
|
def initialize(adjustable_quantity: nil, price: nil, quantity: nil); end
|
373
432
|
end
|
374
433
|
class PaymentIntentData < Stripe::RequestParams
|
375
434
|
# Controls when the funds will be captured from the customer's account.
|
376
|
-
sig { returns(String) }
|
435
|
+
sig { returns(T.nilable(String)) }
|
377
436
|
attr_accessor :capture_method
|
378
437
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
379
|
-
sig { returns(String) }
|
438
|
+
sig { returns(T.nilable(String)) }
|
380
439
|
attr_accessor :description
|
381
440
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
382
|
-
sig { returns(T::Hash[String, String]) }
|
441
|
+
sig { returns(T.nilable(T::Hash[String, String])) }
|
383
442
|
attr_accessor :metadata
|
384
443
|
# Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session.
|
385
444
|
#
|
@@ -392,21 +451,21 @@ module Stripe
|
|
392
451
|
# If Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session's PaymentIntent.
|
393
452
|
#
|
394
453
|
# When processing card payments, Checkout also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
|
395
|
-
sig { returns(String) }
|
454
|
+
sig { returns(T.nilable(String)) }
|
396
455
|
attr_accessor :setup_future_usage
|
397
456
|
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
|
398
457
|
#
|
399
458
|
# Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
|
400
|
-
sig { returns(String) }
|
459
|
+
sig { returns(T.nilable(String)) }
|
401
460
|
attr_accessor :statement_descriptor
|
402
461
|
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
|
403
|
-
sig { returns(String) }
|
462
|
+
sig { returns(T.nilable(String)) }
|
404
463
|
attr_accessor :statement_descriptor_suffix
|
405
464
|
# A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
|
406
|
-
sig { returns(String) }
|
465
|
+
sig { returns(T.nilable(String)) }
|
407
466
|
attr_accessor :transfer_group
|
408
467
|
sig {
|
409
|
-
params(capture_method: String, description: String, metadata: T::Hash[String, String], setup_future_usage: String, statement_descriptor: String, statement_descriptor_suffix: String, transfer_group: String).void
|
468
|
+
params(capture_method: T.nilable(String), description: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), setup_future_usage: T.nilable(String), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_group: T.nilable(String)).void
|
410
469
|
}
|
411
470
|
def initialize(
|
412
471
|
capture_method: nil,
|
@@ -451,30 +510,30 @@ module Stripe
|
|
451
510
|
end
|
452
511
|
class ShippingOption < Stripe::RequestParams
|
453
512
|
# The ID of the Shipping Rate to use for this shipping option.
|
454
|
-
sig { returns(String) }
|
513
|
+
sig { returns(T.nilable(String)) }
|
455
514
|
attr_accessor :shipping_rate
|
456
|
-
sig { params(shipping_rate: String).void }
|
515
|
+
sig { params(shipping_rate: T.nilable(String)).void }
|
457
516
|
def initialize(shipping_rate: nil); end
|
458
517
|
end
|
459
518
|
class SubscriptionData < Stripe::RequestParams
|
460
519
|
class InvoiceSettings < Stripe::RequestParams
|
461
520
|
class Issuer < Stripe::RequestParams
|
462
521
|
# The connected account being referenced when `type` is `account`.
|
463
|
-
sig { returns(String) }
|
522
|
+
sig { returns(T.nilable(String)) }
|
464
523
|
attr_accessor :account
|
465
524
|
# Type of the account referenced in the request.
|
466
525
|
sig { returns(String) }
|
467
526
|
attr_accessor :type
|
468
|
-
sig { params(account: String, type: String).void }
|
527
|
+
sig { params(account: T.nilable(String), type: String).void }
|
469
528
|
def initialize(account: nil, type: nil); end
|
470
529
|
end
|
471
530
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
472
531
|
sig {
|
473
|
-
returns(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::InvoiceSettings::Issuer)
|
532
|
+
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::InvoiceSettings::Issuer))
|
474
533
|
}
|
475
534
|
attr_accessor :issuer
|
476
535
|
sig {
|
477
|
-
params(issuer: ::Stripe::PaymentLinkService::CreateParams::SubscriptionData::InvoiceSettings::Issuer).void
|
536
|
+
params(issuer: T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::InvoiceSettings::Issuer)).void
|
478
537
|
}
|
479
538
|
def initialize(issuer: nil); end
|
480
539
|
end
|
@@ -497,24 +556,26 @@ module Stripe
|
|
497
556
|
def initialize(end_behavior: nil); end
|
498
557
|
end
|
499
558
|
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
|
500
|
-
sig { returns(String) }
|
559
|
+
sig { returns(T.nilable(String)) }
|
501
560
|
attr_accessor :description
|
502
561
|
# All invoices will be billed using the specified settings.
|
503
562
|
sig {
|
504
|
-
returns(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::InvoiceSettings)
|
563
|
+
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::InvoiceSettings))
|
505
564
|
}
|
506
565
|
attr_accessor :invoice_settings
|
507
566
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
508
|
-
sig { returns(T::Hash[String, String]) }
|
567
|
+
sig { returns(T.nilable(T::Hash[String, String])) }
|
509
568
|
attr_accessor :metadata
|
510
569
|
# Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
|
511
|
-
sig { returns(Integer) }
|
570
|
+
sig { returns(T.nilable(Integer)) }
|
512
571
|
attr_accessor :trial_period_days
|
513
572
|
# Settings related to subscription trials.
|
514
|
-
sig {
|
573
|
+
sig {
|
574
|
+
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::TrialSettings))
|
575
|
+
}
|
515
576
|
attr_accessor :trial_settings
|
516
577
|
sig {
|
517
|
-
params(description: String, invoice_settings: ::Stripe::PaymentLinkService::CreateParams::SubscriptionData::InvoiceSettings, metadata: T::Hash[String, String], trial_period_days: Integer, trial_settings: ::Stripe::PaymentLinkService::CreateParams::SubscriptionData::TrialSettings).void
|
578
|
+
params(description: T.nilable(String), invoice_settings: T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::InvoiceSettings), metadata: T.nilable(T::Hash[String, String]), trial_period_days: T.nilable(Integer), trial_settings: T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData::TrialSettings)).void
|
518
579
|
}
|
519
580
|
def initialize(
|
520
581
|
description: nil,
|
@@ -529,14 +590,14 @@ module Stripe
|
|
529
590
|
sig { returns(T::Boolean) }
|
530
591
|
attr_accessor :enabled
|
531
592
|
# Describes whether a tax ID is required during checkout. Defaults to `never`.
|
532
|
-
sig { returns(String) }
|
593
|
+
sig { returns(T.nilable(String)) }
|
533
594
|
attr_accessor :required
|
534
|
-
sig { params(enabled: T::Boolean, required: String).void }
|
595
|
+
sig { params(enabled: T::Boolean, required: T.nilable(String)).void }
|
535
596
|
def initialize(enabled: nil, required: nil); end
|
536
597
|
end
|
537
598
|
class TransferData < Stripe::RequestParams
|
538
599
|
# The amount that will be transferred automatically when a charge succeeds.
|
539
|
-
sig { returns(Integer) }
|
600
|
+
sig { returns(T.nilable(Integer)) }
|
540
601
|
attr_accessor :amount
|
541
602
|
# If specified, successful charges will be attributed to the destination
|
542
603
|
# account for tax reporting, and the funds from charges will be transferred
|
@@ -544,101 +605,110 @@ module Stripe
|
|
544
605
|
# returned on the successful charge's `transfer` field.
|
545
606
|
sig { returns(String) }
|
546
607
|
attr_accessor :destination
|
547
|
-
sig { params(amount: Integer, destination: String).void }
|
608
|
+
sig { params(amount: T.nilable(Integer), destination: String).void }
|
548
609
|
def initialize(amount: nil, destination: nil); end
|
549
610
|
end
|
550
611
|
# Behavior after the purchase is complete.
|
551
|
-
sig { returns(::Stripe::PaymentLinkService::CreateParams::AfterCompletion) }
|
612
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion)) }
|
552
613
|
attr_accessor :after_completion
|
553
614
|
# Enables user redeemable promotion codes.
|
554
|
-
sig { returns(T::Boolean) }
|
615
|
+
sig { returns(T.nilable(T::Boolean)) }
|
555
616
|
attr_accessor :allow_promotion_codes
|
556
617
|
# The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Can only be applied when there are no line items with recurring prices.
|
557
|
-
sig { returns(Integer) }
|
618
|
+
sig { returns(T.nilable(Integer)) }
|
558
619
|
attr_accessor :application_fee_amount
|
559
620
|
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field.
|
560
|
-
sig { returns(Float) }
|
621
|
+
sig { returns(T.nilable(Float)) }
|
561
622
|
attr_accessor :application_fee_percent
|
562
623
|
# Configuration for automatic tax collection.
|
563
|
-
sig { returns(::Stripe::PaymentLinkService::CreateParams::AutomaticTax) }
|
624
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::AutomaticTax)) }
|
564
625
|
attr_accessor :automatic_tax
|
565
626
|
# Configuration for collecting the customer's billing address. Defaults to `auto`.
|
566
|
-
sig { returns(String) }
|
627
|
+
sig { returns(T.nilable(String)) }
|
567
628
|
attr_accessor :billing_address_collection
|
568
629
|
# Configure fields to gather active consent from customers.
|
569
|
-
sig { returns(::Stripe::PaymentLinkService::CreateParams::ConsentCollection) }
|
630
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::ConsentCollection)) }
|
570
631
|
attr_accessor :consent_collection
|
571
632
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies) and supported by each line item's price.
|
572
|
-
sig { returns(String) }
|
633
|
+
sig { returns(T.nilable(String)) }
|
573
634
|
attr_accessor :currency
|
574
635
|
# Collect additional information from your customer using custom fields. Up to 3 fields are supported.
|
575
|
-
sig { returns(T::Array[::Stripe::PaymentLinkService::CreateParams::CustomField]) }
|
636
|
+
sig { returns(T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::CustomField])) }
|
576
637
|
attr_accessor :custom_fields
|
577
638
|
# Display additional text for your customers using custom text.
|
578
|
-
sig { returns(::Stripe::PaymentLinkService::CreateParams::CustomText) }
|
639
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomText)) }
|
579
640
|
attr_accessor :custom_text
|
580
641
|
# Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).
|
581
|
-
sig { returns(String) }
|
642
|
+
sig { returns(T.nilable(String)) }
|
582
643
|
attr_accessor :customer_creation
|
583
644
|
# Specifies which fields in the response should be expanded.
|
584
|
-
sig { returns(T::Array[String]) }
|
645
|
+
sig { returns(T.nilable(T::Array[String])) }
|
585
646
|
attr_accessor :expand
|
586
647
|
# The custom message to be displayed to a customer when a payment link is no longer active.
|
587
|
-
sig { returns(String) }
|
648
|
+
sig { returns(T.nilable(String)) }
|
588
649
|
attr_accessor :inactive_message
|
589
650
|
# Generate a post-purchase Invoice for one-time payments.
|
590
|
-
sig { returns(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation) }
|
651
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation)) }
|
591
652
|
attr_accessor :invoice_creation
|
592
653
|
# The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.
|
593
654
|
sig { returns(T::Array[::Stripe::PaymentLinkService::CreateParams::LineItem]) }
|
594
655
|
attr_accessor :line_items
|
595
656
|
# 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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.
|
596
|
-
sig { returns(T::Hash[String, String]) }
|
657
|
+
sig { returns(T.nilable(T::Hash[String, String])) }
|
597
658
|
attr_accessor :metadata
|
598
659
|
# The account on behalf of which to charge.
|
599
|
-
sig { returns(String) }
|
660
|
+
sig { returns(T.nilable(String)) }
|
600
661
|
attr_accessor :on_behalf_of
|
662
|
+
# A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
|
663
|
+
# There is a maximum of 10 optional items allowed on a payment link, and the existing limits on the number of line items allowed on a payment link apply to the combined number of line items and optional items.
|
664
|
+
# There is a maximum of 20 combined line items and optional items.
|
665
|
+
sig { returns(T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::OptionalItem])) }
|
666
|
+
attr_accessor :optional_items
|
601
667
|
# A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
|
602
|
-
sig { returns(::Stripe::PaymentLinkService::CreateParams::PaymentIntentData) }
|
668
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::PaymentIntentData)) }
|
603
669
|
attr_accessor :payment_intent_data
|
604
670
|
# Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.
|
605
671
|
#
|
606
672
|
# Can only be set in `subscription` mode. Defaults to `always`.
|
607
673
|
#
|
608
674
|
# If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).
|
609
|
-
sig { returns(String) }
|
675
|
+
sig { returns(T.nilable(String)) }
|
610
676
|
attr_accessor :payment_method_collection
|
611
677
|
# The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)).
|
612
|
-
sig { returns(T::Array[String]) }
|
678
|
+
sig { returns(T.nilable(T::Array[String])) }
|
613
679
|
attr_accessor :payment_method_types
|
614
680
|
# Controls phone number collection settings during checkout.
|
615
681
|
#
|
616
682
|
# We recommend that you review your privacy policy and check with your legal contacts.
|
617
|
-
sig { returns(::Stripe::PaymentLinkService::CreateParams::PhoneNumberCollection) }
|
683
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::PhoneNumberCollection)) }
|
618
684
|
attr_accessor :phone_number_collection
|
619
685
|
# Settings that restrict the usage of a payment link.
|
620
|
-
sig { returns(::Stripe::PaymentLinkService::CreateParams::Restrictions) }
|
686
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::Restrictions)) }
|
621
687
|
attr_accessor :restrictions
|
622
688
|
# Configuration for collecting the customer's shipping address.
|
623
|
-
sig {
|
689
|
+
sig {
|
690
|
+
returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::ShippingAddressCollection))
|
691
|
+
}
|
624
692
|
attr_accessor :shipping_address_collection
|
625
693
|
# The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.
|
626
|
-
sig {
|
694
|
+
sig {
|
695
|
+
returns(T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::ShippingOption]))
|
696
|
+
}
|
627
697
|
attr_accessor :shipping_options
|
628
698
|
# Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).
|
629
|
-
sig { returns(String) }
|
699
|
+
sig { returns(T.nilable(String)) }
|
630
700
|
attr_accessor :submit_type
|
631
701
|
# When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.
|
632
|
-
sig { returns(::Stripe::PaymentLinkService::CreateParams::SubscriptionData) }
|
702
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData)) }
|
633
703
|
attr_accessor :subscription_data
|
634
704
|
# Controls tax ID collection during checkout.
|
635
|
-
sig { returns(::Stripe::PaymentLinkService::CreateParams::TaxIdCollection) }
|
705
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::TaxIdCollection)) }
|
636
706
|
attr_accessor :tax_id_collection
|
637
707
|
# The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
|
638
|
-
sig { returns(::Stripe::PaymentLinkService::CreateParams::TransferData) }
|
708
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::CreateParams::TransferData)) }
|
639
709
|
attr_accessor :transfer_data
|
640
710
|
sig {
|
641
|
-
params(after_completion: ::Stripe::PaymentLinkService::CreateParams::AfterCompletion, allow_promotion_codes: T::Boolean, application_fee_amount: Integer, application_fee_percent: Float, automatic_tax: ::Stripe::PaymentLinkService::CreateParams::AutomaticTax, billing_address_collection: String, consent_collection: ::Stripe::PaymentLinkService::CreateParams::ConsentCollection, currency: String, custom_fields: T::Array[::Stripe::PaymentLinkService::CreateParams::CustomField], custom_text: ::Stripe::PaymentLinkService::CreateParams::CustomText, customer_creation: String, expand: T::Array[String], inactive_message: String, invoice_creation: ::Stripe::PaymentLinkService::CreateParams::InvoiceCreation, line_items: T::Array[::Stripe::PaymentLinkService::CreateParams::LineItem], metadata: T::Hash[String, String], on_behalf_of: String, payment_intent_data: ::Stripe::PaymentLinkService::CreateParams::PaymentIntentData, payment_method_collection: String, payment_method_types: T::Array[String], phone_number_collection: ::Stripe::PaymentLinkService::CreateParams::PhoneNumberCollection, restrictions: ::Stripe::PaymentLinkService::CreateParams::Restrictions, shipping_address_collection: ::Stripe::PaymentLinkService::CreateParams::ShippingAddressCollection, shipping_options: T::Array[::Stripe::PaymentLinkService::CreateParams::ShippingOption], submit_type: String, subscription_data: ::Stripe::PaymentLinkService::CreateParams::SubscriptionData, tax_id_collection: ::Stripe::PaymentLinkService::CreateParams::TaxIdCollection, transfer_data: ::Stripe::PaymentLinkService::CreateParams::TransferData).void
|
711
|
+
params(after_completion: T.nilable(::Stripe::PaymentLinkService::CreateParams::AfterCompletion), allow_promotion_codes: T.nilable(T::Boolean), application_fee_amount: T.nilable(Integer), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::PaymentLinkService::CreateParams::AutomaticTax), billing_address_collection: T.nilable(String), consent_collection: T.nilable(::Stripe::PaymentLinkService::CreateParams::ConsentCollection), currency: T.nilable(String), custom_fields: T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::CustomField]), custom_text: T.nilable(::Stripe::PaymentLinkService::CreateParams::CustomText), customer_creation: T.nilable(String), expand: T.nilable(T::Array[String]), inactive_message: T.nilable(String), invoice_creation: T.nilable(::Stripe::PaymentLinkService::CreateParams::InvoiceCreation), line_items: T::Array[::Stripe::PaymentLinkService::CreateParams::LineItem], metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), optional_items: T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::OptionalItem]), payment_intent_data: T.nilable(::Stripe::PaymentLinkService::CreateParams::PaymentIntentData), payment_method_collection: T.nilable(String), payment_method_types: T.nilable(T::Array[String]), phone_number_collection: T.nilable(::Stripe::PaymentLinkService::CreateParams::PhoneNumberCollection), restrictions: T.nilable(::Stripe::PaymentLinkService::CreateParams::Restrictions), shipping_address_collection: T.nilable(::Stripe::PaymentLinkService::CreateParams::ShippingAddressCollection), shipping_options: T.nilable(T::Array[::Stripe::PaymentLinkService::CreateParams::ShippingOption]), submit_type: T.nilable(String), subscription_data: T.nilable(::Stripe::PaymentLinkService::CreateParams::SubscriptionData), tax_id_collection: T.nilable(::Stripe::PaymentLinkService::CreateParams::TaxIdCollection), transfer_data: T.nilable(::Stripe::PaymentLinkService::CreateParams::TransferData)).void
|
642
712
|
}
|
643
713
|
def initialize(
|
644
714
|
after_completion: nil,
|
@@ -658,6 +728,7 @@ module Stripe
|
|
658
728
|
line_items: nil,
|
659
729
|
metadata: nil,
|
660
730
|
on_behalf_of: nil,
|
731
|
+
optional_items: nil,
|
661
732
|
payment_intent_data: nil,
|
662
733
|
payment_method_collection: nil,
|
663
734
|
payment_method_types: nil,
|
@@ -673,18 +744,18 @@ module Stripe
|
|
673
744
|
end
|
674
745
|
class RetrieveParams < Stripe::RequestParams
|
675
746
|
# Specifies which fields in the response should be expanded.
|
676
|
-
sig { returns(T::Array[String]) }
|
747
|
+
sig { returns(T.nilable(T::Array[String])) }
|
677
748
|
attr_accessor :expand
|
678
|
-
sig { params(expand: T::Array[String]).void }
|
749
|
+
sig { params(expand: T.nilable(T::Array[String])).void }
|
679
750
|
def initialize(expand: nil); end
|
680
751
|
end
|
681
752
|
class UpdateParams < Stripe::RequestParams
|
682
753
|
class AfterCompletion < Stripe::RequestParams
|
683
754
|
class HostedConfirmation < Stripe::RequestParams
|
684
755
|
# A custom message to display to the customer after the purchase is complete.
|
685
|
-
sig { returns(String) }
|
756
|
+
sig { returns(T.nilable(String)) }
|
686
757
|
attr_accessor :custom_message
|
687
|
-
sig { params(custom_message: String).void }
|
758
|
+
sig { params(custom_message: T.nilable(String)).void }
|
688
759
|
def initialize(custom_message: nil); end
|
689
760
|
end
|
690
761
|
class Redirect < Stripe::RequestParams
|
@@ -696,29 +767,31 @@ module Stripe
|
|
696
767
|
end
|
697
768
|
# Configuration when `type=hosted_confirmation`.
|
698
769
|
sig {
|
699
|
-
returns(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion::HostedConfirmation)
|
770
|
+
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion::HostedConfirmation))
|
700
771
|
}
|
701
772
|
attr_accessor :hosted_confirmation
|
702
773
|
# Configuration when `type=redirect`.
|
703
|
-
sig {
|
774
|
+
sig {
|
775
|
+
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion::Redirect))
|
776
|
+
}
|
704
777
|
attr_accessor :redirect
|
705
778
|
# The specified behavior after the purchase is complete. Either `redirect` or `hosted_confirmation`.
|
706
779
|
sig { returns(String) }
|
707
780
|
attr_accessor :type
|
708
781
|
sig {
|
709
|
-
params(hosted_confirmation: ::Stripe::PaymentLinkService::UpdateParams::AfterCompletion::HostedConfirmation, redirect: ::Stripe::PaymentLinkService::UpdateParams::AfterCompletion::Redirect, type: String).void
|
782
|
+
params(hosted_confirmation: T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion::HostedConfirmation), redirect: T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion::Redirect), type: String).void
|
710
783
|
}
|
711
784
|
def initialize(hosted_confirmation: nil, redirect: nil, type: nil); end
|
712
785
|
end
|
713
786
|
class AutomaticTax < Stripe::RequestParams
|
714
787
|
class Liability < Stripe::RequestParams
|
715
788
|
# The connected account being referenced when `type` is `account`.
|
716
|
-
sig { returns(String) }
|
789
|
+
sig { returns(T.nilable(String)) }
|
717
790
|
attr_accessor :account
|
718
791
|
# Type of the account referenced in the request.
|
719
792
|
sig { returns(String) }
|
720
793
|
attr_accessor :type
|
721
|
-
sig { params(account: String, type: String).void }
|
794
|
+
sig { params(account: T.nilable(String), type: String).void }
|
722
795
|
def initialize(account: nil, type: nil); end
|
723
796
|
end
|
724
797
|
# Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
|
@@ -727,10 +800,12 @@ module Stripe
|
|
727
800
|
sig { returns(T::Boolean) }
|
728
801
|
attr_accessor :enabled
|
729
802
|
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
|
730
|
-
sig {
|
803
|
+
sig {
|
804
|
+
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::AutomaticTax::Liability))
|
805
|
+
}
|
731
806
|
attr_accessor :liability
|
732
807
|
sig {
|
733
|
-
params(enabled: T::Boolean, liability: ::Stripe::PaymentLinkService::UpdateParams::AutomaticTax::Liability).void
|
808
|
+
params(enabled: T::Boolean, liability: T.nilable(::Stripe::PaymentLinkService::UpdateParams::AutomaticTax::Liability)).void
|
734
809
|
}
|
735
810
|
def initialize(enabled: nil, liability: nil); end
|
736
811
|
end
|
@@ -746,15 +821,18 @@ module Stripe
|
|
746
821
|
sig { params(label: String, value: String).void }
|
747
822
|
def initialize(label: nil, value: nil); end
|
748
823
|
end
|
824
|
+
# The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
|
825
|
+
sig { returns(T.nilable(String)) }
|
826
|
+
attr_accessor :default_value
|
749
827
|
# The options available for the customer to select. Up to 200 options allowed.
|
750
828
|
sig {
|
751
829
|
returns(T::Array[::Stripe::PaymentLinkService::UpdateParams::CustomField::Dropdown::Option])
|
752
830
|
}
|
753
831
|
attr_accessor :options
|
754
832
|
sig {
|
755
|
-
params(options: T::Array[::Stripe::PaymentLinkService::UpdateParams::CustomField::Dropdown::Option]).void
|
833
|
+
params(default_value: T.nilable(String), options: T::Array[::Stripe::PaymentLinkService::UpdateParams::CustomField::Dropdown::Option]).void
|
756
834
|
}
|
757
|
-
def initialize(options: nil); end
|
835
|
+
def initialize(default_value: nil, options: nil); end
|
758
836
|
end
|
759
837
|
class Label < Stripe::RequestParams
|
760
838
|
# Custom text for the label, displayed to the customer. Up to 50 characters.
|
@@ -767,27 +845,39 @@ module Stripe
|
|
767
845
|
def initialize(custom: nil, type: nil); end
|
768
846
|
end
|
769
847
|
class Numeric < Stripe::RequestParams
|
848
|
+
# The value that will pre-fill the field on the payment page.
|
849
|
+
sig { returns(T.nilable(String)) }
|
850
|
+
attr_accessor :default_value
|
770
851
|
# The maximum character length constraint for the customer's input.
|
771
|
-
sig { returns(Integer) }
|
852
|
+
sig { returns(T.nilable(Integer)) }
|
772
853
|
attr_accessor :maximum_length
|
773
854
|
# The minimum character length requirement for the customer's input.
|
774
|
-
sig { returns(Integer) }
|
855
|
+
sig { returns(T.nilable(Integer)) }
|
775
856
|
attr_accessor :minimum_length
|
776
|
-
sig {
|
777
|
-
|
857
|
+
sig {
|
858
|
+
params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
|
859
|
+
}
|
860
|
+
def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
|
778
861
|
end
|
779
862
|
class Text < Stripe::RequestParams
|
863
|
+
# The value that will pre-fill the field on the payment page.
|
864
|
+
sig { returns(T.nilable(String)) }
|
865
|
+
attr_accessor :default_value
|
780
866
|
# The maximum character length constraint for the customer's input.
|
781
|
-
sig { returns(Integer) }
|
867
|
+
sig { returns(T.nilable(Integer)) }
|
782
868
|
attr_accessor :maximum_length
|
783
869
|
# The minimum character length requirement for the customer's input.
|
784
|
-
sig { returns(Integer) }
|
870
|
+
sig { returns(T.nilable(Integer)) }
|
785
871
|
attr_accessor :minimum_length
|
786
|
-
sig {
|
787
|
-
|
872
|
+
sig {
|
873
|
+
params(default_value: T.nilable(String), maximum_length: T.nilable(Integer), minimum_length: T.nilable(Integer)).void
|
874
|
+
}
|
875
|
+
def initialize(default_value: nil, maximum_length: nil, minimum_length: nil); end
|
788
876
|
end
|
789
877
|
# Configuration for `type=dropdown` fields.
|
790
|
-
sig {
|
878
|
+
sig {
|
879
|
+
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Dropdown))
|
880
|
+
}
|
791
881
|
attr_accessor :dropdown
|
792
882
|
# String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
|
793
883
|
sig { returns(String) }
|
@@ -796,19 +886,19 @@ module Stripe
|
|
796
886
|
sig { returns(::Stripe::PaymentLinkService::UpdateParams::CustomField::Label) }
|
797
887
|
attr_accessor :label
|
798
888
|
# Configuration for `type=numeric` fields.
|
799
|
-
sig { returns(::Stripe::PaymentLinkService::UpdateParams::CustomField::Numeric) }
|
889
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Numeric)) }
|
800
890
|
attr_accessor :numeric
|
801
891
|
# Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
|
802
|
-
sig { returns(T::Boolean) }
|
892
|
+
sig { returns(T.nilable(T::Boolean)) }
|
803
893
|
attr_accessor :optional
|
804
894
|
# Configuration for `type=text` fields.
|
805
|
-
sig { returns(::Stripe::PaymentLinkService::UpdateParams::CustomField::Text) }
|
895
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Text)) }
|
806
896
|
attr_accessor :text
|
807
897
|
# The type of the field.
|
808
898
|
sig { returns(String) }
|
809
899
|
attr_accessor :type
|
810
900
|
sig {
|
811
|
-
params(dropdown: ::Stripe::PaymentLinkService::UpdateParams::CustomField::Dropdown, key: String, label: ::Stripe::PaymentLinkService::UpdateParams::CustomField::Label, numeric: ::Stripe::PaymentLinkService::UpdateParams::CustomField::Numeric, optional: T::Boolean, text: ::Stripe::PaymentLinkService::UpdateParams::CustomField::Text, type: String).void
|
901
|
+
params(dropdown: T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Dropdown), key: String, label: ::Stripe::PaymentLinkService::UpdateParams::CustomField::Label, numeric: T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Numeric), optional: T.nilable(T::Boolean), text: T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomField::Text), type: String).void
|
812
902
|
}
|
813
903
|
def initialize(
|
814
904
|
dropdown: nil,
|
@@ -851,24 +941,26 @@ module Stripe
|
|
851
941
|
end
|
852
942
|
# Custom text that should be displayed after the payment confirmation button.
|
853
943
|
sig {
|
854
|
-
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomText::AfterSubmit))
|
944
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::AfterSubmit))))
|
855
945
|
}
|
856
946
|
attr_accessor :after_submit
|
857
947
|
# Custom text that should be displayed alongside shipping address collection.
|
858
948
|
sig {
|
859
|
-
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomText::ShippingAddress))
|
949
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::ShippingAddress))))
|
860
950
|
}
|
861
951
|
attr_accessor :shipping_address
|
862
952
|
# Custom text that should be displayed alongside the payment confirmation button.
|
863
|
-
sig {
|
953
|
+
sig {
|
954
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::Submit))))
|
955
|
+
}
|
864
956
|
attr_accessor :submit
|
865
957
|
# Custom text that should be displayed in place of the default terms of service agreement text.
|
866
958
|
sig {
|
867
|
-
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomText::TermsOfServiceAcceptance))
|
959
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::TermsOfServiceAcceptance))))
|
868
960
|
}
|
869
961
|
attr_accessor :terms_of_service_acceptance
|
870
962
|
sig {
|
871
|
-
params(after_submit: T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomText::AfterSubmit), shipping_address: T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomText::ShippingAddress), submit: T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomText::Submit), terms_of_service_acceptance: T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomText::TermsOfServiceAcceptance)).void
|
963
|
+
params(after_submit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::AfterSubmit))), shipping_address: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::ShippingAddress))), submit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::Submit))), terms_of_service_acceptance: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::CustomText::TermsOfServiceAcceptance)))).void
|
872
964
|
}
|
873
965
|
def initialize(
|
874
966
|
after_submit: nil,
|
@@ -891,50 +983,50 @@ module Stripe
|
|
891
983
|
end
|
892
984
|
class Issuer < Stripe::RequestParams
|
893
985
|
# The connected account being referenced when `type` is `account`.
|
894
|
-
sig { returns(String) }
|
986
|
+
sig { returns(T.nilable(String)) }
|
895
987
|
attr_accessor :account
|
896
988
|
# Type of the account referenced in the request.
|
897
989
|
sig { returns(String) }
|
898
990
|
attr_accessor :type
|
899
|
-
sig { params(account: String, type: String).void }
|
991
|
+
sig { params(account: T.nilable(String), type: String).void }
|
900
992
|
def initialize(account: nil, type: nil); end
|
901
993
|
end
|
902
994
|
class RenderingOptions < Stripe::RequestParams
|
903
995
|
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
|
904
|
-
sig { returns(T.nilable(String)) }
|
996
|
+
sig { returns(T.nilable(T.nilable(T.any(String, String)))) }
|
905
997
|
attr_accessor :amount_tax_display
|
906
|
-
sig { params(amount_tax_display: T.nilable(String)).void }
|
998
|
+
sig { params(amount_tax_display: T.nilable(T.nilable(T.any(String, String)))).void }
|
907
999
|
def initialize(amount_tax_display: nil); end
|
908
1000
|
end
|
909
1001
|
# The account tax IDs associated with the invoice.
|
910
|
-
sig { returns(T.nilable(T::Array[String])) }
|
1002
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
|
911
1003
|
attr_accessor :account_tax_ids
|
912
1004
|
# Default custom fields to be displayed on invoices for this customer.
|
913
1005
|
sig {
|
914
|
-
returns(T.nilable(T::Array[::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::CustomField]))
|
1006
|
+
returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::CustomField]))))
|
915
1007
|
}
|
916
1008
|
attr_accessor :custom_fields
|
917
1009
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
918
|
-
sig { returns(String) }
|
1010
|
+
sig { returns(T.nilable(String)) }
|
919
1011
|
attr_accessor :description
|
920
1012
|
# Default footer to be displayed on invoices for this customer.
|
921
|
-
sig { returns(String) }
|
1013
|
+
sig { returns(T.nilable(String)) }
|
922
1014
|
attr_accessor :footer
|
923
1015
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
924
1016
|
sig {
|
925
|
-
returns(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::Issuer)
|
1017
|
+
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::Issuer))
|
926
1018
|
}
|
927
1019
|
attr_accessor :issuer
|
928
1020
|
# 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`.
|
929
|
-
sig { returns(T.nilable(T::Hash[String, String])) }
|
1021
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
|
930
1022
|
attr_accessor :metadata
|
931
1023
|
# Default options for invoice PDF rendering for this customer.
|
932
1024
|
sig {
|
933
|
-
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::RenderingOptions))
|
1025
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::RenderingOptions))))
|
934
1026
|
}
|
935
1027
|
attr_accessor :rendering_options
|
936
1028
|
sig {
|
937
|
-
params(account_tax_ids: T.nilable(T::Array[String]), custom_fields: T.nilable(T::Array[::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::CustomField]), description: String, footer: String, issuer: ::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::Issuer, metadata: T.nilable(T::Hash[String, String]), rendering_options: T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::RenderingOptions)).void
|
1029
|
+
params(account_tax_ids: T.nilable(T.nilable(T.any(String, T::Array[String]))), custom_fields: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::CustomField]))), description: T.nilable(String), footer: T.nilable(String), issuer: T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::Issuer), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), rendering_options: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData::RenderingOptions)))).void
|
938
1030
|
}
|
939
1031
|
def initialize(
|
940
1032
|
account_tax_ids: nil,
|
@@ -950,10 +1042,12 @@ module Stripe
|
|
950
1042
|
sig { returns(T::Boolean) }
|
951
1043
|
attr_accessor :enabled
|
952
1044
|
# Invoice PDF configuration.
|
953
|
-
sig {
|
1045
|
+
sig {
|
1046
|
+
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData))
|
1047
|
+
}
|
954
1048
|
attr_accessor :invoice_data
|
955
1049
|
sig {
|
956
|
-
params(enabled: T::Boolean, invoice_data: ::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData).void
|
1050
|
+
params(enabled: T::Boolean, invoice_data: T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation::InvoiceData)).void
|
957
1051
|
}
|
958
1052
|
def initialize(enabled: nil, invoice_data: nil); end
|
959
1053
|
end
|
@@ -963,48 +1057,52 @@ module Stripe
|
|
963
1057
|
sig { returns(T::Boolean) }
|
964
1058
|
attr_accessor :enabled
|
965
1059
|
# The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999.
|
966
|
-
sig { returns(Integer) }
|
1060
|
+
sig { returns(T.nilable(Integer)) }
|
967
1061
|
attr_accessor :maximum
|
968
1062
|
# The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.
|
969
|
-
sig { returns(Integer) }
|
1063
|
+
sig { returns(T.nilable(Integer)) }
|
970
1064
|
attr_accessor :minimum
|
971
|
-
sig {
|
1065
|
+
sig {
|
1066
|
+
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer)).void
|
1067
|
+
}
|
972
1068
|
def initialize(enabled: nil, maximum: nil, minimum: nil); end
|
973
1069
|
end
|
974
1070
|
# When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.
|
975
|
-
sig {
|
1071
|
+
sig {
|
1072
|
+
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::LineItem::AdjustableQuantity))
|
1073
|
+
}
|
976
1074
|
attr_accessor :adjustable_quantity
|
977
1075
|
# The ID of an existing line item on the payment link.
|
978
1076
|
sig { returns(String) }
|
979
1077
|
attr_accessor :id
|
980
1078
|
# The quantity of the line item being purchased.
|
981
|
-
sig { returns(Integer) }
|
1079
|
+
sig { returns(T.nilable(Integer)) }
|
982
1080
|
attr_accessor :quantity
|
983
1081
|
sig {
|
984
|
-
params(adjustable_quantity: ::Stripe::PaymentLinkService::UpdateParams::LineItem::AdjustableQuantity, id: String, quantity: Integer).void
|
1082
|
+
params(adjustable_quantity: T.nilable(::Stripe::PaymentLinkService::UpdateParams::LineItem::AdjustableQuantity), id: String, quantity: T.nilable(Integer)).void
|
985
1083
|
}
|
986
1084
|
def initialize(adjustable_quantity: nil, id: nil, quantity: nil); end
|
987
1085
|
end
|
988
1086
|
class PaymentIntentData < Stripe::RequestParams
|
989
1087
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
990
|
-
sig { returns(T.nilable(String)) }
|
1088
|
+
sig { returns(T.nilable(T.nilable(String))) }
|
991
1089
|
attr_accessor :description
|
992
1090
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
993
|
-
sig { returns(T.nilable(T::Hash[String, String])) }
|
1091
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
|
994
1092
|
attr_accessor :metadata
|
995
1093
|
# Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
|
996
1094
|
#
|
997
1095
|
# Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
|
998
|
-
sig { returns(T.nilable(String)) }
|
1096
|
+
sig { returns(T.nilable(T.nilable(String))) }
|
999
1097
|
attr_accessor :statement_descriptor
|
1000
1098
|
# Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
|
1001
|
-
sig { returns(T.nilable(String)) }
|
1099
|
+
sig { returns(T.nilable(T.nilable(String))) }
|
1002
1100
|
attr_accessor :statement_descriptor_suffix
|
1003
1101
|
# A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
|
1004
|
-
sig { returns(T.nilable(String)) }
|
1102
|
+
sig { returns(T.nilable(T.nilable(String))) }
|
1005
1103
|
attr_accessor :transfer_group
|
1006
1104
|
sig {
|
1007
|
-
params(description: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_group: T.nilable(String)).void
|
1105
|
+
params(description: T.nilable(T.nilable(String)), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), statement_descriptor: T.nilable(T.nilable(String)), statement_descriptor_suffix: T.nilable(T.nilable(String)), transfer_group: T.nilable(T.nilable(String))).void
|
1008
1106
|
}
|
1009
1107
|
def initialize(
|
1010
1108
|
description: nil,
|
@@ -1049,21 +1147,21 @@ module Stripe
|
|
1049
1147
|
class InvoiceSettings < Stripe::RequestParams
|
1050
1148
|
class Issuer < Stripe::RequestParams
|
1051
1149
|
# The connected account being referenced when `type` is `account`.
|
1052
|
-
sig { returns(String) }
|
1150
|
+
sig { returns(T.nilable(String)) }
|
1053
1151
|
attr_accessor :account
|
1054
1152
|
# Type of the account referenced in the request.
|
1055
1153
|
sig { returns(String) }
|
1056
1154
|
attr_accessor :type
|
1057
|
-
sig { params(account: String, type: String).void }
|
1155
|
+
sig { params(account: T.nilable(String), type: String).void }
|
1058
1156
|
def initialize(account: nil, type: nil); end
|
1059
1157
|
end
|
1060
1158
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
1061
1159
|
sig {
|
1062
|
-
returns(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::InvoiceSettings::Issuer)
|
1160
|
+
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::InvoiceSettings::Issuer))
|
1063
1161
|
}
|
1064
1162
|
attr_accessor :issuer
|
1065
1163
|
sig {
|
1066
|
-
params(issuer: ::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::InvoiceSettings::Issuer).void
|
1164
|
+
params(issuer: T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::InvoiceSettings::Issuer)).void
|
1067
1165
|
}
|
1068
1166
|
def initialize(issuer: nil); end
|
1069
1167
|
end
|
@@ -1087,22 +1185,22 @@ module Stripe
|
|
1087
1185
|
end
|
1088
1186
|
# All invoices will be billed using the specified settings.
|
1089
1187
|
sig {
|
1090
|
-
returns(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::InvoiceSettings)
|
1188
|
+
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::InvoiceSettings))
|
1091
1189
|
}
|
1092
1190
|
attr_accessor :invoice_settings
|
1093
1191
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
|
1094
|
-
sig { returns(T.nilable(T::Hash[String, String])) }
|
1192
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
|
1095
1193
|
attr_accessor :metadata
|
1096
1194
|
# Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
|
1097
|
-
sig { returns(T.nilable(Integer)) }
|
1195
|
+
sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) }
|
1098
1196
|
attr_accessor :trial_period_days
|
1099
1197
|
# Settings related to subscription trials.
|
1100
1198
|
sig {
|
1101
|
-
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::TrialSettings))
|
1199
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::TrialSettings))))
|
1102
1200
|
}
|
1103
1201
|
attr_accessor :trial_settings
|
1104
1202
|
sig {
|
1105
|
-
params(invoice_settings: ::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::InvoiceSettings, metadata: T.nilable(T::Hash[String, String]), trial_period_days: T.nilable(Integer), trial_settings: T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::TrialSettings)).void
|
1203
|
+
params(invoice_settings: T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::InvoiceSettings), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), trial_period_days: T.nilable(T.nilable(T.any(String, Integer))), trial_settings: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::SubscriptionData::TrialSettings)))).void
|
1106
1204
|
}
|
1107
1205
|
def initialize(
|
1108
1206
|
invoice_settings: nil,
|
@@ -1116,87 +1214,91 @@ module Stripe
|
|
1116
1214
|
sig { returns(T::Boolean) }
|
1117
1215
|
attr_accessor :enabled
|
1118
1216
|
# Describes whether a tax ID is required during checkout. Defaults to `never`.
|
1119
|
-
sig { returns(String) }
|
1217
|
+
sig { returns(T.nilable(String)) }
|
1120
1218
|
attr_accessor :required
|
1121
|
-
sig { params(enabled: T::Boolean, required: String).void }
|
1219
|
+
sig { params(enabled: T::Boolean, required: T.nilable(String)).void }
|
1122
1220
|
def initialize(enabled: nil, required: nil); end
|
1123
1221
|
end
|
1124
1222
|
# Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated.
|
1125
|
-
sig { returns(T::Boolean) }
|
1223
|
+
sig { returns(T.nilable(T::Boolean)) }
|
1126
1224
|
attr_accessor :active
|
1127
1225
|
# Behavior after the purchase is complete.
|
1128
|
-
sig { returns(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion) }
|
1226
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion)) }
|
1129
1227
|
attr_accessor :after_completion
|
1130
1228
|
# Enables user redeemable promotion codes.
|
1131
|
-
sig { returns(T::Boolean) }
|
1229
|
+
sig { returns(T.nilable(T::Boolean)) }
|
1132
1230
|
attr_accessor :allow_promotion_codes
|
1133
1231
|
# Configuration for automatic tax collection.
|
1134
|
-
sig { returns(::Stripe::PaymentLinkService::UpdateParams::AutomaticTax) }
|
1232
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::AutomaticTax)) }
|
1135
1233
|
attr_accessor :automatic_tax
|
1136
1234
|
# Configuration for collecting the customer's billing address. Defaults to `auto`.
|
1137
|
-
sig { returns(String) }
|
1235
|
+
sig { returns(T.nilable(String)) }
|
1138
1236
|
attr_accessor :billing_address_collection
|
1139
1237
|
# Collect additional information from your customer using custom fields. Up to 3 fields are supported.
|
1140
|
-
sig {
|
1238
|
+
sig {
|
1239
|
+
returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::UpdateParams::CustomField]))))
|
1240
|
+
}
|
1141
1241
|
attr_accessor :custom_fields
|
1142
1242
|
# Display additional text for your customers using custom text.
|
1143
|
-
sig { returns(::Stripe::PaymentLinkService::UpdateParams::CustomText) }
|
1243
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomText)) }
|
1144
1244
|
attr_accessor :custom_text
|
1145
1245
|
# Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).
|
1146
|
-
sig { returns(String) }
|
1246
|
+
sig { returns(T.nilable(String)) }
|
1147
1247
|
attr_accessor :customer_creation
|
1148
1248
|
# Specifies which fields in the response should be expanded.
|
1149
|
-
sig { returns(T::Array[String]) }
|
1249
|
+
sig { returns(T.nilable(T::Array[String])) }
|
1150
1250
|
attr_accessor :expand
|
1151
1251
|
# The custom message to be displayed to a customer when a payment link is no longer active.
|
1152
|
-
sig { returns(T.nilable(String)) }
|
1252
|
+
sig { returns(T.nilable(T.nilable(String))) }
|
1153
1253
|
attr_accessor :inactive_message
|
1154
1254
|
# Generate a post-purchase Invoice for one-time payments.
|
1155
|
-
sig { returns(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation) }
|
1255
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation)) }
|
1156
1256
|
attr_accessor :invoice_creation
|
1157
1257
|
# The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.
|
1158
|
-
sig { returns(T::Array[::Stripe::PaymentLinkService::UpdateParams::LineItem]) }
|
1258
|
+
sig { returns(T.nilable(T::Array[::Stripe::PaymentLinkService::UpdateParams::LineItem])) }
|
1159
1259
|
attr_accessor :line_items
|
1160
1260
|
# 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`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.
|
1161
|
-
sig { returns(T::Hash[String, String]) }
|
1261
|
+
sig { returns(T.nilable(T::Hash[String, String])) }
|
1162
1262
|
attr_accessor :metadata
|
1163
1263
|
# A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
|
1164
|
-
sig { returns(::Stripe::PaymentLinkService::UpdateParams::PaymentIntentData) }
|
1264
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::PaymentIntentData)) }
|
1165
1265
|
attr_accessor :payment_intent_data
|
1166
1266
|
# Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.
|
1167
1267
|
#
|
1168
1268
|
# Can only be set in `subscription` mode. Defaults to `always`.
|
1169
1269
|
#
|
1170
1270
|
# If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).
|
1171
|
-
sig { returns(String) }
|
1271
|
+
sig { returns(T.nilable(String)) }
|
1172
1272
|
attr_accessor :payment_method_collection
|
1173
1273
|
# The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).
|
1174
|
-
sig { returns(T.nilable(T::Array[String])) }
|
1274
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
|
1175
1275
|
attr_accessor :payment_method_types
|
1176
1276
|
# Controls phone number collection settings during checkout.
|
1177
1277
|
#
|
1178
1278
|
# We recommend that you review your privacy policy and check with your legal contacts.
|
1179
|
-
sig { returns(::Stripe::PaymentLinkService::UpdateParams::PhoneNumberCollection) }
|
1279
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::PhoneNumberCollection)) }
|
1180
1280
|
attr_accessor :phone_number_collection
|
1181
1281
|
# Settings that restrict the usage of a payment link.
|
1182
|
-
sig {
|
1282
|
+
sig {
|
1283
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::Restrictions))))
|
1284
|
+
}
|
1183
1285
|
attr_accessor :restrictions
|
1184
1286
|
# Configuration for collecting the customer's shipping address.
|
1185
1287
|
sig {
|
1186
|
-
returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::ShippingAddressCollection))
|
1288
|
+
returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::ShippingAddressCollection))))
|
1187
1289
|
}
|
1188
1290
|
attr_accessor :shipping_address_collection
|
1189
1291
|
# Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).
|
1190
|
-
sig { returns(String) }
|
1292
|
+
sig { returns(T.nilable(String)) }
|
1191
1293
|
attr_accessor :submit_type
|
1192
1294
|
# When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.
|
1193
|
-
sig { returns(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData) }
|
1295
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData)) }
|
1194
1296
|
attr_accessor :subscription_data
|
1195
1297
|
# Controls tax ID collection during checkout.
|
1196
|
-
sig { returns(::Stripe::PaymentLinkService::UpdateParams::TaxIdCollection) }
|
1298
|
+
sig { returns(T.nilable(::Stripe::PaymentLinkService::UpdateParams::TaxIdCollection)) }
|
1197
1299
|
attr_accessor :tax_id_collection
|
1198
1300
|
sig {
|
1199
|
-
params(active: T::Boolean, after_completion: ::Stripe::PaymentLinkService::UpdateParams::AfterCompletion, allow_promotion_codes: T::Boolean, automatic_tax: ::Stripe::PaymentLinkService::UpdateParams::AutomaticTax, billing_address_collection: String, custom_fields: T.nilable(T::Array[::Stripe::PaymentLinkService::UpdateParams::CustomField]), custom_text: ::Stripe::PaymentLinkService::UpdateParams::CustomText, customer_creation: String, expand: T::Array[String], inactive_message: T.nilable(String), invoice_creation: ::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation, line_items: T::Array[::Stripe::PaymentLinkService::UpdateParams::LineItem], metadata: T::Hash[String, String], payment_intent_data: ::Stripe::PaymentLinkService::UpdateParams::PaymentIntentData, payment_method_collection: String, payment_method_types: T.nilable(T::Array[String]), phone_number_collection: ::Stripe::PaymentLinkService::UpdateParams::PhoneNumberCollection, restrictions: T.nilable(::Stripe::PaymentLinkService::UpdateParams::Restrictions), shipping_address_collection: T.nilable(::Stripe::PaymentLinkService::UpdateParams::ShippingAddressCollection), submit_type: String, subscription_data: ::Stripe::PaymentLinkService::UpdateParams::SubscriptionData, tax_id_collection: ::Stripe::PaymentLinkService::UpdateParams::TaxIdCollection).void
|
1301
|
+
params(active: T.nilable(T::Boolean), after_completion: T.nilable(::Stripe::PaymentLinkService::UpdateParams::AfterCompletion), allow_promotion_codes: T.nilable(T::Boolean), automatic_tax: T.nilable(::Stripe::PaymentLinkService::UpdateParams::AutomaticTax), billing_address_collection: T.nilable(String), custom_fields: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::PaymentLinkService::UpdateParams::CustomField]))), custom_text: T.nilable(::Stripe::PaymentLinkService::UpdateParams::CustomText), customer_creation: T.nilable(String), expand: T.nilable(T::Array[String]), inactive_message: T.nilable(T.nilable(String)), invoice_creation: T.nilable(::Stripe::PaymentLinkService::UpdateParams::InvoiceCreation), line_items: T.nilable(T::Array[::Stripe::PaymentLinkService::UpdateParams::LineItem]), metadata: T.nilable(T::Hash[String, String]), payment_intent_data: T.nilable(::Stripe::PaymentLinkService::UpdateParams::PaymentIntentData), payment_method_collection: T.nilable(String), payment_method_types: T.nilable(T.nilable(T.any(String, T::Array[String]))), phone_number_collection: T.nilable(::Stripe::PaymentLinkService::UpdateParams::PhoneNumberCollection), restrictions: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::Restrictions))), shipping_address_collection: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentLinkService::UpdateParams::ShippingAddressCollection))), submit_type: T.nilable(String), subscription_data: T.nilable(::Stripe::PaymentLinkService::UpdateParams::SubscriptionData), tax_id_collection: T.nilable(::Stripe::PaymentLinkService::UpdateParams::TaxIdCollection)).void
|
1200
1302
|
}
|
1201
1303
|
def initialize(
|
1202
1304
|
active: nil,
|