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
@@ -8,7 +8,6 @@ module Stripe
|
|
8
8
|
class Liability < Stripe::RequestParams
|
9
9
|
# The connected account being referenced when `type` is `account`.
|
10
10
|
attr_accessor :account
|
11
|
-
|
12
11
|
# Type of the account referenced in the request.
|
13
12
|
attr_accessor :type
|
14
13
|
|
@@ -19,7 +18,6 @@ module Stripe
|
|
19
18
|
end
|
20
19
|
# Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
|
21
20
|
attr_accessor :enabled
|
22
|
-
|
23
21
|
# 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.
|
24
22
|
attr_accessor :liability
|
25
23
|
|
@@ -33,19 +31,14 @@ module Stripe
|
|
33
31
|
class Address < Stripe::RequestParams
|
34
32
|
# City, district, suburb, town, or village.
|
35
33
|
attr_accessor :city
|
36
|
-
|
37
34
|
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
38
35
|
attr_accessor :country
|
39
|
-
|
40
36
|
# Address line 1 (e.g., street, PO Box, or company name).
|
41
37
|
attr_accessor :line1
|
42
|
-
|
43
38
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
44
39
|
attr_accessor :line2
|
45
|
-
|
46
40
|
# ZIP or postal code.
|
47
41
|
attr_accessor :postal_code
|
48
|
-
|
49
42
|
# State, county, province, or region.
|
50
43
|
attr_accessor :state
|
51
44
|
|
@@ -70,19 +63,14 @@ module Stripe
|
|
70
63
|
class Address < Stripe::RequestParams
|
71
64
|
# City, district, suburb, town, or village.
|
72
65
|
attr_accessor :city
|
73
|
-
|
74
66
|
# A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
75
67
|
attr_accessor :country
|
76
|
-
|
77
68
|
# Address line 1 (e.g., street, PO Box, or company name).
|
78
69
|
attr_accessor :line1
|
79
|
-
|
80
70
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
81
71
|
attr_accessor :line2
|
82
|
-
|
83
72
|
# ZIP or postal code.
|
84
73
|
attr_accessor :postal_code
|
85
|
-
|
86
74
|
# State, county, province, or region.
|
87
75
|
attr_accessor :state
|
88
76
|
|
@@ -104,10 +92,8 @@ module Stripe
|
|
104
92
|
end
|
105
93
|
# Customer shipping address.
|
106
94
|
attr_accessor :address
|
107
|
-
|
108
95
|
# Customer name.
|
109
96
|
attr_accessor :name
|
110
|
-
|
111
97
|
# Customer phone (including extension).
|
112
98
|
attr_accessor :phone
|
113
99
|
|
@@ -128,9 +114,8 @@ module Stripe
|
|
128
114
|
end
|
129
115
|
|
130
116
|
class TaxId < Stripe::RequestParams
|
131
|
-
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
|
117
|
+
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
|
132
118
|
attr_accessor :type
|
133
|
-
|
134
119
|
# Value of the tax ID.
|
135
120
|
attr_accessor :value
|
136
121
|
|
@@ -141,16 +126,12 @@ module Stripe
|
|
141
126
|
end
|
142
127
|
# The customer's address.
|
143
128
|
attr_accessor :address
|
144
|
-
|
145
129
|
# The customer's shipping information. Appears on invoices emailed to this customer.
|
146
130
|
attr_accessor :shipping
|
147
|
-
|
148
131
|
# Tax details about the customer.
|
149
132
|
attr_accessor :tax
|
150
|
-
|
151
133
|
# The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
|
152
134
|
attr_accessor :tax_exempt
|
153
|
-
|
154
135
|
# The customer's tax IDs.
|
155
136
|
attr_accessor :tax_ids
|
156
137
|
|
@@ -168,7 +149,6 @@ module Stripe
|
|
168
149
|
class Duration < Stripe::RequestParams
|
169
150
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
170
151
|
attr_accessor :interval
|
171
|
-
|
172
152
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
173
153
|
attr_accessor :interval_count
|
174
154
|
|
@@ -179,10 +159,8 @@ module Stripe
|
|
179
159
|
end
|
180
160
|
# Time span for the redeemed discount.
|
181
161
|
attr_accessor :duration
|
182
|
-
|
183
162
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
184
163
|
attr_accessor :timestamp
|
185
|
-
|
186
164
|
# The type of calculation made to determine when the discount ends.
|
187
165
|
attr_accessor :type
|
188
166
|
|
@@ -194,13 +172,10 @@ module Stripe
|
|
194
172
|
end
|
195
173
|
# ID of the coupon to create a new discount for.
|
196
174
|
attr_accessor :coupon
|
197
|
-
|
198
175
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
199
176
|
attr_accessor :discount
|
200
|
-
|
201
177
|
# Details to determine how long the discount should be applied for.
|
202
178
|
attr_accessor :discount_end
|
203
|
-
|
204
179
|
# ID of the promotion code to create a new discount for.
|
205
180
|
attr_accessor :promotion_code
|
206
181
|
|
@@ -218,7 +193,6 @@ module Stripe
|
|
218
193
|
class Duration < Stripe::RequestParams
|
219
194
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
220
195
|
attr_accessor :interval
|
221
|
-
|
222
196
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
223
197
|
attr_accessor :interval_count
|
224
198
|
|
@@ -229,10 +203,8 @@ module Stripe
|
|
229
203
|
end
|
230
204
|
# Time span for the redeemed discount.
|
231
205
|
attr_accessor :duration
|
232
|
-
|
233
206
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
234
207
|
attr_accessor :timestamp
|
235
|
-
|
236
208
|
# The type of calculation made to determine when the discount ends.
|
237
209
|
attr_accessor :type
|
238
210
|
|
@@ -244,13 +216,10 @@ module Stripe
|
|
244
216
|
end
|
245
217
|
# ID of the coupon to create a new discount for.
|
246
218
|
attr_accessor :coupon
|
247
|
-
|
248
219
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
249
220
|
attr_accessor :discount
|
250
|
-
|
251
221
|
# Details to determine how long the discount should be applied for.
|
252
222
|
attr_accessor :discount_end
|
253
|
-
|
254
223
|
# ID of the promotion code to create a new discount for.
|
255
224
|
attr_accessor :promotion_code
|
256
225
|
|
@@ -265,7 +234,6 @@ module Stripe
|
|
265
234
|
class Period < Stripe::RequestParams
|
266
235
|
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
|
267
236
|
attr_accessor :end
|
268
|
-
|
269
237
|
# The start of the period. This value is inclusive.
|
270
238
|
attr_accessor :start
|
271
239
|
|
@@ -278,16 +246,12 @@ module Stripe
|
|
278
246
|
class PriceData < Stripe::RequestParams
|
279
247
|
# 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).
|
280
248
|
attr_accessor :currency
|
281
|
-
|
282
249
|
# The ID of the product that this price will belong to.
|
283
250
|
attr_accessor :product
|
284
|
-
|
285
251
|
# 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.
|
286
252
|
attr_accessor :tax_behavior
|
287
|
-
|
288
253
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
289
254
|
attr_accessor :unit_amount
|
290
|
-
|
291
255
|
# 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.
|
292
256
|
attr_accessor :unit_amount_decimal
|
293
257
|
|
@@ -307,49 +271,34 @@ module Stripe
|
|
307
271
|
end
|
308
272
|
# The integer amount in cents (or local equivalent) of previewed invoice item.
|
309
273
|
attr_accessor :amount
|
310
|
-
|
311
274
|
# 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). Only applicable to new invoice items.
|
312
275
|
attr_accessor :currency
|
313
|
-
|
314
276
|
# An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
|
315
277
|
attr_accessor :description
|
316
|
-
|
317
278
|
# Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.
|
318
279
|
attr_accessor :discountable
|
319
|
-
|
320
280
|
# The coupons to redeem into discounts for the invoice item in the preview.
|
321
281
|
attr_accessor :discounts
|
322
|
-
|
323
282
|
# The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice.
|
324
283
|
attr_accessor :invoiceitem
|
325
|
-
|
326
284
|
# 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`.
|
327
285
|
attr_accessor :metadata
|
328
|
-
|
329
286
|
# The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
|
330
287
|
attr_accessor :period
|
331
|
-
|
332
288
|
# The ID of the price object. One of `price` or `price_data` is required.
|
333
289
|
attr_accessor :price
|
334
|
-
|
335
290
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
336
291
|
attr_accessor :price_data
|
337
|
-
|
338
292
|
# Non-negative integer. The quantity of units for the invoice item.
|
339
293
|
attr_accessor :quantity
|
340
|
-
|
341
294
|
# 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.
|
342
295
|
attr_accessor :tax_behavior
|
343
|
-
|
344
296
|
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
|
345
297
|
attr_accessor :tax_code
|
346
|
-
|
347
298
|
# The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item.
|
348
299
|
attr_accessor :tax_rates
|
349
|
-
|
350
300
|
# The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.
|
351
301
|
attr_accessor :unit_amount
|
352
|
-
|
353
302
|
# 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.
|
354
303
|
attr_accessor :unit_amount_decimal
|
355
304
|
|
@@ -393,7 +342,6 @@ module Stripe
|
|
393
342
|
class Issuer < Stripe::RequestParams
|
394
343
|
# The connected account being referenced when `type` is `account`.
|
395
344
|
attr_accessor :account
|
396
|
-
|
397
345
|
# Type of the account referenced in the request.
|
398
346
|
attr_accessor :type
|
399
347
|
|
@@ -418,7 +366,6 @@ module Stripe
|
|
418
366
|
class Duration < Stripe::RequestParams
|
419
367
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
420
368
|
attr_accessor :interval
|
421
|
-
|
422
369
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
423
370
|
attr_accessor :interval_count
|
424
371
|
|
@@ -429,13 +376,10 @@ module Stripe
|
|
429
376
|
end
|
430
377
|
# Use the `end` time of a given discount.
|
431
378
|
attr_accessor :discount_end
|
432
|
-
|
433
379
|
# Time span for the amendment starting from the `amendment_start`.
|
434
380
|
attr_accessor :duration
|
435
|
-
|
436
381
|
# A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
|
437
382
|
attr_accessor :timestamp
|
438
|
-
|
439
383
|
# Select one of three ways to pass the `amendment_end`.
|
440
384
|
attr_accessor :type
|
441
385
|
|
@@ -467,13 +411,10 @@ module Stripe
|
|
467
411
|
end
|
468
412
|
# Details of another amendment in the same array, immediately after which this amendment should begin.
|
469
413
|
attr_accessor :amendment_end
|
470
|
-
|
471
414
|
# Use the `end` time of a given discount.
|
472
415
|
attr_accessor :discount_end
|
473
|
-
|
474
416
|
# A precise Unix timestamp for the amendment to start.
|
475
417
|
attr_accessor :timestamp
|
476
|
-
|
477
418
|
# Select one of three ways to pass the `amendment_start`.
|
478
419
|
attr_accessor :type
|
479
420
|
|
@@ -497,16 +438,12 @@ module Stripe
|
|
497
438
|
end
|
498
439
|
# The coupon code to redeem.
|
499
440
|
attr_accessor :coupon
|
500
|
-
|
501
441
|
# An ID of an existing discount for a coupon that was already redeemed.
|
502
442
|
attr_accessor :discount
|
503
|
-
|
504
443
|
# Details to determine how long the discount should be applied for.
|
505
444
|
attr_accessor :discount_end
|
506
|
-
|
507
445
|
# The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.
|
508
446
|
attr_accessor :index
|
509
|
-
|
510
447
|
# The promotion code to redeem.
|
511
448
|
attr_accessor :promotion_code
|
512
449
|
|
@@ -528,10 +465,8 @@ module Stripe
|
|
528
465
|
class Remove < Stripe::RequestParams
|
529
466
|
# The coupon code to remove from the `discounts` array.
|
530
467
|
attr_accessor :coupon
|
531
|
-
|
532
468
|
# The ID of a discount to remove from the `discounts` array.
|
533
469
|
attr_accessor :discount
|
534
|
-
|
535
470
|
# The ID of a promotion code to remove from the `discounts` array.
|
536
471
|
attr_accessor :promotion_code
|
537
472
|
|
@@ -545,10 +480,8 @@ module Stripe
|
|
545
480
|
class Set < Stripe::RequestParams
|
546
481
|
# The coupon code to replace the `discounts` array with.
|
547
482
|
attr_accessor :coupon
|
548
|
-
|
549
483
|
# An ID of an existing discount to replace the `discounts` array with.
|
550
484
|
attr_accessor :discount
|
551
|
-
|
552
485
|
# An ID of an existing promotion code to replace the `discounts` array with.
|
553
486
|
attr_accessor :promotion_code
|
554
487
|
|
@@ -560,13 +493,10 @@ module Stripe
|
|
560
493
|
end
|
561
494
|
# Details of the discount to add.
|
562
495
|
attr_accessor :add
|
563
|
-
|
564
496
|
# Details of the discount to remove.
|
565
497
|
attr_accessor :remove
|
566
|
-
|
567
498
|
# Details of the discount to replace the existing discounts with.
|
568
499
|
attr_accessor :set
|
569
|
-
|
570
500
|
# Determines the type of discount action.
|
571
501
|
attr_accessor :type
|
572
502
|
|
@@ -585,7 +515,6 @@ module Stripe
|
|
585
515
|
class Duration < Stripe::RequestParams
|
586
516
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
587
517
|
attr_accessor :interval
|
588
|
-
|
589
518
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
590
519
|
attr_accessor :interval_count
|
591
520
|
|
@@ -596,10 +525,8 @@ module Stripe
|
|
596
525
|
end
|
597
526
|
# Time span for the redeemed discount.
|
598
527
|
attr_accessor :duration
|
599
|
-
|
600
528
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
601
529
|
attr_accessor :timestamp
|
602
|
-
|
603
530
|
# The type of calculation made to determine when the discount ends.
|
604
531
|
attr_accessor :type
|
605
532
|
|
@@ -611,13 +538,10 @@ module Stripe
|
|
611
538
|
end
|
612
539
|
# ID of the coupon to create a new discount for.
|
613
540
|
attr_accessor :coupon
|
614
|
-
|
615
541
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
616
542
|
attr_accessor :discount
|
617
|
-
|
618
543
|
# Details to determine how long the discount should be applied for.
|
619
544
|
attr_accessor :discount_end
|
620
|
-
|
621
545
|
# ID of the promotion code to create a new discount for.
|
622
546
|
attr_accessor :promotion_code
|
623
547
|
|
@@ -632,7 +556,6 @@ module Stripe
|
|
632
556
|
class Trial < Stripe::RequestParams
|
633
557
|
# 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.
|
634
558
|
attr_accessor :converts_to
|
635
|
-
|
636
559
|
# Determines the type of trial for this item.
|
637
560
|
attr_accessor :type
|
638
561
|
|
@@ -643,19 +566,14 @@ module Stripe
|
|
643
566
|
end
|
644
567
|
# The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
645
568
|
attr_accessor :discounts
|
646
|
-
|
647
569
|
# 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`.
|
648
570
|
attr_accessor :metadata
|
649
|
-
|
650
571
|
# The ID of the price object.
|
651
572
|
attr_accessor :price
|
652
|
-
|
653
573
|
# Quantity for this item.
|
654
574
|
attr_accessor :quantity
|
655
|
-
|
656
575
|
# The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
|
657
576
|
attr_accessor :tax_rates
|
658
|
-
|
659
577
|
# Options that configure the trial on the subscription item.
|
660
578
|
attr_accessor :trial
|
661
579
|
|
@@ -691,7 +609,6 @@ module Stripe
|
|
691
609
|
class Duration < Stripe::RequestParams
|
692
610
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
693
611
|
attr_accessor :interval
|
694
|
-
|
695
612
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
696
613
|
attr_accessor :interval_count
|
697
614
|
|
@@ -702,10 +619,8 @@ module Stripe
|
|
702
619
|
end
|
703
620
|
# Time span for the redeemed discount.
|
704
621
|
attr_accessor :duration
|
705
|
-
|
706
622
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
707
623
|
attr_accessor :timestamp
|
708
|
-
|
709
624
|
# The type of calculation made to determine when the discount ends.
|
710
625
|
attr_accessor :type
|
711
626
|
|
@@ -717,13 +632,10 @@ module Stripe
|
|
717
632
|
end
|
718
633
|
# ID of the coupon to create a new discount for.
|
719
634
|
attr_accessor :coupon
|
720
|
-
|
721
635
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
722
636
|
attr_accessor :discount
|
723
|
-
|
724
637
|
# Details to determine how long the discount should be applied for.
|
725
638
|
attr_accessor :discount_end
|
726
|
-
|
727
639
|
# ID of the promotion code to create a new discount for.
|
728
640
|
attr_accessor :promotion_code
|
729
641
|
|
@@ -738,7 +650,6 @@ module Stripe
|
|
738
650
|
class Trial < Stripe::RequestParams
|
739
651
|
# 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.
|
740
652
|
attr_accessor :converts_to
|
741
|
-
|
742
653
|
# Determines the type of trial for this item.
|
743
654
|
attr_accessor :type
|
744
655
|
|
@@ -749,19 +660,14 @@ module Stripe
|
|
749
660
|
end
|
750
661
|
# If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.
|
751
662
|
attr_accessor :discounts
|
752
|
-
|
753
663
|
# If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.
|
754
664
|
attr_accessor :metadata
|
755
|
-
|
756
665
|
# The ID of the price object.
|
757
666
|
attr_accessor :price
|
758
|
-
|
759
667
|
# If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.
|
760
668
|
attr_accessor :quantity
|
761
|
-
|
762
669
|
# If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.
|
763
670
|
attr_accessor :tax_rates
|
764
|
-
|
765
671
|
# If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.
|
766
672
|
attr_accessor :trial
|
767
673
|
|
@@ -783,13 +689,10 @@ module Stripe
|
|
783
689
|
end
|
784
690
|
# Details of the subscription item to add. If an item with the same `price` exists, it will be replaced by this new item. Otherwise, it adds the new item.
|
785
691
|
attr_accessor :add
|
786
|
-
|
787
692
|
# Details of the subscription item to remove.
|
788
693
|
attr_accessor :remove
|
789
|
-
|
790
694
|
# Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.
|
791
695
|
attr_accessor :set
|
792
|
-
|
793
696
|
# Determines the type of item action.
|
794
697
|
attr_accessor :type
|
795
698
|
|
@@ -804,13 +707,10 @@ module Stripe
|
|
804
707
|
class MetadataAction < Stripe::RequestParams
|
805
708
|
# Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
|
806
709
|
attr_accessor :add
|
807
|
-
|
808
710
|
# Keys to remove from schedule phase metadata.
|
809
711
|
attr_accessor :remove
|
810
|
-
|
811
712
|
# Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
|
812
713
|
attr_accessor :set
|
813
|
-
|
814
714
|
# Select one of three ways to update phase-level `metadata` on subscription schedules.
|
815
715
|
attr_accessor :type
|
816
716
|
|
@@ -833,7 +733,6 @@ module Stripe
|
|
833
733
|
end
|
834
734
|
# Details of the pause_collection behavior to apply to the amendment.
|
835
735
|
attr_accessor :set
|
836
|
-
|
837
736
|
# Determines the type of the pause_collection amendment.
|
838
737
|
attr_accessor :type
|
839
738
|
|
@@ -861,31 +760,22 @@ module Stripe
|
|
861
760
|
end
|
862
761
|
# Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at `amendment_start`, and a restricted set of attributes is supported on the amendment.
|
863
762
|
attr_accessor :amendment_end
|
864
|
-
|
865
763
|
# Details to identify the earliest timestamp where the proposed change should take effect.
|
866
764
|
attr_accessor :amendment_start
|
867
|
-
|
868
765
|
# For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.
|
869
766
|
attr_accessor :billing_cycle_anchor
|
870
|
-
|
871
767
|
# Changes to the coupons being redeemed or discounts being applied during the amendment time span.
|
872
768
|
attr_accessor :discount_actions
|
873
|
-
|
874
769
|
# Changes to the subscription items during the amendment time span.
|
875
770
|
attr_accessor :item_actions
|
876
|
-
|
877
771
|
# Instructions for how to modify phase metadata
|
878
772
|
attr_accessor :metadata_actions
|
879
|
-
|
880
773
|
# Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.
|
881
774
|
attr_accessor :proration_behavior
|
882
|
-
|
883
775
|
# Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
884
776
|
attr_accessor :set_pause_collection
|
885
|
-
|
886
777
|
# Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
|
887
778
|
attr_accessor :set_schedule_end
|
888
|
-
|
889
779
|
# Settings related to subscription trials.
|
890
780
|
attr_accessor :trial_settings
|
891
781
|
|
@@ -921,7 +811,6 @@ module Stripe
|
|
921
811
|
class Duration < Stripe::RequestParams
|
922
812
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
923
813
|
attr_accessor :interval
|
924
|
-
|
925
814
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
926
815
|
attr_accessor :interval_count
|
927
816
|
|
@@ -932,10 +821,8 @@ module Stripe
|
|
932
821
|
end
|
933
822
|
# Time span for the redeemed discount.
|
934
823
|
attr_accessor :duration
|
935
|
-
|
936
824
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
937
825
|
attr_accessor :timestamp
|
938
|
-
|
939
826
|
# The type of calculation made to determine when the discount ends.
|
940
827
|
attr_accessor :type
|
941
828
|
|
@@ -947,13 +834,10 @@ module Stripe
|
|
947
834
|
end
|
948
835
|
# ID of the coupon to create a new discount for.
|
949
836
|
attr_accessor :coupon
|
950
|
-
|
951
837
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
952
838
|
attr_accessor :discount
|
953
|
-
|
954
839
|
# Details to determine how long the discount should be applied for.
|
955
840
|
attr_accessor :discount_end
|
956
|
-
|
957
841
|
# ID of the promotion code to create a new discount for.
|
958
842
|
attr_accessor :promotion_code
|
959
843
|
|
@@ -968,16 +852,12 @@ module Stripe
|
|
968
852
|
class PriceData < Stripe::RequestParams
|
969
853
|
# 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).
|
970
854
|
attr_accessor :currency
|
971
|
-
|
972
855
|
# The ID of the product that this price will belong to.
|
973
856
|
attr_accessor :product
|
974
|
-
|
975
857
|
# 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.
|
976
858
|
attr_accessor :tax_behavior
|
977
|
-
|
978
859
|
# 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.
|
979
860
|
attr_accessor :unit_amount
|
980
|
-
|
981
861
|
# 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.
|
982
862
|
attr_accessor :unit_amount_decimal
|
983
863
|
|
@@ -997,16 +877,12 @@ module Stripe
|
|
997
877
|
end
|
998
878
|
# The coupons to redeem into discounts for the item.
|
999
879
|
attr_accessor :discounts
|
1000
|
-
|
1001
880
|
# The ID of the price object. One of `price` or `price_data` is required.
|
1002
881
|
attr_accessor :price
|
1003
|
-
|
1004
882
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
1005
883
|
attr_accessor :price_data
|
1006
|
-
|
1007
884
|
# Quantity for this item. Defaults to 1.
|
1008
885
|
attr_accessor :quantity
|
1009
|
-
|
1010
886
|
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
|
1011
887
|
attr_accessor :tax_rates
|
1012
888
|
|
@@ -1029,7 +905,6 @@ module Stripe
|
|
1029
905
|
class Liability < Stripe::RequestParams
|
1030
906
|
# The connected account being referenced when `type` is `account`.
|
1031
907
|
attr_accessor :account
|
1032
|
-
|
1033
908
|
# Type of the account referenced in the request.
|
1034
909
|
attr_accessor :type
|
1035
910
|
|
@@ -1040,7 +915,6 @@ module Stripe
|
|
1040
915
|
end
|
1041
916
|
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
|
1042
917
|
attr_accessor :enabled
|
1043
|
-
|
1044
918
|
# 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.
|
1045
919
|
attr_accessor :liability
|
1046
920
|
|
@@ -1053,7 +927,6 @@ module Stripe
|
|
1053
927
|
class BillingThresholds < Stripe::RequestParams
|
1054
928
|
# Monetary threshold that triggers the subscription to advance to a new billing period
|
1055
929
|
attr_accessor :amount_gte
|
1056
|
-
|
1057
930
|
# 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.
|
1058
931
|
attr_accessor :reset_billing_cycle_anchor
|
1059
932
|
|
@@ -1068,7 +941,6 @@ module Stripe
|
|
1068
941
|
class Duration < Stripe::RequestParams
|
1069
942
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1070
943
|
attr_accessor :interval
|
1071
|
-
|
1072
944
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1073
945
|
attr_accessor :interval_count
|
1074
946
|
|
@@ -1079,10 +951,8 @@ module Stripe
|
|
1079
951
|
end
|
1080
952
|
# Time span for the redeemed discount.
|
1081
953
|
attr_accessor :duration
|
1082
|
-
|
1083
954
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1084
955
|
attr_accessor :timestamp
|
1085
|
-
|
1086
956
|
# The type of calculation made to determine when the discount ends.
|
1087
957
|
attr_accessor :type
|
1088
958
|
|
@@ -1094,13 +964,10 @@ module Stripe
|
|
1094
964
|
end
|
1095
965
|
# ID of the coupon to create a new discount for.
|
1096
966
|
attr_accessor :coupon
|
1097
|
-
|
1098
967
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1099
968
|
attr_accessor :discount
|
1100
|
-
|
1101
969
|
# Details to determine how long the discount should be applied for.
|
1102
970
|
attr_accessor :discount_end
|
1103
|
-
|
1104
971
|
# ID of the promotion code to create a new discount for.
|
1105
972
|
attr_accessor :promotion_code
|
1106
973
|
|
@@ -1116,7 +983,6 @@ module Stripe
|
|
1116
983
|
class Issuer < Stripe::RequestParams
|
1117
984
|
# The connected account being referenced when `type` is `account`.
|
1118
985
|
attr_accessor :account
|
1119
|
-
|
1120
986
|
# Type of the account referenced in the request.
|
1121
987
|
attr_accessor :type
|
1122
988
|
|
@@ -1127,10 +993,8 @@ module Stripe
|
|
1127
993
|
end
|
1128
994
|
# The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
|
1129
995
|
attr_accessor :account_tax_ids
|
1130
|
-
|
1131
996
|
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
|
1132
997
|
attr_accessor :days_until_due
|
1133
|
-
|
1134
998
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
1135
999
|
attr_accessor :issuer
|
1136
1000
|
|
@@ -1156,7 +1020,6 @@ module Stripe
|
|
1156
1020
|
class Duration < Stripe::RequestParams
|
1157
1021
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1158
1022
|
attr_accessor :interval
|
1159
|
-
|
1160
1023
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1161
1024
|
attr_accessor :interval_count
|
1162
1025
|
|
@@ -1167,10 +1030,8 @@ module Stripe
|
|
1167
1030
|
end
|
1168
1031
|
# Time span for the redeemed discount.
|
1169
1032
|
attr_accessor :duration
|
1170
|
-
|
1171
1033
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1172
1034
|
attr_accessor :timestamp
|
1173
|
-
|
1174
1035
|
# The type of calculation made to determine when the discount ends.
|
1175
1036
|
attr_accessor :type
|
1176
1037
|
|
@@ -1182,13 +1043,10 @@ module Stripe
|
|
1182
1043
|
end
|
1183
1044
|
# ID of the coupon to create a new discount for.
|
1184
1045
|
attr_accessor :coupon
|
1185
|
-
|
1186
1046
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1187
1047
|
attr_accessor :discount
|
1188
|
-
|
1189
1048
|
# Details to determine how long the discount should be applied for.
|
1190
1049
|
attr_accessor :discount_end
|
1191
|
-
|
1192
1050
|
# ID of the promotion code to create a new discount for.
|
1193
1051
|
attr_accessor :promotion_code
|
1194
1052
|
|
@@ -1204,7 +1062,6 @@ module Stripe
|
|
1204
1062
|
class Recurring < Stripe::RequestParams
|
1205
1063
|
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
1206
1064
|
attr_accessor :interval
|
1207
|
-
|
1208
1065
|
# 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).
|
1209
1066
|
attr_accessor :interval_count
|
1210
1067
|
|
@@ -1215,19 +1072,14 @@ module Stripe
|
|
1215
1072
|
end
|
1216
1073
|
# 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).
|
1217
1074
|
attr_accessor :currency
|
1218
|
-
|
1219
1075
|
# The ID of the product that this price will belong to.
|
1220
1076
|
attr_accessor :product
|
1221
|
-
|
1222
1077
|
# The recurring components of a price such as `interval` and `interval_count`.
|
1223
1078
|
attr_accessor :recurring
|
1224
|
-
|
1225
1079
|
# 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.
|
1226
1080
|
attr_accessor :tax_behavior
|
1227
|
-
|
1228
1081
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
1229
1082
|
attr_accessor :unit_amount
|
1230
|
-
|
1231
1083
|
# 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.
|
1232
1084
|
attr_accessor :unit_amount_decimal
|
1233
1085
|
|
@@ -1251,7 +1103,6 @@ module Stripe
|
|
1251
1103
|
class Trial < Stripe::RequestParams
|
1252
1104
|
# 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.
|
1253
1105
|
attr_accessor :converts_to
|
1254
|
-
|
1255
1106
|
# Determines the type of trial for this item.
|
1256
1107
|
attr_accessor :type
|
1257
1108
|
|
@@ -1262,28 +1113,20 @@ module Stripe
|
|
1262
1113
|
end
|
1263
1114
|
# 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.
|
1264
1115
|
attr_accessor :billing_thresholds
|
1265
|
-
|
1266
1116
|
# The coupons to redeem into discounts for the subscription item.
|
1267
1117
|
attr_accessor :discounts
|
1268
|
-
|
1269
1118
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
|
1270
1119
|
attr_accessor :metadata
|
1271
|
-
|
1272
1120
|
# The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
|
1273
1121
|
attr_accessor :plan
|
1274
|
-
|
1275
1122
|
# The ID of the price object.
|
1276
1123
|
attr_accessor :price
|
1277
|
-
|
1278
1124
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
|
1279
1125
|
attr_accessor :price_data
|
1280
|
-
|
1281
1126
|
# Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
|
1282
1127
|
attr_accessor :quantity
|
1283
|
-
|
1284
1128
|
# 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.
|
1285
1129
|
attr_accessor :tax_rates
|
1286
|
-
|
1287
1130
|
# Options that configure the trial on the subscription item.
|
1288
1131
|
attr_accessor :trial
|
1289
1132
|
|
@@ -1322,7 +1165,6 @@ module Stripe
|
|
1322
1165
|
class TransferData < Stripe::RequestParams
|
1323
1166
|
# 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.
|
1324
1167
|
attr_accessor :amount_percent
|
1325
|
-
|
1326
1168
|
# ID of an existing, connected Stripe account.
|
1327
1169
|
attr_accessor :destination
|
1328
1170
|
|
@@ -1350,79 +1192,54 @@ module Stripe
|
|
1350
1192
|
end
|
1351
1193
|
# A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
|
1352
1194
|
attr_accessor :add_invoice_items
|
1353
|
-
|
1354
1195
|
# 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).
|
1355
1196
|
attr_accessor :application_fee_percent
|
1356
|
-
|
1357
1197
|
# Automatic tax settings for this phase.
|
1358
1198
|
attr_accessor :automatic_tax
|
1359
|
-
|
1360
1199
|
# Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
|
1361
1200
|
attr_accessor :billing_cycle_anchor
|
1362
|
-
|
1363
1201
|
# 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.
|
1364
1202
|
attr_accessor :billing_thresholds
|
1365
|
-
|
1366
1203
|
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing 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` on creation.
|
1367
1204
|
attr_accessor :collection_method
|
1368
|
-
|
1369
1205
|
# The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
|
1370
1206
|
attr_accessor :coupon
|
1371
|
-
|
1372
1207
|
# 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).
|
1373
1208
|
attr_accessor :currency
|
1374
|
-
|
1375
1209
|
# ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
|
1376
1210
|
attr_accessor :default_payment_method
|
1377
|
-
|
1378
1211
|
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
|
1379
1212
|
attr_accessor :default_tax_rates
|
1380
|
-
|
1381
1213
|
# Subscription 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.
|
1382
1214
|
attr_accessor :description
|
1383
|
-
|
1384
1215
|
# The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
|
1385
1216
|
attr_accessor :discounts
|
1386
|
-
|
1387
1217
|
# The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
|
1388
1218
|
attr_accessor :end_date
|
1389
|
-
|
1390
1219
|
# All invoices will be billed using the specified settings.
|
1391
1220
|
attr_accessor :invoice_settings
|
1392
|
-
|
1393
1221
|
# List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
|
1394
1222
|
attr_accessor :items
|
1395
|
-
|
1396
1223
|
# Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.
|
1397
1224
|
attr_accessor :iterations
|
1398
|
-
|
1399
1225
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
|
1400
1226
|
attr_accessor :metadata
|
1401
|
-
|
1402
1227
|
# The account on behalf of which to charge, for each of the associated subscription's invoices.
|
1403
1228
|
attr_accessor :on_behalf_of
|
1404
|
-
|
1405
1229
|
# 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).
|
1406
1230
|
attr_accessor :pause_collection
|
1407
|
-
|
1408
1231
|
# Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.
|
1409
1232
|
attr_accessor :proration_behavior
|
1410
|
-
|
1411
1233
|
# The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
|
1412
1234
|
attr_accessor :start_date
|
1413
|
-
|
1414
1235
|
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
1415
1236
|
attr_accessor :transfer_data
|
1416
|
-
|
1417
1237
|
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
1418
1238
|
attr_accessor :trial
|
1419
|
-
|
1420
1239
|
# Specify trial behavior when crossing phase boundaries
|
1421
1240
|
attr_accessor :trial_continuation
|
1422
|
-
|
1423
1241
|
# Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
|
1424
1242
|
attr_accessor :trial_end
|
1425
|
-
|
1426
1243
|
# Settings related to subscription trials.
|
1427
1244
|
attr_accessor :trial_settings
|
1428
1245
|
|
@@ -1497,7 +1314,6 @@ module Stripe
|
|
1497
1314
|
class Duration < Stripe::RequestParams
|
1498
1315
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1499
1316
|
attr_accessor :interval
|
1500
|
-
|
1501
1317
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1502
1318
|
attr_accessor :interval_count
|
1503
1319
|
|
@@ -1508,13 +1324,10 @@ module Stripe
|
|
1508
1324
|
end
|
1509
1325
|
# End the prebilled period when a specified amendment ends.
|
1510
1326
|
attr_accessor :amendment_end
|
1511
|
-
|
1512
1327
|
# Time span for prebilling, starting from `bill_from`.
|
1513
1328
|
attr_accessor :duration
|
1514
|
-
|
1515
1329
|
# End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
1516
1330
|
attr_accessor :timestamp
|
1517
|
-
|
1518
1331
|
# Select one of several ways to pass the `bill_until` value.
|
1519
1332
|
attr_accessor :type
|
1520
1333
|
|
@@ -1527,7 +1340,6 @@ module Stripe
|
|
1527
1340
|
end
|
1528
1341
|
# The end of the prebilled time period.
|
1529
1342
|
attr_accessor :bill_until
|
1530
|
-
|
1531
1343
|
# This is used to determine the number of billing cycles to prebill.
|
1532
1344
|
attr_accessor :iterations
|
1533
1345
|
|
@@ -1538,19 +1350,14 @@ module Stripe
|
|
1538
1350
|
end
|
1539
1351
|
# Changes to apply to the phases of the subscription schedule, in the order provided.
|
1540
1352
|
attr_accessor :amendments
|
1541
|
-
|
1542
1353
|
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
|
1543
1354
|
attr_accessor :billing_behavior
|
1544
|
-
|
1545
1355
|
# Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
|
1546
1356
|
attr_accessor :end_behavior
|
1547
|
-
|
1548
1357
|
# List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
|
1549
1358
|
attr_accessor :phases
|
1550
|
-
|
1551
1359
|
# Provide any time periods to bill in advance.
|
1552
1360
|
attr_accessor :prebilling
|
1553
|
-
|
1554
1361
|
# In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
|
1555
1362
|
attr_accessor :proration_behavior
|
1556
1363
|
|
@@ -1587,7 +1394,6 @@ module Stripe
|
|
1587
1394
|
class Duration < Stripe::RequestParams
|
1588
1395
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1589
1396
|
attr_accessor :interval
|
1590
|
-
|
1591
1397
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1592
1398
|
attr_accessor :interval_count
|
1593
1399
|
|
@@ -1598,10 +1404,8 @@ module Stripe
|
|
1598
1404
|
end
|
1599
1405
|
# Time span for the redeemed discount.
|
1600
1406
|
attr_accessor :duration
|
1601
|
-
|
1602
1407
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1603
1408
|
attr_accessor :timestamp
|
1604
|
-
|
1605
1409
|
# The type of calculation made to determine when the discount ends.
|
1606
1410
|
attr_accessor :type
|
1607
1411
|
|
@@ -1613,13 +1417,10 @@ module Stripe
|
|
1613
1417
|
end
|
1614
1418
|
# ID of the coupon to create a new discount for.
|
1615
1419
|
attr_accessor :coupon
|
1616
|
-
|
1617
1420
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1618
1421
|
attr_accessor :discount
|
1619
|
-
|
1620
1422
|
# Details to determine how long the discount should be applied for.
|
1621
1423
|
attr_accessor :discount_end
|
1622
|
-
|
1623
1424
|
# ID of the promotion code to create a new discount for.
|
1624
1425
|
attr_accessor :promotion_code
|
1625
1426
|
|
@@ -1635,7 +1436,6 @@ module Stripe
|
|
1635
1436
|
class Recurring < Stripe::RequestParams
|
1636
1437
|
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
1637
1438
|
attr_accessor :interval
|
1638
|
-
|
1639
1439
|
# 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).
|
1640
1440
|
attr_accessor :interval_count
|
1641
1441
|
|
@@ -1646,19 +1446,14 @@ module Stripe
|
|
1646
1446
|
end
|
1647
1447
|
# 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).
|
1648
1448
|
attr_accessor :currency
|
1649
|
-
|
1650
1449
|
# The ID of the product that this price will belong to.
|
1651
1450
|
attr_accessor :product
|
1652
|
-
|
1653
1451
|
# The recurring components of a price such as `interval` and `interval_count`.
|
1654
1452
|
attr_accessor :recurring
|
1655
|
-
|
1656
1453
|
# 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.
|
1657
1454
|
attr_accessor :tax_behavior
|
1658
|
-
|
1659
1455
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
1660
1456
|
attr_accessor :unit_amount
|
1661
|
-
|
1662
1457
|
# 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.
|
1663
1458
|
attr_accessor :unit_amount_decimal
|
1664
1459
|
|
@@ -1680,34 +1475,24 @@ module Stripe
|
|
1680
1475
|
end
|
1681
1476
|
# 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.
|
1682
1477
|
attr_accessor :billing_thresholds
|
1683
|
-
|
1684
1478
|
# 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.
|
1685
1479
|
attr_accessor :clear_usage
|
1686
|
-
|
1687
1480
|
# A flag that, if set to `true`, will delete the specified item.
|
1688
1481
|
attr_accessor :deleted
|
1689
|
-
|
1690
1482
|
# The coupons to redeem into discounts for the subscription item.
|
1691
1483
|
attr_accessor :discounts
|
1692
|
-
|
1693
1484
|
# Subscription item to update.
|
1694
1485
|
attr_accessor :id
|
1695
|
-
|
1696
1486
|
# 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`.
|
1697
1487
|
attr_accessor :metadata
|
1698
|
-
|
1699
1488
|
# Plan ID for this item, as a string.
|
1700
1489
|
attr_accessor :plan
|
1701
|
-
|
1702
1490
|
# 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.
|
1703
1491
|
attr_accessor :price
|
1704
|
-
|
1705
1492
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
1706
1493
|
attr_accessor :price_data
|
1707
|
-
|
1708
1494
|
# Quantity for this item.
|
1709
1495
|
attr_accessor :quantity
|
1710
|
-
|
1711
1496
|
# 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.
|
1712
1497
|
attr_accessor :tax_rates
|
1713
1498
|
|
@@ -1748,37 +1533,26 @@ module Stripe
|
|
1748
1533
|
end
|
1749
1534
|
# For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.
|
1750
1535
|
attr_accessor :billing_cycle_anchor
|
1751
|
-
|
1752
1536
|
# 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.
|
1753
1537
|
attr_accessor :cancel_at
|
1754
|
-
|
1755
1538
|
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
|
1756
1539
|
attr_accessor :cancel_at_period_end
|
1757
|
-
|
1758
1540
|
# This simulates the subscription being canceled or expired immediately.
|
1759
1541
|
attr_accessor :cancel_now
|
1760
|
-
|
1761
1542
|
# If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set.
|
1762
1543
|
attr_accessor :default_tax_rates
|
1763
|
-
|
1764
1544
|
# A list of up to 20 subscription items, each with an attached price.
|
1765
1545
|
attr_accessor :items
|
1766
|
-
|
1767
1546
|
# The pre-billing to apply to the subscription as a preview.
|
1768
1547
|
attr_accessor :prebilling
|
1769
|
-
|
1770
1548
|
# 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`.
|
1771
1549
|
attr_accessor :proration_behavior
|
1772
|
-
|
1773
1550
|
# If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'.
|
1774
1551
|
attr_accessor :proration_date
|
1775
|
-
|
1776
1552
|
# For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.
|
1777
1553
|
attr_accessor :resume_at
|
1778
|
-
|
1779
1554
|
# Date a subscription is intended to start (can be future or past).
|
1780
1555
|
attr_accessor :start_date
|
1781
|
-
|
1782
1556
|
# If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_details.items` or `subscription` is required.
|
1783
1557
|
attr_accessor :trial_end
|
1784
1558
|
|
@@ -1826,7 +1600,6 @@ module Stripe
|
|
1826
1600
|
class Duration < Stripe::RequestParams
|
1827
1601
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1828
1602
|
attr_accessor :interval
|
1829
|
-
|
1830
1603
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1831
1604
|
attr_accessor :interval_count
|
1832
1605
|
|
@@ -1837,10 +1610,8 @@ module Stripe
|
|
1837
1610
|
end
|
1838
1611
|
# Time span for the redeemed discount.
|
1839
1612
|
attr_accessor :duration
|
1840
|
-
|
1841
1613
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1842
1614
|
attr_accessor :timestamp
|
1843
|
-
|
1844
1615
|
# The type of calculation made to determine when the discount ends.
|
1845
1616
|
attr_accessor :type
|
1846
1617
|
|
@@ -1852,13 +1623,10 @@ module Stripe
|
|
1852
1623
|
end
|
1853
1624
|
# ID of the coupon to create a new discount for.
|
1854
1625
|
attr_accessor :coupon
|
1855
|
-
|
1856
1626
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1857
1627
|
attr_accessor :discount
|
1858
|
-
|
1859
1628
|
# Details to determine how long the discount should be applied for.
|
1860
1629
|
attr_accessor :discount_end
|
1861
|
-
|
1862
1630
|
# ID of the promotion code to create a new discount for.
|
1863
1631
|
attr_accessor :promotion_code
|
1864
1632
|
|
@@ -1874,7 +1642,6 @@ module Stripe
|
|
1874
1642
|
class Recurring < Stripe::RequestParams
|
1875
1643
|
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
1876
1644
|
attr_accessor :interval
|
1877
|
-
|
1878
1645
|
# 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).
|
1879
1646
|
attr_accessor :interval_count
|
1880
1647
|
|
@@ -1885,19 +1652,14 @@ module Stripe
|
|
1885
1652
|
end
|
1886
1653
|
# 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).
|
1887
1654
|
attr_accessor :currency
|
1888
|
-
|
1889
1655
|
# The ID of the product that this price will belong to.
|
1890
1656
|
attr_accessor :product
|
1891
|
-
|
1892
1657
|
# The recurring components of a price such as `interval` and `interval_count`.
|
1893
1658
|
attr_accessor :recurring
|
1894
|
-
|
1895
1659
|
# 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.
|
1896
1660
|
attr_accessor :tax_behavior
|
1897
|
-
|
1898
1661
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
1899
1662
|
attr_accessor :unit_amount
|
1900
|
-
|
1901
1663
|
# 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.
|
1902
1664
|
attr_accessor :unit_amount_decimal
|
1903
1665
|
|
@@ -1919,34 +1681,24 @@ module Stripe
|
|
1919
1681
|
end
|
1920
1682
|
# 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.
|
1921
1683
|
attr_accessor :billing_thresholds
|
1922
|
-
|
1923
1684
|
# 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.
|
1924
1685
|
attr_accessor :clear_usage
|
1925
|
-
|
1926
1686
|
# A flag that, if set to `true`, will delete the specified item.
|
1927
1687
|
attr_accessor :deleted
|
1928
|
-
|
1929
1688
|
# The coupons to redeem into discounts for the subscription item.
|
1930
1689
|
attr_accessor :discounts
|
1931
|
-
|
1932
1690
|
# Subscription item to update.
|
1933
1691
|
attr_accessor :id
|
1934
|
-
|
1935
1692
|
# 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`.
|
1936
1693
|
attr_accessor :metadata
|
1937
|
-
|
1938
1694
|
# Plan ID for this item, as a string.
|
1939
1695
|
attr_accessor :plan
|
1940
|
-
|
1941
1696
|
# 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.
|
1942
1697
|
attr_accessor :price
|
1943
|
-
|
1944
1698
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
1945
1699
|
attr_accessor :price_data
|
1946
|
-
|
1947
1700
|
# Quantity for this item.
|
1948
1701
|
attr_accessor :quantity
|
1949
|
-
|
1950
1702
|
# 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.
|
1951
1703
|
attr_accessor :tax_rates
|
1952
1704
|
|
@@ -1987,94 +1739,64 @@ module Stripe
|
|
1987
1739
|
end
|
1988
1740
|
# Settings for automatic tax lookup for this invoice preview.
|
1989
1741
|
attr_accessor :automatic_tax
|
1990
|
-
|
1991
1742
|
# The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
|
1992
1743
|
attr_accessor :coupon
|
1993
|
-
|
1994
1744
|
# The currency to preview this invoice in. Defaults to that of `customer` if not specified.
|
1995
1745
|
attr_accessor :currency
|
1996
|
-
|
1997
1746
|
# The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
|
1998
1747
|
attr_accessor :customer
|
1999
|
-
|
2000
1748
|
# Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
|
2001
1749
|
attr_accessor :customer_details
|
2002
|
-
|
2003
1750
|
# The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.
|
2004
1751
|
attr_accessor :discounts
|
2005
|
-
|
2006
1752
|
# 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.
|
2007
1753
|
attr_accessor :ending_before
|
2008
|
-
|
2009
1754
|
# Specifies which fields in the response should be expanded.
|
2010
1755
|
attr_accessor :expand
|
2011
|
-
|
2012
1756
|
# List of invoice items to add or update in the upcoming invoice preview (up to 250).
|
2013
1757
|
attr_accessor :invoice_items
|
2014
|
-
|
2015
1758
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
2016
1759
|
attr_accessor :issuer
|
2017
|
-
|
2018
1760
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
2019
1761
|
attr_accessor :limit
|
2020
|
-
|
2021
1762
|
# The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
|
2022
1763
|
attr_accessor :on_behalf_of
|
2023
|
-
|
2024
1764
|
# Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.
|
2025
1765
|
attr_accessor :preview_mode
|
2026
|
-
|
2027
1766
|
# The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.
|
2028
1767
|
attr_accessor :schedule
|
2029
|
-
|
2030
1768
|
# The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.
|
2031
1769
|
attr_accessor :schedule_details
|
2032
|
-
|
2033
1770
|
# 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.
|
2034
1771
|
attr_accessor :starting_after
|
2035
|
-
|
2036
1772
|
# The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.
|
2037
1773
|
attr_accessor :subscription
|
2038
|
-
|
2039
1774
|
# For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead.
|
2040
1775
|
attr_accessor :subscription_billing_cycle_anchor
|
2041
|
-
|
2042
1776
|
# 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. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead.
|
2043
1777
|
attr_accessor :subscription_cancel_at
|
2044
|
-
|
2045
1778
|
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.
|
2046
1779
|
attr_accessor :subscription_cancel_at_period_end
|
2047
|
-
|
2048
1780
|
# This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead.
|
2049
1781
|
attr_accessor :subscription_cancel_now
|
2050
|
-
|
2051
1782
|
# If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead.
|
2052
1783
|
attr_accessor :subscription_default_tax_rates
|
2053
|
-
|
2054
1784
|
# The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.
|
2055
1785
|
attr_accessor :subscription_details
|
2056
|
-
|
2057
1786
|
# A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead.
|
2058
1787
|
attr_accessor :subscription_items
|
2059
|
-
|
2060
1788
|
# The pre-billing to apply to the subscription as a preview. This field has been deprecated and will be removed in a future API version. Use `subscription_details.prebilling` instead.
|
2061
1789
|
attr_accessor :subscription_prebilling
|
2062
|
-
|
2063
1790
|
# 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`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead.
|
2064
1791
|
attr_accessor :subscription_proration_behavior
|
2065
|
-
|
2066
1792
|
# If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead.
|
2067
1793
|
attr_accessor :subscription_proration_date
|
2068
|
-
|
2069
1794
|
# For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead.
|
2070
1795
|
attr_accessor :subscription_resume_at
|
2071
|
-
|
2072
1796
|
# Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead.
|
2073
1797
|
attr_accessor :subscription_start_date
|
2074
|
-
|
2075
1798
|
# If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead.
|
2076
1799
|
attr_accessor :subscription_trial_end
|
2077
|
-
|
2078
1800
|
# Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
|
2079
1801
|
attr_accessor :subscription_trial_from_plan
|
2080
1802
|
|