stripe 15.5.0.pre.beta.2 → 15.5.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/API_VERSION +1 -1
- data/CHANGELOG.md +680 -1639
- data/OPENAPI_VERSION +1 -1
- data/README.md +6 -4
- data/VERSION +1 -1
- data/lib/stripe/api_requestor.rb +0 -32
- data/lib/stripe/api_version.rb +2 -1
- data/lib/stripe/errors.rb +0 -60
- data/lib/stripe/event_types.rb +0 -102
- data/lib/stripe/object_types.rb +0 -53
- data/lib/stripe/resources/account.rb +3 -655
- data/lib/stripe/resources/account_session.rb +76 -250
- data/lib/stripe/resources/balance.rb +2 -7
- 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/meter.rb +2 -2
- data/lib/stripe/resources/billing_portal/configuration.rb +12 -2
- data/lib/stripe/resources/billing_portal/session.rb +0 -6
- data/lib/stripe/resources/card.rb +0 -2
- data/lib/stripe/resources/cash_balance.rb +0 -2
- data/lib/stripe/resources/charge.rb +38 -1543
- data/lib/stripe/resources/checkout/session.rb +16 -403
- data/lib/stripe/resources/confirmation_token.rb +0 -170
- data/lib/stripe/resources/coupon.rb +1 -30
- data/lib/stripe/resources/credit_note.rb +3 -9
- data/lib/stripe/resources/credit_note_line_item.rb +0 -9
- data/lib/stripe/resources/customer.rb +0 -2
- 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 +1 -6
- data/lib/stripe/resources/discount.rb +0 -2
- data/lib/stripe/resources/dispute.rb +1 -12
- data/lib/stripe/resources/event.rb +0 -31
- data/lib/stripe/resources/file.rb +1 -1
- data/lib/stripe/resources/file_link.rb +1 -1
- data/lib/stripe/resources/financial_connections/account.rb +1 -22
- data/lib/stripe/resources/financial_connections/session.rb +2 -62
- data/lib/stripe/resources/identity/verification_session.rb +0 -10
- data/lib/stripe/resources/invoice.rb +55 -1136
- data/lib/stripe/resources/invoice_item.rb +2 -78
- data/lib/stripe/resources/invoice_line_item.rb +1 -55
- data/lib/stripe/resources/invoice_payment.rb +1 -6
- data/lib/stripe/resources/issuing/card.rb +8 -0
- data/lib/stripe/resources/issuing/cardholder.rb +1 -2
- 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 +401 -6126
- data/lib/stripe/resources/payment_link.rb +1 -1
- data/lib/stripe/resources/payment_method.rb +1 -192
- data/lib/stripe/resources/payment_method_configuration.rb +0 -295
- data/lib/stripe/resources/price.rb +0 -30
- data/lib/stripe/resources/promotion_code.rb +5 -12
- data/lib/stripe/resources/quote.rb +7 -2038
- data/lib/stripe/resources/refund.rb +0 -9
- data/lib/stripe/resources/setup_attempt.rb +1 -22
- data/lib/stripe/resources/setup_intent.rb +10 -579
- data/lib/stripe/resources/source.rb +0 -29
- data/lib/stripe/resources/subscription.rb +116 -374
- data/lib/stripe/resources/subscription_item.rb +3 -84
- data/lib/stripe/resources/subscription_schedule.rb +134 -1009
- data/lib/stripe/resources/tax_id.rb +2 -12
- data/lib/stripe/resources/terminal/configuration.rb +49 -0
- data/lib/stripe/resources/terminal/reader.rb +22 -8
- data/lib/stripe/resources/transfer.rb +0 -6
- 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.rb +0 -109
- data/lib/stripe/services/account_service.rb +1 -562
- data/lib/stripe/services/account_session_service.rb +46 -220
- 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/meter_service.rb +1 -1
- data/lib/stripe/services/billing_portal/configuration_service.rb +10 -2
- data/lib/stripe/services/billing_portal/session_service.rb +0 -4
- data/lib/stripe/services/billing_service.rb +1 -2
- data/lib/stripe/services/charge_service.rb +0 -1418
- data/lib/stripe/services/checkout/session_service.rb +13 -319
- data/lib/stripe/services/coupon_service.rb +1 -17
- data/lib/stripe/services/credit_note_preview_lines_service.rb +1 -1
- data/lib/stripe/services/credit_note_service.rb +2 -6
- data/lib/stripe/services/customer_service.rb +4 -4
- data/lib/stripe/services/customer_session_service.rb +1 -4
- data/lib/stripe/services/file_link_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 +0 -8
- data/lib/stripe/services/invoice_item_service.rb +2 -74
- data/lib/stripe/services/invoice_line_item_service.rb +1 -33
- data/lib/stripe/services/invoice_payment_service.rb +1 -4
- data/lib/stripe/services/invoice_service.rb +54 -1069
- data/lib/stripe/services/issuing/card_service.rb +8 -0
- data/lib/stripe/services/issuing/cardholder_service.rb +1 -2
- data/lib/stripe/services/issuing/transaction_service.rb +0 -4
- data/lib/stripe/services/issuing_service.rb +1 -5
- data/lib/stripe/services/payment_intent_service.rb +351 -5612
- data/lib/stripe/services/payment_link_service.rb +1 -1
- data/lib/stripe/services/payment_method_configuration_service.rb +0 -210
- data/lib/stripe/services/payment_method_service.rb +1 -120
- data/lib/stripe/services/price_service.rb +0 -19
- data/lib/stripe/services/promotion_code_service.rb +0 -8
- data/lib/stripe/services/quote_service.rb +9 -1724
- data/lib/stripe/services/setup_intent_service.rb +9 -538
- data/lib/stripe/services/subscription_item_service.rb +3 -75
- data/lib/stripe/services/subscription_schedule_service.rb +110 -913
- data/lib/stripe/services/subscription_service.rb +116 -318
- data/lib/stripe/services/tax_id_service.rb +2 -8
- data/lib/stripe/services/tax_service.rb +1 -3
- data/lib/stripe/services/terminal/configuration_service.rb +38 -0
- data/lib/stripe/services/terminal_service.rb +1 -3
- data/lib/stripe/services/test_helpers/confirmation_token_service.rb +0 -97
- data/lib/stripe/services/test_helpers/terminal/reader_service.rb +22 -0
- 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/transfer_service.rb +0 -4
- 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 +4 -14
- data/lib/stripe/services/v2/billing_service.rb +2 -2
- data/lib/stripe/services/v2/core_service.rb +2 -5
- data/lib/stripe/services/v2_services.rb +1 -4
- data/lib/stripe/services.rb +0 -55
- data/lib/stripe/stripe_configuration.rb +1 -3
- data/lib/stripe/stripe_object.rb +1 -1
- data/lib/stripe/stripe_service.rb +3 -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 +4991 -0
- data/rbi/stripe/resources/account_link.rbi +76 -0
- data/rbi/stripe/resources/account_session.rbi +1173 -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 +230 -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 +712 -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 +2136 -0
- data/rbi/stripe/resources/checkout/session.rbi +4105 -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 +1818 -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 +993 -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 +137 -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 +564 -0
- data/rbi/stripe/resources/invoice.rbi +3894 -0
- data/rbi/stripe/resources/invoice_item.rbi +470 -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 +749 -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 +191 -0
- data/rbi/stripe/resources/payment_intent.rbi +10011 -0
- data/rbi/stripe/resources/payment_link.rbi +1891 -0
- data/rbi/stripe/resources/payment_method.rbi +1770 -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 +307 -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 +553 -0
- data/rbi/stripe/resources/product_feature.rbi +26 -0
- data/rbi/stripe/resources/promotion_code.rbi +264 -0
- data/rbi/stripe/resources/quote.rbi +1137 -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 +3974 -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 +2154 -0
- data/rbi/stripe/resources/subscription_item.rbi +404 -0
- data/rbi/stripe/resources/subscription_schedule.rbi +1795 -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 +3216 -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 +1647 -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 +1016 -0
- data/rbi/stripe/resources/test_helpers/test_clock.rbi +132 -0
- data/rbi/stripe/resources/token.rbi +1281 -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 +869 -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} +122 -135
- data/rbi/stripe/services/account_link_service.rbi +60 -0
- data/rbi/stripe/services/account_login_link_service.rbi +22 -0
- data/rbi/stripe/services/account_person_service.rbi +1007 -0
- data/rbi/stripe/services/account_service.rbi +4281 -0
- data/rbi/stripe/services/account_session_service.rbi +748 -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 +561 -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 +2697 -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 +635 -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 +339 -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 +3073 -0
- data/rbi/stripe/services/issuing/authorization_service.rbi +146 -0
- data/rbi/stripe/services/issuing/card_service.rbi +503 -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 +8010 -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 +1441 -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 +781 -0
- data/rbi/stripe/services/payout_service.rbi +209 -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 +695 -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 +3709 -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 +1425 -0
- data/rbi/stripe/services/subscription_service.rbi +1768 -0
- data/{lib/stripe/services/privacy/redaction_job_validation_error_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 +2278 -0
- data/rbi/stripe/services/tax/settings_service.rbi +93 -0
- data/{lib/stripe/services/financial_connections/account_inferred_balance_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 +1328 -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 +540 -0
- data/rbi/stripe/services/terminal_service.rbi +12 -0
- data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +746 -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 +117 -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 +1255 -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 +566 -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 +324 -169
- 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_configuration_storer_capability_status_updated_event.rb +0 -23
- data/lib/stripe/events/v2_core_account_including_configuration_storer_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_returned_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_payout_method_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/events/v2_payments_off_session_payment_authorization_attempt_failed_event.rb +0 -21
- data/lib/stripe/events/v2_payments_off_session_payment_authorization_attempt_started_event.rb +0 -22
- data/lib/stripe/events/v2_payments_off_session_payment_canceled_event.rb +0 -21
- data/lib/stripe/events/v2_payments_off_session_payment_created_event.rb +0 -21
- data/lib/stripe/events/v2_payments_off_session_payment_failed_event.rb +0 -21
- data/lib/stripe/events/v2_payments_off_session_payment_succeeded_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_usage.rb +0 -23
- data/lib/stripe/resources/billing/meter_usage_row.rb +0 -28
- 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 -92
- data/lib/stripe/resources/fx_quote.rb +0 -186
- 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 -2958
- data/lib/stripe/resources/payment_attempt_record.rb +0 -1101
- data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +0 -72
- data/lib/stripe/resources/payment_record.rb +0 -1630
- data/lib/stripe/resources/privacy/redaction_job.rb +0 -298
- data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +0 -33
- data/lib/stripe/resources/quote_line.rb +0 -274
- data/lib/stripe/resources/quote_preview_invoice.rb +0 -680
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -371
- data/lib/stripe/resources/tax/association.rb +0 -66
- data/lib/stripe/resources/tax/form.rb +0 -211
- data/lib/stripe/resources/terminal/onboarding_link.rb +0 -84
- data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -31
- data/lib/stripe/resources/v2/core/account.rb +0 -1930
- data/lib/stripe/resources/v2/core/account_link.rb +0 -72
- 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 -77
- 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 -77
- 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 -122
- data/lib/stripe/resources/v2/money_management/received_debit.rb +0 -84
- 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/resources/v2/payments/off_session_payment.rb +0 -89
- data/lib/stripe/services/account_notice_service.rb +0 -101
- data/lib/stripe/services/balance_settings_service.rb +0 -96
- data/lib/stripe/services/billing/meter_usage_service.rb +0 -76
- 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/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 -2388
- 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 -240
- 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/onboarding_link_service.rb +0 -56
- data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -28
- data/lib/stripe/services/v2/core/account_link_service.rb +0 -114
- data/lib/stripe/services/v2/core/account_service.rb +0 -4522
- data/lib/stripe/services/v2/core/accounts/person_service.rb +0 -1045
- data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +0 -130
- data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +0 -107
- data/lib/stripe/services/v2/core/vault_service.rb +0 -18
- data/lib/stripe/services/v2/money_management/adjustment_service.rb +0 -74
- data/lib/stripe/services/v2/money_management/financial_account_service.rb +0 -116
- data/lib/stripe/services/v2/money_management/financial_address_service.rb +0 -82
- data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +0 -125
- data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +0 -95
- data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +0 -199
- data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +0 -235
- data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +0 -172
- data/lib/stripe/services/v2/money_management/payout_method_service.rb +0 -90
- 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 -70
- data/lib/stripe/services/v2/money_management/received_debit_service.rb +0 -43
- data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +0 -69
- data/lib/stripe/services/v2/money_management/transaction_service.rb +0 -73
- data/lib/stripe/services/v2/money_management_service.rb +0 -31
- data/lib/stripe/services/v2/payment_service.rb +0 -15
- data/lib/stripe/services/v2/payments/off_session_payment_service.rb +0 -152
- data/lib/stripe/services/v2/test_helper_service.rb +0 -15
- data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +0 -53
- data/rbi/stripe.rbi +0 -199145
@@ -49,25 +49,6 @@ module Stripe
|
|
49
49
|
|
50
50
|
nested_resource_class_methods :line, operations: %i[list]
|
51
51
|
|
52
|
-
class AmountsDue < Stripe::StripeObject
|
53
|
-
# Incremental amount due for this payment in cents (or local equivalent).
|
54
|
-
attr_reader :amount
|
55
|
-
# The amount in cents (or local equivalent) that was paid for this payment.
|
56
|
-
attr_reader :amount_paid
|
57
|
-
# The difference between the payment’s amount and amount_paid, in cents (or local equivalent).
|
58
|
-
attr_reader :amount_remaining
|
59
|
-
# Number of days from when invoice is finalized until the payment is due.
|
60
|
-
attr_reader :days_until_due
|
61
|
-
# An arbitrary string attached to the object. Often useful for displaying to users.
|
62
|
-
attr_reader :description
|
63
|
-
# Date on which a payment plan’s payment is due.
|
64
|
-
attr_reader :due_date
|
65
|
-
# Timestamp when the payment was paid.
|
66
|
-
attr_reader :paid_at
|
67
|
-
# The status of the payment, one of `open`, `paid`, or `past_due`
|
68
|
-
attr_reader :status
|
69
|
-
end
|
70
|
-
|
71
52
|
class AutomaticTax < Stripe::StripeObject
|
72
53
|
class Liability < Stripe::StripeObject
|
73
54
|
# The connected account being referenced when `type` is `account`.
|
@@ -179,7 +160,7 @@ module Stripe
|
|
179
160
|
attr_reader :message
|
180
161
|
# For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
|
181
162
|
attr_reader :network_advice_code
|
182
|
-
# For
|
163
|
+
# For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
|
183
164
|
attr_reader :network_decline_code
|
184
165
|
# If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
|
185
166
|
attr_reader :param
|
@@ -240,17 +221,9 @@ module Stripe
|
|
240
221
|
end
|
241
222
|
|
242
223
|
class SubscriptionDetails < Stripe::StripeObject
|
243
|
-
class PauseCollection < Stripe::StripeObject
|
244
|
-
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
245
|
-
attr_reader :behavior
|
246
|
-
# The time after which the subscription will resume collecting payments.
|
247
|
-
attr_reader :resumes_at
|
248
|
-
end
|
249
224
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.
|
250
225
|
# *Note: This attribute is populated only for invoices created on or after June 29, 2023.*
|
251
226
|
attr_reader :metadata
|
252
|
-
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
|
253
|
-
attr_reader :pause_collection
|
254
227
|
# The subscription that generated this invoice
|
255
228
|
attr_reader :subscription
|
256
229
|
# Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
|
@@ -310,32 +283,14 @@ module Stripe
|
|
310
283
|
attr_reader :funding_type
|
311
284
|
end
|
312
285
|
|
313
|
-
class IdBankTransfer < Stripe::StripeObject; end
|
314
286
|
class Konbini < Stripe::StripeObject; end
|
315
287
|
class SepaDebit < Stripe::StripeObject; end
|
316
288
|
|
317
|
-
class Upi < Stripe::StripeObject
|
318
|
-
class MandateOptions < Stripe::StripeObject
|
319
|
-
# Amount to be charged for future payments.
|
320
|
-
attr_reader :amount
|
321
|
-
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
|
322
|
-
attr_reader :amount_type
|
323
|
-
# A description of the mandate or subscription that is meant to be displayed to the customer.
|
324
|
-
attr_reader :description
|
325
|
-
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
|
326
|
-
attr_reader :end_date
|
327
|
-
end
|
328
|
-
# Attribute for field mandate_options
|
329
|
-
attr_reader :mandate_options
|
330
|
-
end
|
331
|
-
|
332
289
|
class UsBankAccount < Stripe::StripeObject
|
333
290
|
class FinancialConnections < Stripe::StripeObject
|
334
291
|
class Filters < Stripe::StripeObject
|
335
292
|
# The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
|
336
293
|
attr_reader :account_subcategories
|
337
|
-
# The institution to use to filter for possible accounts to link.
|
338
|
-
attr_reader :institution
|
339
294
|
end
|
340
295
|
# Attribute for field filters
|
341
296
|
attr_reader :filters
|
@@ -357,14 +312,10 @@ module Stripe
|
|
357
312
|
attr_reader :card
|
358
313
|
# If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
|
359
314
|
attr_reader :customer_balance
|
360
|
-
# If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
|
361
|
-
attr_reader :id_bank_transfer
|
362
315
|
# If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
|
363
316
|
attr_reader :konbini
|
364
317
|
# If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
|
365
318
|
attr_reader :sepa_debit
|
366
|
-
# If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
|
367
|
-
attr_reader :upi
|
368
319
|
# If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
|
369
320
|
attr_reader :us_bank_account
|
370
321
|
end
|
@@ -474,13 +425,6 @@ module Stripe
|
|
474
425
|
attr_reader :discount
|
475
426
|
end
|
476
427
|
|
477
|
-
class TotalMarginAmount < Stripe::StripeObject
|
478
|
-
# The amount, in cents (or local equivalent), of the reduction in line item amount.
|
479
|
-
attr_reader :amount
|
480
|
-
# The margin that was applied to get this margin amount.
|
481
|
-
attr_reader :margin
|
482
|
-
end
|
483
|
-
|
484
428
|
class TotalPretaxCreditAmount < Stripe::StripeObject
|
485
429
|
# The amount, in cents (or local equivalent), of the pretax credit amount.
|
486
430
|
attr_reader :amount
|
@@ -488,8 +432,6 @@ module Stripe
|
|
488
432
|
attr_reader :credit_balance_transaction
|
489
433
|
# The discount that was applied to get this pretax credit amount.
|
490
434
|
attr_reader :discount
|
491
|
-
# The margin that was applied to get this pretax credit amount.
|
492
|
-
attr_reader :margin
|
493
435
|
# Type of the pretax credit amount referenced.
|
494
436
|
attr_reader :type
|
495
437
|
end
|
@@ -516,24 +458,6 @@ module Stripe
|
|
516
458
|
class DeleteParams < Stripe::RequestParams; end
|
517
459
|
|
518
460
|
class UpdateParams < Stripe::RequestParams
|
519
|
-
class AmountsDue < Stripe::RequestParams
|
520
|
-
# The amount in cents (or local equivalent).
|
521
|
-
attr_accessor :amount
|
522
|
-
# Number of days from when invoice is finalized until the payment is due.
|
523
|
-
attr_accessor :days_until_due
|
524
|
-
# An arbitrary string attached to the object. Often useful for displaying to users.
|
525
|
-
attr_accessor :description
|
526
|
-
# Date on which a payment plan’s payment is due.
|
527
|
-
attr_accessor :due_date
|
528
|
-
|
529
|
-
def initialize(amount: nil, days_until_due: nil, description: nil, due_date: nil)
|
530
|
-
@amount = amount
|
531
|
-
@days_until_due = days_until_due
|
532
|
-
@description = description
|
533
|
-
@due_date = due_date
|
534
|
-
end
|
535
|
-
end
|
536
|
-
|
537
461
|
class AutomaticTax < Stripe::RequestParams
|
538
462
|
class Liability < Stripe::RequestParams
|
539
463
|
# The connected account being referenced when `type` is `account`.
|
@@ -570,44 +494,16 @@ module Stripe
|
|
570
494
|
end
|
571
495
|
|
572
496
|
class Discount < Stripe::RequestParams
|
573
|
-
class DiscountEnd < Stripe::RequestParams
|
574
|
-
class Duration < Stripe::RequestParams
|
575
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
576
|
-
attr_accessor :interval
|
577
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
578
|
-
attr_accessor :interval_count
|
579
|
-
|
580
|
-
def initialize(interval: nil, interval_count: nil)
|
581
|
-
@interval = interval
|
582
|
-
@interval_count = interval_count
|
583
|
-
end
|
584
|
-
end
|
585
|
-
# Time span for the redeemed discount.
|
586
|
-
attr_accessor :duration
|
587
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
588
|
-
attr_accessor :timestamp
|
589
|
-
# The type of calculation made to determine when the discount ends.
|
590
|
-
attr_accessor :type
|
591
|
-
|
592
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
593
|
-
@duration = duration
|
594
|
-
@timestamp = timestamp
|
595
|
-
@type = type
|
596
|
-
end
|
597
|
-
end
|
598
497
|
# ID of the coupon to create a new discount for.
|
599
498
|
attr_accessor :coupon
|
600
499
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
601
500
|
attr_accessor :discount
|
602
|
-
# Details to determine how long the discount should be applied for.
|
603
|
-
attr_accessor :discount_end
|
604
501
|
# ID of the promotion code to create a new discount for.
|
605
502
|
attr_accessor :promotion_code
|
606
503
|
|
607
|
-
def initialize(coupon: nil, discount: nil,
|
504
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
608
505
|
@coupon = coupon
|
609
506
|
@discount = discount
|
610
|
-
@discount_end = discount_end
|
611
507
|
@promotion_code = promotion_code
|
612
508
|
end
|
613
509
|
end
|
@@ -727,47 +623,17 @@ module Stripe
|
|
727
623
|
end
|
728
624
|
end
|
729
625
|
|
730
|
-
class IdBankTransfer < Stripe::RequestParams; end
|
731
626
|
class Konbini < Stripe::RequestParams; end
|
732
627
|
class SepaDebit < Stripe::RequestParams; end
|
733
628
|
|
734
|
-
class Upi < Stripe::RequestParams
|
735
|
-
class MandateOptions < Stripe::RequestParams
|
736
|
-
# Amount to be charged for future payments.
|
737
|
-
attr_accessor :amount
|
738
|
-
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
|
739
|
-
attr_accessor :amount_type
|
740
|
-
# A description of the mandate or subscription that is meant to be displayed to the customer.
|
741
|
-
attr_accessor :description
|
742
|
-
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
|
743
|
-
attr_accessor :end_date
|
744
|
-
|
745
|
-
def initialize(amount: nil, amount_type: nil, description: nil, end_date: nil)
|
746
|
-
@amount = amount
|
747
|
-
@amount_type = amount_type
|
748
|
-
@description = description
|
749
|
-
@end_date = end_date
|
750
|
-
end
|
751
|
-
end
|
752
|
-
# Configuration options for setting up an eMandate
|
753
|
-
attr_accessor :mandate_options
|
754
|
-
|
755
|
-
def initialize(mandate_options: nil)
|
756
|
-
@mandate_options = mandate_options
|
757
|
-
end
|
758
|
-
end
|
759
|
-
|
760
629
|
class UsBankAccount < Stripe::RequestParams
|
761
630
|
class FinancialConnections < Stripe::RequestParams
|
762
631
|
class Filters < Stripe::RequestParams
|
763
632
|
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
764
633
|
attr_accessor :account_subcategories
|
765
|
-
# ID of the institution to use to filter for selectable accounts.
|
766
|
-
attr_accessor :institution
|
767
634
|
|
768
|
-
def initialize(account_subcategories: nil
|
635
|
+
def initialize(account_subcategories: nil)
|
769
636
|
@account_subcategories = account_subcategories
|
770
|
-
@institution = institution
|
771
637
|
end
|
772
638
|
end
|
773
639
|
# Provide filters for the linked accounts that the customer can select for the payment method.
|
@@ -801,14 +667,10 @@ module Stripe
|
|
801
667
|
attr_accessor :card
|
802
668
|
# If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
|
803
669
|
attr_accessor :customer_balance
|
804
|
-
# If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
|
805
|
-
attr_accessor :id_bank_transfer
|
806
670
|
# If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
|
807
671
|
attr_accessor :konbini
|
808
672
|
# If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
|
809
673
|
attr_accessor :sepa_debit
|
810
|
-
# If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
|
811
|
-
attr_accessor :upi
|
812
674
|
# If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
|
813
675
|
attr_accessor :us_bank_account
|
814
676
|
|
@@ -817,20 +679,16 @@ module Stripe
|
|
817
679
|
bancontact: nil,
|
818
680
|
card: nil,
|
819
681
|
customer_balance: nil,
|
820
|
-
id_bank_transfer: nil,
|
821
682
|
konbini: nil,
|
822
683
|
sepa_debit: nil,
|
823
|
-
upi: nil,
|
824
684
|
us_bank_account: nil
|
825
685
|
)
|
826
686
|
@acss_debit = acss_debit
|
827
687
|
@bancontact = bancontact
|
828
688
|
@card = card
|
829
689
|
@customer_balance = customer_balance
|
830
|
-
@id_bank_transfer = id_bank_transfer
|
831
690
|
@konbini = konbini
|
832
691
|
@sepa_debit = sepa_debit
|
833
|
-
@upi = upi
|
834
692
|
@us_bank_account = us_bank_account
|
835
693
|
end
|
836
694
|
end
|
@@ -1040,8 +898,6 @@ module Stripe
|
|
1040
898
|
end
|
1041
899
|
# The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
|
1042
900
|
attr_accessor :account_tax_ids
|
1043
|
-
# List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
|
1044
|
-
attr_accessor :amounts_due
|
1045
901
|
# A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).
|
1046
902
|
attr_accessor :application_fee_amount
|
1047
903
|
# Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice.
|
@@ -1056,8 +912,6 @@ module Stripe
|
|
1056
912
|
attr_accessor :custom_fields
|
1057
913
|
# The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.
|
1058
914
|
attr_accessor :days_until_due
|
1059
|
-
# The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
|
1060
|
-
attr_accessor :default_margins
|
1061
915
|
# ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
|
1062
916
|
attr_accessor :default_payment_method
|
1063
917
|
# ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
|
@@ -1099,7 +953,6 @@ module Stripe
|
|
1099
953
|
|
1100
954
|
def initialize(
|
1101
955
|
account_tax_ids: nil,
|
1102
|
-
amounts_due: nil,
|
1103
956
|
application_fee_amount: nil,
|
1104
957
|
auto_advance: nil,
|
1105
958
|
automatic_tax: nil,
|
@@ -1107,7 +960,6 @@ module Stripe
|
|
1107
960
|
collection_method: nil,
|
1108
961
|
custom_fields: nil,
|
1109
962
|
days_until_due: nil,
|
1110
|
-
default_margins: nil,
|
1111
963
|
default_payment_method: nil,
|
1112
964
|
default_source: nil,
|
1113
965
|
default_tax_rates: nil,
|
@@ -1129,7 +981,6 @@ module Stripe
|
|
1129
981
|
transfer_data: nil
|
1130
982
|
)
|
1131
983
|
@account_tax_ids = account_tax_ids
|
1132
|
-
@amounts_due = amounts_due
|
1133
984
|
@application_fee_amount = application_fee_amount
|
1134
985
|
@auto_advance = auto_advance
|
1135
986
|
@automatic_tax = automatic_tax
|
@@ -1137,7 +988,6 @@ module Stripe
|
|
1137
988
|
@collection_method = collection_method
|
1138
989
|
@custom_fields = custom_fields
|
1139
990
|
@days_until_due = days_until_due
|
1140
|
-
@default_margins = default_margins
|
1141
991
|
@default_payment_method = default_payment_method
|
1142
992
|
@default_source = default_source
|
1143
993
|
@default_tax_rates = default_tax_rates
|
@@ -1202,8 +1052,6 @@ module Stripe
|
|
1202
1052
|
attr_accessor :created
|
1203
1053
|
# Only return invoices for the customer specified by this customer ID.
|
1204
1054
|
attr_accessor :customer
|
1205
|
-
# Only return invoices for the account specified by this account ID.
|
1206
|
-
attr_accessor :customer_account
|
1207
1055
|
# Attribute for param field due_date
|
1208
1056
|
attr_accessor :due_date
|
1209
1057
|
# 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.
|
@@ -1223,7 +1071,6 @@ module Stripe
|
|
1223
1071
|
collection_method: nil,
|
1224
1072
|
created: nil,
|
1225
1073
|
customer: nil,
|
1226
|
-
customer_account: nil,
|
1227
1074
|
due_date: nil,
|
1228
1075
|
ending_before: nil,
|
1229
1076
|
expand: nil,
|
@@ -1235,7 +1082,6 @@ module Stripe
|
|
1235
1082
|
@collection_method = collection_method
|
1236
1083
|
@created = created
|
1237
1084
|
@customer = customer
|
1238
|
-
@customer_account = customer_account
|
1239
1085
|
@due_date = due_date
|
1240
1086
|
@ending_before = ending_before
|
1241
1087
|
@expand = expand
|
@@ -1247,24 +1093,6 @@ module Stripe
|
|
1247
1093
|
end
|
1248
1094
|
|
1249
1095
|
class CreateParams < Stripe::RequestParams
|
1250
|
-
class AmountsDue < Stripe::RequestParams
|
1251
|
-
# The amount in cents (or local equivalent).
|
1252
|
-
attr_accessor :amount
|
1253
|
-
# Number of days from when invoice is finalized until the payment is due.
|
1254
|
-
attr_accessor :days_until_due
|
1255
|
-
# An arbitrary string attached to the object. Often useful for displaying to users.
|
1256
|
-
attr_accessor :description
|
1257
|
-
# Date on which a payment plan’s payment is due.
|
1258
|
-
attr_accessor :due_date
|
1259
|
-
|
1260
|
-
def initialize(amount: nil, days_until_due: nil, description: nil, due_date: nil)
|
1261
|
-
@amount = amount
|
1262
|
-
@days_until_due = days_until_due
|
1263
|
-
@description = description
|
1264
|
-
@due_date = due_date
|
1265
|
-
end
|
1266
|
-
end
|
1267
|
-
|
1268
1096
|
class AutomaticTax < Stripe::RequestParams
|
1269
1097
|
class Liability < Stripe::RequestParams
|
1270
1098
|
# The connected account being referenced when `type` is `account`.
|
@@ -1301,44 +1129,16 @@ module Stripe
|
|
1301
1129
|
end
|
1302
1130
|
|
1303
1131
|
class Discount < Stripe::RequestParams
|
1304
|
-
class DiscountEnd < Stripe::RequestParams
|
1305
|
-
class Duration < Stripe::RequestParams
|
1306
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1307
|
-
attr_accessor :interval
|
1308
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1309
|
-
attr_accessor :interval_count
|
1310
|
-
|
1311
|
-
def initialize(interval: nil, interval_count: nil)
|
1312
|
-
@interval = interval
|
1313
|
-
@interval_count = interval_count
|
1314
|
-
end
|
1315
|
-
end
|
1316
|
-
# Time span for the redeemed discount.
|
1317
|
-
attr_accessor :duration
|
1318
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1319
|
-
attr_accessor :timestamp
|
1320
|
-
# The type of calculation made to determine when the discount ends.
|
1321
|
-
attr_accessor :type
|
1322
|
-
|
1323
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
1324
|
-
@duration = duration
|
1325
|
-
@timestamp = timestamp
|
1326
|
-
@type = type
|
1327
|
-
end
|
1328
|
-
end
|
1329
1132
|
# ID of the coupon to create a new discount for.
|
1330
1133
|
attr_accessor :coupon
|
1331
1134
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1332
1135
|
attr_accessor :discount
|
1333
|
-
# Details to determine how long the discount should be applied for.
|
1334
|
-
attr_accessor :discount_end
|
1335
1136
|
# ID of the promotion code to create a new discount for.
|
1336
1137
|
attr_accessor :promotion_code
|
1337
1138
|
|
1338
|
-
def initialize(coupon: nil, discount: nil,
|
1139
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
1339
1140
|
@coupon = coupon
|
1340
1141
|
@discount = discount
|
1341
|
-
@discount_end = discount_end
|
1342
1142
|
@promotion_code = promotion_code
|
1343
1143
|
end
|
1344
1144
|
end
|
@@ -1470,47 +1270,17 @@ module Stripe
|
|
1470
1270
|
end
|
1471
1271
|
end
|
1472
1272
|
|
1473
|
-
class IdBankTransfer < Stripe::RequestParams; end
|
1474
1273
|
class Konbini < Stripe::RequestParams; end
|
1475
1274
|
class SepaDebit < Stripe::RequestParams; end
|
1476
1275
|
|
1477
|
-
class Upi < Stripe::RequestParams
|
1478
|
-
class MandateOptions < Stripe::RequestParams
|
1479
|
-
# Amount to be charged for future payments.
|
1480
|
-
attr_accessor :amount
|
1481
|
-
# One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
|
1482
|
-
attr_accessor :amount_type
|
1483
|
-
# A description of the mandate or subscription that is meant to be displayed to the customer.
|
1484
|
-
attr_accessor :description
|
1485
|
-
# End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
|
1486
|
-
attr_accessor :end_date
|
1487
|
-
|
1488
|
-
def initialize(amount: nil, amount_type: nil, description: nil, end_date: nil)
|
1489
|
-
@amount = amount
|
1490
|
-
@amount_type = amount_type
|
1491
|
-
@description = description
|
1492
|
-
@end_date = end_date
|
1493
|
-
end
|
1494
|
-
end
|
1495
|
-
# Configuration options for setting up an eMandate
|
1496
|
-
attr_accessor :mandate_options
|
1497
|
-
|
1498
|
-
def initialize(mandate_options: nil)
|
1499
|
-
@mandate_options = mandate_options
|
1500
|
-
end
|
1501
|
-
end
|
1502
|
-
|
1503
1276
|
class UsBankAccount < Stripe::RequestParams
|
1504
1277
|
class FinancialConnections < Stripe::RequestParams
|
1505
1278
|
class Filters < Stripe::RequestParams
|
1506
1279
|
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
1507
1280
|
attr_accessor :account_subcategories
|
1508
|
-
# ID of the institution to use to filter for selectable accounts.
|
1509
|
-
attr_accessor :institution
|
1510
1281
|
|
1511
|
-
def initialize(account_subcategories: nil
|
1282
|
+
def initialize(account_subcategories: nil)
|
1512
1283
|
@account_subcategories = account_subcategories
|
1513
|
-
@institution = institution
|
1514
1284
|
end
|
1515
1285
|
end
|
1516
1286
|
# Provide filters for the linked accounts that the customer can select for the payment method.
|
@@ -1544,14 +1314,10 @@ module Stripe
|
|
1544
1314
|
attr_accessor :card
|
1545
1315
|
# If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
|
1546
1316
|
attr_accessor :customer_balance
|
1547
|
-
# If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
|
1548
|
-
attr_accessor :id_bank_transfer
|
1549
1317
|
# If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
|
1550
1318
|
attr_accessor :konbini
|
1551
1319
|
# If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
|
1552
1320
|
attr_accessor :sepa_debit
|
1553
|
-
# If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
|
1554
|
-
attr_accessor :upi
|
1555
1321
|
# If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
|
1556
1322
|
attr_accessor :us_bank_account
|
1557
1323
|
|
@@ -1560,20 +1326,16 @@ module Stripe
|
|
1560
1326
|
bancontact: nil,
|
1561
1327
|
card: nil,
|
1562
1328
|
customer_balance: nil,
|
1563
|
-
id_bank_transfer: nil,
|
1564
1329
|
konbini: nil,
|
1565
1330
|
sepa_debit: nil,
|
1566
|
-
upi: nil,
|
1567
1331
|
us_bank_account: nil
|
1568
1332
|
)
|
1569
1333
|
@acss_debit = acss_debit
|
1570
1334
|
@bancontact = bancontact
|
1571
1335
|
@card = card
|
1572
1336
|
@customer_balance = customer_balance
|
1573
|
-
@id_bank_transfer = id_bank_transfer
|
1574
1337
|
@konbini = konbini
|
1575
1338
|
@sepa_debit = sepa_debit
|
1576
|
-
@upi = upi
|
1577
1339
|
@us_bank_account = us_bank_account
|
1578
1340
|
end
|
1579
1341
|
end
|
@@ -1783,8 +1545,6 @@ module Stripe
|
|
1783
1545
|
end
|
1784
1546
|
# The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
|
1785
1547
|
attr_accessor :account_tax_ids
|
1786
|
-
# List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
|
1787
|
-
attr_accessor :amounts_due
|
1788
1548
|
# A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).
|
1789
1549
|
attr_accessor :application_fee_amount
|
1790
1550
|
# Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. Defaults to false.
|
@@ -1801,12 +1561,8 @@ module Stripe
|
|
1801
1561
|
attr_accessor :custom_fields
|
1802
1562
|
# The ID of the customer who will be billed.
|
1803
1563
|
attr_accessor :customer
|
1804
|
-
# The ID of the account who will be billed.
|
1805
|
-
attr_accessor :customer_account
|
1806
1564
|
# The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.
|
1807
1565
|
attr_accessor :days_until_due
|
1808
|
-
# The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
|
1809
|
-
attr_accessor :default_margins
|
1810
1566
|
# ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
|
1811
1567
|
attr_accessor :default_payment_method
|
1812
1568
|
# ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
|
@@ -1854,7 +1610,6 @@ module Stripe
|
|
1854
1610
|
|
1855
1611
|
def initialize(
|
1856
1612
|
account_tax_ids: nil,
|
1857
|
-
amounts_due: nil,
|
1858
1613
|
application_fee_amount: nil,
|
1859
1614
|
auto_advance: nil,
|
1860
1615
|
automatic_tax: nil,
|
@@ -1863,9 +1618,7 @@ module Stripe
|
|
1863
1618
|
currency: nil,
|
1864
1619
|
custom_fields: nil,
|
1865
1620
|
customer: nil,
|
1866
|
-
customer_account: nil,
|
1867
1621
|
days_until_due: nil,
|
1868
|
-
default_margins: nil,
|
1869
1622
|
default_payment_method: nil,
|
1870
1623
|
default_source: nil,
|
1871
1624
|
default_tax_rates: nil,
|
@@ -1890,7 +1643,6 @@ module Stripe
|
|
1890
1643
|
transfer_data: nil
|
1891
1644
|
)
|
1892
1645
|
@account_tax_ids = account_tax_ids
|
1893
|
-
@amounts_due = amounts_due
|
1894
1646
|
@application_fee_amount = application_fee_amount
|
1895
1647
|
@auto_advance = auto_advance
|
1896
1648
|
@automatic_tax = automatic_tax
|
@@ -1899,9 +1651,7 @@ module Stripe
|
|
1899
1651
|
@currency = currency
|
1900
1652
|
@custom_fields = custom_fields
|
1901
1653
|
@customer = customer
|
1902
|
-
@customer_account = customer_account
|
1903
1654
|
@days_until_due = days_until_due
|
1904
|
-
@default_margins = default_margins
|
1905
1655
|
@default_payment_method = default_payment_method
|
1906
1656
|
@default_source = default_source
|
1907
1657
|
@default_tax_rates = default_tax_rates
|
@@ -1948,44 +1698,16 @@ module Stripe
|
|
1948
1698
|
class AddLinesParams < Stripe::RequestParams
|
1949
1699
|
class Line < Stripe::RequestParams
|
1950
1700
|
class Discount < Stripe::RequestParams
|
1951
|
-
class DiscountEnd < Stripe::RequestParams
|
1952
|
-
class Duration < Stripe::RequestParams
|
1953
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1954
|
-
attr_accessor :interval
|
1955
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1956
|
-
attr_accessor :interval_count
|
1957
|
-
|
1958
|
-
def initialize(interval: nil, interval_count: nil)
|
1959
|
-
@interval = interval
|
1960
|
-
@interval_count = interval_count
|
1961
|
-
end
|
1962
|
-
end
|
1963
|
-
# Time span for the redeemed discount.
|
1964
|
-
attr_accessor :duration
|
1965
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1966
|
-
attr_accessor :timestamp
|
1967
|
-
# The type of calculation made to determine when the discount ends.
|
1968
|
-
attr_accessor :type
|
1969
|
-
|
1970
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
1971
|
-
@duration = duration
|
1972
|
-
@timestamp = timestamp
|
1973
|
-
@type = type
|
1974
|
-
end
|
1975
|
-
end
|
1976
1701
|
# ID of the coupon to create a new discount for.
|
1977
1702
|
attr_accessor :coupon
|
1978
1703
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1979
1704
|
attr_accessor :discount
|
1980
|
-
# Details to determine how long the discount should be applied for.
|
1981
|
-
attr_accessor :discount_end
|
1982
1705
|
# ID of the promotion code to create a new discount for.
|
1983
1706
|
attr_accessor :promotion_code
|
1984
1707
|
|
1985
|
-
def initialize(coupon: nil, discount: nil,
|
1708
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
1986
1709
|
@coupon = coupon
|
1987
1710
|
@discount = discount
|
1988
|
-
@discount_end = discount_end
|
1989
1711
|
@promotion_code = promotion_code
|
1990
1712
|
end
|
1991
1713
|
end
|
@@ -2138,8 +1860,6 @@ module Stripe
|
|
2138
1860
|
attr_accessor :discounts
|
2139
1861
|
# ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created.
|
2140
1862
|
attr_accessor :invoice_item
|
2141
|
-
# The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
|
2142
|
-
attr_accessor :margins
|
2143
1863
|
# 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`.
|
2144
1864
|
attr_accessor :metadata
|
2145
1865
|
# The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
|
@@ -2161,7 +1881,6 @@ module Stripe
|
|
2161
1881
|
discountable: nil,
|
2162
1882
|
discounts: nil,
|
2163
1883
|
invoice_item: nil,
|
2164
|
-
margins: nil,
|
2165
1884
|
metadata: nil,
|
2166
1885
|
period: nil,
|
2167
1886
|
price_data: nil,
|
@@ -2175,7 +1894,6 @@ module Stripe
|
|
2175
1894
|
@discountable = discountable
|
2176
1895
|
@discounts = discounts
|
2177
1896
|
@invoice_item = invoice_item
|
2178
|
-
@margins = margins
|
2179
1897
|
@metadata = metadata
|
2180
1898
|
@period = period
|
2181
1899
|
@price_data = price_data
|
@@ -2200,59 +1918,14 @@ module Stripe
|
|
2200
1918
|
end
|
2201
1919
|
|
2202
1920
|
class AttachPaymentParams < Stripe::RequestParams
|
2203
|
-
class PaymentRecordData < Stripe::RequestParams
|
2204
|
-
# The amount that was paid out of band.
|
2205
|
-
attr_accessor :amount
|
2206
|
-
# The currency that was paid out of band.
|
2207
|
-
attr_accessor :currency
|
2208
|
-
# 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`.
|
2209
|
-
attr_accessor :metadata
|
2210
|
-
# The type of money movement for this out of band payment record.
|
2211
|
-
attr_accessor :money_movement_type
|
2212
|
-
# The timestamp when this out of band payment was paid.
|
2213
|
-
attr_accessor :paid_at
|
2214
|
-
# The reference for this out of band payment record.
|
2215
|
-
attr_accessor :payment_reference
|
2216
|
-
|
2217
|
-
def initialize(
|
2218
|
-
amount: nil,
|
2219
|
-
currency: nil,
|
2220
|
-
metadata: nil,
|
2221
|
-
money_movement_type: nil,
|
2222
|
-
paid_at: nil,
|
2223
|
-
payment_reference: nil
|
2224
|
-
)
|
2225
|
-
@amount = amount
|
2226
|
-
@currency = currency
|
2227
|
-
@metadata = metadata
|
2228
|
-
@money_movement_type = money_movement_type
|
2229
|
-
@paid_at = paid_at
|
2230
|
-
@payment_reference = payment_reference
|
2231
|
-
end
|
2232
|
-
end
|
2233
|
-
# The portion of the `amount` on the PaymentIntent or out of band payment to apply to this invoice. It defaults to the entire amount.
|
2234
|
-
attr_accessor :amount_requested
|
2235
1921
|
# Specifies which fields in the response should be expanded.
|
2236
1922
|
attr_accessor :expand
|
2237
1923
|
# The ID of the PaymentIntent to attach to the invoice.
|
2238
1924
|
attr_accessor :payment_intent
|
2239
|
-
# The ID of the PaymentRecord to attach to the invoice.
|
2240
|
-
attr_accessor :payment_record
|
2241
|
-
# The PaymentRecord data for attaching an out of band payment to the invoice.
|
2242
|
-
attr_accessor :payment_record_data
|
2243
1925
|
|
2244
|
-
def initialize(
|
2245
|
-
amount_requested: nil,
|
2246
|
-
expand: nil,
|
2247
|
-
payment_intent: nil,
|
2248
|
-
payment_record: nil,
|
2249
|
-
payment_record_data: nil
|
2250
|
-
)
|
2251
|
-
@amount_requested = amount_requested
|
1926
|
+
def initialize(expand: nil, payment_intent: nil)
|
2252
1927
|
@expand = expand
|
2253
1928
|
@payment_intent = payment_intent
|
2254
|
-
@payment_record = payment_record
|
2255
|
-
@payment_record_data = payment_record_data
|
2256
1929
|
end
|
2257
1930
|
end
|
2258
1931
|
|
@@ -2352,44 +2025,16 @@ module Stripe
|
|
2352
2025
|
class UpdateLinesParams < Stripe::RequestParams
|
2353
2026
|
class Line < Stripe::RequestParams
|
2354
2027
|
class Discount < Stripe::RequestParams
|
2355
|
-
class DiscountEnd < Stripe::RequestParams
|
2356
|
-
class Duration < Stripe::RequestParams
|
2357
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2358
|
-
attr_accessor :interval
|
2359
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2360
|
-
attr_accessor :interval_count
|
2361
|
-
|
2362
|
-
def initialize(interval: nil, interval_count: nil)
|
2363
|
-
@interval = interval
|
2364
|
-
@interval_count = interval_count
|
2365
|
-
end
|
2366
|
-
end
|
2367
|
-
# Time span for the redeemed discount.
|
2368
|
-
attr_accessor :duration
|
2369
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
2370
|
-
attr_accessor :timestamp
|
2371
|
-
# The type of calculation made to determine when the discount ends.
|
2372
|
-
attr_accessor :type
|
2373
|
-
|
2374
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
2375
|
-
@duration = duration
|
2376
|
-
@timestamp = timestamp
|
2377
|
-
@type = type
|
2378
|
-
end
|
2379
|
-
end
|
2380
2028
|
# ID of the coupon to create a new discount for.
|
2381
2029
|
attr_accessor :coupon
|
2382
2030
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
2383
2031
|
attr_accessor :discount
|
2384
|
-
# Details to determine how long the discount should be applied for.
|
2385
|
-
attr_accessor :discount_end
|
2386
2032
|
# ID of the promotion code to create a new discount for.
|
2387
2033
|
attr_accessor :promotion_code
|
2388
2034
|
|
2389
|
-
def initialize(coupon: nil, discount: nil,
|
2035
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
2390
2036
|
@coupon = coupon
|
2391
2037
|
@discount = discount
|
2392
|
-
@discount_end = discount_end
|
2393
2038
|
@promotion_code = promotion_code
|
2394
2039
|
end
|
2395
2040
|
end
|
@@ -2542,8 +2187,6 @@ module Stripe
|
|
2542
2187
|
attr_accessor :discounts
|
2543
2188
|
# ID of an existing line item on the invoice.
|
2544
2189
|
attr_accessor :id
|
2545
|
-
# The IDs of the margins to apply to the line item. When set, the `default_margins` on the invoice do not apply to this line item.
|
2546
|
-
attr_accessor :margins
|
2547
2190
|
# 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`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
|
2548
2191
|
attr_accessor :metadata
|
2549
2192
|
# The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
|
@@ -2565,7 +2208,6 @@ module Stripe
|
|
2565
2208
|
discountable: nil,
|
2566
2209
|
discounts: nil,
|
2567
2210
|
id: nil,
|
2568
|
-
margins: nil,
|
2569
2211
|
metadata: nil,
|
2570
2212
|
period: nil,
|
2571
2213
|
price_data: nil,
|
@@ -2579,7 +2221,6 @@ module Stripe
|
|
2579
2221
|
@discountable = discountable
|
2580
2222
|
@discounts = discounts
|
2581
2223
|
@id = id
|
2582
|
-
@margins = margins
|
2583
2224
|
@metadata = metadata
|
2584
2225
|
@period = period
|
2585
2226
|
@price_data = price_data
|
@@ -2754,88 +2395,32 @@ module Stripe
|
|
2754
2395
|
end
|
2755
2396
|
|
2756
2397
|
class Discount < Stripe::RequestParams
|
2757
|
-
class DiscountEnd < Stripe::RequestParams
|
2758
|
-
class Duration < Stripe::RequestParams
|
2759
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2760
|
-
attr_accessor :interval
|
2761
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2762
|
-
attr_accessor :interval_count
|
2763
|
-
|
2764
|
-
def initialize(interval: nil, interval_count: nil)
|
2765
|
-
@interval = interval
|
2766
|
-
@interval_count = interval_count
|
2767
|
-
end
|
2768
|
-
end
|
2769
|
-
# Time span for the redeemed discount.
|
2770
|
-
attr_accessor :duration
|
2771
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
2772
|
-
attr_accessor :timestamp
|
2773
|
-
# The type of calculation made to determine when the discount ends.
|
2774
|
-
attr_accessor :type
|
2775
|
-
|
2776
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
2777
|
-
@duration = duration
|
2778
|
-
@timestamp = timestamp
|
2779
|
-
@type = type
|
2780
|
-
end
|
2781
|
-
end
|
2782
2398
|
# ID of the coupon to create a new discount for.
|
2783
2399
|
attr_accessor :coupon
|
2784
2400
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
2785
2401
|
attr_accessor :discount
|
2786
|
-
# Details to determine how long the discount should be applied for.
|
2787
|
-
attr_accessor :discount_end
|
2788
2402
|
# ID of the promotion code to create a new discount for.
|
2789
2403
|
attr_accessor :promotion_code
|
2790
2404
|
|
2791
|
-
def initialize(coupon: nil, discount: nil,
|
2405
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
2792
2406
|
@coupon = coupon
|
2793
2407
|
@discount = discount
|
2794
|
-
@discount_end = discount_end
|
2795
2408
|
@promotion_code = promotion_code
|
2796
2409
|
end
|
2797
2410
|
end
|
2798
2411
|
|
2799
2412
|
class InvoiceItem < Stripe::RequestParams
|
2800
2413
|
class Discount < Stripe::RequestParams
|
2801
|
-
class DiscountEnd < Stripe::RequestParams
|
2802
|
-
class Duration < Stripe::RequestParams
|
2803
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2804
|
-
attr_accessor :interval
|
2805
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2806
|
-
attr_accessor :interval_count
|
2807
|
-
|
2808
|
-
def initialize(interval: nil, interval_count: nil)
|
2809
|
-
@interval = interval
|
2810
|
-
@interval_count = interval_count
|
2811
|
-
end
|
2812
|
-
end
|
2813
|
-
# Time span for the redeemed discount.
|
2814
|
-
attr_accessor :duration
|
2815
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
2816
|
-
attr_accessor :timestamp
|
2817
|
-
# The type of calculation made to determine when the discount ends.
|
2818
|
-
attr_accessor :type
|
2819
|
-
|
2820
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
2821
|
-
@duration = duration
|
2822
|
-
@timestamp = timestamp
|
2823
|
-
@type = type
|
2824
|
-
end
|
2825
|
-
end
|
2826
2414
|
# ID of the coupon to create a new discount for.
|
2827
2415
|
attr_accessor :coupon
|
2828
2416
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
2829
2417
|
attr_accessor :discount
|
2830
|
-
# Details to determine how long the discount should be applied for.
|
2831
|
-
attr_accessor :discount_end
|
2832
2418
|
# ID of the promotion code to create a new discount for.
|
2833
2419
|
attr_accessor :promotion_code
|
2834
2420
|
|
2835
|
-
def initialize(coupon: nil, discount: nil,
|
2421
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
2836
2422
|
@coupon = coupon
|
2837
2423
|
@discount = discount
|
2838
|
-
@discount_end = discount_end
|
2839
2424
|
@promotion_code = promotion_code
|
2840
2425
|
end
|
2841
2426
|
end
|
@@ -2961,137 +2546,23 @@ module Stripe
|
|
2961
2546
|
end
|
2962
2547
|
|
2963
2548
|
class ScheduleDetails < Stripe::RequestParams
|
2964
|
-
class
|
2965
|
-
|
2966
|
-
|
2967
|
-
# The ID of a specific discount.
|
2968
|
-
attr_accessor :discount
|
2969
|
-
|
2970
|
-
def initialize(discount: nil)
|
2971
|
-
@discount = discount
|
2972
|
-
end
|
2973
|
-
end
|
2974
|
-
|
2975
|
-
class Duration < Stripe::RequestParams
|
2976
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2977
|
-
attr_accessor :interval
|
2978
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2979
|
-
attr_accessor :interval_count
|
2980
|
-
|
2981
|
-
def initialize(interval: nil, interval_count: nil)
|
2982
|
-
@interval = interval
|
2983
|
-
@interval_count = interval_count
|
2984
|
-
end
|
2985
|
-
end
|
2986
|
-
# Use the `end` time of a given discount.
|
2987
|
-
attr_accessor :discount_end
|
2988
|
-
# Time span for the amendment starting from the `amendment_start`.
|
2989
|
-
attr_accessor :duration
|
2990
|
-
# A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
|
2991
|
-
attr_accessor :timestamp
|
2992
|
-
# Select one of three ways to pass the `amendment_end`.
|
2993
|
-
attr_accessor :type
|
2994
|
-
|
2995
|
-
def initialize(discount_end: nil, duration: nil, timestamp: nil, type: nil)
|
2996
|
-
@discount_end = discount_end
|
2997
|
-
@duration = duration
|
2998
|
-
@timestamp = timestamp
|
2999
|
-
@type = type
|
3000
|
-
end
|
3001
|
-
end
|
3002
|
-
|
3003
|
-
class AmendmentStart < Stripe::RequestParams
|
3004
|
-
class AmendmentEnd < Stripe::RequestParams
|
3005
|
-
# The position of the previous amendment in the `amendments` array after which this amendment should begin. Indexes start from 0 and must be less than the index of the current amendment in the array.
|
3006
|
-
attr_accessor :index
|
3007
|
-
|
3008
|
-
def initialize(index: nil)
|
3009
|
-
@index = index
|
3010
|
-
end
|
3011
|
-
end
|
3012
|
-
|
3013
|
-
class DiscountEnd < Stripe::RequestParams
|
3014
|
-
# The ID of a specific discount.
|
3015
|
-
attr_accessor :discount
|
2549
|
+
class BillingMode < Stripe::RequestParams
|
2550
|
+
# Controls the calculation and orchestration of prorations and invoices for subscriptions.
|
2551
|
+
attr_accessor :type
|
3016
2552
|
|
3017
|
-
|
3018
|
-
|
3019
|
-
end
|
3020
|
-
end
|
3021
|
-
# Details of another amendment in the same array, immediately after which this amendment should begin.
|
3022
|
-
attr_accessor :amendment_end
|
3023
|
-
# Use the `end` time of a given discount.
|
3024
|
-
attr_accessor :discount_end
|
3025
|
-
# A precise Unix timestamp for the amendment to start.
|
3026
|
-
attr_accessor :timestamp
|
3027
|
-
# Select one of three ways to pass the `amendment_start`.
|
3028
|
-
attr_accessor :type
|
3029
|
-
|
3030
|
-
def initialize(amendment_end: nil, discount_end: nil, timestamp: nil, type: nil)
|
3031
|
-
@amendment_end = amendment_end
|
3032
|
-
@discount_end = discount_end
|
3033
|
-
@timestamp = timestamp
|
3034
|
-
@type = type
|
3035
|
-
end
|
2553
|
+
def initialize(type: nil)
|
2554
|
+
@type = type
|
3036
2555
|
end
|
2556
|
+
end
|
3037
2557
|
|
3038
|
-
|
3039
|
-
|
3040
|
-
|
3041
|
-
|
3042
|
-
attr_accessor :type
|
3043
|
-
|
3044
|
-
def initialize(type: nil)
|
3045
|
-
@type = type
|
3046
|
-
end
|
3047
|
-
end
|
3048
|
-
# The coupon code to redeem.
|
3049
|
-
attr_accessor :coupon
|
3050
|
-
# An ID of an existing discount for a coupon that was already redeemed.
|
3051
|
-
attr_accessor :discount
|
3052
|
-
# Details to determine how long the discount should be applied for.
|
3053
|
-
attr_accessor :discount_end
|
3054
|
-
# The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.
|
3055
|
-
attr_accessor :index
|
3056
|
-
# The promotion code to redeem.
|
3057
|
-
attr_accessor :promotion_code
|
3058
|
-
|
3059
|
-
def initialize(
|
3060
|
-
coupon: nil,
|
3061
|
-
discount: nil,
|
3062
|
-
discount_end: nil,
|
3063
|
-
index: nil,
|
3064
|
-
promotion_code: nil
|
3065
|
-
)
|
3066
|
-
@coupon = coupon
|
3067
|
-
@discount = discount
|
3068
|
-
@discount_end = discount_end
|
3069
|
-
@index = index
|
3070
|
-
@promotion_code = promotion_code
|
3071
|
-
end
|
3072
|
-
end
|
3073
|
-
|
3074
|
-
class Remove < Stripe::RequestParams
|
3075
|
-
# The coupon code to remove from the `discounts` array.
|
3076
|
-
attr_accessor :coupon
|
3077
|
-
# The ID of a discount to remove from the `discounts` array.
|
3078
|
-
attr_accessor :discount
|
3079
|
-
# The ID of a promotion code to remove from the `discounts` array.
|
3080
|
-
attr_accessor :promotion_code
|
3081
|
-
|
3082
|
-
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
3083
|
-
@coupon = coupon
|
3084
|
-
@discount = discount
|
3085
|
-
@promotion_code = promotion_code
|
3086
|
-
end
|
3087
|
-
end
|
3088
|
-
|
3089
|
-
class Set < Stripe::RequestParams
|
3090
|
-
# The coupon code to replace the `discounts` array with.
|
2558
|
+
class Phase < Stripe::RequestParams
|
2559
|
+
class AddInvoiceItem < Stripe::RequestParams
|
2560
|
+
class Discount < Stripe::RequestParams
|
2561
|
+
# ID of the coupon to create a new discount for.
|
3091
2562
|
attr_accessor :coupon
|
3092
|
-
#
|
2563
|
+
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
3093
2564
|
attr_accessor :discount
|
3094
|
-
#
|
2565
|
+
# ID of the promotion code to create a new discount for.
|
3095
2566
|
attr_accessor :promotion_code
|
3096
2567
|
|
3097
2568
|
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
@@ -3100,370 +2571,39 @@ module Stripe
|
|
3100
2571
|
@promotion_code = promotion_code
|
3101
2572
|
end
|
3102
2573
|
end
|
3103
|
-
# Details of the discount to add.
|
3104
|
-
attr_accessor :add
|
3105
|
-
# Details of the discount to remove.
|
3106
|
-
attr_accessor :remove
|
3107
|
-
# Details of the discount to replace the existing discounts with.
|
3108
|
-
attr_accessor :set
|
3109
|
-
# Determines the type of discount action.
|
3110
|
-
attr_accessor :type
|
3111
|
-
|
3112
|
-
def initialize(add: nil, remove: nil, set: nil, type: nil)
|
3113
|
-
@add = add
|
3114
|
-
@remove = remove
|
3115
|
-
@set = set
|
3116
|
-
@type = type
|
3117
|
-
end
|
3118
|
-
end
|
3119
|
-
|
3120
|
-
class ItemAction < Stripe::RequestParams
|
3121
|
-
class Add < Stripe::RequestParams
|
3122
|
-
class Discount < Stripe::RequestParams
|
3123
|
-
class DiscountEnd < Stripe::RequestParams
|
3124
|
-
class Duration < Stripe::RequestParams
|
3125
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
3126
|
-
attr_accessor :interval
|
3127
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
3128
|
-
attr_accessor :interval_count
|
3129
|
-
|
3130
|
-
def initialize(interval: nil, interval_count: nil)
|
3131
|
-
@interval = interval
|
3132
|
-
@interval_count = interval_count
|
3133
|
-
end
|
3134
|
-
end
|
3135
|
-
# Time span for the redeemed discount.
|
3136
|
-
attr_accessor :duration
|
3137
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
3138
|
-
attr_accessor :timestamp
|
3139
|
-
# The type of calculation made to determine when the discount ends.
|
3140
|
-
attr_accessor :type
|
3141
|
-
|
3142
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
3143
|
-
@duration = duration
|
3144
|
-
@timestamp = timestamp
|
3145
|
-
@type = type
|
3146
|
-
end
|
3147
|
-
end
|
3148
|
-
# ID of the coupon to create a new discount for.
|
3149
|
-
attr_accessor :coupon
|
3150
|
-
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
3151
|
-
attr_accessor :discount
|
3152
|
-
# Details to determine how long the discount should be applied for.
|
3153
|
-
attr_accessor :discount_end
|
3154
|
-
# ID of the promotion code to create a new discount for.
|
3155
|
-
attr_accessor :promotion_code
|
3156
|
-
|
3157
|
-
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
|
3158
|
-
@coupon = coupon
|
3159
|
-
@discount = discount
|
3160
|
-
@discount_end = discount_end
|
3161
|
-
@promotion_code = promotion_code
|
3162
|
-
end
|
3163
|
-
end
|
3164
|
-
|
3165
|
-
class Trial < Stripe::RequestParams
|
3166
|
-
# 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.
|
3167
|
-
attr_accessor :converts_to
|
3168
|
-
# Determines the type of trial for this item.
|
3169
|
-
attr_accessor :type
|
3170
|
-
|
3171
|
-
def initialize(converts_to: nil, type: nil)
|
3172
|
-
@converts_to = converts_to
|
3173
|
-
@type = type
|
3174
|
-
end
|
3175
|
-
end
|
3176
|
-
# The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
3177
|
-
attr_accessor :discounts
|
3178
|
-
# 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`.
|
3179
|
-
attr_accessor :metadata
|
3180
|
-
# The ID of the price object.
|
3181
|
-
attr_accessor :price
|
3182
|
-
# Quantity for this item.
|
3183
|
-
attr_accessor :quantity
|
3184
|
-
# The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
|
3185
|
-
attr_accessor :tax_rates
|
3186
|
-
# Options that configure the trial on the subscription item.
|
3187
|
-
attr_accessor :trial
|
3188
|
-
|
3189
|
-
def initialize(
|
3190
|
-
discounts: nil,
|
3191
|
-
metadata: nil,
|
3192
|
-
price: nil,
|
3193
|
-
quantity: nil,
|
3194
|
-
tax_rates: nil,
|
3195
|
-
trial: nil
|
3196
|
-
)
|
3197
|
-
@discounts = discounts
|
3198
|
-
@metadata = metadata
|
3199
|
-
@price = price
|
3200
|
-
@quantity = quantity
|
3201
|
-
@tax_rates = tax_rates
|
3202
|
-
@trial = trial
|
3203
|
-
end
|
3204
|
-
end
|
3205
|
-
|
3206
|
-
class Remove < Stripe::RequestParams
|
3207
|
-
# ID of a price to remove.
|
3208
|
-
attr_accessor :price
|
3209
|
-
|
3210
|
-
def initialize(price: nil)
|
3211
|
-
@price = price
|
3212
|
-
end
|
3213
|
-
end
|
3214
|
-
|
3215
|
-
class Set < Stripe::RequestParams
|
3216
|
-
class Discount < Stripe::RequestParams
|
3217
|
-
class DiscountEnd < Stripe::RequestParams
|
3218
|
-
class Duration < Stripe::RequestParams
|
3219
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
3220
|
-
attr_accessor :interval
|
3221
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
3222
|
-
attr_accessor :interval_count
|
3223
|
-
|
3224
|
-
def initialize(interval: nil, interval_count: nil)
|
3225
|
-
@interval = interval
|
3226
|
-
@interval_count = interval_count
|
3227
|
-
end
|
3228
|
-
end
|
3229
|
-
# Time span for the redeemed discount.
|
3230
|
-
attr_accessor :duration
|
3231
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
3232
|
-
attr_accessor :timestamp
|
3233
|
-
# The type of calculation made to determine when the discount ends.
|
3234
|
-
attr_accessor :type
|
3235
|
-
|
3236
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
3237
|
-
@duration = duration
|
3238
|
-
@timestamp = timestamp
|
3239
|
-
@type = type
|
3240
|
-
end
|
3241
|
-
end
|
3242
|
-
# ID of the coupon to create a new discount for.
|
3243
|
-
attr_accessor :coupon
|
3244
|
-
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
3245
|
-
attr_accessor :discount
|
3246
|
-
# Details to determine how long the discount should be applied for.
|
3247
|
-
attr_accessor :discount_end
|
3248
|
-
# ID of the promotion code to create a new discount for.
|
3249
|
-
attr_accessor :promotion_code
|
3250
|
-
|
3251
|
-
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
|
3252
|
-
@coupon = coupon
|
3253
|
-
@discount = discount
|
3254
|
-
@discount_end = discount_end
|
3255
|
-
@promotion_code = promotion_code
|
3256
|
-
end
|
3257
|
-
end
|
3258
2574
|
|
3259
|
-
|
3260
|
-
|
3261
|
-
|
3262
|
-
|
2575
|
+
class Period < Stripe::RequestParams
|
2576
|
+
class End < Stripe::RequestParams
|
2577
|
+
# A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
|
2578
|
+
attr_accessor :timestamp
|
2579
|
+
# Select how to calculate the end of the invoice item period.
|
3263
2580
|
attr_accessor :type
|
3264
2581
|
|
3265
|
-
def initialize(
|
3266
|
-
@
|
2582
|
+
def initialize(timestamp: nil, type: nil)
|
2583
|
+
@timestamp = timestamp
|
3267
2584
|
@type = type
|
3268
2585
|
end
|
3269
2586
|
end
|
3270
|
-
# If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.
|
3271
|
-
attr_accessor :discounts
|
3272
|
-
# If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.
|
3273
|
-
attr_accessor :metadata
|
3274
|
-
# The ID of the price object.
|
3275
|
-
attr_accessor :price
|
3276
|
-
# If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.
|
3277
|
-
attr_accessor :quantity
|
3278
|
-
# If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.
|
3279
|
-
attr_accessor :tax_rates
|
3280
|
-
# If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.
|
3281
|
-
attr_accessor :trial
|
3282
|
-
|
3283
|
-
def initialize(
|
3284
|
-
discounts: nil,
|
3285
|
-
metadata: nil,
|
3286
|
-
price: nil,
|
3287
|
-
quantity: nil,
|
3288
|
-
tax_rates: nil,
|
3289
|
-
trial: nil
|
3290
|
-
)
|
3291
|
-
@discounts = discounts
|
3292
|
-
@metadata = metadata
|
3293
|
-
@price = price
|
3294
|
-
@quantity = quantity
|
3295
|
-
@tax_rates = tax_rates
|
3296
|
-
@trial = trial
|
3297
|
-
end
|
3298
|
-
end
|
3299
|
-
# Details of the subscription item to add. If an item with the same `price` exists, it will be replaced by this new item. Otherwise, it adds the new item.
|
3300
|
-
attr_accessor :add
|
3301
|
-
# Details of the subscription item to remove.
|
3302
|
-
attr_accessor :remove
|
3303
|
-
# Details of the subscription item to replace the existing items with. If an item with the `set[price]` already exists, the `items` array is not cleared. Instead, all of the other `set` properties that are passed in this request will replace the existing values for the configuration item.
|
3304
|
-
attr_accessor :set
|
3305
|
-
# Determines the type of item action.
|
3306
|
-
attr_accessor :type
|
3307
|
-
|
3308
|
-
def initialize(add: nil, remove: nil, set: nil, type: nil)
|
3309
|
-
@add = add
|
3310
|
-
@remove = remove
|
3311
|
-
@set = set
|
3312
|
-
@type = type
|
3313
|
-
end
|
3314
|
-
end
|
3315
|
-
|
3316
|
-
class MetadataAction < Stripe::RequestParams
|
3317
|
-
# Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
|
3318
|
-
attr_accessor :add
|
3319
|
-
# Keys to remove from schedule phase metadata.
|
3320
|
-
attr_accessor :remove
|
3321
|
-
# Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
|
3322
|
-
attr_accessor :set
|
3323
|
-
# Select one of three ways to update phase-level `metadata` on subscription schedules.
|
3324
|
-
attr_accessor :type
|
3325
|
-
|
3326
|
-
def initialize(add: nil, remove: nil, set: nil, type: nil)
|
3327
|
-
@add = add
|
3328
|
-
@remove = remove
|
3329
|
-
@set = set
|
3330
|
-
@type = type
|
3331
|
-
end
|
3332
|
-
end
|
3333
|
-
|
3334
|
-
class SetPauseCollection < Stripe::RequestParams
|
3335
|
-
class Set < Stripe::RequestParams
|
3336
|
-
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
3337
|
-
attr_accessor :behavior
|
3338
|
-
|
3339
|
-
def initialize(behavior: nil)
|
3340
|
-
@behavior = behavior
|
3341
|
-
end
|
3342
|
-
end
|
3343
|
-
# Details of the pause_collection behavior to apply to the amendment.
|
3344
|
-
attr_accessor :set
|
3345
|
-
# Determines the type of the pause_collection amendment.
|
3346
|
-
attr_accessor :type
|
3347
|
-
|
3348
|
-
def initialize(set: nil, type: nil)
|
3349
|
-
@set = set
|
3350
|
-
@type = type
|
3351
|
-
end
|
3352
|
-
end
|
3353
|
-
|
3354
|
-
class TrialSettings < Stripe::RequestParams
|
3355
|
-
class EndBehavior < Stripe::RequestParams
|
3356
|
-
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
3357
|
-
attr_accessor :prorate_up_front
|
3358
|
-
|
3359
|
-
def initialize(prorate_up_front: nil)
|
3360
|
-
@prorate_up_front = prorate_up_front
|
3361
|
-
end
|
3362
|
-
end
|
3363
|
-
# Defines how the subscription should behave when a trial ends.
|
3364
|
-
attr_accessor :end_behavior
|
3365
|
-
|
3366
|
-
def initialize(end_behavior: nil)
|
3367
|
-
@end_behavior = end_behavior
|
3368
|
-
end
|
3369
|
-
end
|
3370
|
-
# Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at `amendment_start`, and a restricted set of attributes is supported on the amendment.
|
3371
|
-
attr_accessor :amendment_end
|
3372
|
-
# Details to identify the earliest timestamp where the proposed change should take effect.
|
3373
|
-
attr_accessor :amendment_start
|
3374
|
-
# For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.
|
3375
|
-
attr_accessor :billing_cycle_anchor
|
3376
|
-
# Changes to the coupons being redeemed or discounts being applied during the amendment time span.
|
3377
|
-
attr_accessor :discount_actions
|
3378
|
-
# Changes to the subscription items during the amendment time span.
|
3379
|
-
attr_accessor :item_actions
|
3380
|
-
# Instructions for how to modify phase metadata
|
3381
|
-
attr_accessor :metadata_actions
|
3382
|
-
# Changes to how Stripe handles prorations during the amendment time span. Affects if and how prorations are created when a future phase starts. In cases where the amendment changes the currently active phase, it is used to determine whether or how to prorate now, at the time of the request. Also supported as a point-in-time operation when `amendment_end` is `null`.
|
3383
|
-
attr_accessor :proration_behavior
|
3384
|
-
# Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
3385
|
-
attr_accessor :set_pause_collection
|
3386
|
-
# Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
|
3387
|
-
attr_accessor :set_schedule_end
|
3388
|
-
# Settings related to subscription trials.
|
3389
|
-
attr_accessor :trial_settings
|
3390
|
-
|
3391
|
-
def initialize(
|
3392
|
-
amendment_end: nil,
|
3393
|
-
amendment_start: nil,
|
3394
|
-
billing_cycle_anchor: nil,
|
3395
|
-
discount_actions: nil,
|
3396
|
-
item_actions: nil,
|
3397
|
-
metadata_actions: nil,
|
3398
|
-
proration_behavior: nil,
|
3399
|
-
set_pause_collection: nil,
|
3400
|
-
set_schedule_end: nil,
|
3401
|
-
trial_settings: nil
|
3402
|
-
)
|
3403
|
-
@amendment_end = amendment_end
|
3404
|
-
@amendment_start = amendment_start
|
3405
|
-
@billing_cycle_anchor = billing_cycle_anchor
|
3406
|
-
@discount_actions = discount_actions
|
3407
|
-
@item_actions = item_actions
|
3408
|
-
@metadata_actions = metadata_actions
|
3409
|
-
@proration_behavior = proration_behavior
|
3410
|
-
@set_pause_collection = set_pause_collection
|
3411
|
-
@set_schedule_end = set_schedule_end
|
3412
|
-
@trial_settings = trial_settings
|
3413
|
-
end
|
3414
|
-
end
|
3415
|
-
|
3416
|
-
class BillingMode < Stripe::RequestParams
|
3417
|
-
# Controls the calculation and orchestration of prorations and invoices for subscriptions.
|
3418
|
-
attr_accessor :type
|
3419
|
-
|
3420
|
-
def initialize(type: nil)
|
3421
|
-
@type = type
|
3422
|
-
end
|
3423
|
-
end
|
3424
2587
|
|
3425
|
-
|
3426
|
-
|
3427
|
-
class Discount < Stripe::RequestParams
|
3428
|
-
class DiscountEnd < Stripe::RequestParams
|
3429
|
-
class Duration < Stripe::RequestParams
|
3430
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
3431
|
-
attr_accessor :interval
|
3432
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
3433
|
-
attr_accessor :interval_count
|
3434
|
-
|
3435
|
-
def initialize(interval: nil, interval_count: nil)
|
3436
|
-
@interval = interval
|
3437
|
-
@interval_count = interval_count
|
3438
|
-
end
|
3439
|
-
end
|
3440
|
-
# Time span for the redeemed discount.
|
3441
|
-
attr_accessor :duration
|
3442
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
2588
|
+
class Start < Stripe::RequestParams
|
2589
|
+
# A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
|
3443
2590
|
attr_accessor :timestamp
|
3444
|
-
#
|
2591
|
+
# Select how to calculate the start of the invoice item period.
|
3445
2592
|
attr_accessor :type
|
3446
2593
|
|
3447
|
-
def initialize(
|
3448
|
-
@duration = duration
|
2594
|
+
def initialize(timestamp: nil, type: nil)
|
3449
2595
|
@timestamp = timestamp
|
3450
2596
|
@type = type
|
3451
2597
|
end
|
3452
2598
|
end
|
3453
|
-
#
|
3454
|
-
attr_accessor :
|
3455
|
-
#
|
3456
|
-
attr_accessor :
|
3457
|
-
|
3458
|
-
|
3459
|
-
|
3460
|
-
|
3461
|
-
|
3462
|
-
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
|
3463
|
-
@coupon = coupon
|
3464
|
-
@discount = discount
|
3465
|
-
@discount_end = discount_end
|
3466
|
-
@promotion_code = promotion_code
|
2599
|
+
# End of the invoice item period.
|
2600
|
+
attr_accessor :end
|
2601
|
+
# Start of the invoice item period.
|
2602
|
+
attr_accessor :start
|
2603
|
+
|
2604
|
+
def initialize(end_: nil, start: nil)
|
2605
|
+
@end = end_
|
2606
|
+
@start = start
|
3467
2607
|
end
|
3468
2608
|
end
|
3469
2609
|
|
@@ -3495,6 +2635,10 @@ module Stripe
|
|
3495
2635
|
end
|
3496
2636
|
# The coupons to redeem into discounts for the item.
|
3497
2637
|
attr_accessor :discounts
|
2638
|
+
# 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`.
|
2639
|
+
attr_accessor :metadata
|
2640
|
+
# The period associated with this invoice item. Defaults to the period of the underlying subscription that surrounds the start of the phase.
|
2641
|
+
attr_accessor :period
|
3498
2642
|
# The ID of the price object. One of `price` or `price_data` is required.
|
3499
2643
|
attr_accessor :price
|
3500
2644
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
@@ -3506,12 +2650,16 @@ module Stripe
|
|
3506
2650
|
|
3507
2651
|
def initialize(
|
3508
2652
|
discounts: nil,
|
2653
|
+
metadata: nil,
|
2654
|
+
period: nil,
|
3509
2655
|
price: nil,
|
3510
2656
|
price_data: nil,
|
3511
2657
|
quantity: nil,
|
3512
2658
|
tax_rates: nil
|
3513
2659
|
)
|
3514
2660
|
@discounts = discounts
|
2661
|
+
@metadata = metadata
|
2662
|
+
@period = period
|
3515
2663
|
@price = price
|
3516
2664
|
@price_data = price_data
|
3517
2665
|
@quantity = quantity
|
@@ -3555,44 +2703,16 @@ module Stripe
|
|
3555
2703
|
end
|
3556
2704
|
|
3557
2705
|
class Discount < Stripe::RequestParams
|
3558
|
-
class DiscountEnd < Stripe::RequestParams
|
3559
|
-
class Duration < Stripe::RequestParams
|
3560
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
3561
|
-
attr_accessor :interval
|
3562
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
3563
|
-
attr_accessor :interval_count
|
3564
|
-
|
3565
|
-
def initialize(interval: nil, interval_count: nil)
|
3566
|
-
@interval = interval
|
3567
|
-
@interval_count = interval_count
|
3568
|
-
end
|
3569
|
-
end
|
3570
|
-
# Time span for the redeemed discount.
|
3571
|
-
attr_accessor :duration
|
3572
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
3573
|
-
attr_accessor :timestamp
|
3574
|
-
# The type of calculation made to determine when the discount ends.
|
3575
|
-
attr_accessor :type
|
3576
|
-
|
3577
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
3578
|
-
@duration = duration
|
3579
|
-
@timestamp = timestamp
|
3580
|
-
@type = type
|
3581
|
-
end
|
3582
|
-
end
|
3583
2706
|
# ID of the coupon to create a new discount for.
|
3584
2707
|
attr_accessor :coupon
|
3585
2708
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
3586
2709
|
attr_accessor :discount
|
3587
|
-
# Details to determine how long the discount should be applied for.
|
3588
|
-
attr_accessor :discount_end
|
3589
2710
|
# ID of the promotion code to create a new discount for.
|
3590
2711
|
attr_accessor :promotion_code
|
3591
2712
|
|
3592
|
-
def initialize(coupon: nil, discount: nil,
|
2713
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
3593
2714
|
@coupon = coupon
|
3594
2715
|
@discount = discount
|
3595
|
-
@discount_end = discount_end
|
3596
2716
|
@promotion_code = promotion_code
|
3597
2717
|
end
|
3598
2718
|
end
|
@@ -3646,44 +2766,16 @@ module Stripe
|
|
3646
2766
|
end
|
3647
2767
|
|
3648
2768
|
class Discount < Stripe::RequestParams
|
3649
|
-
class DiscountEnd < Stripe::RequestParams
|
3650
|
-
class Duration < Stripe::RequestParams
|
3651
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
3652
|
-
attr_accessor :interval
|
3653
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
3654
|
-
attr_accessor :interval_count
|
3655
|
-
|
3656
|
-
def initialize(interval: nil, interval_count: nil)
|
3657
|
-
@interval = interval
|
3658
|
-
@interval_count = interval_count
|
3659
|
-
end
|
3660
|
-
end
|
3661
|
-
# Time span for the redeemed discount.
|
3662
|
-
attr_accessor :duration
|
3663
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
3664
|
-
attr_accessor :timestamp
|
3665
|
-
# The type of calculation made to determine when the discount ends.
|
3666
|
-
attr_accessor :type
|
3667
|
-
|
3668
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
3669
|
-
@duration = duration
|
3670
|
-
@timestamp = timestamp
|
3671
|
-
@type = type
|
3672
|
-
end
|
3673
|
-
end
|
3674
2769
|
# ID of the coupon to create a new discount for.
|
3675
2770
|
attr_accessor :coupon
|
3676
2771
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
3677
2772
|
attr_accessor :discount
|
3678
|
-
# Details to determine how long the discount should be applied for.
|
3679
|
-
attr_accessor :discount_end
|
3680
2773
|
# ID of the promotion code to create a new discount for.
|
3681
2774
|
attr_accessor :promotion_code
|
3682
2775
|
|
3683
|
-
def initialize(coupon: nil, discount: nil,
|
2776
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
3684
2777
|
@coupon = coupon
|
3685
2778
|
@discount = discount
|
3686
|
-
@discount_end = discount_end
|
3687
2779
|
@promotion_code = promotion_code
|
3688
2780
|
end
|
3689
2781
|
end
|
@@ -3729,18 +2821,6 @@ module Stripe
|
|
3729
2821
|
@unit_amount_decimal = unit_amount_decimal
|
3730
2822
|
end
|
3731
2823
|
end
|
3732
|
-
|
3733
|
-
class Trial < Stripe::RequestParams
|
3734
|
-
# 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.
|
3735
|
-
attr_accessor :converts_to
|
3736
|
-
# Determines the type of trial for this item.
|
3737
|
-
attr_accessor :type
|
3738
|
-
|
3739
|
-
def initialize(converts_to: nil, type: nil)
|
3740
|
-
@converts_to = converts_to
|
3741
|
-
@type = type
|
3742
|
-
end
|
3743
|
-
end
|
3744
2824
|
# 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.
|
3745
2825
|
attr_accessor :billing_thresholds
|
3746
2826
|
# The coupons to redeem into discounts for the subscription item.
|
@@ -3757,8 +2837,6 @@ module Stripe
|
|
3757
2837
|
attr_accessor :quantity
|
3758
2838
|
# 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.
|
3759
2839
|
attr_accessor :tax_rates
|
3760
|
-
# Options that configure the trial on the subscription item.
|
3761
|
-
attr_accessor :trial
|
3762
2840
|
|
3763
2841
|
def initialize(
|
3764
2842
|
billing_thresholds: nil,
|
@@ -3768,8 +2846,7 @@ module Stripe
|
|
3768
2846
|
price: nil,
|
3769
2847
|
price_data: nil,
|
3770
2848
|
quantity: nil,
|
3771
|
-
tax_rates: nil
|
3772
|
-
trial: nil
|
2849
|
+
tax_rates: nil
|
3773
2850
|
)
|
3774
2851
|
@billing_thresholds = billing_thresholds
|
3775
2852
|
@discounts = discounts
|
@@ -3779,16 +2856,6 @@ module Stripe
|
|
3779
2856
|
@price_data = price_data
|
3780
2857
|
@quantity = quantity
|
3781
2858
|
@tax_rates = tax_rates
|
3782
|
-
@trial = trial
|
3783
|
-
end
|
3784
|
-
end
|
3785
|
-
|
3786
|
-
class PauseCollection < Stripe::RequestParams
|
3787
|
-
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
3788
|
-
attr_accessor :behavior
|
3789
|
-
|
3790
|
-
def initialize(behavior: nil)
|
3791
|
-
@behavior = behavior
|
3792
2859
|
end
|
3793
2860
|
end
|
3794
2861
|
|
@@ -3803,23 +2870,6 @@ module Stripe
|
|
3803
2870
|
@destination = destination
|
3804
2871
|
end
|
3805
2872
|
end
|
3806
|
-
|
3807
|
-
class TrialSettings < Stripe::RequestParams
|
3808
|
-
class EndBehavior < Stripe::RequestParams
|
3809
|
-
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
3810
|
-
attr_accessor :prorate_up_front
|
3811
|
-
|
3812
|
-
def initialize(prorate_up_front: nil)
|
3813
|
-
@prorate_up_front = prorate_up_front
|
3814
|
-
end
|
3815
|
-
end
|
3816
|
-
# Defines how the subscription should behave when a trial ends.
|
3817
|
-
attr_accessor :end_behavior
|
3818
|
-
|
3819
|
-
def initialize(end_behavior: nil)
|
3820
|
-
@end_behavior = end_behavior
|
3821
|
-
end
|
3822
|
-
end
|
3823
2873
|
# A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
|
3824
2874
|
attr_accessor :add_invoice_items
|
3825
2875
|
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
|
@@ -3856,8 +2906,6 @@ module Stripe
|
|
3856
2906
|
attr_accessor :metadata
|
3857
2907
|
# The account on behalf of which to charge, for each of the associated subscription's invoices.
|
3858
2908
|
attr_accessor :on_behalf_of
|
3859
|
-
# If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
|
3860
|
-
attr_accessor :pause_collection
|
3861
2909
|
# Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.
|
3862
2910
|
attr_accessor :proration_behavior
|
3863
2911
|
# The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
|
@@ -3866,12 +2914,8 @@ module Stripe
|
|
3866
2914
|
attr_accessor :transfer_data
|
3867
2915
|
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
3868
2916
|
attr_accessor :trial
|
3869
|
-
# Specify trial behavior when crossing phase boundaries
|
3870
|
-
attr_accessor :trial_continuation
|
3871
2917
|
# Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
|
3872
2918
|
attr_accessor :trial_end
|
3873
|
-
# Settings related to subscription trials.
|
3874
|
-
attr_accessor :trial_settings
|
3875
2919
|
|
3876
2920
|
def initialize(
|
3877
2921
|
add_invoice_items: nil,
|
@@ -3892,14 +2936,11 @@ module Stripe
|
|
3892
2936
|
iterations: nil,
|
3893
2937
|
metadata: nil,
|
3894
2938
|
on_behalf_of: nil,
|
3895
|
-
pause_collection: nil,
|
3896
2939
|
proration_behavior: nil,
|
3897
2940
|
start_date: nil,
|
3898
2941
|
transfer_data: nil,
|
3899
2942
|
trial: nil,
|
3900
|
-
|
3901
|
-
trial_end: nil,
|
3902
|
-
trial_settings: nil
|
2943
|
+
trial_end: nil
|
3903
2944
|
)
|
3904
2945
|
@add_invoice_items = add_invoice_items
|
3905
2946
|
@application_fee_percent = application_fee_percent
|
@@ -3919,95 +2960,26 @@ module Stripe
|
|
3919
2960
|
@iterations = iterations
|
3920
2961
|
@metadata = metadata
|
3921
2962
|
@on_behalf_of = on_behalf_of
|
3922
|
-
@pause_collection = pause_collection
|
3923
2963
|
@proration_behavior = proration_behavior
|
3924
2964
|
@start_date = start_date
|
3925
2965
|
@transfer_data = transfer_data
|
3926
2966
|
@trial = trial
|
3927
|
-
@trial_continuation = trial_continuation
|
3928
2967
|
@trial_end = trial_end
|
3929
|
-
@trial_settings = trial_settings
|
3930
|
-
end
|
3931
|
-
end
|
3932
|
-
|
3933
|
-
class Prebilling < Stripe::RequestParams
|
3934
|
-
class BillUntil < Stripe::RequestParams
|
3935
|
-
class AmendmentEnd < Stripe::RequestParams
|
3936
|
-
# The position of the amendment in the `amendments` array at which prebilling should end. Indexes start from 0 and must be less than the total number of supplied amendments.
|
3937
|
-
attr_accessor :index
|
3938
|
-
|
3939
|
-
def initialize(index: nil)
|
3940
|
-
@index = index
|
3941
|
-
end
|
3942
|
-
end
|
3943
|
-
|
3944
|
-
class Duration < Stripe::RequestParams
|
3945
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
3946
|
-
attr_accessor :interval
|
3947
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
3948
|
-
attr_accessor :interval_count
|
3949
|
-
|
3950
|
-
def initialize(interval: nil, interval_count: nil)
|
3951
|
-
@interval = interval
|
3952
|
-
@interval_count = interval_count
|
3953
|
-
end
|
3954
|
-
end
|
3955
|
-
# End the prebilled period when a specified amendment ends.
|
3956
|
-
attr_accessor :amendment_end
|
3957
|
-
# Time span for prebilling, starting from `bill_from`.
|
3958
|
-
attr_accessor :duration
|
3959
|
-
# End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
3960
|
-
attr_accessor :timestamp
|
3961
|
-
# Select one of several ways to pass the `bill_until` value.
|
3962
|
-
attr_accessor :type
|
3963
|
-
|
3964
|
-
def initialize(amendment_end: nil, duration: nil, timestamp: nil, type: nil)
|
3965
|
-
@amendment_end = amendment_end
|
3966
|
-
@duration = duration
|
3967
|
-
@timestamp = timestamp
|
3968
|
-
@type = type
|
3969
|
-
end
|
3970
|
-
end
|
3971
|
-
# The end of the prebilled time period.
|
3972
|
-
attr_accessor :bill_until
|
3973
|
-
# This is used to determine the number of billing cycles to prebill.
|
3974
|
-
attr_accessor :iterations
|
3975
|
-
|
3976
|
-
def initialize(bill_until: nil, iterations: nil)
|
3977
|
-
@bill_until = bill_until
|
3978
|
-
@iterations = iterations
|
3979
2968
|
end
|
3980
2969
|
end
|
3981
|
-
# Changes to apply to the phases of the subscription schedule, in the order provided.
|
3982
|
-
attr_accessor :amendments
|
3983
|
-
# Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
|
3984
|
-
attr_accessor :billing_behavior
|
3985
2970
|
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
3986
2971
|
attr_accessor :billing_mode
|
3987
2972
|
# Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
|
3988
2973
|
attr_accessor :end_behavior
|
3989
2974
|
# List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
|
3990
2975
|
attr_accessor :phases
|
3991
|
-
# Provide any time periods to bill in advance.
|
3992
|
-
attr_accessor :prebilling
|
3993
2976
|
# In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
|
3994
2977
|
attr_accessor :proration_behavior
|
3995
2978
|
|
3996
|
-
def initialize(
|
3997
|
-
amendments: nil,
|
3998
|
-
billing_behavior: nil,
|
3999
|
-
billing_mode: nil,
|
4000
|
-
end_behavior: nil,
|
4001
|
-
phases: nil,
|
4002
|
-
prebilling: nil,
|
4003
|
-
proration_behavior: nil
|
4004
|
-
)
|
4005
|
-
@amendments = amendments
|
4006
|
-
@billing_behavior = billing_behavior
|
2979
|
+
def initialize(billing_mode: nil, end_behavior: nil, phases: nil, proration_behavior: nil)
|
4007
2980
|
@billing_mode = billing_mode
|
4008
2981
|
@end_behavior = end_behavior
|
4009
2982
|
@phases = phases
|
4010
|
-
@prebilling = prebilling
|
4011
2983
|
@proration_behavior = proration_behavior
|
4012
2984
|
end
|
4013
2985
|
end
|
@@ -4033,44 +3005,16 @@ module Stripe
|
|
4033
3005
|
end
|
4034
3006
|
|
4035
3007
|
class Discount < Stripe::RequestParams
|
4036
|
-
class DiscountEnd < Stripe::RequestParams
|
4037
|
-
class Duration < Stripe::RequestParams
|
4038
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
4039
|
-
attr_accessor :interval
|
4040
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
4041
|
-
attr_accessor :interval_count
|
4042
|
-
|
4043
|
-
def initialize(interval: nil, interval_count: nil)
|
4044
|
-
@interval = interval
|
4045
|
-
@interval_count = interval_count
|
4046
|
-
end
|
4047
|
-
end
|
4048
|
-
# Time span for the redeemed discount.
|
4049
|
-
attr_accessor :duration
|
4050
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
4051
|
-
attr_accessor :timestamp
|
4052
|
-
# The type of calculation made to determine when the discount ends.
|
4053
|
-
attr_accessor :type
|
4054
|
-
|
4055
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
4056
|
-
@duration = duration
|
4057
|
-
@timestamp = timestamp
|
4058
|
-
@type = type
|
4059
|
-
end
|
4060
|
-
end
|
4061
3008
|
# ID of the coupon to create a new discount for.
|
4062
3009
|
attr_accessor :coupon
|
4063
3010
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
4064
3011
|
attr_accessor :discount
|
4065
|
-
# Details to determine how long the discount should be applied for.
|
4066
|
-
attr_accessor :discount_end
|
4067
3012
|
# ID of the promotion code to create a new discount for.
|
4068
3013
|
attr_accessor :promotion_code
|
4069
3014
|
|
4070
|
-
def initialize(coupon: nil, discount: nil,
|
3015
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
4071
3016
|
@coupon = coupon
|
4072
3017
|
@discount = discount
|
4073
|
-
@discount_end = discount_end
|
4074
3018
|
@promotion_code = promotion_code
|
4075
3019
|
end
|
4076
3020
|
end
|
@@ -4165,15 +3109,6 @@ module Stripe
|
|
4165
3109
|
@tax_rates = tax_rates
|
4166
3110
|
end
|
4167
3111
|
end
|
4168
|
-
|
4169
|
-
class Prebilling < Stripe::RequestParams
|
4170
|
-
# This is used to determine the number of billing cycles to prebill.
|
4171
|
-
attr_accessor :iterations
|
4172
|
-
|
4173
|
-
def initialize(iterations: nil)
|
4174
|
-
@iterations = iterations
|
4175
|
-
end
|
4176
|
-
end
|
4177
3112
|
# For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.
|
4178
3113
|
attr_accessor :billing_cycle_anchor
|
4179
3114
|
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
@@ -4188,8 +3123,6 @@ module Stripe
|
|
4188
3123
|
attr_accessor :default_tax_rates
|
4189
3124
|
# A list of up to 20 subscription items, each with an attached price.
|
4190
3125
|
attr_accessor :items
|
4191
|
-
# The pre-billing to apply to the subscription as a preview.
|
4192
|
-
attr_accessor :prebilling
|
4193
3126
|
# 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`.
|
4194
3127
|
attr_accessor :proration_behavior
|
4195
3128
|
# If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'.
|
@@ -4209,7 +3142,6 @@ module Stripe
|
|
4209
3142
|
cancel_now: nil,
|
4210
3143
|
default_tax_rates: nil,
|
4211
3144
|
items: nil,
|
4212
|
-
prebilling: nil,
|
4213
3145
|
proration_behavior: nil,
|
4214
3146
|
proration_date: nil,
|
4215
3147
|
resume_at: nil,
|
@@ -4223,7 +3155,6 @@ module Stripe
|
|
4223
3155
|
@cancel_now = cancel_now
|
4224
3156
|
@default_tax_rates = default_tax_rates
|
4225
3157
|
@items = items
|
4226
|
-
@prebilling = prebilling
|
4227
3158
|
@proration_behavior = proration_behavior
|
4228
3159
|
@proration_date = proration_date
|
4229
3160
|
@resume_at = resume_at
|
@@ -4237,8 +3168,6 @@ module Stripe
|
|
4237
3168
|
attr_accessor :currency
|
4238
3169
|
# The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
|
4239
3170
|
attr_accessor :customer
|
4240
|
-
# The identifier of the account whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_account`, `customer_details`, `subscription`, or `schedule` must be set.
|
4241
|
-
attr_accessor :customer_account
|
4242
3171
|
# Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
|
4243
3172
|
attr_accessor :customer_details
|
4244
3173
|
# The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.
|
@@ -4266,7 +3195,6 @@ module Stripe
|
|
4266
3195
|
automatic_tax: nil,
|
4267
3196
|
currency: nil,
|
4268
3197
|
customer: nil,
|
4269
|
-
customer_account: nil,
|
4270
3198
|
customer_details: nil,
|
4271
3199
|
discounts: nil,
|
4272
3200
|
expand: nil,
|
@@ -4282,7 +3210,6 @@ module Stripe
|
|
4282
3210
|
@automatic_tax = automatic_tax
|
4283
3211
|
@currency = currency
|
4284
3212
|
@customer = customer
|
4285
|
-
@customer_account = customer_account
|
4286
3213
|
@customer_details = customer_details
|
4287
3214
|
@discounts = discounts
|
4288
3215
|
@expand = expand
|
@@ -4312,8 +3239,6 @@ module Stripe
|
|
4312
3239
|
attr_reader :amount_remaining
|
4313
3240
|
# This is the sum of all the shipping amounts.
|
4314
3241
|
attr_reader :amount_shipping
|
4315
|
-
# List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.
|
4316
|
-
attr_reader :amounts_due
|
4317
3242
|
# ID of the Connect Application that created the invoice.
|
4318
3243
|
attr_reader :application
|
4319
3244
|
# Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
|
@@ -4348,8 +3273,6 @@ module Stripe
|
|
4348
3273
|
attr_reader :custom_fields
|
4349
3274
|
# The ID of the customer who will be billed.
|
4350
3275
|
attr_reader :customer
|
4351
|
-
# The ID of the account who will be billed.
|
4352
|
-
attr_reader :customer_account
|
4353
3276
|
# The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.
|
4354
3277
|
attr_reader :customer_address
|
4355
3278
|
# The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated.
|
@@ -4364,8 +3287,6 @@ module Stripe
|
|
4364
3287
|
attr_reader :customer_tax_exempt
|
4365
3288
|
# The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.
|
4366
3289
|
attr_reader :customer_tax_ids
|
4367
|
-
# The margins applied to the invoice. Can be overridden by line item `margins`. Use `expand[]=default_margins` to expand each margin.
|
4368
|
-
attr_reader :default_margins
|
4369
3290
|
# ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
|
4370
3291
|
attr_reader :default_payment_method
|
4371
3292
|
# ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
|
@@ -4456,8 +3377,6 @@ module Stripe
|
|
4456
3377
|
attr_reader :total_discount_amounts
|
4457
3378
|
# The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
|
4458
3379
|
attr_reader :total_excluding_tax
|
4459
|
-
# The aggregate amounts calculated per margin across all line items.
|
4460
|
-
attr_reader :total_margin_amounts
|
4461
3380
|
# Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
|
4462
3381
|
attr_reader :total_pretax_credit_amounts
|
4463
3382
|
# The aggregate tax information of all line items.
|