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
@@ -18,7 +18,6 @@ module Stripe
|
|
18
18
|
class CurrentPhase < Stripe::StripeObject
|
19
19
|
# The end of this phase of the subscription schedule.
|
20
20
|
attr_reader :end_date
|
21
|
-
|
22
21
|
# The start of this phase of the subscription schedule.
|
23
22
|
attr_reader :start_date
|
24
23
|
end
|
@@ -28,16 +27,13 @@ module Stripe
|
|
28
27
|
class Liability < Stripe::StripeObject
|
29
28
|
# The connected account being referenced when `type` is `account`.
|
30
29
|
attr_reader :account
|
31
|
-
|
32
30
|
# Type of the account referenced.
|
33
31
|
attr_reader :type
|
34
32
|
end
|
35
33
|
# If Stripe disabled automatic tax, this enum describes why.
|
36
34
|
attr_reader :disabled_reason
|
37
|
-
|
38
35
|
# Whether Stripe automatically computes tax on invoices created during this phase.
|
39
36
|
attr_reader :enabled
|
40
|
-
|
41
37
|
# 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.
|
42
38
|
attr_reader :liability
|
43
39
|
end
|
@@ -45,7 +41,6 @@ module Stripe
|
|
45
41
|
class BillingThresholds < Stripe::StripeObject
|
46
42
|
# Monetary threshold that triggers the subscription to create an invoice
|
47
43
|
attr_reader :amount_gte
|
48
|
-
|
49
44
|
# Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.
|
50
45
|
attr_reader :reset_billing_cycle_anchor
|
51
46
|
end
|
@@ -54,16 +49,13 @@ module Stripe
|
|
54
49
|
class Issuer < Stripe::StripeObject
|
55
50
|
# The connected account being referenced when `type` is `account`.
|
56
51
|
attr_reader :account
|
57
|
-
|
58
52
|
# Type of the account referenced.
|
59
53
|
attr_reader :type
|
60
54
|
end
|
61
55
|
# The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
|
62
56
|
attr_reader :account_tax_ids
|
63
|
-
|
64
57
|
# 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`.
|
65
58
|
attr_reader :days_until_due
|
66
|
-
|
67
59
|
# Attribute for field issuer
|
68
60
|
attr_reader :issuer
|
69
61
|
end
|
@@ -71,37 +63,27 @@ module Stripe
|
|
71
63
|
class TransferData < Stripe::StripeObject
|
72
64
|
# 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.
|
73
65
|
attr_reader :amount_percent
|
74
|
-
|
75
66
|
# The account where funds from the payment will be transferred to upon payment success.
|
76
67
|
attr_reader :destination
|
77
68
|
end
|
78
69
|
# 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 during this phase of the schedule.
|
79
70
|
attr_reader :application_fee_percent
|
80
|
-
|
81
71
|
# Attribute for field automatic_tax
|
82
72
|
attr_reader :automatic_tax
|
83
|
-
|
84
73
|
# Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
|
85
74
|
attr_reader :billing_cycle_anchor
|
86
|
-
|
87
75
|
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
|
88
76
|
attr_reader :billing_thresholds
|
89
|
-
|
90
77
|
# 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`.
|
91
78
|
attr_reader :collection_method
|
92
|
-
|
93
79
|
# ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
|
94
80
|
attr_reader :default_payment_method
|
95
|
-
|
96
81
|
# 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.
|
97
82
|
attr_reader :description
|
98
|
-
|
99
83
|
# Attribute for field invoice_settings
|
100
84
|
attr_reader :invoice_settings
|
101
|
-
|
102
85
|
# The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
|
103
86
|
attr_reader :on_behalf_of
|
104
|
-
|
105
87
|
# The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
|
106
88
|
attr_reader :transfer_data
|
107
89
|
end
|
@@ -110,16 +92,13 @@ module Stripe
|
|
110
92
|
class FailedTransition < Stripe::StripeObject
|
111
93
|
# The original price to be migrated.
|
112
94
|
attr_reader :source_price
|
113
|
-
|
114
95
|
# The intended resulting price of the migration.
|
115
96
|
attr_reader :target_price
|
116
97
|
end
|
117
98
|
# The time at which the price migration encountered an error.
|
118
99
|
attr_reader :errored_at
|
119
|
-
|
120
100
|
# The involved price pairs in each failed transition.
|
121
101
|
attr_reader :failed_transitions
|
122
|
-
|
123
102
|
# The type of error encountered by the price migration.
|
124
103
|
attr_reader :type
|
125
104
|
end
|
@@ -130,31 +109,24 @@ module Stripe
|
|
130
109
|
class DiscountEnd < Stripe::StripeObject
|
131
110
|
# The discount end timestamp.
|
132
111
|
attr_reader :timestamp
|
133
|
-
|
134
112
|
# The discount end type.
|
135
113
|
attr_reader :type
|
136
114
|
end
|
137
115
|
# ID of the coupon to create a new discount for.
|
138
116
|
attr_reader :coupon
|
139
|
-
|
140
117
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
141
118
|
attr_reader :discount
|
142
|
-
|
143
119
|
# Details to determine how long the discount should be applied for.
|
144
120
|
attr_reader :discount_end
|
145
|
-
|
146
121
|
# ID of the promotion code to create a new discount for.
|
147
122
|
attr_reader :promotion_code
|
148
123
|
end
|
149
124
|
# The stackable discounts that will be applied to the item.
|
150
125
|
attr_reader :discounts
|
151
|
-
|
152
126
|
# ID of the price used to generate the invoice item.
|
153
127
|
attr_reader :price
|
154
|
-
|
155
128
|
# The quantity of the invoice item.
|
156
129
|
attr_reader :quantity
|
157
|
-
|
158
130
|
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
|
159
131
|
attr_reader :tax_rates
|
160
132
|
end
|
@@ -163,16 +135,13 @@ module Stripe
|
|
163
135
|
class Liability < Stripe::StripeObject
|
164
136
|
# The connected account being referenced when `type` is `account`.
|
165
137
|
attr_reader :account
|
166
|
-
|
167
138
|
# Type of the account referenced.
|
168
139
|
attr_reader :type
|
169
140
|
end
|
170
141
|
# If Stripe disabled automatic tax, this enum describes why.
|
171
142
|
attr_reader :disabled_reason
|
172
|
-
|
173
143
|
# Whether Stripe automatically computes tax on invoices created during this phase.
|
174
144
|
attr_reader :enabled
|
175
|
-
|
176
145
|
# 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.
|
177
146
|
attr_reader :liability
|
178
147
|
end
|
@@ -180,7 +149,6 @@ module Stripe
|
|
180
149
|
class BillingThresholds < Stripe::StripeObject
|
181
150
|
# Monetary threshold that triggers the subscription to create an invoice
|
182
151
|
attr_reader :amount_gte
|
183
|
-
|
184
152
|
# Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.
|
185
153
|
attr_reader :reset_billing_cycle_anchor
|
186
154
|
end
|
@@ -189,19 +157,15 @@ module Stripe
|
|
189
157
|
class DiscountEnd < Stripe::StripeObject
|
190
158
|
# The discount end timestamp.
|
191
159
|
attr_reader :timestamp
|
192
|
-
|
193
160
|
# The discount end type.
|
194
161
|
attr_reader :type
|
195
162
|
end
|
196
163
|
# ID of the coupon to create a new discount for.
|
197
164
|
attr_reader :coupon
|
198
|
-
|
199
165
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
200
166
|
attr_reader :discount
|
201
|
-
|
202
167
|
# Details to determine how long the discount should be applied for.
|
203
168
|
attr_reader :discount_end
|
204
|
-
|
205
169
|
# ID of the promotion code to create a new discount for.
|
206
170
|
attr_reader :promotion_code
|
207
171
|
end
|
@@ -210,16 +174,13 @@ module Stripe
|
|
210
174
|
class Issuer < Stripe::StripeObject
|
211
175
|
# The connected account being referenced when `type` is `account`.
|
212
176
|
attr_reader :account
|
213
|
-
|
214
177
|
# Type of the account referenced.
|
215
178
|
attr_reader :type
|
216
179
|
end
|
217
180
|
# 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.
|
218
181
|
attr_reader :account_tax_ids
|
219
|
-
|
220
182
|
# 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`.
|
221
183
|
attr_reader :days_until_due
|
222
|
-
|
223
184
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
224
185
|
attr_reader :issuer
|
225
186
|
end
|
@@ -234,19 +195,15 @@ module Stripe
|
|
234
195
|
class DiscountEnd < Stripe::StripeObject
|
235
196
|
# The discount end timestamp.
|
236
197
|
attr_reader :timestamp
|
237
|
-
|
238
198
|
# The discount end type.
|
239
199
|
attr_reader :type
|
240
200
|
end
|
241
201
|
# ID of the coupon to create a new discount for.
|
242
202
|
attr_reader :coupon
|
243
|
-
|
244
203
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
245
204
|
attr_reader :discount
|
246
|
-
|
247
205
|
# Details to determine how long the discount should be applied for.
|
248
206
|
attr_reader :discount_end
|
249
|
-
|
250
207
|
# ID of the promotion code to create a new discount for.
|
251
208
|
attr_reader :promotion_code
|
252
209
|
end
|
@@ -254,31 +211,23 @@ module Stripe
|
|
254
211
|
class Trial < Stripe::StripeObject
|
255
212
|
# List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
|
256
213
|
attr_reader :converts_to
|
257
|
-
|
258
214
|
# Determines the type of trial for this item.
|
259
215
|
attr_reader :type
|
260
216
|
end
|
261
217
|
# Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
|
262
218
|
attr_reader :billing_thresholds
|
263
|
-
|
264
219
|
# The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
|
265
220
|
attr_reader :discounts
|
266
|
-
|
267
221
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.
|
268
222
|
attr_reader :metadata
|
269
|
-
|
270
223
|
# ID of the plan to which the customer should be subscribed.
|
271
224
|
attr_reader :plan
|
272
|
-
|
273
225
|
# ID of the price to which the customer should be subscribed.
|
274
226
|
attr_reader :price
|
275
|
-
|
276
227
|
# Quantity of the plan to which the customer should be subscribed.
|
277
228
|
attr_reader :quantity
|
278
|
-
|
279
229
|
# The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.
|
280
230
|
attr_reader :tax_rates
|
281
|
-
|
282
231
|
# Options that configure the trial on the subscription item.
|
283
232
|
attr_reader :trial
|
284
233
|
end
|
@@ -291,7 +240,6 @@ module Stripe
|
|
291
240
|
class TransferData < Stripe::StripeObject
|
292
241
|
# 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.
|
293
242
|
attr_reader :amount_percent
|
294
|
-
|
295
243
|
# The account where funds from the payment will be transferred to upon payment success.
|
296
244
|
attr_reader :destination
|
297
245
|
end
|
@@ -306,73 +254,50 @@ module Stripe
|
|
306
254
|
end
|
307
255
|
# A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
|
308
256
|
attr_reader :add_invoice_items
|
309
|
-
|
310
257
|
# 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 during this phase of the schedule.
|
311
258
|
attr_reader :application_fee_percent
|
312
|
-
|
313
259
|
# Attribute for field automatic_tax
|
314
260
|
attr_reader :automatic_tax
|
315
|
-
|
316
261
|
# Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
|
317
262
|
attr_reader :billing_cycle_anchor
|
318
|
-
|
319
263
|
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
|
320
264
|
attr_reader :billing_thresholds
|
321
|
-
|
322
265
|
# 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`.
|
323
266
|
attr_reader :collection_method
|
324
|
-
|
325
267
|
# ID of the coupon to use during this phase of the subscription schedule.
|
326
268
|
attr_reader :coupon
|
327
|
-
|
328
269
|
# 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).
|
329
270
|
attr_reader :currency
|
330
|
-
|
331
271
|
# 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.
|
332
272
|
attr_reader :default_payment_method
|
333
|
-
|
334
273
|
# The default tax rates to apply to the subscription during this phase of the subscription schedule.
|
335
274
|
attr_reader :default_tax_rates
|
336
|
-
|
337
275
|
# 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.
|
338
276
|
attr_reader :description
|
339
|
-
|
340
277
|
# The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.
|
341
278
|
attr_reader :discounts
|
342
|
-
|
343
279
|
# The end of this phase of the subscription schedule.
|
344
280
|
attr_reader :end_date
|
345
|
-
|
346
281
|
# The invoice settings applicable during this phase.
|
347
282
|
attr_reader :invoice_settings
|
348
|
-
|
349
283
|
# Subscription items to configure the subscription to during this phase of the subscription schedule.
|
350
284
|
attr_reader :items
|
351
|
-
|
352
285
|
# 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. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`.
|
353
286
|
attr_reader :metadata
|
354
|
-
|
355
287
|
# The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
|
356
288
|
attr_reader :on_behalf_of
|
357
|
-
|
358
289
|
# 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).
|
359
290
|
attr_reader :pause_collection
|
360
|
-
|
361
291
|
# If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`.
|
362
292
|
attr_reader :proration_behavior
|
363
|
-
|
364
293
|
# The start of this phase of the subscription schedule.
|
365
294
|
attr_reader :start_date
|
366
|
-
|
367
295
|
# The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
|
368
296
|
attr_reader :transfer_data
|
369
|
-
|
370
297
|
# Specify behavior of the trial when crossing schedule phase boundaries
|
371
298
|
attr_reader :trial_continuation
|
372
|
-
|
373
299
|
# When the trial ends within the phase.
|
374
300
|
attr_reader :trial_end
|
375
|
-
|
376
301
|
# Settings related to any trials on the subscription during this phase.
|
377
302
|
attr_reader :trial_settings
|
378
303
|
end
|
@@ -380,13 +305,10 @@ module Stripe
|
|
380
305
|
class Prebilling < Stripe::StripeObject
|
381
306
|
# ID of the prebilling invoice.
|
382
307
|
attr_reader :invoice
|
383
|
-
|
384
308
|
# The end of the last period for which the invoice pre-bills.
|
385
309
|
attr_reader :period_end
|
386
|
-
|
387
310
|
# The start of the first period for which the invoice pre-bills.
|
388
311
|
attr_reader :period_start
|
389
|
-
|
390
312
|
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
|
391
313
|
attr_reader :update_behavior
|
392
314
|
end
|
@@ -395,13 +317,10 @@ module Stripe
|
|
395
317
|
class CanceledAt < Stripe::RequestParams
|
396
318
|
# Minimum value to filter by (exclusive)
|
397
319
|
attr_accessor :gt
|
398
|
-
|
399
320
|
# Minimum value to filter by (inclusive)
|
400
321
|
attr_accessor :gte
|
401
|
-
|
402
322
|
# Maximum value to filter by (exclusive)
|
403
323
|
attr_accessor :lt
|
404
|
-
|
405
324
|
# Maximum value to filter by (inclusive)
|
406
325
|
attr_accessor :lte
|
407
326
|
|
@@ -416,13 +335,10 @@ module Stripe
|
|
416
335
|
class CompletedAt < Stripe::RequestParams
|
417
336
|
# Minimum value to filter by (exclusive)
|
418
337
|
attr_accessor :gt
|
419
|
-
|
420
338
|
# Minimum value to filter by (inclusive)
|
421
339
|
attr_accessor :gte
|
422
|
-
|
423
340
|
# Maximum value to filter by (exclusive)
|
424
341
|
attr_accessor :lt
|
425
|
-
|
426
342
|
# Maximum value to filter by (inclusive)
|
427
343
|
attr_accessor :lte
|
428
344
|
|
@@ -437,13 +353,10 @@ module Stripe
|
|
437
353
|
class Created < Stripe::RequestParams
|
438
354
|
# Minimum value to filter by (exclusive)
|
439
355
|
attr_accessor :gt
|
440
|
-
|
441
356
|
# Minimum value to filter by (inclusive)
|
442
357
|
attr_accessor :gte
|
443
|
-
|
444
358
|
# Maximum value to filter by (exclusive)
|
445
359
|
attr_accessor :lt
|
446
|
-
|
447
360
|
# Maximum value to filter by (inclusive)
|
448
361
|
attr_accessor :lte
|
449
362
|
|
@@ -458,13 +371,10 @@ module Stripe
|
|
458
371
|
class ReleasedAt < Stripe::RequestParams
|
459
372
|
# Minimum value to filter by (exclusive)
|
460
373
|
attr_accessor :gt
|
461
|
-
|
462
374
|
# Minimum value to filter by (inclusive)
|
463
375
|
attr_accessor :gte
|
464
|
-
|
465
376
|
# Maximum value to filter by (exclusive)
|
466
377
|
attr_accessor :lt
|
467
|
-
|
468
378
|
# Maximum value to filter by (inclusive)
|
469
379
|
attr_accessor :lte
|
470
380
|
|
@@ -477,31 +387,22 @@ module Stripe
|
|
477
387
|
end
|
478
388
|
# Only return subscription schedules that were created canceled the given date interval.
|
479
389
|
attr_accessor :canceled_at
|
480
|
-
|
481
390
|
# Only return subscription schedules that completed during the given date interval.
|
482
391
|
attr_accessor :completed_at
|
483
|
-
|
484
392
|
# Only return subscription schedules that were created during the given date interval.
|
485
393
|
attr_accessor :created
|
486
|
-
|
487
394
|
# Only return subscription schedules for the given customer.
|
488
395
|
attr_accessor :customer
|
489
|
-
|
490
396
|
# 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.
|
491
397
|
attr_accessor :ending_before
|
492
|
-
|
493
398
|
# Specifies which fields in the response should be expanded.
|
494
399
|
attr_accessor :expand
|
495
|
-
|
496
400
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
497
401
|
attr_accessor :limit
|
498
|
-
|
499
402
|
# Only return subscription schedules that were released during the given date interval.
|
500
403
|
attr_accessor :released_at
|
501
|
-
|
502
404
|
# Only return subscription schedules that have not started yet.
|
503
405
|
attr_accessor :scheduled
|
504
|
-
|
505
406
|
# 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.
|
506
407
|
attr_accessor :starting_after
|
507
408
|
|
@@ -536,7 +437,6 @@ module Stripe
|
|
536
437
|
class Liability < Stripe::RequestParams
|
537
438
|
# The connected account being referenced when `type` is `account`.
|
538
439
|
attr_accessor :account
|
539
|
-
|
540
440
|
# Type of the account referenced in the request.
|
541
441
|
attr_accessor :type
|
542
442
|
|
@@ -547,7 +447,6 @@ module Stripe
|
|
547
447
|
end
|
548
448
|
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
|
549
449
|
attr_accessor :enabled
|
550
|
-
|
551
450
|
# 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.
|
552
451
|
attr_accessor :liability
|
553
452
|
|
@@ -560,7 +459,6 @@ module Stripe
|
|
560
459
|
class BillingThresholds < Stripe::RequestParams
|
561
460
|
# Monetary threshold that triggers the subscription to advance to a new billing period
|
562
461
|
attr_accessor :amount_gte
|
563
|
-
|
564
462
|
# 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.
|
565
463
|
attr_accessor :reset_billing_cycle_anchor
|
566
464
|
|
@@ -574,7 +472,6 @@ module Stripe
|
|
574
472
|
class Issuer < Stripe::RequestParams
|
575
473
|
# The connected account being referenced when `type` is `account`.
|
576
474
|
attr_accessor :account
|
577
|
-
|
578
475
|
# Type of the account referenced in the request.
|
579
476
|
attr_accessor :type
|
580
477
|
|
@@ -585,10 +482,8 @@ module Stripe
|
|
585
482
|
end
|
586
483
|
# The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
|
587
484
|
attr_accessor :account_tax_ids
|
588
|
-
|
589
485
|
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.
|
590
486
|
attr_accessor :days_until_due
|
591
|
-
|
592
487
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
593
488
|
attr_accessor :issuer
|
594
489
|
|
@@ -602,7 +497,6 @@ module Stripe
|
|
602
497
|
class TransferData < Stripe::RequestParams
|
603
498
|
# 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.
|
604
499
|
attr_accessor :amount_percent
|
605
|
-
|
606
500
|
# ID of an existing, connected Stripe account.
|
607
501
|
attr_accessor :destination
|
608
502
|
|
@@ -613,31 +507,22 @@ module Stripe
|
|
613
507
|
end
|
614
508
|
# 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).
|
615
509
|
attr_accessor :application_fee_percent
|
616
|
-
|
617
510
|
# Default settings for automatic tax computation.
|
618
511
|
attr_accessor :automatic_tax
|
619
|
-
|
620
512
|
# 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).
|
621
513
|
attr_accessor :billing_cycle_anchor
|
622
|
-
|
623
514
|
# 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.
|
624
515
|
attr_accessor :billing_thresholds
|
625
|
-
|
626
516
|
# 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.
|
627
517
|
attr_accessor :collection_method
|
628
|
-
|
629
518
|
# 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.
|
630
519
|
attr_accessor :default_payment_method
|
631
|
-
|
632
520
|
# 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.
|
633
521
|
attr_accessor :description
|
634
|
-
|
635
522
|
# All invoices will be billed using the specified settings.
|
636
523
|
attr_accessor :invoice_settings
|
637
|
-
|
638
524
|
# The account on behalf of which to charge, for each of the associated subscription's invoices.
|
639
525
|
attr_accessor :on_behalf_of
|
640
|
-
|
641
526
|
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
642
527
|
attr_accessor :transfer_data
|
643
528
|
|
@@ -673,7 +558,6 @@ module Stripe
|
|
673
558
|
class Duration < Stripe::RequestParams
|
674
559
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
675
560
|
attr_accessor :interval
|
676
|
-
|
677
561
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
678
562
|
attr_accessor :interval_count
|
679
563
|
|
@@ -684,10 +568,8 @@ module Stripe
|
|
684
568
|
end
|
685
569
|
# Time span for the redeemed discount.
|
686
570
|
attr_accessor :duration
|
687
|
-
|
688
571
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
689
572
|
attr_accessor :timestamp
|
690
|
-
|
691
573
|
# The type of calculation made to determine when the discount ends.
|
692
574
|
attr_accessor :type
|
693
575
|
|
@@ -699,13 +581,10 @@ module Stripe
|
|
699
581
|
end
|
700
582
|
# ID of the coupon to create a new discount for.
|
701
583
|
attr_accessor :coupon
|
702
|
-
|
703
584
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
704
585
|
attr_accessor :discount
|
705
|
-
|
706
586
|
# Details to determine how long the discount should be applied for.
|
707
587
|
attr_accessor :discount_end
|
708
|
-
|
709
588
|
# ID of the promotion code to create a new discount for.
|
710
589
|
attr_accessor :promotion_code
|
711
590
|
|
@@ -720,16 +599,12 @@ module Stripe
|
|
720
599
|
class PriceData < Stripe::RequestParams
|
721
600
|
# 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).
|
722
601
|
attr_accessor :currency
|
723
|
-
|
724
602
|
# The ID of the product that this price will belong to.
|
725
603
|
attr_accessor :product
|
726
|
-
|
727
604
|
# 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.
|
728
605
|
attr_accessor :tax_behavior
|
729
|
-
|
730
606
|
# 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.
|
731
607
|
attr_accessor :unit_amount
|
732
|
-
|
733
608
|
# 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.
|
734
609
|
attr_accessor :unit_amount_decimal
|
735
610
|
|
@@ -749,16 +624,12 @@ module Stripe
|
|
749
624
|
end
|
750
625
|
# The coupons to redeem into discounts for the item.
|
751
626
|
attr_accessor :discounts
|
752
|
-
|
753
627
|
# The ID of the price object. One of `price` or `price_data` is required.
|
754
628
|
attr_accessor :price
|
755
|
-
|
756
629
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
757
630
|
attr_accessor :price_data
|
758
|
-
|
759
631
|
# Quantity for this item. Defaults to 1.
|
760
632
|
attr_accessor :quantity
|
761
|
-
|
762
633
|
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
|
763
634
|
attr_accessor :tax_rates
|
764
635
|
|
@@ -775,7 +646,6 @@ module Stripe
|
|
775
646
|
class Liability < Stripe::RequestParams
|
776
647
|
# The connected account being referenced when `type` is `account`.
|
777
648
|
attr_accessor :account
|
778
|
-
|
779
649
|
# Type of the account referenced in the request.
|
780
650
|
attr_accessor :type
|
781
651
|
|
@@ -786,7 +656,6 @@ module Stripe
|
|
786
656
|
end
|
787
657
|
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
|
788
658
|
attr_accessor :enabled
|
789
|
-
|
790
659
|
# 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.
|
791
660
|
attr_accessor :liability
|
792
661
|
|
@@ -799,7 +668,6 @@ module Stripe
|
|
799
668
|
class BillingThresholds < Stripe::RequestParams
|
800
669
|
# Monetary threshold that triggers the subscription to advance to a new billing period
|
801
670
|
attr_accessor :amount_gte
|
802
|
-
|
803
671
|
# 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.
|
804
672
|
attr_accessor :reset_billing_cycle_anchor
|
805
673
|
|
@@ -814,7 +682,6 @@ module Stripe
|
|
814
682
|
class Duration < Stripe::RequestParams
|
815
683
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
816
684
|
attr_accessor :interval
|
817
|
-
|
818
685
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
819
686
|
attr_accessor :interval_count
|
820
687
|
|
@@ -825,10 +692,8 @@ module Stripe
|
|
825
692
|
end
|
826
693
|
# Time span for the redeemed discount.
|
827
694
|
attr_accessor :duration
|
828
|
-
|
829
695
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
830
696
|
attr_accessor :timestamp
|
831
|
-
|
832
697
|
# The type of calculation made to determine when the discount ends.
|
833
698
|
attr_accessor :type
|
834
699
|
|
@@ -840,13 +705,10 @@ module Stripe
|
|
840
705
|
end
|
841
706
|
# ID of the coupon to create a new discount for.
|
842
707
|
attr_accessor :coupon
|
843
|
-
|
844
708
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
845
709
|
attr_accessor :discount
|
846
|
-
|
847
710
|
# Details to determine how long the discount should be applied for.
|
848
711
|
attr_accessor :discount_end
|
849
|
-
|
850
712
|
# ID of the promotion code to create a new discount for.
|
851
713
|
attr_accessor :promotion_code
|
852
714
|
|
@@ -862,7 +724,6 @@ module Stripe
|
|
862
724
|
class Issuer < Stripe::RequestParams
|
863
725
|
# The connected account being referenced when `type` is `account`.
|
864
726
|
attr_accessor :account
|
865
|
-
|
866
727
|
# Type of the account referenced in the request.
|
867
728
|
attr_accessor :type
|
868
729
|
|
@@ -873,10 +734,8 @@ module Stripe
|
|
873
734
|
end
|
874
735
|
# 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.
|
875
736
|
attr_accessor :account_tax_ids
|
876
|
-
|
877
737
|
# 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`.
|
878
738
|
attr_accessor :days_until_due
|
879
|
-
|
880
739
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
881
740
|
attr_accessor :issuer
|
882
741
|
|
@@ -902,7 +761,6 @@ module Stripe
|
|
902
761
|
class Duration < Stripe::RequestParams
|
903
762
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
904
763
|
attr_accessor :interval
|
905
|
-
|
906
764
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
907
765
|
attr_accessor :interval_count
|
908
766
|
|
@@ -913,10 +771,8 @@ module Stripe
|
|
913
771
|
end
|
914
772
|
# Time span for the redeemed discount.
|
915
773
|
attr_accessor :duration
|
916
|
-
|
917
774
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
918
775
|
attr_accessor :timestamp
|
919
|
-
|
920
776
|
# The type of calculation made to determine when the discount ends.
|
921
777
|
attr_accessor :type
|
922
778
|
|
@@ -928,13 +784,10 @@ module Stripe
|
|
928
784
|
end
|
929
785
|
# ID of the coupon to create a new discount for.
|
930
786
|
attr_accessor :coupon
|
931
|
-
|
932
787
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
933
788
|
attr_accessor :discount
|
934
|
-
|
935
789
|
# Details to determine how long the discount should be applied for.
|
936
790
|
attr_accessor :discount_end
|
937
|
-
|
938
791
|
# ID of the promotion code to create a new discount for.
|
939
792
|
attr_accessor :promotion_code
|
940
793
|
|
@@ -950,7 +803,6 @@ module Stripe
|
|
950
803
|
class Recurring < Stripe::RequestParams
|
951
804
|
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
952
805
|
attr_accessor :interval
|
953
|
-
|
954
806
|
# 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).
|
955
807
|
attr_accessor :interval_count
|
956
808
|
|
@@ -961,19 +813,14 @@ module Stripe
|
|
961
813
|
end
|
962
814
|
# 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).
|
963
815
|
attr_accessor :currency
|
964
|
-
|
965
816
|
# The ID of the product that this price will belong to.
|
966
817
|
attr_accessor :product
|
967
|
-
|
968
818
|
# The recurring components of a price such as `interval` and `interval_count`.
|
969
819
|
attr_accessor :recurring
|
970
|
-
|
971
820
|
# 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.
|
972
821
|
attr_accessor :tax_behavior
|
973
|
-
|
974
822
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
975
823
|
attr_accessor :unit_amount
|
976
|
-
|
977
824
|
# 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.
|
978
825
|
attr_accessor :unit_amount_decimal
|
979
826
|
|
@@ -997,7 +844,6 @@ module Stripe
|
|
997
844
|
class Trial < Stripe::RequestParams
|
998
845
|
# 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.
|
999
846
|
attr_accessor :converts_to
|
1000
|
-
|
1001
847
|
# Determines the type of trial for this item.
|
1002
848
|
attr_accessor :type
|
1003
849
|
|
@@ -1008,28 +854,20 @@ module Stripe
|
|
1008
854
|
end
|
1009
855
|
# 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.
|
1010
856
|
attr_accessor :billing_thresholds
|
1011
|
-
|
1012
857
|
# The coupons to redeem into discounts for the subscription item.
|
1013
858
|
attr_accessor :discounts
|
1014
|
-
|
1015
859
|
# 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`.
|
1016
860
|
attr_accessor :metadata
|
1017
|
-
|
1018
861
|
# The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
|
1019
862
|
attr_accessor :plan
|
1020
|
-
|
1021
863
|
# The ID of the price object.
|
1022
864
|
attr_accessor :price
|
1023
|
-
|
1024
865
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
|
1025
866
|
attr_accessor :price_data
|
1026
|
-
|
1027
867
|
# Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
|
1028
868
|
attr_accessor :quantity
|
1029
|
-
|
1030
869
|
# 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.
|
1031
870
|
attr_accessor :tax_rates
|
1032
|
-
|
1033
871
|
# Options that configure the trial on the subscription item.
|
1034
872
|
attr_accessor :trial
|
1035
873
|
|
@@ -1068,7 +906,6 @@ module Stripe
|
|
1068
906
|
class TransferData < Stripe::RequestParams
|
1069
907
|
# 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.
|
1070
908
|
attr_accessor :amount_percent
|
1071
|
-
|
1072
909
|
# ID of an existing, connected Stripe account.
|
1073
910
|
attr_accessor :destination
|
1074
911
|
|
@@ -1096,76 +933,52 @@ module Stripe
|
|
1096
933
|
end
|
1097
934
|
# 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.
|
1098
935
|
attr_accessor :add_invoice_items
|
1099
|
-
|
1100
936
|
# 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).
|
1101
937
|
attr_accessor :application_fee_percent
|
1102
|
-
|
1103
938
|
# Automatic tax settings for this phase.
|
1104
939
|
attr_accessor :automatic_tax
|
1105
|
-
|
1106
940
|
# 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).
|
1107
941
|
attr_accessor :billing_cycle_anchor
|
1108
|
-
|
1109
942
|
# 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.
|
1110
943
|
attr_accessor :billing_thresholds
|
1111
|
-
|
1112
944
|
# 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.
|
1113
945
|
attr_accessor :collection_method
|
1114
|
-
|
1115
946
|
# 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.
|
1116
947
|
attr_accessor :coupon
|
1117
|
-
|
1118
948
|
# 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).
|
1119
949
|
attr_accessor :currency
|
1120
|
-
|
1121
950
|
# 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.
|
1122
951
|
attr_accessor :default_payment_method
|
1123
|
-
|
1124
952
|
# 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.
|
1125
953
|
attr_accessor :default_tax_rates
|
1126
|
-
|
1127
954
|
# 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.
|
1128
955
|
attr_accessor :description
|
1129
|
-
|
1130
956
|
# 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.
|
1131
957
|
attr_accessor :discounts
|
1132
|
-
|
1133
958
|
# The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
|
1134
959
|
attr_accessor :end_date
|
1135
|
-
|
1136
960
|
# All invoices will be billed using the specified settings.
|
1137
961
|
attr_accessor :invoice_settings
|
1138
|
-
|
1139
962
|
# List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
|
1140
963
|
attr_accessor :items
|
1141
|
-
|
1142
964
|
# 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.
|
1143
965
|
attr_accessor :iterations
|
1144
|
-
|
1145
966
|
# 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`.
|
1146
967
|
attr_accessor :metadata
|
1147
|
-
|
1148
968
|
# The account on behalf of which to charge, for each of the associated subscription's invoices.
|
1149
969
|
attr_accessor :on_behalf_of
|
1150
|
-
|
1151
970
|
# 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).
|
1152
971
|
attr_accessor :pause_collection
|
1153
|
-
|
1154
972
|
# 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.
|
1155
973
|
attr_accessor :proration_behavior
|
1156
|
-
|
1157
974
|
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
1158
975
|
attr_accessor :transfer_data
|
1159
|
-
|
1160
976
|
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
1161
977
|
attr_accessor :trial
|
1162
|
-
|
1163
978
|
# Specify trial behavior when crossing phase boundaries
|
1164
979
|
attr_accessor :trial_continuation
|
1165
|
-
|
1166
980
|
# 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`
|
1167
981
|
attr_accessor :trial_end
|
1168
|
-
|
1169
982
|
# Settings related to subscription trials.
|
1170
983
|
attr_accessor :trial_settings
|
1171
984
|
|
@@ -1227,7 +1040,6 @@ module Stripe
|
|
1227
1040
|
class Prebilling < Stripe::RequestParams
|
1228
1041
|
# This is used to determine the number of billing cycles to prebill.
|
1229
1042
|
attr_accessor :iterations
|
1230
|
-
|
1231
1043
|
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
1232
1044
|
attr_accessor :update_behavior
|
1233
1045
|
|
@@ -1238,31 +1050,22 @@ module Stripe
|
|
1238
1050
|
end
|
1239
1051
|
# 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.
|
1240
1052
|
attr_accessor :billing_behavior
|
1241
|
-
|
1242
1053
|
# The identifier of the customer to create the subscription schedule for.
|
1243
1054
|
attr_accessor :customer
|
1244
|
-
|
1245
1055
|
# Object representing the subscription schedule's default settings.
|
1246
1056
|
attr_accessor :default_settings
|
1247
|
-
|
1248
1057
|
# 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.
|
1249
1058
|
attr_accessor :end_behavior
|
1250
|
-
|
1251
1059
|
# Specifies which fields in the response should be expanded.
|
1252
1060
|
attr_accessor :expand
|
1253
|
-
|
1254
1061
|
# Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
|
1255
1062
|
attr_accessor :from_subscription
|
1256
|
-
|
1257
1063
|
# 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`.
|
1258
1064
|
attr_accessor :metadata
|
1259
|
-
|
1260
1065
|
# 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.
|
1261
1066
|
attr_accessor :phases
|
1262
|
-
|
1263
1067
|
# If specified, the invoicing for the given billing cycle iterations will be processed now.
|
1264
1068
|
attr_accessor :prebilling
|
1265
|
-
|
1266
1069
|
# When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
|
1267
1070
|
attr_accessor :start_date
|
1268
1071
|
|
@@ -1306,7 +1109,6 @@ module Stripe
|
|
1306
1109
|
class Liability < Stripe::RequestParams
|
1307
1110
|
# The connected account being referenced when `type` is `account`.
|
1308
1111
|
attr_accessor :account
|
1309
|
-
|
1310
1112
|
# Type of the account referenced in the request.
|
1311
1113
|
attr_accessor :type
|
1312
1114
|
|
@@ -1317,7 +1119,6 @@ module Stripe
|
|
1317
1119
|
end
|
1318
1120
|
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
|
1319
1121
|
attr_accessor :enabled
|
1320
|
-
|
1321
1122
|
# 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.
|
1322
1123
|
attr_accessor :liability
|
1323
1124
|
|
@@ -1330,7 +1131,6 @@ module Stripe
|
|
1330
1131
|
class BillingThresholds < Stripe::RequestParams
|
1331
1132
|
# Monetary threshold that triggers the subscription to advance to a new billing period
|
1332
1133
|
attr_accessor :amount_gte
|
1333
|
-
|
1334
1134
|
# 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.
|
1335
1135
|
attr_accessor :reset_billing_cycle_anchor
|
1336
1136
|
|
@@ -1344,7 +1144,6 @@ module Stripe
|
|
1344
1144
|
class Issuer < Stripe::RequestParams
|
1345
1145
|
# The connected account being referenced when `type` is `account`.
|
1346
1146
|
attr_accessor :account
|
1347
|
-
|
1348
1147
|
# Type of the account referenced in the request.
|
1349
1148
|
attr_accessor :type
|
1350
1149
|
|
@@ -1355,10 +1154,8 @@ module Stripe
|
|
1355
1154
|
end
|
1356
1155
|
# The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
|
1357
1156
|
attr_accessor :account_tax_ids
|
1358
|
-
|
1359
1157
|
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.
|
1360
1158
|
attr_accessor :days_until_due
|
1361
|
-
|
1362
1159
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
1363
1160
|
attr_accessor :issuer
|
1364
1161
|
|
@@ -1372,7 +1169,6 @@ module Stripe
|
|
1372
1169
|
class TransferData < Stripe::RequestParams
|
1373
1170
|
# 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.
|
1374
1171
|
attr_accessor :amount_percent
|
1375
|
-
|
1376
1172
|
# ID of an existing, connected Stripe account.
|
1377
1173
|
attr_accessor :destination
|
1378
1174
|
|
@@ -1383,31 +1179,22 @@ module Stripe
|
|
1383
1179
|
end
|
1384
1180
|
# 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).
|
1385
1181
|
attr_accessor :application_fee_percent
|
1386
|
-
|
1387
1182
|
# Default settings for automatic tax computation.
|
1388
1183
|
attr_accessor :automatic_tax
|
1389
|
-
|
1390
1184
|
# 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).
|
1391
1185
|
attr_accessor :billing_cycle_anchor
|
1392
|
-
|
1393
1186
|
# 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.
|
1394
1187
|
attr_accessor :billing_thresholds
|
1395
|
-
|
1396
1188
|
# 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.
|
1397
1189
|
attr_accessor :collection_method
|
1398
|
-
|
1399
1190
|
# 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.
|
1400
1191
|
attr_accessor :default_payment_method
|
1401
|
-
|
1402
1192
|
# 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.
|
1403
1193
|
attr_accessor :description
|
1404
|
-
|
1405
1194
|
# All invoices will be billed using the specified settings.
|
1406
1195
|
attr_accessor :invoice_settings
|
1407
|
-
|
1408
1196
|
# The account on behalf of which to charge, for each of the associated subscription's invoices.
|
1409
1197
|
attr_accessor :on_behalf_of
|
1410
|
-
|
1411
1198
|
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
1412
1199
|
attr_accessor :transfer_data
|
1413
1200
|
|
@@ -1443,7 +1230,6 @@ module Stripe
|
|
1443
1230
|
class Duration < Stripe::RequestParams
|
1444
1231
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1445
1232
|
attr_accessor :interval
|
1446
|
-
|
1447
1233
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1448
1234
|
attr_accessor :interval_count
|
1449
1235
|
|
@@ -1454,10 +1240,8 @@ module Stripe
|
|
1454
1240
|
end
|
1455
1241
|
# Time span for the redeemed discount.
|
1456
1242
|
attr_accessor :duration
|
1457
|
-
|
1458
1243
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1459
1244
|
attr_accessor :timestamp
|
1460
|
-
|
1461
1245
|
# The type of calculation made to determine when the discount ends.
|
1462
1246
|
attr_accessor :type
|
1463
1247
|
|
@@ -1469,13 +1253,10 @@ module Stripe
|
|
1469
1253
|
end
|
1470
1254
|
# ID of the coupon to create a new discount for.
|
1471
1255
|
attr_accessor :coupon
|
1472
|
-
|
1473
1256
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1474
1257
|
attr_accessor :discount
|
1475
|
-
|
1476
1258
|
# Details to determine how long the discount should be applied for.
|
1477
1259
|
attr_accessor :discount_end
|
1478
|
-
|
1479
1260
|
# ID of the promotion code to create a new discount for.
|
1480
1261
|
attr_accessor :promotion_code
|
1481
1262
|
|
@@ -1490,16 +1271,12 @@ module Stripe
|
|
1490
1271
|
class PriceData < Stripe::RequestParams
|
1491
1272
|
# 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).
|
1492
1273
|
attr_accessor :currency
|
1493
|
-
|
1494
1274
|
# The ID of the product that this price will belong to.
|
1495
1275
|
attr_accessor :product
|
1496
|
-
|
1497
1276
|
# 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.
|
1498
1277
|
attr_accessor :tax_behavior
|
1499
|
-
|
1500
1278
|
# 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.
|
1501
1279
|
attr_accessor :unit_amount
|
1502
|
-
|
1503
1280
|
# 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.
|
1504
1281
|
attr_accessor :unit_amount_decimal
|
1505
1282
|
|
@@ -1519,16 +1296,12 @@ module Stripe
|
|
1519
1296
|
end
|
1520
1297
|
# The coupons to redeem into discounts for the item.
|
1521
1298
|
attr_accessor :discounts
|
1522
|
-
|
1523
1299
|
# The ID of the price object. One of `price` or `price_data` is required.
|
1524
1300
|
attr_accessor :price
|
1525
|
-
|
1526
1301
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
1527
1302
|
attr_accessor :price_data
|
1528
|
-
|
1529
1303
|
# Quantity for this item. Defaults to 1.
|
1530
1304
|
attr_accessor :quantity
|
1531
|
-
|
1532
1305
|
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
|
1533
1306
|
attr_accessor :tax_rates
|
1534
1307
|
|
@@ -1545,7 +1318,6 @@ module Stripe
|
|
1545
1318
|
class Liability < Stripe::RequestParams
|
1546
1319
|
# The connected account being referenced when `type` is `account`.
|
1547
1320
|
attr_accessor :account
|
1548
|
-
|
1549
1321
|
# Type of the account referenced in the request.
|
1550
1322
|
attr_accessor :type
|
1551
1323
|
|
@@ -1556,7 +1328,6 @@ module Stripe
|
|
1556
1328
|
end
|
1557
1329
|
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
|
1558
1330
|
attr_accessor :enabled
|
1559
|
-
|
1560
1331
|
# 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.
|
1561
1332
|
attr_accessor :liability
|
1562
1333
|
|
@@ -1569,7 +1340,6 @@ module Stripe
|
|
1569
1340
|
class BillingThresholds < Stripe::RequestParams
|
1570
1341
|
# Monetary threshold that triggers the subscription to advance to a new billing period
|
1571
1342
|
attr_accessor :amount_gte
|
1572
|
-
|
1573
1343
|
# 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.
|
1574
1344
|
attr_accessor :reset_billing_cycle_anchor
|
1575
1345
|
|
@@ -1584,7 +1354,6 @@ module Stripe
|
|
1584
1354
|
class Duration < Stripe::RequestParams
|
1585
1355
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1586
1356
|
attr_accessor :interval
|
1587
|
-
|
1588
1357
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1589
1358
|
attr_accessor :interval_count
|
1590
1359
|
|
@@ -1595,10 +1364,8 @@ module Stripe
|
|
1595
1364
|
end
|
1596
1365
|
# Time span for the redeemed discount.
|
1597
1366
|
attr_accessor :duration
|
1598
|
-
|
1599
1367
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1600
1368
|
attr_accessor :timestamp
|
1601
|
-
|
1602
1369
|
# The type of calculation made to determine when the discount ends.
|
1603
1370
|
attr_accessor :type
|
1604
1371
|
|
@@ -1610,13 +1377,10 @@ module Stripe
|
|
1610
1377
|
end
|
1611
1378
|
# ID of the coupon to create a new discount for.
|
1612
1379
|
attr_accessor :coupon
|
1613
|
-
|
1614
1380
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1615
1381
|
attr_accessor :discount
|
1616
|
-
|
1617
1382
|
# Details to determine how long the discount should be applied for.
|
1618
1383
|
attr_accessor :discount_end
|
1619
|
-
|
1620
1384
|
# ID of the promotion code to create a new discount for.
|
1621
1385
|
attr_accessor :promotion_code
|
1622
1386
|
|
@@ -1632,7 +1396,6 @@ module Stripe
|
|
1632
1396
|
class Issuer < Stripe::RequestParams
|
1633
1397
|
# The connected account being referenced when `type` is `account`.
|
1634
1398
|
attr_accessor :account
|
1635
|
-
|
1636
1399
|
# Type of the account referenced in the request.
|
1637
1400
|
attr_accessor :type
|
1638
1401
|
|
@@ -1643,10 +1406,8 @@ module Stripe
|
|
1643
1406
|
end
|
1644
1407
|
# 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.
|
1645
1408
|
attr_accessor :account_tax_ids
|
1646
|
-
|
1647
1409
|
# 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`.
|
1648
1410
|
attr_accessor :days_until_due
|
1649
|
-
|
1650
1411
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
1651
1412
|
attr_accessor :issuer
|
1652
1413
|
|
@@ -1672,7 +1433,6 @@ module Stripe
|
|
1672
1433
|
class Duration < Stripe::RequestParams
|
1673
1434
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1674
1435
|
attr_accessor :interval
|
1675
|
-
|
1676
1436
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1677
1437
|
attr_accessor :interval_count
|
1678
1438
|
|
@@ -1683,10 +1443,8 @@ module Stripe
|
|
1683
1443
|
end
|
1684
1444
|
# Time span for the redeemed discount.
|
1685
1445
|
attr_accessor :duration
|
1686
|
-
|
1687
1446
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1688
1447
|
attr_accessor :timestamp
|
1689
|
-
|
1690
1448
|
# The type of calculation made to determine when the discount ends.
|
1691
1449
|
attr_accessor :type
|
1692
1450
|
|
@@ -1698,13 +1456,10 @@ module Stripe
|
|
1698
1456
|
end
|
1699
1457
|
# ID of the coupon to create a new discount for.
|
1700
1458
|
attr_accessor :coupon
|
1701
|
-
|
1702
1459
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1703
1460
|
attr_accessor :discount
|
1704
|
-
|
1705
1461
|
# Details to determine how long the discount should be applied for.
|
1706
1462
|
attr_accessor :discount_end
|
1707
|
-
|
1708
1463
|
# ID of the promotion code to create a new discount for.
|
1709
1464
|
attr_accessor :promotion_code
|
1710
1465
|
|
@@ -1720,7 +1475,6 @@ module Stripe
|
|
1720
1475
|
class Recurring < Stripe::RequestParams
|
1721
1476
|
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
1722
1477
|
attr_accessor :interval
|
1723
|
-
|
1724
1478
|
# 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).
|
1725
1479
|
attr_accessor :interval_count
|
1726
1480
|
|
@@ -1731,19 +1485,14 @@ module Stripe
|
|
1731
1485
|
end
|
1732
1486
|
# 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).
|
1733
1487
|
attr_accessor :currency
|
1734
|
-
|
1735
1488
|
# The ID of the product that this price will belong to.
|
1736
1489
|
attr_accessor :product
|
1737
|
-
|
1738
1490
|
# The recurring components of a price such as `interval` and `interval_count`.
|
1739
1491
|
attr_accessor :recurring
|
1740
|
-
|
1741
1492
|
# 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.
|
1742
1493
|
attr_accessor :tax_behavior
|
1743
|
-
|
1744
1494
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
1745
1495
|
attr_accessor :unit_amount
|
1746
|
-
|
1747
1496
|
# 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.
|
1748
1497
|
attr_accessor :unit_amount_decimal
|
1749
1498
|
|
@@ -1767,7 +1516,6 @@ module Stripe
|
|
1767
1516
|
class Trial < Stripe::RequestParams
|
1768
1517
|
# 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.
|
1769
1518
|
attr_accessor :converts_to
|
1770
|
-
|
1771
1519
|
# Determines the type of trial for this item.
|
1772
1520
|
attr_accessor :type
|
1773
1521
|
|
@@ -1778,28 +1526,20 @@ module Stripe
|
|
1778
1526
|
end
|
1779
1527
|
# 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.
|
1780
1528
|
attr_accessor :billing_thresholds
|
1781
|
-
|
1782
1529
|
# The coupons to redeem into discounts for the subscription item.
|
1783
1530
|
attr_accessor :discounts
|
1784
|
-
|
1785
1531
|
# 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`.
|
1786
1532
|
attr_accessor :metadata
|
1787
|
-
|
1788
1533
|
# The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
|
1789
1534
|
attr_accessor :plan
|
1790
|
-
|
1791
1535
|
# The ID of the price object.
|
1792
1536
|
attr_accessor :price
|
1793
|
-
|
1794
1537
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
|
1795
1538
|
attr_accessor :price_data
|
1796
|
-
|
1797
1539
|
# Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
|
1798
1540
|
attr_accessor :quantity
|
1799
|
-
|
1800
1541
|
# 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.
|
1801
1542
|
attr_accessor :tax_rates
|
1802
|
-
|
1803
1543
|
# Options that configure the trial on the subscription item.
|
1804
1544
|
attr_accessor :trial
|
1805
1545
|
|
@@ -1838,7 +1578,6 @@ module Stripe
|
|
1838
1578
|
class TransferData < Stripe::RequestParams
|
1839
1579
|
# 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.
|
1840
1580
|
attr_accessor :amount_percent
|
1841
|
-
|
1842
1581
|
# ID of an existing, connected Stripe account.
|
1843
1582
|
attr_accessor :destination
|
1844
1583
|
|
@@ -1866,79 +1605,54 @@ module Stripe
|
|
1866
1605
|
end
|
1867
1606
|
# 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.
|
1868
1607
|
attr_accessor :add_invoice_items
|
1869
|
-
|
1870
1608
|
# 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).
|
1871
1609
|
attr_accessor :application_fee_percent
|
1872
|
-
|
1873
1610
|
# Automatic tax settings for this phase.
|
1874
1611
|
attr_accessor :automatic_tax
|
1875
|
-
|
1876
1612
|
# 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).
|
1877
1613
|
attr_accessor :billing_cycle_anchor
|
1878
|
-
|
1879
1614
|
# 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.
|
1880
1615
|
attr_accessor :billing_thresholds
|
1881
|
-
|
1882
1616
|
# 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.
|
1883
1617
|
attr_accessor :collection_method
|
1884
|
-
|
1885
1618
|
# 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.
|
1886
1619
|
attr_accessor :coupon
|
1887
|
-
|
1888
1620
|
# 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).
|
1889
1621
|
attr_accessor :currency
|
1890
|
-
|
1891
1622
|
# 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.
|
1892
1623
|
attr_accessor :default_payment_method
|
1893
|
-
|
1894
1624
|
# 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.
|
1895
1625
|
attr_accessor :default_tax_rates
|
1896
|
-
|
1897
1626
|
# 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.
|
1898
1627
|
attr_accessor :description
|
1899
|
-
|
1900
1628
|
# 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.
|
1901
1629
|
attr_accessor :discounts
|
1902
|
-
|
1903
1630
|
# The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
|
1904
1631
|
attr_accessor :end_date
|
1905
|
-
|
1906
1632
|
# All invoices will be billed using the specified settings.
|
1907
1633
|
attr_accessor :invoice_settings
|
1908
|
-
|
1909
1634
|
# List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
|
1910
1635
|
attr_accessor :items
|
1911
|
-
|
1912
1636
|
# 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.
|
1913
1637
|
attr_accessor :iterations
|
1914
|
-
|
1915
1638
|
# 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`.
|
1916
1639
|
attr_accessor :metadata
|
1917
|
-
|
1918
1640
|
# The account on behalf of which to charge, for each of the associated subscription's invoices.
|
1919
1641
|
attr_accessor :on_behalf_of
|
1920
|
-
|
1921
1642
|
# 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).
|
1922
1643
|
attr_accessor :pause_collection
|
1923
|
-
|
1924
1644
|
# 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.
|
1925
1645
|
attr_accessor :proration_behavior
|
1926
|
-
|
1927
1646
|
# The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
|
1928
1647
|
attr_accessor :start_date
|
1929
|
-
|
1930
1648
|
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
1931
1649
|
attr_accessor :transfer_data
|
1932
|
-
|
1933
1650
|
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
1934
1651
|
attr_accessor :trial
|
1935
|
-
|
1936
1652
|
# Specify trial behavior when crossing phase boundaries
|
1937
1653
|
attr_accessor :trial_continuation
|
1938
|
-
|
1939
1654
|
# 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`
|
1940
1655
|
attr_accessor :trial_end
|
1941
|
-
|
1942
1656
|
# Settings related to subscription trials.
|
1943
1657
|
attr_accessor :trial_settings
|
1944
1658
|
|
@@ -2002,7 +1716,6 @@ module Stripe
|
|
2002
1716
|
class Prebilling < Stripe::RequestParams
|
2003
1717
|
# This is used to determine the number of billing cycles to prebill.
|
2004
1718
|
attr_accessor :iterations
|
2005
|
-
|
2006
1719
|
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
2007
1720
|
attr_accessor :update_behavior
|
2008
1721
|
|
@@ -2013,25 +1726,18 @@ module Stripe
|
|
2013
1726
|
end
|
2014
1727
|
# 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.
|
2015
1728
|
attr_accessor :billing_behavior
|
2016
|
-
|
2017
1729
|
# Object representing the subscription schedule's default settings.
|
2018
1730
|
attr_accessor :default_settings
|
2019
|
-
|
2020
1731
|
# 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.
|
2021
1732
|
attr_accessor :end_behavior
|
2022
|
-
|
2023
1733
|
# Specifies which fields in the response should be expanded.
|
2024
1734
|
attr_accessor :expand
|
2025
|
-
|
2026
1735
|
# 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`.
|
2027
1736
|
attr_accessor :metadata
|
2028
|
-
|
2029
1737
|
# 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. Note that past phases can be omitted.
|
2030
1738
|
attr_accessor :phases
|
2031
|
-
|
2032
1739
|
# If specified, the invoicing for the given billing cycle iterations will be processed now.
|
2033
1740
|
attr_accessor :prebilling
|
2034
|
-
|
2035
1741
|
# If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`.
|
2036
1742
|
attr_accessor :proration_behavior
|
2037
1743
|
|
@@ -2071,7 +1777,6 @@ module Stripe
|
|
2071
1777
|
class Duration < Stripe::RequestParams
|
2072
1778
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2073
1779
|
attr_accessor :interval
|
2074
|
-
|
2075
1780
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2076
1781
|
attr_accessor :interval_count
|
2077
1782
|
|
@@ -2082,13 +1787,10 @@ module Stripe
|
|
2082
1787
|
end
|
2083
1788
|
# Use the `end` time of a given discount.
|
2084
1789
|
attr_accessor :discount_end
|
2085
|
-
|
2086
1790
|
# Time span for the amendment starting from the `amendment_start`.
|
2087
1791
|
attr_accessor :duration
|
2088
|
-
|
2089
1792
|
# A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
|
2090
1793
|
attr_accessor :timestamp
|
2091
|
-
|
2092
1794
|
# Select one of three ways to pass the `amendment_end`.
|
2093
1795
|
attr_accessor :type
|
2094
1796
|
|
@@ -2120,13 +1822,10 @@ module Stripe
|
|
2120
1822
|
end
|
2121
1823
|
# Details of another amendment in the same array, immediately after which this amendment should begin.
|
2122
1824
|
attr_accessor :amendment_end
|
2123
|
-
|
2124
1825
|
# Use the `end` time of a given discount.
|
2125
1826
|
attr_accessor :discount_end
|
2126
|
-
|
2127
1827
|
# A precise Unix timestamp for the amendment to start.
|
2128
1828
|
attr_accessor :timestamp
|
2129
|
-
|
2130
1829
|
# Select one of three ways to pass the `amendment_start`.
|
2131
1830
|
attr_accessor :type
|
2132
1831
|
|
@@ -2150,16 +1849,12 @@ module Stripe
|
|
2150
1849
|
end
|
2151
1850
|
# The coupon code to redeem.
|
2152
1851
|
attr_accessor :coupon
|
2153
|
-
|
2154
1852
|
# An ID of an existing discount for a coupon that was already redeemed.
|
2155
1853
|
attr_accessor :discount
|
2156
|
-
|
2157
1854
|
# Details to determine how long the discount should be applied for.
|
2158
1855
|
attr_accessor :discount_end
|
2159
|
-
|
2160
1856
|
# 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.
|
2161
1857
|
attr_accessor :index
|
2162
|
-
|
2163
1858
|
# The promotion code to redeem.
|
2164
1859
|
attr_accessor :promotion_code
|
2165
1860
|
|
@@ -2181,10 +1876,8 @@ module Stripe
|
|
2181
1876
|
class Remove < Stripe::RequestParams
|
2182
1877
|
# The coupon code to remove from the `discounts` array.
|
2183
1878
|
attr_accessor :coupon
|
2184
|
-
|
2185
1879
|
# The ID of a discount to remove from the `discounts` array.
|
2186
1880
|
attr_accessor :discount
|
2187
|
-
|
2188
1881
|
# The ID of a promotion code to remove from the `discounts` array.
|
2189
1882
|
attr_accessor :promotion_code
|
2190
1883
|
|
@@ -2198,10 +1891,8 @@ module Stripe
|
|
2198
1891
|
class Set < Stripe::RequestParams
|
2199
1892
|
# The coupon code to replace the `discounts` array with.
|
2200
1893
|
attr_accessor :coupon
|
2201
|
-
|
2202
1894
|
# An ID of an existing discount to replace the `discounts` array with.
|
2203
1895
|
attr_accessor :discount
|
2204
|
-
|
2205
1896
|
# An ID of an existing promotion code to replace the `discounts` array with.
|
2206
1897
|
attr_accessor :promotion_code
|
2207
1898
|
|
@@ -2213,13 +1904,10 @@ module Stripe
|
|
2213
1904
|
end
|
2214
1905
|
# Details of the discount to add.
|
2215
1906
|
attr_accessor :add
|
2216
|
-
|
2217
1907
|
# Details of the discount to remove.
|
2218
1908
|
attr_accessor :remove
|
2219
|
-
|
2220
1909
|
# Details of the discount to replace the existing discounts with.
|
2221
1910
|
attr_accessor :set
|
2222
|
-
|
2223
1911
|
# Determines the type of discount action.
|
2224
1912
|
attr_accessor :type
|
2225
1913
|
|
@@ -2238,7 +1926,6 @@ module Stripe
|
|
2238
1926
|
class Duration < Stripe::RequestParams
|
2239
1927
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2240
1928
|
attr_accessor :interval
|
2241
|
-
|
2242
1929
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2243
1930
|
attr_accessor :interval_count
|
2244
1931
|
|
@@ -2249,10 +1936,8 @@ module Stripe
|
|
2249
1936
|
end
|
2250
1937
|
# Time span for the redeemed discount.
|
2251
1938
|
attr_accessor :duration
|
2252
|
-
|
2253
1939
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
2254
1940
|
attr_accessor :timestamp
|
2255
|
-
|
2256
1941
|
# The type of calculation made to determine when the discount ends.
|
2257
1942
|
attr_accessor :type
|
2258
1943
|
|
@@ -2264,13 +1949,10 @@ module Stripe
|
|
2264
1949
|
end
|
2265
1950
|
# ID of the coupon to create a new discount for.
|
2266
1951
|
attr_accessor :coupon
|
2267
|
-
|
2268
1952
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
2269
1953
|
attr_accessor :discount
|
2270
|
-
|
2271
1954
|
# Details to determine how long the discount should be applied for.
|
2272
1955
|
attr_accessor :discount_end
|
2273
|
-
|
2274
1956
|
# ID of the promotion code to create a new discount for.
|
2275
1957
|
attr_accessor :promotion_code
|
2276
1958
|
|
@@ -2285,7 +1967,6 @@ module Stripe
|
|
2285
1967
|
class Trial < Stripe::RequestParams
|
2286
1968
|
# 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.
|
2287
1969
|
attr_accessor :converts_to
|
2288
|
-
|
2289
1970
|
# Determines the type of trial for this item.
|
2290
1971
|
attr_accessor :type
|
2291
1972
|
|
@@ -2296,19 +1977,14 @@ module Stripe
|
|
2296
1977
|
end
|
2297
1978
|
# The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
2298
1979
|
attr_accessor :discounts
|
2299
|
-
|
2300
1980
|
# 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`.
|
2301
1981
|
attr_accessor :metadata
|
2302
|
-
|
2303
1982
|
# The ID of the price object.
|
2304
1983
|
attr_accessor :price
|
2305
|
-
|
2306
1984
|
# Quantity for this item.
|
2307
1985
|
attr_accessor :quantity
|
2308
|
-
|
2309
1986
|
# 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`.
|
2310
1987
|
attr_accessor :tax_rates
|
2311
|
-
|
2312
1988
|
# Options that configure the trial on the subscription item.
|
2313
1989
|
attr_accessor :trial
|
2314
1990
|
|
@@ -2344,7 +2020,6 @@ module Stripe
|
|
2344
2020
|
class Duration < Stripe::RequestParams
|
2345
2021
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2346
2022
|
attr_accessor :interval
|
2347
|
-
|
2348
2023
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2349
2024
|
attr_accessor :interval_count
|
2350
2025
|
|
@@ -2355,10 +2030,8 @@ module Stripe
|
|
2355
2030
|
end
|
2356
2031
|
# Time span for the redeemed discount.
|
2357
2032
|
attr_accessor :duration
|
2358
|
-
|
2359
2033
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
2360
2034
|
attr_accessor :timestamp
|
2361
|
-
|
2362
2035
|
# The type of calculation made to determine when the discount ends.
|
2363
2036
|
attr_accessor :type
|
2364
2037
|
|
@@ -2370,13 +2043,10 @@ module Stripe
|
|
2370
2043
|
end
|
2371
2044
|
# ID of the coupon to create a new discount for.
|
2372
2045
|
attr_accessor :coupon
|
2373
|
-
|
2374
2046
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
2375
2047
|
attr_accessor :discount
|
2376
|
-
|
2377
2048
|
# Details to determine how long the discount should be applied for.
|
2378
2049
|
attr_accessor :discount_end
|
2379
|
-
|
2380
2050
|
# ID of the promotion code to create a new discount for.
|
2381
2051
|
attr_accessor :promotion_code
|
2382
2052
|
|
@@ -2391,7 +2061,6 @@ module Stripe
|
|
2391
2061
|
class Trial < Stripe::RequestParams
|
2392
2062
|
# 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.
|
2393
2063
|
attr_accessor :converts_to
|
2394
|
-
|
2395
2064
|
# Determines the type of trial for this item.
|
2396
2065
|
attr_accessor :type
|
2397
2066
|
|
@@ -2402,19 +2071,14 @@ module Stripe
|
|
2402
2071
|
end
|
2403
2072
|
# 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`.
|
2404
2073
|
attr_accessor :discounts
|
2405
|
-
|
2406
2074
|
# 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`.
|
2407
2075
|
attr_accessor :metadata
|
2408
|
-
|
2409
2076
|
# The ID of the price object.
|
2410
2077
|
attr_accessor :price
|
2411
|
-
|
2412
2078
|
# 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`.
|
2413
2079
|
attr_accessor :quantity
|
2414
|
-
|
2415
2080
|
# 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`.
|
2416
2081
|
attr_accessor :tax_rates
|
2417
|
-
|
2418
2082
|
# 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`.
|
2419
2083
|
attr_accessor :trial
|
2420
2084
|
|
@@ -2436,13 +2100,10 @@ module Stripe
|
|
2436
2100
|
end
|
2437
2101
|
# 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.
|
2438
2102
|
attr_accessor :add
|
2439
|
-
|
2440
2103
|
# Details of the subscription item to remove.
|
2441
2104
|
attr_accessor :remove
|
2442
|
-
|
2443
2105
|
# 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.
|
2444
2106
|
attr_accessor :set
|
2445
|
-
|
2446
2107
|
# Determines the type of item action.
|
2447
2108
|
attr_accessor :type
|
2448
2109
|
|
@@ -2457,13 +2118,10 @@ module Stripe
|
|
2457
2118
|
class MetadataAction < Stripe::RequestParams
|
2458
2119
|
# Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
|
2459
2120
|
attr_accessor :add
|
2460
|
-
|
2461
2121
|
# Keys to remove from schedule phase metadata.
|
2462
2122
|
attr_accessor :remove
|
2463
|
-
|
2464
2123
|
# Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
|
2465
2124
|
attr_accessor :set
|
2466
|
-
|
2467
2125
|
# Select one of three ways to update phase-level `metadata` on subscription schedules.
|
2468
2126
|
attr_accessor :type
|
2469
2127
|
|
@@ -2486,7 +2144,6 @@ module Stripe
|
|
2486
2144
|
end
|
2487
2145
|
# Details of the pause_collection behavior to apply to the amendment.
|
2488
2146
|
attr_accessor :set
|
2489
|
-
|
2490
2147
|
# Determines the type of the pause_collection amendment.
|
2491
2148
|
attr_accessor :type
|
2492
2149
|
|
@@ -2514,31 +2171,22 @@ module Stripe
|
|
2514
2171
|
end
|
2515
2172
|
# 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.
|
2516
2173
|
attr_accessor :amendment_end
|
2517
|
-
|
2518
2174
|
# Details to identify the earliest timestamp where the proposed change should take effect.
|
2519
2175
|
attr_accessor :amendment_start
|
2520
|
-
|
2521
2176
|
# 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.
|
2522
2177
|
attr_accessor :billing_cycle_anchor
|
2523
|
-
|
2524
2178
|
# Changes to the coupons being redeemed or discounts being applied during the amendment time span.
|
2525
2179
|
attr_accessor :discount_actions
|
2526
|
-
|
2527
2180
|
# Changes to the subscription items during the amendment time span.
|
2528
2181
|
attr_accessor :item_actions
|
2529
|
-
|
2530
2182
|
# Instructions for how to modify phase metadata
|
2531
2183
|
attr_accessor :metadata_actions
|
2532
|
-
|
2533
2184
|
# 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`.
|
2534
2185
|
attr_accessor :proration_behavior
|
2535
|
-
|
2536
2186
|
# Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
2537
2187
|
attr_accessor :set_pause_collection
|
2538
|
-
|
2539
2188
|
# Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
|
2540
2189
|
attr_accessor :set_schedule_end
|
2541
|
-
|
2542
2190
|
# Settings related to subscription trials.
|
2543
2191
|
attr_accessor :trial_settings
|
2544
2192
|
|
@@ -2579,10 +2227,8 @@ module Stripe
|
|
2579
2227
|
end
|
2580
2228
|
# Start the prebilled period when a specified amendment begins.
|
2581
2229
|
attr_accessor :amendment_start
|
2582
|
-
|
2583
2230
|
# Start the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
2584
2231
|
attr_accessor :timestamp
|
2585
|
-
|
2586
2232
|
# Select one of several ways to pass the `bill_from` value.
|
2587
2233
|
attr_accessor :type
|
2588
2234
|
|
@@ -2606,7 +2252,6 @@ module Stripe
|
|
2606
2252
|
class Duration < Stripe::RequestParams
|
2607
2253
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2608
2254
|
attr_accessor :interval
|
2609
|
-
|
2610
2255
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2611
2256
|
attr_accessor :interval_count
|
2612
2257
|
|
@@ -2617,13 +2262,10 @@ module Stripe
|
|
2617
2262
|
end
|
2618
2263
|
# End the prebilled period when a specified amendment ends.
|
2619
2264
|
attr_accessor :amendment_end
|
2620
|
-
|
2621
2265
|
# Time span for prebilling, starting from `bill_from`.
|
2622
2266
|
attr_accessor :duration
|
2623
|
-
|
2624
2267
|
# End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
2625
2268
|
attr_accessor :timestamp
|
2626
|
-
|
2627
2269
|
# Select one of several ways to pass the `bill_until` value.
|
2628
2270
|
attr_accessor :type
|
2629
2271
|
|
@@ -2636,13 +2278,10 @@ module Stripe
|
|
2636
2278
|
end
|
2637
2279
|
# The beginning of the prebilled time period. The default value is `now`.
|
2638
2280
|
attr_accessor :bill_from
|
2639
|
-
|
2640
2281
|
# The end of the prebilled time period.
|
2641
2282
|
attr_accessor :bill_until
|
2642
|
-
|
2643
2283
|
# When the prebilling invoice should be created. The default value is `now`.
|
2644
2284
|
attr_accessor :invoice_at
|
2645
|
-
|
2646
2285
|
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
2647
2286
|
attr_accessor :update_behavior
|
2648
2287
|
|
@@ -2664,17 +2303,13 @@ module Stripe
|
|
2664
2303
|
end
|
2665
2304
|
# Changes to apply to the phases of the subscription schedule, in the order provided.
|
2666
2305
|
attr_accessor :amendments
|
2667
|
-
|
2668
2306
|
# Specifies which fields in the response should be expanded.
|
2669
2307
|
attr_accessor :expand
|
2670
|
-
|
2671
2308
|
# Provide any time periods to bill in advance.
|
2672
2309
|
attr_accessor :prebilling
|
2673
|
-
|
2674
2310
|
# In cases where the amendment changes the currently active phase,
|
2675
2311
|
# specifies if and how to prorate at the time of the request.
|
2676
2312
|
attr_accessor :proration_behavior
|
2677
|
-
|
2678
2313
|
# Changes to apply to the subscription schedule.
|
2679
2314
|
attr_accessor :schedule_settings
|
2680
2315
|
|
@@ -2696,10 +2331,8 @@ module Stripe
|
|
2696
2331
|
class CancelParams < Stripe::RequestParams
|
2697
2332
|
# Specifies which fields in the response should be expanded.
|
2698
2333
|
attr_accessor :expand
|
2699
|
-
|
2700
2334
|
# If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`.
|
2701
2335
|
attr_accessor :invoice_now
|
2702
|
-
|
2703
2336
|
# If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`.
|
2704
2337
|
attr_accessor :prorate
|
2705
2338
|
|
@@ -2713,7 +2346,6 @@ module Stripe
|
|
2713
2346
|
class ReleaseParams < Stripe::RequestParams
|
2714
2347
|
# Specifies which fields in the response should be expanded.
|
2715
2348
|
attr_accessor :expand
|
2716
|
-
|
2717
2349
|
# Keep any cancellation on the subscription that the schedule has set
|
2718
2350
|
attr_accessor :preserve_cancel_date
|
2719
2351
|
|
@@ -2724,64 +2356,44 @@ module Stripe
|
|
2724
2356
|
end
|
2725
2357
|
# ID of the Connect Application that created the schedule.
|
2726
2358
|
attr_reader :application
|
2727
|
-
|
2728
2359
|
# 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.
|
2729
2360
|
attr_reader :billing_behavior
|
2730
|
-
|
2731
2361
|
# Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
|
2732
2362
|
attr_reader :canceled_at
|
2733
|
-
|
2734
2363
|
# Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
|
2735
2364
|
attr_reader :completed_at
|
2736
|
-
|
2737
2365
|
# Time at which the object was created. Measured in seconds since the Unix epoch.
|
2738
2366
|
attr_reader :created
|
2739
|
-
|
2740
2367
|
# Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.
|
2741
2368
|
attr_reader :current_phase
|
2742
|
-
|
2743
2369
|
# ID of the customer who owns the subscription schedule.
|
2744
2370
|
attr_reader :customer
|
2745
|
-
|
2746
2371
|
# Attribute for field default_settings
|
2747
2372
|
attr_reader :default_settings
|
2748
|
-
|
2749
2373
|
# 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.
|
2750
2374
|
attr_reader :end_behavior
|
2751
|
-
|
2752
2375
|
# Unique identifier for the object.
|
2753
2376
|
attr_reader :id
|
2754
|
-
|
2755
2377
|
# Details of the most recent price migration that failed for the subscription schedule.
|
2756
2378
|
attr_reader :last_price_migration_error
|
2757
|
-
|
2758
2379
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
2759
2380
|
attr_reader :livemode
|
2760
|
-
|
2761
2381
|
# 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.
|
2762
2382
|
attr_reader :metadata
|
2763
|
-
|
2764
2383
|
# String representing the object's type. Objects of the same type share the same value.
|
2765
2384
|
attr_reader :object
|
2766
|
-
|
2767
2385
|
# Configuration for the subscription schedule's phases.
|
2768
2386
|
attr_reader :phases
|
2769
|
-
|
2770
2387
|
# Time period and invoice for a Subscription billed in advance.
|
2771
2388
|
attr_reader :prebilling
|
2772
|
-
|
2773
2389
|
# Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
|
2774
2390
|
attr_reader :released_at
|
2775
|
-
|
2776
2391
|
# ID of the subscription once managed by the subscription schedule (if it is released).
|
2777
2392
|
attr_reader :released_subscription
|
2778
|
-
|
2779
2393
|
# The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules).
|
2780
2394
|
attr_reader :status
|
2781
|
-
|
2782
2395
|
# ID of the subscription managed by the subscription schedule.
|
2783
2396
|
attr_reader :subscription
|
2784
|
-
|
2785
2397
|
# ID of the test clock this subscription schedule belongs to.
|
2786
2398
|
attr_reader :test_clock
|
2787
2399
|
|