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,68 +7,72 @@ module Stripe
|
|
7
7
|
class ListParams < Stripe::RequestParams
|
8
8
|
class Created < Stripe::RequestParams
|
9
9
|
# Minimum value to filter by (exclusive)
|
10
|
-
sig { returns(Integer) }
|
10
|
+
sig { returns(T.nilable(Integer)) }
|
11
11
|
attr_accessor :gt
|
12
12
|
# Minimum value to filter by (inclusive)
|
13
|
-
sig { returns(Integer) }
|
13
|
+
sig { returns(T.nilable(Integer)) }
|
14
14
|
attr_accessor :gte
|
15
15
|
# Maximum value to filter by (exclusive)
|
16
|
-
sig { returns(Integer) }
|
16
|
+
sig { returns(T.nilable(Integer)) }
|
17
17
|
attr_accessor :lt
|
18
18
|
# Maximum value to filter by (inclusive)
|
19
|
-
sig { returns(Integer) }
|
19
|
+
sig { returns(T.nilable(Integer)) }
|
20
20
|
attr_accessor :lte
|
21
|
-
sig {
|
21
|
+
sig {
|
22
|
+
params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
|
23
|
+
}
|
22
24
|
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
|
23
25
|
end
|
24
26
|
class Recurring < Stripe::RequestParams
|
25
27
|
# Filter by billing frequency. Either `day`, `week`, `month` or `year`.
|
26
|
-
sig { returns(String) }
|
28
|
+
sig { returns(T.nilable(String)) }
|
27
29
|
attr_accessor :interval
|
28
30
|
# Filter by the price's meter.
|
29
|
-
sig { returns(String) }
|
31
|
+
sig { returns(T.nilable(String)) }
|
30
32
|
attr_accessor :meter
|
31
33
|
# Filter by the usage type for this price. Can be either `metered` or `licensed`.
|
32
|
-
sig { returns(String) }
|
34
|
+
sig { returns(T.nilable(String)) }
|
33
35
|
attr_accessor :usage_type
|
34
|
-
sig {
|
36
|
+
sig {
|
37
|
+
params(interval: T.nilable(String), meter: T.nilable(String), usage_type: T.nilable(String)).void
|
38
|
+
}
|
35
39
|
def initialize(interval: nil, meter: nil, usage_type: nil); end
|
36
40
|
end
|
37
41
|
# Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices).
|
38
|
-
sig { returns(T::Boolean) }
|
42
|
+
sig { returns(T.nilable(T::Boolean)) }
|
39
43
|
attr_accessor :active
|
40
44
|
# 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.
|
41
|
-
sig { returns(T.any(::Stripe::PriceService::ListParams::Created, Integer)) }
|
45
|
+
sig { returns(T.nilable(T.any(::Stripe::PriceService::ListParams::Created, Integer))) }
|
42
46
|
attr_accessor :created
|
43
47
|
# Only return prices for the given currency.
|
44
|
-
sig { returns(String) }
|
48
|
+
sig { returns(T.nilable(String)) }
|
45
49
|
attr_accessor :currency
|
46
50
|
# 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.
|
47
|
-
sig { returns(String) }
|
51
|
+
sig { returns(T.nilable(String)) }
|
48
52
|
attr_accessor :ending_before
|
49
53
|
# Specifies which fields in the response should be expanded.
|
50
|
-
sig { returns(T::Array[String]) }
|
54
|
+
sig { returns(T.nilable(T::Array[String])) }
|
51
55
|
attr_accessor :expand
|
52
56
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
53
|
-
sig { returns(Integer) }
|
57
|
+
sig { returns(T.nilable(Integer)) }
|
54
58
|
attr_accessor :limit
|
55
59
|
# Only return the price with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.
|
56
|
-
sig { returns(T::Array[String]) }
|
60
|
+
sig { returns(T.nilable(T::Array[String])) }
|
57
61
|
attr_accessor :lookup_keys
|
58
62
|
# Only return prices for the given product.
|
59
|
-
sig { returns(String) }
|
63
|
+
sig { returns(T.nilable(String)) }
|
60
64
|
attr_accessor :product
|
61
65
|
# Only return prices with these recurring fields.
|
62
|
-
sig { returns(::Stripe::PriceService::ListParams::Recurring) }
|
66
|
+
sig { returns(T.nilable(::Stripe::PriceService::ListParams::Recurring)) }
|
63
67
|
attr_accessor :recurring
|
64
68
|
# 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.
|
65
|
-
sig { returns(String) }
|
69
|
+
sig { returns(T.nilable(String)) }
|
66
70
|
attr_accessor :starting_after
|
67
71
|
# Only return prices of type `recurring` or `one_time`.
|
68
|
-
sig { returns(String) }
|
72
|
+
sig { returns(T.nilable(String)) }
|
69
73
|
attr_accessor :type
|
70
74
|
sig {
|
71
|
-
params(active: T::Boolean, created: T.any(::Stripe::PriceService::ListParams::Created, Integer), currency: String, ending_before: String, expand: T::Array[String], limit: Integer, lookup_keys: T::Array[String], product: String, recurring: ::Stripe::PriceService::ListParams::Recurring, starting_after: String, type: String).void
|
75
|
+
params(active: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::PriceService::ListParams::Created, Integer)), currency: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), lookup_keys: T.nilable(T::Array[String]), product: T.nilable(String), recurring: T.nilable(::Stripe::PriceService::ListParams::Recurring), starting_after: T.nilable(String), type: T.nilable(String)).void
|
72
76
|
}
|
73
77
|
def initialize(
|
74
78
|
active: nil,
|
@@ -91,37 +95,37 @@ module Stripe
|
|
91
95
|
sig { returns(T::Boolean) }
|
92
96
|
attr_accessor :enabled
|
93
97
|
# The maximum unit amount the customer can specify for this item.
|
94
|
-
sig { returns(Integer) }
|
98
|
+
sig { returns(T.nilable(Integer)) }
|
95
99
|
attr_accessor :maximum
|
96
100
|
# The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
|
97
|
-
sig { returns(Integer) }
|
101
|
+
sig { returns(T.nilable(Integer)) }
|
98
102
|
attr_accessor :minimum
|
99
103
|
# The starting unit amount which can be updated by the customer.
|
100
|
-
sig { returns(Integer) }
|
104
|
+
sig { returns(T.nilable(Integer)) }
|
101
105
|
attr_accessor :preset
|
102
106
|
sig {
|
103
|
-
params(enabled: T::Boolean, maximum: Integer, minimum: Integer, preset: Integer).void
|
107
|
+
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
|
104
108
|
}
|
105
109
|
def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
|
106
110
|
end
|
107
111
|
class Tier < Stripe::RequestParams
|
108
112
|
# The flat billing amount for an entire tier, regardless of the number of units in the tier.
|
109
|
-
sig { returns(Integer) }
|
113
|
+
sig { returns(T.nilable(Integer)) }
|
110
114
|
attr_accessor :flat_amount
|
111
115
|
# 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.
|
112
|
-
sig { returns(String) }
|
116
|
+
sig { returns(T.nilable(String)) }
|
113
117
|
attr_accessor :flat_amount_decimal
|
114
118
|
# The per unit billing amount for each individual unit for which this tier applies.
|
115
|
-
sig { returns(Integer) }
|
119
|
+
sig { returns(T.nilable(Integer)) }
|
116
120
|
attr_accessor :unit_amount
|
117
121
|
# 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.
|
118
|
-
sig { returns(String) }
|
122
|
+
sig { returns(T.nilable(String)) }
|
119
123
|
attr_accessor :unit_amount_decimal
|
120
124
|
# 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.
|
121
125
|
sig { returns(T.any(String, Integer)) }
|
122
126
|
attr_accessor :up_to
|
123
127
|
sig {
|
124
|
-
params(flat_amount: Integer, flat_amount_decimal: String, unit_amount: Integer, unit_amount_decimal: String, up_to: T.any(String, Integer)).void
|
128
|
+
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
|
125
129
|
}
|
126
130
|
def initialize(
|
127
131
|
flat_amount: nil,
|
@@ -132,22 +136,26 @@ module Stripe
|
|
132
136
|
); end
|
133
137
|
end
|
134
138
|
# When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
|
135
|
-
sig {
|
139
|
+
sig {
|
140
|
+
returns(T.nilable(::Stripe::PriceService::CreateParams::CurrencyOptions::CustomUnitAmount))
|
141
|
+
}
|
136
142
|
attr_accessor :custom_unit_amount
|
137
143
|
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
138
|
-
sig { returns(String) }
|
144
|
+
sig { returns(T.nilable(String)) }
|
139
145
|
attr_accessor :tax_behavior
|
140
146
|
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
|
141
|
-
sig {
|
147
|
+
sig {
|
148
|
+
returns(T.nilable(T::Array[::Stripe::PriceService::CreateParams::CurrencyOptions::Tier]))
|
149
|
+
}
|
142
150
|
attr_accessor :tiers
|
143
151
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
144
|
-
sig { returns(Integer) }
|
152
|
+
sig { returns(T.nilable(Integer)) }
|
145
153
|
attr_accessor :unit_amount
|
146
154
|
# 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.
|
147
|
-
sig { returns(String) }
|
155
|
+
sig { returns(T.nilable(String)) }
|
148
156
|
attr_accessor :unit_amount_decimal
|
149
157
|
sig {
|
150
|
-
params(custom_unit_amount: ::Stripe::PriceService::CreateParams::CurrencyOptions::CustomUnitAmount, tax_behavior: String, tiers: T::Array[::Stripe::PriceService::CreateParams::CurrencyOptions::Tier], unit_amount: Integer, unit_amount_decimal: String).void
|
158
|
+
params(custom_unit_amount: T.nilable(::Stripe::PriceService::CreateParams::CurrencyOptions::CustomUnitAmount), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::PriceService::CreateParams::CurrencyOptions::Tier]), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
|
151
159
|
}
|
152
160
|
def initialize(
|
153
161
|
custom_unit_amount: nil,
|
@@ -162,28 +170,28 @@ module Stripe
|
|
162
170
|
sig { returns(T::Boolean) }
|
163
171
|
attr_accessor :enabled
|
164
172
|
# The maximum unit amount the customer can specify for this item.
|
165
|
-
sig { returns(Integer) }
|
173
|
+
sig { returns(T.nilable(Integer)) }
|
166
174
|
attr_accessor :maximum
|
167
175
|
# The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
|
168
|
-
sig { returns(Integer) }
|
176
|
+
sig { returns(T.nilable(Integer)) }
|
169
177
|
attr_accessor :minimum
|
170
178
|
# The starting unit amount which can be updated by the customer.
|
171
|
-
sig { returns(Integer) }
|
179
|
+
sig { returns(T.nilable(Integer)) }
|
172
180
|
attr_accessor :preset
|
173
181
|
sig {
|
174
|
-
params(enabled: T::Boolean, maximum: Integer, minimum: Integer, preset: Integer).void
|
182
|
+
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
|
175
183
|
}
|
176
184
|
def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
|
177
185
|
end
|
178
186
|
class ProductData < Stripe::RequestParams
|
179
187
|
# Whether the product is currently available for purchase. Defaults to `true`.
|
180
|
-
sig { returns(T::Boolean) }
|
188
|
+
sig { returns(T.nilable(T::Boolean)) }
|
181
189
|
attr_accessor :active
|
182
190
|
# The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
|
183
|
-
sig { returns(String) }
|
191
|
+
sig { returns(T.nilable(String)) }
|
184
192
|
attr_accessor :id
|
185
193
|
# 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`.
|
186
|
-
sig { returns(T::Hash[String, String]) }
|
194
|
+
sig { returns(T.nilable(T::Hash[String, String])) }
|
187
195
|
attr_accessor :metadata
|
188
196
|
# The product's name, meant to be displayable to the customer.
|
189
197
|
sig { returns(String) }
|
@@ -191,16 +199,16 @@ module Stripe
|
|
191
199
|
# 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.
|
192
200
|
#
|
193
201
|
# 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.
|
194
|
-
sig { returns(String) }
|
202
|
+
sig { returns(T.nilable(String)) }
|
195
203
|
attr_accessor :statement_descriptor
|
196
204
|
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
|
197
|
-
sig { returns(String) }
|
205
|
+
sig { returns(T.nilable(String)) }
|
198
206
|
attr_accessor :tax_code
|
199
207
|
# A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
|
200
|
-
sig { returns(String) }
|
208
|
+
sig { returns(T.nilable(String)) }
|
201
209
|
attr_accessor :unit_label
|
202
210
|
sig {
|
203
|
-
params(active: T::Boolean, id: String, metadata: T::Hash[String, String], name: String, statement_descriptor: String, tax_code: String, unit_label: String).void
|
211
|
+
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
|
204
212
|
}
|
205
213
|
def initialize(
|
206
214
|
active: nil,
|
@@ -213,29 +221,25 @@ module Stripe
|
|
213
221
|
); end
|
214
222
|
end
|
215
223
|
class Recurring < Stripe::RequestParams
|
216
|
-
# Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`.
|
217
|
-
sig { returns(String) }
|
218
|
-
attr_accessor :aggregate_usage
|
219
224
|
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
220
225
|
sig { returns(String) }
|
221
226
|
attr_accessor :interval
|
222
227
|
# 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).
|
223
|
-
sig { returns(Integer) }
|
228
|
+
sig { returns(T.nilable(Integer)) }
|
224
229
|
attr_accessor :interval_count
|
225
230
|
# The meter tracking the usage of a metered price
|
226
|
-
sig { returns(String) }
|
231
|
+
sig { returns(T.nilable(String)) }
|
227
232
|
attr_accessor :meter
|
228
233
|
# Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
|
229
|
-
sig { returns(Integer) }
|
234
|
+
sig { returns(T.nilable(Integer)) }
|
230
235
|
attr_accessor :trial_period_days
|
231
236
|
# 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`.
|
232
|
-
sig { returns(String) }
|
237
|
+
sig { returns(T.nilable(String)) }
|
233
238
|
attr_accessor :usage_type
|
234
239
|
sig {
|
235
|
-
params(
|
240
|
+
params(interval: String, interval_count: T.nilable(Integer), meter: T.nilable(String), trial_period_days: T.nilable(Integer), usage_type: T.nilable(String)).void
|
236
241
|
}
|
237
242
|
def initialize(
|
238
|
-
aggregate_usage: nil,
|
239
243
|
interval: nil,
|
240
244
|
interval_count: nil,
|
241
245
|
meter: nil,
|
@@ -245,22 +249,22 @@ module Stripe
|
|
245
249
|
end
|
246
250
|
class Tier < Stripe::RequestParams
|
247
251
|
# The flat billing amount for an entire tier, regardless of the number of units in the tier.
|
248
|
-
sig { returns(Integer) }
|
252
|
+
sig { returns(T.nilable(Integer)) }
|
249
253
|
attr_accessor :flat_amount
|
250
254
|
# 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.
|
251
|
-
sig { returns(String) }
|
255
|
+
sig { returns(T.nilable(String)) }
|
252
256
|
attr_accessor :flat_amount_decimal
|
253
257
|
# The per unit billing amount for each individual unit for which this tier applies.
|
254
|
-
sig { returns(Integer) }
|
258
|
+
sig { returns(T.nilable(Integer)) }
|
255
259
|
attr_accessor :unit_amount
|
256
260
|
# 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.
|
257
|
-
sig { returns(String) }
|
261
|
+
sig { returns(T.nilable(String)) }
|
258
262
|
attr_accessor :unit_amount_decimal
|
259
263
|
# 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.
|
260
264
|
sig { returns(T.any(String, Integer)) }
|
261
265
|
attr_accessor :up_to
|
262
266
|
sig {
|
263
|
-
params(flat_amount: Integer, flat_amount_decimal: String, unit_amount: Integer, unit_amount_decimal: String, up_to: T.any(String, Integer)).void
|
267
|
+
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
|
264
268
|
}
|
265
269
|
def initialize(
|
266
270
|
flat_amount: nil,
|
@@ -281,64 +285,66 @@ module Stripe
|
|
281
285
|
def initialize(divide_by: nil, round: nil); end
|
282
286
|
end
|
283
287
|
# Whether the price can be used for new purchases. Defaults to `true`.
|
284
|
-
sig { returns(T::Boolean) }
|
288
|
+
sig { returns(T.nilable(T::Boolean)) }
|
285
289
|
attr_accessor :active
|
286
290
|
# Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices 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.
|
287
|
-
sig { returns(String) }
|
291
|
+
sig { returns(T.nilable(String)) }
|
288
292
|
attr_accessor :billing_scheme
|
289
293
|
# 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).
|
290
294
|
sig { returns(String) }
|
291
295
|
attr_accessor :currency
|
292
296
|
# Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
|
293
|
-
sig {
|
297
|
+
sig {
|
298
|
+
returns(T.nilable(T::Hash[String, ::Stripe::PriceService::CreateParams::CurrencyOptions]))
|
299
|
+
}
|
294
300
|
attr_accessor :currency_options
|
295
301
|
# When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
|
296
|
-
sig { returns(::Stripe::PriceService::CreateParams::CustomUnitAmount) }
|
302
|
+
sig { returns(T.nilable(::Stripe::PriceService::CreateParams::CustomUnitAmount)) }
|
297
303
|
attr_accessor :custom_unit_amount
|
298
304
|
# Specifies which fields in the response should be expanded.
|
299
|
-
sig { returns(T::Array[String]) }
|
305
|
+
sig { returns(T.nilable(T::Array[String])) }
|
300
306
|
attr_accessor :expand
|
301
307
|
# A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
|
302
|
-
sig { returns(String) }
|
308
|
+
sig { returns(T.nilable(String)) }
|
303
309
|
attr_accessor :lookup_key
|
304
310
|
# 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`.
|
305
|
-
sig { returns(T::Hash[String, String]) }
|
311
|
+
sig { returns(T.nilable(T::Hash[String, String])) }
|
306
312
|
attr_accessor :metadata
|
307
313
|
# A brief description of the price, hidden from customers.
|
308
|
-
sig { returns(String) }
|
314
|
+
sig { returns(T.nilable(String)) }
|
309
315
|
attr_accessor :nickname
|
310
|
-
# The ID of the
|
311
|
-
sig { returns(String) }
|
316
|
+
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
|
317
|
+
sig { returns(T.nilable(String)) }
|
312
318
|
attr_accessor :product
|
313
319
|
# These fields can be used to create a new product that this price will belong to.
|
314
|
-
sig { returns(::Stripe::PriceService::CreateParams::ProductData) }
|
320
|
+
sig { returns(T.nilable(::Stripe::PriceService::CreateParams::ProductData)) }
|
315
321
|
attr_accessor :product_data
|
316
322
|
# The recurring components of a price such as `interval` and `usage_type`.
|
317
|
-
sig { returns(::Stripe::PriceService::CreateParams::Recurring) }
|
323
|
+
sig { returns(T.nilable(::Stripe::PriceService::CreateParams::Recurring)) }
|
318
324
|
attr_accessor :recurring
|
319
325
|
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
320
|
-
sig { returns(String) }
|
326
|
+
sig { returns(T.nilable(String)) }
|
321
327
|
attr_accessor :tax_behavior
|
322
328
|
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
|
323
|
-
sig { returns(T::Array[::Stripe::PriceService::CreateParams::Tier]) }
|
329
|
+
sig { returns(T.nilable(T::Array[::Stripe::PriceService::CreateParams::Tier])) }
|
324
330
|
attr_accessor :tiers
|
325
331
|
# 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.
|
326
|
-
sig { returns(String) }
|
332
|
+
sig { returns(T.nilable(String)) }
|
327
333
|
attr_accessor :tiers_mode
|
328
334
|
# If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
|
329
|
-
sig { returns(T::Boolean) }
|
335
|
+
sig { returns(T.nilable(T::Boolean)) }
|
330
336
|
attr_accessor :transfer_lookup_key
|
331
337
|
# Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`.
|
332
|
-
sig { returns(::Stripe::PriceService::CreateParams::TransformQuantity) }
|
338
|
+
sig { returns(T.nilable(::Stripe::PriceService::CreateParams::TransformQuantity)) }
|
333
339
|
attr_accessor :transform_quantity
|
334
340
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required, unless `billing_scheme=tiered`.
|
335
|
-
sig { returns(Integer) }
|
341
|
+
sig { returns(T.nilable(Integer)) }
|
336
342
|
attr_accessor :unit_amount
|
337
343
|
# 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.
|
338
|
-
sig { returns(String) }
|
344
|
+
sig { returns(T.nilable(String)) }
|
339
345
|
attr_accessor :unit_amount_decimal
|
340
346
|
sig {
|
341
|
-
params(active: T::Boolean, billing_scheme: String, currency: String, currency_options: T::Hash[String, ::Stripe::PriceService::CreateParams::CurrencyOptions], custom_unit_amount: ::Stripe::PriceService::CreateParams::CustomUnitAmount, expand: T::Array[String], lookup_key: String, metadata: T::Hash[String, String], nickname: String, product: String, product_data: ::Stripe::PriceService::CreateParams::ProductData, recurring: ::Stripe::PriceService::CreateParams::Recurring, tax_behavior: String, tiers: T::Array[::Stripe::PriceService::CreateParams::Tier], tiers_mode: String, transfer_lookup_key: T::Boolean, transform_quantity: ::Stripe::PriceService::CreateParams::TransformQuantity, unit_amount: Integer, unit_amount_decimal: String).void
|
347
|
+
params(active: T.nilable(T::Boolean), billing_scheme: T.nilable(String), currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::PriceService::CreateParams::CurrencyOptions]), custom_unit_amount: T.nilable(::Stripe::PriceService::CreateParams::CustomUnitAmount), expand: T.nilable(T::Array[String]), lookup_key: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), nickname: T.nilable(String), product: T.nilable(String), product_data: T.nilable(::Stripe::PriceService::CreateParams::ProductData), recurring: T.nilable(::Stripe::PriceService::CreateParams::Recurring), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::PriceService::CreateParams::Tier]), tiers_mode: T.nilable(String), transfer_lookup_key: T.nilable(T::Boolean), transform_quantity: T.nilable(::Stripe::PriceService::CreateParams::TransformQuantity), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
|
342
348
|
}
|
343
349
|
def initialize(
|
344
350
|
active: nil,
|
@@ -364,9 +370,9 @@ module Stripe
|
|
364
370
|
end
|
365
371
|
class RetrieveParams < Stripe::RequestParams
|
366
372
|
# Specifies which fields in the response should be expanded.
|
367
|
-
sig { returns(T::Array[String]) }
|
373
|
+
sig { returns(T.nilable(T::Array[String])) }
|
368
374
|
attr_accessor :expand
|
369
|
-
sig { params(expand: T::Array[String]).void }
|
375
|
+
sig { params(expand: T.nilable(T::Array[String])).void }
|
370
376
|
def initialize(expand: nil); end
|
371
377
|
end
|
372
378
|
class UpdateParams < Stripe::RequestParams
|
@@ -376,37 +382,37 @@ module Stripe
|
|
376
382
|
sig { returns(T::Boolean) }
|
377
383
|
attr_accessor :enabled
|
378
384
|
# The maximum unit amount the customer can specify for this item.
|
379
|
-
sig { returns(Integer) }
|
385
|
+
sig { returns(T.nilable(Integer)) }
|
380
386
|
attr_accessor :maximum
|
381
387
|
# The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
|
382
|
-
sig { returns(Integer) }
|
388
|
+
sig { returns(T.nilable(Integer)) }
|
383
389
|
attr_accessor :minimum
|
384
390
|
# The starting unit amount which can be updated by the customer.
|
385
|
-
sig { returns(Integer) }
|
391
|
+
sig { returns(T.nilable(Integer)) }
|
386
392
|
attr_accessor :preset
|
387
393
|
sig {
|
388
|
-
params(enabled: T::Boolean, maximum: Integer, minimum: Integer, preset: Integer).void
|
394
|
+
params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
|
389
395
|
}
|
390
396
|
def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
|
391
397
|
end
|
392
398
|
class Tier < Stripe::RequestParams
|
393
399
|
# The flat billing amount for an entire tier, regardless of the number of units in the tier.
|
394
|
-
sig { returns(Integer) }
|
400
|
+
sig { returns(T.nilable(Integer)) }
|
395
401
|
attr_accessor :flat_amount
|
396
402
|
# 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.
|
397
|
-
sig { returns(String) }
|
403
|
+
sig { returns(T.nilable(String)) }
|
398
404
|
attr_accessor :flat_amount_decimal
|
399
405
|
# The per unit billing amount for each individual unit for which this tier applies.
|
400
|
-
sig { returns(Integer) }
|
406
|
+
sig { returns(T.nilable(Integer)) }
|
401
407
|
attr_accessor :unit_amount
|
402
408
|
# 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.
|
403
|
-
sig { returns(String) }
|
409
|
+
sig { returns(T.nilable(String)) }
|
404
410
|
attr_accessor :unit_amount_decimal
|
405
411
|
# 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.
|
406
412
|
sig { returns(T.any(String, Integer)) }
|
407
413
|
attr_accessor :up_to
|
408
414
|
sig {
|
409
|
-
params(flat_amount: Integer, flat_amount_decimal: String, unit_amount: Integer, unit_amount_decimal: String, up_to: T.any(String, Integer)).void
|
415
|
+
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
|
410
416
|
}
|
411
417
|
def initialize(
|
412
418
|
flat_amount: nil,
|
@@ -417,22 +423,26 @@ module Stripe
|
|
417
423
|
); end
|
418
424
|
end
|
419
425
|
# When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
|
420
|
-
sig {
|
426
|
+
sig {
|
427
|
+
returns(T.nilable(::Stripe::PriceService::UpdateParams::CurrencyOptions::CustomUnitAmount))
|
428
|
+
}
|
421
429
|
attr_accessor :custom_unit_amount
|
422
430
|
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
423
|
-
sig { returns(String) }
|
431
|
+
sig { returns(T.nilable(String)) }
|
424
432
|
attr_accessor :tax_behavior
|
425
433
|
# Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
|
426
|
-
sig {
|
434
|
+
sig {
|
435
|
+
returns(T.nilable(T::Array[::Stripe::PriceService::UpdateParams::CurrencyOptions::Tier]))
|
436
|
+
}
|
427
437
|
attr_accessor :tiers
|
428
438
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
429
|
-
sig { returns(Integer) }
|
439
|
+
sig { returns(T.nilable(Integer)) }
|
430
440
|
attr_accessor :unit_amount
|
431
441
|
# 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.
|
432
|
-
sig { returns(String) }
|
442
|
+
sig { returns(T.nilable(String)) }
|
433
443
|
attr_accessor :unit_amount_decimal
|
434
444
|
sig {
|
435
|
-
params(custom_unit_amount: ::Stripe::PriceService::UpdateParams::CurrencyOptions::CustomUnitAmount, tax_behavior: String, tiers: T::Array[::Stripe::PriceService::UpdateParams::CurrencyOptions::Tier], unit_amount: Integer, unit_amount_decimal: String).void
|
445
|
+
params(custom_unit_amount: T.nilable(::Stripe::PriceService::UpdateParams::CurrencyOptions::CustomUnitAmount), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::PriceService::UpdateParams::CurrencyOptions::Tier]), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
|
436
446
|
}
|
437
447
|
def initialize(
|
438
448
|
custom_unit_amount: nil,
|
@@ -442,50 +452,34 @@ module Stripe
|
|
442
452
|
unit_amount_decimal: nil
|
443
453
|
); end
|
444
454
|
end
|
445
|
-
class MigrateTo < Stripe::RequestParams
|
446
|
-
# The behavior controlling the point in the subscription lifecycle after which to migrate the price. Currently must be `at_cycle_end`.
|
447
|
-
sig { returns(String) }
|
448
|
-
attr_accessor :behavior
|
449
|
-
# The time after which subscriptions should start using the new price.
|
450
|
-
sig { returns(Integer) }
|
451
|
-
attr_accessor :effective_after
|
452
|
-
# The ID of the price object.
|
453
|
-
sig { returns(String) }
|
454
|
-
attr_accessor :price
|
455
|
-
sig { params(behavior: String, effective_after: Integer, price: String).void }
|
456
|
-
def initialize(behavior: nil, effective_after: nil, price: nil); end
|
457
|
-
end
|
458
455
|
# Whether the price can be used for new purchases. Defaults to `true`.
|
459
|
-
sig { returns(T::Boolean) }
|
456
|
+
sig { returns(T.nilable(T::Boolean)) }
|
460
457
|
attr_accessor :active
|
461
458
|
# Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
|
462
459
|
sig {
|
463
|
-
returns(T.nilable(T::Hash[String, ::Stripe::PriceService::UpdateParams::CurrencyOptions]))
|
460
|
+
returns(T.nilable(T.nilable(T.any(String, T::Hash[String, ::Stripe::PriceService::UpdateParams::CurrencyOptions]))))
|
464
461
|
}
|
465
462
|
attr_accessor :currency_options
|
466
463
|
# Specifies which fields in the response should be expanded.
|
467
|
-
sig { returns(T::Array[String]) }
|
464
|
+
sig { returns(T.nilable(T::Array[String])) }
|
468
465
|
attr_accessor :expand
|
469
466
|
# A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
|
470
|
-
sig { returns(String) }
|
467
|
+
sig { returns(T.nilable(String)) }
|
471
468
|
attr_accessor :lookup_key
|
472
469
|
# 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`.
|
473
|
-
sig { returns(T.nilable(T::Hash[String, String])) }
|
470
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
|
474
471
|
attr_accessor :metadata
|
475
|
-
# If specified, subscriptions using this price will be updated to use the new referenced price.
|
476
|
-
sig { returns(T.nilable(::Stripe::PriceService::UpdateParams::MigrateTo)) }
|
477
|
-
attr_accessor :migrate_to
|
478
472
|
# A brief description of the price, hidden from customers.
|
479
|
-
sig { returns(String) }
|
473
|
+
sig { returns(T.nilable(String)) }
|
480
474
|
attr_accessor :nickname
|
481
475
|
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
482
|
-
sig { returns(String) }
|
476
|
+
sig { returns(T.nilable(String)) }
|
483
477
|
attr_accessor :tax_behavior
|
484
478
|
# If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.
|
485
|
-
sig { returns(T::Boolean) }
|
479
|
+
sig { returns(T.nilable(T::Boolean)) }
|
486
480
|
attr_accessor :transfer_lookup_key
|
487
481
|
sig {
|
488
|
-
params(active: T::Boolean, currency_options: T.nilable(T::Hash[String, ::Stripe::PriceService::UpdateParams::CurrencyOptions]), expand: T::Array[String], lookup_key: String, metadata: T.nilable(T::Hash[String, String]),
|
482
|
+
params(active: T.nilable(T::Boolean), currency_options: T.nilable(T.nilable(T.any(String, T::Hash[String, ::Stripe::PriceService::UpdateParams::CurrencyOptions]))), expand: T.nilable(T::Array[String]), lookup_key: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), nickname: T.nilable(String), tax_behavior: T.nilable(String), transfer_lookup_key: T.nilable(T::Boolean)).void
|
489
483
|
}
|
490
484
|
def initialize(
|
491
485
|
active: nil,
|
@@ -493,7 +487,6 @@ module Stripe
|
|
493
487
|
expand: nil,
|
494
488
|
lookup_key: nil,
|
495
489
|
metadata: nil,
|
496
|
-
migrate_to: nil,
|
497
490
|
nickname: nil,
|
498
491
|
tax_behavior: nil,
|
499
492
|
transfer_lookup_key: nil
|
@@ -501,21 +494,23 @@ module Stripe
|
|
501
494
|
end
|
502
495
|
class SearchParams < Stripe::RequestParams
|
503
496
|
# Specifies which fields in the response should be expanded.
|
504
|
-
sig { returns(T::Array[String]) }
|
497
|
+
sig { returns(T.nilable(T::Array[String])) }
|
505
498
|
attr_accessor :expand
|
506
499
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
507
|
-
sig { returns(Integer) }
|
500
|
+
sig { returns(T.nilable(Integer)) }
|
508
501
|
attr_accessor :limit
|
509
502
|
# A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
|
510
|
-
sig { returns(String) }
|
503
|
+
sig { returns(T.nilable(String)) }
|
511
504
|
attr_accessor :page
|
512
505
|
# The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for prices](https://stripe.com/docs/search#query-fields-for-prices).
|
513
506
|
sig { returns(String) }
|
514
507
|
attr_accessor :query
|
515
|
-
sig {
|
508
|
+
sig {
|
509
|
+
params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
|
510
|
+
}
|
516
511
|
def initialize(expand: nil, limit: nil, page: nil, query: nil); end
|
517
512
|
end
|
518
|
-
# Creates a new
|
513
|
+
# Creates a new [Price for an existing <a href="https://docs.stripe.com/api/products">Product](https://docs.stripe.com/api/prices). The Price can be recurring or one-time.
|
519
514
|
sig {
|
520
515
|
params(params: T.any(::Stripe::PriceService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Price)
|
521
516
|
}
|
@@ -9,26 +9,26 @@ module Stripe
|
|
9
9
|
end
|
10
10
|
class RetrieveParams < Stripe::RequestParams
|
11
11
|
# Specifies which fields in the response should be expanded.
|
12
|
-
sig { returns(T::Array[String]) }
|
12
|
+
sig { returns(T.nilable(T::Array[String])) }
|
13
13
|
attr_accessor :expand
|
14
|
-
sig { params(expand: T::Array[String]).void }
|
14
|
+
sig { params(expand: T.nilable(T::Array[String])).void }
|
15
15
|
def initialize(expand: nil); end
|
16
16
|
end
|
17
17
|
class ListParams < Stripe::RequestParams
|
18
18
|
# 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.
|
19
|
-
sig { returns(String) }
|
19
|
+
sig { returns(T.nilable(String)) }
|
20
20
|
attr_accessor :ending_before
|
21
21
|
# Specifies which fields in the response should be expanded.
|
22
|
-
sig { returns(T::Array[String]) }
|
22
|
+
sig { returns(T.nilable(T::Array[String])) }
|
23
23
|
attr_accessor :expand
|
24
24
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
25
|
-
sig { returns(Integer) }
|
25
|
+
sig { returns(T.nilable(Integer)) }
|
26
26
|
attr_accessor :limit
|
27
27
|
# 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.
|
28
|
-
sig { returns(String) }
|
28
|
+
sig { returns(T.nilable(String)) }
|
29
29
|
attr_accessor :starting_after
|
30
30
|
sig {
|
31
|
-
params(ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String).void
|
31
|
+
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
|
32
32
|
}
|
33
33
|
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
|
34
34
|
end
|
@@ -37,9 +37,9 @@ module Stripe
|
|
37
37
|
sig { returns(String) }
|
38
38
|
attr_accessor :entitlement_feature
|
39
39
|
# Specifies which fields in the response should be expanded.
|
40
|
-
sig { returns(T::Array[String]) }
|
40
|
+
sig { returns(T.nilable(T::Array[String])) }
|
41
41
|
attr_accessor :expand
|
42
|
-
sig { params(entitlement_feature: String, expand: T::Array[String]).void }
|
42
|
+
sig { params(entitlement_feature: String, expand: T.nilable(T::Array[String])).void }
|
43
43
|
def initialize(entitlement_feature: nil, expand: nil); end
|
44
44
|
end
|
45
45
|
# Creates a product_feature, which represents a feature attachment to a product
|