stripe 15.1.0.pre.beta.2 → 15.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +696 -1554
- data/OPENAPI_VERSION +1 -1
- data/README.md +6 -0
- data/VERSION +1 -1
- data/lib/stripe/api_requestor.rb +0 -28
- data/lib/stripe/api_version.rb +1 -1
- data/lib/stripe/errors.rb +0 -54
- data/lib/stripe/event_types.rb +1 -75
- data/lib/stripe/events/v1_billing_meter_error_report_triggered_event.rb +1 -1
- data/lib/stripe/events/v1_billing_meter_no_meter_found_event.rb +1 -1
- data/lib/stripe/events/{v2_core_account_including_identity_updated_event.rb → v2_core_event_destination_ping_event.rb} +3 -3
- data/lib/stripe/object_types.rb +0 -53
- data/lib/stripe/resources/account.rb +3 -655
- data/lib/stripe/resources/account_session.rb +1 -299
- data/lib/stripe/resources/billing/credit_balance_summary.rb +0 -2
- data/lib/stripe/resources/billing/credit_balance_transaction.rb +0 -4
- data/lib/stripe/resources/billing/credit_grant.rb +0 -10
- data/lib/stripe/resources/billing_portal/session.rb +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 +0 -1470
- data/lib/stripe/resources/checkout/session.rb +3 -327
- data/lib/stripe/resources/confirmation_token.rb +3 -177
- data/lib/stripe/resources/coupon.rb +1 -30
- data/lib/stripe/resources/credit_note.rb +0 -10
- data/lib/stripe/resources/credit_note_line_item.rb +0 -9
- data/lib/stripe/resources/customer.rb +2 -4
- 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/event.rb +0 -31
- data/lib/stripe/resources/financial_connections/account.rb +1 -20
- data/lib/stripe/resources/financial_connections/session.rb +2 -62
- data/lib/stripe/resources/identity/verification_session.rb +0 -10
- data/lib/stripe/resources/invoice.rb +17 -1123
- 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 +53 -2
- 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 +331 -5153
- data/lib/stripe/resources/payment_method.rb +1 -196
- data/lib/stripe/resources/payment_method_configuration.rb +0 -295
- data/lib/stripe/resources/payout.rb +0 -6
- data/lib/stripe/resources/price.rb +0 -30
- data/lib/stripe/resources/product.rb +0 -59
- data/lib/stripe/resources/promotion_code.rb +0 -10
- data/lib/stripe/resources/quote.rb +6 -2040
- data/lib/stripe/resources/refund.rb +0 -9
- data/lib/stripe/resources/setup_attempt.rb +0 -21
- data/lib/stripe/resources/setup_intent.rb +9 -596
- data/lib/stripe/resources/source.rb +0 -29
- data/lib/stripe/resources/subscription.rb +11 -294
- data/lib/stripe/resources/subscription_item.rb +3 -84
- data/lib/stripe/resources/subscription_schedule.rb +10 -1007
- data/lib/stripe/resources/tax/calculation.rb +2 -2
- data/lib/stripe/resources/tax/registration.rb +60 -0
- data/lib/stripe/resources/tax/transaction.rb +1 -1
- data/lib/stripe/resources/tax_id.rb +4 -14
- data/lib/stripe/resources/terminal/reader.rb +0 -406
- 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_payment.rb +1 -4
- 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/v2/billing/meter_event.rb +2 -2
- data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +2 -2
- data/lib/stripe/resources/v2/billing/meter_event_session.rb +2 -2
- data/lib/stripe/resources/v2/event.rb +2 -2
- data/lib/stripe/resources/v2/event_destination.rb +2 -2
- data/lib/stripe/resources.rb +1 -90
- data/lib/stripe/services/account_external_account_service.rb +1 -1
- data/lib/stripe/services/account_service.rb +3 -564
- data/lib/stripe/services/account_session_service.rb +1 -269
- data/lib/stripe/services/billing/credit_balance_summary_service.rb +1 -4
- data/lib/stripe/services/billing/credit_balance_transaction_service.rb +0 -4
- data/lib/stripe/services/billing/credit_grant_service.rb +0 -8
- data/lib/stripe/services/billing_portal/session_service.rb +0 -4
- data/lib/stripe/services/charge_service.rb +0 -1350
- data/lib/stripe/services/checkout/session_service.rb +2 -243
- data/lib/stripe/services/coupon_service.rb +1 -17
- data/lib/stripe/services/credit_note_service.rb +0 -4
- data/lib/stripe/services/customer_payment_method_service.rb +1 -1
- data/lib/stripe/services/customer_service.rb +1 -1
- data/lib/stripe/services/customer_session_service.rb +1 -4
- data/lib/stripe/services/customer_tax_id_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 +83 -0
- data/lib/stripe/services/invoice_service.rb +16 -1052
- 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 +283 -4656
- data/lib/stripe/services/payment_method_configuration_service.rb +0 -210
- data/lib/stripe/services/payment_method_service.rb +1 -126
- data/lib/stripe/services/payout_service.rb +0 -4
- data/lib/stripe/services/price_service.rb +0 -19
- data/lib/stripe/services/product_service.rb +0 -38
- data/lib/stripe/services/promotion_code_service.rb +0 -8
- data/lib/stripe/services/quote_service.rb +7 -1726
- data/lib/stripe/services/setup_intent_service.rb +9 -556
- data/lib/stripe/services/subscription_item_service.rb +3 -75
- data/lib/stripe/services/subscription_schedule_service.rb +10 -911
- data/lib/stripe/services/subscription_service.rb +10 -254
- data/lib/stripe/services/tax/calculation_service.rb +1 -1
- data/lib/stripe/services/tax/registration_service.rb +39 -0
- data/lib/stripe/services/tax_id_service.rb +3 -9
- data/lib/stripe/services/tax_service.rb +1 -3
- data/lib/stripe/services/terminal/reader_service.rb +0 -180
- data/lib/stripe/services/terminal_service.rb +1 -2
- data/lib/stripe/services/test_helpers/confirmation_token_service.rb +3 -106
- data/lib/stripe/services/test_helpers/terminal/reader_service.rb +0 -43
- 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_payment_service.rb +1 -4
- data/lib/stripe/services/treasury/outbound_transfer_service.rb +0 -24
- data/lib/stripe/services/v1_services.rb +2 -12
- data/lib/stripe/services/v2/core_service.rb +1 -4
- data/lib/stripe/services/v2_services.rb +2 -4
- data/lib/stripe/services.rb +1 -54
- data/lib/stripe/stripe_configuration.rb +1 -3
- data/lib/stripe/stripe_object.rb +1 -1
- data/lib/stripe/util.rb +1 -7
- data/lib/stripe/version.rb +1 -1
- data/lib/stripe.rb +0 -53
- data/rbi/stripe/resources/account.rbi +4903 -0
- data/rbi/stripe/resources/account_link.rbi +74 -0
- data/rbi/stripe/resources/account_session.rbi +894 -0
- data/rbi/stripe/resources/apple_pay_domain.rbi +90 -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 +180 -0
- data/rbi/stripe/resources/balance_transaction.rbi +144 -0
- data/rbi/stripe/resources/bank_account.rbi +127 -0
- data/rbi/stripe/resources/billing/alert.rbi +201 -0
- data/rbi/stripe/resources/billing/alert_triggered.rbi +28 -0
- data/rbi/stripe/resources/billing/credit_balance_summary.rbi +63 -0
- data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +147 -0
- data/rbi/stripe/resources/billing/credit_grant.rbi +291 -0
- data/rbi/stripe/resources/billing/meter.rbi +226 -0
- data/rbi/stripe/resources/billing/meter_event.rbi +64 -0
- data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +64 -0
- data/rbi/stripe/resources/billing/meter_event_summary.rbi +35 -0
- data/rbi/stripe/resources/billing_portal/configuration.rbi +645 -0
- data/rbi/stripe/resources/billing_portal/session.rbi +345 -0
- data/rbi/stripe/resources/capability.rbi +125 -0
- data/rbi/stripe/resources/card.rbi +125 -0
- data/rbi/stripe/resources/cash_balance.rbi +32 -0
- data/rbi/stripe/resources/charge.rbi +2057 -0
- data/rbi/stripe/resources/checkout/session.rbi +3988 -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 +1873 -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 +252 -0
- data/rbi/stripe/resources/credit_note.rbi +747 -0
- data/rbi/stripe/resources/credit_note_line_item.rbi +101 -0
- data/rbi/stripe/resources/customer.rbi +1009 -0
- data/rbi/stripe/resources/customer_balance_transaction.rbi +56 -0
- data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +151 -0
- data/rbi/stripe/resources/customer_session.rbi +200 -0
- data/rbi/stripe/resources/discount.rbi +53 -0
- data/rbi/stripe/resources/dispute.rbi +761 -0
- data/rbi/stripe/resources/entitlements/active_entitlement.rbi +58 -0
- data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +23 -0
- data/rbi/stripe/resources/entitlements/feature.rbi +117 -0
- data/rbi/stripe/resources/ephemeral_key.rbi +44 -0
- data/rbi/stripe/resources/event.rbi +149 -0
- data/rbi/stripe/resources/exchange_rate.rbi +66 -0
- data/rbi/stripe/resources/file.rbi +143 -0
- data/rbi/stripe/resources/file_link.rbi +141 -0
- data/rbi/stripe/resources/financial_connections/account.rbi +339 -0
- data/rbi/stripe/resources/financial_connections/account_owner.rbi +35 -0
- data/rbi/stripe/resources/financial_connections/account_ownership.rbi +23 -0
- data/rbi/stripe/resources/financial_connections/session.rbi +123 -0
- data/rbi/stripe/resources/financial_connections/transaction.rbi +124 -0
- data/rbi/stripe/resources/forwarding/request.rbi +216 -0
- data/rbi/stripe/resources/funding_instructions.rbi +437 -0
- data/rbi/stripe/resources/identity/verification_report.rbi +351 -0
- data/rbi/stripe/resources/identity/verification_session.rbi +517 -0
- data/rbi/stripe/resources/invoice.rbi +3736 -0
- data/rbi/stripe/resources/invoice_item.rbi +475 -0
- data/rbi/stripe/resources/invoice_line_item.rbi +432 -0
- data/rbi/stripe/resources/invoice_payment.rbi +114 -0
- data/rbi/stripe/resources/invoice_rendering_template.rbi +104 -0
- data/rbi/stripe/resources/issuing/authorization.rbi +1283 -0
- data/rbi/stripe/resources/issuing/card.rbi +741 -0
- data/rbi/stripe/resources/issuing/cardholder.rbi +744 -0
- data/rbi/stripe/resources/issuing/dispute.rbi +913 -0
- data/rbi/stripe/resources/issuing/personalization_design.rbi +338 -0
- data/rbi/stripe/resources/issuing/physical_bundle.rbi +79 -0
- data/rbi/stripe/resources/issuing/token.rbi +226 -0
- data/rbi/stripe/resources/issuing/transaction.rbi +1061 -0
- data/rbi/stripe/resources/line_item.rbi +72 -0
- data/rbi/stripe/resources/login_link.rbi +19 -0
- data/rbi/stripe/resources/mandate.rbi +187 -0
- data/rbi/stripe/resources/payment_intent.rbi +9795 -0
- data/rbi/stripe/resources/payment_link.rbi +1801 -0
- data/rbi/stripe/resources/payment_method.rbi +1831 -0
- data/rbi/stripe/resources/payment_method_configuration.rbi +3220 -0
- data/rbi/stripe/resources/payment_method_domain.rbi +228 -0
- data/rbi/stripe/resources/payout.rbi +300 -0
- data/rbi/stripe/resources/person.rbi +401 -0
- data/rbi/stripe/resources/plan.rbi +373 -0
- data/rbi/stripe/resources/price.rbi +694 -0
- data/rbi/stripe/resources/product.rbi +557 -0
- data/rbi/stripe/resources/product_feature.rbi +26 -0
- data/rbi/stripe/resources/promotion_code.rbi +261 -0
- data/rbi/stripe/resources/quote.rbi +1126 -0
- data/rbi/stripe/resources/radar/early_fraud_warning.rbi +98 -0
- data/rbi/stripe/resources/radar/value_list.rbi +170 -0
- data/rbi/stripe/resources/radar/value_list_item.rbi +131 -0
- data/rbi/stripe/resources/refund.rbi +519 -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 +3869 -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 +1964 -0
- data/rbi/stripe/resources/subscription_item.rbi +370 -0
- data/rbi/stripe/resources/subscription_schedule.rbi +1495 -0
- data/rbi/stripe/resources/tax/calculation.rbi +474 -0
- data/rbi/stripe/resources/tax/calculation_line_item.rbi +88 -0
- data/rbi/stripe/resources/tax/registration.rbi +2713 -0
- data/rbi/stripe/resources/tax/settings.rbi +141 -0
- data/rbi/stripe/resources/tax/transaction.rbi +351 -0
- data/rbi/stripe/resources/tax/transaction_line_item.rbi +54 -0
- data/rbi/stripe/resources/tax_code.rbi +44 -0
- data/rbi/stripe/resources/tax_deducted_at_source.rbi +23 -0
- data/rbi/stripe/resources/tax_id.rbi +167 -0
- data/rbi/stripe/resources/tax_rate.rbi +239 -0
- data/rbi/stripe/resources/terminal/configuration.rbi +1388 -0
- data/rbi/stripe/resources/terminal/connection_token.rbi +37 -0
- data/rbi/stripe/resources/terminal/location.rbi +224 -0
- data/rbi/stripe/resources/terminal/reader.rbi +587 -0
- data/rbi/stripe/resources/test_helpers/test_clock.rbi +134 -0
- data/rbi/stripe/resources/token.rbi +1283 -0
- data/rbi/stripe/resources/topup.rbi +222 -0
- data/rbi/stripe/resources/transfer.rbi +199 -0
- data/rbi/stripe/resources/treasury/credit_reversal.rbi +119 -0
- data/rbi/stripe/resources/treasury/debit_reversal.rbi +131 -0
- data/rbi/stripe/resources/treasury/financial_account.rbi +865 -0
- data/rbi/stripe/resources/treasury/financial_account_features.rbi +260 -0
- data/rbi/stripe/resources/treasury/inbound_transfer.rbi +295 -0
- data/rbi/stripe/resources/treasury/outbound_payment.rbi +592 -0
- data/rbi/stripe/resources/treasury/outbound_transfer.rbi +431 -0
- data/rbi/stripe/resources/treasury/received_credit.rbi +302 -0
- data/rbi/stripe/resources/treasury/received_debit.rbi +256 -0
- data/rbi/stripe/resources/treasury/transaction.rbi +215 -0
- data/rbi/stripe/resources/treasury/transaction_entry.rbi +192 -0
- data/rbi/stripe/resources/v2/amount.rbi +14 -0
- data/rbi/stripe/resources/v2/billing/meter_event.rbi +37 -0
- data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +41 -0
- data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +31 -0
- data/rbi/stripe/resources/v2/event.rbi +48 -0
- data/rbi/stripe/resources/v2/event_destination.rbi +91 -0
- data/rbi/stripe/resources/webhook_endpoint.rbi +170 -0
- data/rbi/stripe/services/account_capability_service.rbi +51 -0
- data/{lib/stripe/services/external_account_service.rb → rbi/stripe/services/account_external_account_service.rbi} +124 -136
- data/rbi/stripe/services/account_link_service.rbi +58 -0
- data/rbi/stripe/services/account_login_link_service.rbi +22 -0
- data/rbi/stripe/services/account_person_service.rbi +1013 -0
- data/rbi/stripe/services/account_service.rbi +4189 -0
- data/rbi/stripe/services/account_session_service.rbi +572 -0
- data/rbi/stripe/services/apple_pay_domain_service.rbi +78 -0
- data/rbi/stripe/services/application_fee_refund_service.rbi +93 -0
- data/rbi/stripe/services/application_fee_service.rbi +78 -0
- data/rbi/stripe/services/apps/secret_service.rbi +151 -0
- data/rbi/stripe/services/apps_service.rbi +9 -0
- data/rbi/stripe/services/balance_service.rbi +21 -0
- data/rbi/stripe/services/balance_transaction_service.rbi +93 -0
- data/rbi/stripe/services/billing/alert_service.rbi +152 -0
- data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +68 -0
- data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +59 -0
- data/rbi/stripe/services/billing/credit_grant_service.rbi +211 -0
- data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +42 -0
- data/rbi/stripe/services/billing/meter_event_service.rbi +42 -0
- data/rbi/stripe/services/billing/meter_event_summary_service.rbi +54 -0
- data/rbi/stripe/services/billing/meter_service.rbi +163 -0
- data/rbi/stripe/services/billing_portal/configuration_service.rbi +511 -0
- data/rbi/stripe/services/billing_portal/session_service.rbi +204 -0
- data/rbi/stripe/services/billing_portal_service.rbi +10 -0
- data/rbi/stripe/services/billing_service.rbi +15 -0
- data/rbi/stripe/services/charge_service.rbi +448 -0
- data/rbi/stripe/services/checkout/session_line_item_service.rbi +33 -0
- data/rbi/stripe/services/checkout/session_service.rbi +2607 -0
- data/rbi/stripe/services/checkout_service.rbi +9 -0
- data/rbi/stripe/services/climate/order_service.rbi +142 -0
- data/{lib/stripe/services/financial_connections/institution_service.rb → rbi/stripe/services/climate/product_service.rbi} +25 -36
- data/{lib/stripe/services/privacy/redaction_job_validation_error_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 +196 -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 +416 -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 +651 -0
- data/rbi/stripe/services/customer_session_service.rbi +116 -0
- data/rbi/stripe/services/customer_tax_id_service.rbi +72 -0
- data/rbi/stripe/services/dispute_service.rbi +424 -0
- data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +55 -0
- data/rbi/stripe/services/entitlements/feature_service.rbi +107 -0
- data/rbi/stripe/services/entitlements_service.rbi +10 -0
- data/rbi/stripe/services/ephemeral_key_service.rbi +53 -0
- data/rbi/stripe/services/event_service.rbi +83 -0
- data/rbi/stripe/services/exchange_rate_service.rbi +44 -0
- data/rbi/stripe/services/file_link_service.rbi +124 -0
- data/rbi/stripe/services/file_service.rbi +116 -0
- data/rbi/stripe/services/financial_connections/account_owner_service.rbi +42 -0
- data/rbi/stripe/services/financial_connections/account_service.rbi +133 -0
- data/rbi/stripe/services/financial_connections/session_service.rbi +88 -0
- data/rbi/stripe/services/financial_connections/transaction_service.rbi +92 -0
- data/rbi/stripe/services/financial_connections_service.rbi +11 -0
- data/rbi/stripe/services/forwarding/request_service.rbi +134 -0
- data/rbi/stripe/services/forwarding_service.rbi +9 -0
- data/rbi/stripe/services/identity/verification_report_service.rbi +87 -0
- data/rbi/stripe/services/identity/verification_session_service.rbi +323 -0
- data/rbi/stripe/services/identity_service.rbi +10 -0
- data/rbi/stripe/services/invoice_item_service.rbi +368 -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 +2920 -0
- data/rbi/stripe/services/issuing/authorization_service.rbi +146 -0
- data/rbi/stripe/services/issuing/card_service.rbi +495 -0
- data/rbi/stripe/services/issuing/cardholder_service.rbi +587 -0
- data/rbi/stripe/services/issuing/dispute_service.rbi +707 -0
- data/rbi/stripe/services/issuing/personalization_design_service.rbi +243 -0
- data/rbi/stripe/services/issuing/physical_bundle_service.rbi +59 -0
- data/rbi/stripe/services/issuing/token_service.rbi +99 -0
- data/rbi/stripe/services/issuing/transaction_service.rbi +105 -0
- data/rbi/stripe/services/issuing_service.rbi +16 -0
- data/rbi/stripe/services/mandate_service.rbi +20 -0
- data/rbi/stripe/services/payment_intent_service.rbi +7819 -0
- data/{lib/stripe/services/payment_intent_amount_details_line_item_service.rb → rbi/stripe/services/payment_link_line_item_service.rbi} +16 -20
- data/rbi/stripe/services/payment_link_service.rbi +1352 -0
- data/rbi/stripe/services/payment_method_configuration_service.rbi +2255 -0
- data/rbi/stripe/services/payment_method_domain_service.rbi +112 -0
- data/rbi/stripe/services/payment_method_service.rbi +846 -0
- data/rbi/stripe/services/payout_service.rbi +205 -0
- data/rbi/stripe/services/plan_service.rbi +284 -0
- data/rbi/stripe/services/price_service.rbi +546 -0
- data/rbi/stripe/services/product_feature_service.rbi +69 -0
- data/rbi/stripe/services/product_service.rbi +479 -0
- data/rbi/stripe/services/promotion_code_service.rbi +214 -0
- data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +31 -0
- data/{lib/stripe/services/order_line_item_service.rb → rbi/stripe/services/quote_line_item_service.rbi} +16 -20
- data/rbi/stripe/services/quote_service.rbi +686 -0
- data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +85 -0
- data/rbi/stripe/services/radar/value_list_item_service.rbi +111 -0
- data/rbi/stripe/services/radar/value_list_service.rbi +143 -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 +3605 -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 +324 -0
- data/rbi/stripe/services/subscription_schedule_service.rbi +1192 -0
- data/rbi/stripe/services/subscription_service.rbi +1596 -0
- data/rbi/stripe/services/tax/calculation_line_item_service.rbi +33 -0
- data/rbi/stripe/services/tax/calculation_service.rbi +230 -0
- data/rbi/stripe/services/tax/registration_service.rbi +1845 -0
- data/rbi/stripe/services/tax/settings_service.rbi +93 -0
- data/{lib/stripe/services/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 +112 -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 +1120 -0
- data/rbi/stripe/services/terminal/connection_token_service.rbi +25 -0
- data/rbi/stripe/services/terminal/location_service.rbi +184 -0
- data/rbi/stripe/services/terminal/reader_service.rbi +344 -0
- data/rbi/stripe/services/terminal_service.rbi +12 -0
- data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +805 -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 +62 -0
- data/rbi/stripe/services/test_helpers/terminal_service.rbi +11 -0
- data/rbi/stripe/services/test_helpers/test_clock_service.rbi +92 -0
- data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +64 -0
- data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +125 -0
- data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +125 -0
- data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +87 -0
- data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +87 -0
- data/rbi/stripe/services/test_helpers/treasury_service.rbi +15 -0
- data/rbi/stripe/services/test_helpers_service.rbi +15 -0
- data/rbi/stripe/services/token_service.rbi +1257 -0
- data/rbi/stripe/services/topup_service.rbi +176 -0
- data/rbi/stripe/services/transfer_reversal_service.rbi +101 -0
- data/rbi/stripe/services/transfer_service.rbi +152 -0
- data/rbi/stripe/services/treasury/credit_reversal_service.rbi +84 -0
- data/rbi/stripe/services/treasury/debit_reversal_service.rbi +88 -0
- data/rbi/stripe/services/treasury/financial_account_features_service.rbi +198 -0
- data/rbi/stripe/services/treasury/financial_account_service.rbi +562 -0
- data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +117 -0
- data/rbi/stripe/services/treasury/outbound_payment_service.rbi +304 -0
- data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +157 -0
- data/rbi/stripe/services/treasury/received_credit_service.rbi +72 -0
- data/rbi/stripe/services/treasury/received_debit_service.rbi +59 -0
- data/rbi/stripe/services/treasury/transaction_entry_service.rbi +111 -0
- data/rbi/stripe/services/treasury/transaction_service.rbi +122 -0
- data/rbi/stripe/services/treasury_service.rbi +18 -0
- data/rbi/stripe/services/v1_services.rbi +77 -0
- data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +39 -0
- data/rbi/stripe/services/v2/billing/meter_event_service.rbi +42 -0
- data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +20 -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 +200 -0
- data/rbi/stripe/services/v2/core/event_service.rbi +38 -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 +131 -0
- data/stripe.gemspec +1 -4
- metadata +326 -149
- 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_requirements_updated_event.rb +0 -21
- data/lib/stripe/events/v2_core_account_link_completed_event.rb +0 -13
- data/lib/stripe/events/v2_core_account_person_created_event.rb +0 -23
- data/lib/stripe/events/v2_core_account_person_deleted_event.rb +0 -23
- data/lib/stripe/events/v2_core_account_person_updated_event.rb +0 -23
- data/lib/stripe/events/v2_money_management_financial_account_created_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_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_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/resources/account_notice.rb +0 -123
- data/lib/stripe/resources/balance_settings.rb +0 -105
- data/lib/stripe/resources/billing/meter_error_report.rb +0 -59
- data/lib/stripe/resources/capital/financing_offer.rb +0 -179
- data/lib/stripe/resources/capital/financing_summary.rb +0 -55
- data/lib/stripe/resources/capital/financing_transaction.rb +0 -114
- data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -27
- data/lib/stripe/resources/financial_connections/institution.rb +0 -90
- data/lib/stripe/resources/fx_quote.rb +0 -184
- data/lib/stripe/resources/gift_cards/card.rb +0 -208
- data/lib/stripe/resources/gift_cards/transaction.rb +0 -272
- data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -602
- data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -82
- data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -86
- data/lib/stripe/resources/issuing/settlement.rb +0 -53
- data/lib/stripe/resources/margin.rb +0 -115
- data/lib/stripe/resources/order.rb +0 -2859
- data/lib/stripe/resources/payment_attempt_record.rb +0 -1078
- data/lib/stripe/resources/payment_intent_amount_details_line_item.rb +0 -65
- data/lib/stripe/resources/payment_record.rb +0 -1607
- data/lib/stripe/resources/privacy/redaction_job.rb +0 -254
- data/lib/stripe/resources/privacy/redaction_job_root_objects.rb +0 -35
- data/lib/stripe/resources/privacy/redaction_job_validation_error.rb +0 -25
- data/lib/stripe/resources/quote_line.rb +0 -274
- data/lib/stripe/resources/quote_preview_invoice.rb +0 -663
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -337
- data/lib/stripe/resources/tax/association.rb +0 -89
- data/lib/stripe/resources/tax/form.rb +0 -211
- data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -31
- data/lib/stripe/resources/v2/core/account.rb +0 -1715
- data/lib/stripe/resources/v2/core/account_link.rb +0 -54
- data/lib/stripe/resources/v2/core/person.rb +0 -272
- data/lib/stripe/resources/v2/core/vault/gb_bank_account.rb +0 -72
- data/lib/stripe/resources/v2/core/vault/us_bank_account.rb +0 -37
- data/lib/stripe/resources/v2/financial_address_credit_simulation.rb +0 -18
- data/lib/stripe/resources/v2/financial_address_generated_microdeposits.rb +0 -20
- data/lib/stripe/resources/v2/money_management/adjustment.rb +0 -49
- data/lib/stripe/resources/v2/money_management/financial_account.rb +0 -56
- data/lib/stripe/resources/v2/money_management/financial_address.rb +0 -66
- data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +0 -92
- data/lib/stripe/resources/v2/money_management/outbound_payment.rb +0 -127
- data/lib/stripe/resources/v2/money_management/outbound_payment_quote.rb +0 -74
- data/lib/stripe/resources/v2/money_management/outbound_setup_intent.rb +0 -43
- data/lib/stripe/resources/v2/money_management/outbound_transfer.rb +0 -115
- data/lib/stripe/resources/v2/money_management/payout_method.rb +0 -73
- data/lib/stripe/resources/v2/money_management/payout_methods_bank_account_spec.rb +0 -47
- data/lib/stripe/resources/v2/money_management/received_credit.rb +0 -134
- data/lib/stripe/resources/v2/money_management/received_debit.rb +0 -106
- data/lib/stripe/resources/v2/money_management/transaction.rb +0 -76
- data/lib/stripe/resources/v2/money_management/transaction_entry.rb +0 -66
- data/lib/stripe/services/account_notice_service.rb +0 -101
- data/lib/stripe/services/balance_settings_service.rb +0 -96
- data/lib/stripe/services/capital/financing_offer_service.rb +0 -112
- data/lib/stripe/services/capital/financing_summary_service.rb +0 -28
- data/lib/stripe/services/capital/financing_transaction_service.rb +0 -79
- data/lib/stripe/services/capital_service.rb +0 -15
- data/lib/stripe/services/fx_quote_service.rb +0 -123
- data/lib/stripe/services/gift_cards/card_service.rb +0 -170
- data/lib/stripe/services/gift_cards/transaction_service.rb +0 -209
- data/lib/stripe/services/gift_cards_service.rb +0 -14
- data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -504
- data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -66
- data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -83
- data/lib/stripe/services/margin_service.rb +0 -119
- data/lib/stripe/services/order_service.rb +0 -2268
- data/lib/stripe/services/payment_attempt_record_service.rb +0 -49
- data/lib/stripe/services/payment_record_service.rb +0 -542
- data/lib/stripe/services/privacy/redaction_job_service.rb +0 -231
- data/lib/stripe/services/privacy_service.rb +0 -13
- data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -35
- data/lib/stripe/services/tax/association_service.rb +0 -31
- data/lib/stripe/services/tax/form_service.rb +0 -100
- data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -28
- data/lib/stripe/services/v2/core/account_link_service.rb +0 -76
- data/lib/stripe/services/v2/core/account_service.rb +0 -4130
- data/lib/stripe/services/v2/core/accounts/person_service.rb +0 -1040
- data/lib/stripe/services/v2/core/vault/gb_bank_account_service.rb +0 -135
- data/lib/stripe/services/v2/core/vault/us_bank_account_service.rb +0 -109
- data/lib/stripe/services/v2/core/vault_service.rb +0 -18
- data/lib/stripe/services/v2/money_management/adjustment_service.rb +0 -75
- data/lib/stripe/services/v2/money_management/financial_account_service.rb +0 -44
- data/lib/stripe/services/v2/money_management/financial_address_service.rb +0 -81
- data/lib/stripe/services/v2/money_management/inbound_transfer_service.rb +0 -126
- data/lib/stripe/services/v2/money_management/outbound_payment_quote_service.rb +0 -80
- data/lib/stripe/services/v2/money_management/outbound_payment_service.rb +0 -202
- data/lib/stripe/services/v2/money_management/outbound_setup_intent_service.rb +0 -237
- data/lib/stripe/services/v2/money_management/outbound_transfer_service.rb +0 -174
- data/lib/stripe/services/v2/money_management/payout_method_service.rb +0 -95
- data/lib/stripe/services/v2/money_management/payout_methods_bank_account_spec_service.rb +0 -32
- data/lib/stripe/services/v2/money_management/received_credit_service.rb +0 -71
- data/lib/stripe/services/v2/money_management/received_debit_service.rb +0 -44
- data/lib/stripe/services/v2/money_management/transaction_entry_service.rb +0 -70
- data/lib/stripe/services/v2/money_management/transaction_service.rb +0 -74
- data/lib/stripe/services/v2/money_management_service.rb +0 -31
- data/lib/stripe/services/v2/test_helper_service.rb +0 -15
- data/lib/stripe/services/v2/test_helpers/financial_address_service.rb +0 -50
- data/rbi/stripe.rbi +0 -191592
@@ -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`.
|
@@ -144,7 +125,7 @@ module Stripe
|
|
144
125
|
end
|
145
126
|
|
146
127
|
class CustomerTaxId < Stripe::StripeObject
|
147
|
-
# The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`
|
128
|
+
# The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`
|
148
129
|
attr_reader :type
|
149
130
|
# The value of the tax ID.
|
150
131
|
attr_reader :value
|
@@ -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,7 +283,6 @@ 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
|
|
@@ -319,8 +291,6 @@ module Stripe
|
|
319
291
|
class Filters < Stripe::StripeObject
|
320
292
|
# The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
|
321
293
|
attr_reader :account_subcategories
|
322
|
-
# The institution to use to filter for possible accounts to link.
|
323
|
-
attr_reader :institution
|
324
294
|
end
|
325
295
|
# Attribute for field filters
|
326
296
|
attr_reader :filters
|
@@ -342,8 +312,6 @@ module Stripe
|
|
342
312
|
attr_reader :card
|
343
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.
|
344
314
|
attr_reader :customer_balance
|
345
|
-
# 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.
|
346
|
-
attr_reader :id_bank_transfer
|
347
315
|
# If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
|
348
316
|
attr_reader :konbini
|
349
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.
|
@@ -457,13 +425,6 @@ module Stripe
|
|
457
425
|
attr_reader :discount
|
458
426
|
end
|
459
427
|
|
460
|
-
class TotalMarginAmount < Stripe::StripeObject
|
461
|
-
# The amount, in cents (or local equivalent), of the reduction in line item amount.
|
462
|
-
attr_reader :amount
|
463
|
-
# The margin that was applied to get this margin amount.
|
464
|
-
attr_reader :margin
|
465
|
-
end
|
466
|
-
|
467
428
|
class TotalPretaxCreditAmount < Stripe::StripeObject
|
468
429
|
# The amount, in cents (or local equivalent), of the pretax credit amount.
|
469
430
|
attr_reader :amount
|
@@ -471,8 +432,6 @@ module Stripe
|
|
471
432
|
attr_reader :credit_balance_transaction
|
472
433
|
# The discount that was applied to get this pretax credit amount.
|
473
434
|
attr_reader :discount
|
474
|
-
# The margin that was applied to get this pretax credit amount.
|
475
|
-
attr_reader :margin
|
476
435
|
# Type of the pretax credit amount referenced.
|
477
436
|
attr_reader :type
|
478
437
|
end
|
@@ -500,24 +459,6 @@ module Stripe
|
|
500
459
|
end
|
501
460
|
|
502
461
|
class UpdateParams < Stripe::RequestParams
|
503
|
-
class AmountsDue < Stripe::RequestParams
|
504
|
-
# The amount in cents (or local equivalent).
|
505
|
-
attr_accessor :amount
|
506
|
-
# Number of days from when invoice is finalized until the payment is due.
|
507
|
-
attr_accessor :days_until_due
|
508
|
-
# An arbitrary string attached to the object. Often useful for displaying to users.
|
509
|
-
attr_accessor :description
|
510
|
-
# Date on which a payment plan’s payment is due.
|
511
|
-
attr_accessor :due_date
|
512
|
-
|
513
|
-
def initialize(amount: nil, days_until_due: nil, description: nil, due_date: nil)
|
514
|
-
@amount = amount
|
515
|
-
@days_until_due = days_until_due
|
516
|
-
@description = description
|
517
|
-
@due_date = due_date
|
518
|
-
end
|
519
|
-
end
|
520
|
-
|
521
462
|
class AutomaticTax < Stripe::RequestParams
|
522
463
|
class Liability < Stripe::RequestParams
|
523
464
|
# The connected account being referenced when `type` is `account`.
|
@@ -554,44 +495,16 @@ module Stripe
|
|
554
495
|
end
|
555
496
|
|
556
497
|
class Discount < Stripe::RequestParams
|
557
|
-
class DiscountEnd < Stripe::RequestParams
|
558
|
-
class Duration < Stripe::RequestParams
|
559
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
560
|
-
attr_accessor :interval
|
561
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
562
|
-
attr_accessor :interval_count
|
563
|
-
|
564
|
-
def initialize(interval: nil, interval_count: nil)
|
565
|
-
@interval = interval
|
566
|
-
@interval_count = interval_count
|
567
|
-
end
|
568
|
-
end
|
569
|
-
# Time span for the redeemed discount.
|
570
|
-
attr_accessor :duration
|
571
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
572
|
-
attr_accessor :timestamp
|
573
|
-
# The type of calculation made to determine when the discount ends.
|
574
|
-
attr_accessor :type
|
575
|
-
|
576
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
577
|
-
@duration = duration
|
578
|
-
@timestamp = timestamp
|
579
|
-
@type = type
|
580
|
-
end
|
581
|
-
end
|
582
498
|
# ID of the coupon to create a new discount for.
|
583
499
|
attr_accessor :coupon
|
584
500
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
585
501
|
attr_accessor :discount
|
586
|
-
# Details to determine how long the discount should be applied for.
|
587
|
-
attr_accessor :discount_end
|
588
502
|
# ID of the promotion code to create a new discount for.
|
589
503
|
attr_accessor :promotion_code
|
590
504
|
|
591
|
-
def initialize(coupon: nil, discount: nil,
|
505
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
592
506
|
@coupon = coupon
|
593
507
|
@discount = discount
|
594
|
-
@discount_end = discount_end
|
595
508
|
@promotion_code = promotion_code
|
596
509
|
end
|
597
510
|
end
|
@@ -711,9 +624,6 @@ module Stripe
|
|
711
624
|
end
|
712
625
|
end
|
713
626
|
|
714
|
-
class IdBankTransfer < Stripe::RequestParams
|
715
|
-
end
|
716
|
-
|
717
627
|
class Konbini < Stripe::RequestParams
|
718
628
|
end
|
719
629
|
|
@@ -725,12 +635,9 @@ module Stripe
|
|
725
635
|
class Filters < Stripe::RequestParams
|
726
636
|
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
727
637
|
attr_accessor :account_subcategories
|
728
|
-
# ID of the institution to use to filter for selectable accounts.
|
729
|
-
attr_accessor :institution
|
730
638
|
|
731
|
-
def initialize(account_subcategories: nil
|
639
|
+
def initialize(account_subcategories: nil)
|
732
640
|
@account_subcategories = account_subcategories
|
733
|
-
@institution = institution
|
734
641
|
end
|
735
642
|
end
|
736
643
|
# Provide filters for the linked accounts that the customer can select for the payment method.
|
@@ -764,8 +671,6 @@ module Stripe
|
|
764
671
|
attr_accessor :card
|
765
672
|
# If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
|
766
673
|
attr_accessor :customer_balance
|
767
|
-
# 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.
|
768
|
-
attr_accessor :id_bank_transfer
|
769
674
|
# If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
|
770
675
|
attr_accessor :konbini
|
771
676
|
# 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.
|
@@ -778,7 +683,6 @@ module Stripe
|
|
778
683
|
bancontact: nil,
|
779
684
|
card: nil,
|
780
685
|
customer_balance: nil,
|
781
|
-
id_bank_transfer: nil,
|
782
686
|
konbini: nil,
|
783
687
|
sepa_debit: nil,
|
784
688
|
us_bank_account: nil
|
@@ -787,7 +691,6 @@ module Stripe
|
|
787
691
|
@bancontact = bancontact
|
788
692
|
@card = card
|
789
693
|
@customer_balance = customer_balance
|
790
|
-
@id_bank_transfer = id_bank_transfer
|
791
694
|
@konbini = konbini
|
792
695
|
@sepa_debit = sepa_debit
|
793
696
|
@us_bank_account = us_bank_account
|
@@ -999,8 +902,6 @@ module Stripe
|
|
999
902
|
end
|
1000
903
|
# The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
|
1001
904
|
attr_accessor :account_tax_ids
|
1002
|
-
# List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
|
1003
|
-
attr_accessor :amounts_due
|
1004
905
|
# 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).
|
1005
906
|
attr_accessor :application_fee_amount
|
1006
907
|
# Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice.
|
@@ -1015,8 +916,6 @@ module Stripe
|
|
1015
916
|
attr_accessor :custom_fields
|
1016
917
|
# 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.
|
1017
918
|
attr_accessor :days_until_due
|
1018
|
-
# The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
|
1019
|
-
attr_accessor :default_margins
|
1020
919
|
# 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.
|
1021
920
|
attr_accessor :default_payment_method
|
1022
921
|
# 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.
|
@@ -1058,7 +957,6 @@ module Stripe
|
|
1058
957
|
|
1059
958
|
def initialize(
|
1060
959
|
account_tax_ids: nil,
|
1061
|
-
amounts_due: nil,
|
1062
960
|
application_fee_amount: nil,
|
1063
961
|
auto_advance: nil,
|
1064
962
|
automatic_tax: nil,
|
@@ -1066,7 +964,6 @@ module Stripe
|
|
1066
964
|
collection_method: nil,
|
1067
965
|
custom_fields: nil,
|
1068
966
|
days_until_due: nil,
|
1069
|
-
default_margins: nil,
|
1070
967
|
default_payment_method: nil,
|
1071
968
|
default_source: nil,
|
1072
969
|
default_tax_rates: nil,
|
@@ -1088,7 +985,6 @@ module Stripe
|
|
1088
985
|
transfer_data: nil
|
1089
986
|
)
|
1090
987
|
@account_tax_ids = account_tax_ids
|
1091
|
-
@amounts_due = amounts_due
|
1092
988
|
@application_fee_amount = application_fee_amount
|
1093
989
|
@auto_advance = auto_advance
|
1094
990
|
@automatic_tax = automatic_tax
|
@@ -1096,7 +992,6 @@ module Stripe
|
|
1096
992
|
@collection_method = collection_method
|
1097
993
|
@custom_fields = custom_fields
|
1098
994
|
@days_until_due = days_until_due
|
1099
|
-
@default_margins = default_margins
|
1100
995
|
@default_payment_method = default_payment_method
|
1101
996
|
@default_source = default_source
|
1102
997
|
@default_tax_rates = default_tax_rates
|
@@ -1161,8 +1056,6 @@ module Stripe
|
|
1161
1056
|
attr_accessor :created
|
1162
1057
|
# Only return invoices for the customer specified by this customer ID.
|
1163
1058
|
attr_accessor :customer
|
1164
|
-
# Only return invoices for the account specified by this account ID.
|
1165
|
-
attr_accessor :customer_account
|
1166
1059
|
# Attribute for param field due_date
|
1167
1060
|
attr_accessor :due_date
|
1168
1061
|
# 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.
|
@@ -1182,7 +1075,6 @@ module Stripe
|
|
1182
1075
|
collection_method: nil,
|
1183
1076
|
created: nil,
|
1184
1077
|
customer: nil,
|
1185
|
-
customer_account: nil,
|
1186
1078
|
due_date: nil,
|
1187
1079
|
ending_before: nil,
|
1188
1080
|
expand: nil,
|
@@ -1194,7 +1086,6 @@ module Stripe
|
|
1194
1086
|
@collection_method = collection_method
|
1195
1087
|
@created = created
|
1196
1088
|
@customer = customer
|
1197
|
-
@customer_account = customer_account
|
1198
1089
|
@due_date = due_date
|
1199
1090
|
@ending_before = ending_before
|
1200
1091
|
@expand = expand
|
@@ -1206,24 +1097,6 @@ module Stripe
|
|
1206
1097
|
end
|
1207
1098
|
|
1208
1099
|
class CreateParams < Stripe::RequestParams
|
1209
|
-
class AmountsDue < Stripe::RequestParams
|
1210
|
-
# The amount in cents (or local equivalent).
|
1211
|
-
attr_accessor :amount
|
1212
|
-
# Number of days from when invoice is finalized until the payment is due.
|
1213
|
-
attr_accessor :days_until_due
|
1214
|
-
# An arbitrary string attached to the object. Often useful for displaying to users.
|
1215
|
-
attr_accessor :description
|
1216
|
-
# Date on which a payment plan’s payment is due.
|
1217
|
-
attr_accessor :due_date
|
1218
|
-
|
1219
|
-
def initialize(amount: nil, days_until_due: nil, description: nil, due_date: nil)
|
1220
|
-
@amount = amount
|
1221
|
-
@days_until_due = days_until_due
|
1222
|
-
@description = description
|
1223
|
-
@due_date = due_date
|
1224
|
-
end
|
1225
|
-
end
|
1226
|
-
|
1227
1100
|
class AutomaticTax < Stripe::RequestParams
|
1228
1101
|
class Liability < Stripe::RequestParams
|
1229
1102
|
# The connected account being referenced when `type` is `account`.
|
@@ -1260,44 +1133,16 @@ module Stripe
|
|
1260
1133
|
end
|
1261
1134
|
|
1262
1135
|
class Discount < Stripe::RequestParams
|
1263
|
-
class DiscountEnd < Stripe::RequestParams
|
1264
|
-
class Duration < Stripe::RequestParams
|
1265
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1266
|
-
attr_accessor :interval
|
1267
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1268
|
-
attr_accessor :interval_count
|
1269
|
-
|
1270
|
-
def initialize(interval: nil, interval_count: nil)
|
1271
|
-
@interval = interval
|
1272
|
-
@interval_count = interval_count
|
1273
|
-
end
|
1274
|
-
end
|
1275
|
-
# Time span for the redeemed discount.
|
1276
|
-
attr_accessor :duration
|
1277
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1278
|
-
attr_accessor :timestamp
|
1279
|
-
# The type of calculation made to determine when the discount ends.
|
1280
|
-
attr_accessor :type
|
1281
|
-
|
1282
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
1283
|
-
@duration = duration
|
1284
|
-
@timestamp = timestamp
|
1285
|
-
@type = type
|
1286
|
-
end
|
1287
|
-
end
|
1288
1136
|
# ID of the coupon to create a new discount for.
|
1289
1137
|
attr_accessor :coupon
|
1290
1138
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1291
1139
|
attr_accessor :discount
|
1292
|
-
# Details to determine how long the discount should be applied for.
|
1293
|
-
attr_accessor :discount_end
|
1294
1140
|
# ID of the promotion code to create a new discount for.
|
1295
1141
|
attr_accessor :promotion_code
|
1296
1142
|
|
1297
|
-
def initialize(coupon: nil, discount: nil,
|
1143
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
1298
1144
|
@coupon = coupon
|
1299
1145
|
@discount = discount
|
1300
|
-
@discount_end = discount_end
|
1301
1146
|
@promotion_code = promotion_code
|
1302
1147
|
end
|
1303
1148
|
end
|
@@ -1429,9 +1274,6 @@ module Stripe
|
|
1429
1274
|
end
|
1430
1275
|
end
|
1431
1276
|
|
1432
|
-
class IdBankTransfer < Stripe::RequestParams
|
1433
|
-
end
|
1434
|
-
|
1435
1277
|
class Konbini < Stripe::RequestParams
|
1436
1278
|
end
|
1437
1279
|
|
@@ -1443,12 +1285,9 @@ module Stripe
|
|
1443
1285
|
class Filters < Stripe::RequestParams
|
1444
1286
|
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
1445
1287
|
attr_accessor :account_subcategories
|
1446
|
-
# ID of the institution to use to filter for selectable accounts.
|
1447
|
-
attr_accessor :institution
|
1448
1288
|
|
1449
|
-
def initialize(account_subcategories: nil
|
1289
|
+
def initialize(account_subcategories: nil)
|
1450
1290
|
@account_subcategories = account_subcategories
|
1451
|
-
@institution = institution
|
1452
1291
|
end
|
1453
1292
|
end
|
1454
1293
|
# Provide filters for the linked accounts that the customer can select for the payment method.
|
@@ -1482,8 +1321,6 @@ module Stripe
|
|
1482
1321
|
attr_accessor :card
|
1483
1322
|
# If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
|
1484
1323
|
attr_accessor :customer_balance
|
1485
|
-
# 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.
|
1486
|
-
attr_accessor :id_bank_transfer
|
1487
1324
|
# If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
|
1488
1325
|
attr_accessor :konbini
|
1489
1326
|
# 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.
|
@@ -1496,7 +1333,6 @@ module Stripe
|
|
1496
1333
|
bancontact: nil,
|
1497
1334
|
card: nil,
|
1498
1335
|
customer_balance: nil,
|
1499
|
-
id_bank_transfer: nil,
|
1500
1336
|
konbini: nil,
|
1501
1337
|
sepa_debit: nil,
|
1502
1338
|
us_bank_account: nil
|
@@ -1505,7 +1341,6 @@ module Stripe
|
|
1505
1341
|
@bancontact = bancontact
|
1506
1342
|
@card = card
|
1507
1343
|
@customer_balance = customer_balance
|
1508
|
-
@id_bank_transfer = id_bank_transfer
|
1509
1344
|
@konbini = konbini
|
1510
1345
|
@sepa_debit = sepa_debit
|
1511
1346
|
@us_bank_account = us_bank_account
|
@@ -1717,8 +1552,6 @@ module Stripe
|
|
1717
1552
|
end
|
1718
1553
|
# The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
|
1719
1554
|
attr_accessor :account_tax_ids
|
1720
|
-
# List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
|
1721
|
-
attr_accessor :amounts_due
|
1722
1555
|
# 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).
|
1723
1556
|
attr_accessor :application_fee_amount
|
1724
1557
|
# 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.
|
@@ -1735,12 +1568,8 @@ module Stripe
|
|
1735
1568
|
attr_accessor :custom_fields
|
1736
1569
|
# The ID of the customer who will be billed.
|
1737
1570
|
attr_accessor :customer
|
1738
|
-
# The ID of the account who will be billed.
|
1739
|
-
attr_accessor :customer_account
|
1740
1571
|
# The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.
|
1741
1572
|
attr_accessor :days_until_due
|
1742
|
-
# The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
|
1743
|
-
attr_accessor :default_margins
|
1744
1573
|
# 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.
|
1745
1574
|
attr_accessor :default_payment_method
|
1746
1575
|
# 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.
|
@@ -1788,7 +1617,6 @@ module Stripe
|
|
1788
1617
|
|
1789
1618
|
def initialize(
|
1790
1619
|
account_tax_ids: nil,
|
1791
|
-
amounts_due: nil,
|
1792
1620
|
application_fee_amount: nil,
|
1793
1621
|
auto_advance: nil,
|
1794
1622
|
automatic_tax: nil,
|
@@ -1797,9 +1625,7 @@ module Stripe
|
|
1797
1625
|
currency: nil,
|
1798
1626
|
custom_fields: nil,
|
1799
1627
|
customer: nil,
|
1800
|
-
customer_account: nil,
|
1801
1628
|
days_until_due: nil,
|
1802
|
-
default_margins: nil,
|
1803
1629
|
default_payment_method: nil,
|
1804
1630
|
default_source: nil,
|
1805
1631
|
default_tax_rates: nil,
|
@@ -1824,7 +1650,6 @@ module Stripe
|
|
1824
1650
|
transfer_data: nil
|
1825
1651
|
)
|
1826
1652
|
@account_tax_ids = account_tax_ids
|
1827
|
-
@amounts_due = amounts_due
|
1828
1653
|
@application_fee_amount = application_fee_amount
|
1829
1654
|
@auto_advance = auto_advance
|
1830
1655
|
@automatic_tax = automatic_tax
|
@@ -1833,9 +1658,7 @@ module Stripe
|
|
1833
1658
|
@currency = currency
|
1834
1659
|
@custom_fields = custom_fields
|
1835
1660
|
@customer = customer
|
1836
|
-
@customer_account = customer_account
|
1837
1661
|
@days_until_due = days_until_due
|
1838
|
-
@default_margins = default_margins
|
1839
1662
|
@default_payment_method = default_payment_method
|
1840
1663
|
@default_source = default_source
|
1841
1664
|
@default_tax_rates = default_tax_rates
|
@@ -1882,44 +1705,16 @@ module Stripe
|
|
1882
1705
|
class AddLinesParams < Stripe::RequestParams
|
1883
1706
|
class Line < Stripe::RequestParams
|
1884
1707
|
class Discount < Stripe::RequestParams
|
1885
|
-
class DiscountEnd < Stripe::RequestParams
|
1886
|
-
class Duration < Stripe::RequestParams
|
1887
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1888
|
-
attr_accessor :interval
|
1889
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1890
|
-
attr_accessor :interval_count
|
1891
|
-
|
1892
|
-
def initialize(interval: nil, interval_count: nil)
|
1893
|
-
@interval = interval
|
1894
|
-
@interval_count = interval_count
|
1895
|
-
end
|
1896
|
-
end
|
1897
|
-
# Time span for the redeemed discount.
|
1898
|
-
attr_accessor :duration
|
1899
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1900
|
-
attr_accessor :timestamp
|
1901
|
-
# The type of calculation made to determine when the discount ends.
|
1902
|
-
attr_accessor :type
|
1903
|
-
|
1904
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
1905
|
-
@duration = duration
|
1906
|
-
@timestamp = timestamp
|
1907
|
-
@type = type
|
1908
|
-
end
|
1909
|
-
end
|
1910
1708
|
# ID of the coupon to create a new discount for.
|
1911
1709
|
attr_accessor :coupon
|
1912
1710
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1913
1711
|
attr_accessor :discount
|
1914
|
-
# Details to determine how long the discount should be applied for.
|
1915
|
-
attr_accessor :discount_end
|
1916
1712
|
# ID of the promotion code to create a new discount for.
|
1917
1713
|
attr_accessor :promotion_code
|
1918
1714
|
|
1919
|
-
def initialize(coupon: nil, discount: nil,
|
1715
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
1920
1716
|
@coupon = coupon
|
1921
1717
|
@discount = discount
|
1922
|
-
@discount_end = discount_end
|
1923
1718
|
@promotion_code = promotion_code
|
1924
1719
|
end
|
1925
1720
|
end
|
@@ -2072,8 +1867,6 @@ module Stripe
|
|
2072
1867
|
attr_accessor :discounts
|
2073
1868
|
# ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created.
|
2074
1869
|
attr_accessor :invoice_item
|
2075
|
-
# 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.
|
2076
|
-
attr_accessor :margins
|
2077
1870
|
# 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`.
|
2078
1871
|
attr_accessor :metadata
|
2079
1872
|
# 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.
|
@@ -2095,7 +1888,6 @@ module Stripe
|
|
2095
1888
|
discountable: nil,
|
2096
1889
|
discounts: nil,
|
2097
1890
|
invoice_item: nil,
|
2098
|
-
margins: nil,
|
2099
1891
|
metadata: nil,
|
2100
1892
|
period: nil,
|
2101
1893
|
price_data: nil,
|
@@ -2109,7 +1901,6 @@ module Stripe
|
|
2109
1901
|
@discountable = discountable
|
2110
1902
|
@discounts = discounts
|
2111
1903
|
@invoice_item = invoice_item
|
2112
|
-
@margins = margins
|
2113
1904
|
@metadata = metadata
|
2114
1905
|
@period = period
|
2115
1906
|
@price_data = price_data
|
@@ -2133,63 +1924,6 @@ module Stripe
|
|
2133
1924
|
end
|
2134
1925
|
end
|
2135
1926
|
|
2136
|
-
class AttachPaymentParams < Stripe::RequestParams
|
2137
|
-
class PaymentRecordData < Stripe::RequestParams
|
2138
|
-
# The amount that was paid out of band.
|
2139
|
-
attr_accessor :amount
|
2140
|
-
# The currency that was paid out of band.
|
2141
|
-
attr_accessor :currency
|
2142
|
-
# 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`.
|
2143
|
-
attr_accessor :metadata
|
2144
|
-
# The type of money movement for this out of band payment record.
|
2145
|
-
attr_accessor :money_movement_type
|
2146
|
-
# The timestamp when this out of band payment was paid.
|
2147
|
-
attr_accessor :paid_at
|
2148
|
-
# The reference for this out of band payment record.
|
2149
|
-
attr_accessor :payment_reference
|
2150
|
-
|
2151
|
-
def initialize(
|
2152
|
-
amount: nil,
|
2153
|
-
currency: nil,
|
2154
|
-
metadata: nil,
|
2155
|
-
money_movement_type: nil,
|
2156
|
-
paid_at: nil,
|
2157
|
-
payment_reference: nil
|
2158
|
-
)
|
2159
|
-
@amount = amount
|
2160
|
-
@currency = currency
|
2161
|
-
@metadata = metadata
|
2162
|
-
@money_movement_type = money_movement_type
|
2163
|
-
@paid_at = paid_at
|
2164
|
-
@payment_reference = payment_reference
|
2165
|
-
end
|
2166
|
-
end
|
2167
|
-
# The portion of the `amount` on the PaymentIntent or out of band payment to apply to this invoice. It defaults to the entire amount.
|
2168
|
-
attr_accessor :amount_requested
|
2169
|
-
# Specifies which fields in the response should be expanded.
|
2170
|
-
attr_accessor :expand
|
2171
|
-
# The ID of the PaymentIntent to attach to the invoice.
|
2172
|
-
attr_accessor :payment_intent
|
2173
|
-
# The ID of the PaymentRecord to attach to the invoice.
|
2174
|
-
attr_accessor :payment_record
|
2175
|
-
# The PaymentRecord data for attaching an out of band payment to the invoice.
|
2176
|
-
attr_accessor :payment_record_data
|
2177
|
-
|
2178
|
-
def initialize(
|
2179
|
-
amount_requested: nil,
|
2180
|
-
expand: nil,
|
2181
|
-
payment_intent: nil,
|
2182
|
-
payment_record: nil,
|
2183
|
-
payment_record_data: nil
|
2184
|
-
)
|
2185
|
-
@amount_requested = amount_requested
|
2186
|
-
@expand = expand
|
2187
|
-
@payment_intent = payment_intent
|
2188
|
-
@payment_record = payment_record
|
2189
|
-
@payment_record_data = payment_record_data
|
2190
|
-
end
|
2191
|
-
end
|
2192
|
-
|
2193
1927
|
class FinalizeInvoiceParams < Stripe::RequestParams
|
2194
1928
|
# 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.
|
2195
1929
|
attr_accessor :auto_advance
|
@@ -2286,44 +2020,16 @@ module Stripe
|
|
2286
2020
|
class UpdateLinesParams < Stripe::RequestParams
|
2287
2021
|
class Line < Stripe::RequestParams
|
2288
2022
|
class Discount < Stripe::RequestParams
|
2289
|
-
class DiscountEnd < Stripe::RequestParams
|
2290
|
-
class Duration < Stripe::RequestParams
|
2291
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2292
|
-
attr_accessor :interval
|
2293
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2294
|
-
attr_accessor :interval_count
|
2295
|
-
|
2296
|
-
def initialize(interval: nil, interval_count: nil)
|
2297
|
-
@interval = interval
|
2298
|
-
@interval_count = interval_count
|
2299
|
-
end
|
2300
|
-
end
|
2301
|
-
# Time span for the redeemed discount.
|
2302
|
-
attr_accessor :duration
|
2303
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
2304
|
-
attr_accessor :timestamp
|
2305
|
-
# The type of calculation made to determine when the discount ends.
|
2306
|
-
attr_accessor :type
|
2307
|
-
|
2308
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
2309
|
-
@duration = duration
|
2310
|
-
@timestamp = timestamp
|
2311
|
-
@type = type
|
2312
|
-
end
|
2313
|
-
end
|
2314
2023
|
# ID of the coupon to create a new discount for.
|
2315
2024
|
attr_accessor :coupon
|
2316
2025
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
2317
2026
|
attr_accessor :discount
|
2318
|
-
# Details to determine how long the discount should be applied for.
|
2319
|
-
attr_accessor :discount_end
|
2320
2027
|
# ID of the promotion code to create a new discount for.
|
2321
2028
|
attr_accessor :promotion_code
|
2322
2029
|
|
2323
|
-
def initialize(coupon: nil, discount: nil,
|
2030
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
2324
2031
|
@coupon = coupon
|
2325
2032
|
@discount = discount
|
2326
|
-
@discount_end = discount_end
|
2327
2033
|
@promotion_code = promotion_code
|
2328
2034
|
end
|
2329
2035
|
end
|
@@ -2476,8 +2182,6 @@ module Stripe
|
|
2476
2182
|
attr_accessor :discounts
|
2477
2183
|
# ID of an existing line item on the invoice.
|
2478
2184
|
attr_accessor :id
|
2479
|
-
# 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.
|
2480
|
-
attr_accessor :margins
|
2481
2185
|
# 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.
|
2482
2186
|
attr_accessor :metadata
|
2483
2187
|
# 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.
|
@@ -2499,7 +2203,6 @@ module Stripe
|
|
2499
2203
|
discountable: nil,
|
2500
2204
|
discounts: nil,
|
2501
2205
|
id: nil,
|
2502
|
-
margins: nil,
|
2503
2206
|
metadata: nil,
|
2504
2207
|
period: nil,
|
2505
2208
|
price_data: nil,
|
@@ -2513,7 +2216,6 @@ module Stripe
|
|
2513
2216
|
@discountable = discountable
|
2514
2217
|
@discounts = discounts
|
2515
2218
|
@id = id
|
2516
|
-
@margins = margins
|
2517
2219
|
@metadata = metadata
|
2518
2220
|
@period = period
|
2519
2221
|
@price_data = price_data
|
@@ -2657,7 +2359,7 @@ module Stripe
|
|
2657
2359
|
end
|
2658
2360
|
|
2659
2361
|
class TaxId < Stripe::RequestParams
|
2660
|
-
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
|
2362
|
+
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
|
2661
2363
|
attr_accessor :type
|
2662
2364
|
# Value of the tax ID.
|
2663
2365
|
attr_accessor :value
|
@@ -2688,88 +2390,32 @@ module Stripe
|
|
2688
2390
|
end
|
2689
2391
|
|
2690
2392
|
class Discount < Stripe::RequestParams
|
2691
|
-
class DiscountEnd < Stripe::RequestParams
|
2692
|
-
class Duration < Stripe::RequestParams
|
2693
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2694
|
-
attr_accessor :interval
|
2695
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2696
|
-
attr_accessor :interval_count
|
2697
|
-
|
2698
|
-
def initialize(interval: nil, interval_count: nil)
|
2699
|
-
@interval = interval
|
2700
|
-
@interval_count = interval_count
|
2701
|
-
end
|
2702
|
-
end
|
2703
|
-
# Time span for the redeemed discount.
|
2704
|
-
attr_accessor :duration
|
2705
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
2706
|
-
attr_accessor :timestamp
|
2707
|
-
# The type of calculation made to determine when the discount ends.
|
2708
|
-
attr_accessor :type
|
2709
|
-
|
2710
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
2711
|
-
@duration = duration
|
2712
|
-
@timestamp = timestamp
|
2713
|
-
@type = type
|
2714
|
-
end
|
2715
|
-
end
|
2716
2393
|
# ID of the coupon to create a new discount for.
|
2717
2394
|
attr_accessor :coupon
|
2718
2395
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
2719
2396
|
attr_accessor :discount
|
2720
|
-
# Details to determine how long the discount should be applied for.
|
2721
|
-
attr_accessor :discount_end
|
2722
2397
|
# ID of the promotion code to create a new discount for.
|
2723
2398
|
attr_accessor :promotion_code
|
2724
2399
|
|
2725
|
-
def initialize(coupon: nil, discount: nil,
|
2400
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
2726
2401
|
@coupon = coupon
|
2727
2402
|
@discount = discount
|
2728
|
-
@discount_end = discount_end
|
2729
2403
|
@promotion_code = promotion_code
|
2730
2404
|
end
|
2731
2405
|
end
|
2732
2406
|
|
2733
2407
|
class InvoiceItem < Stripe::RequestParams
|
2734
2408
|
class Discount < Stripe::RequestParams
|
2735
|
-
class DiscountEnd < Stripe::RequestParams
|
2736
|
-
class Duration < Stripe::RequestParams
|
2737
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2738
|
-
attr_accessor :interval
|
2739
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2740
|
-
attr_accessor :interval_count
|
2741
|
-
|
2742
|
-
def initialize(interval: nil, interval_count: nil)
|
2743
|
-
@interval = interval
|
2744
|
-
@interval_count = interval_count
|
2745
|
-
end
|
2746
|
-
end
|
2747
|
-
# Time span for the redeemed discount.
|
2748
|
-
attr_accessor :duration
|
2749
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
2750
|
-
attr_accessor :timestamp
|
2751
|
-
# The type of calculation made to determine when the discount ends.
|
2752
|
-
attr_accessor :type
|
2753
|
-
|
2754
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
2755
|
-
@duration = duration
|
2756
|
-
@timestamp = timestamp
|
2757
|
-
@type = type
|
2758
|
-
end
|
2759
|
-
end
|
2760
2409
|
# ID of the coupon to create a new discount for.
|
2761
2410
|
attr_accessor :coupon
|
2762
2411
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
2763
2412
|
attr_accessor :discount
|
2764
|
-
# Details to determine how long the discount should be applied for.
|
2765
|
-
attr_accessor :discount_end
|
2766
2413
|
# ID of the promotion code to create a new discount for.
|
2767
2414
|
attr_accessor :promotion_code
|
2768
2415
|
|
2769
|
-
def initialize(coupon: nil, discount: nil,
|
2416
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
2770
2417
|
@coupon = coupon
|
2771
2418
|
@discount = discount
|
2772
|
-
@discount_end = discount_end
|
2773
2419
|
@promotion_code = promotion_code
|
2774
2420
|
end
|
2775
2421
|
end
|
@@ -2895,499 +2541,19 @@ module Stripe
|
|
2895
2541
|
end
|
2896
2542
|
|
2897
2543
|
class ScheduleDetails < Stripe::RequestParams
|
2898
|
-
class Amendment < Stripe::RequestParams
|
2899
|
-
class AmendmentEnd < Stripe::RequestParams
|
2900
|
-
class DiscountEnd < Stripe::RequestParams
|
2901
|
-
# The ID of a specific discount.
|
2902
|
-
attr_accessor :discount
|
2903
|
-
|
2904
|
-
def initialize(discount: nil)
|
2905
|
-
@discount = discount
|
2906
|
-
end
|
2907
|
-
end
|
2908
|
-
|
2909
|
-
class Duration < Stripe::RequestParams
|
2910
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2911
|
-
attr_accessor :interval
|
2912
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2913
|
-
attr_accessor :interval_count
|
2914
|
-
|
2915
|
-
def initialize(interval: nil, interval_count: nil)
|
2916
|
-
@interval = interval
|
2917
|
-
@interval_count = interval_count
|
2918
|
-
end
|
2919
|
-
end
|
2920
|
-
# Use the `end` time of a given discount.
|
2921
|
-
attr_accessor :discount_end
|
2922
|
-
# Time span for the amendment starting from the `amendment_start`.
|
2923
|
-
attr_accessor :duration
|
2924
|
-
# A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
|
2925
|
-
attr_accessor :timestamp
|
2926
|
-
# Select one of three ways to pass the `amendment_end`.
|
2927
|
-
attr_accessor :type
|
2928
|
-
|
2929
|
-
def initialize(discount_end: nil, duration: nil, timestamp: nil, type: nil)
|
2930
|
-
@discount_end = discount_end
|
2931
|
-
@duration = duration
|
2932
|
-
@timestamp = timestamp
|
2933
|
-
@type = type
|
2934
|
-
end
|
2935
|
-
end
|
2936
|
-
|
2937
|
-
class AmendmentStart < Stripe::RequestParams
|
2938
|
-
class AmendmentEnd < Stripe::RequestParams
|
2939
|
-
# 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.
|
2940
|
-
attr_accessor :index
|
2941
|
-
|
2942
|
-
def initialize(index: nil)
|
2943
|
-
@index = index
|
2944
|
-
end
|
2945
|
-
end
|
2946
|
-
|
2947
|
-
class DiscountEnd < Stripe::RequestParams
|
2948
|
-
# The ID of a specific discount.
|
2949
|
-
attr_accessor :discount
|
2950
|
-
|
2951
|
-
def initialize(discount: nil)
|
2952
|
-
@discount = discount
|
2953
|
-
end
|
2954
|
-
end
|
2955
|
-
# Details of another amendment in the same array, immediately after which this amendment should begin.
|
2956
|
-
attr_accessor :amendment_end
|
2957
|
-
# Use the `end` time of a given discount.
|
2958
|
-
attr_accessor :discount_end
|
2959
|
-
# A precise Unix timestamp for the amendment to start.
|
2960
|
-
attr_accessor :timestamp
|
2961
|
-
# Select one of three ways to pass the `amendment_start`.
|
2962
|
-
attr_accessor :type
|
2963
|
-
|
2964
|
-
def initialize(amendment_end: nil, discount_end: nil, timestamp: nil, type: nil)
|
2965
|
-
@amendment_end = amendment_end
|
2966
|
-
@discount_end = discount_end
|
2967
|
-
@timestamp = timestamp
|
2968
|
-
@type = type
|
2969
|
-
end
|
2970
|
-
end
|
2971
|
-
|
2972
|
-
class DiscountAction < Stripe::RequestParams
|
2973
|
-
class Add < Stripe::RequestParams
|
2974
|
-
class DiscountEnd < Stripe::RequestParams
|
2975
|
-
# The type of calculation made to determine when the discount ends.
|
2976
|
-
attr_accessor :type
|
2977
|
-
|
2978
|
-
def initialize(type: nil)
|
2979
|
-
@type = type
|
2980
|
-
end
|
2981
|
-
end
|
2982
|
-
# The coupon code to redeem.
|
2983
|
-
attr_accessor :coupon
|
2984
|
-
# An ID of an existing discount for a coupon that was already redeemed.
|
2985
|
-
attr_accessor :discount
|
2986
|
-
# Details to determine how long the discount should be applied for.
|
2987
|
-
attr_accessor :discount_end
|
2988
|
-
# 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.
|
2989
|
-
attr_accessor :index
|
2990
|
-
# The promotion code to redeem.
|
2991
|
-
attr_accessor :promotion_code
|
2992
|
-
|
2993
|
-
def initialize(
|
2994
|
-
coupon: nil,
|
2995
|
-
discount: nil,
|
2996
|
-
discount_end: nil,
|
2997
|
-
index: nil,
|
2998
|
-
promotion_code: nil
|
2999
|
-
)
|
3000
|
-
@coupon = coupon
|
3001
|
-
@discount = discount
|
3002
|
-
@discount_end = discount_end
|
3003
|
-
@index = index
|
3004
|
-
@promotion_code = promotion_code
|
3005
|
-
end
|
3006
|
-
end
|
3007
|
-
|
3008
|
-
class Remove < Stripe::RequestParams
|
3009
|
-
# The coupon code to remove from the `discounts` array.
|
3010
|
-
attr_accessor :coupon
|
3011
|
-
# The ID of a discount to remove from the `discounts` array.
|
3012
|
-
attr_accessor :discount
|
3013
|
-
# The ID of a promotion code to remove from the `discounts` array.
|
3014
|
-
attr_accessor :promotion_code
|
3015
|
-
|
3016
|
-
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
3017
|
-
@coupon = coupon
|
3018
|
-
@discount = discount
|
3019
|
-
@promotion_code = promotion_code
|
3020
|
-
end
|
3021
|
-
end
|
3022
|
-
|
3023
|
-
class Set < Stripe::RequestParams
|
3024
|
-
# The coupon code to replace the `discounts` array with.
|
3025
|
-
attr_accessor :coupon
|
3026
|
-
# An ID of an existing discount to replace the `discounts` array with.
|
3027
|
-
attr_accessor :discount
|
3028
|
-
# An ID of an existing promotion code to replace the `discounts` array with.
|
3029
|
-
attr_accessor :promotion_code
|
3030
|
-
|
3031
|
-
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
3032
|
-
@coupon = coupon
|
3033
|
-
@discount = discount
|
3034
|
-
@promotion_code = promotion_code
|
3035
|
-
end
|
3036
|
-
end
|
3037
|
-
# Details of the discount to add.
|
3038
|
-
attr_accessor :add
|
3039
|
-
# Details of the discount to remove.
|
3040
|
-
attr_accessor :remove
|
3041
|
-
# Details of the discount to replace the existing discounts with.
|
3042
|
-
attr_accessor :set
|
3043
|
-
# Determines the type of discount action.
|
3044
|
-
attr_accessor :type
|
3045
|
-
|
3046
|
-
def initialize(add: nil, remove: nil, set: nil, type: nil)
|
3047
|
-
@add = add
|
3048
|
-
@remove = remove
|
3049
|
-
@set = set
|
3050
|
-
@type = type
|
3051
|
-
end
|
3052
|
-
end
|
3053
|
-
|
3054
|
-
class ItemAction < Stripe::RequestParams
|
3055
|
-
class Add < Stripe::RequestParams
|
3056
|
-
class Discount < Stripe::RequestParams
|
3057
|
-
class DiscountEnd < Stripe::RequestParams
|
3058
|
-
class Duration < Stripe::RequestParams
|
3059
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
3060
|
-
attr_accessor :interval
|
3061
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
3062
|
-
attr_accessor :interval_count
|
3063
|
-
|
3064
|
-
def initialize(interval: nil, interval_count: nil)
|
3065
|
-
@interval = interval
|
3066
|
-
@interval_count = interval_count
|
3067
|
-
end
|
3068
|
-
end
|
3069
|
-
# Time span for the redeemed discount.
|
3070
|
-
attr_accessor :duration
|
3071
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
3072
|
-
attr_accessor :timestamp
|
3073
|
-
# The type of calculation made to determine when the discount ends.
|
3074
|
-
attr_accessor :type
|
3075
|
-
|
3076
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
3077
|
-
@duration = duration
|
3078
|
-
@timestamp = timestamp
|
3079
|
-
@type = type
|
3080
|
-
end
|
3081
|
-
end
|
3082
|
-
# ID of the coupon to create a new discount for.
|
3083
|
-
attr_accessor :coupon
|
3084
|
-
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
3085
|
-
attr_accessor :discount
|
3086
|
-
# Details to determine how long the discount should be applied for.
|
3087
|
-
attr_accessor :discount_end
|
3088
|
-
# ID of the promotion code to create a new discount for.
|
3089
|
-
attr_accessor :promotion_code
|
3090
|
-
|
3091
|
-
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
|
3092
|
-
@coupon = coupon
|
3093
|
-
@discount = discount
|
3094
|
-
@discount_end = discount_end
|
3095
|
-
@promotion_code = promotion_code
|
3096
|
-
end
|
3097
|
-
end
|
3098
|
-
|
3099
|
-
class Trial < Stripe::RequestParams
|
3100
|
-
# 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.
|
3101
|
-
attr_accessor :converts_to
|
3102
|
-
# Determines the type of trial for this item.
|
3103
|
-
attr_accessor :type
|
3104
|
-
|
3105
|
-
def initialize(converts_to: nil, type: nil)
|
3106
|
-
@converts_to = converts_to
|
3107
|
-
@type = type
|
3108
|
-
end
|
3109
|
-
end
|
3110
|
-
# The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
3111
|
-
attr_accessor :discounts
|
3112
|
-
# 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`.
|
3113
|
-
attr_accessor :metadata
|
3114
|
-
# The ID of the price object.
|
3115
|
-
attr_accessor :price
|
3116
|
-
# Quantity for this item.
|
3117
|
-
attr_accessor :quantity
|
3118
|
-
# 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`.
|
3119
|
-
attr_accessor :tax_rates
|
3120
|
-
# Options that configure the trial on the subscription item.
|
3121
|
-
attr_accessor :trial
|
3122
|
-
|
3123
|
-
def initialize(
|
3124
|
-
discounts: nil,
|
3125
|
-
metadata: nil,
|
3126
|
-
price: nil,
|
3127
|
-
quantity: nil,
|
3128
|
-
tax_rates: nil,
|
3129
|
-
trial: nil
|
3130
|
-
)
|
3131
|
-
@discounts = discounts
|
3132
|
-
@metadata = metadata
|
3133
|
-
@price = price
|
3134
|
-
@quantity = quantity
|
3135
|
-
@tax_rates = tax_rates
|
3136
|
-
@trial = trial
|
3137
|
-
end
|
3138
|
-
end
|
3139
|
-
|
3140
|
-
class Remove < Stripe::RequestParams
|
3141
|
-
# ID of a price to remove.
|
3142
|
-
attr_accessor :price
|
3143
|
-
|
3144
|
-
def initialize(price: nil)
|
3145
|
-
@price = price
|
3146
|
-
end
|
3147
|
-
end
|
3148
|
-
|
3149
|
-
class Set < Stripe::RequestParams
|
3150
|
-
class Discount < Stripe::RequestParams
|
3151
|
-
class DiscountEnd < Stripe::RequestParams
|
3152
|
-
class Duration < Stripe::RequestParams
|
3153
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
3154
|
-
attr_accessor :interval
|
3155
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
3156
|
-
attr_accessor :interval_count
|
3157
|
-
|
3158
|
-
def initialize(interval: nil, interval_count: nil)
|
3159
|
-
@interval = interval
|
3160
|
-
@interval_count = interval_count
|
3161
|
-
end
|
3162
|
-
end
|
3163
|
-
# Time span for the redeemed discount.
|
3164
|
-
attr_accessor :duration
|
3165
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
3166
|
-
attr_accessor :timestamp
|
3167
|
-
# The type of calculation made to determine when the discount ends.
|
3168
|
-
attr_accessor :type
|
3169
|
-
|
3170
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
3171
|
-
@duration = duration
|
3172
|
-
@timestamp = timestamp
|
3173
|
-
@type = type
|
3174
|
-
end
|
3175
|
-
end
|
3176
|
-
# ID of the coupon to create a new discount for.
|
3177
|
-
attr_accessor :coupon
|
3178
|
-
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
3179
|
-
attr_accessor :discount
|
3180
|
-
# Details to determine how long the discount should be applied for.
|
3181
|
-
attr_accessor :discount_end
|
3182
|
-
# ID of the promotion code to create a new discount for.
|
3183
|
-
attr_accessor :promotion_code
|
3184
|
-
|
3185
|
-
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
|
3186
|
-
@coupon = coupon
|
3187
|
-
@discount = discount
|
3188
|
-
@discount_end = discount_end
|
3189
|
-
@promotion_code = promotion_code
|
3190
|
-
end
|
3191
|
-
end
|
3192
|
-
|
3193
|
-
class Trial < Stripe::RequestParams
|
3194
|
-
# 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.
|
3195
|
-
attr_accessor :converts_to
|
3196
|
-
# Determines the type of trial for this item.
|
3197
|
-
attr_accessor :type
|
3198
|
-
|
3199
|
-
def initialize(converts_to: nil, type: nil)
|
3200
|
-
@converts_to = converts_to
|
3201
|
-
@type = type
|
3202
|
-
end
|
3203
|
-
end
|
3204
|
-
# 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`.
|
3205
|
-
attr_accessor :discounts
|
3206
|
-
# 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`.
|
3207
|
-
attr_accessor :metadata
|
3208
|
-
# The ID of the price object.
|
3209
|
-
attr_accessor :price
|
3210
|
-
# 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`.
|
3211
|
-
attr_accessor :quantity
|
3212
|
-
# 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`.
|
3213
|
-
attr_accessor :tax_rates
|
3214
|
-
# 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`.
|
3215
|
-
attr_accessor :trial
|
3216
|
-
|
3217
|
-
def initialize(
|
3218
|
-
discounts: nil,
|
3219
|
-
metadata: nil,
|
3220
|
-
price: nil,
|
3221
|
-
quantity: nil,
|
3222
|
-
tax_rates: nil,
|
3223
|
-
trial: nil
|
3224
|
-
)
|
3225
|
-
@discounts = discounts
|
3226
|
-
@metadata = metadata
|
3227
|
-
@price = price
|
3228
|
-
@quantity = quantity
|
3229
|
-
@tax_rates = tax_rates
|
3230
|
-
@trial = trial
|
3231
|
-
end
|
3232
|
-
end
|
3233
|
-
# 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.
|
3234
|
-
attr_accessor :add
|
3235
|
-
# Details of the subscription item to remove.
|
3236
|
-
attr_accessor :remove
|
3237
|
-
# 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.
|
3238
|
-
attr_accessor :set
|
3239
|
-
# Determines the type of item action.
|
3240
|
-
attr_accessor :type
|
3241
|
-
|
3242
|
-
def initialize(add: nil, remove: nil, set: nil, type: nil)
|
3243
|
-
@add = add
|
3244
|
-
@remove = remove
|
3245
|
-
@set = set
|
3246
|
-
@type = type
|
3247
|
-
end
|
3248
|
-
end
|
3249
|
-
|
3250
|
-
class MetadataAction < Stripe::RequestParams
|
3251
|
-
# Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
|
3252
|
-
attr_accessor :add
|
3253
|
-
# Keys to remove from schedule phase metadata.
|
3254
|
-
attr_accessor :remove
|
3255
|
-
# Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
|
3256
|
-
attr_accessor :set
|
3257
|
-
# Select one of three ways to update phase-level `metadata` on subscription schedules.
|
3258
|
-
attr_accessor :type
|
3259
|
-
|
3260
|
-
def initialize(add: nil, remove: nil, set: nil, type: nil)
|
3261
|
-
@add = add
|
3262
|
-
@remove = remove
|
3263
|
-
@set = set
|
3264
|
-
@type = type
|
3265
|
-
end
|
3266
|
-
end
|
3267
|
-
|
3268
|
-
class SetPauseCollection < Stripe::RequestParams
|
3269
|
-
class Set < Stripe::RequestParams
|
3270
|
-
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
3271
|
-
attr_accessor :behavior
|
3272
|
-
|
3273
|
-
def initialize(behavior: nil)
|
3274
|
-
@behavior = behavior
|
3275
|
-
end
|
3276
|
-
end
|
3277
|
-
# Details of the pause_collection behavior to apply to the amendment.
|
3278
|
-
attr_accessor :set
|
3279
|
-
# Determines the type of the pause_collection amendment.
|
3280
|
-
attr_accessor :type
|
3281
|
-
|
3282
|
-
def initialize(set: nil, type: nil)
|
3283
|
-
@set = set
|
3284
|
-
@type = type
|
3285
|
-
end
|
3286
|
-
end
|
3287
|
-
|
3288
|
-
class TrialSettings < Stripe::RequestParams
|
3289
|
-
class EndBehavior < Stripe::RequestParams
|
3290
|
-
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
3291
|
-
attr_accessor :prorate_up_front
|
3292
|
-
|
3293
|
-
def initialize(prorate_up_front: nil)
|
3294
|
-
@prorate_up_front = prorate_up_front
|
3295
|
-
end
|
3296
|
-
end
|
3297
|
-
# Defines how the subscription should behave when a trial ends.
|
3298
|
-
attr_accessor :end_behavior
|
3299
|
-
|
3300
|
-
def initialize(end_behavior: nil)
|
3301
|
-
@end_behavior = end_behavior
|
3302
|
-
end
|
3303
|
-
end
|
3304
|
-
# 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.
|
3305
|
-
attr_accessor :amendment_end
|
3306
|
-
# Details to identify the earliest timestamp where the proposed change should take effect.
|
3307
|
-
attr_accessor :amendment_start
|
3308
|
-
# 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.
|
3309
|
-
attr_accessor :billing_cycle_anchor
|
3310
|
-
# Changes to the coupons being redeemed or discounts being applied during the amendment time span.
|
3311
|
-
attr_accessor :discount_actions
|
3312
|
-
# Changes to the subscription items during the amendment time span.
|
3313
|
-
attr_accessor :item_actions
|
3314
|
-
# Instructions for how to modify phase metadata
|
3315
|
-
attr_accessor :metadata_actions
|
3316
|
-
# 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`.
|
3317
|
-
attr_accessor :proration_behavior
|
3318
|
-
# Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
3319
|
-
attr_accessor :set_pause_collection
|
3320
|
-
# Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
|
3321
|
-
attr_accessor :set_schedule_end
|
3322
|
-
# Settings related to subscription trials.
|
3323
|
-
attr_accessor :trial_settings
|
3324
|
-
|
3325
|
-
def initialize(
|
3326
|
-
amendment_end: nil,
|
3327
|
-
amendment_start: nil,
|
3328
|
-
billing_cycle_anchor: nil,
|
3329
|
-
discount_actions: nil,
|
3330
|
-
item_actions: nil,
|
3331
|
-
metadata_actions: nil,
|
3332
|
-
proration_behavior: nil,
|
3333
|
-
set_pause_collection: nil,
|
3334
|
-
set_schedule_end: nil,
|
3335
|
-
trial_settings: nil
|
3336
|
-
)
|
3337
|
-
@amendment_end = amendment_end
|
3338
|
-
@amendment_start = amendment_start
|
3339
|
-
@billing_cycle_anchor = billing_cycle_anchor
|
3340
|
-
@discount_actions = discount_actions
|
3341
|
-
@item_actions = item_actions
|
3342
|
-
@metadata_actions = metadata_actions
|
3343
|
-
@proration_behavior = proration_behavior
|
3344
|
-
@set_pause_collection = set_pause_collection
|
3345
|
-
@set_schedule_end = set_schedule_end
|
3346
|
-
@trial_settings = trial_settings
|
3347
|
-
end
|
3348
|
-
end
|
3349
|
-
|
3350
2544
|
class Phase < Stripe::RequestParams
|
3351
2545
|
class AddInvoiceItem < Stripe::RequestParams
|
3352
2546
|
class Discount < Stripe::RequestParams
|
3353
|
-
class DiscountEnd < Stripe::RequestParams
|
3354
|
-
class Duration < Stripe::RequestParams
|
3355
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
3356
|
-
attr_accessor :interval
|
3357
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
3358
|
-
attr_accessor :interval_count
|
3359
|
-
|
3360
|
-
def initialize(interval: nil, interval_count: nil)
|
3361
|
-
@interval = interval
|
3362
|
-
@interval_count = interval_count
|
3363
|
-
end
|
3364
|
-
end
|
3365
|
-
# Time span for the redeemed discount.
|
3366
|
-
attr_accessor :duration
|
3367
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
3368
|
-
attr_accessor :timestamp
|
3369
|
-
# The type of calculation made to determine when the discount ends.
|
3370
|
-
attr_accessor :type
|
3371
|
-
|
3372
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
3373
|
-
@duration = duration
|
3374
|
-
@timestamp = timestamp
|
3375
|
-
@type = type
|
3376
|
-
end
|
3377
|
-
end
|
3378
2547
|
# ID of the coupon to create a new discount for.
|
3379
2548
|
attr_accessor :coupon
|
3380
2549
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
3381
2550
|
attr_accessor :discount
|
3382
|
-
# Details to determine how long the discount should be applied for.
|
3383
|
-
attr_accessor :discount_end
|
3384
2551
|
# ID of the promotion code to create a new discount for.
|
3385
2552
|
attr_accessor :promotion_code
|
3386
2553
|
|
3387
|
-
def initialize(coupon: nil, discount: nil,
|
2554
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
3388
2555
|
@coupon = coupon
|
3389
2556
|
@discount = discount
|
3390
|
-
@discount_end = discount_end
|
3391
2557
|
@promotion_code = promotion_code
|
3392
2558
|
end
|
3393
2559
|
end
|
@@ -3468,44 +2634,16 @@ module Stripe
|
|
3468
2634
|
end
|
3469
2635
|
|
3470
2636
|
class Discount < Stripe::RequestParams
|
3471
|
-
class DiscountEnd < Stripe::RequestParams
|
3472
|
-
class Duration < Stripe::RequestParams
|
3473
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
3474
|
-
attr_accessor :interval
|
3475
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
3476
|
-
attr_accessor :interval_count
|
3477
|
-
|
3478
|
-
def initialize(interval: nil, interval_count: nil)
|
3479
|
-
@interval = interval
|
3480
|
-
@interval_count = interval_count
|
3481
|
-
end
|
3482
|
-
end
|
3483
|
-
# Time span for the redeemed discount.
|
3484
|
-
attr_accessor :duration
|
3485
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
3486
|
-
attr_accessor :timestamp
|
3487
|
-
# The type of calculation made to determine when the discount ends.
|
3488
|
-
attr_accessor :type
|
3489
|
-
|
3490
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
3491
|
-
@duration = duration
|
3492
|
-
@timestamp = timestamp
|
3493
|
-
@type = type
|
3494
|
-
end
|
3495
|
-
end
|
3496
2637
|
# ID of the coupon to create a new discount for.
|
3497
2638
|
attr_accessor :coupon
|
3498
2639
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
3499
2640
|
attr_accessor :discount
|
3500
|
-
# Details to determine how long the discount should be applied for.
|
3501
|
-
attr_accessor :discount_end
|
3502
2641
|
# ID of the promotion code to create a new discount for.
|
3503
2642
|
attr_accessor :promotion_code
|
3504
2643
|
|
3505
|
-
def initialize(coupon: nil, discount: nil,
|
2644
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
3506
2645
|
@coupon = coupon
|
3507
2646
|
@discount = discount
|
3508
|
-
@discount_end = discount_end
|
3509
2647
|
@promotion_code = promotion_code
|
3510
2648
|
end
|
3511
2649
|
end
|
@@ -3538,44 +2676,16 @@ module Stripe
|
|
3538
2676
|
|
3539
2677
|
class Item < Stripe::RequestParams
|
3540
2678
|
class Discount < Stripe::RequestParams
|
3541
|
-
class DiscountEnd < Stripe::RequestParams
|
3542
|
-
class Duration < Stripe::RequestParams
|
3543
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
3544
|
-
attr_accessor :interval
|
3545
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
3546
|
-
attr_accessor :interval_count
|
3547
|
-
|
3548
|
-
def initialize(interval: nil, interval_count: nil)
|
3549
|
-
@interval = interval
|
3550
|
-
@interval_count = interval_count
|
3551
|
-
end
|
3552
|
-
end
|
3553
|
-
# Time span for the redeemed discount.
|
3554
|
-
attr_accessor :duration
|
3555
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
3556
|
-
attr_accessor :timestamp
|
3557
|
-
# The type of calculation made to determine when the discount ends.
|
3558
|
-
attr_accessor :type
|
3559
|
-
|
3560
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
3561
|
-
@duration = duration
|
3562
|
-
@timestamp = timestamp
|
3563
|
-
@type = type
|
3564
|
-
end
|
3565
|
-
end
|
3566
2679
|
# ID of the coupon to create a new discount for.
|
3567
2680
|
attr_accessor :coupon
|
3568
2681
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
3569
2682
|
attr_accessor :discount
|
3570
|
-
# Details to determine how long the discount should be applied for.
|
3571
|
-
attr_accessor :discount_end
|
3572
2683
|
# ID of the promotion code to create a new discount for.
|
3573
2684
|
attr_accessor :promotion_code
|
3574
2685
|
|
3575
|
-
def initialize(coupon: nil, discount: nil,
|
2686
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
3576
2687
|
@coupon = coupon
|
3577
2688
|
@discount = discount
|
3578
|
-
@discount_end = discount_end
|
3579
2689
|
@promotion_code = promotion_code
|
3580
2690
|
end
|
3581
2691
|
end
|
@@ -3621,18 +2731,6 @@ module Stripe
|
|
3621
2731
|
@unit_amount_decimal = unit_amount_decimal
|
3622
2732
|
end
|
3623
2733
|
end
|
3624
|
-
|
3625
|
-
class Trial < Stripe::RequestParams
|
3626
|
-
# 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.
|
3627
|
-
attr_accessor :converts_to
|
3628
|
-
# Determines the type of trial for this item.
|
3629
|
-
attr_accessor :type
|
3630
|
-
|
3631
|
-
def initialize(converts_to: nil, type: nil)
|
3632
|
-
@converts_to = converts_to
|
3633
|
-
@type = type
|
3634
|
-
end
|
3635
|
-
end
|
3636
2734
|
# The coupons to redeem into discounts for the subscription item.
|
3637
2735
|
attr_accessor :discounts
|
3638
2736
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
|
@@ -3647,8 +2745,6 @@ module Stripe
|
|
3647
2745
|
attr_accessor :quantity
|
3648
2746
|
# 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.
|
3649
2747
|
attr_accessor :tax_rates
|
3650
|
-
# Options that configure the trial on the subscription item.
|
3651
|
-
attr_accessor :trial
|
3652
2748
|
|
3653
2749
|
def initialize(
|
3654
2750
|
discounts: nil,
|
@@ -3657,8 +2753,7 @@ module Stripe
|
|
3657
2753
|
price: nil,
|
3658
2754
|
price_data: nil,
|
3659
2755
|
quantity: nil,
|
3660
|
-
tax_rates: nil
|
3661
|
-
trial: nil
|
2756
|
+
tax_rates: nil
|
3662
2757
|
)
|
3663
2758
|
@discounts = discounts
|
3664
2759
|
@metadata = metadata
|
@@ -3667,16 +2762,6 @@ module Stripe
|
|
3667
2762
|
@price_data = price_data
|
3668
2763
|
@quantity = quantity
|
3669
2764
|
@tax_rates = tax_rates
|
3670
|
-
@trial = trial
|
3671
|
-
end
|
3672
|
-
end
|
3673
|
-
|
3674
|
-
class PauseCollection < Stripe::RequestParams
|
3675
|
-
# The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
|
3676
|
-
attr_accessor :behavior
|
3677
|
-
|
3678
|
-
def initialize(behavior: nil)
|
3679
|
-
@behavior = behavior
|
3680
2765
|
end
|
3681
2766
|
end
|
3682
2767
|
|
@@ -3691,23 +2776,6 @@ module Stripe
|
|
3691
2776
|
@destination = destination
|
3692
2777
|
end
|
3693
2778
|
end
|
3694
|
-
|
3695
|
-
class TrialSettings < Stripe::RequestParams
|
3696
|
-
class EndBehavior < Stripe::RequestParams
|
3697
|
-
# Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
|
3698
|
-
attr_accessor :prorate_up_front
|
3699
|
-
|
3700
|
-
def initialize(prorate_up_front: nil)
|
3701
|
-
@prorate_up_front = prorate_up_front
|
3702
|
-
end
|
3703
|
-
end
|
3704
|
-
# Defines how the subscription should behave when a trial ends.
|
3705
|
-
attr_accessor :end_behavior
|
3706
|
-
|
3707
|
-
def initialize(end_behavior: nil)
|
3708
|
-
@end_behavior = end_behavior
|
3709
|
-
end
|
3710
|
-
end
|
3711
2779
|
# 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.
|
3712
2780
|
attr_accessor :add_invoice_items
|
3713
2781
|
# 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).
|
@@ -3740,8 +2808,6 @@ module Stripe
|
|
3740
2808
|
attr_accessor :metadata
|
3741
2809
|
# The account on behalf of which to charge, for each of the associated subscription's invoices.
|
3742
2810
|
attr_accessor :on_behalf_of
|
3743
|
-
# 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).
|
3744
|
-
attr_accessor :pause_collection
|
3745
2811
|
# Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.
|
3746
2812
|
attr_accessor :proration_behavior
|
3747
2813
|
# The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
|
@@ -3750,12 +2816,8 @@ module Stripe
|
|
3750
2816
|
attr_accessor :transfer_data
|
3751
2817
|
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
3752
2818
|
attr_accessor :trial
|
3753
|
-
# Specify trial behavior when crossing phase boundaries
|
3754
|
-
attr_accessor :trial_continuation
|
3755
2819
|
# 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`
|
3756
2820
|
attr_accessor :trial_end
|
3757
|
-
# Settings related to subscription trials.
|
3758
|
-
attr_accessor :trial_settings
|
3759
2821
|
|
3760
2822
|
def initialize(
|
3761
2823
|
add_invoice_items: nil,
|
@@ -3774,14 +2836,11 @@ module Stripe
|
|
3774
2836
|
iterations: nil,
|
3775
2837
|
metadata: nil,
|
3776
2838
|
on_behalf_of: nil,
|
3777
|
-
pause_collection: nil,
|
3778
2839
|
proration_behavior: nil,
|
3779
2840
|
start_date: nil,
|
3780
2841
|
transfer_data: nil,
|
3781
2842
|
trial: nil,
|
3782
|
-
|
3783
|
-
trial_end: nil,
|
3784
|
-
trial_settings: nil
|
2843
|
+
trial_end: nil
|
3785
2844
|
)
|
3786
2845
|
@add_invoice_items = add_invoice_items
|
3787
2846
|
@application_fee_percent = application_fee_percent
|
@@ -3799,91 +2858,23 @@ module Stripe
|
|
3799
2858
|
@iterations = iterations
|
3800
2859
|
@metadata = metadata
|
3801
2860
|
@on_behalf_of = on_behalf_of
|
3802
|
-
@pause_collection = pause_collection
|
3803
2861
|
@proration_behavior = proration_behavior
|
3804
2862
|
@start_date = start_date
|
3805
2863
|
@transfer_data = transfer_data
|
3806
2864
|
@trial = trial
|
3807
|
-
@trial_continuation = trial_continuation
|
3808
2865
|
@trial_end = trial_end
|
3809
|
-
@trial_settings = trial_settings
|
3810
|
-
end
|
3811
|
-
end
|
3812
|
-
|
3813
|
-
class Prebilling < Stripe::RequestParams
|
3814
|
-
class BillUntil < Stripe::RequestParams
|
3815
|
-
class AmendmentEnd < Stripe::RequestParams
|
3816
|
-
# 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.
|
3817
|
-
attr_accessor :index
|
3818
|
-
|
3819
|
-
def initialize(index: nil)
|
3820
|
-
@index = index
|
3821
|
-
end
|
3822
|
-
end
|
3823
|
-
|
3824
|
-
class Duration < Stripe::RequestParams
|
3825
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
3826
|
-
attr_accessor :interval
|
3827
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
3828
|
-
attr_accessor :interval_count
|
3829
|
-
|
3830
|
-
def initialize(interval: nil, interval_count: nil)
|
3831
|
-
@interval = interval
|
3832
|
-
@interval_count = interval_count
|
3833
|
-
end
|
3834
|
-
end
|
3835
|
-
# End the prebilled period when a specified amendment ends.
|
3836
|
-
attr_accessor :amendment_end
|
3837
|
-
# Time span for prebilling, starting from `bill_from`.
|
3838
|
-
attr_accessor :duration
|
3839
|
-
# End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
3840
|
-
attr_accessor :timestamp
|
3841
|
-
# Select one of several ways to pass the `bill_until` value.
|
3842
|
-
attr_accessor :type
|
3843
|
-
|
3844
|
-
def initialize(amendment_end: nil, duration: nil, timestamp: nil, type: nil)
|
3845
|
-
@amendment_end = amendment_end
|
3846
|
-
@duration = duration
|
3847
|
-
@timestamp = timestamp
|
3848
|
-
@type = type
|
3849
|
-
end
|
3850
|
-
end
|
3851
|
-
# The end of the prebilled time period.
|
3852
|
-
attr_accessor :bill_until
|
3853
|
-
# This is used to determine the number of billing cycles to prebill.
|
3854
|
-
attr_accessor :iterations
|
3855
|
-
|
3856
|
-
def initialize(bill_until: nil, iterations: nil)
|
3857
|
-
@bill_until = bill_until
|
3858
|
-
@iterations = iterations
|
3859
2866
|
end
|
3860
2867
|
end
|
3861
|
-
# Changes to apply to the phases of the subscription schedule, in the order provided.
|
3862
|
-
attr_accessor :amendments
|
3863
|
-
# 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.
|
3864
|
-
attr_accessor :billing_behavior
|
3865
2868
|
# 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.
|
3866
2869
|
attr_accessor :end_behavior
|
3867
2870
|
# 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.
|
3868
2871
|
attr_accessor :phases
|
3869
|
-
# Provide any time periods to bill in advance.
|
3870
|
-
attr_accessor :prebilling
|
3871
2872
|
# In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
|
3872
2873
|
attr_accessor :proration_behavior
|
3873
2874
|
|
3874
|
-
def initialize(
|
3875
|
-
amendments: nil,
|
3876
|
-
billing_behavior: nil,
|
3877
|
-
end_behavior: nil,
|
3878
|
-
phases: nil,
|
3879
|
-
prebilling: nil,
|
3880
|
-
proration_behavior: nil
|
3881
|
-
)
|
3882
|
-
@amendments = amendments
|
3883
|
-
@billing_behavior = billing_behavior
|
2875
|
+
def initialize(end_behavior: nil, phases: nil, proration_behavior: nil)
|
3884
2876
|
@end_behavior = end_behavior
|
3885
2877
|
@phases = phases
|
3886
|
-
@prebilling = prebilling
|
3887
2878
|
@proration_behavior = proration_behavior
|
3888
2879
|
end
|
3889
2880
|
end
|
@@ -3891,44 +2882,16 @@ module Stripe
|
|
3891
2882
|
class SubscriptionDetails < Stripe::RequestParams
|
3892
2883
|
class Item < Stripe::RequestParams
|
3893
2884
|
class Discount < Stripe::RequestParams
|
3894
|
-
class DiscountEnd < Stripe::RequestParams
|
3895
|
-
class Duration < Stripe::RequestParams
|
3896
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
3897
|
-
attr_accessor :interval
|
3898
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
3899
|
-
attr_accessor :interval_count
|
3900
|
-
|
3901
|
-
def initialize(interval: nil, interval_count: nil)
|
3902
|
-
@interval = interval
|
3903
|
-
@interval_count = interval_count
|
3904
|
-
end
|
3905
|
-
end
|
3906
|
-
# Time span for the redeemed discount.
|
3907
|
-
attr_accessor :duration
|
3908
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
3909
|
-
attr_accessor :timestamp
|
3910
|
-
# The type of calculation made to determine when the discount ends.
|
3911
|
-
attr_accessor :type
|
3912
|
-
|
3913
|
-
def initialize(duration: nil, timestamp: nil, type: nil)
|
3914
|
-
@duration = duration
|
3915
|
-
@timestamp = timestamp
|
3916
|
-
@type = type
|
3917
|
-
end
|
3918
|
-
end
|
3919
2885
|
# ID of the coupon to create a new discount for.
|
3920
2886
|
attr_accessor :coupon
|
3921
2887
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
3922
2888
|
attr_accessor :discount
|
3923
|
-
# Details to determine how long the discount should be applied for.
|
3924
|
-
attr_accessor :discount_end
|
3925
2889
|
# ID of the promotion code to create a new discount for.
|
3926
2890
|
attr_accessor :promotion_code
|
3927
2891
|
|
3928
|
-
def initialize(coupon: nil, discount: nil,
|
2892
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil)
|
3929
2893
|
@coupon = coupon
|
3930
2894
|
@discount = discount
|
3931
|
-
@discount_end = discount_end
|
3932
2895
|
@promotion_code = promotion_code
|
3933
2896
|
end
|
3934
2897
|
end
|
@@ -4019,15 +2982,6 @@ module Stripe
|
|
4019
2982
|
@tax_rates = tax_rates
|
4020
2983
|
end
|
4021
2984
|
end
|
4022
|
-
|
4023
|
-
class Prebilling < Stripe::RequestParams
|
4024
|
-
# This is used to determine the number of billing cycles to prebill.
|
4025
|
-
attr_accessor :iterations
|
4026
|
-
|
4027
|
-
def initialize(iterations: nil)
|
4028
|
-
@iterations = iterations
|
4029
|
-
end
|
4030
|
-
end
|
4031
2985
|
# 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`.
|
4032
2986
|
attr_accessor :billing_cycle_anchor
|
4033
2987
|
# A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
|
@@ -4040,8 +2994,6 @@ module Stripe
|
|
4040
2994
|
attr_accessor :default_tax_rates
|
4041
2995
|
# A list of up to 20 subscription items, each with an attached price.
|
4042
2996
|
attr_accessor :items
|
4043
|
-
# The pre-billing to apply to the subscription as a preview.
|
4044
|
-
attr_accessor :prebilling
|
4045
2997
|
# 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`.
|
4046
2998
|
attr_accessor :proration_behavior
|
4047
2999
|
# 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'.
|
@@ -4060,7 +3012,6 @@ module Stripe
|
|
4060
3012
|
cancel_now: nil,
|
4061
3013
|
default_tax_rates: nil,
|
4062
3014
|
items: nil,
|
4063
|
-
prebilling: nil,
|
4064
3015
|
proration_behavior: nil,
|
4065
3016
|
proration_date: nil,
|
4066
3017
|
resume_at: nil,
|
@@ -4073,7 +3024,6 @@ module Stripe
|
|
4073
3024
|
@cancel_now = cancel_now
|
4074
3025
|
@default_tax_rates = default_tax_rates
|
4075
3026
|
@items = items
|
4076
|
-
@prebilling = prebilling
|
4077
3027
|
@proration_behavior = proration_behavior
|
4078
3028
|
@proration_date = proration_date
|
4079
3029
|
@resume_at = resume_at
|
@@ -4087,8 +3037,6 @@ module Stripe
|
|
4087
3037
|
attr_accessor :currency
|
4088
3038
|
# 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.
|
4089
3039
|
attr_accessor :customer
|
4090
|
-
# 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.
|
4091
|
-
attr_accessor :customer_account
|
4092
3040
|
# 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.
|
4093
3041
|
attr_accessor :customer_details
|
4094
3042
|
# 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.
|
@@ -4116,7 +3064,6 @@ module Stripe
|
|
4116
3064
|
automatic_tax: nil,
|
4117
3065
|
currency: nil,
|
4118
3066
|
customer: nil,
|
4119
|
-
customer_account: nil,
|
4120
3067
|
customer_details: nil,
|
4121
3068
|
discounts: nil,
|
4122
3069
|
expand: nil,
|
@@ -4132,7 +3079,6 @@ module Stripe
|
|
4132
3079
|
@automatic_tax = automatic_tax
|
4133
3080
|
@currency = currency
|
4134
3081
|
@customer = customer
|
4135
|
-
@customer_account = customer_account
|
4136
3082
|
@customer_details = customer_details
|
4137
3083
|
@discounts = discounts
|
4138
3084
|
@expand = expand
|
@@ -4162,8 +3108,6 @@ module Stripe
|
|
4162
3108
|
attr_reader :amount_remaining
|
4163
3109
|
# This is the sum of all the shipping amounts.
|
4164
3110
|
attr_reader :amount_shipping
|
4165
|
-
# List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.
|
4166
|
-
attr_reader :amounts_due
|
4167
3111
|
# ID of the Connect Application that created the invoice.
|
4168
3112
|
attr_reader :application
|
4169
3113
|
# 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.
|
@@ -4198,8 +3142,6 @@ module Stripe
|
|
4198
3142
|
attr_reader :custom_fields
|
4199
3143
|
# The ID of the customer who will be billed.
|
4200
3144
|
attr_reader :customer
|
4201
|
-
# The ID of the account who will be billed.
|
4202
|
-
attr_reader :customer_account
|
4203
3145
|
# 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.
|
4204
3146
|
attr_reader :customer_address
|
4205
3147
|
# 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.
|
@@ -4214,8 +3156,6 @@ module Stripe
|
|
4214
3156
|
attr_reader :customer_tax_exempt
|
4215
3157
|
# 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.
|
4216
3158
|
attr_reader :customer_tax_ids
|
4217
|
-
# The margins applied to the invoice. Can be overridden by line item `margins`. Use `expand[]=default_margins` to expand each margin.
|
4218
|
-
attr_reader :default_margins
|
4219
3159
|
# 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.
|
4220
3160
|
attr_reader :default_payment_method
|
4221
3161
|
# 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.
|
@@ -4306,8 +3246,6 @@ module Stripe
|
|
4306
3246
|
attr_reader :total_discount_amounts
|
4307
3247
|
# The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
|
4308
3248
|
attr_reader :total_excluding_tax
|
4309
|
-
# The aggregate amounts calculated per margin across all line items.
|
4310
|
-
attr_reader :total_margin_amounts
|
4311
3249
|
# 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.
|
4312
3250
|
attr_reader :total_pretax_credit_amounts
|
4313
3251
|
# The aggregate tax information of all line items.
|
@@ -4337,50 +3275,6 @@ module Stripe
|
|
4337
3275
|
)
|
4338
3276
|
end
|
4339
3277
|
|
4340
|
-
# Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
|
4341
|
-
#
|
4342
|
-
# For Out of Band Payment, the payment is credited to the invoice immediately, increasing the amount_paid
|
4343
|
-
# of the invoice and subsequently transitioning the status of the invoice to paid if necessary.
|
4344
|
-
#
|
4345
|
-
# For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited
|
4346
|
-
# to the invoice, increasing its amount_paid. When the invoice is fully paid, the
|
4347
|
-
# invoice's status becomes paid.
|
4348
|
-
#
|
4349
|
-
# If the PaymentIntent's status is already succeeded when it's attached, it's
|
4350
|
-
# credited to the invoice immediately.
|
4351
|
-
#
|
4352
|
-
# See: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create) to learn more.
|
4353
|
-
def attach_payment(params = {}, opts = {})
|
4354
|
-
request_stripe_object(
|
4355
|
-
method: :post,
|
4356
|
-
path: format("/v1/invoices/%<invoice>s/attach_payment", { invoice: CGI.escape(self["id"]) }),
|
4357
|
-
params: params,
|
4358
|
-
opts: opts
|
4359
|
-
)
|
4360
|
-
end
|
4361
|
-
|
4362
|
-
# Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
|
4363
|
-
#
|
4364
|
-
# For Out of Band Payment, the payment is credited to the invoice immediately, increasing the amount_paid
|
4365
|
-
# of the invoice and subsequently transitioning the status of the invoice to paid if necessary.
|
4366
|
-
#
|
4367
|
-
# For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited
|
4368
|
-
# to the invoice, increasing its amount_paid. When the invoice is fully paid, the
|
4369
|
-
# invoice's status becomes paid.
|
4370
|
-
#
|
4371
|
-
# If the PaymentIntent's status is already succeeded when it's attached, it's
|
4372
|
-
# credited to the invoice immediately.
|
4373
|
-
#
|
4374
|
-
# See: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create) to learn more.
|
4375
|
-
def self.attach_payment(invoice, params = {}, opts = {})
|
4376
|
-
request_stripe_object(
|
4377
|
-
method: :post,
|
4378
|
-
path: format("/v1/invoices/%<invoice>s/attach_payment", { invoice: CGI.escape(invoice) }),
|
4379
|
-
params: params,
|
4380
|
-
opts: opts
|
4381
|
-
)
|
4382
|
-
end
|
4383
|
-
|
4384
3278
|
# This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or <a href="#send_invoice">send](https://stripe.com/docs/api#finalize_invoice) the invoice to your customers.
|
4385
3279
|
def self.create(params = {}, opts = {})
|
4386
3280
|
request_stripe_object(method: :post, path: "/v1/invoices", params: params, opts: opts)
|