stripe 13.4.0.pre.beta.1 → 13.4.0.pre.beta.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +12 -1
- data/OPENAPI_VERSION +1 -1
- data/VERSION +1 -1
- data/lib/stripe/resources/account.rb +23 -745
- data/lib/stripe/resources/account_link.rb +0 -10
- data/lib/stripe/resources/account_notice.rb +0 -22
- data/lib/stripe/resources/account_session.rb +0 -125
- data/lib/stripe/resources/apple_pay_domain.rb +0 -10
- data/lib/stripe/resources/application.rb +0 -3
- data/lib/stripe/resources/application_fee.rb +0 -24
- data/lib/stripe/resources/application_fee_refund.rb +0 -7
- data/lib/stripe/resources/apps/secret.rb +0 -25
- data/lib/stripe/resources/balance.rb +0 -31
- data/lib/stripe/resources/balance_transaction.rb +0 -29
- data/lib/stripe/resources/bank_account.rb +0 -29
- data/lib/stripe/resources/billing/alert.rb +0 -22
- data/lib/stripe/resources/billing/alert_triggered.rb +0 -5
- data/lib/stripe/resources/billing/credit_balance_summary.rb +0 -12
- data/lib/stripe/resources/billing/credit_balance_transaction.rb +0 -24
- data/lib/stripe/resources/billing/credit_grant.rb +0 -32
- data/lib/stripe/resources/billing/meter.rb +0 -25
- data/lib/stripe/resources/billing/meter_error_report.rb +0 -11
- data/lib/stripe/resources/billing/meter_event.rb +0 -10
- data/lib/stripe/resources/billing/meter_event_adjustment.rb +0 -8
- data/lib/stripe/resources/billing/meter_event_summary.rb +0 -6
- data/lib/stripe/resources/billing_portal/configuration.rb +0 -77
- data/lib/stripe/resources/billing_portal/session.rb +0 -42
- data/lib/stripe/resources/capability.rb +2 -29
- data/lib/stripe/resources/capital/financing_offer.rb +0 -33
- data/lib/stripe/resources/capital/financing_summary.rb +0 -13
- data/lib/stripe/resources/capital/financing_transaction.rb +0 -24
- data/lib/stripe/resources/card.rb +2 -34
- data/lib/stripe/resources/cash_balance.rb +0 -5
- data/lib/stripe/resources/charge.rb +4 -665
- data/lib/stripe/resources/checkout/session.rb +4 -512
- data/lib/stripe/resources/climate/order.rb +0 -40
- data/lib/stripe/resources/climate/product.rb +0 -13
- data/lib/stripe/resources/climate/supplier.rb +0 -13
- data/lib/stripe/resources/confirmation_token.rb +2 -337
- data/lib/stripe/resources/connect_collection_transfer.rb +0 -5
- data/lib/stripe/resources/country_spec.rb +0 -13
- data/lib/stripe/resources/coupon.rb +0 -39
- data/lib/stripe/resources/credit_note.rb +0 -138
- data/lib/stripe/resources/credit_note_line_item.rb +0 -24
- data/lib/stripe/resources/customer.rb +1 -156
- data/lib/stripe/resources/customer_balance_transaction.rb +0 -12
- data/lib/stripe/resources/customer_cash_balance_transaction.rb +0 -27
- data/lib/stripe/resources/customer_session.rb +0 -24
- data/lib/stripe/resources/discount.rb +0 -12
- data/lib/stripe/resources/dispute.rb +4 -152
- data/lib/stripe/resources/entitlements/active_entitlement.rb +0 -8
- data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +0 -3
- data/lib/stripe/resources/entitlements/feature.rb +0 -17
- data/lib/stripe/resources/ephemeral_key.rb +0 -5
- data/lib/stripe/resources/event.rb +0 -27
- data/lib/stripe/resources/exchange_rate.rb +0 -5
- data/lib/stripe/resources/file.rb +0 -23
- data/lib/stripe/resources/file_link.rb +0 -22
- data/lib/stripe/resources/financial_connections/account.rb +0 -47
- data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -3
- data/lib/stripe/resources/financial_connections/account_owner.rb +0 -7
- data/lib/stripe/resources/financial_connections/account_ownership.rb +0 -3
- data/lib/stripe/resources/financial_connections/institution.rb +0 -13
- data/lib/stripe/resources/financial_connections/session.rb +0 -28
- data/lib/stripe/resources/financial_connections/transaction.rb +0 -21
- data/lib/stripe/resources/forwarding/request.rb +0 -31
- data/lib/stripe/resources/funding_instructions.rb +0 -107
- data/lib/stripe/resources/gift_cards/card.rb +0 -28
- data/lib/stripe/resources/gift_cards/transaction.rb +0 -32
- data/lib/stripe/resources/identity/verification_report.rb +0 -69
- data/lib/stripe/resources/identity/verification_session.rb +0 -69
- data/lib/stripe/resources/invoice.rb +6 -1276
- data/lib/stripe/resources/invoice_item.rb +0 -91
- data/lib/stripe/resources/invoice_line_item.rb +0 -76
- data/lib/stripe/resources/invoice_payment.rb +0 -16
- data/lib/stripe/resources/invoice_rendering_template.rb +0 -12
- data/lib/stripe/resources/issuing/authorization.rb +0 -199
- data/lib/stripe/resources/issuing/card.rb +0 -128
- data/lib/stripe/resources/issuing/cardholder.rb +0 -110
- data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -82
- data/lib/stripe/resources/issuing/dispute.rb +0 -151
- data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -14
- data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -14
- data/lib/stripe/resources/issuing/personalization_design.rb +0 -48
- data/lib/stripe/resources/issuing/physical_bundle.rb +0 -13
- data/lib/stripe/resources/issuing/settlement.rb +0 -16
- data/lib/stripe/resources/issuing/token.rb +0 -46
- data/lib/stripe/resources/issuing/transaction.rb +0 -171
- data/lib/stripe/resources/line_item.rb +0 -23
- data/lib/stripe/resources/login_link.rb +0 -2
- data/lib/stripe/resources/mandate.rb +0 -45
- data/lib/stripe/resources/margin.rb +0 -19
- data/lib/stripe/resources/order.rb +3 -391
- data/lib/stripe/resources/payment_attempt_record.rb +0 -42
- data/lib/stripe/resources/payment_intent.rb +2 -1768
- data/lib/stripe/resources/payment_link.rb +15 -213
- data/lib/stripe/resources/payment_method.rb +2 -345
- data/lib/stripe/resources/payment_method_configuration.rb +0 -293
- data/lib/stripe/resources/payment_method_domain.rb +0 -23
- data/lib/stripe/resources/payment_record.rb +0 -109
- data/lib/stripe/resources/payout.rb +0 -49
- data/lib/stripe/resources/person.rb +2 -92
- data/lib/stripe/resources/plan.rb +0 -69
- data/lib/stripe/resources/price.rb +0 -133
- data/lib/stripe/resources/product.rb +0 -100
- data/lib/stripe/resources/product_feature.rb +0 -4
- data/lib/stripe/resources/promotion_code.rb +0 -40
- data/lib/stripe/resources/quote.rb +0 -458
- data/lib/stripe/resources/quote_line.rb +0 -66
- data/lib/stripe/resources/quote_preview_invoice.rb +3 -184
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -101
- data/lib/stripe/resources/radar/early_fraud_warning.rb +0 -16
- data/lib/stripe/resources/radar/value_list.rb +0 -26
- data/lib/stripe/resources/radar/value_list_item.rb +0 -18
- data/lib/stripe/resources/refund.rb +0 -92
- data/lib/stripe/resources/reporting/report_run.rb +0 -32
- data/lib/stripe/resources/reporting/report_type.rb +0 -8
- data/lib/stripe/resources/reserve_transaction.rb +0 -4
- data/lib/stripe/resources/reversal.rb +0 -9
- data/lib/stripe/resources/review.rb +0 -27
- data/lib/stripe/resources/setup_attempt.rb +2 -103
- data/lib/stripe/resources/setup_intent.rb +2 -539
- data/lib/stripe/resources/shipping_rate.rb +0 -44
- data/lib/stripe/resources/sigma/scheduled_query_run.rb +0 -13
- data/lib/stripe/resources/source.rb +6 -338
- data/lib/stripe/resources/source_mandate_notification.rb +0 -13
- data/lib/stripe/resources/source_transaction.rb +0 -29
- data/lib/stripe/resources/subscription.rb +0 -338
- data/lib/stripe/resources/subscription_item.rb +0 -69
- data/lib/stripe/resources/subscription_schedule.rb +0 -388
- data/lib/stripe/resources/tax/association.rb +0 -11
- data/lib/stripe/resources/tax/calculation.rb +2 -89
- data/lib/stripe/resources/tax/calculation_line_item.rb +0 -20
- data/lib/stripe/resources/tax/form.rb +2 -35
- data/lib/stripe/resources/tax/registration.rb +421 -213
- data/lib/stripe/resources/tax/settings.rb +0 -20
- data/lib/stripe/resources/tax/transaction.rb +1 -66
- data/lib/stripe/resources/tax/transaction_line_item.rb +0 -12
- data/lib/stripe/resources/tax_code.rb +0 -6
- data/lib/stripe/resources/tax_deducted_at_source.rb +0 -4
- data/lib/stripe/resources/tax_id.rb +2 -28
- data/lib/stripe/resources/tax_rate.rb +0 -45
- data/lib/stripe/resources/terminal/configuration.rb +0 -164
- data/lib/stripe/resources/terminal/connection_token.rb +0 -3
- data/lib/stripe/resources/terminal/location.rb +0 -33
- data/lib/stripe/resources/terminal/reader.rb +0 -129
- data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -5
- data/lib/stripe/resources/test_helpers/test_clock.rb +0 -15
- data/lib/stripe/resources/token.rb +4 -192
- data/lib/stripe/resources/topup.rb +0 -36
- data/lib/stripe/resources/transfer.rb +0 -35
- data/lib/stripe/resources/treasury/credit_reversal.rb +0 -21
- data/lib/stripe/resources/treasury/debit_reversal.rb +0 -23
- data/lib/stripe/resources/treasury/financial_account.rb +77 -71
- data/lib/stripe/resources/treasury/financial_account_features.rb +0 -46
- data/lib/stripe/resources/treasury/inbound_transfer.rb +0 -50
- data/lib/stripe/resources/treasury/outbound_payment.rb +0 -92
- data/lib/stripe/resources/treasury/outbound_transfer.rb +25 -66
- data/lib/stripe/resources/treasury/received_credit.rb +6 -58
- data/lib/stripe/resources/treasury/received_debit.rb +0 -54
- data/lib/stripe/resources/treasury/transaction.rb +0 -39
- data/lib/stripe/resources/treasury/transaction_entry.rb +0 -36
- data/lib/stripe/resources/usage_record.rb +0 -5
- data/lib/stripe/resources/usage_record_summary.rb +0 -7
- data/lib/stripe/resources/v2/billing/meter_event.rb +0 -6
- data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +0 -7
- data/lib/stripe/resources/v2/billing/meter_event_session.rb +0 -5
- data/lib/stripe/resources/v2/event.rb +0 -8
- data/lib/stripe/resources/v2/event_destination.rb +0 -19
- data/lib/stripe/resources/webhook_endpoint.rb +0 -26
- data/lib/stripe/services/account_capability_service.rb +0 -1
- data/lib/stripe/services/account_external_account_service.rb +0 -43
- data/lib/stripe/services/account_link_service.rb +0 -7
- data/lib/stripe/services/account_notice_service.rb +0 -9
- data/lib/stripe/services/account_person_service.rb +0 -139
- data/lib/stripe/services/account_service.rb +8 -519
- data/lib/stripe/services/account_session_service.rb +0 -76
- data/lib/stripe/services/apple_pay_domain_service.rb +0 -5
- data/lib/stripe/services/application_fee_refund_service.rb +0 -6
- data/lib/stripe/services/application_fee_service.rb +0 -8
- data/lib/stripe/services/apps/secret_service.rb +0 -16
- data/lib/stripe/services/balance_transaction_service.rb +0 -11
- data/lib/stripe/services/billing/alert_service.rb +0 -12
- data/lib/stripe/services/billing/credit_balance_summary_service.rb +0 -4
- data/lib/stripe/services/billing/credit_balance_transaction_service.rb +0 -5
- data/lib/stripe/services/billing/credit_grant_service.rb +0 -16
- data/lib/stripe/services/billing/meter_event_adjustment_service.rb +0 -3
- data/lib/stripe/services/billing/meter_event_service.rb +0 -4
- data/lib/stripe/services/billing/meter_event_summary_service.rb +0 -7
- data/lib/stripe/services/billing/meter_service.rb +0 -12
- data/lib/stripe/services/billing_portal/configuration_service.rb +0 -48
- data/lib/stripe/services/billing_portal/session_service.rb +0 -19
- data/lib/stripe/services/capital/financing_offer_service.rb +0 -9
- data/lib/stripe/services/capital/financing_transaction_service.rb +0 -7
- data/lib/stripe/services/charge_service.rb +0 -274
- data/lib/stripe/services/checkout/session_line_item_service.rb +0 -3
- data/lib/stripe/services/checkout/session_service.rb +2 -273
- data/lib/stripe/services/climate/order_service.rb +0 -11
- data/lib/stripe/services/climate/product_service.rb +0 -3
- data/lib/stripe/services/climate/supplier_service.rb +0 -3
- data/lib/stripe/services/country_spec_service.rb +0 -3
- data/lib/stripe/services/coupon_service.rb +0 -22
- data/lib/stripe/services/credit_note_line_item_service.rb +0 -3
- data/lib/stripe/services/credit_note_preview_lines_service.rb +0 -28
- data/lib/stripe/services/credit_note_service.rb +0 -61
- data/lib/stripe/services/customer_balance_transaction_service.rb +0 -9
- data/lib/stripe/services/customer_cash_balance_service.rb +0 -1
- data/lib/stripe/services/customer_cash_balance_transaction_service.rb +0 -3
- data/lib/stripe/services/customer_funding_instructions_service.rb +0 -5
- data/lib/stripe/services/customer_payment_method_service.rb +0 -5
- data/lib/stripe/services/customer_payment_source_service.rb +0 -29
- data/lib/stripe/services/customer_service.rb +1 -92
- data/lib/stripe/services/customer_session_service.rb +0 -10
- data/lib/stripe/services/customer_tax_id_service.rb +1 -6
- data/lib/stripe/services/dispute_service.rb +2 -67
- data/lib/stripe/services/entitlements/active_entitlement_service.rb +0 -4
- data/lib/stripe/services/entitlements/feature_service.rb +0 -11
- data/lib/stripe/services/ephemeral_key_service.rb +0 -4
- data/lib/stripe/services/event_service.rb +0 -10
- data/lib/stripe/services/exchange_rate_service.rb +0 -3
- data/lib/stripe/services/file_link_service.rb +0 -14
- data/lib/stripe/services/file_service.rb +0 -13
- data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +0 -3
- data/lib/stripe/services/financial_connections/account_owner_service.rb +0 -4
- data/lib/stripe/services/financial_connections/account_service.rb +0 -9
- data/lib/stripe/services/financial_connections/institution_service.rb +0 -3
- data/lib/stripe/services/financial_connections/session_service.rb +0 -11
- data/lib/stripe/services/financial_connections/transaction_service.rb +0 -9
- data/lib/stripe/services/forwarding/request_service.rb +0 -14
- data/lib/stripe/services/gift_cards/card_service.rb +0 -13
- data/lib/stripe/services/gift_cards/transaction_service.rb +0 -16
- data/lib/stripe/services/identity/verification_report_service.rb +0 -10
- data/lib/stripe/services/identity/verification_session_service.rb +0 -30
- data/lib/stripe/services/invoice_item_service.rb +0 -66
- data/lib/stripe/services/invoice_line_item_service.rb +0 -40
- data/lib/stripe/services/invoice_payment_service.rb +0 -3
- data/lib/stripe/services/invoice_rendering_template_service.rb +0 -5
- data/lib/stripe/services/invoice_service.rb +2 -810
- data/lib/stripe/services/invoice_upcoming_lines_service.rb +1 -279
- data/lib/stripe/services/issuing/authorization_service.rb +0 -14
- data/lib/stripe/services/issuing/card_service.rb +0 -70
- data/lib/stripe/services/issuing/cardholder_service.rb +0 -73
- data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -56
- data/lib/stripe/services/issuing/dispute_service.rb +0 -98
- data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -4
- data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -7
- data/lib/stripe/services/issuing/personalization_design_service.rb +0 -29
- data/lib/stripe/services/issuing/physical_bundle_service.rb +0 -5
- data/lib/stripe/services/issuing/token_service.rb +0 -10
- data/lib/stripe/services/issuing/transaction_service.rb +0 -12
- data/lib/stripe/services/margin_service.rb +0 -11
- data/lib/stripe/services/order_line_item_service.rb +0 -3
- data/lib/stripe/services/order_service.rb +2 -266
- data/lib/stripe/services/payment_attempt_record_service.rb +0 -1
- data/lib/stripe/services/payment_intent_service.rb +0 -1309
- data/lib/stripe/services/payment_link_line_item_service.rb +0 -3
- data/lib/stripe/services/payment_link_service.rb +15 -135
- data/lib/stripe/services/payment_method_configuration_service.rb +0 -102
- data/lib/stripe/services/payment_method_domain_service.rb +0 -8
- data/lib/stripe/services/payment_method_service.rb +0 -113
- data/lib/stripe/services/payment_record_service.rb +0 -68
- data/lib/stripe/services/payout_service.rb +0 -23
- data/lib/stripe/services/plan_service.rb +0 -43
- data/lib/stripe/services/price_service.rb +0 -87
- data/lib/stripe/services/product_feature_service.rb +0 -4
- data/lib/stripe/services/product_service.rb +0 -74
- data/lib/stripe/services/promotion_code_service.rb +0 -25
- data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +0 -3
- data/lib/stripe/services/quote_line_item_service.rb +0 -3
- data/lib/stripe/services/quote_line_service.rb +0 -3
- data/lib/stripe/services/quote_preview_invoice_service.rb +0 -3
- data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -3
- data/lib/stripe/services/quote_service.rb +0 -309
- data/lib/stripe/services/radar/early_fraud_warning_service.rb +0 -9
- data/lib/stripe/services/radar/value_list_item_service.rb +0 -11
- data/lib/stripe/services/radar/value_list_service.rb +0 -16
- data/lib/stripe/services/refund_service.rb +0 -21
- data/lib/stripe/services/reporting/report_run_service.rb +0 -16
- data/lib/stripe/services/review_service.rb +0 -7
- data/lib/stripe/services/setup_attempt_service.rb +0 -8
- data/lib/stripe/services/setup_intent_service.rb +0 -447
- data/lib/stripe/services/shipping_rate_service.rb +0 -27
- data/lib/stripe/services/sigma/scheduled_query_run_service.rb +0 -3
- data/lib/stripe/services/source_service.rb +0 -92
- data/lib/stripe/services/source_transaction_service.rb +0 -3
- data/lib/stripe/services/subscription_item_service.rb +0 -56
- data/lib/stripe/services/subscription_item_usage_record_service.rb +0 -3
- data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +0 -3
- data/lib/stripe/services/subscription_schedule_service.rb +0 -290
- data/lib/stripe/services/subscription_service.rb +0 -245
- data/lib/stripe/services/tax/association_service.rb +0 -1
- data/lib/stripe/services/tax/calculation_line_item_service.rb +0 -3
- data/lib/stripe/services/tax/calculation_service.rb +1 -31
- data/lib/stripe/services/tax/form_service.rb +0 -7
- data/lib/stripe/services/tax/registration_service.rb +274 -108
- data/lib/stripe/services/tax/settings_service.rb +0 -8
- data/lib/stripe/services/tax/transaction_line_item_service.rb +0 -3
- data/lib/stripe/services/tax/transaction_service.rb +0 -17
- data/lib/stripe/services/tax_code_service.rb +0 -3
- data/lib/stripe/services/tax_id_service.rb +1 -12
- data/lib/stripe/services/tax_rate_service.rb +0 -27
- data/lib/stripe/services/terminal/configuration_service.rb +0 -108
- data/lib/stripe/services/terminal/connection_token_service.rb +0 -1
- data/lib/stripe/services/terminal/location_service.rb +0 -21
- data/lib/stripe/services/terminal/reader_service.rb +0 -53
- data/lib/stripe/services/test_helpers/confirmation_token_service.rb +0 -89
- data/lib/stripe/services/test_helpers/customer_service.rb +0 -3
- data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +0 -99
- data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +0 -2
- data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +0 -91
- data/lib/stripe/services/test_helpers/terminal/reader_service.rb +0 -4
- data/lib/stripe/services/test_helpers/test_clock_service.rb +0 -6
- data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +0 -1
- data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +0 -6
- data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +0 -6
- data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +0 -11
- data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +0 -11
- data/lib/stripe/services/token_service.rb +4 -184
- data/lib/stripe/services/topup_service.rb +0 -21
- data/lib/stripe/services/transfer_reversal_service.rb +0 -8
- data/lib/stripe/services/transfer_service.rb +0 -19
- data/lib/stripe/services/treasury/credit_reversal_service.rb +0 -8
- data/lib/stripe/services/treasury/debit_reversal_service.rb +0 -9
- data/lib/stripe/services/treasury/financial_account_features_service.rb +0 -10
- data/lib/stripe/services/treasury/financial_account_service.rb +64 -36
- data/lib/stripe/services/treasury/inbound_transfer_service.rb +0 -12
- data/lib/stripe/services/treasury/outbound_payment_service.rb +0 -38
- data/lib/stripe/services/treasury/outbound_transfer_service.rb +16 -15
- data/lib/stripe/services/treasury/received_credit_service.rb +0 -6
- data/lib/stripe/services/treasury/received_debit_service.rb +0 -5
- data/lib/stripe/services/treasury/transaction_entry_service.rb +0 -14
- data/lib/stripe/services/treasury/transaction_service.rb +0 -14
- data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +0 -2
- data/lib/stripe/services/v2/billing/meter_event_service.rb +0 -3
- data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +0 -3
- data/lib/stripe/services/v2/core/event_destination_service.rb +0 -18
- data/lib/stripe/services/v2/core/event_service.rb +0 -2
- data/lib/stripe/services/webhook_endpoint_service.rb +0 -14
- data/lib/stripe/stripe_client.rb +1 -1
- data/lib/stripe/stripe_object.rb +3 -3
- data/lib/stripe/util.rb +1 -1
- data/lib/stripe/version.rb +1 -1
- data/rbi/stripe/resources/account.rbi +29 -1001
- data/rbi/stripe/resources/account_link.rbi +0 -13
- data/rbi/stripe/resources/account_notice.rbi +0 -27
- data/rbi/stripe/resources/account_session.rbi +0 -166
- data/rbi/stripe/resources/apple_pay_domain.rbi +0 -14
- data/rbi/stripe/resources/application.rbi +0 -3
- data/rbi/stripe/resources/application_fee.rbi +0 -28
- data/rbi/stripe/resources/application_fee_refund.rbi +0 -7
- data/rbi/stripe/resources/apps/secret.rbi +0 -34
- data/rbi/stripe/resources/balance.rbi +0 -33
- data/rbi/stripe/resources/balance_transaction.rbi +0 -33
- data/rbi/stripe/resources/bank_account.rbi +0 -29
- data/rbi/stripe/resources/billing/alert.rbi +0 -31
- data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -5
- data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -16
- data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -27
- data/rbi/stripe/resources/billing/credit_grant.rbi +0 -43
- data/rbi/stripe/resources/billing/meter.rbi +0 -35
- data/rbi/stripe/resources/billing/meter_error_report.rbi +0 -11
- data/rbi/stripe/resources/billing/meter_event.rbi +0 -12
- data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -11
- data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -6
- data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -106
- data/rbi/stripe/resources/billing_portal/session.rbi +0 -55
- data/rbi/stripe/resources/capability.rbi +2 -29
- data/rbi/stripe/resources/capital/financing_offer.rbi +0 -38
- data/rbi/stripe/resources/capital/financing_summary.rbi +0 -15
- data/rbi/stripe/resources/capital/financing_transaction.rbi +0 -27
- data/rbi/stripe/resources/card.rbi +3 -34
- data/rbi/stripe/resources/cash_balance.rbi +0 -5
- data/rbi/stripe/resources/charge.rbi +6 -738
- data/rbi/stripe/resources/checkout/session.rbi +4 -636
- data/rbi/stripe/resources/climate/order.rbi +0 -48
- data/rbi/stripe/resources/climate/product.rbi +0 -16
- data/rbi/stripe/resources/climate/supplier.rbi +0 -16
- data/rbi/stripe/resources/confirmation_token.rbi +3 -364
- data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -5
- data/rbi/stripe/resources/country_spec.rbi +0 -16
- data/rbi/stripe/resources/coupon.rbi +0 -48
- data/rbi/stripe/resources/credit_note.rbi +0 -159
- data/rbi/stripe/resources/credit_note_line_item.rbi +0 -24
- data/rbi/stripe/resources/customer.rbi +1 -188
- data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -12
- data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -27
- data/rbi/stripe/resources/customer_session.rbi +0 -31
- data/rbi/stripe/resources/discount.rbi +0 -12
- data/rbi/stripe/resources/dispute.rbi +4 -166
- data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -11
- data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -3
- data/rbi/stripe/resources/entitlements/feature.rbi +0 -22
- data/rbi/stripe/resources/ephemeral_key.rbi +0 -7
- data/rbi/stripe/resources/event.rbi +0 -31
- data/rbi/stripe/resources/exchange_rate.rbi +0 -8
- data/rbi/stripe/resources/file.rbi +0 -29
- data/rbi/stripe/resources/file_link.rbi +0 -28
- data/rbi/stripe/resources/financial_connections/account.rbi +0 -56
- data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +0 -3
- data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -7
- data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -3
- data/rbi/stripe/resources/financial_connections/institution.rbi +0 -16
- data/rbi/stripe/resources/financial_connections/session.rbi +0 -35
- data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -26
- data/rbi/stripe/resources/forwarding/request.rbi +0 -38
- data/rbi/stripe/resources/funding_instructions.rbi +0 -107
- data/rbi/stripe/resources/gift_cards/card.rbi +0 -36
- data/rbi/stripe/resources/gift_cards/transaction.rbi +0 -41
- data/rbi/stripe/resources/identity/verification_report.rbi +0 -73
- data/rbi/stripe/resources/identity/verification_session.rbi +0 -83
- data/rbi/stripe/resources/invoice.rbi +7 -1663
- data/rbi/stripe/resources/invoice_item.rbi +0 -107
- data/rbi/stripe/resources/invoice_line_item.rbi +0 -86
- data/rbi/stripe/resources/invoice_payment.rbi +0 -16
- data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -17
- data/rbi/stripe/resources/issuing/authorization.rbi +0 -245
- data/rbi/stripe/resources/issuing/card.rbi +0 -153
- data/rbi/stripe/resources/issuing/cardholder.rbi +0 -138
- data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +0 -109
- data/rbi/stripe/resources/issuing/dispute.rbi +0 -177
- data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +0 -17
- data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +0 -18
- data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -62
- data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -16
- data/rbi/stripe/resources/issuing/settlement.rbi +0 -16
- data/rbi/stripe/resources/issuing/token.rbi +0 -51
- data/rbi/stripe/resources/issuing/transaction.rbi +0 -205
- data/rbi/stripe/resources/line_item.rbi +0 -23
- data/rbi/stripe/resources/login_link.rbi +0 -2
- data/rbi/stripe/resources/mandate.rbi +0 -47
- data/rbi/stripe/resources/margin.rbi +0 -24
- data/rbi/stripe/resources/order.rbi +3 -492
- data/rbi/stripe/resources/payment_attempt_record.rbi +0 -45
- data/rbi/stripe/resources/payment_intent.rbi +3 -2224
- data/rbi/stripe/resources/payment_link.rbi +14 -291
- data/rbi/stripe/resources/payment_method.rbi +3 -382
- data/rbi/stripe/resources/payment_method_configuration.rbi +0 -486
- data/rbi/stripe/resources/payment_method_domain.rbi +0 -29
- data/rbi/stripe/resources/payment_record.rbi +0 -134
- data/rbi/stripe/resources/payout.rbi +0 -58
- data/rbi/stripe/resources/person.rbi +2 -92
- data/rbi/stripe/resources/plan.rbi +0 -78
- data/rbi/stripe/resources/price.rbi +0 -153
- data/rbi/stripe/resources/product.rbi +0 -120
- data/rbi/stripe/resources/product_feature.rbi +0 -4
- data/rbi/stripe/resources/promotion_code.rbi +0 -50
- data/rbi/stripe/resources/quote.rbi +0 -593
- data/rbi/stripe/resources/quote_line.rbi +0 -66
- data/rbi/stripe/resources/quote_preview_invoice.rbi +4 -184
- data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +0 -101
- data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -20
- data/rbi/stripe/resources/radar/value_list.rbi +0 -32
- data/rbi/stripe/resources/radar/value_list_item.rbi +0 -23
- data/rbi/stripe/resources/refund.rbi +0 -100
- data/rbi/stripe/resources/reporting/report_run.rbi +0 -38
- data/rbi/stripe/resources/reporting/report_type.rbi +0 -11
- data/rbi/stripe/resources/reserve_transaction.rbi +0 -4
- data/rbi/stripe/resources/reversal.rbi +0 -9
- data/rbi/stripe/resources/review.rbi +0 -32
- data/rbi/stripe/resources/setup_attempt.rbi +3 -106
- data/rbi/stripe/resources/setup_intent.rbi +3 -688
- data/rbi/stripe/resources/shipping_rate.rbi +0 -57
- data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -16
- data/rbi/stripe/resources/source.rbi +9 -365
- data/rbi/stripe/resources/source_mandate_notification.rbi +0 -13
- data/rbi/stripe/resources/source_transaction.rbi +0 -29
- data/rbi/stripe/resources/subscription.rbi +0 -431
- data/rbi/stripe/resources/subscription_item.rbi +0 -88
- data/rbi/stripe/resources/subscription_schedule.rbi +0 -504
- data/rbi/stripe/resources/tax/association.rbi +0 -13
- data/rbi/stripe/resources/tax/calculation.rbi +2 -100
- data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -20
- data/rbi/stripe/resources/tax/form.rbi +2 -40
- data/rbi/stripe/resources/tax/registration.rbi +401 -317
- data/rbi/stripe/resources/tax/settings.rbi +0 -26
- data/rbi/stripe/resources/tax/transaction.rbi +1 -73
- data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -12
- data/rbi/stripe/resources/tax_code.rbi +0 -9
- data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -4
- data/rbi/stripe/resources/tax_id.rbi +2 -34
- data/rbi/stripe/resources/tax_rate.rbi +0 -51
- data/rbi/stripe/resources/terminal/configuration.rbi +0 -211
- data/rbi/stripe/resources/terminal/connection_token.rbi +0 -5
- data/rbi/stripe/resources/terminal/location.rbi +0 -40
- data/rbi/stripe/resources/terminal/reader.rbi +0 -158
- data/rbi/stripe/resources/terminal/reader_collected_data.rbi +0 -7
- data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -20
- data/rbi/stripe/resources/token.rbi +5 -235
- data/rbi/stripe/resources/topup.rbi +0 -44
- data/rbi/stripe/resources/transfer.rbi +0 -41
- data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -25
- data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -27
- data/rbi/stripe/resources/treasury/financial_account.rbi +70 -124
- data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -46
- data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -59
- data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -113
- data/rbi/stripe/resources/treasury/outbound_transfer.rbi +28 -84
- data/rbi/stripe/resources/treasury/received_credit.rbi +7 -67
- data/rbi/stripe/resources/treasury/received_debit.rbi +0 -62
- data/rbi/stripe/resources/treasury/transaction.rbi +0 -45
- data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -41
- data/rbi/stripe/resources/usage_record.rbi +0 -5
- data/rbi/stripe/resources/usage_record_summary.rbi +0 -7
- data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -6
- data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -7
- data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -5
- data/rbi/stripe/resources/v2/event.rbi +0 -8
- data/rbi/stripe/resources/v2/event_destination.rbi +0 -19
- data/rbi/stripe/resources/webhook_endpoint.rbi +0 -31
- data/rbi/stripe/services/account_capability_service.rbi +0 -4
- data/rbi/stripe/services/account_external_account_service.rbi +0 -52
- data/rbi/stripe/services/account_link_service.rbi +0 -9
- data/rbi/stripe/services/account_login_link_service.rbi +0 -1
- data/rbi/stripe/services/account_notice_service.rbi +0 -13
- data/rbi/stripe/services/account_person_service.rbi +0 -174
- data/rbi/stripe/services/account_service.rbi +10 -773
- data/rbi/stripe/services/account_session_service.rbi +0 -116
- data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -8
- data/rbi/stripe/services/application_fee_refund_service.rbi +0 -10
- data/rbi/stripe/services/application_fee_service.rbi +0 -11
- data/rbi/stripe/services/apps/secret_service.rbi +0 -24
- data/rbi/stripe/services/balance_service.rbi +0 -1
- data/rbi/stripe/services/balance_transaction_service.rbi +0 -14
- data/rbi/stripe/services/billing/alert_service.rbi +0 -20
- data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -7
- data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -7
- data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -26
- data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -5
- data/rbi/stripe/services/billing/meter_event_service.rbi +0 -5
- data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -8
- data/rbi/stripe/services/billing/meter_service.rbi +0 -21
- data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -76
- data/rbi/stripe/services/billing_portal/session_service.rbi +0 -31
- data/rbi/stripe/services/capital/financing_offer_service.rbi +0 -13
- data/rbi/stripe/services/capital/financing_summary_service.rbi +0 -1
- data/rbi/stripe/services/capital/financing_transaction_service.rbi +0 -9
- data/rbi/stripe/services/charge_service.rbi +0 -346
- data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -4
- data/rbi/stripe/services/checkout/session_service.rbi +2 -395
- data/rbi/stripe/services/climate/order_service.rbi +0 -18
- data/rbi/stripe/services/climate/product_service.rbi +0 -5
- data/rbi/stripe/services/climate/supplier_service.rbi +0 -5
- data/rbi/stripe/services/confirmation_token_service.rbi +0 -1
- data/rbi/stripe/services/country_spec_service.rbi +0 -5
- data/rbi/stripe/services/coupon_service.rbi +0 -30
- data/rbi/stripe/services/credit_note_line_item_service.rbi +0 -4
- data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -33
- data/rbi/stripe/services/credit_note_service.rbi +0 -76
- data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -13
- data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -4
- data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -5
- data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -8
- data/rbi/stripe/services/customer_payment_method_service.rbi +0 -7
- data/rbi/stripe/services/customer_payment_source_service.rbi +0 -37
- data/rbi/stripe/services/customer_service.rbi +1 -117
- data/rbi/stripe/services/customer_session_service.rbi +0 -16
- data/rbi/stripe/services/customer_tax_id_service.rbi +1 -9
- data/rbi/stripe/services/dispute_service.rbi +2 -80
- data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -6
- data/rbi/stripe/services/entitlements/feature_service.rbi +0 -15
- data/rbi/stripe/services/ephemeral_key_service.rbi +0 -6
- data/rbi/stripe/services/event_service.rbi +0 -13
- data/rbi/stripe/services/exchange_rate_service.rbi +0 -5
- data/rbi/stripe/services/file_link_service.rbi +0 -19
- data/rbi/stripe/services/file_service.rbi +0 -18
- data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +0 -4
- data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -5
- data/rbi/stripe/services/financial_connections/account_service.rbi +0 -16
- data/rbi/stripe/services/financial_connections/institution_service.rbi +0 -5
- data/rbi/stripe/services/financial_connections/session_service.rbi +0 -17
- data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -13
- data/rbi/stripe/services/forwarding/request_service.rbi +0 -20
- data/rbi/stripe/services/gift_cards/card_service.rbi +0 -20
- data/rbi/stripe/services/gift_cards/transaction_service.rbi +0 -24
- data/rbi/stripe/services/identity/verification_report_service.rbi +0 -13
- data/rbi/stripe/services/identity/verification_session_service.rbi +0 -43
- data/rbi/stripe/services/invoice_item_service.rbi +0 -81
- data/rbi/stripe/services/invoice_line_item_service.rbi +0 -50
- data/rbi/stripe/services/invoice_payment_service.rbi +0 -5
- data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -9
- data/rbi/stripe/services/invoice_service.rbi +2 -1100
- data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +1 -375
- data/rbi/stripe/services/issuing/authorization_service.rbi +0 -20
- data/rbi/stripe/services/issuing/card_service.rbi +0 -89
- data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -100
- data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +0 -82
- data/rbi/stripe/services/issuing/dispute_service.rbi +0 -123
- data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +0 -6
- data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +0 -10
- data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -38
- data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -7
- data/rbi/stripe/services/issuing/token_service.rbi +0 -14
- data/rbi/stripe/services/issuing/transaction_service.rbi +0 -16
- data/rbi/stripe/services/mandate_service.rbi +0 -1
- data/rbi/stripe/services/margin_service.rbi +0 -15
- data/rbi/stripe/services/order_line_item_service.rbi +0 -4
- data/rbi/stripe/services/order_service.rbi +2 -365
- data/rbi/stripe/services/payment_attempt_record_service.rbi +0 -3
- data/rbi/stripe/services/payment_intent_service.rbi +0 -1764
- data/rbi/stripe/services/payment_link_line_item_service.rbi +0 -4
- data/rbi/stripe/services/payment_link_service.rbi +14 -211
- data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -294
- data/rbi/stripe/services/payment_method_domain_service.rbi +0 -13
- data/rbi/stripe/services/payment_method_service.rbi +0 -149
- data/rbi/stripe/services/payment_record_service.rbi +0 -92
- data/rbi/stripe/services/payout_service.rbi +0 -31
- data/rbi/stripe/services/plan_service.rbi +0 -51
- data/rbi/stripe/services/price_service.rbi +0 -106
- data/rbi/stripe/services/product_feature_service.rbi +0 -7
- data/rbi/stripe/services/product_service.rbi +0 -93
- data/rbi/stripe/services/promotion_code_service.rbi +0 -34
- data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -4
- data/rbi/stripe/services/quote_line_item_service.rbi +0 -4
- data/rbi/stripe/services/quote_line_service.rbi +0 -4
- data/rbi/stripe/services/quote_preview_invoice_service.rbi +0 -4
- data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +0 -4
- data/rbi/stripe/services/quote_service.rbi +0 -440
- data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -12
- data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -15
- data/rbi/stripe/services/radar/value_list_service.rbi +0 -21
- data/rbi/stripe/services/refund_service.rbi +0 -27
- data/rbi/stripe/services/reporting/report_run_service.rbi +0 -21
- data/rbi/stripe/services/reporting/report_type_service.rbi +0 -2
- data/rbi/stripe/services/review_service.rbi +0 -11
- data/rbi/stripe/services/setup_attempt_service.rbi +0 -10
- data/rbi/stripe/services/setup_intent_service.rbi +0 -595
- data/rbi/stripe/services/shipping_rate_service.rbi +0 -39
- data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -5
- data/rbi/stripe/services/source_service.rbi +0 -119
- data/rbi/stripe/services/source_transaction_service.rbi +0 -4
- data/rbi/stripe/services/subscription_item_service.rbi +0 -74
- data/rbi/stripe/services/subscription_item_usage_record_service.rbi +0 -4
- data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +0 -4
- data/rbi/stripe/services/subscription_schedule_service.rbi +0 -405
- data/rbi/stripe/services/subscription_service.rbi +0 -337
- data/rbi/stripe/services/tax/association_service.rbi +0 -2
- data/rbi/stripe/services/tax/calculation_line_item_service.rbi +0 -4
- data/rbi/stripe/services/tax/calculation_service.rbi +1 -40
- data/rbi/stripe/services/tax/form_service.rbi +0 -11
- data/rbi/stripe/services/tax/registration_service.rbi +233 -211
- data/rbi/stripe/services/tax/settings_service.rbi +0 -13
- data/rbi/stripe/services/tax/transaction_line_item_service.rbi +0 -4
- data/rbi/stripe/services/tax/transaction_service.rbi +0 -22
- data/rbi/stripe/services/tax_code_service.rbi +0 -5
- data/rbi/stripe/services/tax_id_service.rbi +1 -17
- data/rbi/stripe/services/tax_rate_service.rbi +0 -32
- data/rbi/stripe/services/terminal/configuration_service.rbi +0 -154
- data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -2
- data/rbi/stripe/services/terminal/location_service.rbi +0 -27
- data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +0 -1
- data/rbi/stripe/services/terminal/reader_service.rbi +0 -78
- data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -114
- data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -4
- data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -138
- data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -5
- data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -6
- data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -120
- data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -1
- data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -7
- data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -10
- data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -5
- data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -14
- data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -14
- data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -16
- data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -16
- data/rbi/stripe/services/token_service.rbi +5 -226
- data/rbi/stripe/services/topup_service.rbi +0 -28
- data/rbi/stripe/services/transfer_reversal_service.rbi +0 -12
- data/rbi/stripe/services/transfer_service.rbi +0 -24
- data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -11
- data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -12
- data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -25
- data/rbi/stripe/services/treasury/financial_account_service.rbi +62 -73
- data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -16
- data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -50
- data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +17 -24
- data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -9
- data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -7
- data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -18
- data/rbi/stripe/services/treasury/transaction_service.rbi +0 -19
- data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -4
- data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -4
- data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -5
- data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -25
- data/rbi/stripe/services/v2/core/event_service.rbi +0 -3
- data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -18
- metadata +2 -2
@@ -12,7 +12,6 @@ module Stripe
|
|
12
12
|
# The connected account being referenced when `type` is `account`.
|
13
13
|
sig { returns(T.any(String, Stripe::Account)) }
|
14
14
|
attr_reader :account
|
15
|
-
|
16
15
|
# Type of the account referenced.
|
17
16
|
sig { returns(String) }
|
18
17
|
attr_reader :type
|
@@ -20,11 +19,9 @@ module Stripe
|
|
20
19
|
# If Stripe disabled automatic tax, this enum describes why.
|
21
20
|
sig { returns(T.nilable(String)) }
|
22
21
|
attr_reader :disabled_reason
|
23
|
-
|
24
22
|
# Whether Stripe automatically computes tax on this subscription.
|
25
23
|
sig { returns(T::Boolean) }
|
26
24
|
attr_reader :enabled
|
27
|
-
|
28
25
|
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
|
29
26
|
sig { returns(T.nilable(Liability)) }
|
30
27
|
attr_reader :liability
|
@@ -33,19 +30,15 @@ module Stripe
|
|
33
30
|
# The day of the month of the billing_cycle_anchor.
|
34
31
|
sig { returns(Integer) }
|
35
32
|
attr_reader :day_of_month
|
36
|
-
|
37
33
|
# The hour of the day of the billing_cycle_anchor.
|
38
34
|
sig { returns(T.nilable(Integer)) }
|
39
35
|
attr_reader :hour
|
40
|
-
|
41
36
|
# The minute of the hour of the billing_cycle_anchor.
|
42
37
|
sig { returns(T.nilable(Integer)) }
|
43
38
|
attr_reader :minute
|
44
|
-
|
45
39
|
# The month to start full cycle billing periods.
|
46
40
|
sig { returns(T.nilable(Integer)) }
|
47
41
|
attr_reader :month
|
48
|
-
|
49
42
|
# The second of the minute of the billing_cycle_anchor.
|
50
43
|
sig { returns(T.nilable(Integer)) }
|
51
44
|
attr_reader :second
|
@@ -54,7 +47,6 @@ module Stripe
|
|
54
47
|
# Monetary threshold that triggers the subscription to create an invoice
|
55
48
|
sig { returns(T.nilable(Integer)) }
|
56
49
|
attr_reader :amount_gte
|
57
|
-
|
58
50
|
# Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.
|
59
51
|
sig { returns(T.nilable(T::Boolean)) }
|
60
52
|
attr_reader :reset_billing_cycle_anchor
|
@@ -63,11 +55,9 @@ module Stripe
|
|
63
55
|
# Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
|
64
56
|
sig { returns(T.nilable(String)) }
|
65
57
|
attr_reader :comment
|
66
|
-
|
67
58
|
# The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
|
68
59
|
sig { returns(T.nilable(String)) }
|
69
60
|
attr_reader :feedback
|
70
|
-
|
71
61
|
# Why this subscription was canceled.
|
72
62
|
sig { returns(T.nilable(String)) }
|
73
63
|
attr_reader :reason
|
@@ -77,7 +67,6 @@ module Stripe
|
|
77
67
|
# The connected account being referenced when `type` is `account`.
|
78
68
|
sig { returns(T.any(String, Stripe::Account)) }
|
79
69
|
attr_reader :account
|
80
|
-
|
81
70
|
# Type of the account referenced.
|
82
71
|
sig { returns(String) }
|
83
72
|
attr_reader :type
|
@@ -85,7 +74,6 @@ module Stripe
|
|
85
74
|
# The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
|
86
75
|
sig { returns(T.nilable(T::Array[T.any(String, Stripe::TaxId)])) }
|
87
76
|
attr_reader :account_tax_ids
|
88
|
-
|
89
77
|
# Attribute for field issuer
|
90
78
|
sig { returns(Issuer) }
|
91
79
|
attr_reader :issuer
|
@@ -95,7 +83,6 @@ module Stripe
|
|
95
83
|
# The original price to be migrated.
|
96
84
|
sig { returns(String) }
|
97
85
|
attr_reader :source_price
|
98
|
-
|
99
86
|
# The intended resulting price of the migration.
|
100
87
|
sig { returns(String) }
|
101
88
|
attr_reader :target_price
|
@@ -103,11 +90,9 @@ module Stripe
|
|
103
90
|
# The time at which the price migration encountered an error.
|
104
91
|
sig { returns(Integer) }
|
105
92
|
attr_reader :errored_at
|
106
|
-
|
107
93
|
# The involved price pairs in each failed transition.
|
108
94
|
sig { returns(T::Array[FailedTransition]) }
|
109
95
|
attr_reader :failed_transitions
|
110
|
-
|
111
96
|
# The type of error encountered by the price migration.
|
112
97
|
sig { returns(String) }
|
113
98
|
attr_reader :type
|
@@ -116,7 +101,6 @@ module Stripe
|
|
116
101
|
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
117
102
|
sig { returns(String) }
|
118
103
|
attr_reader :behavior
|
119
|
-
|
120
104
|
# The time after which the subscription will resume collecting payments.
|
121
105
|
sig { returns(T.nilable(Integer)) }
|
122
106
|
attr_reader :resumes_at
|
@@ -132,7 +116,6 @@ module Stripe
|
|
132
116
|
# Attribute for field mandate_options
|
133
117
|
sig { returns(MandateOptions) }
|
134
118
|
attr_reader :mandate_options
|
135
|
-
|
136
119
|
# Bank account verification method.
|
137
120
|
sig { returns(String) }
|
138
121
|
attr_reader :verification_method
|
@@ -147,11 +130,9 @@ module Stripe
|
|
147
130
|
# Amount to be charged for future payments.
|
148
131
|
sig { returns(T.nilable(Integer)) }
|
149
132
|
attr_reader :amount
|
150
|
-
|
151
133
|
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
|
152
134
|
sig { returns(T.nilable(String)) }
|
153
135
|
attr_reader :amount_type
|
154
|
-
|
155
136
|
# A description of the mandate or subscription that is meant to be displayed to the customer.
|
156
137
|
sig { returns(T.nilable(String)) }
|
157
138
|
attr_reader :description
|
@@ -159,11 +140,9 @@ module Stripe
|
|
159
140
|
# Attribute for field mandate_options
|
160
141
|
sig { returns(MandateOptions) }
|
161
142
|
attr_reader :mandate_options
|
162
|
-
|
163
143
|
# Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
|
164
144
|
sig { returns(T.nilable(String)) }
|
165
145
|
attr_reader :network
|
166
|
-
|
167
146
|
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
|
168
147
|
sig { returns(T.nilable(String)) }
|
169
148
|
attr_reader :request_three_d_secure
|
@@ -178,7 +157,6 @@ module Stripe
|
|
178
157
|
# Attribute for field eu_bank_transfer
|
179
158
|
sig { returns(EuBankTransfer) }
|
180
159
|
attr_reader :eu_bank_transfer
|
181
|
-
|
182
160
|
# The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
|
183
161
|
sig { returns(T.nilable(String)) }
|
184
162
|
attr_reader :type
|
@@ -186,7 +164,6 @@ module Stripe
|
|
186
164
|
# Attribute for field bank_transfer
|
187
165
|
sig { returns(BankTransfer) }
|
188
166
|
attr_reader :bank_transfer
|
189
|
-
|
190
167
|
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
|
191
168
|
sig { returns(T.nilable(String)) }
|
192
169
|
attr_reader :funding_type
|
@@ -200,7 +177,6 @@ module Stripe
|
|
200
177
|
# The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
|
201
178
|
sig { returns(T::Array[String]) }
|
202
179
|
attr_reader :account_subcategories
|
203
|
-
|
204
180
|
# The institution to use to filter for possible accounts to link.
|
205
181
|
sig { returns(String) }
|
206
182
|
attr_reader :institution
|
@@ -208,11 +184,9 @@ module Stripe
|
|
208
184
|
# Attribute for field filters
|
209
185
|
sig { returns(Filters) }
|
210
186
|
attr_reader :filters
|
211
|
-
|
212
187
|
# The list of permissions to request. The `payment_method` permission must be included.
|
213
188
|
sig { returns(T::Array[String]) }
|
214
189
|
attr_reader :permissions
|
215
|
-
|
216
190
|
# Data features requested to be retrieved upon account creation.
|
217
191
|
sig { returns(T.nilable(T::Array[String])) }
|
218
192
|
attr_reader :prefetch
|
@@ -220,7 +194,6 @@ module Stripe
|
|
220
194
|
# Attribute for field financial_connections
|
221
195
|
sig { returns(FinancialConnections) }
|
222
196
|
attr_reader :financial_connections
|
223
|
-
|
224
197
|
# Bank account verification method.
|
225
198
|
sig { returns(String) }
|
226
199
|
attr_reader :verification_method
|
@@ -228,31 +201,24 @@ module Stripe
|
|
228
201
|
# This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.
|
229
202
|
sig { returns(T.nilable(AcssDebit)) }
|
230
203
|
attr_reader :acss_debit
|
231
|
-
|
232
204
|
# This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.
|
233
205
|
sig { returns(T.nilable(Bancontact)) }
|
234
206
|
attr_reader :bancontact
|
235
|
-
|
236
207
|
# This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.
|
237
208
|
sig { returns(T.nilable(Card)) }
|
238
209
|
attr_reader :card
|
239
|
-
|
240
210
|
# This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.
|
241
211
|
sig { returns(T.nilable(CustomerBalance)) }
|
242
212
|
attr_reader :customer_balance
|
243
|
-
|
244
213
|
# This sub-hash contains details about the Indonesia bank transfer payment method options to pass to invoices created by the subscription.
|
245
214
|
sig { returns(T.nilable(IdBankTransfer)) }
|
246
215
|
attr_reader :id_bank_transfer
|
247
|
-
|
248
216
|
# This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.
|
249
217
|
sig { returns(T.nilable(Konbini)) }
|
250
218
|
attr_reader :konbini
|
251
|
-
|
252
219
|
# This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription.
|
253
220
|
sig { returns(T.nilable(SepaDebit)) }
|
254
221
|
attr_reader :sepa_debit
|
255
|
-
|
256
222
|
# This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.
|
257
223
|
sig { returns(T.nilable(UsBankAccount)) }
|
258
224
|
attr_reader :us_bank_account
|
@@ -260,11 +226,9 @@ module Stripe
|
|
260
226
|
# Payment-method-specific configuration to provide to invoices created by the subscription.
|
261
227
|
sig { returns(T.nilable(PaymentMethodOptions)) }
|
262
228
|
attr_reader :payment_method_options
|
263
|
-
|
264
229
|
# The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).
|
265
230
|
sig { returns(T.nilable(T::Array[String])) }
|
266
231
|
attr_reader :payment_method_types
|
267
|
-
|
268
232
|
# Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`.
|
269
233
|
sig { returns(T.nilable(String)) }
|
270
234
|
attr_reader :save_default_payment_method
|
@@ -273,7 +237,6 @@ module Stripe
|
|
273
237
|
# Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
|
274
238
|
sig { returns(String) }
|
275
239
|
attr_reader :interval
|
276
|
-
|
277
240
|
# The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
|
278
241
|
sig { returns(Integer) }
|
279
242
|
attr_reader :interval_count
|
@@ -282,23 +245,18 @@ module Stripe
|
|
282
245
|
# If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.
|
283
246
|
sig { returns(T.nilable(Integer)) }
|
284
247
|
attr_reader :billing_cycle_anchor
|
285
|
-
|
286
248
|
# The point after which the changes reflected by this update will be discarded and no longer applied.
|
287
249
|
sig { returns(Integer) }
|
288
250
|
attr_reader :expires_at
|
289
|
-
|
290
251
|
# The number of iterations of prebilling to apply.
|
291
252
|
sig { returns(T.nilable(Integer)) }
|
292
253
|
attr_reader :prebilling_iterations
|
293
|
-
|
294
254
|
# List of subscription items, each with an attached plan, that will be set if the update is applied.
|
295
255
|
sig { returns(T.nilable(T::Array[Stripe::SubscriptionItem])) }
|
296
256
|
attr_reader :subscription_items
|
297
|
-
|
298
257
|
# Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.
|
299
258
|
sig { returns(T.nilable(Integer)) }
|
300
259
|
attr_reader :trial_end
|
301
|
-
|
302
260
|
# Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
|
303
261
|
sig { returns(T.nilable(T::Boolean)) }
|
304
262
|
attr_reader :trial_from_plan
|
@@ -307,15 +265,12 @@ module Stripe
|
|
307
265
|
# ID of the prebilling invoice.
|
308
266
|
sig { returns(T.any(String, Stripe::Invoice)) }
|
309
267
|
attr_reader :invoice
|
310
|
-
|
311
268
|
# The end of the last period for which the invoice pre-bills.
|
312
269
|
sig { returns(Integer) }
|
313
270
|
attr_reader :period_end
|
314
|
-
|
315
271
|
# The start of the first period for which the invoice pre-bills.
|
316
272
|
sig { returns(Integer) }
|
317
273
|
attr_reader :period_start
|
318
|
-
|
319
274
|
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
|
320
275
|
sig { returns(String) }
|
321
276
|
attr_reader :update_behavior
|
@@ -324,7 +279,6 @@ module Stripe
|
|
324
279
|
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
|
325
280
|
sig { returns(T.nilable(Float)) }
|
326
281
|
attr_reader :amount_percent
|
327
|
-
|
328
282
|
# The account where funds from the payment will be transferred to upon payment success.
|
329
283
|
sig { returns(T.any(String, Stripe::Account)) }
|
330
284
|
attr_reader :destination
|
@@ -342,173 +296,131 @@ module Stripe
|
|
342
296
|
# ID of the Connect Application that created the subscription.
|
343
297
|
sig { returns(T.nilable(T.any(String, Stripe::Application))) }
|
344
298
|
attr_reader :application
|
345
|
-
|
346
299
|
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
|
347
300
|
sig { returns(T.nilable(Float)) }
|
348
301
|
attr_reader :application_fee_percent
|
349
|
-
|
350
302
|
# Attribute for field automatic_tax
|
351
303
|
sig { returns(AutomaticTax) }
|
352
304
|
attr_reader :automatic_tax
|
353
|
-
|
354
305
|
# The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.
|
355
306
|
sig { returns(Integer) }
|
356
307
|
attr_reader :billing_cycle_anchor
|
357
|
-
|
358
308
|
# The fixed values used to calculate the `billing_cycle_anchor`.
|
359
309
|
sig { returns(T.nilable(BillingCycleAnchorConfig)) }
|
360
310
|
attr_reader :billing_cycle_anchor_config
|
361
|
-
|
362
311
|
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
|
363
312
|
sig { returns(T.nilable(BillingThresholds)) }
|
364
313
|
attr_reader :billing_thresholds
|
365
|
-
|
366
314
|
# A date in the future at which the subscription will automatically get canceled
|
367
315
|
sig { returns(T.nilable(Integer)) }
|
368
316
|
attr_reader :cancel_at
|
369
|
-
|
370
317
|
# Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.
|
371
318
|
sig { returns(T::Boolean) }
|
372
319
|
attr_reader :cancel_at_period_end
|
373
|
-
|
374
320
|
# If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
|
375
321
|
sig { returns(T.nilable(Integer)) }
|
376
322
|
attr_reader :canceled_at
|
377
|
-
|
378
323
|
# Details about why this subscription was cancelled
|
379
324
|
sig { returns(T.nilable(CancellationDetails)) }
|
380
325
|
attr_reader :cancellation_details
|
381
|
-
|
382
326
|
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
|
383
327
|
sig { returns(String) }
|
384
328
|
attr_reader :collection_method
|
385
|
-
|
386
329
|
# Time at which the object was created. Measured in seconds since the Unix epoch.
|
387
330
|
sig { returns(Integer) }
|
388
331
|
attr_reader :created
|
389
|
-
|
390
332
|
# 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).
|
391
333
|
sig { returns(String) }
|
392
334
|
attr_reader :currency
|
393
|
-
|
394
335
|
# End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
|
395
336
|
sig { returns(Integer) }
|
396
337
|
attr_reader :current_period_end
|
397
|
-
|
398
338
|
# Start of the current period that the subscription has been invoiced for.
|
399
339
|
sig { returns(Integer) }
|
400
340
|
attr_reader :current_period_start
|
401
|
-
|
402
341
|
# ID of the customer who owns the subscription.
|
403
342
|
sig { returns(T.any(String, Stripe::Customer)) }
|
404
343
|
attr_reader :customer
|
405
|
-
|
406
344
|
# Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.
|
407
345
|
sig { returns(T.nilable(Integer)) }
|
408
346
|
attr_reader :days_until_due
|
409
|
-
|
410
347
|
# ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
|
411
348
|
sig { returns(T.nilable(T.any(String, Stripe::PaymentMethod))) }
|
412
349
|
attr_reader :default_payment_method
|
413
|
-
|
414
350
|
# ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
|
415
351
|
sig {
|
416
352
|
returns(T.nilable(T.any(String, T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source))))
|
417
353
|
}
|
418
354
|
attr_reader :default_source
|
419
|
-
|
420
355
|
# The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
|
421
356
|
sig { returns(T.nilable(T::Array[Stripe::TaxRate])) }
|
422
357
|
attr_reader :default_tax_rates
|
423
|
-
|
424
358
|
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
|
425
359
|
sig { returns(T.nilable(String)) }
|
426
360
|
attr_reader :description
|
427
|
-
|
428
361
|
# Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
|
429
362
|
sig { returns(T.nilable(Stripe::Discount)) }
|
430
363
|
attr_reader :discount
|
431
|
-
|
432
364
|
# The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
|
433
365
|
sig { returns(T::Array[T.any(String, Stripe::Discount)]) }
|
434
366
|
attr_reader :discounts
|
435
|
-
|
436
367
|
# If the subscription has ended, the date the subscription ended.
|
437
368
|
sig { returns(T.nilable(Integer)) }
|
438
369
|
attr_reader :ended_at
|
439
|
-
|
440
370
|
# Unique identifier for the object.
|
441
371
|
sig { returns(String) }
|
442
372
|
attr_reader :id
|
443
|
-
|
444
373
|
# Attribute for field invoice_settings
|
445
374
|
sig { returns(InvoiceSettings) }
|
446
375
|
attr_reader :invoice_settings
|
447
|
-
|
448
376
|
# List of subscription items, each with an attached price.
|
449
377
|
sig { returns(Stripe::ListObject) }
|
450
378
|
attr_reader :items
|
451
|
-
|
452
379
|
# Details of the most recent price migration that failed for the subscription.
|
453
380
|
sig { returns(T.nilable(LastPriceMigrationError)) }
|
454
381
|
attr_reader :last_price_migration_error
|
455
|
-
|
456
382
|
# The most recent invoice this subscription has generated.
|
457
383
|
sig { returns(T.nilable(T.any(String, Stripe::Invoice))) }
|
458
384
|
attr_reader :latest_invoice
|
459
|
-
|
460
385
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
461
386
|
sig { returns(T::Boolean) }
|
462
387
|
attr_reader :livemode
|
463
|
-
|
464
388
|
# 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.
|
465
389
|
sig { returns(T::Hash[String, String]) }
|
466
390
|
attr_reader :metadata
|
467
|
-
|
468
391
|
# Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.
|
469
392
|
sig { returns(T.nilable(Integer)) }
|
470
393
|
attr_reader :next_pending_invoice_item_invoice
|
471
|
-
|
472
394
|
# String representing the object's type. Objects of the same type share the same value.
|
473
395
|
sig { returns(String) }
|
474
396
|
attr_reader :object
|
475
|
-
|
476
397
|
# The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
|
477
398
|
sig { returns(T.nilable(T.any(String, Stripe::Account))) }
|
478
399
|
attr_reader :on_behalf_of
|
479
|
-
|
480
400
|
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
|
481
401
|
sig { returns(T.nilable(PauseCollection)) }
|
482
402
|
attr_reader :pause_collection
|
483
|
-
|
484
403
|
# Payment settings passed on to invoices created by the subscription.
|
485
404
|
sig { returns(T.nilable(PaymentSettings)) }
|
486
405
|
attr_reader :payment_settings
|
487
|
-
|
488
406
|
# Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
|
489
407
|
sig { returns(T.nilable(PendingInvoiceItemInterval)) }
|
490
408
|
attr_reader :pending_invoice_item_interval
|
491
|
-
|
492
409
|
# You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2).
|
493
410
|
sig { returns(T.nilable(T.any(String, Stripe::SetupIntent))) }
|
494
411
|
attr_reader :pending_setup_intent
|
495
|
-
|
496
412
|
# If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.
|
497
413
|
sig { returns(T.nilable(PendingUpdate)) }
|
498
414
|
attr_reader :pending_update
|
499
|
-
|
500
415
|
# Time period and invoice for a Subscription billed in advance.
|
501
416
|
sig { returns(T.nilable(Prebilling)) }
|
502
417
|
attr_reader :prebilling
|
503
|
-
|
504
418
|
# The schedule attached to the subscription
|
505
419
|
sig { returns(T.nilable(T.any(String, Stripe::SubscriptionSchedule))) }
|
506
420
|
attr_reader :schedule
|
507
|
-
|
508
421
|
# Date when the subscription was first created. The date might differ from the `created` date due to backdating.
|
509
422
|
sig { returns(Integer) }
|
510
423
|
attr_reader :start_date
|
511
|
-
|
512
424
|
# Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, `unpaid`, or `paused`.
|
513
425
|
#
|
514
426
|
# For `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` status. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal status, the open invoice will be voided and no further invoices will be generated.
|
@@ -522,56 +434,44 @@ module Stripe
|
|
522
434
|
# If subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.
|
523
435
|
sig { returns(String) }
|
524
436
|
attr_reader :status
|
525
|
-
|
526
437
|
# ID of the test clock this subscription belongs to.
|
527
438
|
sig { returns(T.nilable(T.any(String, Stripe::TestHelpers::TestClock))) }
|
528
439
|
attr_reader :test_clock
|
529
|
-
|
530
440
|
# The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
|
531
441
|
sig { returns(T.nilable(TransferData)) }
|
532
442
|
attr_reader :transfer_data
|
533
|
-
|
534
443
|
# If the subscription has a trial, the end of that trial.
|
535
444
|
sig { returns(T.nilable(Integer)) }
|
536
445
|
attr_reader :trial_end
|
537
|
-
|
538
446
|
# Settings related to subscription trials.
|
539
447
|
sig { returns(T.nilable(TrialSettings)) }
|
540
448
|
attr_reader :trial_settings
|
541
|
-
|
542
449
|
# If the subscription has a trial, the beginning of that trial.
|
543
450
|
sig { returns(T.nilable(Integer)) }
|
544
451
|
attr_reader :trial_start
|
545
|
-
|
546
452
|
class CancelParams < Stripe::RequestParams
|
547
453
|
class CancellationDetails < Stripe::RequestParams
|
548
454
|
# Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
|
549
455
|
sig { returns(T.nilable(String)) }
|
550
456
|
attr_accessor :comment
|
551
|
-
|
552
457
|
# The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
|
553
458
|
sig { returns(T.nilable(String)) }
|
554
459
|
attr_accessor :feedback
|
555
|
-
|
556
460
|
sig { params(comment: T.nilable(String), feedback: T.nilable(String)).void }
|
557
461
|
def initialize(comment: nil, feedback: nil); end
|
558
462
|
end
|
559
463
|
# Details about why this subscription was cancelled
|
560
464
|
sig { returns(::Stripe::Subscription::CancelParams::CancellationDetails) }
|
561
465
|
attr_accessor :cancellation_details
|
562
|
-
|
563
466
|
# Specifies which fields in the response should be expanded.
|
564
467
|
sig { returns(T::Array[String]) }
|
565
468
|
attr_accessor :expand
|
566
|
-
|
567
469
|
# Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. Defaults to `false`.
|
568
470
|
sig { returns(T::Boolean) }
|
569
471
|
attr_accessor :invoice_now
|
570
|
-
|
571
472
|
# Will generate a proration invoice item that credits remaining unused time until the subscription period end. Defaults to `false`.
|
572
473
|
sig { returns(T::Boolean) }
|
573
474
|
attr_accessor :prorate
|
574
|
-
|
575
475
|
sig {
|
576
476
|
params(cancellation_details: ::Stripe::Subscription::CancelParams::CancellationDetails, expand: T::Array[String], invoice_now: T::Boolean, prorate: T::Boolean).void
|
577
477
|
}
|
@@ -581,7 +481,6 @@ module Stripe
|
|
581
481
|
# Specifies which fields in the response should be expanded.
|
582
482
|
sig { returns(T::Array[String]) }
|
583
483
|
attr_accessor :expand
|
584
|
-
|
585
484
|
sig { params(expand: T::Array[String]).void }
|
586
485
|
def initialize(expand: nil); end
|
587
486
|
end
|
@@ -593,11 +492,9 @@ module Stripe
|
|
593
492
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
594
493
|
sig { returns(String) }
|
595
494
|
attr_accessor :interval
|
596
|
-
|
597
495
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
598
496
|
sig { returns(Integer) }
|
599
497
|
attr_accessor :interval_count
|
600
|
-
|
601
498
|
sig { params(interval: String, interval_count: Integer).void }
|
602
499
|
def initialize(interval: nil, interval_count: nil); end
|
603
500
|
end
|
@@ -606,15 +503,12 @@ module Stripe
|
|
606
503
|
returns(::Stripe::Subscription::UpdateParams::AddInvoiceItem::Discount::DiscountEnd::Duration)
|
607
504
|
}
|
608
505
|
attr_accessor :duration
|
609
|
-
|
610
506
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
611
507
|
sig { returns(Integer) }
|
612
508
|
attr_accessor :timestamp
|
613
|
-
|
614
509
|
# The type of calculation made to determine when the discount ends.
|
615
510
|
sig { returns(String) }
|
616
511
|
attr_accessor :type
|
617
|
-
|
618
512
|
sig {
|
619
513
|
params(duration: ::Stripe::Subscription::UpdateParams::AddInvoiceItem::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
|
620
514
|
}
|
@@ -623,21 +517,17 @@ module Stripe
|
|
623
517
|
# ID of the coupon to create a new discount for.
|
624
518
|
sig { returns(String) }
|
625
519
|
attr_accessor :coupon
|
626
|
-
|
627
520
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
628
521
|
sig { returns(String) }
|
629
522
|
attr_accessor :discount
|
630
|
-
|
631
523
|
# Details to determine how long the discount should be applied for.
|
632
524
|
sig {
|
633
525
|
returns(::Stripe::Subscription::UpdateParams::AddInvoiceItem::Discount::DiscountEnd)
|
634
526
|
}
|
635
527
|
attr_accessor :discount_end
|
636
|
-
|
637
528
|
# ID of the promotion code to create a new discount for.
|
638
529
|
sig { returns(String) }
|
639
530
|
attr_accessor :promotion_code
|
640
|
-
|
641
531
|
sig {
|
642
532
|
params(coupon: String, discount: String, discount_end: ::Stripe::Subscription::UpdateParams::AddInvoiceItem::Discount::DiscountEnd, promotion_code: String).void
|
643
533
|
}
|
@@ -647,23 +537,18 @@ module Stripe
|
|
647
537
|
# 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).
|
648
538
|
sig { returns(String) }
|
649
539
|
attr_accessor :currency
|
650
|
-
|
651
540
|
# The ID of the product that this price will belong to.
|
652
541
|
sig { returns(String) }
|
653
542
|
attr_accessor :product
|
654
|
-
|
655
543
|
# 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.
|
656
544
|
sig { returns(String) }
|
657
545
|
attr_accessor :tax_behavior
|
658
|
-
|
659
546
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
|
660
547
|
sig { returns(Integer) }
|
661
548
|
attr_accessor :unit_amount
|
662
|
-
|
663
549
|
# 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.
|
664
550
|
sig { returns(String) }
|
665
551
|
attr_accessor :unit_amount_decimal
|
666
|
-
|
667
552
|
sig {
|
668
553
|
params(currency: String, product: String, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
|
669
554
|
}
|
@@ -678,23 +563,18 @@ module Stripe
|
|
678
563
|
# The coupons to redeem into discounts for the item.
|
679
564
|
sig { returns(T::Array[::Stripe::Subscription::UpdateParams::AddInvoiceItem::Discount]) }
|
680
565
|
attr_accessor :discounts
|
681
|
-
|
682
566
|
# The ID of the price object. One of `price` or `price_data` is required.
|
683
567
|
sig { returns(String) }
|
684
568
|
attr_accessor :price
|
685
|
-
|
686
569
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
687
570
|
sig { returns(::Stripe::Subscription::UpdateParams::AddInvoiceItem::PriceData) }
|
688
571
|
attr_accessor :price_data
|
689
|
-
|
690
572
|
# Quantity for this item. Defaults to 1.
|
691
573
|
sig { returns(Integer) }
|
692
574
|
attr_accessor :quantity
|
693
|
-
|
694
575
|
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
|
695
576
|
sig { returns(T.nilable(T::Array[String])) }
|
696
577
|
attr_accessor :tax_rates
|
697
|
-
|
698
578
|
sig {
|
699
579
|
params(discounts: T::Array[::Stripe::Subscription::UpdateParams::AddInvoiceItem::Discount], price: String, price_data: ::Stripe::Subscription::UpdateParams::AddInvoiceItem::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
|
700
580
|
}
|
@@ -711,22 +591,18 @@ module Stripe
|
|
711
591
|
# The connected account being referenced when `type` is `account`.
|
712
592
|
sig { returns(String) }
|
713
593
|
attr_accessor :account
|
714
|
-
|
715
594
|
# Type of the account referenced in the request.
|
716
595
|
sig { returns(String) }
|
717
596
|
attr_accessor :type
|
718
|
-
|
719
597
|
sig { params(account: String, type: String).void }
|
720
598
|
def initialize(account: nil, type: nil); end
|
721
599
|
end
|
722
600
|
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
|
723
601
|
sig { returns(T::Boolean) }
|
724
602
|
attr_accessor :enabled
|
725
|
-
|
726
603
|
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
|
727
604
|
sig { returns(::Stripe::Subscription::UpdateParams::AutomaticTax::Liability) }
|
728
605
|
attr_accessor :liability
|
729
|
-
|
730
606
|
sig {
|
731
607
|
params(enabled: T::Boolean, liability: ::Stripe::Subscription::UpdateParams::AutomaticTax::Liability).void
|
732
608
|
}
|
@@ -736,11 +612,9 @@ module Stripe
|
|
736
612
|
# Monetary threshold that triggers the subscription to advance to a new billing period
|
737
613
|
sig { returns(Integer) }
|
738
614
|
attr_accessor :amount_gte
|
739
|
-
|
740
615
|
# Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
|
741
616
|
sig { returns(T::Boolean) }
|
742
617
|
attr_accessor :reset_billing_cycle_anchor
|
743
|
-
|
744
618
|
sig { params(amount_gte: Integer, reset_billing_cycle_anchor: T::Boolean).void }
|
745
619
|
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
|
746
620
|
end
|
@@ -748,11 +622,9 @@ module Stripe
|
|
748
622
|
# Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
|
749
623
|
sig { returns(T.nilable(String)) }
|
750
624
|
attr_accessor :comment
|
751
|
-
|
752
625
|
# The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
|
753
626
|
sig { returns(T.nilable(String)) }
|
754
627
|
attr_accessor :feedback
|
755
|
-
|
756
628
|
sig { params(comment: T.nilable(String), feedback: T.nilable(String)).void }
|
757
629
|
def initialize(comment: nil, feedback: nil); end
|
758
630
|
end
|
@@ -762,26 +634,21 @@ module Stripe
|
|
762
634
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
763
635
|
sig { returns(String) }
|
764
636
|
attr_accessor :interval
|
765
|
-
|
766
637
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
767
638
|
sig { returns(Integer) }
|
768
639
|
attr_accessor :interval_count
|
769
|
-
|
770
640
|
sig { params(interval: String, interval_count: Integer).void }
|
771
641
|
def initialize(interval: nil, interval_count: nil); end
|
772
642
|
end
|
773
643
|
# Time span for the redeemed discount.
|
774
644
|
sig { returns(::Stripe::Subscription::UpdateParams::Discount::DiscountEnd::Duration) }
|
775
645
|
attr_accessor :duration
|
776
|
-
|
777
646
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
778
647
|
sig { returns(Integer) }
|
779
648
|
attr_accessor :timestamp
|
780
|
-
|
781
649
|
# The type of calculation made to determine when the discount ends.
|
782
650
|
sig { returns(String) }
|
783
651
|
attr_accessor :type
|
784
|
-
|
785
652
|
sig {
|
786
653
|
params(duration: ::Stripe::Subscription::UpdateParams::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
|
787
654
|
}
|
@@ -790,19 +657,15 @@ module Stripe
|
|
790
657
|
# ID of the coupon to create a new discount for.
|
791
658
|
sig { returns(String) }
|
792
659
|
attr_accessor :coupon
|
793
|
-
|
794
660
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
795
661
|
sig { returns(String) }
|
796
662
|
attr_accessor :discount
|
797
|
-
|
798
663
|
# Details to determine how long the discount should be applied for.
|
799
664
|
sig { returns(::Stripe::Subscription::UpdateParams::Discount::DiscountEnd) }
|
800
665
|
attr_accessor :discount_end
|
801
|
-
|
802
666
|
# ID of the promotion code to create a new discount for.
|
803
667
|
sig { returns(String) }
|
804
668
|
attr_accessor :promotion_code
|
805
|
-
|
806
669
|
sig {
|
807
670
|
params(coupon: String, discount: String, discount_end: ::Stripe::Subscription::UpdateParams::Discount::DiscountEnd, promotion_code: String).void
|
808
671
|
}
|
@@ -813,22 +676,18 @@ module Stripe
|
|
813
676
|
# The connected account being referenced when `type` is `account`.
|
814
677
|
sig { returns(String) }
|
815
678
|
attr_accessor :account
|
816
|
-
|
817
679
|
# Type of the account referenced in the request.
|
818
680
|
sig { returns(String) }
|
819
681
|
attr_accessor :type
|
820
|
-
|
821
682
|
sig { params(account: String, type: String).void }
|
822
683
|
def initialize(account: nil, type: nil); end
|
823
684
|
end
|
824
685
|
# The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
|
825
686
|
sig { returns(T.nilable(T::Array[String])) }
|
826
687
|
attr_accessor :account_tax_ids
|
827
|
-
|
828
688
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
829
689
|
sig { returns(::Stripe::Subscription::UpdateParams::InvoiceSettings::Issuer) }
|
830
690
|
attr_accessor :issuer
|
831
|
-
|
832
691
|
sig {
|
833
692
|
params(account_tax_ids: T.nilable(T::Array[String]), issuer: ::Stripe::Subscription::UpdateParams::InvoiceSettings::Issuer).void
|
834
693
|
}
|
@@ -839,7 +698,6 @@ module Stripe
|
|
839
698
|
# Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
|
840
699
|
sig { returns(Integer) }
|
841
700
|
attr_accessor :usage_gte
|
842
|
-
|
843
701
|
sig { params(usage_gte: Integer).void }
|
844
702
|
def initialize(usage_gte: nil); end
|
845
703
|
end
|
@@ -849,11 +707,9 @@ module Stripe
|
|
849
707
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
850
708
|
sig { returns(String) }
|
851
709
|
attr_accessor :interval
|
852
|
-
|
853
710
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
854
711
|
sig { returns(Integer) }
|
855
712
|
attr_accessor :interval_count
|
856
|
-
|
857
713
|
sig { params(interval: String, interval_count: Integer).void }
|
858
714
|
def initialize(interval: nil, interval_count: nil); end
|
859
715
|
end
|
@@ -862,15 +718,12 @@ module Stripe
|
|
862
718
|
returns(::Stripe::Subscription::UpdateParams::Item::Discount::DiscountEnd::Duration)
|
863
719
|
}
|
864
720
|
attr_accessor :duration
|
865
|
-
|
866
721
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
867
722
|
sig { returns(Integer) }
|
868
723
|
attr_accessor :timestamp
|
869
|
-
|
870
724
|
# The type of calculation made to determine when the discount ends.
|
871
725
|
sig { returns(String) }
|
872
726
|
attr_accessor :type
|
873
|
-
|
874
727
|
sig {
|
875
728
|
params(duration: ::Stripe::Subscription::UpdateParams::Item::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
|
876
729
|
}
|
@@ -879,19 +732,15 @@ module Stripe
|
|
879
732
|
# ID of the coupon to create a new discount for.
|
880
733
|
sig { returns(String) }
|
881
734
|
attr_accessor :coupon
|
882
|
-
|
883
735
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
884
736
|
sig { returns(String) }
|
885
737
|
attr_accessor :discount
|
886
|
-
|
887
738
|
# Details to determine how long the discount should be applied for.
|
888
739
|
sig { returns(::Stripe::Subscription::UpdateParams::Item::Discount::DiscountEnd) }
|
889
740
|
attr_accessor :discount_end
|
890
|
-
|
891
741
|
# ID of the promotion code to create a new discount for.
|
892
742
|
sig { returns(String) }
|
893
743
|
attr_accessor :promotion_code
|
894
|
-
|
895
744
|
sig {
|
896
745
|
params(coupon: String, discount: String, discount_end: ::Stripe::Subscription::UpdateParams::Item::Discount::DiscountEnd, promotion_code: String).void
|
897
746
|
}
|
@@ -902,38 +751,30 @@ module Stripe
|
|
902
751
|
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
903
752
|
sig { returns(String) }
|
904
753
|
attr_accessor :interval
|
905
|
-
|
906
754
|
# 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).
|
907
755
|
sig { returns(Integer) }
|
908
756
|
attr_accessor :interval_count
|
909
|
-
|
910
757
|
sig { params(interval: String, interval_count: Integer).void }
|
911
758
|
def initialize(interval: nil, interval_count: nil); end
|
912
759
|
end
|
913
760
|
# 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).
|
914
761
|
sig { returns(String) }
|
915
762
|
attr_accessor :currency
|
916
|
-
|
917
763
|
# The ID of the product that this price will belong to.
|
918
764
|
sig { returns(String) }
|
919
765
|
attr_accessor :product
|
920
|
-
|
921
766
|
# The recurring components of a price such as `interval` and `interval_count`.
|
922
767
|
sig { returns(::Stripe::Subscription::UpdateParams::Item::PriceData::Recurring) }
|
923
768
|
attr_accessor :recurring
|
924
|
-
|
925
769
|
# 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.
|
926
770
|
sig { returns(String) }
|
927
771
|
attr_accessor :tax_behavior
|
928
|
-
|
929
772
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
930
773
|
sig { returns(Integer) }
|
931
774
|
attr_accessor :unit_amount
|
932
|
-
|
933
775
|
# 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.
|
934
776
|
sig { returns(String) }
|
935
777
|
attr_accessor :unit_amount_decimal
|
936
|
-
|
937
778
|
sig {
|
938
779
|
params(currency: String, product: String, recurring: ::Stripe::Subscription::UpdateParams::Item::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
|
939
780
|
}
|
@@ -949,47 +790,36 @@ module Stripe
|
|
949
790
|
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
|
950
791
|
sig { returns(T.nilable(::Stripe::Subscription::UpdateParams::Item::BillingThresholds)) }
|
951
792
|
attr_accessor :billing_thresholds
|
952
|
-
|
953
793
|
# Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
|
954
794
|
sig { returns(T::Boolean) }
|
955
795
|
attr_accessor :clear_usage
|
956
|
-
|
957
796
|
# A flag that, if set to `true`, will delete the specified item.
|
958
797
|
sig { returns(T::Boolean) }
|
959
798
|
attr_accessor :deleted
|
960
|
-
|
961
799
|
# The coupons to redeem into discounts for the subscription item.
|
962
800
|
sig { returns(T.nilable(T::Array[::Stripe::Subscription::UpdateParams::Item::Discount])) }
|
963
801
|
attr_accessor :discounts
|
964
|
-
|
965
802
|
# Subscription item to update.
|
966
803
|
sig { returns(String) }
|
967
804
|
attr_accessor :id
|
968
|
-
|
969
805
|
# 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`.
|
970
806
|
sig { returns(T.nilable(T::Hash[String, String])) }
|
971
807
|
attr_accessor :metadata
|
972
|
-
|
973
808
|
# Plan ID for this item, as a string.
|
974
809
|
sig { returns(String) }
|
975
810
|
attr_accessor :plan
|
976
|
-
|
977
811
|
# The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
|
978
812
|
sig { returns(String) }
|
979
813
|
attr_accessor :price
|
980
|
-
|
981
814
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
982
815
|
sig { returns(::Stripe::Subscription::UpdateParams::Item::PriceData) }
|
983
816
|
attr_accessor :price_data
|
984
|
-
|
985
817
|
# Quantity for this item.
|
986
818
|
sig { returns(Integer) }
|
987
819
|
attr_accessor :quantity
|
988
|
-
|
989
820
|
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
990
821
|
sig { returns(T.nilable(T::Array[String])) }
|
991
822
|
attr_accessor :tax_rates
|
992
|
-
|
993
823
|
sig {
|
994
824
|
params(billing_thresholds: T.nilable(::Stripe::Subscription::UpdateParams::Item::BillingThresholds), clear_usage: T::Boolean, deleted: T::Boolean, discounts: T.nilable(T::Array[::Stripe::Subscription::UpdateParams::Item::Discount]), id: String, metadata: T.nilable(T::Hash[String, String]), plan: String, price: String, price_data: ::Stripe::Subscription::UpdateParams::Item::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
|
995
825
|
}
|
@@ -1011,11 +841,9 @@ module Stripe
|
|
1011
841
|
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
1012
842
|
sig { returns(String) }
|
1013
843
|
attr_accessor :behavior
|
1014
|
-
|
1015
844
|
# The time after which the subscription will resume collecting payments.
|
1016
845
|
sig { returns(Integer) }
|
1017
846
|
attr_accessor :resumes_at
|
1018
|
-
|
1019
847
|
sig { params(behavior: String, resumes_at: Integer).void }
|
1020
848
|
def initialize(behavior: nil, resumes_at: nil); end
|
1021
849
|
end
|
@@ -1026,7 +854,6 @@ module Stripe
|
|
1026
854
|
# Transaction type of the mandate.
|
1027
855
|
sig { returns(String) }
|
1028
856
|
attr_accessor :transaction_type
|
1029
|
-
|
1030
857
|
sig { params(transaction_type: String).void }
|
1031
858
|
def initialize(transaction_type: nil); end
|
1032
859
|
end
|
@@ -1035,11 +862,9 @@ module Stripe
|
|
1035
862
|
returns(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions)
|
1036
863
|
}
|
1037
864
|
attr_accessor :mandate_options
|
1038
|
-
|
1039
865
|
# Verification method for the intent
|
1040
866
|
sig { returns(String) }
|
1041
867
|
attr_accessor :verification_method
|
1042
|
-
|
1043
868
|
sig {
|
1044
869
|
params(mandate_options: ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions, verification_method: String).void
|
1045
870
|
}
|
@@ -1049,7 +874,6 @@ module Stripe
|
|
1049
874
|
# Preferred language of the Bancontact authorization page that the customer is redirected to.
|
1050
875
|
sig { returns(String) }
|
1051
876
|
attr_accessor :preferred_language
|
1052
|
-
|
1053
877
|
sig { params(preferred_language: String).void }
|
1054
878
|
def initialize(preferred_language: nil); end
|
1055
879
|
end
|
@@ -1058,15 +882,12 @@ module Stripe
|
|
1058
882
|
# Amount to be charged for future payments.
|
1059
883
|
sig { returns(Integer) }
|
1060
884
|
attr_accessor :amount
|
1061
|
-
|
1062
885
|
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
|
1063
886
|
sig { returns(String) }
|
1064
887
|
attr_accessor :amount_type
|
1065
|
-
|
1066
888
|
# A description of the mandate or subscription that is meant to be displayed to the customer.
|
1067
889
|
sig { returns(String) }
|
1068
890
|
attr_accessor :description
|
1069
|
-
|
1070
891
|
sig { params(amount: Integer, amount_type: String, description: String).void }
|
1071
892
|
def initialize(amount: nil, amount_type: nil, description: nil); end
|
1072
893
|
end
|
@@ -1075,15 +896,12 @@ module Stripe
|
|
1075
896
|
returns(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions)
|
1076
897
|
}
|
1077
898
|
attr_accessor :mandate_options
|
1078
|
-
|
1079
899
|
# Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
|
1080
900
|
sig { returns(String) }
|
1081
901
|
attr_accessor :network
|
1082
|
-
|
1083
902
|
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
|
1084
903
|
sig { returns(String) }
|
1085
904
|
attr_accessor :request_three_d_secure
|
1086
|
-
|
1087
905
|
sig {
|
1088
906
|
params(mandate_options: ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions, network: String, request_three_d_secure: String).void
|
1089
907
|
}
|
@@ -1095,7 +913,6 @@ module Stripe
|
|
1095
913
|
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
|
1096
914
|
sig { returns(String) }
|
1097
915
|
attr_accessor :country
|
1098
|
-
|
1099
916
|
sig { params(country: String).void }
|
1100
917
|
def initialize(country: nil); end
|
1101
918
|
end
|
@@ -1104,11 +921,9 @@ module Stripe
|
|
1104
921
|
returns(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)
|
1105
922
|
}
|
1106
923
|
attr_accessor :eu_bank_transfer
|
1107
|
-
|
1108
924
|
# The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
|
1109
925
|
sig { returns(String) }
|
1110
926
|
attr_accessor :type
|
1111
|
-
|
1112
927
|
sig {
|
1113
928
|
params(eu_bank_transfer: ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer, type: String).void
|
1114
929
|
}
|
@@ -1119,11 +934,9 @@ module Stripe
|
|
1119
934
|
returns(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer)
|
1120
935
|
}
|
1121
936
|
attr_accessor :bank_transfer
|
1122
|
-
|
1123
937
|
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
|
1124
938
|
sig { returns(String) }
|
1125
939
|
attr_accessor :funding_type
|
1126
|
-
|
1127
940
|
sig {
|
1128
941
|
params(bank_transfer: ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer, funding_type: String).void
|
1129
942
|
}
|
@@ -1144,11 +957,9 @@ module Stripe
|
|
1144
957
|
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
1145
958
|
sig { returns(T::Array[String]) }
|
1146
959
|
attr_accessor :account_subcategories
|
1147
|
-
|
1148
960
|
# ID of the institution to use to filter for selectable accounts.
|
1149
961
|
sig { returns(String) }
|
1150
962
|
attr_accessor :institution
|
1151
|
-
|
1152
963
|
sig { params(account_subcategories: T::Array[String], institution: String).void }
|
1153
964
|
def initialize(account_subcategories: nil, institution: nil); end
|
1154
965
|
end
|
@@ -1157,15 +968,12 @@ module Stripe
|
|
1157
968
|
returns(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)
|
1158
969
|
}
|
1159
970
|
attr_accessor :filters
|
1160
|
-
|
1161
971
|
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
|
1162
972
|
sig { returns(T::Array[String]) }
|
1163
973
|
attr_accessor :permissions
|
1164
|
-
|
1165
974
|
# List of data features that you would like to retrieve upon account creation.
|
1166
975
|
sig { returns(T::Array[String]) }
|
1167
976
|
attr_accessor :prefetch
|
1168
|
-
|
1169
977
|
sig {
|
1170
978
|
params(filters: ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters, permissions: T::Array[String], prefetch: T::Array[String]).void
|
1171
979
|
}
|
@@ -1176,11 +984,9 @@ module Stripe
|
|
1176
984
|
returns(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections)
|
1177
985
|
}
|
1178
986
|
attr_accessor :financial_connections
|
1179
|
-
|
1180
987
|
# Verification method for the intent
|
1181
988
|
sig { returns(String) }
|
1182
989
|
attr_accessor :verification_method
|
1183
|
-
|
1184
990
|
sig {
|
1185
991
|
params(financial_connections: ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections, verification_method: String).void
|
1186
992
|
}
|
@@ -1191,49 +997,41 @@ module Stripe
|
|
1191
997
|
returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit))
|
1192
998
|
}
|
1193
999
|
attr_accessor :acss_debit
|
1194
|
-
|
1195
1000
|
# This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
|
1196
1001
|
sig {
|
1197
1002
|
returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact))
|
1198
1003
|
}
|
1199
1004
|
attr_accessor :bancontact
|
1200
|
-
|
1201
1005
|
# This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
|
1202
1006
|
sig {
|
1203
1007
|
returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Card))
|
1204
1008
|
}
|
1205
1009
|
attr_accessor :card
|
1206
|
-
|
1207
1010
|
# This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
|
1208
1011
|
sig {
|
1209
1012
|
returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance))
|
1210
1013
|
}
|
1211
1014
|
attr_accessor :customer_balance
|
1212
|
-
|
1213
1015
|
# This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
|
1214
1016
|
sig {
|
1215
1017
|
returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer))
|
1216
1018
|
}
|
1217
1019
|
attr_accessor :id_bank_transfer
|
1218
|
-
|
1219
1020
|
# This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
|
1220
1021
|
sig {
|
1221
1022
|
returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini))
|
1222
1023
|
}
|
1223
1024
|
attr_accessor :konbini
|
1224
|
-
|
1225
1025
|
# This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
|
1226
1026
|
sig {
|
1227
1027
|
returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit))
|
1228
1028
|
}
|
1229
1029
|
attr_accessor :sepa_debit
|
1230
|
-
|
1231
1030
|
# This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
|
1232
1031
|
sig {
|
1233
1032
|
returns(T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))
|
1234
1033
|
}
|
1235
1034
|
attr_accessor :us_bank_account
|
1236
|
-
|
1237
1035
|
sig {
|
1238
1036
|
params(acss_debit: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::AcssDebit), bancontact: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Bancontact), card: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Card), customer_balance: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance), id_bank_transfer: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer), konbini: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::Konbini), sepa_debit: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::SepaDebit), us_bank_account: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)).void
|
1239
1037
|
}
|
@@ -1251,15 +1049,12 @@ module Stripe
|
|
1251
1049
|
# Payment-method-specific configuration to provide to invoices created by the subscription.
|
1252
1050
|
sig { returns(::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions) }
|
1253
1051
|
attr_accessor :payment_method_options
|
1254
|
-
|
1255
1052
|
# The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration
|
1256
1053
|
sig { returns(T.nilable(T::Array[String])) }
|
1257
1054
|
attr_accessor :payment_method_types
|
1258
|
-
|
1259
1055
|
# Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.
|
1260
1056
|
sig { returns(String) }
|
1261
1057
|
attr_accessor :save_default_payment_method
|
1262
|
-
|
1263
1058
|
sig {
|
1264
1059
|
params(payment_method_options: ::Stripe::Subscription::UpdateParams::PaymentSettings::PaymentMethodOptions, payment_method_types: T.nilable(T::Array[String]), save_default_payment_method: String).void
|
1265
1060
|
}
|
@@ -1273,11 +1068,9 @@ module Stripe
|
|
1273
1068
|
# Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
|
1274
1069
|
sig { returns(String) }
|
1275
1070
|
attr_accessor :interval
|
1276
|
-
|
1277
1071
|
# The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
|
1278
1072
|
sig { returns(Integer) }
|
1279
1073
|
attr_accessor :interval_count
|
1280
|
-
|
1281
1074
|
sig { params(interval: String, interval_count: Integer).void }
|
1282
1075
|
def initialize(interval: nil, interval_count: nil); end
|
1283
1076
|
end
|
@@ -1285,11 +1078,9 @@ module Stripe
|
|
1285
1078
|
# This is used to determine the number of billing cycles to prebill.
|
1286
1079
|
sig { returns(Integer) }
|
1287
1080
|
attr_accessor :iterations
|
1288
|
-
|
1289
1081
|
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
1290
1082
|
sig { returns(String) }
|
1291
1083
|
attr_accessor :update_behavior
|
1292
|
-
|
1293
1084
|
sig { params(iterations: Integer, update_behavior: String).void }
|
1294
1085
|
def initialize(iterations: nil, update_behavior: nil); end
|
1295
1086
|
end
|
@@ -1297,11 +1088,9 @@ module Stripe
|
|
1297
1088
|
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
|
1298
1089
|
sig { returns(Float) }
|
1299
1090
|
attr_accessor :amount_percent
|
1300
|
-
|
1301
1091
|
# ID of an existing, connected Stripe account.
|
1302
1092
|
sig { returns(String) }
|
1303
1093
|
attr_accessor :destination
|
1304
|
-
|
1305
1094
|
sig { params(amount_percent: Float, destination: String).void }
|
1306
1095
|
def initialize(amount_percent: nil, destination: nil); end
|
1307
1096
|
end
|
@@ -1310,14 +1099,12 @@ module Stripe
|
|
1310
1099
|
# Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
|
1311
1100
|
sig { returns(String) }
|
1312
1101
|
attr_accessor :missing_payment_method
|
1313
|
-
|
1314
1102
|
sig { params(missing_payment_method: String).void }
|
1315
1103
|
def initialize(missing_payment_method: nil); end
|
1316
1104
|
end
|
1317
1105
|
# Defines how the subscription should behave when the user's free trial ends.
|
1318
1106
|
sig { returns(::Stripe::Subscription::UpdateParams::TrialSettings::EndBehavior) }
|
1319
1107
|
attr_accessor :end_behavior
|
1320
|
-
|
1321
1108
|
sig {
|
1322
1109
|
params(end_behavior: ::Stripe::Subscription::UpdateParams::TrialSettings::EndBehavior).void
|
1323
1110
|
}
|
@@ -1326,95 +1113,72 @@ module Stripe
|
|
1326
1113
|
# A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
|
1327
1114
|
sig { returns(T::Array[::Stripe::Subscription::UpdateParams::AddInvoiceItem]) }
|
1328
1115
|
attr_accessor :add_invoice_items
|
1329
|
-
|
1330
1116
|
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
|
1331
1117
|
sig { returns(T.nilable(Float)) }
|
1332
1118
|
attr_accessor :application_fee_percent
|
1333
|
-
|
1334
1119
|
# Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
|
1335
1120
|
sig { returns(::Stripe::Subscription::UpdateParams::AutomaticTax) }
|
1336
1121
|
attr_accessor :automatic_tax
|
1337
|
-
|
1338
1122
|
# Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
|
1339
1123
|
sig { returns(String) }
|
1340
1124
|
attr_accessor :billing_cycle_anchor
|
1341
|
-
|
1342
1125
|
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
|
1343
1126
|
sig { returns(T.nilable(::Stripe::Subscription::UpdateParams::BillingThresholds)) }
|
1344
1127
|
attr_accessor :billing_thresholds
|
1345
|
-
|
1346
1128
|
# A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
|
1347
1129
|
sig { returns(T.nilable(Integer)) }
|
1348
1130
|
attr_accessor :cancel_at
|
1349
|
-
|
1350
1131
|
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
|
1351
1132
|
sig { returns(T::Boolean) }
|
1352
1133
|
attr_accessor :cancel_at_period_end
|
1353
|
-
|
1354
1134
|
# Details about why this subscription was cancelled
|
1355
1135
|
sig { returns(::Stripe::Subscription::UpdateParams::CancellationDetails) }
|
1356
1136
|
attr_accessor :cancellation_details
|
1357
|
-
|
1358
1137
|
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.
|
1359
1138
|
sig { returns(String) }
|
1360
1139
|
attr_accessor :collection_method
|
1361
|
-
|
1362
1140
|
# The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
|
1363
1141
|
sig { returns(String) }
|
1364
1142
|
attr_accessor :coupon
|
1365
|
-
|
1366
1143
|
# Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
|
1367
1144
|
sig { returns(Integer) }
|
1368
1145
|
attr_accessor :days_until_due
|
1369
|
-
|
1370
1146
|
# ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
|
1371
1147
|
sig { returns(String) }
|
1372
1148
|
attr_accessor :default_payment_method
|
1373
|
-
|
1374
1149
|
# ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
|
1375
1150
|
sig { returns(T.nilable(String)) }
|
1376
1151
|
attr_accessor :default_source
|
1377
|
-
|
1378
1152
|
# The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates.
|
1379
1153
|
sig { returns(T.nilable(T::Array[String])) }
|
1380
1154
|
attr_accessor :default_tax_rates
|
1381
|
-
|
1382
1155
|
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
|
1383
1156
|
sig { returns(T.nilable(String)) }
|
1384
1157
|
attr_accessor :description
|
1385
|
-
|
1386
1158
|
# The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer.
|
1387
1159
|
sig { returns(T.nilable(T::Array[::Stripe::Subscription::UpdateParams::Discount])) }
|
1388
1160
|
attr_accessor :discounts
|
1389
|
-
|
1390
1161
|
# Specifies which fields in the response should be expanded.
|
1391
1162
|
sig { returns(T::Array[String]) }
|
1392
1163
|
attr_accessor :expand
|
1393
|
-
|
1394
1164
|
# All invoices will be billed using the specified settings.
|
1395
1165
|
sig { returns(::Stripe::Subscription::UpdateParams::InvoiceSettings) }
|
1396
1166
|
attr_accessor :invoice_settings
|
1397
|
-
|
1398
1167
|
# A list of up to 20 subscription items, each with an attached price.
|
1399
1168
|
sig { returns(T::Array[::Stripe::Subscription::UpdateParams::Item]) }
|
1400
1169
|
attr_accessor :items
|
1401
|
-
|
1402
1170
|
# 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`.
|
1403
1171
|
sig { returns(T.nilable(T::Hash[String, String])) }
|
1404
1172
|
attr_accessor :metadata
|
1405
|
-
|
1406
1173
|
# Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
|
1407
1174
|
sig { returns(T::Boolean) }
|
1408
1175
|
attr_accessor :off_session
|
1409
|
-
|
1410
1176
|
# The account on behalf of which to charge, for each of the subscription's invoices.
|
1411
1177
|
sig { returns(T.nilable(String)) }
|
1412
1178
|
attr_accessor :on_behalf_of
|
1413
|
-
|
1414
1179
|
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
|
1415
1180
|
sig { returns(T.nilable(::Stripe::Subscription::UpdateParams::PauseCollection)) }
|
1416
1181
|
attr_accessor :pause_collection
|
1417
|
-
|
1418
1182
|
# Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
|
1419
1183
|
#
|
1420
1184
|
# Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
|
@@ -1424,47 +1188,36 @@ module Stripe
|
|
1424
1188
|
# Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.
|
1425
1189
|
sig { returns(String) }
|
1426
1190
|
attr_accessor :payment_behavior
|
1427
|
-
|
1428
1191
|
# Payment settings to pass to invoices created by the subscription.
|
1429
1192
|
sig { returns(::Stripe::Subscription::UpdateParams::PaymentSettings) }
|
1430
1193
|
attr_accessor :payment_settings
|
1431
|
-
|
1432
1194
|
# Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
|
1433
1195
|
sig { returns(T.nilable(::Stripe::Subscription::UpdateParams::PendingInvoiceItemInterval)) }
|
1434
1196
|
attr_accessor :pending_invoice_item_interval
|
1435
|
-
|
1436
1197
|
# If specified, the invoicing for the given billing cycle iterations will be processed now.
|
1437
1198
|
sig { returns(::Stripe::Subscription::UpdateParams::Prebilling) }
|
1438
1199
|
attr_accessor :prebilling
|
1439
|
-
|
1440
1200
|
# The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
|
1441
1201
|
sig { returns(String) }
|
1442
1202
|
attr_accessor :promotion_code
|
1443
|
-
|
1444
1203
|
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
|
1445
1204
|
sig { returns(String) }
|
1446
1205
|
attr_accessor :proration_behavior
|
1447
|
-
|
1448
1206
|
# If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.
|
1449
1207
|
sig { returns(Integer) }
|
1450
1208
|
attr_accessor :proration_date
|
1451
|
-
|
1452
1209
|
# If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value.
|
1453
1210
|
sig { returns(T.nilable(::Stripe::Subscription::UpdateParams::TransferData)) }
|
1454
1211
|
attr_accessor :transfer_data
|
1455
|
-
|
1456
1212
|
# Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.
|
1457
1213
|
sig { returns(T.any(String, Integer)) }
|
1458
1214
|
attr_accessor :trial_end
|
1459
|
-
|
1460
1215
|
# Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
|
1461
1216
|
sig { returns(T::Boolean) }
|
1462
1217
|
attr_accessor :trial_from_plan
|
1463
|
-
|
1464
1218
|
# Settings related to subscription trials.
|
1465
1219
|
sig { returns(::Stripe::Subscription::UpdateParams::TrialSettings) }
|
1466
1220
|
attr_accessor :trial_settings
|
1467
|
-
|
1468
1221
|
sig {
|
1469
1222
|
params(add_invoice_items: T::Array[::Stripe::Subscription::UpdateParams::AddInvoiceItem], application_fee_percent: T.nilable(Float), automatic_tax: ::Stripe::Subscription::UpdateParams::AutomaticTax, billing_cycle_anchor: String, billing_thresholds: T.nilable(::Stripe::Subscription::UpdateParams::BillingThresholds), cancel_at: T.nilable(Integer), cancel_at_period_end: T::Boolean, cancellation_details: ::Stripe::Subscription::UpdateParams::CancellationDetails, collection_method: String, coupon: String, days_until_due: Integer, default_payment_method: String, default_source: T.nilable(String), default_tax_rates: T.nilable(T::Array[String]), description: T.nilable(String), discounts: T.nilable(T::Array[::Stripe::Subscription::UpdateParams::Discount]), expand: T::Array[String], invoice_settings: ::Stripe::Subscription::UpdateParams::InvoiceSettings, items: T::Array[::Stripe::Subscription::UpdateParams::Item], metadata: T.nilable(T::Hash[String, String]), off_session: T::Boolean, on_behalf_of: T.nilable(String), pause_collection: T.nilable(::Stripe::Subscription::UpdateParams::PauseCollection), payment_behavior: String, payment_settings: ::Stripe::Subscription::UpdateParams::PaymentSettings, pending_invoice_item_interval: T.nilable(::Stripe::Subscription::UpdateParams::PendingInvoiceItemInterval), prebilling: ::Stripe::Subscription::UpdateParams::Prebilling, promotion_code: String, proration_behavior: String, proration_date: Integer, transfer_data: T.nilable(::Stripe::Subscription::UpdateParams::TransferData), trial_end: T.any(String, Integer), trial_from_plan: T::Boolean, trial_settings: ::Stripe::Subscription::UpdateParams::TrialSettings).void
|
1470
1223
|
}
|
@@ -1513,7 +1266,6 @@ module Stripe
|
|
1513
1266
|
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
|
1514
1267
|
sig { returns(T::Boolean) }
|
1515
1268
|
attr_accessor :enabled
|
1516
|
-
|
1517
1269
|
sig { params(enabled: T::Boolean).void }
|
1518
1270
|
def initialize(enabled: nil); end
|
1519
1271
|
end
|
@@ -1521,19 +1273,15 @@ module Stripe
|
|
1521
1273
|
# Minimum value to filter by (exclusive)
|
1522
1274
|
sig { returns(Integer) }
|
1523
1275
|
attr_accessor :gt
|
1524
|
-
|
1525
1276
|
# Minimum value to filter by (inclusive)
|
1526
1277
|
sig { returns(Integer) }
|
1527
1278
|
attr_accessor :gte
|
1528
|
-
|
1529
1279
|
# Maximum value to filter by (exclusive)
|
1530
1280
|
sig { returns(Integer) }
|
1531
1281
|
attr_accessor :lt
|
1532
|
-
|
1533
1282
|
# Maximum value to filter by (inclusive)
|
1534
1283
|
sig { returns(Integer) }
|
1535
1284
|
attr_accessor :lte
|
1536
|
-
|
1537
1285
|
sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
|
1538
1286
|
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
|
1539
1287
|
end
|
@@ -1541,19 +1289,15 @@ module Stripe
|
|
1541
1289
|
# Minimum value to filter by (exclusive)
|
1542
1290
|
sig { returns(Integer) }
|
1543
1291
|
attr_accessor :gt
|
1544
|
-
|
1545
1292
|
# Minimum value to filter by (inclusive)
|
1546
1293
|
sig { returns(Integer) }
|
1547
1294
|
attr_accessor :gte
|
1548
|
-
|
1549
1295
|
# Maximum value to filter by (exclusive)
|
1550
1296
|
sig { returns(Integer) }
|
1551
1297
|
attr_accessor :lt
|
1552
|
-
|
1553
1298
|
# Maximum value to filter by (inclusive)
|
1554
1299
|
sig { returns(Integer) }
|
1555
1300
|
attr_accessor :lte
|
1556
|
-
|
1557
1301
|
sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
|
1558
1302
|
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
|
1559
1303
|
end
|
@@ -1561,78 +1305,60 @@ module Stripe
|
|
1561
1305
|
# Minimum value to filter by (exclusive)
|
1562
1306
|
sig { returns(Integer) }
|
1563
1307
|
attr_accessor :gt
|
1564
|
-
|
1565
1308
|
# Minimum value to filter by (inclusive)
|
1566
1309
|
sig { returns(Integer) }
|
1567
1310
|
attr_accessor :gte
|
1568
|
-
|
1569
1311
|
# Maximum value to filter by (exclusive)
|
1570
1312
|
sig { returns(Integer) }
|
1571
1313
|
attr_accessor :lt
|
1572
|
-
|
1573
1314
|
# Maximum value to filter by (inclusive)
|
1574
1315
|
sig { returns(Integer) }
|
1575
1316
|
attr_accessor :lte
|
1576
|
-
|
1577
1317
|
sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
|
1578
1318
|
def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
|
1579
1319
|
end
|
1580
1320
|
# Filter subscriptions by their automatic tax settings.
|
1581
1321
|
sig { returns(::Stripe::Subscription::ListParams::AutomaticTax) }
|
1582
1322
|
attr_accessor :automatic_tax
|
1583
|
-
|
1584
1323
|
# The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.
|
1585
1324
|
sig { returns(String) }
|
1586
1325
|
attr_accessor :collection_method
|
1587
|
-
|
1588
1326
|
# Only return subscriptions that were created during the given date interval.
|
1589
1327
|
sig { returns(T.any(::Stripe::Subscription::ListParams::Created, Integer)) }
|
1590
1328
|
attr_accessor :created
|
1591
|
-
|
1592
1329
|
# Only return subscriptions whose current_period_end falls within the given date interval.
|
1593
1330
|
sig { returns(T.any(::Stripe::Subscription::ListParams::CurrentPeriodEnd, Integer)) }
|
1594
1331
|
attr_accessor :current_period_end
|
1595
|
-
|
1596
1332
|
# Only return subscriptions whose current_period_start falls within the given date interval.
|
1597
1333
|
sig { returns(T.any(::Stripe::Subscription::ListParams::CurrentPeriodStart, Integer)) }
|
1598
1334
|
attr_accessor :current_period_start
|
1599
|
-
|
1600
1335
|
# The ID of the customer whose subscriptions will be retrieved.
|
1601
1336
|
sig { returns(String) }
|
1602
1337
|
attr_accessor :customer
|
1603
|
-
|
1604
1338
|
# 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.
|
1605
1339
|
sig { returns(String) }
|
1606
1340
|
attr_accessor :ending_before
|
1607
|
-
|
1608
1341
|
# Specifies which fields in the response should be expanded.
|
1609
1342
|
sig { returns(T::Array[String]) }
|
1610
1343
|
attr_accessor :expand
|
1611
|
-
|
1612
1344
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
1613
1345
|
sig { returns(Integer) }
|
1614
1346
|
attr_accessor :limit
|
1615
|
-
|
1616
1347
|
# The ID of the plan whose subscriptions will be retrieved.
|
1617
1348
|
sig { returns(String) }
|
1618
1349
|
attr_accessor :plan
|
1619
|
-
|
1620
1350
|
# Filter for subscriptions that contain this recurring price ID.
|
1621
1351
|
sig { returns(String) }
|
1622
1352
|
attr_accessor :price
|
1623
|
-
|
1624
1353
|
# 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.
|
1625
1354
|
sig { returns(String) }
|
1626
1355
|
attr_accessor :starting_after
|
1627
|
-
|
1628
1356
|
# The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.
|
1629
1357
|
sig { returns(String) }
|
1630
1358
|
attr_accessor :status
|
1631
|
-
|
1632
1359
|
# Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.
|
1633
1360
|
sig { returns(String) }
|
1634
1361
|
attr_accessor :test_clock
|
1635
|
-
|
1636
1362
|
sig {
|
1637
1363
|
params(automatic_tax: ::Stripe::Subscription::ListParams::AutomaticTax, collection_method: String, created: T.any(::Stripe::Subscription::ListParams::Created, Integer), current_period_end: T.any(::Stripe::Subscription::ListParams::CurrentPeriodEnd, Integer), current_period_start: T.any(::Stripe::Subscription::ListParams::CurrentPeriodStart, Integer), customer: String, ending_before: String, expand: T::Array[String], limit: Integer, plan: String, price: String, starting_after: String, status: String, test_clock: String).void
|
1638
1364
|
}
|
@@ -1661,11 +1387,9 @@ module Stripe
|
|
1661
1387
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1662
1388
|
sig { returns(String) }
|
1663
1389
|
attr_accessor :interval
|
1664
|
-
|
1665
1390
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1666
1391
|
sig { returns(Integer) }
|
1667
1392
|
attr_accessor :interval_count
|
1668
|
-
|
1669
1393
|
sig { params(interval: String, interval_count: Integer).void }
|
1670
1394
|
def initialize(interval: nil, interval_count: nil); end
|
1671
1395
|
end
|
@@ -1674,15 +1398,12 @@ module Stripe
|
|
1674
1398
|
returns(::Stripe::Subscription::CreateParams::AddInvoiceItem::Discount::DiscountEnd::Duration)
|
1675
1399
|
}
|
1676
1400
|
attr_accessor :duration
|
1677
|
-
|
1678
1401
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1679
1402
|
sig { returns(Integer) }
|
1680
1403
|
attr_accessor :timestamp
|
1681
|
-
|
1682
1404
|
# The type of calculation made to determine when the discount ends.
|
1683
1405
|
sig { returns(String) }
|
1684
1406
|
attr_accessor :type
|
1685
|
-
|
1686
1407
|
sig {
|
1687
1408
|
params(duration: ::Stripe::Subscription::CreateParams::AddInvoiceItem::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
|
1688
1409
|
}
|
@@ -1691,21 +1412,17 @@ module Stripe
|
|
1691
1412
|
# ID of the coupon to create a new discount for.
|
1692
1413
|
sig { returns(String) }
|
1693
1414
|
attr_accessor :coupon
|
1694
|
-
|
1695
1415
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1696
1416
|
sig { returns(String) }
|
1697
1417
|
attr_accessor :discount
|
1698
|
-
|
1699
1418
|
# Details to determine how long the discount should be applied for.
|
1700
1419
|
sig {
|
1701
1420
|
returns(::Stripe::Subscription::CreateParams::AddInvoiceItem::Discount::DiscountEnd)
|
1702
1421
|
}
|
1703
1422
|
attr_accessor :discount_end
|
1704
|
-
|
1705
1423
|
# ID of the promotion code to create a new discount for.
|
1706
1424
|
sig { returns(String) }
|
1707
1425
|
attr_accessor :promotion_code
|
1708
|
-
|
1709
1426
|
sig {
|
1710
1427
|
params(coupon: String, discount: String, discount_end: ::Stripe::Subscription::CreateParams::AddInvoiceItem::Discount::DiscountEnd, promotion_code: String).void
|
1711
1428
|
}
|
@@ -1715,23 +1432,18 @@ module Stripe
|
|
1715
1432
|
# 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).
|
1716
1433
|
sig { returns(String) }
|
1717
1434
|
attr_accessor :currency
|
1718
|
-
|
1719
1435
|
# The ID of the product that this price will belong to.
|
1720
1436
|
sig { returns(String) }
|
1721
1437
|
attr_accessor :product
|
1722
|
-
|
1723
1438
|
# 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.
|
1724
1439
|
sig { returns(String) }
|
1725
1440
|
attr_accessor :tax_behavior
|
1726
|
-
|
1727
1441
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
|
1728
1442
|
sig { returns(Integer) }
|
1729
1443
|
attr_accessor :unit_amount
|
1730
|
-
|
1731
1444
|
# 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.
|
1732
1445
|
sig { returns(String) }
|
1733
1446
|
attr_accessor :unit_amount_decimal
|
1734
|
-
|
1735
1447
|
sig {
|
1736
1448
|
params(currency: String, product: String, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
|
1737
1449
|
}
|
@@ -1746,23 +1458,18 @@ module Stripe
|
|
1746
1458
|
# The coupons to redeem into discounts for the item.
|
1747
1459
|
sig { returns(T::Array[::Stripe::Subscription::CreateParams::AddInvoiceItem::Discount]) }
|
1748
1460
|
attr_accessor :discounts
|
1749
|
-
|
1750
1461
|
# The ID of the price object. One of `price` or `price_data` is required.
|
1751
1462
|
sig { returns(String) }
|
1752
1463
|
attr_accessor :price
|
1753
|
-
|
1754
1464
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
1755
1465
|
sig { returns(::Stripe::Subscription::CreateParams::AddInvoiceItem::PriceData) }
|
1756
1466
|
attr_accessor :price_data
|
1757
|
-
|
1758
1467
|
# Quantity for this item. Defaults to 1.
|
1759
1468
|
sig { returns(Integer) }
|
1760
1469
|
attr_accessor :quantity
|
1761
|
-
|
1762
1470
|
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
|
1763
1471
|
sig { returns(T.nilable(T::Array[String])) }
|
1764
1472
|
attr_accessor :tax_rates
|
1765
|
-
|
1766
1473
|
sig {
|
1767
1474
|
params(discounts: T::Array[::Stripe::Subscription::CreateParams::AddInvoiceItem::Discount], price: String, price_data: ::Stripe::Subscription::CreateParams::AddInvoiceItem::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String])).void
|
1768
1475
|
}
|
@@ -1779,22 +1486,18 @@ module Stripe
|
|
1779
1486
|
# The connected account being referenced when `type` is `account`.
|
1780
1487
|
sig { returns(String) }
|
1781
1488
|
attr_accessor :account
|
1782
|
-
|
1783
1489
|
# Type of the account referenced in the request.
|
1784
1490
|
sig { returns(String) }
|
1785
1491
|
attr_accessor :type
|
1786
|
-
|
1787
1492
|
sig { params(account: String, type: String).void }
|
1788
1493
|
def initialize(account: nil, type: nil); end
|
1789
1494
|
end
|
1790
1495
|
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
|
1791
1496
|
sig { returns(T::Boolean) }
|
1792
1497
|
attr_accessor :enabled
|
1793
|
-
|
1794
1498
|
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
|
1795
1499
|
sig { returns(::Stripe::Subscription::CreateParams::AutomaticTax::Liability) }
|
1796
1500
|
attr_accessor :liability
|
1797
|
-
|
1798
1501
|
sig {
|
1799
1502
|
params(enabled: T::Boolean, liability: ::Stripe::Subscription::CreateParams::AutomaticTax::Liability).void
|
1800
1503
|
}
|
@@ -1804,23 +1507,18 @@ module Stripe
|
|
1804
1507
|
# The day of the month the billing_cycle_anchor should be. Ranges from 1 to 31.
|
1805
1508
|
sig { returns(Integer) }
|
1806
1509
|
attr_accessor :day_of_month
|
1807
|
-
|
1808
1510
|
# The hour of the day the billing_cycle_anchor should be. Ranges from 0 to 23.
|
1809
1511
|
sig { returns(Integer) }
|
1810
1512
|
attr_accessor :hour
|
1811
|
-
|
1812
1513
|
# The minute of the hour the billing_cycle_anchor should be. Ranges from 0 to 59.
|
1813
1514
|
sig { returns(Integer) }
|
1814
1515
|
attr_accessor :minute
|
1815
|
-
|
1816
1516
|
# The month to start full cycle billing periods. Ranges from 1 to 12.
|
1817
1517
|
sig { returns(Integer) }
|
1818
1518
|
attr_accessor :month
|
1819
|
-
|
1820
1519
|
# The second of the minute the billing_cycle_anchor should be. Ranges from 0 to 59.
|
1821
1520
|
sig { returns(Integer) }
|
1822
1521
|
attr_accessor :second
|
1823
|
-
|
1824
1522
|
sig {
|
1825
1523
|
params(day_of_month: Integer, hour: Integer, minute: Integer, month: Integer, second: Integer).void
|
1826
1524
|
}
|
@@ -1830,11 +1528,9 @@ module Stripe
|
|
1830
1528
|
# Monetary threshold that triggers the subscription to advance to a new billing period
|
1831
1529
|
sig { returns(Integer) }
|
1832
1530
|
attr_accessor :amount_gte
|
1833
|
-
|
1834
1531
|
# Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
|
1835
1532
|
sig { returns(T::Boolean) }
|
1836
1533
|
attr_accessor :reset_billing_cycle_anchor
|
1837
|
-
|
1838
1534
|
sig { params(amount_gte: Integer, reset_billing_cycle_anchor: T::Boolean).void }
|
1839
1535
|
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end
|
1840
1536
|
end
|
@@ -1844,26 +1540,21 @@ module Stripe
|
|
1844
1540
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1845
1541
|
sig { returns(String) }
|
1846
1542
|
attr_accessor :interval
|
1847
|
-
|
1848
1543
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1849
1544
|
sig { returns(Integer) }
|
1850
1545
|
attr_accessor :interval_count
|
1851
|
-
|
1852
1546
|
sig { params(interval: String, interval_count: Integer).void }
|
1853
1547
|
def initialize(interval: nil, interval_count: nil); end
|
1854
1548
|
end
|
1855
1549
|
# Time span for the redeemed discount.
|
1856
1550
|
sig { returns(::Stripe::Subscription::CreateParams::Discount::DiscountEnd::Duration) }
|
1857
1551
|
attr_accessor :duration
|
1858
|
-
|
1859
1552
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1860
1553
|
sig { returns(Integer) }
|
1861
1554
|
attr_accessor :timestamp
|
1862
|
-
|
1863
1555
|
# The type of calculation made to determine when the discount ends.
|
1864
1556
|
sig { returns(String) }
|
1865
1557
|
attr_accessor :type
|
1866
|
-
|
1867
1558
|
sig {
|
1868
1559
|
params(duration: ::Stripe::Subscription::CreateParams::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
|
1869
1560
|
}
|
@@ -1872,19 +1563,15 @@ module Stripe
|
|
1872
1563
|
# ID of the coupon to create a new discount for.
|
1873
1564
|
sig { returns(String) }
|
1874
1565
|
attr_accessor :coupon
|
1875
|
-
|
1876
1566
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1877
1567
|
sig { returns(String) }
|
1878
1568
|
attr_accessor :discount
|
1879
|
-
|
1880
1569
|
# Details to determine how long the discount should be applied for.
|
1881
1570
|
sig { returns(::Stripe::Subscription::CreateParams::Discount::DiscountEnd) }
|
1882
1571
|
attr_accessor :discount_end
|
1883
|
-
|
1884
1572
|
# ID of the promotion code to create a new discount for.
|
1885
1573
|
sig { returns(String) }
|
1886
1574
|
attr_accessor :promotion_code
|
1887
|
-
|
1888
1575
|
sig {
|
1889
1576
|
params(coupon: String, discount: String, discount_end: ::Stripe::Subscription::CreateParams::Discount::DiscountEnd, promotion_code: String).void
|
1890
1577
|
}
|
@@ -1895,22 +1582,18 @@ module Stripe
|
|
1895
1582
|
# The connected account being referenced when `type` is `account`.
|
1896
1583
|
sig { returns(String) }
|
1897
1584
|
attr_accessor :account
|
1898
|
-
|
1899
1585
|
# Type of the account referenced in the request.
|
1900
1586
|
sig { returns(String) }
|
1901
1587
|
attr_accessor :type
|
1902
|
-
|
1903
1588
|
sig { params(account: String, type: String).void }
|
1904
1589
|
def initialize(account: nil, type: nil); end
|
1905
1590
|
end
|
1906
1591
|
# The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
|
1907
1592
|
sig { returns(T.nilable(T::Array[String])) }
|
1908
1593
|
attr_accessor :account_tax_ids
|
1909
|
-
|
1910
1594
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
1911
1595
|
sig { returns(::Stripe::Subscription::CreateParams::InvoiceSettings::Issuer) }
|
1912
1596
|
attr_accessor :issuer
|
1913
|
-
|
1914
1597
|
sig {
|
1915
1598
|
params(account_tax_ids: T.nilable(T::Array[String]), issuer: ::Stripe::Subscription::CreateParams::InvoiceSettings::Issuer).void
|
1916
1599
|
}
|
@@ -1921,7 +1604,6 @@ module Stripe
|
|
1921
1604
|
# Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
|
1922
1605
|
sig { returns(Integer) }
|
1923
1606
|
attr_accessor :usage_gte
|
1924
|
-
|
1925
1607
|
sig { params(usage_gte: Integer).void }
|
1926
1608
|
def initialize(usage_gte: nil); end
|
1927
1609
|
end
|
@@ -1931,11 +1613,9 @@ module Stripe
|
|
1931
1613
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1932
1614
|
sig { returns(String) }
|
1933
1615
|
attr_accessor :interval
|
1934
|
-
|
1935
1616
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1936
1617
|
sig { returns(Integer) }
|
1937
1618
|
attr_accessor :interval_count
|
1938
|
-
|
1939
1619
|
sig { params(interval: String, interval_count: Integer).void }
|
1940
1620
|
def initialize(interval: nil, interval_count: nil); end
|
1941
1621
|
end
|
@@ -1944,15 +1624,12 @@ module Stripe
|
|
1944
1624
|
returns(::Stripe::Subscription::CreateParams::Item::Discount::DiscountEnd::Duration)
|
1945
1625
|
}
|
1946
1626
|
attr_accessor :duration
|
1947
|
-
|
1948
1627
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1949
1628
|
sig { returns(Integer) }
|
1950
1629
|
attr_accessor :timestamp
|
1951
|
-
|
1952
1630
|
# The type of calculation made to determine when the discount ends.
|
1953
1631
|
sig { returns(String) }
|
1954
1632
|
attr_accessor :type
|
1955
|
-
|
1956
1633
|
sig {
|
1957
1634
|
params(duration: ::Stripe::Subscription::CreateParams::Item::Discount::DiscountEnd::Duration, timestamp: Integer, type: String).void
|
1958
1635
|
}
|
@@ -1961,19 +1638,15 @@ module Stripe
|
|
1961
1638
|
# ID of the coupon to create a new discount for.
|
1962
1639
|
sig { returns(String) }
|
1963
1640
|
attr_accessor :coupon
|
1964
|
-
|
1965
1641
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1966
1642
|
sig { returns(String) }
|
1967
1643
|
attr_accessor :discount
|
1968
|
-
|
1969
1644
|
# Details to determine how long the discount should be applied for.
|
1970
1645
|
sig { returns(::Stripe::Subscription::CreateParams::Item::Discount::DiscountEnd) }
|
1971
1646
|
attr_accessor :discount_end
|
1972
|
-
|
1973
1647
|
# ID of the promotion code to create a new discount for.
|
1974
1648
|
sig { returns(String) }
|
1975
1649
|
attr_accessor :promotion_code
|
1976
|
-
|
1977
1650
|
sig {
|
1978
1651
|
params(coupon: String, discount: String, discount_end: ::Stripe::Subscription::CreateParams::Item::Discount::DiscountEnd, promotion_code: String).void
|
1979
1652
|
}
|
@@ -1984,38 +1657,30 @@ module Stripe
|
|
1984
1657
|
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
1985
1658
|
sig { returns(String) }
|
1986
1659
|
attr_accessor :interval
|
1987
|
-
|
1988
1660
|
# 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).
|
1989
1661
|
sig { returns(Integer) }
|
1990
1662
|
attr_accessor :interval_count
|
1991
|
-
|
1992
1663
|
sig { params(interval: String, interval_count: Integer).void }
|
1993
1664
|
def initialize(interval: nil, interval_count: nil); end
|
1994
1665
|
end
|
1995
1666
|
# 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).
|
1996
1667
|
sig { returns(String) }
|
1997
1668
|
attr_accessor :currency
|
1998
|
-
|
1999
1669
|
# The ID of the product that this price will belong to.
|
2000
1670
|
sig { returns(String) }
|
2001
1671
|
attr_accessor :product
|
2002
|
-
|
2003
1672
|
# The recurring components of a price such as `interval` and `interval_count`.
|
2004
1673
|
sig { returns(::Stripe::Subscription::CreateParams::Item::PriceData::Recurring) }
|
2005
1674
|
attr_accessor :recurring
|
2006
|
-
|
2007
1675
|
# 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.
|
2008
1676
|
sig { returns(String) }
|
2009
1677
|
attr_accessor :tax_behavior
|
2010
|
-
|
2011
1678
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
2012
1679
|
sig { returns(Integer) }
|
2013
1680
|
attr_accessor :unit_amount
|
2014
|
-
|
2015
1681
|
# 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.
|
2016
1682
|
sig { returns(String) }
|
2017
1683
|
attr_accessor :unit_amount_decimal
|
2018
|
-
|
2019
1684
|
sig {
|
2020
1685
|
params(currency: String, product: String, recurring: ::Stripe::Subscription::CreateParams::Item::PriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
|
2021
1686
|
}
|
@@ -2032,50 +1697,39 @@ module Stripe
|
|
2032
1697
|
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
|
2033
1698
|
sig { returns(T::Array[String]) }
|
2034
1699
|
attr_accessor :converts_to
|
2035
|
-
|
2036
1700
|
# Determines the type of trial for this item.
|
2037
1701
|
sig { returns(String) }
|
2038
1702
|
attr_accessor :type
|
2039
|
-
|
2040
1703
|
sig { params(converts_to: T::Array[String], type: String).void }
|
2041
1704
|
def initialize(converts_to: nil, type: nil); end
|
2042
1705
|
end
|
2043
1706
|
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
|
2044
1707
|
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::Item::BillingThresholds)) }
|
2045
1708
|
attr_accessor :billing_thresholds
|
2046
|
-
|
2047
1709
|
# The coupons to redeem into discounts for the subscription item.
|
2048
1710
|
sig { returns(T.nilable(T::Array[::Stripe::Subscription::CreateParams::Item::Discount])) }
|
2049
1711
|
attr_accessor :discounts
|
2050
|
-
|
2051
1712
|
# 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`.
|
2052
1713
|
sig { returns(T::Hash[String, String]) }
|
2053
1714
|
attr_accessor :metadata
|
2054
|
-
|
2055
1715
|
# Plan ID for this item, as a string.
|
2056
1716
|
sig { returns(String) }
|
2057
1717
|
attr_accessor :plan
|
2058
|
-
|
2059
1718
|
# The ID of the price object.
|
2060
1719
|
sig { returns(String) }
|
2061
1720
|
attr_accessor :price
|
2062
|
-
|
2063
1721
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
|
2064
1722
|
sig { returns(::Stripe::Subscription::CreateParams::Item::PriceData) }
|
2065
1723
|
attr_accessor :price_data
|
2066
|
-
|
2067
1724
|
# Quantity for this item.
|
2068
1725
|
sig { returns(Integer) }
|
2069
1726
|
attr_accessor :quantity
|
2070
|
-
|
2071
1727
|
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
|
2072
1728
|
sig { returns(T.nilable(T::Array[String])) }
|
2073
1729
|
attr_accessor :tax_rates
|
2074
|
-
|
2075
1730
|
# Define options to configure the trial on the subscription item.
|
2076
1731
|
sig { returns(::Stripe::Subscription::CreateParams::Item::Trial) }
|
2077
1732
|
attr_accessor :trial
|
2078
|
-
|
2079
1733
|
sig {
|
2080
1734
|
params(billing_thresholds: T.nilable(::Stripe::Subscription::CreateParams::Item::BillingThresholds), discounts: T.nilable(T::Array[::Stripe::Subscription::CreateParams::Item::Discount]), metadata: T::Hash[String, String], plan: String, price: String, price_data: ::Stripe::Subscription::CreateParams::Item::PriceData, quantity: Integer, tax_rates: T.nilable(T::Array[String]), trial: ::Stripe::Subscription::CreateParams::Item::Trial).void
|
2081
1735
|
}
|
@@ -2098,7 +1752,6 @@ module Stripe
|
|
2098
1752
|
# Transaction type of the mandate.
|
2099
1753
|
sig { returns(String) }
|
2100
1754
|
attr_accessor :transaction_type
|
2101
|
-
|
2102
1755
|
sig { params(transaction_type: String).void }
|
2103
1756
|
def initialize(transaction_type: nil); end
|
2104
1757
|
end
|
@@ -2107,11 +1760,9 @@ module Stripe
|
|
2107
1760
|
returns(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions)
|
2108
1761
|
}
|
2109
1762
|
attr_accessor :mandate_options
|
2110
|
-
|
2111
1763
|
# Verification method for the intent
|
2112
1764
|
sig { returns(String) }
|
2113
1765
|
attr_accessor :verification_method
|
2114
|
-
|
2115
1766
|
sig {
|
2116
1767
|
params(mandate_options: ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit::MandateOptions, verification_method: String).void
|
2117
1768
|
}
|
@@ -2121,7 +1772,6 @@ module Stripe
|
|
2121
1772
|
# Preferred language of the Bancontact authorization page that the customer is redirected to.
|
2122
1773
|
sig { returns(String) }
|
2123
1774
|
attr_accessor :preferred_language
|
2124
|
-
|
2125
1775
|
sig { params(preferred_language: String).void }
|
2126
1776
|
def initialize(preferred_language: nil); end
|
2127
1777
|
end
|
@@ -2130,15 +1780,12 @@ module Stripe
|
|
2130
1780
|
# Amount to be charged for future payments.
|
2131
1781
|
sig { returns(Integer) }
|
2132
1782
|
attr_accessor :amount
|
2133
|
-
|
2134
1783
|
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
|
2135
1784
|
sig { returns(String) }
|
2136
1785
|
attr_accessor :amount_type
|
2137
|
-
|
2138
1786
|
# A description of the mandate or subscription that is meant to be displayed to the customer.
|
2139
1787
|
sig { returns(String) }
|
2140
1788
|
attr_accessor :description
|
2141
|
-
|
2142
1789
|
sig { params(amount: Integer, amount_type: String, description: String).void }
|
2143
1790
|
def initialize(amount: nil, amount_type: nil, description: nil); end
|
2144
1791
|
end
|
@@ -2147,15 +1794,12 @@ module Stripe
|
|
2147
1794
|
returns(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions)
|
2148
1795
|
}
|
2149
1796
|
attr_accessor :mandate_options
|
2150
|
-
|
2151
1797
|
# Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
|
2152
1798
|
sig { returns(String) }
|
2153
1799
|
attr_accessor :network
|
2154
|
-
|
2155
1800
|
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
|
2156
1801
|
sig { returns(String) }
|
2157
1802
|
attr_accessor :request_three_d_secure
|
2158
|
-
|
2159
1803
|
sig {
|
2160
1804
|
params(mandate_options: ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Card::MandateOptions, network: String, request_three_d_secure: String).void
|
2161
1805
|
}
|
@@ -2167,7 +1811,6 @@ module Stripe
|
|
2167
1811
|
# The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
|
2168
1812
|
sig { returns(String) }
|
2169
1813
|
attr_accessor :country
|
2170
|
-
|
2171
1814
|
sig { params(country: String).void }
|
2172
1815
|
def initialize(country: nil); end
|
2173
1816
|
end
|
@@ -2176,11 +1819,9 @@ module Stripe
|
|
2176
1819
|
returns(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer)
|
2177
1820
|
}
|
2178
1821
|
attr_accessor :eu_bank_transfer
|
2179
|
-
|
2180
1822
|
# The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
|
2181
1823
|
sig { returns(String) }
|
2182
1824
|
attr_accessor :type
|
2183
|
-
|
2184
1825
|
sig {
|
2185
1826
|
params(eu_bank_transfer: ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer::EuBankTransfer, type: String).void
|
2186
1827
|
}
|
@@ -2191,11 +1832,9 @@ module Stripe
|
|
2191
1832
|
returns(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer)
|
2192
1833
|
}
|
2193
1834
|
attr_accessor :bank_transfer
|
2194
|
-
|
2195
1835
|
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
|
2196
1836
|
sig { returns(String) }
|
2197
1837
|
attr_accessor :funding_type
|
2198
|
-
|
2199
1838
|
sig {
|
2200
1839
|
params(bank_transfer: ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance::BankTransfer, funding_type: String).void
|
2201
1840
|
}
|
@@ -2216,11 +1855,9 @@ module Stripe
|
|
2216
1855
|
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
2217
1856
|
sig { returns(T::Array[String]) }
|
2218
1857
|
attr_accessor :account_subcategories
|
2219
|
-
|
2220
1858
|
# ID of the institution to use to filter for selectable accounts.
|
2221
1859
|
sig { returns(String) }
|
2222
1860
|
attr_accessor :institution
|
2223
|
-
|
2224
1861
|
sig { params(account_subcategories: T::Array[String], institution: String).void }
|
2225
1862
|
def initialize(account_subcategories: nil, institution: nil); end
|
2226
1863
|
end
|
@@ -2229,15 +1866,12 @@ module Stripe
|
|
2229
1866
|
returns(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters)
|
2230
1867
|
}
|
2231
1868
|
attr_accessor :filters
|
2232
|
-
|
2233
1869
|
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
|
2234
1870
|
sig { returns(T::Array[String]) }
|
2235
1871
|
attr_accessor :permissions
|
2236
|
-
|
2237
1872
|
# List of data features that you would like to retrieve upon account creation.
|
2238
1873
|
sig { returns(T::Array[String]) }
|
2239
1874
|
attr_accessor :prefetch
|
2240
|
-
|
2241
1875
|
sig {
|
2242
1876
|
params(filters: ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections::Filters, permissions: T::Array[String], prefetch: T::Array[String]).void
|
2243
1877
|
}
|
@@ -2248,11 +1882,9 @@ module Stripe
|
|
2248
1882
|
returns(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections)
|
2249
1883
|
}
|
2250
1884
|
attr_accessor :financial_connections
|
2251
|
-
|
2252
1885
|
# Verification method for the intent
|
2253
1886
|
sig { returns(String) }
|
2254
1887
|
attr_accessor :verification_method
|
2255
|
-
|
2256
1888
|
sig {
|
2257
1889
|
params(financial_connections: ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount::FinancialConnections, verification_method: String).void
|
2258
1890
|
}
|
@@ -2263,49 +1895,41 @@ module Stripe
|
|
2263
1895
|
returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit))
|
2264
1896
|
}
|
2265
1897
|
attr_accessor :acss_debit
|
2266
|
-
|
2267
1898
|
# This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
|
2268
1899
|
sig {
|
2269
1900
|
returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact))
|
2270
1901
|
}
|
2271
1902
|
attr_accessor :bancontact
|
2272
|
-
|
2273
1903
|
# This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
|
2274
1904
|
sig {
|
2275
1905
|
returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Card))
|
2276
1906
|
}
|
2277
1907
|
attr_accessor :card
|
2278
|
-
|
2279
1908
|
# This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
|
2280
1909
|
sig {
|
2281
1910
|
returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance))
|
2282
1911
|
}
|
2283
1912
|
attr_accessor :customer_balance
|
2284
|
-
|
2285
1913
|
# This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
|
2286
1914
|
sig {
|
2287
1915
|
returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer))
|
2288
1916
|
}
|
2289
1917
|
attr_accessor :id_bank_transfer
|
2290
|
-
|
2291
1918
|
# This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
|
2292
1919
|
sig {
|
2293
1920
|
returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini))
|
2294
1921
|
}
|
2295
1922
|
attr_accessor :konbini
|
2296
|
-
|
2297
1923
|
# This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
|
2298
1924
|
sig {
|
2299
1925
|
returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit))
|
2300
1926
|
}
|
2301
1927
|
attr_accessor :sepa_debit
|
2302
|
-
|
2303
1928
|
# This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
|
2304
1929
|
sig {
|
2305
1930
|
returns(T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount))
|
2306
1931
|
}
|
2307
1932
|
attr_accessor :us_bank_account
|
2308
|
-
|
2309
1933
|
sig {
|
2310
1934
|
params(acss_debit: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::AcssDebit), bancontact: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Bancontact), card: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Card), customer_balance: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::CustomerBalance), id_bank_transfer: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::IdBankTransfer), konbini: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::Konbini), sepa_debit: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::SepaDebit), us_bank_account: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions::UsBankAccount)).void
|
2311
1935
|
}
|
@@ -2323,15 +1947,12 @@ module Stripe
|
|
2323
1947
|
# Payment-method-specific configuration to provide to invoices created by the subscription.
|
2324
1948
|
sig { returns(::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions) }
|
2325
1949
|
attr_accessor :payment_method_options
|
2326
|
-
|
2327
1950
|
# The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration
|
2328
1951
|
sig { returns(T.nilable(T::Array[String])) }
|
2329
1952
|
attr_accessor :payment_method_types
|
2330
|
-
|
2331
1953
|
# Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.
|
2332
1954
|
sig { returns(String) }
|
2333
1955
|
attr_accessor :save_default_payment_method
|
2334
|
-
|
2335
1956
|
sig {
|
2336
1957
|
params(payment_method_options: ::Stripe::Subscription::CreateParams::PaymentSettings::PaymentMethodOptions, payment_method_types: T.nilable(T::Array[String]), save_default_payment_method: String).void
|
2337
1958
|
}
|
@@ -2345,11 +1966,9 @@ module Stripe
|
|
2345
1966
|
# Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
|
2346
1967
|
sig { returns(String) }
|
2347
1968
|
attr_accessor :interval
|
2348
|
-
|
2349
1969
|
# The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
|
2350
1970
|
sig { returns(Integer) }
|
2351
1971
|
attr_accessor :interval_count
|
2352
|
-
|
2353
1972
|
sig { params(interval: String, interval_count: Integer).void }
|
2354
1973
|
def initialize(interval: nil, interval_count: nil); end
|
2355
1974
|
end
|
@@ -2357,11 +1976,9 @@ module Stripe
|
|
2357
1976
|
# This is used to determine the number of billing cycles to prebill.
|
2358
1977
|
sig { returns(Integer) }
|
2359
1978
|
attr_accessor :iterations
|
2360
|
-
|
2361
1979
|
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
2362
1980
|
sig { returns(String) }
|
2363
1981
|
attr_accessor :update_behavior
|
2364
|
-
|
2365
1982
|
sig { params(iterations: Integer, update_behavior: String).void }
|
2366
1983
|
def initialize(iterations: nil, update_behavior: nil); end
|
2367
1984
|
end
|
@@ -2369,11 +1986,9 @@ module Stripe
|
|
2369
1986
|
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
|
2370
1987
|
sig { returns(Float) }
|
2371
1988
|
attr_accessor :amount_percent
|
2372
|
-
|
2373
1989
|
# ID of an existing, connected Stripe account.
|
2374
1990
|
sig { returns(String) }
|
2375
1991
|
attr_accessor :destination
|
2376
|
-
|
2377
1992
|
sig { params(amount_percent: Float, destination: String).void }
|
2378
1993
|
def initialize(amount_percent: nil, destination: nil); end
|
2379
1994
|
end
|
@@ -2382,14 +1997,12 @@ module Stripe
|
|
2382
1997
|
# Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
|
2383
1998
|
sig { returns(String) }
|
2384
1999
|
attr_accessor :missing_payment_method
|
2385
|
-
|
2386
2000
|
sig { params(missing_payment_method: String).void }
|
2387
2001
|
def initialize(missing_payment_method: nil); end
|
2388
2002
|
end
|
2389
2003
|
# Defines how the subscription should behave when the user's free trial ends.
|
2390
2004
|
sig { returns(::Stripe::Subscription::CreateParams::TrialSettings::EndBehavior) }
|
2391
2005
|
attr_accessor :end_behavior
|
2392
|
-
|
2393
2006
|
sig {
|
2394
2007
|
params(end_behavior: ::Stripe::Subscription::CreateParams::TrialSettings::EndBehavior).void
|
2395
2008
|
}
|
@@ -2398,103 +2011,78 @@ module Stripe
|
|
2398
2011
|
# A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
|
2399
2012
|
sig { returns(T::Array[::Stripe::Subscription::CreateParams::AddInvoiceItem]) }
|
2400
2013
|
attr_accessor :add_invoice_items
|
2401
|
-
|
2402
2014
|
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
|
2403
2015
|
sig { returns(T.nilable(Float)) }
|
2404
2016
|
attr_accessor :application_fee_percent
|
2405
|
-
|
2406
2017
|
# Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
|
2407
2018
|
sig { returns(::Stripe::Subscription::CreateParams::AutomaticTax) }
|
2408
2019
|
attr_accessor :automatic_tax
|
2409
|
-
|
2410
2020
|
# For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
|
2411
2021
|
sig { returns(Integer) }
|
2412
2022
|
attr_accessor :backdate_start_date
|
2413
|
-
|
2414
2023
|
# A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.
|
2415
2024
|
sig { returns(Integer) }
|
2416
2025
|
attr_accessor :billing_cycle_anchor
|
2417
|
-
|
2418
2026
|
# Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC.
|
2419
2027
|
sig { returns(::Stripe::Subscription::CreateParams::BillingCycleAnchorConfig) }
|
2420
2028
|
attr_accessor :billing_cycle_anchor_config
|
2421
|
-
|
2422
2029
|
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
|
2423
2030
|
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::BillingThresholds)) }
|
2424
2031
|
attr_accessor :billing_thresholds
|
2425
|
-
|
2426
2032
|
# A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
|
2427
2033
|
sig { returns(Integer) }
|
2428
2034
|
attr_accessor :cancel_at
|
2429
|
-
|
2430
2035
|
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
|
2431
2036
|
sig { returns(T::Boolean) }
|
2432
2037
|
attr_accessor :cancel_at_period_end
|
2433
|
-
|
2434
2038
|
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.
|
2435
2039
|
sig { returns(String) }
|
2436
2040
|
attr_accessor :collection_method
|
2437
|
-
|
2438
2041
|
# The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
|
2439
2042
|
sig { returns(String) }
|
2440
2043
|
attr_accessor :coupon
|
2441
|
-
|
2442
2044
|
# 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).
|
2443
2045
|
sig { returns(String) }
|
2444
2046
|
attr_accessor :currency
|
2445
|
-
|
2446
2047
|
# The identifier of the customer to subscribe.
|
2447
2048
|
sig { returns(String) }
|
2448
2049
|
attr_accessor :customer
|
2449
|
-
|
2450
2050
|
# Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
|
2451
2051
|
sig { returns(Integer) }
|
2452
2052
|
attr_accessor :days_until_due
|
2453
|
-
|
2454
2053
|
# ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
|
2455
2054
|
sig { returns(String) }
|
2456
2055
|
attr_accessor :default_payment_method
|
2457
|
-
|
2458
2056
|
# ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
|
2459
2057
|
sig { returns(String) }
|
2460
2058
|
attr_accessor :default_source
|
2461
|
-
|
2462
2059
|
# The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
|
2463
2060
|
sig { returns(T.nilable(T::Array[String])) }
|
2464
2061
|
attr_accessor :default_tax_rates
|
2465
|
-
|
2466
2062
|
# The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
|
2467
2063
|
sig { returns(String) }
|
2468
2064
|
attr_accessor :description
|
2469
|
-
|
2470
2065
|
# The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer.
|
2471
2066
|
sig { returns(T.nilable(T::Array[::Stripe::Subscription::CreateParams::Discount])) }
|
2472
2067
|
attr_accessor :discounts
|
2473
|
-
|
2474
2068
|
# Specifies which fields in the response should be expanded.
|
2475
2069
|
sig { returns(T::Array[String]) }
|
2476
2070
|
attr_accessor :expand
|
2477
|
-
|
2478
2071
|
# All invoices will be billed using the specified settings.
|
2479
2072
|
sig { returns(::Stripe::Subscription::CreateParams::InvoiceSettings) }
|
2480
2073
|
attr_accessor :invoice_settings
|
2481
|
-
|
2482
2074
|
# A list of up to 20 subscription items, each with an attached price.
|
2483
2075
|
sig { returns(T::Array[::Stripe::Subscription::CreateParams::Item]) }
|
2484
2076
|
attr_accessor :items
|
2485
|
-
|
2486
2077
|
# 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`.
|
2487
2078
|
sig { returns(T.nilable(T::Hash[String, String])) }
|
2488
2079
|
attr_accessor :metadata
|
2489
|
-
|
2490
2080
|
# Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
|
2491
2081
|
sig { returns(T::Boolean) }
|
2492
2082
|
attr_accessor :off_session
|
2493
|
-
|
2494
2083
|
# The account on behalf of which to charge, for each of the subscription's invoices.
|
2495
2084
|
sig { returns(T.nilable(String)) }
|
2496
2085
|
attr_accessor :on_behalf_of
|
2497
|
-
|
2498
2086
|
# Only applies to subscriptions with `collection_method=charge_automatically`.
|
2499
2087
|
#
|
2500
2088
|
# Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
|
@@ -2508,47 +2096,36 @@ module Stripe
|
|
2508
2096
|
# Subscriptions with `collection_method=send_invoice` are automatically activated regardless of the first Invoice status.
|
2509
2097
|
sig { returns(String) }
|
2510
2098
|
attr_accessor :payment_behavior
|
2511
|
-
|
2512
2099
|
# Payment settings to pass to invoices created by the subscription.
|
2513
2100
|
sig { returns(::Stripe::Subscription::CreateParams::PaymentSettings) }
|
2514
2101
|
attr_accessor :payment_settings
|
2515
|
-
|
2516
2102
|
# Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
|
2517
2103
|
sig { returns(T.nilable(::Stripe::Subscription::CreateParams::PendingInvoiceItemInterval)) }
|
2518
2104
|
attr_accessor :pending_invoice_item_interval
|
2519
|
-
|
2520
2105
|
# If specified, the invoicing for the given billing cycle iterations will be processed now.
|
2521
2106
|
sig { returns(::Stripe::Subscription::CreateParams::Prebilling) }
|
2522
2107
|
attr_accessor :prebilling
|
2523
|
-
|
2524
2108
|
# The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
|
2525
2109
|
sig { returns(String) }
|
2526
2110
|
attr_accessor :promotion_code
|
2527
|
-
|
2528
2111
|
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
|
2529
2112
|
sig { returns(String) }
|
2530
2113
|
attr_accessor :proration_behavior
|
2531
|
-
|
2532
2114
|
# If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
|
2533
2115
|
sig { returns(::Stripe::Subscription::CreateParams::TransferData) }
|
2534
2116
|
attr_accessor :transfer_data
|
2535
|
-
|
2536
2117
|
# Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
|
2537
2118
|
sig { returns(T.any(String, Integer)) }
|
2538
2119
|
attr_accessor :trial_end
|
2539
|
-
|
2540
2120
|
# Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
|
2541
2121
|
sig { returns(T::Boolean) }
|
2542
2122
|
attr_accessor :trial_from_plan
|
2543
|
-
|
2544
2123
|
# Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
|
2545
2124
|
sig { returns(Integer) }
|
2546
2125
|
attr_accessor :trial_period_days
|
2547
|
-
|
2548
2126
|
# Settings related to subscription trials.
|
2549
2127
|
sig { returns(::Stripe::Subscription::CreateParams::TrialSettings) }
|
2550
2128
|
attr_accessor :trial_settings
|
2551
|
-
|
2552
2129
|
sig {
|
2553
2130
|
params(add_invoice_items: T::Array[::Stripe::Subscription::CreateParams::AddInvoiceItem], application_fee_percent: T.nilable(Float), automatic_tax: ::Stripe::Subscription::CreateParams::AutomaticTax, backdate_start_date: Integer, billing_cycle_anchor: Integer, billing_cycle_anchor_config: ::Stripe::Subscription::CreateParams::BillingCycleAnchorConfig, billing_thresholds: T.nilable(::Stripe::Subscription::CreateParams::BillingThresholds), cancel_at: Integer, cancel_at_period_end: T::Boolean, collection_method: String, coupon: String, currency: String, customer: String, days_until_due: Integer, default_payment_method: String, default_source: String, default_tax_rates: T.nilable(T::Array[String]), description: String, discounts: T.nilable(T::Array[::Stripe::Subscription::CreateParams::Discount]), expand: T::Array[String], invoice_settings: ::Stripe::Subscription::CreateParams::InvoiceSettings, items: T::Array[::Stripe::Subscription::CreateParams::Item], metadata: T.nilable(T::Hash[String, String]), off_session: T::Boolean, on_behalf_of: T.nilable(String), payment_behavior: String, payment_settings: ::Stripe::Subscription::CreateParams::PaymentSettings, pending_invoice_item_interval: T.nilable(::Stripe::Subscription::CreateParams::PendingInvoiceItemInterval), prebilling: ::Stripe::Subscription::CreateParams::Prebilling, promotion_code: String, proration_behavior: String, transfer_data: ::Stripe::Subscription::CreateParams::TransferData, trial_end: T.any(String, Integer), trial_from_plan: T::Boolean, trial_period_days: Integer, trial_settings: ::Stripe::Subscription::CreateParams::TrialSettings).void
|
2554
2131
|
}
|
@@ -2595,19 +2172,15 @@ module Stripe
|
|
2595
2172
|
# Specifies which fields in the response should be expanded.
|
2596
2173
|
sig { returns(T::Array[String]) }
|
2597
2174
|
attr_accessor :expand
|
2598
|
-
|
2599
2175
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
2600
2176
|
sig { returns(Integer) }
|
2601
2177
|
attr_accessor :limit
|
2602
|
-
|
2603
2178
|
# 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.
|
2604
2179
|
sig { returns(String) }
|
2605
2180
|
attr_accessor :page
|
2606
|
-
|
2607
2181
|
# The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for subscriptions](https://stripe.com/docs/search#query-fields-for-subscriptions).
|
2608
2182
|
sig { returns(String) }
|
2609
2183
|
attr_accessor :query
|
2610
|
-
|
2611
2184
|
sig { params(expand: T::Array[String], limit: Integer, page: String, query: String).void }
|
2612
2185
|
def initialize(expand: nil, limit: nil, page: nil, query: nil); end
|
2613
2186
|
end
|
@@ -2615,19 +2188,15 @@ module Stripe
|
|
2615
2188
|
# The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
|
2616
2189
|
sig { returns(String) }
|
2617
2190
|
attr_accessor :billing_cycle_anchor
|
2618
|
-
|
2619
2191
|
# Specifies which fields in the response should be expanded.
|
2620
2192
|
sig { returns(T::Array[String]) }
|
2621
2193
|
attr_accessor :expand
|
2622
|
-
|
2623
2194
|
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
|
2624
2195
|
sig { returns(String) }
|
2625
2196
|
attr_accessor :proration_behavior
|
2626
|
-
|
2627
2197
|
# If set, the proration will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint.
|
2628
2198
|
sig { returns(Integer) }
|
2629
2199
|
attr_accessor :proration_date
|
2630
|
-
|
2631
2200
|
sig {
|
2632
2201
|
params(billing_cycle_anchor: String, expand: T::Array[String], proration_behavior: String, proration_date: Integer).void
|
2633
2202
|
}
|