stripe 15.2.0.pre.beta.1 → 15.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +718 -1556
- data/CONTRIBUTING.md +25 -0
- data/OPENAPI_VERSION +1 -1
- data/README.md +10 -7
- data/VERSION +1 -1
- data/lib/stripe/api_requestor.rb +0 -28
- data/lib/stripe/api_version.rb +1 -1
- data/lib/stripe/errors.rb +0 -54
- data/lib/stripe/event_types.rb +0 -89
- data/lib/stripe/object_types.rb +0 -52
- data/lib/stripe/resources/account.rb +32 -657
- data/lib/stripe/resources/account_session.rb +59 -253
- data/lib/stripe/resources/apple_pay_domain.rb +1 -2
- data/lib/stripe/resources/balance.rb +42 -0
- data/lib/stripe/resources/balance_transaction.rb +2 -0
- data/lib/stripe/resources/bank_account.rb +2 -2
- data/lib/stripe/resources/billing/credit_balance_summary.rb +0 -2
- data/lib/stripe/resources/billing/credit_balance_transaction.rb +0 -4
- data/lib/stripe/resources/billing/credit_grant.rb +0 -10
- data/lib/stripe/resources/billing_portal/session.rb +1 -7
- data/lib/stripe/resources/capability.rb +1 -1
- data/lib/stripe/resources/card.rb +0 -2
- data/lib/stripe/resources/cash_balance.rb +0 -2
- data/lib/stripe/resources/charge.rb +13 -1475
- data/lib/stripe/resources/checkout/session.rb +21 -333
- data/lib/stripe/resources/confirmation_token.rb +33 -263
- data/lib/stripe/resources/country_spec.rb +1 -1
- data/lib/stripe/resources/coupon.rb +2 -32
- data/lib/stripe/resources/credit_note.rb +10 -17
- data/lib/stripe/resources/credit_note_line_item.rb +0 -9
- data/lib/stripe/resources/customer.rb +2 -6
- data/lib/stripe/resources/customer_balance_transaction.rb +0 -2
- data/lib/stripe/resources/customer_cash_balance_transaction.rb +0 -2
- data/lib/stripe/resources/customer_session.rb +4 -9
- data/lib/stripe/resources/discount.rb +0 -2
- data/lib/stripe/resources/dispute.rb +2 -2
- data/lib/stripe/resources/event.rb +1 -32
- data/lib/stripe/resources/file.rb +1 -1
- data/lib/stripe/resources/financial_connections/account.rb +1 -20
- data/lib/stripe/resources/financial_connections/session.rb +2 -62
- data/lib/stripe/resources/identity/verification_report.rb +6 -0
- data/lib/stripe/resources/identity/verification_session.rb +17 -21
- data/lib/stripe/resources/invoice.rb +79 -1106
- data/lib/stripe/resources/invoice_item.rb +4 -81
- data/lib/stripe/resources/invoice_line_item.rb +2 -56
- data/lib/stripe/resources/invoice_payment.rb +62 -4
- data/lib/stripe/resources/issuing/authorization.rb +8 -8
- data/lib/stripe/resources/issuing/card.rb +1 -1
- data/lib/stripe/resources/issuing/cardholder.rb +1 -2
- data/lib/stripe/resources/issuing/dispute.rb +3 -3
- data/lib/stripe/resources/issuing/transaction.rb +0 -6
- data/lib/stripe/resources/line_item.rb +0 -37
- data/lib/stripe/resources/mandate.rb +0 -24
- data/lib/stripe/resources/payment_intent.rb +1912 -6840
- data/lib/stripe/resources/payment_method.rb +47 -301
- data/lib/stripe/resources/payment_method_configuration.rb +112 -112
- data/lib/stripe/resources/payment_method_domain.rb +2 -2
- data/lib/stripe/resources/payout.rb +4 -10
- data/lib/stripe/resources/person.rb +2 -2
- data/lib/stripe/resources/plan.rb +2 -3
- data/lib/stripe/resources/price.rb +1 -31
- data/lib/stripe/resources/product.rb +1 -61
- data/lib/stripe/resources/promotion_code.rb +0 -10
- data/lib/stripe/resources/quote.rb +6 -2046
- data/lib/stripe/resources/radar/value_list.rb +1 -2
- data/lib/stripe/resources/radar/value_list_item.rb +1 -2
- data/lib/stripe/resources/refund.rb +6 -10
- data/lib/stripe/resources/reversal.rb +1 -1
- data/lib/stripe/resources/review.rb +1 -1
- data/lib/stripe/resources/setup_attempt.rb +0 -21
- data/lib/stripe/resources/setup_intent.rb +120 -877
- data/lib/stripe/resources/source.rb +1 -30
- data/lib/stripe/resources/subscription.rb +97 -326
- data/lib/stripe/resources/subscription_item.rb +32 -80
- data/lib/stripe/resources/subscription_schedule.rb +127 -1015
- data/lib/stripe/resources/tax/calculation.rb +4 -0
- data/lib/stripe/resources/tax/calculation_line_item.rb +2 -0
- data/lib/stripe/resources/tax/registration.rb +1 -1
- data/lib/stripe/resources/tax_id.rb +3 -14
- data/lib/stripe/resources/tax_rate.rb +2 -2
- data/lib/stripe/resources/terminal/configuration.rb +1 -2
- data/lib/stripe/resources/terminal/location.rb +2 -3
- data/lib/stripe/resources/terminal/reader.rb +8 -142
- data/lib/stripe/resources/test_helpers/test_clock.rb +1 -2
- data/lib/stripe/resources/token.rb +2 -2
- data/lib/stripe/resources/transfer.rb +1 -7
- data/lib/stripe/resources/treasury/financial_account.rb +3 -22
- data/lib/stripe/resources/treasury/financial_account_features.rb +0 -2
- data/lib/stripe/resources/treasury/outbound_transfer.rb +0 -37
- data/lib/stripe/resources/treasury/received_credit.rb +1 -38
- data/lib/stripe/resources/treasury/received_debit.rb +1 -40
- data/lib/stripe/resources/webhook_endpoint.rb +1 -2
- data/lib/stripe/resources.rb +0 -99
- data/lib/stripe/services/account_external_account_service.rb +2 -3
- data/lib/stripe/services/account_login_link_service.rb +1 -1
- data/lib/stripe/services/account_person_service.rb +1 -2
- data/lib/stripe/services/account_service.rb +23 -559
- data/lib/stripe/services/account_session_service.rb +29 -229
- data/lib/stripe/services/apple_pay_domain_service.rb +1 -2
- data/lib/stripe/services/balance_service.rb +1 -1
- data/lib/stripe/services/billing/credit_balance_summary_service.rb +1 -4
- data/lib/stripe/services/billing/credit_balance_transaction_service.rb +0 -4
- data/lib/stripe/services/billing/credit_grant_service.rb +0 -8
- data/lib/stripe/services/billing_portal/session_service.rb +0 -4
- data/lib/stripe/services/charge_service.rb +4 -1354
- data/lib/stripe/services/checkout/session_service.rb +13 -250
- data/lib/stripe/services/coupon_service.rb +2 -19
- data/lib/stripe/services/credit_note_service.rb +7 -12
- data/lib/stripe/services/customer_balance_transaction_service.rb +3 -3
- data/lib/stripe/services/customer_cash_balance_transaction_service.rb +2 -2
- data/lib/stripe/services/customer_payment_source_service.rb +1 -1
- data/lib/stripe/services/customer_service.rb +3 -5
- data/lib/stripe/services/customer_session_service.rb +1 -4
- data/lib/stripe/services/customer_tax_id_service.rb +1 -2
- data/lib/stripe/services/dispute_service.rb +1 -1
- data/lib/stripe/services/file_service.rb +1 -1
- data/lib/stripe/services/financial_connections/account_service.rb +2 -7
- data/lib/stripe/services/financial_connections/session_service.rb +2 -34
- data/lib/stripe/services/financial_connections_service.rb +1 -2
- data/lib/stripe/services/identity/verification_session_service.rb +5 -13
- data/lib/stripe/services/invoice_item_service.rb +3 -76
- data/lib/stripe/services/invoice_line_item_service.rb +1 -33
- data/lib/stripe/services/invoice_payment_service.rb +83 -0
- data/lib/stripe/services/invoice_service.rb +74 -1049
- data/lib/stripe/services/issuing/authorization_service.rb +4 -4
- data/lib/stripe/services/issuing/card_service.rb +1 -1
- data/lib/stripe/services/issuing/cardholder_service.rb +1 -2
- data/lib/stripe/services/issuing/dispute_service.rb +2 -2
- data/lib/stripe/services/issuing/transaction_service.rb +0 -4
- data/lib/stripe/services/issuing_service.rb +1 -5
- data/lib/stripe/services/payment_intent_service.rb +439 -4928
- data/lib/stripe/services/payment_method_configuration_service.rb +82 -82
- data/lib/stripe/services/payment_method_domain_service.rb +1 -1
- data/lib/stripe/services/payment_method_service.rb +44 -226
- data/lib/stripe/services/payout_service.rb +2 -6
- data/lib/stripe/services/plan_service.rb +2 -3
- data/lib/stripe/services/price_service.rb +2 -21
- data/lib/stripe/services/product_feature_service.rb +1 -2
- data/lib/stripe/services/product_service.rb +2 -41
- data/lib/stripe/services/promotion_code_service.rb +1 -9
- data/lib/stripe/services/quote_service.rb +7 -1730
- data/lib/stripe/services/radar/early_fraud_warning_service.rb +1 -1
- data/lib/stripe/services/radar/value_list_item_service.rb +1 -2
- data/lib/stripe/services/radar/value_list_service.rb +1 -2
- data/lib/stripe/services/setup_intent_service.rb +119 -836
- data/lib/stripe/services/source_service.rb +1 -1
- data/lib/stripe/services/subscription_item_service.rb +27 -73
- data/lib/stripe/services/subscription_schedule_service.rb +101 -916
- data/lib/stripe/services/subscription_service.rb +85 -282
- data/lib/stripe/services/tax/calculation_service.rb +4 -0
- data/lib/stripe/services/tax/registration_service.rb +1 -1
- data/lib/stripe/services/tax_id_service.rb +3 -10
- data/lib/stripe/services/tax_service.rb +1 -3
- data/lib/stripe/services/terminal/configuration_service.rb +1 -2
- data/lib/stripe/services/terminal/location_service.rb +2 -3
- data/lib/stripe/services/terminal/reader_service.rb +5 -81
- data/lib/stripe/services/terminal_service.rb +1 -2
- data/lib/stripe/services/test_helpers/confirmation_token_service.rb +33 -190
- data/lib/stripe/services/test_helpers/test_clock_service.rb +1 -2
- data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +1 -25
- data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +1 -25
- data/lib/stripe/services/token_service.rb +1 -1
- data/lib/stripe/services/transfer_service.rb +1 -5
- data/lib/stripe/services/treasury/financial_account_features_service.rb +1 -4
- data/lib/stripe/services/treasury/financial_account_service.rb +2 -16
- data/lib/stripe/services/treasury/outbound_transfer_service.rb +0 -24
- data/lib/stripe/services/v1_services.rb +2 -12
- data/lib/stripe/services/v2/billing/meter_event_session_service.rb +1 -2
- data/lib/stripe/services/v2/core/event_destination_service.rb +4 -10
- data/lib/stripe/services/v2/core/event_service.rb +1 -2
- data/lib/stripe/services/v2/core_service.rb +1 -4
- data/lib/stripe/services/v2_services.rb +2 -4
- data/lib/stripe/services/webhook_endpoint_service.rb +1 -2
- data/lib/stripe/services.rb +1 -54
- data/lib/stripe/stripe_configuration.rb +1 -3
- data/lib/stripe/stripe_object.rb +1 -1
- data/lib/stripe/util.rb +1 -7
- data/lib/stripe/version.rb +1 -1
- data/lib/stripe.rb +0 -53
- data/rbi/stripe/resources/account.rbi +4926 -0
- data/rbi/stripe/resources/account_link.rbi +74 -0
- data/rbi/stripe/resources/account_session.rbi +1013 -0
- data/rbi/stripe/resources/apple_pay_domain.rbi +88 -0
- data/rbi/stripe/resources/application.rbi +20 -0
- data/rbi/stripe/resources/application_fee.rbi +118 -0
- data/rbi/stripe/resources/application_fee_refund.rbi +37 -0
- data/rbi/stripe/resources/apps/secret.rbi +195 -0
- data/rbi/stripe/resources/balance.rbi +235 -0
- data/rbi/stripe/resources/balance_transaction.rbi +147 -0
- data/rbi/stripe/resources/bank_account.rbi +127 -0
- data/rbi/stripe/resources/billing/alert.rbi +201 -0
- data/rbi/stripe/resources/billing/alert_triggered.rbi +28 -0
- data/rbi/stripe/resources/billing/credit_balance_summary.rbi +63 -0
- data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +147 -0
- data/rbi/stripe/resources/billing/credit_grant.rbi +291 -0
- data/rbi/stripe/resources/billing/meter.rbi +226 -0
- data/rbi/stripe/resources/billing/meter_event.rbi +64 -0
- data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +64 -0
- data/rbi/stripe/resources/billing/meter_event_summary.rbi +35 -0
- data/rbi/stripe/resources/billing_portal/configuration.rbi +645 -0
- data/rbi/stripe/resources/billing_portal/session.rbi +345 -0
- data/rbi/stripe/resources/capability.rbi +125 -0
- data/rbi/stripe/resources/card.rbi +125 -0
- data/rbi/stripe/resources/cash_balance.rbi +32 -0
- data/rbi/stripe/resources/charge.rbi +2069 -0
- data/rbi/stripe/resources/checkout/session.rbi +4004 -0
- data/rbi/stripe/resources/climate/order.rbi +245 -0
- data/rbi/stripe/resources/climate/product.rbi +75 -0
- data/rbi/stripe/resources/climate/supplier.rbi +72 -0
- data/rbi/stripe/resources/confirmation_token.rbi +1807 -0
- data/rbi/stripe/resources/connect_collection_transfer.rbi +26 -0
- data/rbi/stripe/resources/country_spec.rbi +85 -0
- data/rbi/stripe/resources/coupon.rbi +250 -0
- data/rbi/stripe/resources/credit_note.rbi +752 -0
- data/rbi/stripe/resources/credit_note_line_item.rbi +101 -0
- data/rbi/stripe/resources/customer.rbi +1005 -0
- data/rbi/stripe/resources/customer_balance_transaction.rbi +56 -0
- data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +151 -0
- data/rbi/stripe/resources/customer_session.rbi +200 -0
- data/rbi/stripe/resources/discount.rbi +53 -0
- data/rbi/stripe/resources/dispute.rbi +761 -0
- data/rbi/stripe/resources/entitlements/active_entitlement.rbi +58 -0
- data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +23 -0
- data/rbi/stripe/resources/entitlements/feature.rbi +117 -0
- data/rbi/stripe/resources/ephemeral_key.rbi +44 -0
- data/rbi/stripe/resources/event.rbi +149 -0
- data/rbi/stripe/resources/exchange_rate.rbi +66 -0
- data/rbi/stripe/resources/file.rbi +143 -0
- data/rbi/stripe/resources/file_link.rbi +141 -0
- data/rbi/stripe/resources/financial_connections/account.rbi +339 -0
- data/rbi/stripe/resources/financial_connections/account_owner.rbi +35 -0
- data/rbi/stripe/resources/financial_connections/account_ownership.rbi +23 -0
- data/rbi/stripe/resources/financial_connections/session.rbi +123 -0
- data/rbi/stripe/resources/financial_connections/transaction.rbi +124 -0
- data/rbi/stripe/resources/forwarding/request.rbi +216 -0
- data/rbi/stripe/resources/funding_instructions.rbi +437 -0
- data/rbi/stripe/resources/identity/verification_report.rbi +360 -0
- data/rbi/stripe/resources/identity/verification_session.rbi +526 -0
- data/rbi/stripe/resources/invoice.rbi +3812 -0
- data/rbi/stripe/resources/invoice_item.rbi +473 -0
- data/rbi/stripe/resources/invoice_line_item.rbi +432 -0
- data/rbi/stripe/resources/invoice_payment.rbi +121 -0
- data/rbi/stripe/resources/invoice_rendering_template.rbi +104 -0
- data/rbi/stripe/resources/issuing/authorization.rbi +1283 -0
- data/rbi/stripe/resources/issuing/card.rbi +741 -0
- data/rbi/stripe/resources/issuing/cardholder.rbi +744 -0
- data/rbi/stripe/resources/issuing/dispute.rbi +913 -0
- data/rbi/stripe/resources/issuing/personalization_design.rbi +338 -0
- data/rbi/stripe/resources/issuing/physical_bundle.rbi +79 -0
- data/rbi/stripe/resources/issuing/token.rbi +226 -0
- data/rbi/stripe/resources/issuing/transaction.rbi +1061 -0
- data/rbi/stripe/resources/line_item.rbi +72 -0
- data/rbi/stripe/resources/login_link.rbi +19 -0
- data/rbi/stripe/resources/mandate.rbi +187 -0
- data/rbi/stripe/resources/payment_intent.rbi +9647 -0
- data/rbi/stripe/resources/payment_link.rbi +1801 -0
- data/rbi/stripe/resources/payment_method.rbi +1761 -0
- data/rbi/stripe/resources/payment_method_configuration.rbi +3550 -0
- data/rbi/stripe/resources/payment_method_domain.rbi +228 -0
- data/rbi/stripe/resources/payout.rbi +300 -0
- data/rbi/stripe/resources/person.rbi +401 -0
- data/rbi/stripe/resources/plan.rbi +371 -0
- data/rbi/stripe/resources/price.rbi +694 -0
- data/rbi/stripe/resources/product.rbi +555 -0
- data/rbi/stripe/resources/product_feature.rbi +26 -0
- data/rbi/stripe/resources/promotion_code.rbi +261 -0
- data/rbi/stripe/resources/quote.rbi +1126 -0
- data/rbi/stripe/resources/radar/early_fraud_warning.rbi +98 -0
- data/rbi/stripe/resources/radar/value_list.rbi +168 -0
- data/rbi/stripe/resources/radar/value_list_item.rbi +129 -0
- data/rbi/stripe/resources/refund.rbi +523 -0
- data/rbi/stripe/resources/reporting/report_run.rbi +191 -0
- data/rbi/stripe/resources/reporting/report_type.rbi +57 -0
- data/rbi/stripe/resources/reserve_transaction.rbi +23 -0
- data/rbi/stripe/resources/reversal.rbi +51 -0
- data/rbi/stripe/resources/review.rbi +154 -0
- data/rbi/stripe/resources/setup_attempt.rbi +477 -0
- data/rbi/stripe/resources/setup_intent.rbi +3655 -0
- data/rbi/stripe/resources/shipping_rate.rbi +305 -0
- data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +75 -0
- data/rbi/stripe/resources/source.rbi +1496 -0
- data/rbi/stripe/resources/source_mandate_notification.rbi +77 -0
- data/rbi/stripe/resources/source_transaction.rbi +127 -0
- data/rbi/stripe/resources/subscription.rbi +2027 -0
- data/rbi/stripe/resources/subscription_item.rbi +404 -0
- data/rbi/stripe/resources/subscription_schedule.rbi +1623 -0
- data/rbi/stripe/resources/tax/calculation.rbi +478 -0
- data/rbi/stripe/resources/tax/calculation_line_item.rbi +91 -0
- data/rbi/stripe/resources/tax/registration.rbi +2713 -0
- data/rbi/stripe/resources/tax/settings.rbi +141 -0
- data/rbi/stripe/resources/tax/transaction.rbi +351 -0
- data/rbi/stripe/resources/tax/transaction_line_item.rbi +54 -0
- data/rbi/stripe/resources/tax_code.rbi +44 -0
- data/rbi/stripe/resources/tax_deducted_at_source.rbi +23 -0
- data/rbi/stripe/resources/tax_id.rbi +165 -0
- data/rbi/stripe/resources/tax_rate.rbi +239 -0
- data/rbi/stripe/resources/terminal/configuration.rbi +1386 -0
- data/rbi/stripe/resources/terminal/connection_token.rbi +37 -0
- data/rbi/stripe/resources/terminal/location.rbi +222 -0
- data/rbi/stripe/resources/terminal/reader.rbi +847 -0
- data/rbi/stripe/resources/test_helpers/test_clock.rbi +132 -0
- data/rbi/stripe/resources/token.rbi +1283 -0
- data/rbi/stripe/resources/topup.rbi +222 -0
- data/rbi/stripe/resources/transfer.rbi +199 -0
- data/rbi/stripe/resources/treasury/credit_reversal.rbi +119 -0
- data/rbi/stripe/resources/treasury/debit_reversal.rbi +131 -0
- data/rbi/stripe/resources/treasury/financial_account.rbi +865 -0
- data/rbi/stripe/resources/treasury/financial_account_features.rbi +260 -0
- data/rbi/stripe/resources/treasury/inbound_transfer.rbi +295 -0
- data/rbi/stripe/resources/treasury/outbound_payment.rbi +592 -0
- data/rbi/stripe/resources/treasury/outbound_transfer.rbi +431 -0
- data/rbi/stripe/resources/treasury/received_credit.rbi +302 -0
- data/rbi/stripe/resources/treasury/received_debit.rbi +256 -0
- data/rbi/stripe/resources/treasury/transaction.rbi +215 -0
- data/rbi/stripe/resources/treasury/transaction_entry.rbi +192 -0
- data/rbi/stripe/resources/v2/amount.rbi +14 -0
- data/rbi/stripe/resources/v2/billing/meter_event.rbi +37 -0
- data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +41 -0
- data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +31 -0
- data/rbi/stripe/resources/v2/event.rbi +48 -0
- data/rbi/stripe/resources/v2/event_destination.rbi +91 -0
- data/rbi/stripe/resources/webhook_endpoint.rbi +168 -0
- data/rbi/stripe/services/account_capability_service.rbi +51 -0
- data/{lib/stripe/services/external_account_service.rb → rbi/stripe/services/account_external_account_service.rbi} +124 -138
- data/rbi/stripe/services/account_link_service.rbi +58 -0
- data/rbi/stripe/services/account_login_link_service.rbi +22 -0
- data/rbi/stripe/services/account_person_service.rbi +1011 -0
- data/rbi/stripe/services/account_service.rbi +4213 -0
- data/rbi/stripe/services/account_session_service.rbi +646 -0
- data/rbi/stripe/services/apple_pay_domain_service.rbi +76 -0
- data/rbi/stripe/services/application_fee_refund_service.rbi +93 -0
- data/rbi/stripe/services/application_fee_service.rbi +78 -0
- data/rbi/stripe/services/apps/secret_service.rbi +151 -0
- data/rbi/stripe/services/apps_service.rbi +9 -0
- data/rbi/stripe/services/balance_service.rbi +21 -0
- data/rbi/stripe/services/balance_transaction_service.rbi +93 -0
- data/rbi/stripe/services/billing/alert_service.rbi +152 -0
- data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +68 -0
- data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +59 -0
- data/rbi/stripe/services/billing/credit_grant_service.rbi +211 -0
- data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +42 -0
- data/rbi/stripe/services/billing/meter_event_service.rbi +42 -0
- data/rbi/stripe/services/billing/meter_event_summary_service.rbi +54 -0
- data/rbi/stripe/services/billing/meter_service.rbi +163 -0
- data/rbi/stripe/services/billing_portal/configuration_service.rbi +511 -0
- data/rbi/stripe/services/billing_portal/session_service.rbi +204 -0
- data/rbi/stripe/services/billing_portal_service.rbi +10 -0
- data/rbi/stripe/services/billing_service.rbi +15 -0
- data/rbi/stripe/services/charge_service.rbi +448 -0
- data/rbi/stripe/services/checkout/session_line_item_service.rbi +33 -0
- data/rbi/stripe/services/checkout/session_service.rbi +2614 -0
- data/rbi/stripe/services/checkout_service.rbi +9 -0
- data/rbi/stripe/services/climate/order_service.rbi +142 -0
- data/rbi/stripe/services/climate/product_service.rbi +46 -0
- data/{lib/stripe/services/financial_connections/institution_service.rb → rbi/stripe/services/climate/supplier_service.rbi} +25 -36
- data/rbi/stripe/services/climate_service.rbi +11 -0
- data/rbi/stripe/services/confirmation_token_service.rbi +20 -0
- data/rbi/stripe/services/country_spec_service.rbi +44 -0
- data/rbi/stripe/services/coupon_service.rbi +194 -0
- data/{lib/stripe/services/quote_preview_invoice_service.rb → rbi/stripe/services/credit_note_line_item_service.rbi} +16 -20
- data/rbi/stripe/services/credit_note_preview_lines_service.rbi +167 -0
- data/rbi/stripe/services/credit_note_service.rbi +415 -0
- data/rbi/stripe/services/customer_balance_transaction_service.rbi +92 -0
- data/rbi/stripe/services/customer_cash_balance_service.rbi +45 -0
- data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +44 -0
- data/rbi/stripe/services/customer_funding_instructions_service.rbi +59 -0
- data/rbi/stripe/services/customer_payment_method_service.rbi +57 -0
- data/rbi/stripe/services/customer_payment_source_service.rbi +232 -0
- data/rbi/stripe/services/customer_service.rbi +647 -0
- data/rbi/stripe/services/customer_session_service.rbi +116 -0
- data/rbi/stripe/services/customer_tax_id_service.rbi +70 -0
- data/rbi/stripe/services/dispute_service.rbi +424 -0
- data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +55 -0
- data/rbi/stripe/services/entitlements/feature_service.rbi +107 -0
- data/rbi/stripe/services/entitlements_service.rbi +10 -0
- data/rbi/stripe/services/ephemeral_key_service.rbi +53 -0
- data/rbi/stripe/services/event_service.rbi +83 -0
- data/rbi/stripe/services/exchange_rate_service.rbi +44 -0
- data/rbi/stripe/services/file_link_service.rbi +124 -0
- data/rbi/stripe/services/file_service.rbi +116 -0
- data/rbi/stripe/services/financial_connections/account_owner_service.rbi +42 -0
- data/rbi/stripe/services/financial_connections/account_service.rbi +133 -0
- data/rbi/stripe/services/financial_connections/session_service.rbi +88 -0
- data/rbi/stripe/services/financial_connections/transaction_service.rbi +92 -0
- data/rbi/stripe/services/financial_connections_service.rbi +11 -0
- data/rbi/stripe/services/forwarding/request_service.rbi +134 -0
- data/rbi/stripe/services/forwarding_service.rbi +9 -0
- data/rbi/stripe/services/identity/verification_report_service.rbi +87 -0
- data/rbi/stripe/services/identity/verification_session_service.rbi +323 -0
- data/rbi/stripe/services/identity_service.rbi +10 -0
- data/rbi/stripe/services/invoice_item_service.rbi +366 -0
- data/rbi/stripe/services/invoice_line_item_service.rbi +259 -0
- data/rbi/stripe/services/invoice_payment_service.rbi +71 -0
- data/rbi/stripe/services/invoice_rendering_template_service.rbi +82 -0
- data/rbi/stripe/services/invoice_service.rbi +2981 -0
- data/rbi/stripe/services/issuing/authorization_service.rbi +146 -0
- data/rbi/stripe/services/issuing/card_service.rbi +495 -0
- data/rbi/stripe/services/issuing/cardholder_service.rbi +587 -0
- data/rbi/stripe/services/issuing/dispute_service.rbi +707 -0
- data/rbi/stripe/services/issuing/personalization_design_service.rbi +243 -0
- data/rbi/stripe/services/issuing/physical_bundle_service.rbi +59 -0
- data/rbi/stripe/services/issuing/token_service.rbi +99 -0
- data/rbi/stripe/services/issuing/transaction_service.rbi +105 -0
- data/rbi/stripe/services/issuing_service.rbi +16 -0
- data/rbi/stripe/services/mandate_service.rbi +20 -0
- data/rbi/stripe/services/payment_intent_service.rbi +7659 -0
- data/{lib/stripe/services/payment_intent_amount_details_line_item_service.rb → rbi/stripe/services/payment_link_line_item_service.rbi} +16 -20
- data/rbi/stripe/services/payment_link_service.rbi +1352 -0
- data/rbi/stripe/services/payment_method_configuration_service.rbi +2487 -0
- data/rbi/stripe/services/payment_method_domain_service.rbi +112 -0
- data/rbi/stripe/services/payment_method_service.rbi +776 -0
- data/rbi/stripe/services/payout_service.rbi +205 -0
- data/rbi/stripe/services/plan_service.rbi +282 -0
- data/rbi/stripe/services/price_service.rbi +546 -0
- data/rbi/stripe/services/product_feature_service.rbi +67 -0
- data/rbi/stripe/services/product_service.rbi +477 -0
- data/rbi/stripe/services/promotion_code_service.rbi +214 -0
- data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +31 -0
- data/{lib/stripe/services/order_line_item_service.rb → rbi/stripe/services/quote_line_item_service.rbi} +16 -20
- data/rbi/stripe/services/quote_service.rbi +686 -0
- data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +85 -0
- data/rbi/stripe/services/radar/value_list_item_service.rbi +109 -0
- data/rbi/stripe/services/radar/value_list_service.rbi +141 -0
- data/rbi/stripe/services/radar_service.rbi +11 -0
- data/rbi/stripe/services/refund_service.rbi +185 -0
- data/rbi/stripe/services/reporting/report_run_service.rbi +135 -0
- data/rbi/stripe/services/reporting/report_type_service.rbi +35 -0
- data/rbi/stripe/services/reporting_service.rbi +10 -0
- data/rbi/stripe/services/review_service.rbi +84 -0
- data/rbi/stripe/services/setup_attempt_service.rbi +65 -0
- data/rbi/stripe/services/setup_intent_service.rbi +3391 -0
- data/rbi/stripe/services/shipping_rate_service.rbi +241 -0
- data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +46 -0
- data/rbi/stripe/services/sigma_service.rbi +9 -0
- data/rbi/stripe/services/source_service.rbi +663 -0
- data/{lib/stripe/services/quote_line_service.rb → rbi/stripe/services/source_transaction_service.rbi} +16 -20
- data/rbi/stripe/services/subscription_item_service.rbi +350 -0
- data/rbi/stripe/services/subscription_schedule_service.rbi +1290 -0
- data/rbi/stripe/services/subscription_service.rbi +1648 -0
- data/{lib/stripe/services/financial_connections/account_inferred_balance_service.rb → rbi/stripe/services/tax/calculation_line_item_service.rbi} +17 -21
- data/rbi/stripe/services/tax/calculation_service.rbi +234 -0
- data/rbi/stripe/services/tax/registration_service.rbi +1845 -0
- data/rbi/stripe/services/tax/settings_service.rbi +93 -0
- data/{lib/stripe/services/privacy/redaction_job_validation_error_service.rb → rbi/stripe/services/tax/transaction_line_item_service.rbi} +17 -21
- data/rbi/stripe/services/tax/transaction_service.rbi +146 -0
- data/rbi/stripe/services/tax_code_service.rbi +44 -0
- data/rbi/stripe/services/tax_id_service.rbi +110 -0
- data/rbi/stripe/services/tax_rate_service.rbi +185 -0
- data/rbi/stripe/services/tax_service.rbi +12 -0
- data/rbi/stripe/services/terminal/configuration_service.rbi +1118 -0
- data/rbi/stripe/services/terminal/connection_token_service.rbi +25 -0
- data/rbi/stripe/services/terminal/location_service.rbi +182 -0
- data/rbi/stripe/services/terminal/reader_service.rbi +455 -0
- data/rbi/stripe/services/terminal_service.rbi +12 -0
- data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +739 -0
- data/rbi/stripe/services/test_helpers/customer_service.rbi +33 -0
- data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +848 -0
- data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +76 -0
- data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +69 -0
- data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +711 -0
- data/rbi/stripe/services/test_helpers/issuing_service.rbi +14 -0
- data/rbi/stripe/services/test_helpers/refund_service.rbi +22 -0
- data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +93 -0
- data/rbi/stripe/services/test_helpers/terminal_service.rbi +11 -0
- data/rbi/stripe/services/test_helpers/test_clock_service.rbi +90 -0
- data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +64 -0
- data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +125 -0
- data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +125 -0
- data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +87 -0
- data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +87 -0
- data/rbi/stripe/services/test_helpers/treasury_service.rbi +15 -0
- data/rbi/stripe/services/test_helpers_service.rbi +15 -0
- data/rbi/stripe/services/token_service.rbi +1257 -0
- data/rbi/stripe/services/topup_service.rbi +176 -0
- data/rbi/stripe/services/transfer_reversal_service.rbi +101 -0
- data/rbi/stripe/services/transfer_service.rbi +152 -0
- data/rbi/stripe/services/treasury/credit_reversal_service.rbi +84 -0
- data/rbi/stripe/services/treasury/debit_reversal_service.rbi +88 -0
- data/rbi/stripe/services/treasury/financial_account_features_service.rbi +198 -0
- data/rbi/stripe/services/treasury/financial_account_service.rbi +562 -0
- data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +117 -0
- data/rbi/stripe/services/treasury/outbound_payment_service.rbi +304 -0
- data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +157 -0
- data/rbi/stripe/services/treasury/received_credit_service.rbi +72 -0
- data/rbi/stripe/services/treasury/received_debit_service.rbi +59 -0
- data/rbi/stripe/services/treasury/transaction_entry_service.rbi +111 -0
- data/rbi/stripe/services/treasury/transaction_service.rbi +122 -0
- data/rbi/stripe/services/treasury_service.rbi +18 -0
- data/rbi/stripe/services/v1_services.rbi +77 -0
- data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +39 -0
- data/rbi/stripe/services/v2/billing/meter_event_service.rbi +42 -0
- data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +18 -0
- data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +55 -0
- data/rbi/stripe/services/v2/billing_service.rbi +14 -0
- data/rbi/stripe/services/v2/core/event_destination_service.rbi +192 -0
- data/rbi/stripe/services/v2/core/event_service.rbi +36 -0
- data/rbi/stripe/services/v2/core_service.rbi +12 -0
- data/rbi/stripe/services/v2_services.rbi +10 -0
- data/rbi/stripe/services/webhook_endpoint_service.rbi +129 -0
- data/stripe.gemspec +1 -4
- metadata +326 -158
- data/lib/stripe/events/v2_core_account_closed_event.rb +0 -21
- data/lib/stripe/events/v2_core_account_created_event.rb +0 -21
- data/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb +0 -23
- data/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb +0 -21
- data/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb +0 -23
- data/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb +0 -21
- data/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb +0 -23
- data/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb +0 -21
- data/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb +0 -21
- data/lib/stripe/events/v2_core_account_including_identity_updated_event.rb +0 -21
- data/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb +0 -21
- data/lib/stripe/events/v2_core_account_link_completed_event.rb +0 -13
- data/lib/stripe/events/v2_core_account_person_created_event.rb +0 -23
- data/lib/stripe/events/v2_core_account_person_deleted_event.rb +0 -23
- data/lib/stripe/events/v2_core_account_person_updated_event.rb +0 -23
- data/lib/stripe/events/v2_core_account_updated_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_adjustment_created_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_financial_account_created_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_financial_account_updated_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_financial_address_activated_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_financial_address_failed_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_inbound_transfer_available_event.rb +0 -23
- data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_failed_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_processing_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_queued_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_returned_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_inbound_transfer_bank_debit_succeeded_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_outbound_payment_canceled_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_outbound_payment_created_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_outbound_payment_failed_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_outbound_payment_posted_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_outbound_payment_returned_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_outbound_payment_updated_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_outbound_transfer_canceled_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_outbound_transfer_created_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_outbound_transfer_failed_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_outbound_transfer_posted_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_outbound_transfer_returned_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_outbound_transfer_updated_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_received_credit_available_event.rb +0 -23
- data/lib/stripe/events/v2_money_management_received_credit_failed_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_received_credit_returned_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_received_credit_succeeded_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_received_debit_canceled_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_received_debit_failed_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_received_debit_pending_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_received_debit_succeeded_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_received_debit_updated_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_transaction_created_event.rb +0 -21
- data/lib/stripe/events/v2_money_management_transaction_updated_event.rb +0 -21
- data/lib/stripe/resources/account_notice.rb +0 -123
- data/lib/stripe/resources/balance_settings.rb +0 -105
- data/lib/stripe/resources/billing/meter_error_report.rb +0 -59
- data/lib/stripe/resources/capital/financing_offer.rb +0 -179
- data/lib/stripe/resources/capital/financing_summary.rb +0 -55
- data/lib/stripe/resources/capital/financing_transaction.rb +0 -114
- data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -27
- data/lib/stripe/resources/financial_connections/institution.rb +0 -90
- data/lib/stripe/resources/fx_quote.rb +0 -184
- data/lib/stripe/resources/gift_cards/card.rb +0 -208
- data/lib/stripe/resources/gift_cards/transaction.rb +0 -272
- data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -602
- data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -82
- data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -86
- data/lib/stripe/resources/issuing/settlement.rb +0 -53
- data/lib/stripe/resources/margin.rb +0 -115
- data/lib/stripe/resources/order.rb +0 -2859
- data/lib/stripe/resources/payment_attempt_record.rb +0 -1078
- data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +0 -65
- data/lib/stripe/resources/payment_record.rb +0 -1607
- data/lib/stripe/resources/privacy/redaction_job.rb +0 -275
- data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +0 -25
- data/lib/stripe/resources/quote_line.rb +0 -274
- data/lib/stripe/resources/quote_preview_invoice.rb +0 -663
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -339
- data/lib/stripe/resources/tax/association.rb +0 -89
- data/lib/stripe/resources/tax/form.rb +0 -211
- data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -31
- data/lib/stripe/resources/v2/core/account.rb +0 -1746
- data/lib/stripe/resources/v2/core/account_link.rb +0 -56
- data/lib/stripe/resources/v2/core/person.rb +0 -276
- data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +0 -74
- data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +0 -39
- data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +0 -20
- data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +0 -22
- data/lib/stripe/resources/v2/money_management/adjustment.rb +0 -51
- data/lib/stripe/resources/v2/money_management/financial_account.rb +0 -58
- data/lib/stripe/resources/v2/money_management/financial_address.rb +0 -68
- data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +0 -94
- data/lib/stripe/resources/v2/money_management/outbound_payment.rb +0 -129
- data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +0 -82
- data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +0 -45
- data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +0 -117
- data/lib/stripe/resources/v2/money_management/payout_method.rb +0 -75
- data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +0 -49
- data/lib/stripe/resources/v2/money_management/received_credit.rb +0 -136
- data/lib/stripe/resources/v2/money_management/received_debit.rb +0 -108
- data/lib/stripe/resources/v2/money_management/transaction.rb +0 -78
- data/lib/stripe/resources/v2/money_management/transaction_entry.rb +0 -68
- data/lib/stripe/services/account_notice_service.rb +0 -101
- data/lib/stripe/services/balance_settings_service.rb +0 -96
- data/lib/stripe/services/capital/financing_offer_service.rb +0 -112
- data/lib/stripe/services/capital/financing_summary_service.rb +0 -28
- data/lib/stripe/services/capital/financing_transaction_service.rb +0 -79
- data/lib/stripe/services/capital_service.rb +0 -15
- data/lib/stripe/services/fx_quote_service.rb +0 -123
- data/lib/stripe/services/gift_cards/card_service.rb +0 -170
- data/lib/stripe/services/gift_cards/transaction_service.rb +0 -209
- data/lib/stripe/services/gift_cards_service.rb +0 -14
- data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -504
- data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -66
- data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -83
- data/lib/stripe/services/margin_service.rb +0 -119
- data/lib/stripe/services/order_service.rb +0 -2268
- data/lib/stripe/services/payment_attempt_record_service.rb +0 -49
- data/lib/stripe/services/payment_record_service.rb +0 -542
- data/lib/stripe/services/privacy/redaction_job_service.rb +0 -231
- data/lib/stripe/services/privacy_service.rb +0 -13
- data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -35
- data/lib/stripe/services/tax/association_service.rb +0 -31
- data/lib/stripe/services/tax/form_service.rb +0 -100
- data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -28
- data/lib/stripe/services/v2/core/account_link_service.rb +0 -76
- data/lib/stripe/services/v2/core/account_service.rb +0 -4138
- data/lib/stripe/services/v2/core/accounts/person_service.rb +0 -1048
- data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +0 -135
- data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +0 -109
- data/lib/stripe/services/v2/core/vault_service.rb +0 -18
- data/lib/stripe/services/v2/money_management/adjustment_service.rb +0 -75
- data/lib/stripe/services/v2/money_management/financial_account_service.rb +0 -44
- data/lib/stripe/services/v2/money_management/financial_address_service.rb +0 -81
- data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +0 -126
- data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +0 -96
- data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +0 -202
- data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +0 -237
- data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +0 -174
- data/lib/stripe/services/v2/money_management/payout_method_service.rb +0 -95
- data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +0 -32
- data/lib/stripe/services/v2/money_management/received_credit_service.rb +0 -71
- data/lib/stripe/services/v2/money_management/received_debit_service.rb +0 -44
- data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +0 -70
- data/lib/stripe/services/v2/money_management/transaction_service.rb +0 -74
- data/lib/stripe/services/v2/money_management_service.rb +0 -31
- data/lib/stripe/services/v2/test_helper_service.rb +0 -15
- data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +0 -50
- data/rbi/stripe.rbi +0 -191867
@@ -44,6 +44,13 @@ module Stripe
|
|
44
44
|
attr_reader :second
|
45
45
|
end
|
46
46
|
|
47
|
+
class BillingThresholds < Stripe::StripeObject
|
48
|
+
# Monetary threshold that triggers the subscription to create an invoice
|
49
|
+
attr_reader :amount_gte
|
50
|
+
# Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.
|
51
|
+
attr_reader :reset_billing_cycle_anchor
|
52
|
+
end
|
53
|
+
|
47
54
|
class CancellationDetails < Stripe::StripeObject
|
48
55
|
# Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
|
49
56
|
attr_reader :comment
|
@@ -66,21 +73,6 @@ module Stripe
|
|
66
73
|
attr_reader :issuer
|
67
74
|
end
|
68
75
|
|
69
|
-
class LastPriceMigrationError < Stripe::StripeObject
|
70
|
-
class FailedTransition < Stripe::StripeObject
|
71
|
-
# The original price to be migrated.
|
72
|
-
attr_reader :source_price
|
73
|
-
# The intended resulting price of the migration.
|
74
|
-
attr_reader :target_price
|
75
|
-
end
|
76
|
-
# The time at which the price migration encountered an error.
|
77
|
-
attr_reader :errored_at
|
78
|
-
# The involved price pairs in each failed transition.
|
79
|
-
attr_reader :failed_transitions
|
80
|
-
# The type of error encountered by the price migration.
|
81
|
-
attr_reader :type
|
82
|
-
end
|
83
|
-
|
84
76
|
class PauseCollection < Stripe::StripeObject
|
85
77
|
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
86
78
|
attr_reader :behavior
|
@@ -140,7 +132,6 @@ module Stripe
|
|
140
132
|
attr_reader :funding_type
|
141
133
|
end
|
142
134
|
|
143
|
-
class IdBankTransfer < Stripe::StripeObject; end
|
144
135
|
class Konbini < Stripe::StripeObject; end
|
145
136
|
class SepaDebit < Stripe::StripeObject; end
|
146
137
|
|
@@ -149,8 +140,6 @@ module Stripe
|
|
149
140
|
class Filters < Stripe::StripeObject
|
150
141
|
# The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
|
151
142
|
attr_reader :account_subcategories
|
152
|
-
# The institution to use to filter for possible accounts to link.
|
153
|
-
attr_reader :institution
|
154
143
|
end
|
155
144
|
# Attribute for field filters
|
156
145
|
attr_reader :filters
|
@@ -172,8 +161,6 @@ module Stripe
|
|
172
161
|
attr_reader :card
|
173
162
|
# This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.
|
174
163
|
attr_reader :customer_balance
|
175
|
-
# This sub-hash contains details about the Indonesia bank transfer payment method options to pass to invoices created by the subscription.
|
176
|
-
attr_reader :id_bank_transfer
|
177
164
|
# This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.
|
178
165
|
attr_reader :konbini
|
179
166
|
# This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription.
|
@@ -201,8 +188,6 @@ module Stripe
|
|
201
188
|
attr_reader :billing_cycle_anchor
|
202
189
|
# The point after which the changes reflected by this update will be discarded and no longer applied.
|
203
190
|
attr_reader :expires_at
|
204
|
-
# The number of iterations of prebilling to apply.
|
205
|
-
attr_reader :prebilling_iterations
|
206
191
|
# List of subscription items, each with an attached plan, that will be set if the update is applied.
|
207
192
|
attr_reader :subscription_items
|
208
193
|
# Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.
|
@@ -211,17 +196,6 @@ module Stripe
|
|
211
196
|
attr_reader :trial_from_plan
|
212
197
|
end
|
213
198
|
|
214
|
-
class Prebilling < Stripe::StripeObject
|
215
|
-
# ID of the prebilling invoice.
|
216
|
-
attr_reader :invoice
|
217
|
-
# The end of the last period for which the invoice pre-bills.
|
218
|
-
attr_reader :period_end
|
219
|
-
# The start of the first period for which the invoice pre-bills.
|
220
|
-
attr_reader :period_start
|
221
|
-
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
|
222
|
-
attr_reader :update_behavior
|
223
|
-
end
|
224
|
-
|
225
199
|
class TransferData < Stripe::StripeObject
|
226
200
|
# 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.
|
227
201
|
attr_reader :amount_percent
|
@@ -270,44 +244,16 @@ module Stripe
|
|
270
244
|
class UpdateParams < Stripe::RequestParams
|
271
245
|
class AddInvoiceItem < Stripe::RequestParams
|
272
246
|
class Discount < Stripe::RequestParams
|
273
|
-
class DiscountEnd < Stripe::RequestParams
|
274
|
-
class Duration < Stripe::RequestParams
|
275
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
276
|
-
attr_accessor :interval
|
277
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
278
|
-
attr_accessor :interval_count
|
279
|
-
|
280
|
-
def initialize(interval: nil, interval_count: nil)
|
281
|
-
@interval = interval
|
282
|
-
@interval_count = interval_count
|
283
|
-
end
|
284
|
-
end
|
285
|
-
# Time span for the redeemed discount.
|
286
|
-
attr_accessor :duration
|
287
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
288
|
-
attr_accessor :timestamp
|
289
|
-
# The type of calculation made to determine when the discount ends.
|
290
|
-
attr_accessor :type
|
291
|
-
|
292
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
293
|
-
@duration = duration
|
294
|
-
@timestamp = timestamp
|
295
|
-
@type = type
|
296
|
-
end
|
297
|
-
end
|
298
247
|
# ID of the coupon to create a new discount for.
|
299
248
|
attr_accessor :coupon
|
300
249
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
301
250
|
attr_accessor :discount
|
302
|
-
# Details to determine how long the discount should be applied for.
|
303
|
-
attr_accessor :discount_end
|
304
251
|
# ID of the promotion code to create a new discount for.
|
305
252
|
attr_accessor :promotion_code
|
306
253
|
|
307
|
-
def initialize(coupon: nil, discount: nil,
|
254
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
308
255
|
@coupon = coupon
|
309
256
|
@discount = discount
|
310
|
-
@discount_end = discount_end
|
311
257
|
@promotion_code = promotion_code
|
312
258
|
end
|
313
259
|
end
|
@@ -381,6 +327,18 @@ module Stripe
|
|
381
327
|
end
|
382
328
|
end
|
383
329
|
|
330
|
+
class BillingThresholds < Stripe::RequestParams
|
331
|
+
# Monetary threshold that triggers the subscription to advance to a new billing period
|
332
|
+
attr_accessor :amount_gte
|
333
|
+
# 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.
|
334
|
+
attr_accessor :reset_billing_cycle_anchor
|
335
|
+
|
336
|
+
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil)
|
337
|
+
@amount_gte = amount_gte
|
338
|
+
@reset_billing_cycle_anchor = reset_billing_cycle_anchor
|
339
|
+
end
|
340
|
+
end
|
341
|
+
|
384
342
|
class CancellationDetails < Stripe::RequestParams
|
385
343
|
# Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
|
386
344
|
attr_accessor :comment
|
@@ -394,44 +352,16 @@ module Stripe
|
|
394
352
|
end
|
395
353
|
|
396
354
|
class Discount < Stripe::RequestParams
|
397
|
-
class DiscountEnd < Stripe::RequestParams
|
398
|
-
class Duration < Stripe::RequestParams
|
399
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
400
|
-
attr_accessor :interval
|
401
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
402
|
-
attr_accessor :interval_count
|
403
|
-
|
404
|
-
def initialize(interval: nil, interval_count: nil)
|
405
|
-
@interval = interval
|
406
|
-
@interval_count = interval_count
|
407
|
-
end
|
408
|
-
end
|
409
|
-
# Time span for the redeemed discount.
|
410
|
-
attr_accessor :duration
|
411
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
412
|
-
attr_accessor :timestamp
|
413
|
-
# The type of calculation made to determine when the discount ends.
|
414
|
-
attr_accessor :type
|
415
|
-
|
416
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
417
|
-
@duration = duration
|
418
|
-
@timestamp = timestamp
|
419
|
-
@type = type
|
420
|
-
end
|
421
|
-
end
|
422
355
|
# ID of the coupon to create a new discount for.
|
423
356
|
attr_accessor :coupon
|
424
357
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
425
358
|
attr_accessor :discount
|
426
|
-
# Details to determine how long the discount should be applied for.
|
427
|
-
attr_accessor :discount_end
|
428
359
|
# ID of the promotion code to create a new discount for.
|
429
360
|
attr_accessor :promotion_code
|
430
361
|
|
431
|
-
def initialize(coupon: nil, discount: nil,
|
362
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
432
363
|
@coupon = coupon
|
433
364
|
@discount = discount
|
434
|
-
@discount_end = discount_end
|
435
365
|
@promotion_code = promotion_code
|
436
366
|
end
|
437
367
|
end
|
@@ -460,45 +390,26 @@ module Stripe
|
|
460
390
|
end
|
461
391
|
|
462
392
|
class Item < Stripe::RequestParams
|
463
|
-
class
|
464
|
-
|
465
|
-
|
466
|
-
|
467
|
-
|
468
|
-
|
469
|
-
attr_accessor :interval_count
|
470
|
-
|
471
|
-
def initialize(interval: nil, interval_count: nil)
|
472
|
-
@interval = interval
|
473
|
-
@interval_count = interval_count
|
474
|
-
end
|
475
|
-
end
|
476
|
-
# Time span for the redeemed discount.
|
477
|
-
attr_accessor :duration
|
478
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
479
|
-
attr_accessor :timestamp
|
480
|
-
# The type of calculation made to determine when the discount ends.
|
481
|
-
attr_accessor :type
|
482
|
-
|
483
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
484
|
-
@duration = duration
|
485
|
-
@timestamp = timestamp
|
486
|
-
@type = type
|
487
|
-
end
|
393
|
+
class BillingThresholds < Stripe::RequestParams
|
394
|
+
# Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
|
395
|
+
attr_accessor :usage_gte
|
396
|
+
|
397
|
+
def initialize(usage_gte: nil)
|
398
|
+
@usage_gte = usage_gte
|
488
399
|
end
|
400
|
+
end
|
401
|
+
|
402
|
+
class Discount < Stripe::RequestParams
|
489
403
|
# ID of the coupon to create a new discount for.
|
490
404
|
attr_accessor :coupon
|
491
405
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
492
406
|
attr_accessor :discount
|
493
|
-
# Details to determine how long the discount should be applied for.
|
494
|
-
attr_accessor :discount_end
|
495
407
|
# ID of the promotion code to create a new discount for.
|
496
408
|
attr_accessor :promotion_code
|
497
409
|
|
498
|
-
def initialize(coupon: nil, discount: nil,
|
410
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
499
411
|
@coupon = coupon
|
500
412
|
@discount = discount
|
501
|
-
@discount_end = discount_end
|
502
413
|
@promotion_code = promotion_code
|
503
414
|
end
|
504
415
|
end
|
@@ -544,6 +455,8 @@ module Stripe
|
|
544
455
|
@unit_amount_decimal = unit_amount_decimal
|
545
456
|
end
|
546
457
|
end
|
458
|
+
# 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.
|
459
|
+
attr_accessor :billing_thresholds
|
547
460
|
# Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
|
548
461
|
attr_accessor :clear_usage
|
549
462
|
# A flag that, if set to `true`, will delete the specified item.
|
@@ -566,6 +479,7 @@ module Stripe
|
|
566
479
|
attr_accessor :tax_rates
|
567
480
|
|
568
481
|
def initialize(
|
482
|
+
billing_thresholds: nil,
|
569
483
|
clear_usage: nil,
|
570
484
|
deleted: nil,
|
571
485
|
discounts: nil,
|
@@ -577,6 +491,7 @@ module Stripe
|
|
577
491
|
quantity: nil,
|
578
492
|
tax_rates: nil
|
579
493
|
)
|
494
|
+
@billing_thresholds = billing_thresholds
|
580
495
|
@clear_usage = clear_usage
|
581
496
|
@deleted = deleted
|
582
497
|
@discounts = discounts
|
@@ -693,26 +608,17 @@ module Stripe
|
|
693
608
|
end
|
694
609
|
end
|
695
610
|
|
696
|
-
class
|
697
|
-
end
|
698
|
-
|
699
|
-
class Konbini < Stripe::RequestParams
|
700
|
-
end
|
701
|
-
|
702
|
-
class SepaDebit < Stripe::RequestParams
|
703
|
-
end
|
611
|
+
class Konbini < Stripe::RequestParams; end
|
612
|
+
class SepaDebit < Stripe::RequestParams; end
|
704
613
|
|
705
614
|
class UsBankAccount < Stripe::RequestParams
|
706
615
|
class FinancialConnections < Stripe::RequestParams
|
707
616
|
class Filters < Stripe::RequestParams
|
708
617
|
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
709
618
|
attr_accessor :account_subcategories
|
710
|
-
# ID of the institution to use to filter for selectable accounts.
|
711
|
-
attr_accessor :institution
|
712
619
|
|
713
|
-
def initialize(account_subcategories: nil
|
620
|
+
def initialize(account_subcategories: nil)
|
714
621
|
@account_subcategories = account_subcategories
|
715
|
-
@institution = institution
|
716
622
|
end
|
717
623
|
end
|
718
624
|
# Provide filters for the linked accounts that the customer can select for the payment method.
|
@@ -746,8 +652,6 @@ module Stripe
|
|
746
652
|
attr_accessor :card
|
747
653
|
# This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
|
748
654
|
attr_accessor :customer_balance
|
749
|
-
# This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
|
750
|
-
attr_accessor :id_bank_transfer
|
751
655
|
# This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
|
752
656
|
attr_accessor :konbini
|
753
657
|
# This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
|
@@ -760,7 +664,6 @@ module Stripe
|
|
760
664
|
bancontact: nil,
|
761
665
|
card: nil,
|
762
666
|
customer_balance: nil,
|
763
|
-
id_bank_transfer: nil,
|
764
667
|
konbini: nil,
|
765
668
|
sepa_debit: nil,
|
766
669
|
us_bank_account: nil
|
@@ -769,7 +672,6 @@ module Stripe
|
|
769
672
|
@bancontact = bancontact
|
770
673
|
@card = card
|
771
674
|
@customer_balance = customer_balance
|
772
|
-
@id_bank_transfer = id_bank_transfer
|
773
675
|
@konbini = konbini
|
774
676
|
@sepa_debit = sepa_debit
|
775
677
|
@us_bank_account = us_bank_account
|
@@ -805,18 +707,6 @@ module Stripe
|
|
805
707
|
end
|
806
708
|
end
|
807
709
|
|
808
|
-
class Prebilling < Stripe::RequestParams
|
809
|
-
# This is used to determine the number of billing cycles to prebill.
|
810
|
-
attr_accessor :iterations
|
811
|
-
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
812
|
-
attr_accessor :update_behavior
|
813
|
-
|
814
|
-
def initialize(iterations: nil, update_behavior: nil)
|
815
|
-
@iterations = iterations
|
816
|
-
@update_behavior = update_behavior
|
817
|
-
end
|
818
|
-
end
|
819
|
-
|
820
710
|
class TransferData < Stripe::RequestParams
|
821
711
|
# 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.
|
822
712
|
attr_accessor :amount_percent
|
@@ -853,9 +743,11 @@ module Stripe
|
|
853
743
|
attr_accessor :automatic_tax
|
854
744
|
# Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
|
855
745
|
attr_accessor :billing_cycle_anchor
|
746
|
+
# 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.
|
747
|
+
attr_accessor :billing_thresholds
|
856
748
|
# A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
|
857
749
|
attr_accessor :cancel_at
|
858
|
-
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
|
750
|
+
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
|
859
751
|
attr_accessor :cancel_at_period_end
|
860
752
|
# Details about why this subscription was cancelled
|
861
753
|
attr_accessor :cancellation_details
|
@@ -899,15 +791,13 @@ module Stripe
|
|
899
791
|
attr_accessor :payment_settings
|
900
792
|
# Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
|
901
793
|
attr_accessor :pending_invoice_item_interval
|
902
|
-
# If specified, the invoicing for the given billing cycle iterations will be processed now.
|
903
|
-
attr_accessor :prebilling
|
904
794
|
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
|
905
795
|
attr_accessor :proration_behavior
|
906
|
-
# If set,
|
796
|
+
# If set, prorations will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. `proration_date` can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.
|
907
797
|
attr_accessor :proration_date
|
908
798
|
# If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value.
|
909
799
|
attr_accessor :transfer_data
|
910
|
-
# Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.
|
800
|
+
# Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, `trial_end` will override the default trial period of the plan the customer is being subscribed to. The `billing_cycle_anchor` will be updated to the `trial_end` value. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.
|
911
801
|
attr_accessor :trial_end
|
912
802
|
# Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
|
913
803
|
attr_accessor :trial_from_plan
|
@@ -919,6 +809,7 @@ module Stripe
|
|
919
809
|
application_fee_percent: nil,
|
920
810
|
automatic_tax: nil,
|
921
811
|
billing_cycle_anchor: nil,
|
812
|
+
billing_thresholds: nil,
|
922
813
|
cancel_at: nil,
|
923
814
|
cancel_at_period_end: nil,
|
924
815
|
cancellation_details: nil,
|
@@ -939,7 +830,6 @@ module Stripe
|
|
939
830
|
payment_behavior: nil,
|
940
831
|
payment_settings: nil,
|
941
832
|
pending_invoice_item_interval: nil,
|
942
|
-
prebilling: nil,
|
943
833
|
proration_behavior: nil,
|
944
834
|
proration_date: nil,
|
945
835
|
transfer_data: nil,
|
@@ -951,6 +841,7 @@ module Stripe
|
|
951
841
|
@application_fee_percent = application_fee_percent
|
952
842
|
@automatic_tax = automatic_tax
|
953
843
|
@billing_cycle_anchor = billing_cycle_anchor
|
844
|
+
@billing_thresholds = billing_thresholds
|
954
845
|
@cancel_at = cancel_at
|
955
846
|
@cancel_at_period_end = cancel_at_period_end
|
956
847
|
@cancellation_details = cancellation_details
|
@@ -971,7 +862,6 @@ module Stripe
|
|
971
862
|
@payment_behavior = payment_behavior
|
972
863
|
@payment_settings = payment_settings
|
973
864
|
@pending_invoice_item_interval = pending_invoice_item_interval
|
974
|
-
@prebilling = prebilling
|
975
865
|
@proration_behavior = proration_behavior
|
976
866
|
@proration_date = proration_date
|
977
867
|
@transfer_data = transfer_data
|
@@ -981,8 +871,7 @@ module Stripe
|
|
981
871
|
end
|
982
872
|
end
|
983
873
|
|
984
|
-
class DeleteDiscountParams < Stripe::RequestParams
|
985
|
-
end
|
874
|
+
class DeleteDiscountParams < Stripe::RequestParams; end
|
986
875
|
|
987
876
|
class ListParams < Stripe::RequestParams
|
988
877
|
class AutomaticTax < Stripe::RequestParams
|
@@ -1059,8 +948,6 @@ module Stripe
|
|
1059
948
|
attr_accessor :current_period_start
|
1060
949
|
# The ID of the customer whose subscriptions will be retrieved.
|
1061
950
|
attr_accessor :customer
|
1062
|
-
# The ID of the account whose subscriptions will be retrieved.
|
1063
|
-
attr_accessor :customer_account
|
1064
951
|
# 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.
|
1065
952
|
attr_accessor :ending_before
|
1066
953
|
# Specifies which fields in the response should be expanded.
|
@@ -1085,7 +972,6 @@ module Stripe
|
|
1085
972
|
current_period_end: nil,
|
1086
973
|
current_period_start: nil,
|
1087
974
|
customer: nil,
|
1088
|
-
customer_account: nil,
|
1089
975
|
ending_before: nil,
|
1090
976
|
expand: nil,
|
1091
977
|
limit: nil,
|
@@ -1101,7 +987,6 @@ module Stripe
|
|
1101
987
|
@current_period_end = current_period_end
|
1102
988
|
@current_period_start = current_period_start
|
1103
989
|
@customer = customer
|
1104
|
-
@customer_account = customer_account
|
1105
990
|
@ending_before = ending_before
|
1106
991
|
@expand = expand
|
1107
992
|
@limit = limit
|
@@ -1116,44 +1001,16 @@ module Stripe
|
|
1116
1001
|
class CreateParams < Stripe::RequestParams
|
1117
1002
|
class AddInvoiceItem < Stripe::RequestParams
|
1118
1003
|
class Discount < Stripe::RequestParams
|
1119
|
-
class DiscountEnd < Stripe::RequestParams
|
1120
|
-
class Duration < Stripe::RequestParams
|
1121
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1122
|
-
attr_accessor :interval
|
1123
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1124
|
-
attr_accessor :interval_count
|
1125
|
-
|
1126
|
-
def initialize(interval: nil, interval_count: nil)
|
1127
|
-
@interval = interval
|
1128
|
-
@interval_count = interval_count
|
1129
|
-
end
|
1130
|
-
end
|
1131
|
-
# Time span for the redeemed discount.
|
1132
|
-
attr_accessor :duration
|
1133
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1134
|
-
attr_accessor :timestamp
|
1135
|
-
# The type of calculation made to determine when the discount ends.
|
1136
|
-
attr_accessor :type
|
1137
|
-
|
1138
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
1139
|
-
@duration = duration
|
1140
|
-
@timestamp = timestamp
|
1141
|
-
@type = type
|
1142
|
-
end
|
1143
|
-
end
|
1144
1004
|
# ID of the coupon to create a new discount for.
|
1145
1005
|
attr_accessor :coupon
|
1146
1006
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1147
1007
|
attr_accessor :discount
|
1148
|
-
# Details to determine how long the discount should be applied for.
|
1149
|
-
attr_accessor :discount_end
|
1150
1008
|
# ID of the promotion code to create a new discount for.
|
1151
1009
|
attr_accessor :promotion_code
|
1152
1010
|
|
1153
|
-
def initialize(coupon: nil, discount: nil,
|
1011
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
1154
1012
|
@coupon = coupon
|
1155
1013
|
@discount = discount
|
1156
|
-
@discount_end = discount_end
|
1157
1014
|
@promotion_code = promotion_code
|
1158
1015
|
end
|
1159
1016
|
end
|
@@ -1248,45 +1105,29 @@ module Stripe
|
|
1248
1105
|
end
|
1249
1106
|
end
|
1250
1107
|
|
1251
|
-
class
|
1252
|
-
|
1253
|
-
|
1254
|
-
|
1255
|
-
|
1256
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1257
|
-
attr_accessor :interval_count
|
1108
|
+
class BillingThresholds < Stripe::RequestParams
|
1109
|
+
# Monetary threshold that triggers the subscription to advance to a new billing period
|
1110
|
+
attr_accessor :amount_gte
|
1111
|
+
# 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.
|
1112
|
+
attr_accessor :reset_billing_cycle_anchor
|
1258
1113
|
|
1259
|
-
|
1260
|
-
|
1261
|
-
|
1262
|
-
end
|
1263
|
-
end
|
1264
|
-
# Time span for the redeemed discount.
|
1265
|
-
attr_accessor :duration
|
1266
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1267
|
-
attr_accessor :timestamp
|
1268
|
-
# The type of calculation made to determine when the discount ends.
|
1269
|
-
attr_accessor :type
|
1270
|
-
|
1271
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
1272
|
-
@duration = duration
|
1273
|
-
@timestamp = timestamp
|
1274
|
-
@type = type
|
1275
|
-
end
|
1114
|
+
def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil)
|
1115
|
+
@amount_gte = amount_gte
|
1116
|
+
@reset_billing_cycle_anchor = reset_billing_cycle_anchor
|
1276
1117
|
end
|
1118
|
+
end
|
1119
|
+
|
1120
|
+
class Discount < Stripe::RequestParams
|
1277
1121
|
# ID of the coupon to create a new discount for.
|
1278
1122
|
attr_accessor :coupon
|
1279
1123
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1280
1124
|
attr_accessor :discount
|
1281
|
-
# Details to determine how long the discount should be applied for.
|
1282
|
-
attr_accessor :discount_end
|
1283
1125
|
# ID of the promotion code to create a new discount for.
|
1284
1126
|
attr_accessor :promotion_code
|
1285
1127
|
|
1286
|
-
def initialize(coupon: nil, discount: nil,
|
1128
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
1287
1129
|
@coupon = coupon
|
1288
1130
|
@discount = discount
|
1289
|
-
@discount_end = discount_end
|
1290
1131
|
@promotion_code = promotion_code
|
1291
1132
|
end
|
1292
1133
|
end
|
@@ -1315,45 +1156,26 @@ module Stripe
|
|
1315
1156
|
end
|
1316
1157
|
|
1317
1158
|
class Item < Stripe::RequestParams
|
1318
|
-
class
|
1319
|
-
|
1320
|
-
|
1321
|
-
|
1322
|
-
|
1323
|
-
|
1324
|
-
attr_accessor :interval_count
|
1325
|
-
|
1326
|
-
def initialize(interval: nil, interval_count: nil)
|
1327
|
-
@interval = interval
|
1328
|
-
@interval_count = interval_count
|
1329
|
-
end
|
1330
|
-
end
|
1331
|
-
# Time span for the redeemed discount.
|
1332
|
-
attr_accessor :duration
|
1333
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1334
|
-
attr_accessor :timestamp
|
1335
|
-
# The type of calculation made to determine when the discount ends.
|
1336
|
-
attr_accessor :type
|
1337
|
-
|
1338
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
1339
|
-
@duration = duration
|
1340
|
-
@timestamp = timestamp
|
1341
|
-
@type = type
|
1342
|
-
end
|
1159
|
+
class BillingThresholds < Stripe::RequestParams
|
1160
|
+
# Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
|
1161
|
+
attr_accessor :usage_gte
|
1162
|
+
|
1163
|
+
def initialize(usage_gte: nil)
|
1164
|
+
@usage_gte = usage_gte
|
1343
1165
|
end
|
1166
|
+
end
|
1167
|
+
|
1168
|
+
class Discount < Stripe::RequestParams
|
1344
1169
|
# ID of the coupon to create a new discount for.
|
1345
1170
|
attr_accessor :coupon
|
1346
1171
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1347
1172
|
attr_accessor :discount
|
1348
|
-
# Details to determine how long the discount should be applied for.
|
1349
|
-
attr_accessor :discount_end
|
1350
1173
|
# ID of the promotion code to create a new discount for.
|
1351
1174
|
attr_accessor :promotion_code
|
1352
1175
|
|
1353
|
-
def initialize(coupon: nil, discount: nil,
|
1176
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
1354
1177
|
@coupon = coupon
|
1355
1178
|
@discount = discount
|
1356
|
-
@discount_end = discount_end
|
1357
1179
|
@promotion_code = promotion_code
|
1358
1180
|
end
|
1359
1181
|
end
|
@@ -1399,18 +1221,8 @@ module Stripe
|
|
1399
1221
|
@unit_amount_decimal = unit_amount_decimal
|
1400
1222
|
end
|
1401
1223
|
end
|
1402
|
-
|
1403
|
-
|
1404
|
-
# 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.
|
1405
|
-
attr_accessor :converts_to
|
1406
|
-
# Determines the type of trial for this item.
|
1407
|
-
attr_accessor :type
|
1408
|
-
|
1409
|
-
def initialize(converts_to: nil, type: nil)
|
1410
|
-
@converts_to = converts_to
|
1411
|
-
@type = type
|
1412
|
-
end
|
1413
|
-
end
|
1224
|
+
# 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.
|
1225
|
+
attr_accessor :billing_thresholds
|
1414
1226
|
# The coupons to redeem into discounts for the subscription item.
|
1415
1227
|
attr_accessor :discounts
|
1416
1228
|
# 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`.
|
@@ -1425,19 +1237,18 @@ module Stripe
|
|
1425
1237
|
attr_accessor :quantity
|
1426
1238
|
# 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.
|
1427
1239
|
attr_accessor :tax_rates
|
1428
|
-
# Define options to configure the trial on the subscription item.
|
1429
|
-
attr_accessor :trial
|
1430
1240
|
|
1431
1241
|
def initialize(
|
1242
|
+
billing_thresholds: nil,
|
1432
1243
|
discounts: nil,
|
1433
1244
|
metadata: nil,
|
1434
1245
|
plan: nil,
|
1435
1246
|
price: nil,
|
1436
1247
|
price_data: nil,
|
1437
1248
|
quantity: nil,
|
1438
|
-
tax_rates: nil
|
1439
|
-
trial: nil
|
1249
|
+
tax_rates: nil
|
1440
1250
|
)
|
1251
|
+
@billing_thresholds = billing_thresholds
|
1441
1252
|
@discounts = discounts
|
1442
1253
|
@metadata = metadata
|
1443
1254
|
@plan = plan
|
@@ -1445,7 +1256,6 @@ module Stripe
|
|
1445
1256
|
@price_data = price_data
|
1446
1257
|
@quantity = quantity
|
1447
1258
|
@tax_rates = tax_rates
|
1448
|
-
@trial = trial
|
1449
1259
|
end
|
1450
1260
|
end
|
1451
1261
|
|
@@ -1540,26 +1350,17 @@ module Stripe
|
|
1540
1350
|
end
|
1541
1351
|
end
|
1542
1352
|
|
1543
|
-
class
|
1544
|
-
end
|
1545
|
-
|
1546
|
-
class Konbini < Stripe::RequestParams
|
1547
|
-
end
|
1548
|
-
|
1549
|
-
class SepaDebit < Stripe::RequestParams
|
1550
|
-
end
|
1353
|
+
class Konbini < Stripe::RequestParams; end
|
1354
|
+
class SepaDebit < Stripe::RequestParams; end
|
1551
1355
|
|
1552
1356
|
class UsBankAccount < Stripe::RequestParams
|
1553
1357
|
class FinancialConnections < Stripe::RequestParams
|
1554
1358
|
class Filters < Stripe::RequestParams
|
1555
1359
|
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
1556
1360
|
attr_accessor :account_subcategories
|
1557
|
-
# ID of the institution to use to filter for selectable accounts.
|
1558
|
-
attr_accessor :institution
|
1559
1361
|
|
1560
|
-
def initialize(account_subcategories: nil
|
1362
|
+
def initialize(account_subcategories: nil)
|
1561
1363
|
@account_subcategories = account_subcategories
|
1562
|
-
@institution = institution
|
1563
1364
|
end
|
1564
1365
|
end
|
1565
1366
|
# Provide filters for the linked accounts that the customer can select for the payment method.
|
@@ -1593,8 +1394,6 @@ module Stripe
|
|
1593
1394
|
attr_accessor :card
|
1594
1395
|
# This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
|
1595
1396
|
attr_accessor :customer_balance
|
1596
|
-
# This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
|
1597
|
-
attr_accessor :id_bank_transfer
|
1598
1397
|
# This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
|
1599
1398
|
attr_accessor :konbini
|
1600
1399
|
# This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
|
@@ -1607,7 +1406,6 @@ module Stripe
|
|
1607
1406
|
bancontact: nil,
|
1608
1407
|
card: nil,
|
1609
1408
|
customer_balance: nil,
|
1610
|
-
id_bank_transfer: nil,
|
1611
1409
|
konbini: nil,
|
1612
1410
|
sepa_debit: nil,
|
1613
1411
|
us_bank_account: nil
|
@@ -1616,7 +1414,6 @@ module Stripe
|
|
1616
1414
|
@bancontact = bancontact
|
1617
1415
|
@card = card
|
1618
1416
|
@customer_balance = customer_balance
|
1619
|
-
@id_bank_transfer = id_bank_transfer
|
1620
1417
|
@konbini = konbini
|
1621
1418
|
@sepa_debit = sepa_debit
|
1622
1419
|
@us_bank_account = us_bank_account
|
@@ -1652,18 +1449,6 @@ module Stripe
|
|
1652
1449
|
end
|
1653
1450
|
end
|
1654
1451
|
|
1655
|
-
class Prebilling < Stripe::RequestParams
|
1656
|
-
# This is used to determine the number of billing cycles to prebill.
|
1657
|
-
attr_accessor :iterations
|
1658
|
-
# Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
|
1659
|
-
attr_accessor :update_behavior
|
1660
|
-
|
1661
|
-
def initialize(iterations: nil, update_behavior: nil)
|
1662
|
-
@iterations = iterations
|
1663
|
-
@update_behavior = update_behavior
|
1664
|
-
end
|
1665
|
-
end
|
1666
|
-
|
1667
1452
|
class TransferData < Stripe::RequestParams
|
1668
1453
|
# 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.
|
1669
1454
|
attr_accessor :amount_percent
|
@@ -1704,11 +1489,11 @@ module Stripe
|
|
1704
1489
|
attr_accessor :billing_cycle_anchor
|
1705
1490
|
# Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC.
|
1706
1491
|
attr_accessor :billing_cycle_anchor_config
|
1707
|
-
#
|
1708
|
-
attr_accessor :
|
1492
|
+
# 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.
|
1493
|
+
attr_accessor :billing_thresholds
|
1709
1494
|
# A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
|
1710
1495
|
attr_accessor :cancel_at
|
1711
|
-
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
|
1496
|
+
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
|
1712
1497
|
attr_accessor :cancel_at_period_end
|
1713
1498
|
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.
|
1714
1499
|
attr_accessor :collection_method
|
@@ -1716,8 +1501,6 @@ module Stripe
|
|
1716
1501
|
attr_accessor :currency
|
1717
1502
|
# The identifier of the customer to subscribe.
|
1718
1503
|
attr_accessor :customer
|
1719
|
-
# The identifier of the account to subscribe.
|
1720
|
-
attr_accessor :customer_account
|
1721
1504
|
# Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
|
1722
1505
|
attr_accessor :days_until_due
|
1723
1506
|
# ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
|
@@ -1758,8 +1541,6 @@ module Stripe
|
|
1758
1541
|
attr_accessor :payment_settings
|
1759
1542
|
# Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
|
1760
1543
|
attr_accessor :pending_invoice_item_interval
|
1761
|
-
# If specified, the invoicing for the given billing cycle iterations will be processed now.
|
1762
|
-
attr_accessor :prebilling
|
1763
1544
|
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
|
1764
1545
|
attr_accessor :proration_behavior
|
1765
1546
|
# If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
|
@@ -1780,13 +1561,12 @@ module Stripe
|
|
1780
1561
|
backdate_start_date: nil,
|
1781
1562
|
billing_cycle_anchor: nil,
|
1782
1563
|
billing_cycle_anchor_config: nil,
|
1783
|
-
|
1564
|
+
billing_thresholds: nil,
|
1784
1565
|
cancel_at: nil,
|
1785
1566
|
cancel_at_period_end: nil,
|
1786
1567
|
collection_method: nil,
|
1787
1568
|
currency: nil,
|
1788
1569
|
customer: nil,
|
1789
|
-
customer_account: nil,
|
1790
1570
|
days_until_due: nil,
|
1791
1571
|
default_payment_method: nil,
|
1792
1572
|
default_source: nil,
|
@@ -1802,7 +1582,6 @@ module Stripe
|
|
1802
1582
|
payment_behavior: nil,
|
1803
1583
|
payment_settings: nil,
|
1804
1584
|
pending_invoice_item_interval: nil,
|
1805
|
-
prebilling: nil,
|
1806
1585
|
proration_behavior: nil,
|
1807
1586
|
transfer_data: nil,
|
1808
1587
|
trial_end: nil,
|
@@ -1816,13 +1595,12 @@ module Stripe
|
|
1816
1595
|
@backdate_start_date = backdate_start_date
|
1817
1596
|
@billing_cycle_anchor = billing_cycle_anchor
|
1818
1597
|
@billing_cycle_anchor_config = billing_cycle_anchor_config
|
1819
|
-
@
|
1598
|
+
@billing_thresholds = billing_thresholds
|
1820
1599
|
@cancel_at = cancel_at
|
1821
1600
|
@cancel_at_period_end = cancel_at_period_end
|
1822
1601
|
@collection_method = collection_method
|
1823
1602
|
@currency = currency
|
1824
1603
|
@customer = customer
|
1825
|
-
@customer_account = customer_account
|
1826
1604
|
@days_until_due = days_until_due
|
1827
1605
|
@default_payment_method = default_payment_method
|
1828
1606
|
@default_source = default_source
|
@@ -1838,7 +1616,6 @@ module Stripe
|
|
1838
1616
|
@payment_behavior = payment_behavior
|
1839
1617
|
@payment_settings = payment_settings
|
1840
1618
|
@pending_invoice_item_interval = pending_invoice_item_interval
|
1841
|
-
@prebilling = prebilling
|
1842
1619
|
@proration_behavior = proration_behavior
|
1843
1620
|
@transfer_data = transfer_data
|
1844
1621
|
@trial_end = trial_end
|
@@ -1871,9 +1648,9 @@ module Stripe
|
|
1871
1648
|
attr_accessor :billing_cycle_anchor
|
1872
1649
|
# Specifies which fields in the response should be expanded.
|
1873
1650
|
attr_accessor :expand
|
1874
|
-
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations)
|
1651
|
+
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`.
|
1875
1652
|
attr_accessor :proration_behavior
|
1876
|
-
# If set,
|
1653
|
+
# If set, prorations will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint.
|
1877
1654
|
attr_accessor :proration_date
|
1878
1655
|
|
1879
1656
|
def initialize(
|
@@ -1898,11 +1675,11 @@ module Stripe
|
|
1898
1675
|
attr_reader :billing_cycle_anchor
|
1899
1676
|
# The fixed values used to calculate the `billing_cycle_anchor`.
|
1900
1677
|
attr_reader :billing_cycle_anchor_config
|
1901
|
-
#
|
1902
|
-
attr_reader :
|
1678
|
+
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
|
1679
|
+
attr_reader :billing_thresholds
|
1903
1680
|
# A date in the future at which the subscription will automatically get canceled
|
1904
1681
|
attr_reader :cancel_at
|
1905
|
-
# Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.
|
1682
|
+
# Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. This field will be removed in a future API version. Please use `cancel_at` instead.
|
1906
1683
|
attr_reader :cancel_at_period_end
|
1907
1684
|
# If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
|
1908
1685
|
attr_reader :canceled_at
|
@@ -1916,8 +1693,6 @@ module Stripe
|
|
1916
1693
|
attr_reader :currency
|
1917
1694
|
# ID of the customer who owns the subscription.
|
1918
1695
|
attr_reader :customer
|
1919
|
-
# ID of the account who owns the subscription.
|
1920
|
-
attr_reader :customer_account
|
1921
1696
|
# Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.
|
1922
1697
|
attr_reader :days_until_due
|
1923
1698
|
# ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
|
@@ -1938,8 +1713,6 @@ module Stripe
|
|
1938
1713
|
attr_reader :invoice_settings
|
1939
1714
|
# List of subscription items, each with an attached price.
|
1940
1715
|
attr_reader :items
|
1941
|
-
# Details of the most recent price migration that failed for the subscription.
|
1942
|
-
attr_reader :last_price_migration_error
|
1943
1716
|
# The most recent invoice this subscription has generated.
|
1944
1717
|
attr_reader :latest_invoice
|
1945
1718
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
@@ -1962,8 +1735,6 @@ module Stripe
|
|
1962
1735
|
attr_reader :pending_setup_intent
|
1963
1736
|
# If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.
|
1964
1737
|
attr_reader :pending_update
|
1965
|
-
# Time period and invoice for a Subscription billed in advance.
|
1966
|
-
attr_reader :prebilling
|
1967
1738
|
# The schedule attached to the subscription
|
1968
1739
|
attr_reader :schedule
|
1969
1740
|
# Date when the subscription was first created. The date might differ from the `created` date due to backdating.
|
@@ -1988,12 +1759,12 @@ module Stripe
|
|
1988
1759
|
attr_reader :trial_end
|
1989
1760
|
# Settings related to subscription trials.
|
1990
1761
|
attr_reader :trial_settings
|
1991
|
-
# If the subscription has a trial, the beginning of that trial.
|
1762
|
+
# If the subscription has a trial, the beginning of that trial. For subsequent trials, this date remains as the start of the first ever trial on the subscription.
|
1992
1763
|
attr_reader :trial_start
|
1993
1764
|
|
1994
|
-
# Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://stripe.com/metadata).
|
1765
|
+
# Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata).
|
1995
1766
|
#
|
1996
|
-
# Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://stripe.com/
|
1767
|
+
# Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://docs.stripe.com/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true.
|
1997
1768
|
#
|
1998
1769
|
# By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
|
1999
1770
|
def cancel(params = {}, opts = {})
|
@@ -2005,9 +1776,9 @@ module Stripe
|
|
2005
1776
|
)
|
2006
1777
|
end
|
2007
1778
|
|
2008
|
-
# Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://stripe.com/metadata).
|
1779
|
+
# Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata).
|
2009
1780
|
#
|
2010
|
-
# Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://stripe.com/
|
1781
|
+
# Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://docs.stripe.com/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true.
|
2011
1782
|
#
|
2012
1783
|
# By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
|
2013
1784
|
def self.cancel(subscription_exposed_id, params = {}, opts = {})
|
@@ -2024,7 +1795,7 @@ module Stripe
|
|
2024
1795
|
# When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request.
|
2025
1796
|
# The payment_behavior parameter determines the exact behavior of the initial payment.
|
2026
1797
|
#
|
2027
|
-
# To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead.
|
1798
|
+
# To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://docs.stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead.
|
2028
1799
|
# Schedules provide the flexibility to model more complex billing configurations that change over time.
|
2029
1800
|
def self.create(params = {}, opts = {})
|
2030
1801
|
request_stripe_object(method: :post, path: "/v1/subscriptions", params: params, opts: opts)
|
@@ -2090,7 +1861,7 @@ module Stripe
|
|
2090
1861
|
|
2091
1862
|
# Updates an existing subscription to match the specified parameters.
|
2092
1863
|
# When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.
|
2093
|
-
# To preview how the proration is calculated, use the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint.
|
1864
|
+
# To preview how the proration is calculated, use the [create preview](https://docs.stripe.com/docs/api/invoices/create_preview) endpoint.
|
2094
1865
|
#
|
2095
1866
|
# By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they'll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they'll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month's 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.
|
2096
1867
|
#
|
@@ -2102,13 +1873,13 @@ module Stripe
|
|
2102
1873
|
# A trial starts or ends.
|
2103
1874
|
#
|
2104
1875
|
#
|
2105
|
-
# In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://stripe.com/docs/billing/subscriptions/upgrade-downgrade#immediate-payment).
|
1876
|
+
# In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://docs.stripe.com/docs/billing/subscriptions/upgrade-downgrade#immediate-payment).
|
2106
1877
|
#
|
2107
|
-
# If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://stripe.com/docs/api/invoices/create).
|
1878
|
+
# If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://docs.stripe.com/docs/api/invoices/create).
|
2108
1879
|
#
|
2109
1880
|
# If you don't want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don't generate any credits for the old subscription's unused time. We still reset the billing date and bill immediately for the new subscription.
|
2110
1881
|
#
|
2111
|
-
# Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating <a href="/docs/billing/subscriptions/usage-based">usage-based billing](https://stripe.com/docs/rate-limits) instead.
|
1882
|
+
# Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating <a href="/docs/billing/subscriptions/usage-based">usage-based billing](https://docs.stripe.com/docs/rate-limits) instead.
|
2112
1883
|
def self.update(subscription_exposed_id, params = {}, opts = {})
|
2113
1884
|
request_stripe_object(
|
2114
1885
|
method: :post,
|