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
@@ -108,25 +108,25 @@ module Stripe
|
|
108
108
|
attr_reader :paypal
|
109
109
|
class ListParams < Stripe::RequestParams
|
110
110
|
# The domain name that this payment method domain object represents.
|
111
|
-
sig { returns(String) }
|
111
|
+
sig { returns(T.nilable(String)) }
|
112
112
|
attr_accessor :domain_name
|
113
|
-
# Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements
|
114
|
-
sig { returns(T::Boolean) }
|
113
|
+
# Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements or Embedded Checkout
|
114
|
+
sig { returns(T.nilable(T::Boolean)) }
|
115
115
|
attr_accessor :enabled
|
116
116
|
# 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.
|
117
|
-
sig { returns(String) }
|
117
|
+
sig { returns(T.nilable(String)) }
|
118
118
|
attr_accessor :ending_before
|
119
119
|
# Specifies which fields in the response should be expanded.
|
120
|
-
sig { returns(T::Array[String]) }
|
120
|
+
sig { returns(T.nilable(T::Array[String])) }
|
121
121
|
attr_accessor :expand
|
122
122
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
123
|
-
sig { returns(Integer) }
|
123
|
+
sig { returns(T.nilable(Integer)) }
|
124
124
|
attr_accessor :limit
|
125
125
|
# 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.
|
126
|
-
sig { returns(String) }
|
126
|
+
sig { returns(T.nilable(String)) }
|
127
127
|
attr_accessor :starting_after
|
128
128
|
sig {
|
129
|
-
params(domain_name: String, enabled: T::Boolean, ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String).void
|
129
|
+
params(domain_name: T.nilable(String), enabled: 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
|
130
130
|
}
|
131
131
|
def initialize(
|
132
132
|
domain_name: nil,
|
@@ -141,37 +141,32 @@ module Stripe
|
|
141
141
|
# The domain name that this payment method domain object represents.
|
142
142
|
sig { returns(String) }
|
143
143
|
attr_accessor :domain_name
|
144
|
-
# Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.
|
145
|
-
sig { returns(T::Boolean) }
|
144
|
+
# Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout.
|
145
|
+
sig { returns(T.nilable(T::Boolean)) }
|
146
146
|
attr_accessor :enabled
|
147
147
|
# Specifies which fields in the response should be expanded.
|
148
|
-
sig { returns(T::Array[String]) }
|
148
|
+
sig { returns(T.nilable(T::Array[String])) }
|
149
149
|
attr_accessor :expand
|
150
|
-
sig {
|
150
|
+
sig {
|
151
|
+
params(domain_name: String, enabled: T.nilable(T::Boolean), expand: T.nilable(T::Array[String])).void
|
152
|
+
}
|
151
153
|
def initialize(domain_name: nil, enabled: nil, expand: nil); end
|
152
154
|
end
|
153
|
-
class RetrieveParams < Stripe::RequestParams
|
154
|
-
# Specifies which fields in the response should be expanded.
|
155
|
-
sig { returns(T::Array[String]) }
|
156
|
-
attr_accessor :expand
|
157
|
-
sig { params(expand: T::Array[String]).void }
|
158
|
-
def initialize(expand: nil); end
|
159
|
-
end
|
160
155
|
class UpdateParams < Stripe::RequestParams
|
161
|
-
# Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.
|
162
|
-
sig { returns(T::Boolean) }
|
156
|
+
# Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout.
|
157
|
+
sig { returns(T.nilable(T::Boolean)) }
|
163
158
|
attr_accessor :enabled
|
164
159
|
# Specifies which fields in the response should be expanded.
|
165
|
-
sig { returns(T::Array[String]) }
|
160
|
+
sig { returns(T.nilable(T::Array[String])) }
|
166
161
|
attr_accessor :expand
|
167
|
-
sig { params(enabled: T::Boolean, expand: T::Array[String]).void }
|
162
|
+
sig { params(enabled: T.nilable(T::Boolean), expand: T.nilable(T::Array[String])).void }
|
168
163
|
def initialize(enabled: nil, expand: nil); end
|
169
164
|
end
|
170
165
|
class ValidateParams < Stripe::RequestParams
|
171
166
|
# Specifies which fields in the response should be expanded.
|
172
|
-
sig { returns(T::Array[String]) }
|
167
|
+
sig { returns(T.nilable(T::Array[String])) }
|
173
168
|
attr_accessor :expand
|
174
|
-
sig { params(expand: T::Array[String]).void }
|
169
|
+
sig { params(expand: T.nilable(T::Array[String])).void }
|
175
170
|
def initialize(expand: nil); end
|
176
171
|
end
|
177
172
|
# Creates a payment method domain.
|
@@ -192,10 +187,10 @@ module Stripe
|
|
192
187
|
}
|
193
188
|
def self.update(payment_method_domain, params = {}, opts = {}); end
|
194
189
|
|
195
|
-
# Some payment methods
|
196
|
-
# The payment method doesn't appear in Elements for this domain until it is active.
|
190
|
+
# Some payment methods might require additional steps to register a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
|
191
|
+
# The payment method doesn't appear in Elements or Embedded Checkout for this domain until it is active.
|
197
192
|
#
|
198
|
-
# To activate a payment method on an existing payment method domain, complete the required
|
193
|
+
# To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
|
199
194
|
#
|
200
195
|
# Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).
|
201
196
|
sig {
|
@@ -203,10 +198,10 @@ module Stripe
|
|
203
198
|
}
|
204
199
|
def validate(params = {}, opts = {}); end
|
205
200
|
|
206
|
-
# Some payment methods
|
207
|
-
# The payment method doesn't appear in Elements for this domain until it is active.
|
201
|
+
# Some payment methods might require additional steps to register a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
|
202
|
+
# The payment method doesn't appear in Elements or Embedded Checkout for this domain until it is active.
|
208
203
|
#
|
209
|
-
# To activate a payment method on an existing payment method domain, complete the required
|
204
|
+
# To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
|
210
205
|
#
|
211
206
|
# Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).
|
212
207
|
sig {
|
@@ -101,62 +101,66 @@ module Stripe
|
|
101
101
|
class ListParams < Stripe::RequestParams
|
102
102
|
class ArrivalDate < Stripe::RequestParams
|
103
103
|
# Minimum value to filter by (exclusive)
|
104
|
-
sig { returns(Integer) }
|
104
|
+
sig { returns(T.nilable(Integer)) }
|
105
105
|
attr_accessor :gt
|
106
106
|
# Minimum value to filter by (inclusive)
|
107
|
-
sig { returns(Integer) }
|
107
|
+
sig { returns(T.nilable(Integer)) }
|
108
108
|
attr_accessor :gte
|
109
109
|
# Maximum value to filter by (exclusive)
|
110
|
-
sig { returns(Integer) }
|
110
|
+
sig { returns(T.nilable(Integer)) }
|
111
111
|
attr_accessor :lt
|
112
112
|
# Maximum value to filter by (inclusive)
|
113
|
-
sig { returns(Integer) }
|
113
|
+
sig { returns(T.nilable(Integer)) }
|
114
114
|
attr_accessor :lte
|
115
|
-
sig {
|
115
|
+
sig {
|
116
|
+
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
|
117
|
+
}
|
116
118
|
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
|
117
119
|
end
|
118
120
|
class Created < Stripe::RequestParams
|
119
121
|
# Minimum value to filter by (exclusive)
|
120
|
-
sig { returns(Integer) }
|
122
|
+
sig { returns(T.nilable(Integer)) }
|
121
123
|
attr_accessor :gt
|
122
124
|
# Minimum value to filter by (inclusive)
|
123
|
-
sig { returns(Integer) }
|
125
|
+
sig { returns(T.nilable(Integer)) }
|
124
126
|
attr_accessor :gte
|
125
127
|
# Maximum value to filter by (exclusive)
|
126
|
-
sig { returns(Integer) }
|
128
|
+
sig { returns(T.nilable(Integer)) }
|
127
129
|
attr_accessor :lt
|
128
130
|
# Maximum value to filter by (inclusive)
|
129
|
-
sig { returns(Integer) }
|
131
|
+
sig { returns(T.nilable(Integer)) }
|
130
132
|
attr_accessor :lte
|
131
|
-
sig {
|
133
|
+
sig {
|
134
|
+
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
|
135
|
+
}
|
132
136
|
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
|
133
137
|
end
|
134
138
|
# Only return payouts that are expected to arrive during the given date interval.
|
135
|
-
sig { returns(T.any(::Stripe::Payout::ListParams::ArrivalDate, Integer)) }
|
139
|
+
sig { returns(T.nilable(T.any(::Stripe::Payout::ListParams::ArrivalDate, Integer))) }
|
136
140
|
attr_accessor :arrival_date
|
137
141
|
# Only return payouts that were created during the given date interval.
|
138
|
-
sig { returns(T.any(::Stripe::Payout::ListParams::Created, Integer)) }
|
142
|
+
sig { returns(T.nilable(T.any(::Stripe::Payout::ListParams::Created, Integer))) }
|
139
143
|
attr_accessor :created
|
140
144
|
# The ID of an external account - only return payouts sent to this external account.
|
141
|
-
sig { returns(String) }
|
145
|
+
sig { returns(T.nilable(String)) }
|
142
146
|
attr_accessor :destination
|
143
147
|
# 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.
|
144
|
-
sig { returns(String) }
|
148
|
+
sig { returns(T.nilable(String)) }
|
145
149
|
attr_accessor :ending_before
|
146
150
|
# Specifies which fields in the response should be expanded.
|
147
|
-
sig { returns(T::Array[String]) }
|
151
|
+
sig { returns(T.nilable(T::Array[String])) }
|
148
152
|
attr_accessor :expand
|
149
153
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
150
|
-
sig { returns(Integer) }
|
154
|
+
sig { returns(T.nilable(Integer)) }
|
151
155
|
attr_accessor :limit
|
152
156
|
# 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.
|
153
|
-
sig { returns(String) }
|
157
|
+
sig { returns(T.nilable(String)) }
|
154
158
|
attr_accessor :starting_after
|
155
159
|
# Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`.
|
156
|
-
sig { returns(String) }
|
160
|
+
sig { returns(T.nilable(String)) }
|
157
161
|
attr_accessor :status
|
158
162
|
sig {
|
159
|
-
params(arrival_date: T.any(::Stripe::Payout::ListParams::ArrivalDate, Integer), created: T.any(::Stripe::Payout::ListParams::Created, Integer), destination: String, ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String, status: String).void
|
163
|
+
params(arrival_date: T.nilable(T.any(::Stripe::Payout::ListParams::ArrivalDate, Integer)), created: T.nilable(T.any(::Stripe::Payout::ListParams::Created, Integer)), destination: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
|
160
164
|
}
|
161
165
|
def initialize(
|
162
166
|
arrival_date: nil,
|
@@ -177,28 +181,28 @@ module Stripe
|
|
177
181
|
sig { returns(String) }
|
178
182
|
attr_accessor :currency
|
179
183
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
180
|
-
sig { returns(String) }
|
184
|
+
sig { returns(T.nilable(String)) }
|
181
185
|
attr_accessor :description
|
182
186
|
# The ID of a bank account or a card to send the payout to. If you don't provide a destination, we use the default external account for the specified currency.
|
183
|
-
sig { returns(String) }
|
187
|
+
sig { returns(T.nilable(String)) }
|
184
188
|
attr_accessor :destination
|
185
189
|
# Specifies which fields in the response should be expanded.
|
186
|
-
sig { returns(T::Array[String]) }
|
190
|
+
sig { returns(T.nilable(T::Array[String])) }
|
187
191
|
attr_accessor :expand
|
188
192
|
# 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`.
|
189
|
-
sig { returns(T::Hash[String, String]) }
|
193
|
+
sig { returns(T.nilable(T::Hash[String, String])) }
|
190
194
|
attr_accessor :metadata
|
191
195
|
# The method used to send this payout, which is `standard` or `instant`. We support `instant` for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).
|
192
|
-
sig { returns(String) }
|
196
|
+
sig { returns(T.nilable(String)) }
|
193
197
|
attr_accessor :method
|
194
198
|
# The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of `bank_account`, `card`, or `fpx`.
|
195
|
-
sig { returns(String) }
|
199
|
+
sig { returns(T.nilable(String)) }
|
196
200
|
attr_accessor :source_type
|
197
201
|
# A string that displays on the recipient's bank or card statement (up to 22 characters). A `statement_descriptor` that's longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all.
|
198
|
-
sig { returns(String) }
|
202
|
+
sig { returns(T.nilable(String)) }
|
199
203
|
attr_accessor :statement_descriptor
|
200
204
|
sig {
|
201
|
-
params(amount: Integer, currency: String, description: String, destination: String, expand: T::Array[String], metadata: T::Hash[String, String], method: String, source_type: String, statement_descriptor: String).void
|
205
|
+
params(amount: Integer, currency: String, description: T.nilable(String), destination: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), method: T.nilable(String), source_type: T.nilable(String), statement_descriptor: T.nilable(String)).void
|
202
206
|
}
|
203
207
|
def initialize(
|
204
208
|
amount: nil,
|
@@ -212,38 +216,35 @@ module Stripe
|
|
212
216
|
statement_descriptor: nil
|
213
217
|
); end
|
214
218
|
end
|
215
|
-
class RetrieveParams < Stripe::RequestParams
|
216
|
-
# Specifies which fields in the response should be expanded.
|
217
|
-
sig { returns(T::Array[String]) }
|
218
|
-
attr_accessor :expand
|
219
|
-
sig { params(expand: T::Array[String]).void }
|
220
|
-
def initialize(expand: nil); end
|
221
|
-
end
|
222
219
|
class UpdateParams < Stripe::RequestParams
|
223
220
|
# Specifies which fields in the response should be expanded.
|
224
|
-
sig { returns(T::Array[String]) }
|
221
|
+
sig { returns(T.nilable(T::Array[String])) }
|
225
222
|
attr_accessor :expand
|
226
223
|
# 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`.
|
227
|
-
sig { returns(T.nilable(T::Hash[String, String])) }
|
224
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
|
228
225
|
attr_accessor :metadata
|
229
|
-
sig {
|
226
|
+
sig {
|
227
|
+
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
|
228
|
+
}
|
230
229
|
def initialize(expand: nil, metadata: nil); end
|
231
230
|
end
|
232
231
|
class CancelParams < Stripe::RequestParams
|
233
232
|
# Specifies which fields in the response should be expanded.
|
234
|
-
sig { returns(T::Array[String]) }
|
233
|
+
sig { returns(T.nilable(T::Array[String])) }
|
235
234
|
attr_accessor :expand
|
236
|
-
sig { params(expand: T::Array[String]).void }
|
235
|
+
sig { params(expand: T.nilable(T::Array[String])).void }
|
237
236
|
def initialize(expand: nil); end
|
238
237
|
end
|
239
238
|
class ReverseParams < Stripe::RequestParams
|
240
239
|
# Specifies which fields in the response should be expanded.
|
241
|
-
sig { returns(T::Array[String]) }
|
240
|
+
sig { returns(T.nilable(T::Array[String])) }
|
242
241
|
attr_accessor :expand
|
243
242
|
# 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`.
|
244
|
-
sig { returns(T::Hash[String, String]) }
|
243
|
+
sig { returns(T.nilable(T::Hash[String, String])) }
|
245
244
|
attr_accessor :metadata
|
246
|
-
sig {
|
245
|
+
sig {
|
246
|
+
params(expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String])).void
|
247
|
+
}
|
247
248
|
def initialize(expand: nil, metadata: nil); end
|
248
249
|
end
|
249
250
|
# You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can't cancel automatic Stripe payouts.
|
@@ -5,7 +5,7 @@
|
|
5
5
|
module Stripe
|
6
6
|
# This is an object representing a person associated with a Stripe account.
|
7
7
|
#
|
8
|
-
# A platform
|
8
|
+
# A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.
|
9
9
|
#
|
10
10
|
# See the [Standard onboarding](https://stripe.com/connect/standard-accounts) or [Express onboarding](https://stripe.com/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](https://stripe.com/connect/handling-api-verification#person-information).
|
11
11
|
class Person < APIResource
|
@@ -292,19 +292,19 @@ module Stripe
|
|
292
292
|
# Attribute for field dob
|
293
293
|
sig { returns(Dob) }
|
294
294
|
attr_reader :dob
|
295
|
-
# The person's email address.
|
295
|
+
# The person's email address. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
|
296
296
|
sig { returns(T.nilable(String)) }
|
297
297
|
attr_reader :email
|
298
|
-
# The person's first name.
|
298
|
+
# The person's first name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
|
299
299
|
sig { returns(T.nilable(String)) }
|
300
300
|
attr_reader :first_name
|
301
|
-
# The Kana variation of the person's first name (Japan only).
|
301
|
+
# The Kana variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
|
302
302
|
sig { returns(T.nilable(String)) }
|
303
303
|
attr_reader :first_name_kana
|
304
|
-
# The Kanji variation of the person's first name (Japan only).
|
304
|
+
# The Kanji variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
|
305
305
|
sig { returns(T.nilable(String)) }
|
306
306
|
attr_reader :first_name_kanji
|
307
|
-
# A list of alternate names or aliases that the person is known by.
|
307
|
+
# A list of alternate names or aliases that the person is known by. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
|
308
308
|
sig { returns(T::Array[String]) }
|
309
309
|
attr_reader :full_name_aliases
|
310
310
|
# Information about the [upcoming new requirements for this person](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.
|
@@ -322,13 +322,13 @@ module Stripe
|
|
322
322
|
# Whether the person's `id_number_secondary` was provided.
|
323
323
|
sig { returns(T::Boolean) }
|
324
324
|
attr_reader :id_number_secondary_provided
|
325
|
-
# The person's last name.
|
325
|
+
# The person's last name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
|
326
326
|
sig { returns(T.nilable(String)) }
|
327
327
|
attr_reader :last_name
|
328
|
-
# The Kana variation of the person's last name (Japan only).
|
328
|
+
# The Kana variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
|
329
329
|
sig { returns(T.nilable(String)) }
|
330
330
|
attr_reader :last_name_kana
|
331
|
-
# The Kanji variation of the person's last name (Japan only).
|
331
|
+
# The Kanji variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
|
332
332
|
sig { returns(T.nilable(String)) }
|
333
333
|
attr_reader :last_name_kanji
|
334
334
|
# The person's maiden name.
|
@@ -40,9 +40,6 @@ module Stripe
|
|
40
40
|
# Whether the plan can be used for new purchases.
|
41
41
|
sig { returns(T::Boolean) }
|
42
42
|
attr_reader :active
|
43
|
-
# Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.
|
44
|
-
sig { returns(T.nilable(String)) }
|
45
|
-
attr_reader :aggregate_usage
|
46
43
|
# The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.
|
47
44
|
sig { returns(T.nilable(Integer)) }
|
48
45
|
attr_reader :amount
|
@@ -105,35 +102,28 @@ module Stripe
|
|
105
102
|
attr_reader :deleted
|
106
103
|
class DeleteParams < Stripe::RequestParams
|
107
104
|
|
108
|
-
end
|
109
|
-
class RetrieveParams < Stripe::RequestParams
|
110
|
-
# Specifies which fields in the response should be expanded.
|
111
|
-
sig { returns(T::Array[String]) }
|
112
|
-
attr_accessor :expand
|
113
|
-
sig { params(expand: T::Array[String]).void }
|
114
|
-
def initialize(expand: nil); end
|
115
105
|
end
|
116
106
|
class UpdateParams < Stripe::RequestParams
|
117
107
|
# Whether the plan is currently available for new subscriptions.
|
118
|
-
sig { returns(T::Boolean) }
|
108
|
+
sig { returns(T.nilable(T::Boolean)) }
|
119
109
|
attr_accessor :active
|
120
110
|
# Specifies which fields in the response should be expanded.
|
121
|
-
sig { returns(T::Array[String]) }
|
111
|
+
sig { returns(T.nilable(T::Array[String])) }
|
122
112
|
attr_accessor :expand
|
123
113
|
# 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`.
|
124
|
-
sig { returns(T.nilable(T::Hash[String, String])) }
|
114
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
|
125
115
|
attr_accessor :metadata
|
126
116
|
# A brief description of the plan, hidden from customers.
|
127
|
-
sig { returns(String) }
|
117
|
+
sig { returns(T.nilable(String)) }
|
128
118
|
attr_accessor :nickname
|
129
119
|
# The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule.
|
130
|
-
sig { returns(String) }
|
120
|
+
sig { returns(T.nilable(String)) }
|
131
121
|
attr_accessor :product
|
132
122
|
# Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
|
133
|
-
sig { returns(Integer) }
|
123
|
+
sig { returns(T.nilable(Integer)) }
|
134
124
|
attr_accessor :trial_period_days
|
135
125
|
sig {
|
136
|
-
params(active: T::Boolean, expand: T::Array[String], metadata: T.nilable(T::Hash[String, String]), nickname: String, product: String, trial_period_days: Integer).void
|
126
|
+
params(active: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), nickname: T.nilable(String), product: T.nilable(String), trial_period_days: T.nilable(Integer)).void
|
137
127
|
}
|
138
128
|
def initialize(
|
139
129
|
active: nil,
|
@@ -147,43 +137,45 @@ module Stripe
|
|
147
137
|
class ListParams < Stripe::RequestParams
|
148
138
|
class Created < Stripe::RequestParams
|
149
139
|
# Minimum value to filter by (exclusive)
|
150
|
-
sig { returns(Integer) }
|
140
|
+
sig { returns(T.nilable(Integer)) }
|
151
141
|
attr_accessor :gt
|
152
142
|
# Minimum value to filter by (inclusive)
|
153
|
-
sig { returns(Integer) }
|
143
|
+
sig { returns(T.nilable(Integer)) }
|
154
144
|
attr_accessor :gte
|
155
145
|
# Maximum value to filter by (exclusive)
|
156
|
-
sig { returns(Integer) }
|
146
|
+
sig { returns(T.nilable(Integer)) }
|
157
147
|
attr_accessor :lt
|
158
148
|
# Maximum value to filter by (inclusive)
|
159
|
-
sig { returns(Integer) }
|
149
|
+
sig { returns(T.nilable(Integer)) }
|
160
150
|
attr_accessor :lte
|
161
|
-
sig {
|
151
|
+
sig {
|
152
|
+
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
|
153
|
+
}
|
162
154
|
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
|
163
155
|
end
|
164
156
|
# Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans).
|
165
|
-
sig { returns(T::Boolean) }
|
157
|
+
sig { returns(T.nilable(T::Boolean)) }
|
166
158
|
attr_accessor :active
|
167
159
|
# A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
|
168
|
-
sig { returns(T.any(::Stripe::Plan::ListParams::Created, Integer)) }
|
160
|
+
sig { returns(T.nilable(T.any(::Stripe::Plan::ListParams::Created, Integer))) }
|
169
161
|
attr_accessor :created
|
170
162
|
# 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.
|
171
|
-
sig { returns(String) }
|
163
|
+
sig { returns(T.nilable(String)) }
|
172
164
|
attr_accessor :ending_before
|
173
165
|
# Specifies which fields in the response should be expanded.
|
174
|
-
sig { returns(T::Array[String]) }
|
166
|
+
sig { returns(T.nilable(T::Array[String])) }
|
175
167
|
attr_accessor :expand
|
176
168
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
177
|
-
sig { returns(Integer) }
|
169
|
+
sig { returns(T.nilable(Integer)) }
|
178
170
|
attr_accessor :limit
|
179
171
|
# Only return plans for the given product.
|
180
|
-
sig { returns(String) }
|
172
|
+
sig { returns(T.nilable(String)) }
|
181
173
|
attr_accessor :product
|
182
174
|
# 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.
|
183
|
-
sig { returns(String) }
|
175
|
+
sig { returns(T.nilable(String)) }
|
184
176
|
attr_accessor :starting_after
|
185
177
|
sig {
|
186
|
-
params(active: T::Boolean, created: T.any(::Stripe::Plan::ListParams::Created, Integer), ending_before: String, expand: T::Array[String], limit: Integer, product: String, starting_after: String).void
|
178
|
+
params(active: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::Plan::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), product: T.nilable(String), starting_after: T.nilable(String)).void
|
187
179
|
}
|
188
180
|
def initialize(
|
189
181
|
active: nil,
|
@@ -198,13 +190,13 @@ module Stripe
|
|
198
190
|
class CreateParams < Stripe::RequestParams
|
199
191
|
class Product < Stripe::RequestParams
|
200
192
|
# Whether the product is currently available for purchase. Defaults to `true`.
|
201
|
-
sig { returns(T::Boolean) }
|
193
|
+
sig { returns(T.nilable(T::Boolean)) }
|
202
194
|
attr_accessor :active
|
203
195
|
# The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
|
204
|
-
sig { returns(String) }
|
196
|
+
sig { returns(T.nilable(String)) }
|
205
197
|
attr_accessor :id
|
206
198
|
# 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`.
|
207
|
-
sig { returns(T::Hash[String, String]) }
|
199
|
+
sig { returns(T.nilable(T::Hash[String, String])) }
|
208
200
|
attr_accessor :metadata
|
209
201
|
# The product's name, meant to be displayable to the customer.
|
210
202
|
sig { returns(String) }
|
@@ -212,16 +204,16 @@ module Stripe
|
|
212
204
|
# An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
|
213
205
|
#
|
214
206
|
# This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
|
215
|
-
sig { returns(String) }
|
207
|
+
sig { returns(T.nilable(String)) }
|
216
208
|
attr_accessor :statement_descriptor
|
217
209
|
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
|
218
|
-
sig { returns(String) }
|
210
|
+
sig { returns(T.nilable(String)) }
|
219
211
|
attr_accessor :tax_code
|
220
212
|
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
221
|
-
sig { returns(String) }
|
213
|
+
sig { returns(T.nilable(String)) }
|
222
214
|
attr_accessor :unit_label
|
223
215
|
sig {
|
224
|
-
params(active: T::Boolean, id: String, metadata: T::Hash[String, String], name: String, statement_descriptor: String, tax_code: String, unit_label: String).void
|
216
|
+
params(active: T.nilable(T::Boolean), id: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), name: String, statement_descriptor: T.nilable(String), tax_code: T.nilable(String), unit_label: T.nilable(String)).void
|
225
217
|
}
|
226
218
|
def initialize(
|
227
219
|
active: nil,
|
@@ -235,22 +227,22 @@ module Stripe
|
|
235
227
|
end
|
236
228
|
class Tier < Stripe::RequestParams
|
237
229
|
# The flat billing amount for an entire tier, regardless of the number of units in the tier.
|
238
|
-
sig { returns(Integer) }
|
230
|
+
sig { returns(T.nilable(Integer)) }
|
239
231
|
attr_accessor :flat_amount
|
240
232
|
# Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
|
241
|
-
sig { returns(String) }
|
233
|
+
sig { returns(T.nilable(String)) }
|
242
234
|
attr_accessor :flat_amount_decimal
|
243
235
|
# The per unit billing amount for each individual unit for which this tier applies.
|
244
|
-
sig { returns(Integer) }
|
236
|
+
sig { returns(T.nilable(Integer)) }
|
245
237
|
attr_accessor :unit_amount
|
246
238
|
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
247
|
-
sig { returns(String) }
|
239
|
+
sig { returns(T.nilable(String)) }
|
248
240
|
attr_accessor :unit_amount_decimal
|
249
241
|
# Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
|
250
242
|
sig { returns(T.any(String, Integer)) }
|
251
243
|
attr_accessor :up_to
|
252
244
|
sig {
|
253
|
-
params(flat_amount: Integer, flat_amount_decimal: String, unit_amount: Integer, unit_amount_decimal: String, up_to: T.any(String, Integer)).void
|
245
|
+
params(flat_amount: T.nilable(Integer), flat_amount_decimal: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String), up_to: T.any(String, Integer)).void
|
254
246
|
}
|
255
247
|
def initialize(
|
256
248
|
flat_amount: nil,
|
@@ -271,68 +263,64 @@ module Stripe
|
|
271
263
|
def initialize(divide_by: nil, round: nil); end
|
272
264
|
end
|
273
265
|
# Whether the plan is currently available for new subscriptions. Defaults to `true`.
|
274
|
-
sig { returns(T::Boolean) }
|
266
|
+
sig { returns(T.nilable(T::Boolean)) }
|
275
267
|
attr_accessor :active
|
276
|
-
# Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.
|
277
|
-
sig { returns(String) }
|
278
|
-
attr_accessor :aggregate_usage
|
279
268
|
# A positive integer in cents (or local equivalent) (or 0 for a free plan) representing how much to charge on a recurring basis.
|
280
|
-
sig { returns(Integer) }
|
269
|
+
sig { returns(T.nilable(Integer)) }
|
281
270
|
attr_accessor :amount
|
282
271
|
# Same as `amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set.
|
283
|
-
sig { returns(String) }
|
272
|
+
sig { returns(T.nilable(String)) }
|
284
273
|
attr_accessor :amount_decimal
|
285
274
|
# Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.
|
286
|
-
sig { returns(String) }
|
275
|
+
sig { returns(T.nilable(String)) }
|
287
276
|
attr_accessor :billing_scheme
|
288
277
|
# 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).
|
289
278
|
sig { returns(String) }
|
290
279
|
attr_accessor :currency
|
291
280
|
# Specifies which fields in the response should be expanded.
|
292
|
-
sig { returns(T::Array[String]) }
|
281
|
+
sig { returns(T.nilable(T::Array[String])) }
|
293
282
|
attr_accessor :expand
|
294
283
|
# An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes.
|
295
|
-
sig { returns(String) }
|
284
|
+
sig { returns(T.nilable(String)) }
|
296
285
|
attr_accessor :id
|
297
286
|
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
298
287
|
sig { returns(String) }
|
299
288
|
attr_accessor :interval
|
300
289
|
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
|
301
|
-
sig { returns(Integer) }
|
290
|
+
sig { returns(T.nilable(Integer)) }
|
302
291
|
attr_accessor :interval_count
|
303
292
|
# 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`.
|
304
|
-
sig { returns(T.nilable(T::Hash[String, String])) }
|
293
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
|
305
294
|
attr_accessor :metadata
|
306
295
|
# The meter tracking the usage of a metered price
|
307
|
-
sig { returns(String) }
|
296
|
+
sig { returns(T.nilable(String)) }
|
308
297
|
attr_accessor :meter
|
309
298
|
# A brief description of the plan, hidden from customers.
|
310
|
-
sig { returns(String) }
|
299
|
+
sig { returns(T.nilable(String)) }
|
311
300
|
attr_accessor :nickname
|
312
301
|
# Attribute for param field product
|
313
|
-
sig { returns(T.any(::Stripe::Plan::CreateParams::Product, String)) }
|
302
|
+
sig { returns(T.nilable(T.any(::Stripe::Plan::CreateParams::Product, String))) }
|
314
303
|
attr_accessor :product
|
315
304
|
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
|
316
|
-
sig { returns(T::Array[::Stripe::Plan::CreateParams::Tier]) }
|
305
|
+
sig { returns(T.nilable(T::Array[::Stripe::Plan::CreateParams::Tier])) }
|
317
306
|
attr_accessor :tiers
|
318
307
|
# Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.
|
319
|
-
sig { returns(String) }
|
308
|
+
sig { returns(T.nilable(String)) }
|
320
309
|
attr_accessor :tiers_mode
|
321
310
|
# Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.
|
322
|
-
sig { returns(::Stripe::Plan::CreateParams::TransformUsage) }
|
311
|
+
sig { returns(T.nilable(::Stripe::Plan::CreateParams::TransformUsage)) }
|
323
312
|
attr_accessor :transform_usage
|
324
313
|
# Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
|
325
|
-
sig { returns(Integer) }
|
314
|
+
sig { returns(T.nilable(Integer)) }
|
326
315
|
attr_accessor :trial_period_days
|
327
316
|
# Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.
|
328
|
-
sig { returns(String) }
|
317
|
+
sig { returns(T.nilable(String)) }
|
329
318
|
attr_accessor :usage_type
|
330
319
|
sig {
|
331
|
-
params(active: T::Boolean,
|
320
|
+
params(active: T.nilable(T::Boolean), amount: T.nilable(Integer), amount_decimal: T.nilable(String), billing_scheme: T.nilable(String), currency: String, expand: T.nilable(T::Array[String]), id: T.nilable(String), interval: String, interval_count: T.nilable(Integer), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), meter: T.nilable(String), nickname: T.nilable(String), product: T.nilable(T.any(::Stripe::Plan::CreateParams::Product, String)), tiers: T.nilable(T::Array[::Stripe::Plan::CreateParams::Tier]), tiers_mode: T.nilable(String), transform_usage: T.nilable(::Stripe::Plan::CreateParams::TransformUsage), trial_period_days: T.nilable(Integer), usage_type: T.nilable(String)).void
|
332
321
|
}
|
333
322
|
def initialize(
|
334
323
|
active: nil,
|
335
|
-
aggregate_usage: nil,
|
336
324
|
amount: nil,
|
337
325
|
amount_decimal: nil,
|
338
326
|
billing_scheme: nil,
|