stripe 13.4.0.pre.beta.1 → 13.4.0.pre.beta.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +12 -1
- data/OPENAPI_VERSION +1 -1
- data/VERSION +1 -1
- data/lib/stripe/resources/account.rb +23 -745
- data/lib/stripe/resources/account_link.rb +0 -10
- data/lib/stripe/resources/account_notice.rb +0 -22
- data/lib/stripe/resources/account_session.rb +0 -125
- data/lib/stripe/resources/apple_pay_domain.rb +0 -10
- data/lib/stripe/resources/application.rb +0 -3
- data/lib/stripe/resources/application_fee.rb +0 -24
- data/lib/stripe/resources/application_fee_refund.rb +0 -7
- data/lib/stripe/resources/apps/secret.rb +0 -25
- data/lib/stripe/resources/balance.rb +0 -31
- data/lib/stripe/resources/balance_transaction.rb +0 -29
- data/lib/stripe/resources/bank_account.rb +0 -29
- data/lib/stripe/resources/billing/alert.rb +0 -22
- data/lib/stripe/resources/billing/alert_triggered.rb +0 -5
- data/lib/stripe/resources/billing/credit_balance_summary.rb +0 -12
- data/lib/stripe/resources/billing/credit_balance_transaction.rb +0 -24
- data/lib/stripe/resources/billing/credit_grant.rb +0 -32
- data/lib/stripe/resources/billing/meter.rb +0 -25
- data/lib/stripe/resources/billing/meter_error_report.rb +0 -11
- data/lib/stripe/resources/billing/meter_event.rb +0 -10
- data/lib/stripe/resources/billing/meter_event_adjustment.rb +0 -8
- data/lib/stripe/resources/billing/meter_event_summary.rb +0 -6
- data/lib/stripe/resources/billing_portal/configuration.rb +0 -77
- data/lib/stripe/resources/billing_portal/session.rb +0 -42
- data/lib/stripe/resources/capability.rb +2 -29
- data/lib/stripe/resources/capital/financing_offer.rb +0 -33
- data/lib/stripe/resources/capital/financing_summary.rb +0 -13
- data/lib/stripe/resources/capital/financing_transaction.rb +0 -24
- data/lib/stripe/resources/card.rb +2 -34
- data/lib/stripe/resources/cash_balance.rb +0 -5
- data/lib/stripe/resources/charge.rb +4 -665
- data/lib/stripe/resources/checkout/session.rb +4 -512
- data/lib/stripe/resources/climate/order.rb +0 -40
- data/lib/stripe/resources/climate/product.rb +0 -13
- data/lib/stripe/resources/climate/supplier.rb +0 -13
- data/lib/stripe/resources/confirmation_token.rb +2 -337
- data/lib/stripe/resources/connect_collection_transfer.rb +0 -5
- data/lib/stripe/resources/country_spec.rb +0 -13
- data/lib/stripe/resources/coupon.rb +0 -39
- data/lib/stripe/resources/credit_note.rb +0 -138
- data/lib/stripe/resources/credit_note_line_item.rb +0 -24
- data/lib/stripe/resources/customer.rb +1 -156
- data/lib/stripe/resources/customer_balance_transaction.rb +0 -12
- data/lib/stripe/resources/customer_cash_balance_transaction.rb +0 -27
- data/lib/stripe/resources/customer_session.rb +0 -24
- data/lib/stripe/resources/discount.rb +0 -12
- data/lib/stripe/resources/dispute.rb +4 -152
- data/lib/stripe/resources/entitlements/active_entitlement.rb +0 -8
- data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +0 -3
- data/lib/stripe/resources/entitlements/feature.rb +0 -17
- data/lib/stripe/resources/ephemeral_key.rb +0 -5
- data/lib/stripe/resources/event.rb +0 -27
- data/lib/stripe/resources/exchange_rate.rb +0 -5
- data/lib/stripe/resources/file.rb +0 -23
- data/lib/stripe/resources/file_link.rb +0 -22
- data/lib/stripe/resources/financial_connections/account.rb +0 -47
- data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -3
- data/lib/stripe/resources/financial_connections/account_owner.rb +0 -7
- data/lib/stripe/resources/financial_connections/account_ownership.rb +0 -3
- data/lib/stripe/resources/financial_connections/institution.rb +0 -13
- data/lib/stripe/resources/financial_connections/session.rb +0 -28
- data/lib/stripe/resources/financial_connections/transaction.rb +0 -21
- data/lib/stripe/resources/forwarding/request.rb +0 -31
- data/lib/stripe/resources/funding_instructions.rb +0 -107
- data/lib/stripe/resources/gift_cards/card.rb +0 -28
- data/lib/stripe/resources/gift_cards/transaction.rb +0 -32
- data/lib/stripe/resources/identity/verification_report.rb +0 -69
- data/lib/stripe/resources/identity/verification_session.rb +0 -69
- data/lib/stripe/resources/invoice.rb +6 -1276
- data/lib/stripe/resources/invoice_item.rb +0 -91
- data/lib/stripe/resources/invoice_line_item.rb +0 -76
- data/lib/stripe/resources/invoice_payment.rb +0 -16
- data/lib/stripe/resources/invoice_rendering_template.rb +0 -12
- data/lib/stripe/resources/issuing/authorization.rb +0 -199
- data/lib/stripe/resources/issuing/card.rb +0 -128
- data/lib/stripe/resources/issuing/cardholder.rb +0 -110
- data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -82
- data/lib/stripe/resources/issuing/dispute.rb +0 -151
- data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -14
- data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -14
- data/lib/stripe/resources/issuing/personalization_design.rb +0 -48
- data/lib/stripe/resources/issuing/physical_bundle.rb +0 -13
- data/lib/stripe/resources/issuing/settlement.rb +0 -16
- data/lib/stripe/resources/issuing/token.rb +0 -46
- data/lib/stripe/resources/issuing/transaction.rb +0 -171
- data/lib/stripe/resources/line_item.rb +0 -23
- data/lib/stripe/resources/login_link.rb +0 -2
- data/lib/stripe/resources/mandate.rb +0 -45
- data/lib/stripe/resources/margin.rb +0 -19
- data/lib/stripe/resources/order.rb +3 -391
- data/lib/stripe/resources/payment_attempt_record.rb +0 -42
- data/lib/stripe/resources/payment_intent.rb +2 -1768
- data/lib/stripe/resources/payment_link.rb +15 -213
- data/lib/stripe/resources/payment_method.rb +2 -345
- data/lib/stripe/resources/payment_method_configuration.rb +0 -293
- data/lib/stripe/resources/payment_method_domain.rb +0 -23
- data/lib/stripe/resources/payment_record.rb +0 -109
- data/lib/stripe/resources/payout.rb +0 -49
- data/lib/stripe/resources/person.rb +2 -92
- data/lib/stripe/resources/plan.rb +0 -69
- data/lib/stripe/resources/price.rb +0 -133
- data/lib/stripe/resources/product.rb +0 -100
- data/lib/stripe/resources/product_feature.rb +0 -4
- data/lib/stripe/resources/promotion_code.rb +0 -40
- data/lib/stripe/resources/quote.rb +0 -458
- data/lib/stripe/resources/quote_line.rb +0 -66
- data/lib/stripe/resources/quote_preview_invoice.rb +3 -184
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -101
- data/lib/stripe/resources/radar/early_fraud_warning.rb +0 -16
- data/lib/stripe/resources/radar/value_list.rb +0 -26
- data/lib/stripe/resources/radar/value_list_item.rb +0 -18
- data/lib/stripe/resources/refund.rb +0 -92
- data/lib/stripe/resources/reporting/report_run.rb +0 -32
- data/lib/stripe/resources/reporting/report_type.rb +0 -8
- data/lib/stripe/resources/reserve_transaction.rb +0 -4
- data/lib/stripe/resources/reversal.rb +0 -9
- data/lib/stripe/resources/review.rb +0 -27
- data/lib/stripe/resources/setup_attempt.rb +2 -103
- data/lib/stripe/resources/setup_intent.rb +2 -539
- data/lib/stripe/resources/shipping_rate.rb +0 -44
- data/lib/stripe/resources/sigma/scheduled_query_run.rb +0 -13
- data/lib/stripe/resources/source.rb +6 -338
- data/lib/stripe/resources/source_mandate_notification.rb +0 -13
- data/lib/stripe/resources/source_transaction.rb +0 -29
- data/lib/stripe/resources/subscription.rb +0 -338
- data/lib/stripe/resources/subscription_item.rb +0 -69
- data/lib/stripe/resources/subscription_schedule.rb +0 -388
- data/lib/stripe/resources/tax/association.rb +0 -11
- data/lib/stripe/resources/tax/calculation.rb +2 -89
- data/lib/stripe/resources/tax/calculation_line_item.rb +0 -20
- data/lib/stripe/resources/tax/form.rb +2 -35
- data/lib/stripe/resources/tax/registration.rb +421 -213
- data/lib/stripe/resources/tax/settings.rb +0 -20
- data/lib/stripe/resources/tax/transaction.rb +1 -66
- data/lib/stripe/resources/tax/transaction_line_item.rb +0 -12
- data/lib/stripe/resources/tax_code.rb +0 -6
- data/lib/stripe/resources/tax_deducted_at_source.rb +0 -4
- data/lib/stripe/resources/tax_id.rb +2 -28
- data/lib/stripe/resources/tax_rate.rb +0 -45
- data/lib/stripe/resources/terminal/configuration.rb +0 -164
- data/lib/stripe/resources/terminal/connection_token.rb +0 -3
- data/lib/stripe/resources/terminal/location.rb +0 -33
- data/lib/stripe/resources/terminal/reader.rb +0 -129
- data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -5
- data/lib/stripe/resources/test_helpers/test_clock.rb +0 -15
- data/lib/stripe/resources/token.rb +4 -192
- data/lib/stripe/resources/topup.rb +0 -36
- data/lib/stripe/resources/transfer.rb +0 -35
- data/lib/stripe/resources/treasury/credit_reversal.rb +0 -21
- data/lib/stripe/resources/treasury/debit_reversal.rb +0 -23
- data/lib/stripe/resources/treasury/financial_account.rb +77 -71
- data/lib/stripe/resources/treasury/financial_account_features.rb +0 -46
- data/lib/stripe/resources/treasury/inbound_transfer.rb +0 -50
- data/lib/stripe/resources/treasury/outbound_payment.rb +0 -92
- data/lib/stripe/resources/treasury/outbound_transfer.rb +25 -66
- data/lib/stripe/resources/treasury/received_credit.rb +6 -58
- data/lib/stripe/resources/treasury/received_debit.rb +0 -54
- data/lib/stripe/resources/treasury/transaction.rb +0 -39
- data/lib/stripe/resources/treasury/transaction_entry.rb +0 -36
- data/lib/stripe/resources/usage_record.rb +0 -5
- data/lib/stripe/resources/usage_record_summary.rb +0 -7
- data/lib/stripe/resources/v2/billing/meter_event.rb +0 -6
- data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +0 -7
- data/lib/stripe/resources/v2/billing/meter_event_session.rb +0 -5
- data/lib/stripe/resources/v2/event.rb +0 -8
- data/lib/stripe/resources/v2/event_destination.rb +0 -19
- data/lib/stripe/resources/webhook_endpoint.rb +0 -26
- data/lib/stripe/services/account_capability_service.rb +0 -1
- data/lib/stripe/services/account_external_account_service.rb +0 -43
- data/lib/stripe/services/account_link_service.rb +0 -7
- data/lib/stripe/services/account_notice_service.rb +0 -9
- data/lib/stripe/services/account_person_service.rb +0 -139
- data/lib/stripe/services/account_service.rb +8 -519
- data/lib/stripe/services/account_session_service.rb +0 -76
- data/lib/stripe/services/apple_pay_domain_service.rb +0 -5
- data/lib/stripe/services/application_fee_refund_service.rb +0 -6
- data/lib/stripe/services/application_fee_service.rb +0 -8
- data/lib/stripe/services/apps/secret_service.rb +0 -16
- data/lib/stripe/services/balance_transaction_service.rb +0 -11
- data/lib/stripe/services/billing/alert_service.rb +0 -12
- data/lib/stripe/services/billing/credit_balance_summary_service.rb +0 -4
- data/lib/stripe/services/billing/credit_balance_transaction_service.rb +0 -5
- data/lib/stripe/services/billing/credit_grant_service.rb +0 -16
- data/lib/stripe/services/billing/meter_event_adjustment_service.rb +0 -3
- data/lib/stripe/services/billing/meter_event_service.rb +0 -4
- data/lib/stripe/services/billing/meter_event_summary_service.rb +0 -7
- data/lib/stripe/services/billing/meter_service.rb +0 -12
- data/lib/stripe/services/billing_portal/configuration_service.rb +0 -48
- data/lib/stripe/services/billing_portal/session_service.rb +0 -19
- data/lib/stripe/services/capital/financing_offer_service.rb +0 -9
- data/lib/stripe/services/capital/financing_transaction_service.rb +0 -7
- data/lib/stripe/services/charge_service.rb +0 -274
- data/lib/stripe/services/checkout/session_line_item_service.rb +0 -3
- data/lib/stripe/services/checkout/session_service.rb +2 -273
- data/lib/stripe/services/climate/order_service.rb +0 -11
- data/lib/stripe/services/climate/product_service.rb +0 -3
- data/lib/stripe/services/climate/supplier_service.rb +0 -3
- data/lib/stripe/services/country_spec_service.rb +0 -3
- data/lib/stripe/services/coupon_service.rb +0 -22
- data/lib/stripe/services/credit_note_line_item_service.rb +0 -3
- data/lib/stripe/services/credit_note_preview_lines_service.rb +0 -28
- data/lib/stripe/services/credit_note_service.rb +0 -61
- data/lib/stripe/services/customer_balance_transaction_service.rb +0 -9
- data/lib/stripe/services/customer_cash_balance_service.rb +0 -1
- data/lib/stripe/services/customer_cash_balance_transaction_service.rb +0 -3
- data/lib/stripe/services/customer_funding_instructions_service.rb +0 -5
- data/lib/stripe/services/customer_payment_method_service.rb +0 -5
- data/lib/stripe/services/customer_payment_source_service.rb +0 -29
- data/lib/stripe/services/customer_service.rb +1 -92
- data/lib/stripe/services/customer_session_service.rb +0 -10
- data/lib/stripe/services/customer_tax_id_service.rb +1 -6
- data/lib/stripe/services/dispute_service.rb +2 -67
- data/lib/stripe/services/entitlements/active_entitlement_service.rb +0 -4
- data/lib/stripe/services/entitlements/feature_service.rb +0 -11
- data/lib/stripe/services/ephemeral_key_service.rb +0 -4
- data/lib/stripe/services/event_service.rb +0 -10
- data/lib/stripe/services/exchange_rate_service.rb +0 -3
- data/lib/stripe/services/file_link_service.rb +0 -14
- data/lib/stripe/services/file_service.rb +0 -13
- data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +0 -3
- data/lib/stripe/services/financial_connections/account_owner_service.rb +0 -4
- data/lib/stripe/services/financial_connections/account_service.rb +0 -9
- data/lib/stripe/services/financial_connections/institution_service.rb +0 -3
- data/lib/stripe/services/financial_connections/session_service.rb +0 -11
- data/lib/stripe/services/financial_connections/transaction_service.rb +0 -9
- data/lib/stripe/services/forwarding/request_service.rb +0 -14
- data/lib/stripe/services/gift_cards/card_service.rb +0 -13
- data/lib/stripe/services/gift_cards/transaction_service.rb +0 -16
- data/lib/stripe/services/identity/verification_report_service.rb +0 -10
- data/lib/stripe/services/identity/verification_session_service.rb +0 -30
- data/lib/stripe/services/invoice_item_service.rb +0 -66
- data/lib/stripe/services/invoice_line_item_service.rb +0 -40
- data/lib/stripe/services/invoice_payment_service.rb +0 -3
- data/lib/stripe/services/invoice_rendering_template_service.rb +0 -5
- data/lib/stripe/services/invoice_service.rb +2 -810
- data/lib/stripe/services/invoice_upcoming_lines_service.rb +1 -279
- data/lib/stripe/services/issuing/authorization_service.rb +0 -14
- data/lib/stripe/services/issuing/card_service.rb +0 -70
- data/lib/stripe/services/issuing/cardholder_service.rb +0 -73
- data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -56
- data/lib/stripe/services/issuing/dispute_service.rb +0 -98
- data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -4
- data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -7
- data/lib/stripe/services/issuing/personalization_design_service.rb +0 -29
- data/lib/stripe/services/issuing/physical_bundle_service.rb +0 -5
- data/lib/stripe/services/issuing/token_service.rb +0 -10
- data/lib/stripe/services/issuing/transaction_service.rb +0 -12
- data/lib/stripe/services/margin_service.rb +0 -11
- data/lib/stripe/services/order_line_item_service.rb +0 -3
- data/lib/stripe/services/order_service.rb +2 -266
- data/lib/stripe/services/payment_attempt_record_service.rb +0 -1
- data/lib/stripe/services/payment_intent_service.rb +0 -1309
- data/lib/stripe/services/payment_link_line_item_service.rb +0 -3
- data/lib/stripe/services/payment_link_service.rb +15 -135
- data/lib/stripe/services/payment_method_configuration_service.rb +0 -102
- data/lib/stripe/services/payment_method_domain_service.rb +0 -8
- data/lib/stripe/services/payment_method_service.rb +0 -113
- data/lib/stripe/services/payment_record_service.rb +0 -68
- data/lib/stripe/services/payout_service.rb +0 -23
- data/lib/stripe/services/plan_service.rb +0 -43
- data/lib/stripe/services/price_service.rb +0 -87
- data/lib/stripe/services/product_feature_service.rb +0 -4
- data/lib/stripe/services/product_service.rb +0 -74
- data/lib/stripe/services/promotion_code_service.rb +0 -25
- data/lib/stripe/services/quote_computed_upfront_line_items_service.rb +0 -3
- data/lib/stripe/services/quote_line_item_service.rb +0 -3
- data/lib/stripe/services/quote_line_service.rb +0 -3
- data/lib/stripe/services/quote_preview_invoice_service.rb +0 -3
- data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -3
- data/lib/stripe/services/quote_service.rb +0 -309
- data/lib/stripe/services/radar/early_fraud_warning_service.rb +0 -9
- data/lib/stripe/services/radar/value_list_item_service.rb +0 -11
- data/lib/stripe/services/radar/value_list_service.rb +0 -16
- data/lib/stripe/services/refund_service.rb +0 -21
- data/lib/stripe/services/reporting/report_run_service.rb +0 -16
- data/lib/stripe/services/review_service.rb +0 -7
- data/lib/stripe/services/setup_attempt_service.rb +0 -8
- data/lib/stripe/services/setup_intent_service.rb +0 -447
- data/lib/stripe/services/shipping_rate_service.rb +0 -27
- data/lib/stripe/services/sigma/scheduled_query_run_service.rb +0 -3
- data/lib/stripe/services/source_service.rb +0 -92
- data/lib/stripe/services/source_transaction_service.rb +0 -3
- data/lib/stripe/services/subscription_item_service.rb +0 -56
- data/lib/stripe/services/subscription_item_usage_record_service.rb +0 -3
- data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +0 -3
- data/lib/stripe/services/subscription_schedule_service.rb +0 -290
- data/lib/stripe/services/subscription_service.rb +0 -245
- data/lib/stripe/services/tax/association_service.rb +0 -1
- data/lib/stripe/services/tax/calculation_line_item_service.rb +0 -3
- data/lib/stripe/services/tax/calculation_service.rb +1 -31
- data/lib/stripe/services/tax/form_service.rb +0 -7
- data/lib/stripe/services/tax/registration_service.rb +274 -108
- data/lib/stripe/services/tax/settings_service.rb +0 -8
- data/lib/stripe/services/tax/transaction_line_item_service.rb +0 -3
- data/lib/stripe/services/tax/transaction_service.rb +0 -17
- data/lib/stripe/services/tax_code_service.rb +0 -3
- data/lib/stripe/services/tax_id_service.rb +1 -12
- data/lib/stripe/services/tax_rate_service.rb +0 -27
- data/lib/stripe/services/terminal/configuration_service.rb +0 -108
- data/lib/stripe/services/terminal/connection_token_service.rb +0 -1
- data/lib/stripe/services/terminal/location_service.rb +0 -21
- data/lib/stripe/services/terminal/reader_service.rb +0 -53
- data/lib/stripe/services/test_helpers/confirmation_token_service.rb +0 -89
- data/lib/stripe/services/test_helpers/customer_service.rb +0 -3
- data/lib/stripe/services/test_helpers/issuing/authorization_service.rb +0 -99
- data/lib/stripe/services/test_helpers/issuing/personalization_design_service.rb +0 -2
- data/lib/stripe/services/test_helpers/issuing/transaction_service.rb +0 -91
- data/lib/stripe/services/test_helpers/terminal/reader_service.rb +0 -4
- data/lib/stripe/services/test_helpers/test_clock_service.rb +0 -6
- data/lib/stripe/services/test_helpers/treasury/inbound_transfer_service.rb +0 -1
- data/lib/stripe/services/test_helpers/treasury/outbound_payment_service.rb +0 -6
- data/lib/stripe/services/test_helpers/treasury/outbound_transfer_service.rb +0 -6
- data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +0 -11
- data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +0 -11
- data/lib/stripe/services/token_service.rb +4 -184
- data/lib/stripe/services/topup_service.rb +0 -21
- data/lib/stripe/services/transfer_reversal_service.rb +0 -8
- data/lib/stripe/services/transfer_service.rb +0 -19
- data/lib/stripe/services/treasury/credit_reversal_service.rb +0 -8
- data/lib/stripe/services/treasury/debit_reversal_service.rb +0 -9
- data/lib/stripe/services/treasury/financial_account_features_service.rb +0 -10
- data/lib/stripe/services/treasury/financial_account_service.rb +64 -36
- data/lib/stripe/services/treasury/inbound_transfer_service.rb +0 -12
- data/lib/stripe/services/treasury/outbound_payment_service.rb +0 -38
- data/lib/stripe/services/treasury/outbound_transfer_service.rb +16 -15
- data/lib/stripe/services/treasury/received_credit_service.rb +0 -6
- data/lib/stripe/services/treasury/received_debit_service.rb +0 -5
- data/lib/stripe/services/treasury/transaction_entry_service.rb +0 -14
- data/lib/stripe/services/treasury/transaction_service.rb +0 -14
- data/lib/stripe/services/v2/billing/meter_event_adjustment_service.rb +0 -2
- data/lib/stripe/services/v2/billing/meter_event_service.rb +0 -3
- data/lib/stripe/services/v2/billing/meter_event_stream_service.rb +0 -3
- data/lib/stripe/services/v2/core/event_destination_service.rb +0 -18
- data/lib/stripe/services/v2/core/event_service.rb +0 -2
- data/lib/stripe/services/webhook_endpoint_service.rb +0 -14
- data/lib/stripe/stripe_client.rb +1 -1
- data/lib/stripe/stripe_object.rb +3 -3
- data/lib/stripe/util.rb +1 -1
- data/lib/stripe/version.rb +1 -1
- data/rbi/stripe/resources/account.rbi +29 -1001
- data/rbi/stripe/resources/account_link.rbi +0 -13
- data/rbi/stripe/resources/account_notice.rbi +0 -27
- data/rbi/stripe/resources/account_session.rbi +0 -166
- data/rbi/stripe/resources/apple_pay_domain.rbi +0 -14
- data/rbi/stripe/resources/application.rbi +0 -3
- data/rbi/stripe/resources/application_fee.rbi +0 -28
- data/rbi/stripe/resources/application_fee_refund.rbi +0 -7
- data/rbi/stripe/resources/apps/secret.rbi +0 -34
- data/rbi/stripe/resources/balance.rbi +0 -33
- data/rbi/stripe/resources/balance_transaction.rbi +0 -33
- data/rbi/stripe/resources/bank_account.rbi +0 -29
- data/rbi/stripe/resources/billing/alert.rbi +0 -31
- data/rbi/stripe/resources/billing/alert_triggered.rbi +0 -5
- data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -16
- data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +0 -27
- data/rbi/stripe/resources/billing/credit_grant.rbi +0 -43
- data/rbi/stripe/resources/billing/meter.rbi +0 -35
- data/rbi/stripe/resources/billing/meter_error_report.rbi +0 -11
- data/rbi/stripe/resources/billing/meter_event.rbi +0 -12
- data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +0 -11
- data/rbi/stripe/resources/billing/meter_event_summary.rbi +0 -6
- data/rbi/stripe/resources/billing_portal/configuration.rbi +0 -106
- data/rbi/stripe/resources/billing_portal/session.rbi +0 -55
- data/rbi/stripe/resources/capability.rbi +2 -29
- data/rbi/stripe/resources/capital/financing_offer.rbi +0 -38
- data/rbi/stripe/resources/capital/financing_summary.rbi +0 -15
- data/rbi/stripe/resources/capital/financing_transaction.rbi +0 -27
- data/rbi/stripe/resources/card.rbi +3 -34
- data/rbi/stripe/resources/cash_balance.rbi +0 -5
- data/rbi/stripe/resources/charge.rbi +6 -738
- data/rbi/stripe/resources/checkout/session.rbi +4 -636
- data/rbi/stripe/resources/climate/order.rbi +0 -48
- data/rbi/stripe/resources/climate/product.rbi +0 -16
- data/rbi/stripe/resources/climate/supplier.rbi +0 -16
- data/rbi/stripe/resources/confirmation_token.rbi +3 -364
- data/rbi/stripe/resources/connect_collection_transfer.rbi +0 -5
- data/rbi/stripe/resources/country_spec.rbi +0 -16
- data/rbi/stripe/resources/coupon.rbi +0 -48
- data/rbi/stripe/resources/credit_note.rbi +0 -159
- data/rbi/stripe/resources/credit_note_line_item.rbi +0 -24
- data/rbi/stripe/resources/customer.rbi +1 -188
- data/rbi/stripe/resources/customer_balance_transaction.rbi +0 -12
- data/rbi/stripe/resources/customer_cash_balance_transaction.rbi +0 -27
- data/rbi/stripe/resources/customer_session.rbi +0 -31
- data/rbi/stripe/resources/discount.rbi +0 -12
- data/rbi/stripe/resources/dispute.rbi +4 -166
- data/rbi/stripe/resources/entitlements/active_entitlement.rbi +0 -11
- data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi +0 -3
- data/rbi/stripe/resources/entitlements/feature.rbi +0 -22
- data/rbi/stripe/resources/ephemeral_key.rbi +0 -7
- data/rbi/stripe/resources/event.rbi +0 -31
- data/rbi/stripe/resources/exchange_rate.rbi +0 -8
- data/rbi/stripe/resources/file.rbi +0 -29
- data/rbi/stripe/resources/file_link.rbi +0 -28
- data/rbi/stripe/resources/financial_connections/account.rbi +0 -56
- data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +0 -3
- data/rbi/stripe/resources/financial_connections/account_owner.rbi +0 -7
- data/rbi/stripe/resources/financial_connections/account_ownership.rbi +0 -3
- data/rbi/stripe/resources/financial_connections/institution.rbi +0 -16
- data/rbi/stripe/resources/financial_connections/session.rbi +0 -35
- data/rbi/stripe/resources/financial_connections/transaction.rbi +0 -26
- data/rbi/stripe/resources/forwarding/request.rbi +0 -38
- data/rbi/stripe/resources/funding_instructions.rbi +0 -107
- data/rbi/stripe/resources/gift_cards/card.rbi +0 -36
- data/rbi/stripe/resources/gift_cards/transaction.rbi +0 -41
- data/rbi/stripe/resources/identity/verification_report.rbi +0 -73
- data/rbi/stripe/resources/identity/verification_session.rbi +0 -83
- data/rbi/stripe/resources/invoice.rbi +7 -1663
- data/rbi/stripe/resources/invoice_item.rbi +0 -107
- data/rbi/stripe/resources/invoice_line_item.rbi +0 -86
- data/rbi/stripe/resources/invoice_payment.rbi +0 -16
- data/rbi/stripe/resources/invoice_rendering_template.rbi +0 -17
- data/rbi/stripe/resources/issuing/authorization.rbi +0 -245
- data/rbi/stripe/resources/issuing/card.rbi +0 -153
- data/rbi/stripe/resources/issuing/cardholder.rbi +0 -138
- data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +0 -109
- data/rbi/stripe/resources/issuing/dispute.rbi +0 -177
- data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +0 -17
- data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +0 -18
- data/rbi/stripe/resources/issuing/personalization_design.rbi +0 -62
- data/rbi/stripe/resources/issuing/physical_bundle.rbi +0 -16
- data/rbi/stripe/resources/issuing/settlement.rbi +0 -16
- data/rbi/stripe/resources/issuing/token.rbi +0 -51
- data/rbi/stripe/resources/issuing/transaction.rbi +0 -205
- data/rbi/stripe/resources/line_item.rbi +0 -23
- data/rbi/stripe/resources/login_link.rbi +0 -2
- data/rbi/stripe/resources/mandate.rbi +0 -47
- data/rbi/stripe/resources/margin.rbi +0 -24
- data/rbi/stripe/resources/order.rbi +3 -492
- data/rbi/stripe/resources/payment_attempt_record.rbi +0 -45
- data/rbi/stripe/resources/payment_intent.rbi +3 -2224
- data/rbi/stripe/resources/payment_link.rbi +14 -291
- data/rbi/stripe/resources/payment_method.rbi +3 -382
- data/rbi/stripe/resources/payment_method_configuration.rbi +0 -486
- data/rbi/stripe/resources/payment_method_domain.rbi +0 -29
- data/rbi/stripe/resources/payment_record.rbi +0 -134
- data/rbi/stripe/resources/payout.rbi +0 -58
- data/rbi/stripe/resources/person.rbi +2 -92
- data/rbi/stripe/resources/plan.rbi +0 -78
- data/rbi/stripe/resources/price.rbi +0 -153
- data/rbi/stripe/resources/product.rbi +0 -120
- data/rbi/stripe/resources/product_feature.rbi +0 -4
- data/rbi/stripe/resources/promotion_code.rbi +0 -50
- data/rbi/stripe/resources/quote.rbi +0 -593
- data/rbi/stripe/resources/quote_line.rbi +0 -66
- data/rbi/stripe/resources/quote_preview_invoice.rbi +4 -184
- data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +0 -101
- data/rbi/stripe/resources/radar/early_fraud_warning.rbi +0 -20
- data/rbi/stripe/resources/radar/value_list.rbi +0 -32
- data/rbi/stripe/resources/radar/value_list_item.rbi +0 -23
- data/rbi/stripe/resources/refund.rbi +0 -100
- data/rbi/stripe/resources/reporting/report_run.rbi +0 -38
- data/rbi/stripe/resources/reporting/report_type.rbi +0 -11
- data/rbi/stripe/resources/reserve_transaction.rbi +0 -4
- data/rbi/stripe/resources/reversal.rbi +0 -9
- data/rbi/stripe/resources/review.rbi +0 -32
- data/rbi/stripe/resources/setup_attempt.rbi +3 -106
- data/rbi/stripe/resources/setup_intent.rbi +3 -688
- data/rbi/stripe/resources/shipping_rate.rbi +0 -57
- data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +0 -16
- data/rbi/stripe/resources/source.rbi +9 -365
- data/rbi/stripe/resources/source_mandate_notification.rbi +0 -13
- data/rbi/stripe/resources/source_transaction.rbi +0 -29
- data/rbi/stripe/resources/subscription.rbi +0 -431
- data/rbi/stripe/resources/subscription_item.rbi +0 -88
- data/rbi/stripe/resources/subscription_schedule.rbi +0 -504
- data/rbi/stripe/resources/tax/association.rbi +0 -13
- data/rbi/stripe/resources/tax/calculation.rbi +2 -100
- data/rbi/stripe/resources/tax/calculation_line_item.rbi +0 -20
- data/rbi/stripe/resources/tax/form.rbi +2 -40
- data/rbi/stripe/resources/tax/registration.rbi +401 -317
- data/rbi/stripe/resources/tax/settings.rbi +0 -26
- data/rbi/stripe/resources/tax/transaction.rbi +1 -73
- data/rbi/stripe/resources/tax/transaction_line_item.rbi +0 -12
- data/rbi/stripe/resources/tax_code.rbi +0 -9
- data/rbi/stripe/resources/tax_deducted_at_source.rbi +0 -4
- data/rbi/stripe/resources/tax_id.rbi +2 -34
- data/rbi/stripe/resources/tax_rate.rbi +0 -51
- data/rbi/stripe/resources/terminal/configuration.rbi +0 -211
- data/rbi/stripe/resources/terminal/connection_token.rbi +0 -5
- data/rbi/stripe/resources/terminal/location.rbi +0 -40
- data/rbi/stripe/resources/terminal/reader.rbi +0 -158
- data/rbi/stripe/resources/terminal/reader_collected_data.rbi +0 -7
- data/rbi/stripe/resources/test_helpers/test_clock.rbi +0 -20
- data/rbi/stripe/resources/token.rbi +5 -235
- data/rbi/stripe/resources/topup.rbi +0 -44
- data/rbi/stripe/resources/transfer.rbi +0 -41
- data/rbi/stripe/resources/treasury/credit_reversal.rbi +0 -25
- data/rbi/stripe/resources/treasury/debit_reversal.rbi +0 -27
- data/rbi/stripe/resources/treasury/financial_account.rbi +70 -124
- data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -46
- data/rbi/stripe/resources/treasury/inbound_transfer.rbi +0 -59
- data/rbi/stripe/resources/treasury/outbound_payment.rbi +0 -113
- data/rbi/stripe/resources/treasury/outbound_transfer.rbi +28 -84
- data/rbi/stripe/resources/treasury/received_credit.rbi +7 -67
- data/rbi/stripe/resources/treasury/received_debit.rbi +0 -62
- data/rbi/stripe/resources/treasury/transaction.rbi +0 -45
- data/rbi/stripe/resources/treasury/transaction_entry.rbi +0 -41
- data/rbi/stripe/resources/usage_record.rbi +0 -5
- data/rbi/stripe/resources/usage_record_summary.rbi +0 -7
- data/rbi/stripe/resources/v2/billing/meter_event.rbi +0 -6
- data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +0 -7
- data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +0 -5
- data/rbi/stripe/resources/v2/event.rbi +0 -8
- data/rbi/stripe/resources/v2/event_destination.rbi +0 -19
- data/rbi/stripe/resources/webhook_endpoint.rbi +0 -31
- data/rbi/stripe/services/account_capability_service.rbi +0 -4
- data/rbi/stripe/services/account_external_account_service.rbi +0 -52
- data/rbi/stripe/services/account_link_service.rbi +0 -9
- data/rbi/stripe/services/account_login_link_service.rbi +0 -1
- data/rbi/stripe/services/account_notice_service.rbi +0 -13
- data/rbi/stripe/services/account_person_service.rbi +0 -174
- data/rbi/stripe/services/account_service.rbi +10 -773
- data/rbi/stripe/services/account_session_service.rbi +0 -116
- data/rbi/stripe/services/apple_pay_domain_service.rbi +0 -8
- data/rbi/stripe/services/application_fee_refund_service.rbi +0 -10
- data/rbi/stripe/services/application_fee_service.rbi +0 -11
- data/rbi/stripe/services/apps/secret_service.rbi +0 -24
- data/rbi/stripe/services/balance_service.rbi +0 -1
- data/rbi/stripe/services/balance_transaction_service.rbi +0 -14
- data/rbi/stripe/services/billing/alert_service.rbi +0 -20
- data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +0 -7
- data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +0 -7
- data/rbi/stripe/services/billing/credit_grant_service.rbi +0 -26
- data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +0 -5
- data/rbi/stripe/services/billing/meter_event_service.rbi +0 -5
- data/rbi/stripe/services/billing/meter_event_summary_service.rbi +0 -8
- data/rbi/stripe/services/billing/meter_service.rbi +0 -21
- data/rbi/stripe/services/billing_portal/configuration_service.rbi +0 -76
- data/rbi/stripe/services/billing_portal/session_service.rbi +0 -31
- data/rbi/stripe/services/capital/financing_offer_service.rbi +0 -13
- data/rbi/stripe/services/capital/financing_summary_service.rbi +0 -1
- data/rbi/stripe/services/capital/financing_transaction_service.rbi +0 -9
- data/rbi/stripe/services/charge_service.rbi +0 -346
- data/rbi/stripe/services/checkout/session_line_item_service.rbi +0 -4
- data/rbi/stripe/services/checkout/session_service.rbi +2 -395
- data/rbi/stripe/services/climate/order_service.rbi +0 -18
- data/rbi/stripe/services/climate/product_service.rbi +0 -5
- data/rbi/stripe/services/climate/supplier_service.rbi +0 -5
- data/rbi/stripe/services/confirmation_token_service.rbi +0 -1
- data/rbi/stripe/services/country_spec_service.rbi +0 -5
- data/rbi/stripe/services/coupon_service.rbi +0 -30
- data/rbi/stripe/services/credit_note_line_item_service.rbi +0 -4
- data/rbi/stripe/services/credit_note_preview_lines_service.rbi +0 -33
- data/rbi/stripe/services/credit_note_service.rbi +0 -76
- data/rbi/stripe/services/customer_balance_transaction_service.rbi +0 -13
- data/rbi/stripe/services/customer_cash_balance_service.rbi +0 -4
- data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +0 -5
- data/rbi/stripe/services/customer_funding_instructions_service.rbi +0 -8
- data/rbi/stripe/services/customer_payment_method_service.rbi +0 -7
- data/rbi/stripe/services/customer_payment_source_service.rbi +0 -37
- data/rbi/stripe/services/customer_service.rbi +1 -117
- data/rbi/stripe/services/customer_session_service.rbi +0 -16
- data/rbi/stripe/services/customer_tax_id_service.rbi +1 -9
- data/rbi/stripe/services/dispute_service.rbi +2 -80
- data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +0 -6
- data/rbi/stripe/services/entitlements/feature_service.rbi +0 -15
- data/rbi/stripe/services/ephemeral_key_service.rbi +0 -6
- data/rbi/stripe/services/event_service.rbi +0 -13
- data/rbi/stripe/services/exchange_rate_service.rbi +0 -5
- data/rbi/stripe/services/file_link_service.rbi +0 -19
- data/rbi/stripe/services/file_service.rbi +0 -18
- data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +0 -4
- data/rbi/stripe/services/financial_connections/account_owner_service.rbi +0 -5
- data/rbi/stripe/services/financial_connections/account_service.rbi +0 -16
- data/rbi/stripe/services/financial_connections/institution_service.rbi +0 -5
- data/rbi/stripe/services/financial_connections/session_service.rbi +0 -17
- data/rbi/stripe/services/financial_connections/transaction_service.rbi +0 -13
- data/rbi/stripe/services/forwarding/request_service.rbi +0 -20
- data/rbi/stripe/services/gift_cards/card_service.rbi +0 -20
- data/rbi/stripe/services/gift_cards/transaction_service.rbi +0 -24
- data/rbi/stripe/services/identity/verification_report_service.rbi +0 -13
- data/rbi/stripe/services/identity/verification_session_service.rbi +0 -43
- data/rbi/stripe/services/invoice_item_service.rbi +0 -81
- data/rbi/stripe/services/invoice_line_item_service.rbi +0 -50
- data/rbi/stripe/services/invoice_payment_service.rbi +0 -5
- data/rbi/stripe/services/invoice_rendering_template_service.rbi +0 -9
- data/rbi/stripe/services/invoice_service.rbi +2 -1100
- data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +1 -375
- data/rbi/stripe/services/issuing/authorization_service.rbi +0 -20
- data/rbi/stripe/services/issuing/card_service.rbi +0 -89
- data/rbi/stripe/services/issuing/cardholder_service.rbi +0 -100
- data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +0 -82
- data/rbi/stripe/services/issuing/dispute_service.rbi +0 -123
- data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +0 -6
- data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +0 -10
- data/rbi/stripe/services/issuing/personalization_design_service.rbi +0 -38
- data/rbi/stripe/services/issuing/physical_bundle_service.rbi +0 -7
- data/rbi/stripe/services/issuing/token_service.rbi +0 -14
- data/rbi/stripe/services/issuing/transaction_service.rbi +0 -16
- data/rbi/stripe/services/mandate_service.rbi +0 -1
- data/rbi/stripe/services/margin_service.rbi +0 -15
- data/rbi/stripe/services/order_line_item_service.rbi +0 -4
- data/rbi/stripe/services/order_service.rbi +2 -365
- data/rbi/stripe/services/payment_attempt_record_service.rbi +0 -3
- data/rbi/stripe/services/payment_intent_service.rbi +0 -1764
- data/rbi/stripe/services/payment_link_line_item_service.rbi +0 -4
- data/rbi/stripe/services/payment_link_service.rbi +14 -211
- data/rbi/stripe/services/payment_method_configuration_service.rbi +0 -294
- data/rbi/stripe/services/payment_method_domain_service.rbi +0 -13
- data/rbi/stripe/services/payment_method_service.rbi +0 -149
- data/rbi/stripe/services/payment_record_service.rbi +0 -92
- data/rbi/stripe/services/payout_service.rbi +0 -31
- data/rbi/stripe/services/plan_service.rbi +0 -51
- data/rbi/stripe/services/price_service.rbi +0 -106
- data/rbi/stripe/services/product_feature_service.rbi +0 -7
- data/rbi/stripe/services/product_service.rbi +0 -93
- data/rbi/stripe/services/promotion_code_service.rbi +0 -34
- data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +0 -4
- data/rbi/stripe/services/quote_line_item_service.rbi +0 -4
- data/rbi/stripe/services/quote_line_service.rbi +0 -4
- data/rbi/stripe/services/quote_preview_invoice_service.rbi +0 -4
- data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +0 -4
- data/rbi/stripe/services/quote_service.rbi +0 -440
- data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +0 -12
- data/rbi/stripe/services/radar/value_list_item_service.rbi +0 -15
- data/rbi/stripe/services/radar/value_list_service.rbi +0 -21
- data/rbi/stripe/services/refund_service.rbi +0 -27
- data/rbi/stripe/services/reporting/report_run_service.rbi +0 -21
- data/rbi/stripe/services/reporting/report_type_service.rbi +0 -2
- data/rbi/stripe/services/review_service.rbi +0 -11
- data/rbi/stripe/services/setup_attempt_service.rbi +0 -10
- data/rbi/stripe/services/setup_intent_service.rbi +0 -595
- data/rbi/stripe/services/shipping_rate_service.rbi +0 -39
- data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +0 -5
- data/rbi/stripe/services/source_service.rbi +0 -119
- data/rbi/stripe/services/source_transaction_service.rbi +0 -4
- data/rbi/stripe/services/subscription_item_service.rbi +0 -74
- data/rbi/stripe/services/subscription_item_usage_record_service.rbi +0 -4
- data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +0 -4
- data/rbi/stripe/services/subscription_schedule_service.rbi +0 -405
- data/rbi/stripe/services/subscription_service.rbi +0 -337
- data/rbi/stripe/services/tax/association_service.rbi +0 -2
- data/rbi/stripe/services/tax/calculation_line_item_service.rbi +0 -4
- data/rbi/stripe/services/tax/calculation_service.rbi +1 -40
- data/rbi/stripe/services/tax/form_service.rbi +0 -11
- data/rbi/stripe/services/tax/registration_service.rbi +233 -211
- data/rbi/stripe/services/tax/settings_service.rbi +0 -13
- data/rbi/stripe/services/tax/transaction_line_item_service.rbi +0 -4
- data/rbi/stripe/services/tax/transaction_service.rbi +0 -22
- data/rbi/stripe/services/tax_code_service.rbi +0 -5
- data/rbi/stripe/services/tax_id_service.rbi +1 -17
- data/rbi/stripe/services/tax_rate_service.rbi +0 -32
- data/rbi/stripe/services/terminal/configuration_service.rbi +0 -154
- data/rbi/stripe/services/terminal/connection_token_service.rbi +0 -2
- data/rbi/stripe/services/terminal/location_service.rbi +0 -27
- data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +0 -1
- data/rbi/stripe/services/terminal/reader_service.rbi +0 -78
- data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +0 -114
- data/rbi/stripe/services/test_helpers/customer_service.rbi +0 -4
- data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +0 -138
- data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +0 -5
- data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +0 -6
- data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +0 -120
- data/rbi/stripe/services/test_helpers/refund_service.rbi +0 -1
- data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +0 -7
- data/rbi/stripe/services/test_helpers/test_clock_service.rbi +0 -10
- data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +0 -5
- data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +0 -14
- data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +0 -14
- data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +0 -16
- data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +0 -16
- data/rbi/stripe/services/token_service.rbi +5 -226
- data/rbi/stripe/services/topup_service.rbi +0 -28
- data/rbi/stripe/services/transfer_reversal_service.rbi +0 -12
- data/rbi/stripe/services/transfer_service.rbi +0 -24
- data/rbi/stripe/services/treasury/credit_reversal_service.rbi +0 -11
- data/rbi/stripe/services/treasury/debit_reversal_service.rbi +0 -12
- data/rbi/stripe/services/treasury/financial_account_features_service.rbi +0 -25
- data/rbi/stripe/services/treasury/financial_account_service.rbi +62 -73
- data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +0 -16
- data/rbi/stripe/services/treasury/outbound_payment_service.rbi +0 -50
- data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +17 -24
- data/rbi/stripe/services/treasury/received_credit_service.rbi +0 -9
- data/rbi/stripe/services/treasury/received_debit_service.rbi +0 -7
- data/rbi/stripe/services/treasury/transaction_entry_service.rbi +0 -18
- data/rbi/stripe/services/treasury/transaction_service.rbi +0 -19
- data/rbi/stripe/services/v2/billing/meter_event_adjustment_service.rbi +0 -4
- data/rbi/stripe/services/v2/billing/meter_event_service.rbi +0 -4
- data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +0 -5
- data/rbi/stripe/services/v2/core/event_destination_service.rbi +0 -25
- data/rbi/stripe/services/v2/core/event_service.rbi +0 -3
- data/rbi/stripe/services/webhook_endpoint_service.rbi +0 -18
- metadata +2 -2
@@ -28,13 +28,10 @@ module Stripe
|
|
28
28
|
class AmountsDue < Stripe::RequestParams
|
29
29
|
# The amount in cents (or local equivalent).
|
30
30
|
attr_accessor :amount
|
31
|
-
|
32
31
|
# Number of days from when invoice is finalized until the payment is due.
|
33
32
|
attr_accessor :days_until_due
|
34
|
-
|
35
33
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
36
34
|
attr_accessor :description
|
37
|
-
|
38
35
|
# Date on which a payment plan’s payment is due.
|
39
36
|
attr_accessor :due_date
|
40
37
|
|
@@ -50,7 +47,6 @@ module Stripe
|
|
50
47
|
class Liability < Stripe::RequestParams
|
51
48
|
# The connected account being referenced when `type` is `account`.
|
52
49
|
attr_accessor :account
|
53
|
-
|
54
50
|
# Type of the account referenced in the request.
|
55
51
|
attr_accessor :type
|
56
52
|
|
@@ -61,7 +57,6 @@ module Stripe
|
|
61
57
|
end
|
62
58
|
# Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
|
63
59
|
attr_accessor :enabled
|
64
|
-
|
65
60
|
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
|
66
61
|
attr_accessor :liability
|
67
62
|
|
@@ -74,7 +69,6 @@ module Stripe
|
|
74
69
|
class CustomField < Stripe::RequestParams
|
75
70
|
# The name of the custom field. This may be up to 40 characters.
|
76
71
|
attr_accessor :name
|
77
|
-
|
78
72
|
# The value of the custom field. This may be up to 140 characters.
|
79
73
|
attr_accessor :value
|
80
74
|
|
@@ -89,7 +83,6 @@ module Stripe
|
|
89
83
|
class Duration < Stripe::RequestParams
|
90
84
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
91
85
|
attr_accessor :interval
|
92
|
-
|
93
86
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
94
87
|
attr_accessor :interval_count
|
95
88
|
|
@@ -100,10 +93,8 @@ module Stripe
|
|
100
93
|
end
|
101
94
|
# Time span for the redeemed discount.
|
102
95
|
attr_accessor :duration
|
103
|
-
|
104
96
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
105
97
|
attr_accessor :timestamp
|
106
|
-
|
107
98
|
# The type of calculation made to determine when the discount ends.
|
108
99
|
attr_accessor :type
|
109
100
|
|
@@ -115,13 +106,10 @@ module Stripe
|
|
115
106
|
end
|
116
107
|
# ID of the coupon to create a new discount for.
|
117
108
|
attr_accessor :coupon
|
118
|
-
|
119
109
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
120
110
|
attr_accessor :discount
|
121
|
-
|
122
111
|
# Details to determine how long the discount should be applied for.
|
123
112
|
attr_accessor :discount_end
|
124
|
-
|
125
113
|
# ID of the promotion code to create a new discount for.
|
126
114
|
attr_accessor :promotion_code
|
127
115
|
|
@@ -136,7 +124,6 @@ module Stripe
|
|
136
124
|
class Issuer < Stripe::RequestParams
|
137
125
|
# The connected account being referenced when `type` is `account`.
|
138
126
|
attr_accessor :account
|
139
|
-
|
140
127
|
# Type of the account referenced in the request.
|
141
128
|
attr_accessor :type
|
142
129
|
|
@@ -159,7 +146,6 @@ module Stripe
|
|
159
146
|
end
|
160
147
|
# Additional fields for Mandate creation
|
161
148
|
attr_accessor :mandate_options
|
162
|
-
|
163
149
|
# Verification method for the intent
|
164
150
|
attr_accessor :verification_method
|
165
151
|
|
@@ -183,11 +169,9 @@ module Stripe
|
|
183
169
|
class Plan < Stripe::RequestParams
|
184
170
|
# For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
|
185
171
|
attr_accessor :count
|
186
|
-
|
187
172
|
# For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
|
188
173
|
# One of `month`.
|
189
174
|
attr_accessor :interval
|
190
|
-
|
191
175
|
# Type of installment plan, one of `fixed_count`.
|
192
176
|
attr_accessor :type
|
193
177
|
|
@@ -200,7 +184,6 @@ module Stripe
|
|
200
184
|
# Setting to true enables installments for this invoice.
|
201
185
|
# Setting to false will prevent any selected plan from applying to a payment.
|
202
186
|
attr_accessor :enabled
|
203
|
-
|
204
187
|
# The selected installment plan to use for this invoice.
|
205
188
|
attr_accessor :plan
|
206
189
|
|
@@ -213,7 +196,6 @@ module Stripe
|
|
213
196
|
#
|
214
197
|
# For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
|
215
198
|
attr_accessor :installments
|
216
|
-
|
217
199
|
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
|
218
200
|
attr_accessor :request_three_d_secure
|
219
201
|
|
@@ -235,7 +217,6 @@ module Stripe
|
|
235
217
|
end
|
236
218
|
# Configuration for eu_bank_transfer funding type.
|
237
219
|
attr_accessor :eu_bank_transfer
|
238
|
-
|
239
220
|
# The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
|
240
221
|
attr_accessor :type
|
241
222
|
|
@@ -246,7 +227,6 @@ module Stripe
|
|
246
227
|
end
|
247
228
|
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
|
248
229
|
attr_accessor :bank_transfer
|
249
|
-
|
250
230
|
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
|
251
231
|
attr_accessor :funding_type
|
252
232
|
|
@@ -270,7 +250,6 @@ module Stripe
|
|
270
250
|
class Filters < Stripe::RequestParams
|
271
251
|
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
272
252
|
attr_accessor :account_subcategories
|
273
|
-
|
274
253
|
# ID of the institution to use to filter for selectable accounts.
|
275
254
|
attr_accessor :institution
|
276
255
|
|
@@ -281,10 +260,8 @@ module Stripe
|
|
281
260
|
end
|
282
261
|
# Provide filters for the linked accounts that the customer can select for the payment method.
|
283
262
|
attr_accessor :filters
|
284
|
-
|
285
263
|
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
|
286
264
|
attr_accessor :permissions
|
287
|
-
|
288
265
|
# List of data features that you would like to retrieve upon account creation.
|
289
266
|
attr_accessor :prefetch
|
290
267
|
|
@@ -296,7 +273,6 @@ module Stripe
|
|
296
273
|
end
|
297
274
|
# Additional fields for Financial Connections Session creation
|
298
275
|
attr_accessor :financial_connections
|
299
|
-
|
300
276
|
# Verification method for the intent
|
301
277
|
attr_accessor :verification_method
|
302
278
|
|
@@ -307,25 +283,18 @@ module Stripe
|
|
307
283
|
end
|
308
284
|
# If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
|
309
285
|
attr_accessor :acss_debit
|
310
|
-
|
311
286
|
# If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
|
312
287
|
attr_accessor :bancontact
|
313
|
-
|
314
288
|
# If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
|
315
289
|
attr_accessor :card
|
316
|
-
|
317
290
|
# If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
|
318
291
|
attr_accessor :customer_balance
|
319
|
-
|
320
292
|
# 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.
|
321
293
|
attr_accessor :id_bank_transfer
|
322
|
-
|
323
294
|
# If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
|
324
295
|
attr_accessor :konbini
|
325
|
-
|
326
296
|
# 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.
|
327
297
|
attr_accessor :sepa_debit
|
328
|
-
|
329
298
|
# If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
|
330
299
|
attr_accessor :us_bank_account
|
331
300
|
|
@@ -351,10 +320,8 @@ module Stripe
|
|
351
320
|
end
|
352
321
|
# ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set.
|
353
322
|
attr_accessor :default_mandate
|
354
|
-
|
355
323
|
# Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
|
356
324
|
attr_accessor :payment_method_options
|
357
|
-
|
358
325
|
# The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration
|
359
326
|
attr_accessor :payment_method_types
|
360
327
|
|
@@ -378,13 +345,10 @@ module Stripe
|
|
378
345
|
end
|
379
346
|
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
|
380
347
|
attr_accessor :amount_tax_display
|
381
|
-
|
382
348
|
# Invoice pdf rendering options
|
383
349
|
attr_accessor :pdf
|
384
|
-
|
385
350
|
# ID of the invoice rendering template to use for this invoice.
|
386
351
|
attr_accessor :template
|
387
|
-
|
388
352
|
# The specific version of invoice rendering template to use for this invoice.
|
389
353
|
attr_accessor :template_version
|
390
354
|
|
@@ -402,7 +366,6 @@ module Stripe
|
|
402
366
|
class Maximum < Stripe::RequestParams
|
403
367
|
# A unit of time.
|
404
368
|
attr_accessor :unit
|
405
|
-
|
406
369
|
# Must be greater than 0.
|
407
370
|
attr_accessor :value
|
408
371
|
|
@@ -415,7 +378,6 @@ module Stripe
|
|
415
378
|
class Minimum < Stripe::RequestParams
|
416
379
|
# A unit of time.
|
417
380
|
attr_accessor :unit
|
418
|
-
|
419
381
|
# Must be greater than 0.
|
420
382
|
attr_accessor :value
|
421
383
|
|
@@ -426,7 +388,6 @@ module Stripe
|
|
426
388
|
end
|
427
389
|
# The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
|
428
390
|
attr_accessor :maximum
|
429
|
-
|
430
391
|
# The lower bound of the estimated range. If empty, represents no lower bound.
|
431
392
|
attr_accessor :minimum
|
432
393
|
|
@@ -440,7 +401,6 @@ module Stripe
|
|
440
401
|
class CurrencyOptions < Stripe::RequestParams
|
441
402
|
# A non-negative integer in cents representing how much to charge.
|
442
403
|
attr_accessor :amount
|
443
|
-
|
444
404
|
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
|
445
405
|
attr_accessor :tax_behavior
|
446
406
|
|
@@ -451,10 +411,8 @@ module Stripe
|
|
451
411
|
end
|
452
412
|
# A non-negative integer in cents representing how much to charge.
|
453
413
|
attr_accessor :amount
|
454
|
-
|
455
414
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
456
415
|
attr_accessor :currency
|
457
|
-
|
458
416
|
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
|
459
417
|
attr_accessor :currency_options
|
460
418
|
|
@@ -466,22 +424,16 @@ module Stripe
|
|
466
424
|
end
|
467
425
|
# The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
|
468
426
|
attr_accessor :delivery_estimate
|
469
|
-
|
470
427
|
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
|
471
428
|
attr_accessor :display_name
|
472
|
-
|
473
429
|
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
|
474
430
|
attr_accessor :fixed_amount
|
475
|
-
|
476
431
|
# 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`.
|
477
432
|
attr_accessor :metadata
|
478
|
-
|
479
433
|
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
|
480
434
|
attr_accessor :tax_behavior
|
481
|
-
|
482
435
|
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
|
483
436
|
attr_accessor :tax_code
|
484
|
-
|
485
437
|
# The type of calculation to use on the shipping rate.
|
486
438
|
attr_accessor :type
|
487
439
|
|
@@ -505,7 +457,6 @@ module Stripe
|
|
505
457
|
end
|
506
458
|
# The ID of the shipping rate to use for this order.
|
507
459
|
attr_accessor :shipping_rate
|
508
|
-
|
509
460
|
# Parameters to create a new ad-hoc shipping rate for this order.
|
510
461
|
attr_accessor :shipping_rate_data
|
511
462
|
|
@@ -519,19 +470,14 @@ module Stripe
|
|
519
470
|
class Address < Stripe::RequestParams
|
520
471
|
# City, district, suburb, town, or village.
|
521
472
|
attr_accessor :city
|
522
|
-
|
523
473
|
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
524
474
|
attr_accessor :country
|
525
|
-
|
526
475
|
# Address line 1 (e.g., street, PO Box, or company name).
|
527
476
|
attr_accessor :line1
|
528
|
-
|
529
477
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
530
478
|
attr_accessor :line2
|
531
|
-
|
532
479
|
# ZIP or postal code.
|
533
480
|
attr_accessor :postal_code
|
534
|
-
|
535
481
|
# State, county, province, or region.
|
536
482
|
attr_accessor :state
|
537
483
|
|
@@ -553,10 +499,8 @@ module Stripe
|
|
553
499
|
end
|
554
500
|
# Shipping address
|
555
501
|
attr_accessor :address
|
556
|
-
|
557
502
|
# Recipient name.
|
558
503
|
attr_accessor :name
|
559
|
-
|
560
504
|
# Recipient phone (including extension)
|
561
505
|
attr_accessor :phone
|
562
506
|
|
@@ -570,7 +514,6 @@ module Stripe
|
|
570
514
|
class TransferData < Stripe::RequestParams
|
571
515
|
# The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
|
572
516
|
attr_accessor :amount
|
573
|
-
|
574
517
|
# ID of an existing, connected Stripe account.
|
575
518
|
attr_accessor :destination
|
576
519
|
|
@@ -581,88 +524,60 @@ module Stripe
|
|
581
524
|
end
|
582
525
|
# The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
|
583
526
|
attr_accessor :account_tax_ids
|
584
|
-
|
585
527
|
# List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
|
586
528
|
attr_accessor :amounts_due
|
587
|
-
|
588
529
|
# 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).
|
589
530
|
attr_accessor :application_fee_amount
|
590
|
-
|
591
531
|
# Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice.
|
592
532
|
attr_accessor :auto_advance
|
593
|
-
|
594
533
|
# Settings for automatic tax lookup for this invoice.
|
595
534
|
attr_accessor :automatic_tax
|
596
|
-
|
597
535
|
# The time when this invoice should be scheduled to finalize. The invoice will be finalized at this time if it is still in draft state. To turn off automatic finalization, set `auto_advance` to false.
|
598
536
|
attr_accessor :automatically_finalizes_at
|
599
|
-
|
600
537
|
# Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices.
|
601
538
|
attr_accessor :collection_method
|
602
|
-
|
603
539
|
# A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields.
|
604
540
|
attr_accessor :custom_fields
|
605
|
-
|
606
541
|
# 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.
|
607
542
|
attr_accessor :days_until_due
|
608
|
-
|
609
543
|
# The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
|
610
544
|
attr_accessor :default_margins
|
611
|
-
|
612
545
|
# 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.
|
613
546
|
attr_accessor :default_payment_method
|
614
|
-
|
615
547
|
# 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.
|
616
548
|
attr_accessor :default_source
|
617
|
-
|
618
549
|
# The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates.
|
619
550
|
attr_accessor :default_tax_rates
|
620
|
-
|
621
551
|
# An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
|
622
552
|
attr_accessor :description
|
623
|
-
|
624
553
|
# The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts.
|
625
554
|
attr_accessor :discounts
|
626
|
-
|
627
555
|
# The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.
|
628
556
|
attr_accessor :due_date
|
629
|
-
|
630
557
|
# The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
|
631
558
|
attr_accessor :effective_at
|
632
|
-
|
633
559
|
# Specifies which fields in the response should be expanded.
|
634
560
|
attr_accessor :expand
|
635
|
-
|
636
561
|
# Footer to be displayed on the invoice.
|
637
562
|
attr_accessor :footer
|
638
|
-
|
639
563
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
640
564
|
attr_accessor :issuer
|
641
|
-
|
642
565
|
# 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`.
|
643
566
|
attr_accessor :metadata
|
644
|
-
|
645
567
|
# Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.
|
646
568
|
attr_accessor :number
|
647
|
-
|
648
569
|
# The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
|
649
570
|
attr_accessor :on_behalf_of
|
650
|
-
|
651
571
|
# Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
|
652
572
|
attr_accessor :payment_settings
|
653
|
-
|
654
573
|
# The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
|
655
574
|
attr_accessor :rendering
|
656
|
-
|
657
575
|
# Settings for the cost of shipping for this invoice.
|
658
576
|
attr_accessor :shipping_cost
|
659
|
-
|
660
577
|
# Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.
|
661
578
|
attr_accessor :shipping_details
|
662
|
-
|
663
579
|
# Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.
|
664
580
|
attr_accessor :statement_descriptor
|
665
|
-
|
666
581
|
# If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. This will be unset if you POST an empty value.
|
667
582
|
attr_accessor :transfer_data
|
668
583
|
|
@@ -733,13 +648,10 @@ module Stripe
|
|
733
648
|
class Created < Stripe::RequestParams
|
734
649
|
# Minimum value to filter by (exclusive)
|
735
650
|
attr_accessor :gt
|
736
|
-
|
737
651
|
# Minimum value to filter by (inclusive)
|
738
652
|
attr_accessor :gte
|
739
|
-
|
740
653
|
# Maximum value to filter by (exclusive)
|
741
654
|
attr_accessor :lt
|
742
|
-
|
743
655
|
# Maximum value to filter by (inclusive)
|
744
656
|
attr_accessor :lte
|
745
657
|
|
@@ -754,13 +666,10 @@ module Stripe
|
|
754
666
|
class DueDate < Stripe::RequestParams
|
755
667
|
# Minimum value to filter by (exclusive)
|
756
668
|
attr_accessor :gt
|
757
|
-
|
758
669
|
# Minimum value to filter by (inclusive)
|
759
670
|
attr_accessor :gte
|
760
|
-
|
761
671
|
# Maximum value to filter by (exclusive)
|
762
672
|
attr_accessor :lt
|
763
|
-
|
764
673
|
# Maximum value to filter by (inclusive)
|
765
674
|
attr_accessor :lte
|
766
675
|
|
@@ -773,31 +682,22 @@ module Stripe
|
|
773
682
|
end
|
774
683
|
# The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.
|
775
684
|
attr_accessor :collection_method
|
776
|
-
|
777
685
|
# Only return invoices that were created during the given date interval.
|
778
686
|
attr_accessor :created
|
779
|
-
|
780
687
|
# Only return invoices for the customer specified by this customer ID.
|
781
688
|
attr_accessor :customer
|
782
|
-
|
783
689
|
# Attribute for param field due_date
|
784
690
|
attr_accessor :due_date
|
785
|
-
|
786
691
|
# 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.
|
787
692
|
attr_accessor :ending_before
|
788
|
-
|
789
693
|
# Specifies which fields in the response should be expanded.
|
790
694
|
attr_accessor :expand
|
791
|
-
|
792
695
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
793
696
|
attr_accessor :limit
|
794
|
-
|
795
697
|
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
|
796
698
|
attr_accessor :starting_after
|
797
|
-
|
798
699
|
# The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)
|
799
700
|
attr_accessor :status
|
800
|
-
|
801
701
|
# Only return invoices for the subscription specified by this subscription ID.
|
802
702
|
attr_accessor :subscription
|
803
703
|
|
@@ -830,13 +730,10 @@ module Stripe
|
|
830
730
|
class AmountsDue < Stripe::RequestParams
|
831
731
|
# The amount in cents (or local equivalent).
|
832
732
|
attr_accessor :amount
|
833
|
-
|
834
733
|
# Number of days from when invoice is finalized until the payment is due.
|
835
734
|
attr_accessor :days_until_due
|
836
|
-
|
837
735
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
838
736
|
attr_accessor :description
|
839
|
-
|
840
737
|
# Date on which a payment plan’s payment is due.
|
841
738
|
attr_accessor :due_date
|
842
739
|
|
@@ -852,7 +749,6 @@ module Stripe
|
|
852
749
|
class Liability < Stripe::RequestParams
|
853
750
|
# The connected account being referenced when `type` is `account`.
|
854
751
|
attr_accessor :account
|
855
|
-
|
856
752
|
# Type of the account referenced in the request.
|
857
753
|
attr_accessor :type
|
858
754
|
|
@@ -863,7 +759,6 @@ module Stripe
|
|
863
759
|
end
|
864
760
|
# Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
|
865
761
|
attr_accessor :enabled
|
866
|
-
|
867
762
|
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
|
868
763
|
attr_accessor :liability
|
869
764
|
|
@@ -876,7 +771,6 @@ module Stripe
|
|
876
771
|
class CustomField < Stripe::RequestParams
|
877
772
|
# The name of the custom field. This may be up to 40 characters.
|
878
773
|
attr_accessor :name
|
879
|
-
|
880
774
|
# The value of the custom field. This may be up to 140 characters.
|
881
775
|
attr_accessor :value
|
882
776
|
|
@@ -891,7 +785,6 @@ module Stripe
|
|
891
785
|
class Duration < Stripe::RequestParams
|
892
786
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
893
787
|
attr_accessor :interval
|
894
|
-
|
895
788
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
896
789
|
attr_accessor :interval_count
|
897
790
|
|
@@ -902,10 +795,8 @@ module Stripe
|
|
902
795
|
end
|
903
796
|
# Time span for the redeemed discount.
|
904
797
|
attr_accessor :duration
|
905
|
-
|
906
798
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
907
799
|
attr_accessor :timestamp
|
908
|
-
|
909
800
|
# The type of calculation made to determine when the discount ends.
|
910
801
|
attr_accessor :type
|
911
802
|
|
@@ -917,13 +808,10 @@ module Stripe
|
|
917
808
|
end
|
918
809
|
# ID of the coupon to create a new discount for.
|
919
810
|
attr_accessor :coupon
|
920
|
-
|
921
811
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
922
812
|
attr_accessor :discount
|
923
|
-
|
924
813
|
# Details to determine how long the discount should be applied for.
|
925
814
|
attr_accessor :discount_end
|
926
|
-
|
927
815
|
# ID of the promotion code to create a new discount for.
|
928
816
|
attr_accessor :promotion_code
|
929
817
|
|
@@ -938,7 +826,6 @@ module Stripe
|
|
938
826
|
class FromInvoice < Stripe::RequestParams
|
939
827
|
# The relation between the new invoice and the original invoice. Currently, only 'revision' is permitted
|
940
828
|
attr_accessor :action
|
941
|
-
|
942
829
|
# The `id` of the invoice that will be cloned.
|
943
830
|
attr_accessor :invoice
|
944
831
|
|
@@ -951,7 +838,6 @@ module Stripe
|
|
951
838
|
class Issuer < Stripe::RequestParams
|
952
839
|
# The connected account being referenced when `type` is `account`.
|
953
840
|
attr_accessor :account
|
954
|
-
|
955
841
|
# Type of the account referenced in the request.
|
956
842
|
attr_accessor :type
|
957
843
|
|
@@ -974,7 +860,6 @@ module Stripe
|
|
974
860
|
end
|
975
861
|
# Additional fields for Mandate creation
|
976
862
|
attr_accessor :mandate_options
|
977
|
-
|
978
863
|
# Verification method for the intent
|
979
864
|
attr_accessor :verification_method
|
980
865
|
|
@@ -998,11 +883,9 @@ module Stripe
|
|
998
883
|
class Plan < Stripe::RequestParams
|
999
884
|
# For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
|
1000
885
|
attr_accessor :count
|
1001
|
-
|
1002
886
|
# For `fixed_count` installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card.
|
1003
887
|
# One of `month`.
|
1004
888
|
attr_accessor :interval
|
1005
|
-
|
1006
889
|
# Type of installment plan, one of `fixed_count`.
|
1007
890
|
attr_accessor :type
|
1008
891
|
|
@@ -1015,7 +898,6 @@ module Stripe
|
|
1015
898
|
# Setting to true enables installments for this invoice.
|
1016
899
|
# Setting to false will prevent any selected plan from applying to a payment.
|
1017
900
|
attr_accessor :enabled
|
1018
|
-
|
1019
901
|
# The selected installment plan to use for this invoice.
|
1020
902
|
attr_accessor :plan
|
1021
903
|
|
@@ -1028,7 +910,6 @@ module Stripe
|
|
1028
910
|
#
|
1029
911
|
# For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
|
1030
912
|
attr_accessor :installments
|
1031
|
-
|
1032
913
|
# We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
|
1033
914
|
attr_accessor :request_three_d_secure
|
1034
915
|
|
@@ -1050,7 +931,6 @@ module Stripe
|
|
1050
931
|
end
|
1051
932
|
# Configuration for eu_bank_transfer funding type.
|
1052
933
|
attr_accessor :eu_bank_transfer
|
1053
|
-
|
1054
934
|
# The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
|
1055
935
|
attr_accessor :type
|
1056
936
|
|
@@ -1061,7 +941,6 @@ module Stripe
|
|
1061
941
|
end
|
1062
942
|
# Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
|
1063
943
|
attr_accessor :bank_transfer
|
1064
|
-
|
1065
944
|
# The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
|
1066
945
|
attr_accessor :funding_type
|
1067
946
|
|
@@ -1085,7 +964,6 @@ module Stripe
|
|
1085
964
|
class Filters < Stripe::RequestParams
|
1086
965
|
# The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
|
1087
966
|
attr_accessor :account_subcategories
|
1088
|
-
|
1089
967
|
# ID of the institution to use to filter for selectable accounts.
|
1090
968
|
attr_accessor :institution
|
1091
969
|
|
@@ -1096,10 +974,8 @@ module Stripe
|
|
1096
974
|
end
|
1097
975
|
# Provide filters for the linked accounts that the customer can select for the payment method.
|
1098
976
|
attr_accessor :filters
|
1099
|
-
|
1100
977
|
# The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
|
1101
978
|
attr_accessor :permissions
|
1102
|
-
|
1103
979
|
# List of data features that you would like to retrieve upon account creation.
|
1104
980
|
attr_accessor :prefetch
|
1105
981
|
|
@@ -1111,7 +987,6 @@ module Stripe
|
|
1111
987
|
end
|
1112
988
|
# Additional fields for Financial Connections Session creation
|
1113
989
|
attr_accessor :financial_connections
|
1114
|
-
|
1115
990
|
# Verification method for the intent
|
1116
991
|
attr_accessor :verification_method
|
1117
992
|
|
@@ -1122,25 +997,18 @@ module Stripe
|
|
1122
997
|
end
|
1123
998
|
# If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
|
1124
999
|
attr_accessor :acss_debit
|
1125
|
-
|
1126
1000
|
# If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
|
1127
1001
|
attr_accessor :bancontact
|
1128
|
-
|
1129
1002
|
# If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
|
1130
1003
|
attr_accessor :card
|
1131
|
-
|
1132
1004
|
# If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
|
1133
1005
|
attr_accessor :customer_balance
|
1134
|
-
|
1135
1006
|
# 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.
|
1136
1007
|
attr_accessor :id_bank_transfer
|
1137
|
-
|
1138
1008
|
# If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
|
1139
1009
|
attr_accessor :konbini
|
1140
|
-
|
1141
1010
|
# 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.
|
1142
1011
|
attr_accessor :sepa_debit
|
1143
|
-
|
1144
1012
|
# If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
|
1145
1013
|
attr_accessor :us_bank_account
|
1146
1014
|
|
@@ -1166,10 +1034,8 @@ module Stripe
|
|
1166
1034
|
end
|
1167
1035
|
# ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set.
|
1168
1036
|
attr_accessor :default_mandate
|
1169
|
-
|
1170
1037
|
# Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
|
1171
1038
|
attr_accessor :payment_method_options
|
1172
|
-
|
1173
1039
|
# The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration
|
1174
1040
|
attr_accessor :payment_method_types
|
1175
1041
|
|
@@ -1193,13 +1059,10 @@ module Stripe
|
|
1193
1059
|
end
|
1194
1060
|
# How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
|
1195
1061
|
attr_accessor :amount_tax_display
|
1196
|
-
|
1197
1062
|
# Invoice pdf rendering options
|
1198
1063
|
attr_accessor :pdf
|
1199
|
-
|
1200
1064
|
# ID of the invoice rendering template to use for this invoice.
|
1201
1065
|
attr_accessor :template
|
1202
|
-
|
1203
1066
|
# The specific version of invoice rendering template to use for this invoice.
|
1204
1067
|
attr_accessor :template_version
|
1205
1068
|
|
@@ -1217,7 +1080,6 @@ module Stripe
|
|
1217
1080
|
class Maximum < Stripe::RequestParams
|
1218
1081
|
# A unit of time.
|
1219
1082
|
attr_accessor :unit
|
1220
|
-
|
1221
1083
|
# Must be greater than 0.
|
1222
1084
|
attr_accessor :value
|
1223
1085
|
|
@@ -1230,7 +1092,6 @@ module Stripe
|
|
1230
1092
|
class Minimum < Stripe::RequestParams
|
1231
1093
|
# A unit of time.
|
1232
1094
|
attr_accessor :unit
|
1233
|
-
|
1234
1095
|
# Must be greater than 0.
|
1235
1096
|
attr_accessor :value
|
1236
1097
|
|
@@ -1241,7 +1102,6 @@ module Stripe
|
|
1241
1102
|
end
|
1242
1103
|
# The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
|
1243
1104
|
attr_accessor :maximum
|
1244
|
-
|
1245
1105
|
# The lower bound of the estimated range. If empty, represents no lower bound.
|
1246
1106
|
attr_accessor :minimum
|
1247
1107
|
|
@@ -1255,7 +1115,6 @@ module Stripe
|
|
1255
1115
|
class CurrencyOptions < Stripe::RequestParams
|
1256
1116
|
# A non-negative integer in cents representing how much to charge.
|
1257
1117
|
attr_accessor :amount
|
1258
|
-
|
1259
1118
|
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
|
1260
1119
|
attr_accessor :tax_behavior
|
1261
1120
|
|
@@ -1266,10 +1125,8 @@ module Stripe
|
|
1266
1125
|
end
|
1267
1126
|
# A non-negative integer in cents representing how much to charge.
|
1268
1127
|
attr_accessor :amount
|
1269
|
-
|
1270
1128
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
1271
1129
|
attr_accessor :currency
|
1272
|
-
|
1273
1130
|
# Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
|
1274
1131
|
attr_accessor :currency_options
|
1275
1132
|
|
@@ -1281,22 +1138,16 @@ module Stripe
|
|
1281
1138
|
end
|
1282
1139
|
# The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
|
1283
1140
|
attr_accessor :delivery_estimate
|
1284
|
-
|
1285
1141
|
# The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
|
1286
1142
|
attr_accessor :display_name
|
1287
|
-
|
1288
1143
|
# Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
|
1289
1144
|
attr_accessor :fixed_amount
|
1290
|
-
|
1291
1145
|
# 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`.
|
1292
1146
|
attr_accessor :metadata
|
1293
|
-
|
1294
1147
|
# Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
|
1295
1148
|
attr_accessor :tax_behavior
|
1296
|
-
|
1297
1149
|
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
|
1298
1150
|
attr_accessor :tax_code
|
1299
|
-
|
1300
1151
|
# The type of calculation to use on the shipping rate.
|
1301
1152
|
attr_accessor :type
|
1302
1153
|
|
@@ -1320,7 +1171,6 @@ module Stripe
|
|
1320
1171
|
end
|
1321
1172
|
# The ID of the shipping rate to use for this order.
|
1322
1173
|
attr_accessor :shipping_rate
|
1323
|
-
|
1324
1174
|
# Parameters to create a new ad-hoc shipping rate for this order.
|
1325
1175
|
attr_accessor :shipping_rate_data
|
1326
1176
|
|
@@ -1334,19 +1184,14 @@ module Stripe
|
|
1334
1184
|
class Address < Stripe::RequestParams
|
1335
1185
|
# City, district, suburb, town, or village.
|
1336
1186
|
attr_accessor :city
|
1337
|
-
|
1338
1187
|
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
1339
1188
|
attr_accessor :country
|
1340
|
-
|
1341
1189
|
# Address line 1 (e.g., street, PO Box, or company name).
|
1342
1190
|
attr_accessor :line1
|
1343
|
-
|
1344
1191
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
1345
1192
|
attr_accessor :line2
|
1346
|
-
|
1347
1193
|
# ZIP or postal code.
|
1348
1194
|
attr_accessor :postal_code
|
1349
|
-
|
1350
1195
|
# State, county, province, or region.
|
1351
1196
|
attr_accessor :state
|
1352
1197
|
|
@@ -1368,10 +1213,8 @@ module Stripe
|
|
1368
1213
|
end
|
1369
1214
|
# Shipping address
|
1370
1215
|
attr_accessor :address
|
1371
|
-
|
1372
1216
|
# Recipient name.
|
1373
1217
|
attr_accessor :name
|
1374
|
-
|
1375
1218
|
# Recipient phone (including extension)
|
1376
1219
|
attr_accessor :phone
|
1377
1220
|
|
@@ -1385,7 +1228,6 @@ module Stripe
|
|
1385
1228
|
class TransferData < Stripe::RequestParams
|
1386
1229
|
# The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
|
1387
1230
|
attr_accessor :amount
|
1388
|
-
|
1389
1231
|
# ID of an existing, connected Stripe account.
|
1390
1232
|
attr_accessor :destination
|
1391
1233
|
|
@@ -1396,103 +1238,70 @@ module Stripe
|
|
1396
1238
|
end
|
1397
1239
|
# The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
|
1398
1240
|
attr_accessor :account_tax_ids
|
1399
|
-
|
1400
1241
|
# List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.
|
1401
1242
|
attr_accessor :amounts_due
|
1402
|
-
|
1403
1243
|
# 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).
|
1404
1244
|
attr_accessor :application_fee_amount
|
1405
|
-
|
1406
1245
|
# 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.
|
1407
1246
|
attr_accessor :auto_advance
|
1408
|
-
|
1409
1247
|
# Settings for automatic tax lookup for this invoice.
|
1410
1248
|
attr_accessor :automatic_tax
|
1411
|
-
|
1412
1249
|
# The time when this invoice should be scheduled to finalize. The invoice will be finalized at this time if it is still in draft state.
|
1413
1250
|
attr_accessor :automatically_finalizes_at
|
1414
|
-
|
1415
1251
|
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to `charge_automatically`.
|
1416
1252
|
attr_accessor :collection_method
|
1417
|
-
|
1418
1253
|
# The currency to create this invoice in. Defaults to that of `customer` if not specified.
|
1419
1254
|
attr_accessor :currency
|
1420
|
-
|
1421
1255
|
# A list of up to 4 custom fields to be displayed on the invoice.
|
1422
1256
|
attr_accessor :custom_fields
|
1423
|
-
|
1424
1257
|
# The ID of the customer who will be billed.
|
1425
1258
|
attr_accessor :customer
|
1426
|
-
|
1427
1259
|
# The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.
|
1428
1260
|
attr_accessor :days_until_due
|
1429
|
-
|
1430
1261
|
# The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.
|
1431
1262
|
attr_accessor :default_margins
|
1432
|
-
|
1433
1263
|
# 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.
|
1434
1264
|
attr_accessor :default_payment_method
|
1435
|
-
|
1436
1265
|
# 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.
|
1437
1266
|
attr_accessor :default_source
|
1438
|
-
|
1439
1267
|
# The tax rates that will apply to any line item that does not have `tax_rates` set.
|
1440
1268
|
attr_accessor :default_tax_rates
|
1441
|
-
|
1442
1269
|
# An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
|
1443
1270
|
attr_accessor :description
|
1444
|
-
|
1445
1271
|
# The coupons and promotion codes to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts.
|
1446
1272
|
attr_accessor :discounts
|
1447
|
-
|
1448
1273
|
# The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`.
|
1449
1274
|
attr_accessor :due_date
|
1450
|
-
|
1451
1275
|
# The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
|
1452
1276
|
attr_accessor :effective_at
|
1453
|
-
|
1454
1277
|
# Specifies which fields in the response should be expanded.
|
1455
1278
|
attr_accessor :expand
|
1456
|
-
|
1457
1279
|
# Footer to be displayed on the invoice.
|
1458
1280
|
attr_accessor :footer
|
1459
|
-
|
1460
1281
|
# Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.
|
1461
1282
|
attr_accessor :from_invoice
|
1462
|
-
|
1463
1283
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
1464
1284
|
attr_accessor :issuer
|
1465
|
-
|
1466
1285
|
# 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`.
|
1467
1286
|
attr_accessor :metadata
|
1468
|
-
|
1469
1287
|
# Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.
|
1470
1288
|
attr_accessor :number
|
1471
|
-
|
1472
1289
|
# The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
|
1473
1290
|
attr_accessor :on_behalf_of
|
1474
|
-
|
1475
1291
|
# Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
|
1476
1292
|
attr_accessor :payment_settings
|
1477
|
-
|
1478
1293
|
# How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted.
|
1479
1294
|
attr_accessor :pending_invoice_items_behavior
|
1480
|
-
|
1481
1295
|
# The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
|
1482
1296
|
attr_accessor :rendering
|
1483
|
-
|
1484
1297
|
# Settings for the cost of shipping for this invoice.
|
1485
1298
|
attr_accessor :shipping_cost
|
1486
|
-
|
1487
1299
|
# Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.
|
1488
1300
|
attr_accessor :shipping_details
|
1489
|
-
|
1490
1301
|
# Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.
|
1491
1302
|
attr_accessor :statement_descriptor
|
1492
|
-
|
1493
1303
|
# The ID of the subscription to invoice, if any. If set, the created invoice will only include pending invoice items for that subscription. The subscription's billing cycle and regular subscription events won't be affected.
|
1494
1304
|
attr_accessor :subscription
|
1495
|
-
|
1496
1305
|
# If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.
|
1497
1306
|
attr_accessor :transfer_data
|
1498
1307
|
|
@@ -1572,13 +1381,10 @@ module Stripe
|
|
1572
1381
|
class SearchParams < Stripe::RequestParams
|
1573
1382
|
# Specifies which fields in the response should be expanded.
|
1574
1383
|
attr_accessor :expand
|
1575
|
-
|
1576
1384
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
1577
1385
|
attr_accessor :limit
|
1578
|
-
|
1579
1386
|
# A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
|
1580
1387
|
attr_accessor :page
|
1581
|
-
|
1582
1388
|
# The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for invoices](https://stripe.com/docs/search#query-fields-for-invoices).
|
1583
1389
|
attr_accessor :query
|
1584
1390
|
|
@@ -1595,7 +1401,6 @@ module Stripe
|
|
1595
1401
|
class Liability < Stripe::RequestParams
|
1596
1402
|
# The connected account being referenced when `type` is `account`.
|
1597
1403
|
attr_accessor :account
|
1598
|
-
|
1599
1404
|
# Type of the account referenced in the request.
|
1600
1405
|
attr_accessor :type
|
1601
1406
|
|
@@ -1606,7 +1411,6 @@ module Stripe
|
|
1606
1411
|
end
|
1607
1412
|
# Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
|
1608
1413
|
attr_accessor :enabled
|
1609
|
-
|
1610
1414
|
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
|
1611
1415
|
attr_accessor :liability
|
1612
1416
|
|
@@ -1620,19 +1424,14 @@ module Stripe
|
|
1620
1424
|
class Address < Stripe::RequestParams
|
1621
1425
|
# City, district, suburb, town, or village.
|
1622
1426
|
attr_accessor :city
|
1623
|
-
|
1624
1427
|
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
1625
1428
|
attr_accessor :country
|
1626
|
-
|
1627
1429
|
# Address line 1 (e.g., street, PO Box, or company name).
|
1628
1430
|
attr_accessor :line1
|
1629
|
-
|
1630
1431
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
1631
1432
|
attr_accessor :line2
|
1632
|
-
|
1633
1433
|
# ZIP or postal code.
|
1634
1434
|
attr_accessor :postal_code
|
1635
|
-
|
1636
1435
|
# State, county, province, or region.
|
1637
1436
|
attr_accessor :state
|
1638
1437
|
|
@@ -1657,19 +1456,14 @@ module Stripe
|
|
1657
1456
|
class Address < Stripe::RequestParams
|
1658
1457
|
# City, district, suburb, town, or village.
|
1659
1458
|
attr_accessor :city
|
1660
|
-
|
1661
1459
|
# A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
1662
1460
|
attr_accessor :country
|
1663
|
-
|
1664
1461
|
# Address line 1 (e.g., street, PO Box, or company name).
|
1665
1462
|
attr_accessor :line1
|
1666
|
-
|
1667
1463
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
1668
1464
|
attr_accessor :line2
|
1669
|
-
|
1670
1465
|
# ZIP or postal code.
|
1671
1466
|
attr_accessor :postal_code
|
1672
|
-
|
1673
1467
|
# State, county, province, or region.
|
1674
1468
|
attr_accessor :state
|
1675
1469
|
|
@@ -1691,10 +1485,8 @@ module Stripe
|
|
1691
1485
|
end
|
1692
1486
|
# Customer shipping address.
|
1693
1487
|
attr_accessor :address
|
1694
|
-
|
1695
1488
|
# Customer name.
|
1696
1489
|
attr_accessor :name
|
1697
|
-
|
1698
1490
|
# Customer phone (including extension).
|
1699
1491
|
attr_accessor :phone
|
1700
1492
|
|
@@ -1715,9 +1507,8 @@ module Stripe
|
|
1715
1507
|
end
|
1716
1508
|
|
1717
1509
|
class TaxId < Stripe::RequestParams
|
1718
|
-
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
|
1510
|
+
# 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`
|
1719
1511
|
attr_accessor :type
|
1720
|
-
|
1721
1512
|
# Value of the tax ID.
|
1722
1513
|
attr_accessor :value
|
1723
1514
|
|
@@ -1728,16 +1519,12 @@ module Stripe
|
|
1728
1519
|
end
|
1729
1520
|
# The customer's address.
|
1730
1521
|
attr_accessor :address
|
1731
|
-
|
1732
1522
|
# The customer's shipping information. Appears on invoices emailed to this customer.
|
1733
1523
|
attr_accessor :shipping
|
1734
|
-
|
1735
1524
|
# Tax details about the customer.
|
1736
1525
|
attr_accessor :tax
|
1737
|
-
|
1738
1526
|
# The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
|
1739
1527
|
attr_accessor :tax_exempt
|
1740
|
-
|
1741
1528
|
# The customer's tax IDs.
|
1742
1529
|
attr_accessor :tax_ids
|
1743
1530
|
|
@@ -1755,7 +1542,6 @@ module Stripe
|
|
1755
1542
|
class Duration < Stripe::RequestParams
|
1756
1543
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1757
1544
|
attr_accessor :interval
|
1758
|
-
|
1759
1545
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1760
1546
|
attr_accessor :interval_count
|
1761
1547
|
|
@@ -1766,10 +1552,8 @@ module Stripe
|
|
1766
1552
|
end
|
1767
1553
|
# Time span for the redeemed discount.
|
1768
1554
|
attr_accessor :duration
|
1769
|
-
|
1770
1555
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1771
1556
|
attr_accessor :timestamp
|
1772
|
-
|
1773
1557
|
# The type of calculation made to determine when the discount ends.
|
1774
1558
|
attr_accessor :type
|
1775
1559
|
|
@@ -1781,13 +1565,10 @@ module Stripe
|
|
1781
1565
|
end
|
1782
1566
|
# ID of the coupon to create a new discount for.
|
1783
1567
|
attr_accessor :coupon
|
1784
|
-
|
1785
1568
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1786
1569
|
attr_accessor :discount
|
1787
|
-
|
1788
1570
|
# Details to determine how long the discount should be applied for.
|
1789
1571
|
attr_accessor :discount_end
|
1790
|
-
|
1791
1572
|
# ID of the promotion code to create a new discount for.
|
1792
1573
|
attr_accessor :promotion_code
|
1793
1574
|
|
@@ -1805,7 +1586,6 @@ module Stripe
|
|
1805
1586
|
class Duration < Stripe::RequestParams
|
1806
1587
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
1807
1588
|
attr_accessor :interval
|
1808
|
-
|
1809
1589
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
1810
1590
|
attr_accessor :interval_count
|
1811
1591
|
|
@@ -1816,10 +1596,8 @@ module Stripe
|
|
1816
1596
|
end
|
1817
1597
|
# Time span for the redeemed discount.
|
1818
1598
|
attr_accessor :duration
|
1819
|
-
|
1820
1599
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
1821
1600
|
attr_accessor :timestamp
|
1822
|
-
|
1823
1601
|
# The type of calculation made to determine when the discount ends.
|
1824
1602
|
attr_accessor :type
|
1825
1603
|
|
@@ -1831,13 +1609,10 @@ module Stripe
|
|
1831
1609
|
end
|
1832
1610
|
# ID of the coupon to create a new discount for.
|
1833
1611
|
attr_accessor :coupon
|
1834
|
-
|
1835
1612
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
1836
1613
|
attr_accessor :discount
|
1837
|
-
|
1838
1614
|
# Details to determine how long the discount should be applied for.
|
1839
1615
|
attr_accessor :discount_end
|
1840
|
-
|
1841
1616
|
# ID of the promotion code to create a new discount for.
|
1842
1617
|
attr_accessor :promotion_code
|
1843
1618
|
|
@@ -1852,7 +1627,6 @@ module Stripe
|
|
1852
1627
|
class Period < Stripe::RequestParams
|
1853
1628
|
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
|
1854
1629
|
attr_accessor :end
|
1855
|
-
|
1856
1630
|
# The start of the period. This value is inclusive.
|
1857
1631
|
attr_accessor :start
|
1858
1632
|
|
@@ -1865,16 +1639,12 @@ module Stripe
|
|
1865
1639
|
class PriceData < Stripe::RequestParams
|
1866
1640
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
1867
1641
|
attr_accessor :currency
|
1868
|
-
|
1869
1642
|
# The ID of the product that this price will belong to.
|
1870
1643
|
attr_accessor :product
|
1871
|
-
|
1872
1644
|
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
1873
1645
|
attr_accessor :tax_behavior
|
1874
|
-
|
1875
1646
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
1876
1647
|
attr_accessor :unit_amount
|
1877
|
-
|
1878
1648
|
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
1879
1649
|
attr_accessor :unit_amount_decimal
|
1880
1650
|
|
@@ -1894,49 +1664,34 @@ module Stripe
|
|
1894
1664
|
end
|
1895
1665
|
# The integer amount in cents (or local equivalent) of previewed invoice item.
|
1896
1666
|
attr_accessor :amount
|
1897
|
-
|
1898
1667
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Only applicable to new invoice items.
|
1899
1668
|
attr_accessor :currency
|
1900
|
-
|
1901
1669
|
# An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
|
1902
1670
|
attr_accessor :description
|
1903
|
-
|
1904
1671
|
# Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.
|
1905
1672
|
attr_accessor :discountable
|
1906
|
-
|
1907
1673
|
# The coupons to redeem into discounts for the invoice item in the preview.
|
1908
1674
|
attr_accessor :discounts
|
1909
|
-
|
1910
1675
|
# The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice.
|
1911
1676
|
attr_accessor :invoiceitem
|
1912
|
-
|
1913
1677
|
# 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`.
|
1914
1678
|
attr_accessor :metadata
|
1915
|
-
|
1916
1679
|
# 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.
|
1917
1680
|
attr_accessor :period
|
1918
|
-
|
1919
1681
|
# The ID of the price object. One of `price` or `price_data` is required.
|
1920
1682
|
attr_accessor :price
|
1921
|
-
|
1922
1683
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
1923
1684
|
attr_accessor :price_data
|
1924
|
-
|
1925
1685
|
# Non-negative integer. The quantity of units for the invoice item.
|
1926
1686
|
attr_accessor :quantity
|
1927
|
-
|
1928
1687
|
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
1929
1688
|
attr_accessor :tax_behavior
|
1930
|
-
|
1931
1689
|
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
|
1932
1690
|
attr_accessor :tax_code
|
1933
|
-
|
1934
1691
|
# The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item.
|
1935
1692
|
attr_accessor :tax_rates
|
1936
|
-
|
1937
1693
|
# The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.
|
1938
1694
|
attr_accessor :unit_amount
|
1939
|
-
|
1940
1695
|
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
1941
1696
|
attr_accessor :unit_amount_decimal
|
1942
1697
|
|
@@ -1980,7 +1735,6 @@ module Stripe
|
|
1980
1735
|
class Issuer < Stripe::RequestParams
|
1981
1736
|
# The connected account being referenced when `type` is `account`.
|
1982
1737
|
attr_accessor :account
|
1983
|
-
|
1984
1738
|
# Type of the account referenced in the request.
|
1985
1739
|
attr_accessor :type
|
1986
1740
|
|
@@ -2005,7 +1759,6 @@ module Stripe
|
|
2005
1759
|
class Duration < Stripe::RequestParams
|
2006
1760
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2007
1761
|
attr_accessor :interval
|
2008
|
-
|
2009
1762
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2010
1763
|
attr_accessor :interval_count
|
2011
1764
|
|
@@ -2016,13 +1769,10 @@ module Stripe
|
|
2016
1769
|
end
|
2017
1770
|
# Use the `end` time of a given discount.
|
2018
1771
|
attr_accessor :discount_end
|
2019
|
-
|
2020
1772
|
# Time span for the amendment starting from the `amendment_start`.
|
2021
1773
|
attr_accessor :duration
|
2022
|
-
|
2023
1774
|
# A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
|
2024
1775
|
attr_accessor :timestamp
|
2025
|
-
|
2026
1776
|
# Select one of three ways to pass the `amendment_end`.
|
2027
1777
|
attr_accessor :type
|
2028
1778
|
|
@@ -2054,13 +1804,10 @@ module Stripe
|
|
2054
1804
|
end
|
2055
1805
|
# Details of another amendment in the same array, immediately after which this amendment should begin.
|
2056
1806
|
attr_accessor :amendment_end
|
2057
|
-
|
2058
1807
|
# Use the `end` time of a given discount.
|
2059
1808
|
attr_accessor :discount_end
|
2060
|
-
|
2061
1809
|
# A precise Unix timestamp for the amendment to start.
|
2062
1810
|
attr_accessor :timestamp
|
2063
|
-
|
2064
1811
|
# Select one of three ways to pass the `amendment_start`.
|
2065
1812
|
attr_accessor :type
|
2066
1813
|
|
@@ -2084,16 +1831,12 @@ module Stripe
|
|
2084
1831
|
end
|
2085
1832
|
# The coupon code to redeem.
|
2086
1833
|
attr_accessor :coupon
|
2087
|
-
|
2088
1834
|
# An ID of an existing discount for a coupon that was already redeemed.
|
2089
1835
|
attr_accessor :discount
|
2090
|
-
|
2091
1836
|
# Details to determine how long the discount should be applied for.
|
2092
1837
|
attr_accessor :discount_end
|
2093
|
-
|
2094
1838
|
# 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.
|
2095
1839
|
attr_accessor :index
|
2096
|
-
|
2097
1840
|
# The promotion code to redeem.
|
2098
1841
|
attr_accessor :promotion_code
|
2099
1842
|
|
@@ -2115,10 +1858,8 @@ module Stripe
|
|
2115
1858
|
class Remove < Stripe::RequestParams
|
2116
1859
|
# The coupon code to remove from the `discounts` array.
|
2117
1860
|
attr_accessor :coupon
|
2118
|
-
|
2119
1861
|
# The ID of a discount to remove from the `discounts` array.
|
2120
1862
|
attr_accessor :discount
|
2121
|
-
|
2122
1863
|
# The ID of a promotion code to remove from the `discounts` array.
|
2123
1864
|
attr_accessor :promotion_code
|
2124
1865
|
|
@@ -2132,10 +1873,8 @@ module Stripe
|
|
2132
1873
|
class Set < Stripe::RequestParams
|
2133
1874
|
# The coupon code to replace the `discounts` array with.
|
2134
1875
|
attr_accessor :coupon
|
2135
|
-
|
2136
1876
|
# An ID of an existing discount to replace the `discounts` array with.
|
2137
1877
|
attr_accessor :discount
|
2138
|
-
|
2139
1878
|
# An ID of an existing promotion code to replace the `discounts` array with.
|
2140
1879
|
attr_accessor :promotion_code
|
2141
1880
|
|
@@ -2147,13 +1886,10 @@ module Stripe
|
|
2147
1886
|
end
|
2148
1887
|
# Details of the discount to add.
|
2149
1888
|
attr_accessor :add
|
2150
|
-
|
2151
1889
|
# Details of the discount to remove.
|
2152
1890
|
attr_accessor :remove
|
2153
|
-
|
2154
1891
|
# Details of the discount to replace the existing discounts with.
|
2155
1892
|
attr_accessor :set
|
2156
|
-
|
2157
1893
|
# Determines the type of discount action.
|
2158
1894
|
attr_accessor :type
|
2159
1895
|
|
@@ -2172,7 +1908,6 @@ module Stripe
|
|
2172
1908
|
class Duration < Stripe::RequestParams
|
2173
1909
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2174
1910
|
attr_accessor :interval
|
2175
|
-
|
2176
1911
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2177
1912
|
attr_accessor :interval_count
|
2178
1913
|
|
@@ -2183,10 +1918,8 @@ module Stripe
|
|
2183
1918
|
end
|
2184
1919
|
# Time span for the redeemed discount.
|
2185
1920
|
attr_accessor :duration
|
2186
|
-
|
2187
1921
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
2188
1922
|
attr_accessor :timestamp
|
2189
|
-
|
2190
1923
|
# The type of calculation made to determine when the discount ends.
|
2191
1924
|
attr_accessor :type
|
2192
1925
|
|
@@ -2198,13 +1931,10 @@ module Stripe
|
|
2198
1931
|
end
|
2199
1932
|
# ID of the coupon to create a new discount for.
|
2200
1933
|
attr_accessor :coupon
|
2201
|
-
|
2202
1934
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
2203
1935
|
attr_accessor :discount
|
2204
|
-
|
2205
1936
|
# Details to determine how long the discount should be applied for.
|
2206
1937
|
attr_accessor :discount_end
|
2207
|
-
|
2208
1938
|
# ID of the promotion code to create a new discount for.
|
2209
1939
|
attr_accessor :promotion_code
|
2210
1940
|
|
@@ -2219,7 +1949,6 @@ module Stripe
|
|
2219
1949
|
class Trial < Stripe::RequestParams
|
2220
1950
|
# 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.
|
2221
1951
|
attr_accessor :converts_to
|
2222
|
-
|
2223
1952
|
# Determines the type of trial for this item.
|
2224
1953
|
attr_accessor :type
|
2225
1954
|
|
@@ -2230,19 +1959,14 @@ module Stripe
|
|
2230
1959
|
end
|
2231
1960
|
# The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
2232
1961
|
attr_accessor :discounts
|
2233
|
-
|
2234
1962
|
# 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`.
|
2235
1963
|
attr_accessor :metadata
|
2236
|
-
|
2237
1964
|
# The ID of the price object.
|
2238
1965
|
attr_accessor :price
|
2239
|
-
|
2240
1966
|
# Quantity for this item.
|
2241
1967
|
attr_accessor :quantity
|
2242
|
-
|
2243
1968
|
# 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`.
|
2244
1969
|
attr_accessor :tax_rates
|
2245
|
-
|
2246
1970
|
# Options that configure the trial on the subscription item.
|
2247
1971
|
attr_accessor :trial
|
2248
1972
|
|
@@ -2278,7 +2002,6 @@ module Stripe
|
|
2278
2002
|
class Duration < Stripe::RequestParams
|
2279
2003
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2280
2004
|
attr_accessor :interval
|
2281
|
-
|
2282
2005
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2283
2006
|
attr_accessor :interval_count
|
2284
2007
|
|
@@ -2289,10 +2012,8 @@ module Stripe
|
|
2289
2012
|
end
|
2290
2013
|
# Time span for the redeemed discount.
|
2291
2014
|
attr_accessor :duration
|
2292
|
-
|
2293
2015
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
2294
2016
|
attr_accessor :timestamp
|
2295
|
-
|
2296
2017
|
# The type of calculation made to determine when the discount ends.
|
2297
2018
|
attr_accessor :type
|
2298
2019
|
|
@@ -2304,13 +2025,10 @@ module Stripe
|
|
2304
2025
|
end
|
2305
2026
|
# ID of the coupon to create a new discount for.
|
2306
2027
|
attr_accessor :coupon
|
2307
|
-
|
2308
2028
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
2309
2029
|
attr_accessor :discount
|
2310
|
-
|
2311
2030
|
# Details to determine how long the discount should be applied for.
|
2312
2031
|
attr_accessor :discount_end
|
2313
|
-
|
2314
2032
|
# ID of the promotion code to create a new discount for.
|
2315
2033
|
attr_accessor :promotion_code
|
2316
2034
|
|
@@ -2325,7 +2043,6 @@ module Stripe
|
|
2325
2043
|
class Trial < Stripe::RequestParams
|
2326
2044
|
# 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.
|
2327
2045
|
attr_accessor :converts_to
|
2328
|
-
|
2329
2046
|
# Determines the type of trial for this item.
|
2330
2047
|
attr_accessor :type
|
2331
2048
|
|
@@ -2336,19 +2053,14 @@ module Stripe
|
|
2336
2053
|
end
|
2337
2054
|
# 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`.
|
2338
2055
|
attr_accessor :discounts
|
2339
|
-
|
2340
2056
|
# 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`.
|
2341
2057
|
attr_accessor :metadata
|
2342
|
-
|
2343
2058
|
# The ID of the price object.
|
2344
2059
|
attr_accessor :price
|
2345
|
-
|
2346
2060
|
# 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`.
|
2347
2061
|
attr_accessor :quantity
|
2348
|
-
|
2349
2062
|
# 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`.
|
2350
2063
|
attr_accessor :tax_rates
|
2351
|
-
|
2352
2064
|
# 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`.
|
2353
2065
|
attr_accessor :trial
|
2354
2066
|
|
@@ -2370,13 +2082,10 @@ module Stripe
|
|
2370
2082
|
end
|
2371
2083
|
# 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.
|
2372
2084
|
attr_accessor :add
|
2373
|
-
|
2374
2085
|
# Details of the subscription item to remove.
|
2375
2086
|
attr_accessor :remove
|
2376
|
-
|
2377
2087
|
# 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.
|
2378
2088
|
attr_accessor :set
|
2379
|
-
|
2380
2089
|
# Determines the type of item action.
|
2381
2090
|
attr_accessor :type
|
2382
2091
|
|
@@ -2391,13 +2100,10 @@ module Stripe
|
|
2391
2100
|
class MetadataAction < Stripe::RequestParams
|
2392
2101
|
# Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
|
2393
2102
|
attr_accessor :add
|
2394
|
-
|
2395
2103
|
# Keys to remove from schedule phase metadata.
|
2396
2104
|
attr_accessor :remove
|
2397
|
-
|
2398
2105
|
# Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
|
2399
2106
|
attr_accessor :set
|
2400
|
-
|
2401
2107
|
# Select one of three ways to update phase-level `metadata` on subscription schedules.
|
2402
2108
|
attr_accessor :type
|
2403
2109
|
|
@@ -2420,7 +2126,6 @@ module Stripe
|
|
2420
2126
|
end
|
2421
2127
|
# Details of the pause_collection behavior to apply to the amendment.
|
2422
2128
|
attr_accessor :set
|
2423
|
-
|
2424
2129
|
# Determines the type of the pause_collection amendment.
|
2425
2130
|
attr_accessor :type
|
2426
2131
|
|
@@ -2448,31 +2153,22 @@ module Stripe
|
|
2448
2153
|
end
|
2449
2154
|
# 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.
|
2450
2155
|
attr_accessor :amendment_end
|
2451
|
-
|
2452
2156
|
# Details to identify the earliest timestamp where the proposed change should take effect.
|
2453
2157
|
attr_accessor :amendment_start
|
2454
|
-
|
2455
2158
|
# 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.
|
2456
2159
|
attr_accessor :billing_cycle_anchor
|
2457
|
-
|
2458
2160
|
# Changes to the coupons being redeemed or discounts being applied during the amendment time span.
|
2459
2161
|
attr_accessor :discount_actions
|
2460
|
-
|
2461
2162
|
# Changes to the subscription items during the amendment time span.
|
2462
2163
|
attr_accessor :item_actions
|
2463
|
-
|
2464
2164
|
# Instructions for how to modify phase metadata
|
2465
2165
|
attr_accessor :metadata_actions
|
2466
|
-
|
2467
2166
|
# 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`.
|
2468
2167
|
attr_accessor :proration_behavior
|
2469
|
-
|
2470
2168
|
# Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
2471
2169
|
attr_accessor :set_pause_collection
|
2472
|
-
|
2473
2170
|
# Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
|
2474
2171
|
attr_accessor :set_schedule_end
|
2475
|
-
|
2476
2172
|
# Settings related to subscription trials.
|
2477
2173
|
attr_accessor :trial_settings
|
2478
2174
|
|
@@ -2508,7 +2204,6 @@ module Stripe
|
|
2508
2204
|
class Duration < Stripe::RequestParams
|
2509
2205
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2510
2206
|
attr_accessor :interval
|
2511
|
-
|
2512
2207
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2513
2208
|
attr_accessor :interval_count
|
2514
2209
|
|
@@ -2519,10 +2214,8 @@ module Stripe
|
|
2519
2214
|
end
|
2520
2215
|
# Time span for the redeemed discount.
|
2521
2216
|
attr_accessor :duration
|
2522
|
-
|
2523
2217
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
2524
2218
|
attr_accessor :timestamp
|
2525
|
-
|
2526
2219
|
# The type of calculation made to determine when the discount ends.
|
2527
2220
|
attr_accessor :type
|
2528
2221
|
|
@@ -2534,13 +2227,10 @@ module Stripe
|
|
2534
2227
|
end
|
2535
2228
|
# ID of the coupon to create a new discount for.
|
2536
2229
|
attr_accessor :coupon
|
2537
|
-
|
2538
2230
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
2539
2231
|
attr_accessor :discount
|
2540
|
-
|
2541
2232
|
# Details to determine how long the discount should be applied for.
|
2542
2233
|
attr_accessor :discount_end
|
2543
|
-
|
2544
2234
|
# ID of the promotion code to create a new discount for.
|
2545
2235
|
attr_accessor :promotion_code
|
2546
2236
|
|
@@ -2555,16 +2245,12 @@ module Stripe
|
|
2555
2245
|
class PriceData < Stripe::RequestParams
|
2556
2246
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
2557
2247
|
attr_accessor :currency
|
2558
|
-
|
2559
2248
|
# The ID of the product that this price will belong to.
|
2560
2249
|
attr_accessor :product
|
2561
|
-
|
2562
2250
|
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
2563
2251
|
attr_accessor :tax_behavior
|
2564
|
-
|
2565
2252
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
|
2566
2253
|
attr_accessor :unit_amount
|
2567
|
-
|
2568
2254
|
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
2569
2255
|
attr_accessor :unit_amount_decimal
|
2570
2256
|
|
@@ -2584,16 +2270,12 @@ module Stripe
|
|
2584
2270
|
end
|
2585
2271
|
# The coupons to redeem into discounts for the item.
|
2586
2272
|
attr_accessor :discounts
|
2587
|
-
|
2588
2273
|
# The ID of the price object. One of `price` or `price_data` is required.
|
2589
2274
|
attr_accessor :price
|
2590
|
-
|
2591
2275
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
2592
2276
|
attr_accessor :price_data
|
2593
|
-
|
2594
2277
|
# Quantity for this item. Defaults to 1.
|
2595
2278
|
attr_accessor :quantity
|
2596
|
-
|
2597
2279
|
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
|
2598
2280
|
attr_accessor :tax_rates
|
2599
2281
|
|
@@ -2616,7 +2298,6 @@ module Stripe
|
|
2616
2298
|
class Liability < Stripe::RequestParams
|
2617
2299
|
# The connected account being referenced when `type` is `account`.
|
2618
2300
|
attr_accessor :account
|
2619
|
-
|
2620
2301
|
# Type of the account referenced in the request.
|
2621
2302
|
attr_accessor :type
|
2622
2303
|
|
@@ -2627,7 +2308,6 @@ module Stripe
|
|
2627
2308
|
end
|
2628
2309
|
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
|
2629
2310
|
attr_accessor :enabled
|
2630
|
-
|
2631
2311
|
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
|
2632
2312
|
attr_accessor :liability
|
2633
2313
|
|
@@ -2640,7 +2320,6 @@ module Stripe
|
|
2640
2320
|
class BillingThresholds < Stripe::RequestParams
|
2641
2321
|
# Monetary threshold that triggers the subscription to advance to a new billing period
|
2642
2322
|
attr_accessor :amount_gte
|
2643
|
-
|
2644
2323
|
# Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
|
2645
2324
|
attr_accessor :reset_billing_cycle_anchor
|
2646
2325
|
|
@@ -2655,7 +2334,6 @@ module Stripe
|
|
2655
2334
|
class Duration < Stripe::RequestParams
|
2656
2335
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2657
2336
|
attr_accessor :interval
|
2658
|
-
|
2659
2337
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2660
2338
|
attr_accessor :interval_count
|
2661
2339
|
|
@@ -2666,10 +2344,8 @@ module Stripe
|
|
2666
2344
|
end
|
2667
2345
|
# Time span for the redeemed discount.
|
2668
2346
|
attr_accessor :duration
|
2669
|
-
|
2670
2347
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
2671
2348
|
attr_accessor :timestamp
|
2672
|
-
|
2673
2349
|
# The type of calculation made to determine when the discount ends.
|
2674
2350
|
attr_accessor :type
|
2675
2351
|
|
@@ -2681,13 +2357,10 @@ module Stripe
|
|
2681
2357
|
end
|
2682
2358
|
# ID of the coupon to create a new discount for.
|
2683
2359
|
attr_accessor :coupon
|
2684
|
-
|
2685
2360
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
2686
2361
|
attr_accessor :discount
|
2687
|
-
|
2688
2362
|
# Details to determine how long the discount should be applied for.
|
2689
2363
|
attr_accessor :discount_end
|
2690
|
-
|
2691
2364
|
# ID of the promotion code to create a new discount for.
|
2692
2365
|
attr_accessor :promotion_code
|
2693
2366
|
|
@@ -2703,7 +2376,6 @@ module Stripe
|
|
2703
2376
|
class Issuer < Stripe::RequestParams
|
2704
2377
|
# The connected account being referenced when `type` is `account`.
|
2705
2378
|
attr_accessor :account
|
2706
|
-
|
2707
2379
|
# Type of the account referenced in the request.
|
2708
2380
|
attr_accessor :type
|
2709
2381
|
|
@@ -2714,10 +2386,8 @@ module Stripe
|
|
2714
2386
|
end
|
2715
2387
|
# The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
|
2716
2388
|
attr_accessor :account_tax_ids
|
2717
|
-
|
2718
2389
|
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
|
2719
2390
|
attr_accessor :days_until_due
|
2720
|
-
|
2721
2391
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
2722
2392
|
attr_accessor :issuer
|
2723
2393
|
|
@@ -2743,7 +2413,6 @@ module Stripe
|
|
2743
2413
|
class Duration < Stripe::RequestParams
|
2744
2414
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
2745
2415
|
attr_accessor :interval
|
2746
|
-
|
2747
2416
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
2748
2417
|
attr_accessor :interval_count
|
2749
2418
|
|
@@ -2754,10 +2423,8 @@ module Stripe
|
|
2754
2423
|
end
|
2755
2424
|
# Time span for the redeemed discount.
|
2756
2425
|
attr_accessor :duration
|
2757
|
-
|
2758
2426
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
2759
2427
|
attr_accessor :timestamp
|
2760
|
-
|
2761
2428
|
# The type of calculation made to determine when the discount ends.
|
2762
2429
|
attr_accessor :type
|
2763
2430
|
|
@@ -2769,13 +2436,10 @@ module Stripe
|
|
2769
2436
|
end
|
2770
2437
|
# ID of the coupon to create a new discount for.
|
2771
2438
|
attr_accessor :coupon
|
2772
|
-
|
2773
2439
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
2774
2440
|
attr_accessor :discount
|
2775
|
-
|
2776
2441
|
# Details to determine how long the discount should be applied for.
|
2777
2442
|
attr_accessor :discount_end
|
2778
|
-
|
2779
2443
|
# ID of the promotion code to create a new discount for.
|
2780
2444
|
attr_accessor :promotion_code
|
2781
2445
|
|
@@ -2791,7 +2455,6 @@ module Stripe
|
|
2791
2455
|
class Recurring < Stripe::RequestParams
|
2792
2456
|
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
2793
2457
|
attr_accessor :interval
|
2794
|
-
|
2795
2458
|
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
|
2796
2459
|
attr_accessor :interval_count
|
2797
2460
|
|
@@ -2802,19 +2465,14 @@ module Stripe
|
|
2802
2465
|
end
|
2803
2466
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
2804
2467
|
attr_accessor :currency
|
2805
|
-
|
2806
2468
|
# The ID of the product that this price will belong to.
|
2807
2469
|
attr_accessor :product
|
2808
|
-
|
2809
2470
|
# The recurring components of a price such as `interval` and `interval_count`.
|
2810
2471
|
attr_accessor :recurring
|
2811
|
-
|
2812
2472
|
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
2813
2473
|
attr_accessor :tax_behavior
|
2814
|
-
|
2815
2474
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
2816
2475
|
attr_accessor :unit_amount
|
2817
|
-
|
2818
2476
|
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
2819
2477
|
attr_accessor :unit_amount_decimal
|
2820
2478
|
|
@@ -2838,7 +2496,6 @@ module Stripe
|
|
2838
2496
|
class Trial < Stripe::RequestParams
|
2839
2497
|
# 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.
|
2840
2498
|
attr_accessor :converts_to
|
2841
|
-
|
2842
2499
|
# Determines the type of trial for this item.
|
2843
2500
|
attr_accessor :type
|
2844
2501
|
|
@@ -2849,28 +2506,20 @@ module Stripe
|
|
2849
2506
|
end
|
2850
2507
|
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
|
2851
2508
|
attr_accessor :billing_thresholds
|
2852
|
-
|
2853
2509
|
# The coupons to redeem into discounts for the subscription item.
|
2854
2510
|
attr_accessor :discounts
|
2855
|
-
|
2856
2511
|
# 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`.
|
2857
2512
|
attr_accessor :metadata
|
2858
|
-
|
2859
2513
|
# The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
|
2860
2514
|
attr_accessor :plan
|
2861
|
-
|
2862
2515
|
# The ID of the price object.
|
2863
2516
|
attr_accessor :price
|
2864
|
-
|
2865
2517
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
|
2866
2518
|
attr_accessor :price_data
|
2867
|
-
|
2868
2519
|
# Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
|
2869
2520
|
attr_accessor :quantity
|
2870
|
-
|
2871
2521
|
# 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.
|
2872
2522
|
attr_accessor :tax_rates
|
2873
|
-
|
2874
2523
|
# Options that configure the trial on the subscription item.
|
2875
2524
|
attr_accessor :trial
|
2876
2525
|
|
@@ -2909,7 +2558,6 @@ module Stripe
|
|
2909
2558
|
class TransferData < Stripe::RequestParams
|
2910
2559
|
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
|
2911
2560
|
attr_accessor :amount_percent
|
2912
|
-
|
2913
2561
|
# ID of an existing, connected Stripe account.
|
2914
2562
|
attr_accessor :destination
|
2915
2563
|
|
@@ -2937,79 +2585,54 @@ module Stripe
|
|
2937
2585
|
end
|
2938
2586
|
# 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.
|
2939
2587
|
attr_accessor :add_invoice_items
|
2940
|
-
|
2941
2588
|
# 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).
|
2942
2589
|
attr_accessor :application_fee_percent
|
2943
|
-
|
2944
2590
|
# Automatic tax settings for this phase.
|
2945
2591
|
attr_accessor :automatic_tax
|
2946
|
-
|
2947
2592
|
# Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
|
2948
2593
|
attr_accessor :billing_cycle_anchor
|
2949
|
-
|
2950
2594
|
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
|
2951
2595
|
attr_accessor :billing_thresholds
|
2952
|
-
|
2953
2596
|
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
|
2954
2597
|
attr_accessor :collection_method
|
2955
|
-
|
2956
2598
|
# The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
|
2957
2599
|
attr_accessor :coupon
|
2958
|
-
|
2959
2600
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
2960
2601
|
attr_accessor :currency
|
2961
|
-
|
2962
2602
|
# ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
|
2963
2603
|
attr_accessor :default_payment_method
|
2964
|
-
|
2965
2604
|
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
|
2966
2605
|
attr_accessor :default_tax_rates
|
2967
|
-
|
2968
2606
|
# Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
|
2969
2607
|
attr_accessor :description
|
2970
|
-
|
2971
2608
|
# The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
|
2972
2609
|
attr_accessor :discounts
|
2973
|
-
|
2974
2610
|
# The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
|
2975
2611
|
attr_accessor :end_date
|
2976
|
-
|
2977
2612
|
# All invoices will be billed using the specified settings.
|
2978
2613
|
attr_accessor :invoice_settings
|
2979
|
-
|
2980
2614
|
# List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
|
2981
2615
|
attr_accessor :items
|
2982
|
-
|
2983
2616
|
# Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.
|
2984
2617
|
attr_accessor :iterations
|
2985
|
-
|
2986
2618
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
|
2987
2619
|
attr_accessor :metadata
|
2988
|
-
|
2989
2620
|
# The account on behalf of which to charge, for each of the associated subscription's invoices.
|
2990
2621
|
attr_accessor :on_behalf_of
|
2991
|
-
|
2992
2622
|
# 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).
|
2993
2623
|
attr_accessor :pause_collection
|
2994
|
-
|
2995
2624
|
# 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.
|
2996
2625
|
attr_accessor :proration_behavior
|
2997
|
-
|
2998
2626
|
# The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
|
2999
2627
|
attr_accessor :start_date
|
3000
|
-
|
3001
2628
|
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
3002
2629
|
attr_accessor :transfer_data
|
3003
|
-
|
3004
2630
|
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
3005
2631
|
attr_accessor :trial
|
3006
|
-
|
3007
2632
|
# Specify trial behavior when crossing phase boundaries
|
3008
2633
|
attr_accessor :trial_continuation
|
3009
|
-
|
3010
2634
|
# 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`
|
3011
2635
|
attr_accessor :trial_end
|
3012
|
-
|
3013
2636
|
# Settings related to subscription trials.
|
3014
2637
|
attr_accessor :trial_settings
|
3015
2638
|
|
@@ -3084,7 +2707,6 @@ module Stripe
|
|
3084
2707
|
class Duration < Stripe::RequestParams
|
3085
2708
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
3086
2709
|
attr_accessor :interval
|
3087
|
-
|
3088
2710
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
3089
2711
|
attr_accessor :interval_count
|
3090
2712
|
|
@@ -3095,13 +2717,10 @@ module Stripe
|
|
3095
2717
|
end
|
3096
2718
|
# End the prebilled period when a specified amendment ends.
|
3097
2719
|
attr_accessor :amendment_end
|
3098
|
-
|
3099
2720
|
# Time span for prebilling, starting from `bill_from`.
|
3100
2721
|
attr_accessor :duration
|
3101
|
-
|
3102
2722
|
# End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
3103
2723
|
attr_accessor :timestamp
|
3104
|
-
|
3105
2724
|
# Select one of several ways to pass the `bill_until` value.
|
3106
2725
|
attr_accessor :type
|
3107
2726
|
|
@@ -3114,7 +2733,6 @@ module Stripe
|
|
3114
2733
|
end
|
3115
2734
|
# The end of the prebilled time period.
|
3116
2735
|
attr_accessor :bill_until
|
3117
|
-
|
3118
2736
|
# This is used to determine the number of billing cycles to prebill.
|
3119
2737
|
attr_accessor :iterations
|
3120
2738
|
|
@@ -3125,19 +2743,14 @@ module Stripe
|
|
3125
2743
|
end
|
3126
2744
|
# Changes to apply to the phases of the subscription schedule, in the order provided.
|
3127
2745
|
attr_accessor :amendments
|
3128
|
-
|
3129
2746
|
# 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.
|
3130
2747
|
attr_accessor :billing_behavior
|
3131
|
-
|
3132
2748
|
# 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.
|
3133
2749
|
attr_accessor :end_behavior
|
3134
|
-
|
3135
2750
|
# 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.
|
3136
2751
|
attr_accessor :phases
|
3137
|
-
|
3138
2752
|
# Provide any time periods to bill in advance.
|
3139
2753
|
attr_accessor :prebilling
|
3140
|
-
|
3141
2754
|
# In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
|
3142
2755
|
attr_accessor :proration_behavior
|
3143
2756
|
|
@@ -3174,7 +2787,6 @@ module Stripe
|
|
3174
2787
|
class Duration < Stripe::RequestParams
|
3175
2788
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
3176
2789
|
attr_accessor :interval
|
3177
|
-
|
3178
2790
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
3179
2791
|
attr_accessor :interval_count
|
3180
2792
|
|
@@ -3185,10 +2797,8 @@ module Stripe
|
|
3185
2797
|
end
|
3186
2798
|
# Time span for the redeemed discount.
|
3187
2799
|
attr_accessor :duration
|
3188
|
-
|
3189
2800
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
3190
2801
|
attr_accessor :timestamp
|
3191
|
-
|
3192
2802
|
# The type of calculation made to determine when the discount ends.
|
3193
2803
|
attr_accessor :type
|
3194
2804
|
|
@@ -3200,13 +2810,10 @@ module Stripe
|
|
3200
2810
|
end
|
3201
2811
|
# ID of the coupon to create a new discount for.
|
3202
2812
|
attr_accessor :coupon
|
3203
|
-
|
3204
2813
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
3205
2814
|
attr_accessor :discount
|
3206
|
-
|
3207
2815
|
# Details to determine how long the discount should be applied for.
|
3208
2816
|
attr_accessor :discount_end
|
3209
|
-
|
3210
2817
|
# ID of the promotion code to create a new discount for.
|
3211
2818
|
attr_accessor :promotion_code
|
3212
2819
|
|
@@ -3222,7 +2829,6 @@ module Stripe
|
|
3222
2829
|
class Recurring < Stripe::RequestParams
|
3223
2830
|
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
3224
2831
|
attr_accessor :interval
|
3225
|
-
|
3226
2832
|
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
|
3227
2833
|
attr_accessor :interval_count
|
3228
2834
|
|
@@ -3233,19 +2839,14 @@ module Stripe
|
|
3233
2839
|
end
|
3234
2840
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
3235
2841
|
attr_accessor :currency
|
3236
|
-
|
3237
2842
|
# The ID of the product that this price will belong to.
|
3238
2843
|
attr_accessor :product
|
3239
|
-
|
3240
2844
|
# The recurring components of a price such as `interval` and `interval_count`.
|
3241
2845
|
attr_accessor :recurring
|
3242
|
-
|
3243
2846
|
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
3244
2847
|
attr_accessor :tax_behavior
|
3245
|
-
|
3246
2848
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
3247
2849
|
attr_accessor :unit_amount
|
3248
|
-
|
3249
2850
|
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
3250
2851
|
attr_accessor :unit_amount_decimal
|
3251
2852
|
|
@@ -3267,34 +2868,24 @@ module Stripe
|
|
3267
2868
|
end
|
3268
2869
|
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
|
3269
2870
|
attr_accessor :billing_thresholds
|
3270
|
-
|
3271
2871
|
# Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
|
3272
2872
|
attr_accessor :clear_usage
|
3273
|
-
|
3274
2873
|
# A flag that, if set to `true`, will delete the specified item.
|
3275
2874
|
attr_accessor :deleted
|
3276
|
-
|
3277
2875
|
# The coupons to redeem into discounts for the subscription item.
|
3278
2876
|
attr_accessor :discounts
|
3279
|
-
|
3280
2877
|
# Subscription item to update.
|
3281
2878
|
attr_accessor :id
|
3282
|
-
|
3283
2879
|
# 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`.
|
3284
2880
|
attr_accessor :metadata
|
3285
|
-
|
3286
2881
|
# Plan ID for this item, as a string.
|
3287
2882
|
attr_accessor :plan
|
3288
|
-
|
3289
2883
|
# The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
|
3290
2884
|
attr_accessor :price
|
3291
|
-
|
3292
2885
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
3293
2886
|
attr_accessor :price_data
|
3294
|
-
|
3295
2887
|
# Quantity for this item.
|
3296
2888
|
attr_accessor :quantity
|
3297
|
-
|
3298
2889
|
# 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.
|
3299
2890
|
attr_accessor :tax_rates
|
3300
2891
|
|
@@ -3335,37 +2926,26 @@ module Stripe
|
|
3335
2926
|
end
|
3336
2927
|
# 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`.
|
3337
2928
|
attr_accessor :billing_cycle_anchor
|
3338
|
-
|
3339
2929
|
# 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.
|
3340
2930
|
attr_accessor :cancel_at
|
3341
|
-
|
3342
2931
|
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
|
3343
2932
|
attr_accessor :cancel_at_period_end
|
3344
|
-
|
3345
2933
|
# This simulates the subscription being canceled or expired immediately.
|
3346
2934
|
attr_accessor :cancel_now
|
3347
|
-
|
3348
2935
|
# If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set.
|
3349
2936
|
attr_accessor :default_tax_rates
|
3350
|
-
|
3351
2937
|
# A list of up to 20 subscription items, each with an attached price.
|
3352
2938
|
attr_accessor :items
|
3353
|
-
|
3354
2939
|
# The pre-billing to apply to the subscription as a preview.
|
3355
2940
|
attr_accessor :prebilling
|
3356
|
-
|
3357
2941
|
# 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`.
|
3358
2942
|
attr_accessor :proration_behavior
|
3359
|
-
|
3360
2943
|
# 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'.
|
3361
2944
|
attr_accessor :proration_date
|
3362
|
-
|
3363
2945
|
# For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.
|
3364
2946
|
attr_accessor :resume_at
|
3365
|
-
|
3366
2947
|
# Date a subscription is intended to start (can be future or past).
|
3367
2948
|
attr_accessor :start_date
|
3368
|
-
|
3369
2949
|
# If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_details.items` or `subscription` is required.
|
3370
2950
|
attr_accessor :trial_end
|
3371
2951
|
|
@@ -3413,7 +2993,6 @@ module Stripe
|
|
3413
2993
|
class Duration < Stripe::RequestParams
|
3414
2994
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
3415
2995
|
attr_accessor :interval
|
3416
|
-
|
3417
2996
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
3418
2997
|
attr_accessor :interval_count
|
3419
2998
|
|
@@ -3424,10 +3003,8 @@ module Stripe
|
|
3424
3003
|
end
|
3425
3004
|
# Time span for the redeemed discount.
|
3426
3005
|
attr_accessor :duration
|
3427
|
-
|
3428
3006
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
3429
3007
|
attr_accessor :timestamp
|
3430
|
-
|
3431
3008
|
# The type of calculation made to determine when the discount ends.
|
3432
3009
|
attr_accessor :type
|
3433
3010
|
|
@@ -3439,13 +3016,10 @@ module Stripe
|
|
3439
3016
|
end
|
3440
3017
|
# ID of the coupon to create a new discount for.
|
3441
3018
|
attr_accessor :coupon
|
3442
|
-
|
3443
3019
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
3444
3020
|
attr_accessor :discount
|
3445
|
-
|
3446
3021
|
# Details to determine how long the discount should be applied for.
|
3447
3022
|
attr_accessor :discount_end
|
3448
|
-
|
3449
3023
|
# ID of the promotion code to create a new discount for.
|
3450
3024
|
attr_accessor :promotion_code
|
3451
3025
|
|
@@ -3461,7 +3035,6 @@ module Stripe
|
|
3461
3035
|
class Recurring < Stripe::RequestParams
|
3462
3036
|
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
3463
3037
|
attr_accessor :interval
|
3464
|
-
|
3465
3038
|
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
|
3466
3039
|
attr_accessor :interval_count
|
3467
3040
|
|
@@ -3472,19 +3045,14 @@ module Stripe
|
|
3472
3045
|
end
|
3473
3046
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
3474
3047
|
attr_accessor :currency
|
3475
|
-
|
3476
3048
|
# The ID of the product that this price will belong to.
|
3477
3049
|
attr_accessor :product
|
3478
|
-
|
3479
3050
|
# The recurring components of a price such as `interval` and `interval_count`.
|
3480
3051
|
attr_accessor :recurring
|
3481
|
-
|
3482
3052
|
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
3483
3053
|
attr_accessor :tax_behavior
|
3484
|
-
|
3485
3054
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
3486
3055
|
attr_accessor :unit_amount
|
3487
|
-
|
3488
3056
|
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
3489
3057
|
attr_accessor :unit_amount_decimal
|
3490
3058
|
|
@@ -3506,34 +3074,24 @@ module Stripe
|
|
3506
3074
|
end
|
3507
3075
|
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
|
3508
3076
|
attr_accessor :billing_thresholds
|
3509
|
-
|
3510
3077
|
# Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
|
3511
3078
|
attr_accessor :clear_usage
|
3512
|
-
|
3513
3079
|
# A flag that, if set to `true`, will delete the specified item.
|
3514
3080
|
attr_accessor :deleted
|
3515
|
-
|
3516
3081
|
# The coupons to redeem into discounts for the subscription item.
|
3517
3082
|
attr_accessor :discounts
|
3518
|
-
|
3519
3083
|
# Subscription item to update.
|
3520
3084
|
attr_accessor :id
|
3521
|
-
|
3522
3085
|
# 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`.
|
3523
3086
|
attr_accessor :metadata
|
3524
|
-
|
3525
3087
|
# Plan ID for this item, as a string.
|
3526
3088
|
attr_accessor :plan
|
3527
|
-
|
3528
3089
|
# The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
|
3529
3090
|
attr_accessor :price
|
3530
|
-
|
3531
3091
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
3532
3092
|
attr_accessor :price_data
|
3533
|
-
|
3534
3093
|
# Quantity for this item.
|
3535
3094
|
attr_accessor :quantity
|
3536
|
-
|
3537
3095
|
# 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.
|
3538
3096
|
attr_accessor :tax_rates
|
3539
3097
|
|
@@ -3574,85 +3132,58 @@ module Stripe
|
|
3574
3132
|
end
|
3575
3133
|
# Settings for automatic tax lookup for this invoice preview.
|
3576
3134
|
attr_accessor :automatic_tax
|
3577
|
-
|
3578
3135
|
# The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
|
3579
3136
|
attr_accessor :coupon
|
3580
|
-
|
3581
3137
|
# The currency to preview this invoice in. Defaults to that of `customer` if not specified.
|
3582
3138
|
attr_accessor :currency
|
3583
|
-
|
3584
3139
|
# 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.
|
3585
3140
|
attr_accessor :customer
|
3586
|
-
|
3587
3141
|
# 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.
|
3588
3142
|
attr_accessor :customer_details
|
3589
|
-
|
3590
3143
|
# 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.
|
3591
3144
|
attr_accessor :discounts
|
3592
|
-
|
3593
3145
|
# Specifies which fields in the response should be expanded.
|
3594
3146
|
attr_accessor :expand
|
3595
|
-
|
3596
3147
|
# List of invoice items to add or update in the upcoming invoice preview (up to 250).
|
3597
3148
|
attr_accessor :invoice_items
|
3598
|
-
|
3599
3149
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
3600
3150
|
attr_accessor :issuer
|
3601
|
-
|
3602
3151
|
# The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
|
3603
3152
|
attr_accessor :on_behalf_of
|
3604
|
-
|
3605
3153
|
# Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.
|
3606
3154
|
attr_accessor :preview_mode
|
3607
|
-
|
3608
3155
|
# The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.
|
3609
3156
|
attr_accessor :schedule
|
3610
|
-
|
3611
3157
|
# The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.
|
3612
3158
|
attr_accessor :schedule_details
|
3613
|
-
|
3614
3159
|
# The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.
|
3615
3160
|
attr_accessor :subscription
|
3616
|
-
|
3617
3161
|
# For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead.
|
3618
3162
|
attr_accessor :subscription_billing_cycle_anchor
|
3619
|
-
|
3620
3163
|
# A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead.
|
3621
3164
|
attr_accessor :subscription_cancel_at
|
3622
|
-
|
3623
3165
|
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.
|
3624
3166
|
attr_accessor :subscription_cancel_at_period_end
|
3625
|
-
|
3626
3167
|
# This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead.
|
3627
3168
|
attr_accessor :subscription_cancel_now
|
3628
|
-
|
3629
3169
|
# If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead.
|
3630
3170
|
attr_accessor :subscription_default_tax_rates
|
3631
|
-
|
3632
3171
|
# The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.
|
3633
3172
|
attr_accessor :subscription_details
|
3634
|
-
|
3635
3173
|
# A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead.
|
3636
3174
|
attr_accessor :subscription_items
|
3637
|
-
|
3638
3175
|
# The pre-billing to apply to the subscription as a preview. This field has been deprecated and will be removed in a future API version. Use `subscription_details.prebilling` instead.
|
3639
3176
|
attr_accessor :subscription_prebilling
|
3640
|
-
|
3641
3177
|
# Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead.
|
3642
3178
|
attr_accessor :subscription_proration_behavior
|
3643
|
-
|
3644
3179
|
# If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead.
|
3645
3180
|
attr_accessor :subscription_proration_date
|
3646
|
-
|
3647
3181
|
# For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead.
|
3648
3182
|
attr_accessor :subscription_resume_at
|
3649
|
-
|
3650
3183
|
# Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead.
|
3651
3184
|
attr_accessor :subscription_start_date
|
3652
|
-
|
3653
3185
|
# If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead.
|
3654
3186
|
attr_accessor :subscription_trial_end
|
3655
|
-
|
3656
3187
|
# Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
|
3657
3188
|
attr_accessor :subscription_trial_from_plan
|
3658
3189
|
|
@@ -3724,7 +3255,6 @@ module Stripe
|
|
3724
3255
|
class Duration < Stripe::RequestParams
|
3725
3256
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
3726
3257
|
attr_accessor :interval
|
3727
|
-
|
3728
3258
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
3729
3259
|
attr_accessor :interval_count
|
3730
3260
|
|
@@ -3735,10 +3265,8 @@ module Stripe
|
|
3735
3265
|
end
|
3736
3266
|
# Time span for the redeemed discount.
|
3737
3267
|
attr_accessor :duration
|
3738
|
-
|
3739
3268
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
3740
3269
|
attr_accessor :timestamp
|
3741
|
-
|
3742
3270
|
# The type of calculation made to determine when the discount ends.
|
3743
3271
|
attr_accessor :type
|
3744
3272
|
|
@@ -3750,13 +3278,10 @@ module Stripe
|
|
3750
3278
|
end
|
3751
3279
|
# ID of the coupon to create a new discount for.
|
3752
3280
|
attr_accessor :coupon
|
3753
|
-
|
3754
3281
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
3755
3282
|
attr_accessor :discount
|
3756
|
-
|
3757
3283
|
# Details to determine how long the discount should be applied for.
|
3758
3284
|
attr_accessor :discount_end
|
3759
|
-
|
3760
3285
|
# ID of the promotion code to create a new discount for.
|
3761
3286
|
attr_accessor :promotion_code
|
3762
3287
|
|
@@ -3771,7 +3296,6 @@ module Stripe
|
|
3771
3296
|
class Period < Stripe::RequestParams
|
3772
3297
|
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
|
3773
3298
|
attr_accessor :end
|
3774
|
-
|
3775
3299
|
# The start of the period. This value is inclusive.
|
3776
3300
|
attr_accessor :start
|
3777
3301
|
|
@@ -3785,16 +3309,12 @@ module Stripe
|
|
3785
3309
|
class ProductData < Stripe::RequestParams
|
3786
3310
|
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
|
3787
3311
|
attr_accessor :description
|
3788
|
-
|
3789
3312
|
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
|
3790
3313
|
attr_accessor :images
|
3791
|
-
|
3792
3314
|
# 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`.
|
3793
3315
|
attr_accessor :metadata
|
3794
|
-
|
3795
3316
|
# The product's name, meant to be displayable to the customer.
|
3796
3317
|
attr_accessor :name
|
3797
|
-
|
3798
3318
|
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
|
3799
3319
|
attr_accessor :tax_code
|
3800
3320
|
|
@@ -3808,19 +3328,14 @@ module Stripe
|
|
3808
3328
|
end
|
3809
3329
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
3810
3330
|
attr_accessor :currency
|
3811
|
-
|
3812
3331
|
# The ID of the product that this price will belong to. One of `product` or `product_data` is required.
|
3813
3332
|
attr_accessor :product
|
3814
|
-
|
3815
3333
|
# Data used to generate a new product object inline. One of `product` or `product_data` is required.
|
3816
3334
|
attr_accessor :product_data
|
3817
|
-
|
3818
3335
|
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
3819
3336
|
attr_accessor :tax_behavior
|
3820
|
-
|
3821
3337
|
# A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
|
3822
3338
|
attr_accessor :unit_amount
|
3823
|
-
|
3824
3339
|
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
3825
3340
|
attr_accessor :unit_amount_decimal
|
3826
3341
|
|
@@ -3845,25 +3360,18 @@ module Stripe
|
|
3845
3360
|
class TaxRateData < Stripe::RequestParams
|
3846
3361
|
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
3847
3362
|
attr_accessor :country
|
3848
|
-
|
3849
3363
|
# An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
|
3850
3364
|
attr_accessor :description
|
3851
|
-
|
3852
3365
|
# The display name of the tax rate, which will be shown to users.
|
3853
3366
|
attr_accessor :display_name
|
3854
|
-
|
3855
3367
|
# This specifies if the tax rate is inclusive or exclusive.
|
3856
3368
|
attr_accessor :inclusive
|
3857
|
-
|
3858
3369
|
# The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
|
3859
3370
|
attr_accessor :jurisdiction
|
3860
|
-
|
3861
3371
|
# The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.
|
3862
3372
|
attr_accessor :percentage
|
3863
|
-
|
3864
3373
|
# [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.
|
3865
3374
|
attr_accessor :state
|
3866
|
-
|
3867
3375
|
# The high-level tax type, such as `vat` or `sales_tax`.
|
3868
3376
|
attr_accessor :tax_type
|
3869
3377
|
|
@@ -3889,12 +3397,10 @@ module Stripe
|
|
3889
3397
|
end
|
3890
3398
|
# The amount, in cents (or local equivalent), of the tax.
|
3891
3399
|
attr_accessor :amount
|
3892
|
-
|
3893
3400
|
# Data to find or create a TaxRate object.
|
3894
3401
|
#
|
3895
3402
|
# Stripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.
|
3896
3403
|
attr_accessor :tax_rate_data
|
3897
|
-
|
3898
3404
|
# The amount on which tax is calculated, in cents (or local equivalent).
|
3899
3405
|
attr_accessor :taxable_amount
|
3900
3406
|
|
@@ -3906,40 +3412,28 @@ module Stripe
|
|
3906
3412
|
end
|
3907
3413
|
# The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
|
3908
3414
|
attr_accessor :amount
|
3909
|
-
|
3910
3415
|
# An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
|
3911
3416
|
attr_accessor :description
|
3912
|
-
|
3913
3417
|
# Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.
|
3914
3418
|
attr_accessor :discountable
|
3915
|
-
|
3916
3419
|
# The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
|
3917
3420
|
attr_accessor :discounts
|
3918
|
-
|
3919
3421
|
# ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created.
|
3920
3422
|
attr_accessor :invoice_item
|
3921
|
-
|
3922
3423
|
# 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.
|
3923
3424
|
attr_accessor :margins
|
3924
|
-
|
3925
3425
|
# 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`.
|
3926
3426
|
attr_accessor :metadata
|
3927
|
-
|
3928
3427
|
# 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.
|
3929
3428
|
attr_accessor :period
|
3930
|
-
|
3931
3429
|
# The ID of the price object. One of `price` or `price_data` is required.
|
3932
3430
|
attr_accessor :price
|
3933
|
-
|
3934
3431
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
3935
3432
|
attr_accessor :price_data
|
3936
|
-
|
3937
3433
|
# Non-negative integer. The quantity of units for the line item.
|
3938
3434
|
attr_accessor :quantity
|
3939
|
-
|
3940
3435
|
# A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
|
3941
3436
|
attr_accessor :tax_amounts
|
3942
|
-
|
3943
3437
|
# The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.
|
3944
3438
|
attr_accessor :tax_rates
|
3945
3439
|
|
@@ -3975,10 +3469,8 @@ module Stripe
|
|
3975
3469
|
end
|
3976
3470
|
# Specifies which fields in the response should be expanded.
|
3977
3471
|
attr_accessor :expand
|
3978
|
-
|
3979
3472
|
# 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`.
|
3980
3473
|
attr_accessor :invoice_metadata
|
3981
|
-
|
3982
3474
|
# The line items to add.
|
3983
3475
|
attr_accessor :lines
|
3984
3476
|
|
@@ -3993,19 +3485,14 @@ module Stripe
|
|
3993
3485
|
class PaymentRecordData < Stripe::RequestParams
|
3994
3486
|
# The amount that was paid out of band.
|
3995
3487
|
attr_accessor :amount
|
3996
|
-
|
3997
3488
|
# The currency that was paid out of band.
|
3998
3489
|
attr_accessor :currency
|
3999
|
-
|
4000
3490
|
# 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`.
|
4001
3491
|
attr_accessor :metadata
|
4002
|
-
|
4003
3492
|
# The type of money movement for this out of band payment record.
|
4004
3493
|
attr_accessor :money_movement_type
|
4005
|
-
|
4006
3494
|
# The timestamp when this out of band payment was paid.
|
4007
3495
|
attr_accessor :paid_at
|
4008
|
-
|
4009
3496
|
# The reference for this out of band payment record.
|
4010
3497
|
attr_accessor :payment_reference
|
4011
3498
|
|
@@ -4027,16 +3514,12 @@ module Stripe
|
|
4027
3514
|
end
|
4028
3515
|
# The portion of the `amount` on the PaymentIntent or out of band payment to apply to this invoice. It defaults to the entire amount.
|
4029
3516
|
attr_accessor :amount_requested
|
4030
|
-
|
4031
3517
|
# Specifies which fields in the response should be expanded.
|
4032
3518
|
attr_accessor :expand
|
4033
|
-
|
4034
3519
|
# The ID of the PaymentIntent to attach to the invoice.
|
4035
3520
|
attr_accessor :payment_intent
|
4036
|
-
|
4037
3521
|
# The ID of the PaymentRecord to detach from the invoice.
|
4038
3522
|
attr_accessor :payment_record
|
4039
|
-
|
4040
3523
|
# The PaymentRecord data for attaching an out of band payment to the invoice.
|
4041
3524
|
attr_accessor :payment_record_data
|
4042
3525
|
|
@@ -4058,10 +3541,8 @@ module Stripe
|
|
4058
3541
|
class AttachPaymentIntentParams < Stripe::RequestParams
|
4059
3542
|
# The portion of the PaymentIntent’s `amount` that should be applied to thisinvoice. Defaults to the entire amount.
|
4060
3543
|
attr_accessor :amount_requested
|
4061
|
-
|
4062
3544
|
# Specifies which fields in the response should be expanded.
|
4063
3545
|
attr_accessor :expand
|
4064
|
-
|
4065
3546
|
# The ID of the PaymentIntent to attach to the invoice.
|
4066
3547
|
attr_accessor :payment_intent
|
4067
3548
|
|
@@ -4075,7 +3556,6 @@ module Stripe
|
|
4075
3556
|
class FinalizeInvoiceParams < Stripe::RequestParams
|
4076
3557
|
# 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.
|
4077
3558
|
attr_accessor :auto_advance
|
4078
|
-
|
4079
3559
|
# Specifies which fields in the response should be expanded.
|
4080
3560
|
attr_accessor :expand
|
4081
3561
|
|
@@ -4097,24 +3577,18 @@ module Stripe
|
|
4097
3577
|
class PayParams < Stripe::RequestParams
|
4098
3578
|
# Specifies which fields in the response should be expanded.
|
4099
3579
|
attr_accessor :expand
|
4100
|
-
|
4101
3580
|
# In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due.
|
4102
3581
|
#
|
4103
3582
|
# Passing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to `false`.
|
4104
3583
|
attr_accessor :forgive
|
4105
|
-
|
4106
3584
|
# ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice's default_payment_method or default_source, if set.
|
4107
3585
|
attr_accessor :mandate
|
4108
|
-
|
4109
3586
|
# Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session).
|
4110
3587
|
attr_accessor :off_session
|
4111
|
-
|
4112
3588
|
# Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`.
|
4113
3589
|
attr_accessor :paid_out_of_band
|
4114
|
-
|
4115
3590
|
# A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid.
|
4116
3591
|
attr_accessor :payment_method
|
4117
|
-
|
4118
3592
|
# A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid.
|
4119
3593
|
attr_accessor :source
|
4120
3594
|
|
@@ -4141,7 +3615,6 @@ module Stripe
|
|
4141
3615
|
class Line < Stripe::RequestParams
|
4142
3616
|
# Either `delete` or `unassign`. Deleted line items are permanently deleted. Unassigned line items can be reassigned to an invoice.
|
4143
3617
|
attr_accessor :behavior
|
4144
|
-
|
4145
3618
|
# ID of an existing line item to remove from this invoice.
|
4146
3619
|
attr_accessor :id
|
4147
3620
|
|
@@ -4152,10 +3625,8 @@ module Stripe
|
|
4152
3625
|
end
|
4153
3626
|
# Specifies which fields in the response should be expanded.
|
4154
3627
|
attr_accessor :expand
|
4155
|
-
|
4156
3628
|
# 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`.
|
4157
3629
|
attr_accessor :invoice_metadata
|
4158
|
-
|
4159
3630
|
# The line items to remove.
|
4160
3631
|
attr_accessor :lines
|
4161
3632
|
|
@@ -4182,7 +3653,6 @@ module Stripe
|
|
4182
3653
|
class Duration < Stripe::RequestParams
|
4183
3654
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
4184
3655
|
attr_accessor :interval
|
4185
|
-
|
4186
3656
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
4187
3657
|
attr_accessor :interval_count
|
4188
3658
|
|
@@ -4193,10 +3663,8 @@ module Stripe
|
|
4193
3663
|
end
|
4194
3664
|
# Time span for the redeemed discount.
|
4195
3665
|
attr_accessor :duration
|
4196
|
-
|
4197
3666
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
4198
3667
|
attr_accessor :timestamp
|
4199
|
-
|
4200
3668
|
# The type of calculation made to determine when the discount ends.
|
4201
3669
|
attr_accessor :type
|
4202
3670
|
|
@@ -4208,13 +3676,10 @@ module Stripe
|
|
4208
3676
|
end
|
4209
3677
|
# ID of the coupon to create a new discount for.
|
4210
3678
|
attr_accessor :coupon
|
4211
|
-
|
4212
3679
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
4213
3680
|
attr_accessor :discount
|
4214
|
-
|
4215
3681
|
# Details to determine how long the discount should be applied for.
|
4216
3682
|
attr_accessor :discount_end
|
4217
|
-
|
4218
3683
|
# ID of the promotion code to create a new discount for.
|
4219
3684
|
attr_accessor :promotion_code
|
4220
3685
|
|
@@ -4229,7 +3694,6 @@ module Stripe
|
|
4229
3694
|
class Period < Stripe::RequestParams
|
4230
3695
|
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
|
4231
3696
|
attr_accessor :end
|
4232
|
-
|
4233
3697
|
# The start of the period. This value is inclusive.
|
4234
3698
|
attr_accessor :start
|
4235
3699
|
|
@@ -4243,16 +3707,12 @@ module Stripe
|
|
4243
3707
|
class ProductData < Stripe::RequestParams
|
4244
3708
|
# The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
|
4245
3709
|
attr_accessor :description
|
4246
|
-
|
4247
3710
|
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
|
4248
3711
|
attr_accessor :images
|
4249
|
-
|
4250
3712
|
# 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`.
|
4251
3713
|
attr_accessor :metadata
|
4252
|
-
|
4253
3714
|
# The product's name, meant to be displayable to the customer.
|
4254
3715
|
attr_accessor :name
|
4255
|
-
|
4256
3716
|
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
|
4257
3717
|
attr_accessor :tax_code
|
4258
3718
|
|
@@ -4266,19 +3726,14 @@ module Stripe
|
|
4266
3726
|
end
|
4267
3727
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
4268
3728
|
attr_accessor :currency
|
4269
|
-
|
4270
3729
|
# The ID of the product that this price will belong to. One of `product` or `product_data` is required.
|
4271
3730
|
attr_accessor :product
|
4272
|
-
|
4273
3731
|
# Data used to generate a new product object inline. One of `product` or `product_data` is required.
|
4274
3732
|
attr_accessor :product_data
|
4275
|
-
|
4276
3733
|
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
4277
3734
|
attr_accessor :tax_behavior
|
4278
|
-
|
4279
3735
|
# A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
|
4280
3736
|
attr_accessor :unit_amount
|
4281
|
-
|
4282
3737
|
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
4283
3738
|
attr_accessor :unit_amount_decimal
|
4284
3739
|
|
@@ -4303,25 +3758,18 @@ module Stripe
|
|
4303
3758
|
class TaxRateData < Stripe::RequestParams
|
4304
3759
|
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
4305
3760
|
attr_accessor :country
|
4306
|
-
|
4307
3761
|
# An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
|
4308
3762
|
attr_accessor :description
|
4309
|
-
|
4310
3763
|
# The display name of the tax rate, which will be shown to users.
|
4311
3764
|
attr_accessor :display_name
|
4312
|
-
|
4313
3765
|
# This specifies if the tax rate is inclusive or exclusive.
|
4314
3766
|
attr_accessor :inclusive
|
4315
|
-
|
4316
3767
|
# The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
|
4317
3768
|
attr_accessor :jurisdiction
|
4318
|
-
|
4319
3769
|
# The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.
|
4320
3770
|
attr_accessor :percentage
|
4321
|
-
|
4322
3771
|
# [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.
|
4323
3772
|
attr_accessor :state
|
4324
|
-
|
4325
3773
|
# The high-level tax type, such as `vat` or `sales_tax`.
|
4326
3774
|
attr_accessor :tax_type
|
4327
3775
|
|
@@ -4347,12 +3795,10 @@ module Stripe
|
|
4347
3795
|
end
|
4348
3796
|
# The amount, in cents (or local equivalent), of the tax.
|
4349
3797
|
attr_accessor :amount
|
4350
|
-
|
4351
3798
|
# Data to find or create a TaxRate object.
|
4352
3799
|
#
|
4353
3800
|
# Stripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.
|
4354
3801
|
attr_accessor :tax_rate_data
|
4355
|
-
|
4356
3802
|
# The amount on which tax is calculated, in cents (or local equivalent).
|
4357
3803
|
attr_accessor :taxable_amount
|
4358
3804
|
|
@@ -4364,40 +3810,28 @@ module Stripe
|
|
4364
3810
|
end
|
4365
3811
|
# The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
|
4366
3812
|
attr_accessor :amount
|
4367
|
-
|
4368
3813
|
# An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
|
4369
3814
|
attr_accessor :description
|
4370
|
-
|
4371
3815
|
# Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.
|
4372
3816
|
attr_accessor :discountable
|
4373
|
-
|
4374
3817
|
# The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
|
4375
3818
|
attr_accessor :discounts
|
4376
|
-
|
4377
3819
|
# ID of an existing line item on the invoice.
|
4378
3820
|
attr_accessor :id
|
4379
|
-
|
4380
3821
|
# 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.
|
4381
3822
|
attr_accessor :margins
|
4382
|
-
|
4383
3823
|
# 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.
|
4384
3824
|
attr_accessor :metadata
|
4385
|
-
|
4386
3825
|
# 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.
|
4387
3826
|
attr_accessor :period
|
4388
|
-
|
4389
3827
|
# The ID of the price object. One of `price` or `price_data` is required.
|
4390
3828
|
attr_accessor :price
|
4391
|
-
|
4392
3829
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
4393
3830
|
attr_accessor :price_data
|
4394
|
-
|
4395
3831
|
# Non-negative integer. The quantity of units for the line item.
|
4396
3832
|
attr_accessor :quantity
|
4397
|
-
|
4398
3833
|
# A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
|
4399
3834
|
attr_accessor :tax_amounts
|
4400
|
-
|
4401
3835
|
# The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.
|
4402
3836
|
attr_accessor :tax_rates
|
4403
3837
|
|
@@ -4433,10 +3867,8 @@ module Stripe
|
|
4433
3867
|
end
|
4434
3868
|
# Specifies which fields in the response should be expanded.
|
4435
3869
|
attr_accessor :expand
|
4436
|
-
|
4437
3870
|
# 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.
|
4438
3871
|
attr_accessor :invoice_metadata
|
4439
|
-
|
4440
3872
|
# The line items to update.
|
4441
3873
|
attr_accessor :lines
|
4442
3874
|
|
@@ -4461,7 +3893,6 @@ module Stripe
|
|
4461
3893
|
class Liability < Stripe::RequestParams
|
4462
3894
|
# The connected account being referenced when `type` is `account`.
|
4463
3895
|
attr_accessor :account
|
4464
|
-
|
4465
3896
|
# Type of the account referenced in the request.
|
4466
3897
|
attr_accessor :type
|
4467
3898
|
|
@@ -4472,7 +3903,6 @@ module Stripe
|
|
4472
3903
|
end
|
4473
3904
|
# Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
|
4474
3905
|
attr_accessor :enabled
|
4475
|
-
|
4476
3906
|
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
|
4477
3907
|
attr_accessor :liability
|
4478
3908
|
|
@@ -4486,19 +3916,14 @@ module Stripe
|
|
4486
3916
|
class Address < Stripe::RequestParams
|
4487
3917
|
# City, district, suburb, town, or village.
|
4488
3918
|
attr_accessor :city
|
4489
|
-
|
4490
3919
|
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
4491
3920
|
attr_accessor :country
|
4492
|
-
|
4493
3921
|
# Address line 1 (e.g., street, PO Box, or company name).
|
4494
3922
|
attr_accessor :line1
|
4495
|
-
|
4496
3923
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
4497
3924
|
attr_accessor :line2
|
4498
|
-
|
4499
3925
|
# ZIP or postal code.
|
4500
3926
|
attr_accessor :postal_code
|
4501
|
-
|
4502
3927
|
# State, county, province, or region.
|
4503
3928
|
attr_accessor :state
|
4504
3929
|
|
@@ -4523,19 +3948,14 @@ module Stripe
|
|
4523
3948
|
class Address < Stripe::RequestParams
|
4524
3949
|
# City, district, suburb, town, or village.
|
4525
3950
|
attr_accessor :city
|
4526
|
-
|
4527
3951
|
# A freeform text field for the country. However, in order to activate some tax features, the format should be a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
4528
3952
|
attr_accessor :country
|
4529
|
-
|
4530
3953
|
# Address line 1 (e.g., street, PO Box, or company name).
|
4531
3954
|
attr_accessor :line1
|
4532
|
-
|
4533
3955
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
4534
3956
|
attr_accessor :line2
|
4535
|
-
|
4536
3957
|
# ZIP or postal code.
|
4537
3958
|
attr_accessor :postal_code
|
4538
|
-
|
4539
3959
|
# State, county, province, or region.
|
4540
3960
|
attr_accessor :state
|
4541
3961
|
|
@@ -4557,10 +3977,8 @@ module Stripe
|
|
4557
3977
|
end
|
4558
3978
|
# Customer shipping address.
|
4559
3979
|
attr_accessor :address
|
4560
|
-
|
4561
3980
|
# Customer name.
|
4562
3981
|
attr_accessor :name
|
4563
|
-
|
4564
3982
|
# Customer phone (including extension).
|
4565
3983
|
attr_accessor :phone
|
4566
3984
|
|
@@ -4581,9 +3999,8 @@ module Stripe
|
|
4581
3999
|
end
|
4582
4000
|
|
4583
4001
|
class TaxId < Stripe::RequestParams
|
4584
|
-
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
|
4002
|
+
# 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`
|
4585
4003
|
attr_accessor :type
|
4586
|
-
|
4587
4004
|
# Value of the tax ID.
|
4588
4005
|
attr_accessor :value
|
4589
4006
|
|
@@ -4594,16 +4011,12 @@ module Stripe
|
|
4594
4011
|
end
|
4595
4012
|
# The customer's address.
|
4596
4013
|
attr_accessor :address
|
4597
|
-
|
4598
4014
|
# The customer's shipping information. Appears on invoices emailed to this customer.
|
4599
4015
|
attr_accessor :shipping
|
4600
|
-
|
4601
4016
|
# Tax details about the customer.
|
4602
4017
|
attr_accessor :tax
|
4603
|
-
|
4604
4018
|
# The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
|
4605
4019
|
attr_accessor :tax_exempt
|
4606
|
-
|
4607
4020
|
# The customer's tax IDs.
|
4608
4021
|
attr_accessor :tax_ids
|
4609
4022
|
|
@@ -4621,7 +4034,6 @@ module Stripe
|
|
4621
4034
|
class Duration < Stripe::RequestParams
|
4622
4035
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
4623
4036
|
attr_accessor :interval
|
4624
|
-
|
4625
4037
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
4626
4038
|
attr_accessor :interval_count
|
4627
4039
|
|
@@ -4632,10 +4044,8 @@ module Stripe
|
|
4632
4044
|
end
|
4633
4045
|
# Time span for the redeemed discount.
|
4634
4046
|
attr_accessor :duration
|
4635
|
-
|
4636
4047
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
4637
4048
|
attr_accessor :timestamp
|
4638
|
-
|
4639
4049
|
# The type of calculation made to determine when the discount ends.
|
4640
4050
|
attr_accessor :type
|
4641
4051
|
|
@@ -4647,13 +4057,10 @@ module Stripe
|
|
4647
4057
|
end
|
4648
4058
|
# ID of the coupon to create a new discount for.
|
4649
4059
|
attr_accessor :coupon
|
4650
|
-
|
4651
4060
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
4652
4061
|
attr_accessor :discount
|
4653
|
-
|
4654
4062
|
# Details to determine how long the discount should be applied for.
|
4655
4063
|
attr_accessor :discount_end
|
4656
|
-
|
4657
4064
|
# ID of the promotion code to create a new discount for.
|
4658
4065
|
attr_accessor :promotion_code
|
4659
4066
|
|
@@ -4671,7 +4078,6 @@ module Stripe
|
|
4671
4078
|
class Duration < Stripe::RequestParams
|
4672
4079
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
4673
4080
|
attr_accessor :interval
|
4674
|
-
|
4675
4081
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
4676
4082
|
attr_accessor :interval_count
|
4677
4083
|
|
@@ -4682,10 +4088,8 @@ module Stripe
|
|
4682
4088
|
end
|
4683
4089
|
# Time span for the redeemed discount.
|
4684
4090
|
attr_accessor :duration
|
4685
|
-
|
4686
4091
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
4687
4092
|
attr_accessor :timestamp
|
4688
|
-
|
4689
4093
|
# The type of calculation made to determine when the discount ends.
|
4690
4094
|
attr_accessor :type
|
4691
4095
|
|
@@ -4697,13 +4101,10 @@ module Stripe
|
|
4697
4101
|
end
|
4698
4102
|
# ID of the coupon to create a new discount for.
|
4699
4103
|
attr_accessor :coupon
|
4700
|
-
|
4701
4104
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
4702
4105
|
attr_accessor :discount
|
4703
|
-
|
4704
4106
|
# Details to determine how long the discount should be applied for.
|
4705
4107
|
attr_accessor :discount_end
|
4706
|
-
|
4707
4108
|
# ID of the promotion code to create a new discount for.
|
4708
4109
|
attr_accessor :promotion_code
|
4709
4110
|
|
@@ -4718,7 +4119,6 @@ module Stripe
|
|
4718
4119
|
class Period < Stripe::RequestParams
|
4719
4120
|
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
|
4720
4121
|
attr_accessor :end
|
4721
|
-
|
4722
4122
|
# The start of the period. This value is inclusive.
|
4723
4123
|
attr_accessor :start
|
4724
4124
|
|
@@ -4731,16 +4131,12 @@ module Stripe
|
|
4731
4131
|
class PriceData < Stripe::RequestParams
|
4732
4132
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
4733
4133
|
attr_accessor :currency
|
4734
|
-
|
4735
4134
|
# The ID of the product that this price will belong to.
|
4736
4135
|
attr_accessor :product
|
4737
|
-
|
4738
4136
|
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
4739
4137
|
attr_accessor :tax_behavior
|
4740
|
-
|
4741
4138
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
4742
4139
|
attr_accessor :unit_amount
|
4743
|
-
|
4744
4140
|
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
4745
4141
|
attr_accessor :unit_amount_decimal
|
4746
4142
|
|
@@ -4760,49 +4156,34 @@ module Stripe
|
|
4760
4156
|
end
|
4761
4157
|
# The integer amount in cents (or local equivalent) of previewed invoice item.
|
4762
4158
|
attr_accessor :amount
|
4763
|
-
|
4764
4159
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Only applicable to new invoice items.
|
4765
4160
|
attr_accessor :currency
|
4766
|
-
|
4767
4161
|
# An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
|
4768
4162
|
attr_accessor :description
|
4769
|
-
|
4770
4163
|
# Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.
|
4771
4164
|
attr_accessor :discountable
|
4772
|
-
|
4773
4165
|
# The coupons to redeem into discounts for the invoice item in the preview.
|
4774
4166
|
attr_accessor :discounts
|
4775
|
-
|
4776
4167
|
# The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice.
|
4777
4168
|
attr_accessor :invoiceitem
|
4778
|
-
|
4779
4169
|
# 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`.
|
4780
4170
|
attr_accessor :metadata
|
4781
|
-
|
4782
4171
|
# 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.
|
4783
4172
|
attr_accessor :period
|
4784
|
-
|
4785
4173
|
# The ID of the price object. One of `price` or `price_data` is required.
|
4786
4174
|
attr_accessor :price
|
4787
|
-
|
4788
4175
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
4789
4176
|
attr_accessor :price_data
|
4790
|
-
|
4791
4177
|
# Non-negative integer. The quantity of units for the invoice item.
|
4792
4178
|
attr_accessor :quantity
|
4793
|
-
|
4794
4179
|
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
4795
4180
|
attr_accessor :tax_behavior
|
4796
|
-
|
4797
4181
|
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
|
4798
4182
|
attr_accessor :tax_code
|
4799
|
-
|
4800
4183
|
# The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item.
|
4801
4184
|
attr_accessor :tax_rates
|
4802
|
-
|
4803
4185
|
# The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.
|
4804
4186
|
attr_accessor :unit_amount
|
4805
|
-
|
4806
4187
|
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
4807
4188
|
attr_accessor :unit_amount_decimal
|
4808
4189
|
|
@@ -4846,7 +4227,6 @@ module Stripe
|
|
4846
4227
|
class Issuer < Stripe::RequestParams
|
4847
4228
|
# The connected account being referenced when `type` is `account`.
|
4848
4229
|
attr_accessor :account
|
4849
|
-
|
4850
4230
|
# Type of the account referenced in the request.
|
4851
4231
|
attr_accessor :type
|
4852
4232
|
|
@@ -4871,7 +4251,6 @@ module Stripe
|
|
4871
4251
|
class Duration < Stripe::RequestParams
|
4872
4252
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
4873
4253
|
attr_accessor :interval
|
4874
|
-
|
4875
4254
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
4876
4255
|
attr_accessor :interval_count
|
4877
4256
|
|
@@ -4882,13 +4261,10 @@ module Stripe
|
|
4882
4261
|
end
|
4883
4262
|
# Use the `end` time of a given discount.
|
4884
4263
|
attr_accessor :discount_end
|
4885
|
-
|
4886
4264
|
# Time span for the amendment starting from the `amendment_start`.
|
4887
4265
|
attr_accessor :duration
|
4888
|
-
|
4889
4266
|
# A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.
|
4890
4267
|
attr_accessor :timestamp
|
4891
|
-
|
4892
4268
|
# Select one of three ways to pass the `amendment_end`.
|
4893
4269
|
attr_accessor :type
|
4894
4270
|
|
@@ -4920,13 +4296,10 @@ module Stripe
|
|
4920
4296
|
end
|
4921
4297
|
# Details of another amendment in the same array, immediately after which this amendment should begin.
|
4922
4298
|
attr_accessor :amendment_end
|
4923
|
-
|
4924
4299
|
# Use the `end` time of a given discount.
|
4925
4300
|
attr_accessor :discount_end
|
4926
|
-
|
4927
4301
|
# A precise Unix timestamp for the amendment to start.
|
4928
4302
|
attr_accessor :timestamp
|
4929
|
-
|
4930
4303
|
# Select one of three ways to pass the `amendment_start`.
|
4931
4304
|
attr_accessor :type
|
4932
4305
|
|
@@ -4950,16 +4323,12 @@ module Stripe
|
|
4950
4323
|
end
|
4951
4324
|
# The coupon code to redeem.
|
4952
4325
|
attr_accessor :coupon
|
4953
|
-
|
4954
4326
|
# An ID of an existing discount for a coupon that was already redeemed.
|
4955
4327
|
attr_accessor :discount
|
4956
|
-
|
4957
4328
|
# Details to determine how long the discount should be applied for.
|
4958
4329
|
attr_accessor :discount_end
|
4959
|
-
|
4960
4330
|
# 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.
|
4961
4331
|
attr_accessor :index
|
4962
|
-
|
4963
4332
|
# The promotion code to redeem.
|
4964
4333
|
attr_accessor :promotion_code
|
4965
4334
|
|
@@ -4981,10 +4350,8 @@ module Stripe
|
|
4981
4350
|
class Remove < Stripe::RequestParams
|
4982
4351
|
# The coupon code to remove from the `discounts` array.
|
4983
4352
|
attr_accessor :coupon
|
4984
|
-
|
4985
4353
|
# The ID of a discount to remove from the `discounts` array.
|
4986
4354
|
attr_accessor :discount
|
4987
|
-
|
4988
4355
|
# The ID of a promotion code to remove from the `discounts` array.
|
4989
4356
|
attr_accessor :promotion_code
|
4990
4357
|
|
@@ -4998,10 +4365,8 @@ module Stripe
|
|
4998
4365
|
class Set < Stripe::RequestParams
|
4999
4366
|
# The coupon code to replace the `discounts` array with.
|
5000
4367
|
attr_accessor :coupon
|
5001
|
-
|
5002
4368
|
# An ID of an existing discount to replace the `discounts` array with.
|
5003
4369
|
attr_accessor :discount
|
5004
|
-
|
5005
4370
|
# An ID of an existing promotion code to replace the `discounts` array with.
|
5006
4371
|
attr_accessor :promotion_code
|
5007
4372
|
|
@@ -5013,13 +4378,10 @@ module Stripe
|
|
5013
4378
|
end
|
5014
4379
|
# Details of the discount to add.
|
5015
4380
|
attr_accessor :add
|
5016
|
-
|
5017
4381
|
# Details of the discount to remove.
|
5018
4382
|
attr_accessor :remove
|
5019
|
-
|
5020
4383
|
# Details of the discount to replace the existing discounts with.
|
5021
4384
|
attr_accessor :set
|
5022
|
-
|
5023
4385
|
# Determines the type of discount action.
|
5024
4386
|
attr_accessor :type
|
5025
4387
|
|
@@ -5038,7 +4400,6 @@ module Stripe
|
|
5038
4400
|
class Duration < Stripe::RequestParams
|
5039
4401
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
5040
4402
|
attr_accessor :interval
|
5041
|
-
|
5042
4403
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
5043
4404
|
attr_accessor :interval_count
|
5044
4405
|
|
@@ -5049,10 +4410,8 @@ module Stripe
|
|
5049
4410
|
end
|
5050
4411
|
# Time span for the redeemed discount.
|
5051
4412
|
attr_accessor :duration
|
5052
|
-
|
5053
4413
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
5054
4414
|
attr_accessor :timestamp
|
5055
|
-
|
5056
4415
|
# The type of calculation made to determine when the discount ends.
|
5057
4416
|
attr_accessor :type
|
5058
4417
|
|
@@ -5064,13 +4423,10 @@ module Stripe
|
|
5064
4423
|
end
|
5065
4424
|
# ID of the coupon to create a new discount for.
|
5066
4425
|
attr_accessor :coupon
|
5067
|
-
|
5068
4426
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
5069
4427
|
attr_accessor :discount
|
5070
|
-
|
5071
4428
|
# Details to determine how long the discount should be applied for.
|
5072
4429
|
attr_accessor :discount_end
|
5073
|
-
|
5074
4430
|
# ID of the promotion code to create a new discount for.
|
5075
4431
|
attr_accessor :promotion_code
|
5076
4432
|
|
@@ -5085,7 +4441,6 @@ module Stripe
|
|
5085
4441
|
class Trial < Stripe::RequestParams
|
5086
4442
|
# 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.
|
5087
4443
|
attr_accessor :converts_to
|
5088
|
-
|
5089
4444
|
# Determines the type of trial for this item.
|
5090
4445
|
attr_accessor :type
|
5091
4446
|
|
@@ -5096,19 +4451,14 @@ module Stripe
|
|
5096
4451
|
end
|
5097
4452
|
# The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
|
5098
4453
|
attr_accessor :discounts
|
5099
|
-
|
5100
4454
|
# 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`.
|
5101
4455
|
attr_accessor :metadata
|
5102
|
-
|
5103
4456
|
# The ID of the price object.
|
5104
4457
|
attr_accessor :price
|
5105
|
-
|
5106
4458
|
# Quantity for this item.
|
5107
4459
|
attr_accessor :quantity
|
5108
|
-
|
5109
4460
|
# 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`.
|
5110
4461
|
attr_accessor :tax_rates
|
5111
|
-
|
5112
4462
|
# Options that configure the trial on the subscription item.
|
5113
4463
|
attr_accessor :trial
|
5114
4464
|
|
@@ -5144,7 +4494,6 @@ module Stripe
|
|
5144
4494
|
class Duration < Stripe::RequestParams
|
5145
4495
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
5146
4496
|
attr_accessor :interval
|
5147
|
-
|
5148
4497
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
5149
4498
|
attr_accessor :interval_count
|
5150
4499
|
|
@@ -5155,10 +4504,8 @@ module Stripe
|
|
5155
4504
|
end
|
5156
4505
|
# Time span for the redeemed discount.
|
5157
4506
|
attr_accessor :duration
|
5158
|
-
|
5159
4507
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
5160
4508
|
attr_accessor :timestamp
|
5161
|
-
|
5162
4509
|
# The type of calculation made to determine when the discount ends.
|
5163
4510
|
attr_accessor :type
|
5164
4511
|
|
@@ -5170,13 +4517,10 @@ module Stripe
|
|
5170
4517
|
end
|
5171
4518
|
# ID of the coupon to create a new discount for.
|
5172
4519
|
attr_accessor :coupon
|
5173
|
-
|
5174
4520
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
5175
4521
|
attr_accessor :discount
|
5176
|
-
|
5177
4522
|
# Details to determine how long the discount should be applied for.
|
5178
4523
|
attr_accessor :discount_end
|
5179
|
-
|
5180
4524
|
# ID of the promotion code to create a new discount for.
|
5181
4525
|
attr_accessor :promotion_code
|
5182
4526
|
|
@@ -5191,7 +4535,6 @@ module Stripe
|
|
5191
4535
|
class Trial < Stripe::RequestParams
|
5192
4536
|
# 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.
|
5193
4537
|
attr_accessor :converts_to
|
5194
|
-
|
5195
4538
|
# Determines the type of trial for this item.
|
5196
4539
|
attr_accessor :type
|
5197
4540
|
|
@@ -5202,19 +4545,14 @@ module Stripe
|
|
5202
4545
|
end
|
5203
4546
|
# 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`.
|
5204
4547
|
attr_accessor :discounts
|
5205
|
-
|
5206
4548
|
# 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`.
|
5207
4549
|
attr_accessor :metadata
|
5208
|
-
|
5209
4550
|
# The ID of the price object.
|
5210
4551
|
attr_accessor :price
|
5211
|
-
|
5212
4552
|
# 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`.
|
5213
4553
|
attr_accessor :quantity
|
5214
|
-
|
5215
4554
|
# 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`.
|
5216
4555
|
attr_accessor :tax_rates
|
5217
|
-
|
5218
4556
|
# 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`.
|
5219
4557
|
attr_accessor :trial
|
5220
4558
|
|
@@ -5236,13 +4574,10 @@ module Stripe
|
|
5236
4574
|
end
|
5237
4575
|
# 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.
|
5238
4576
|
attr_accessor :add
|
5239
|
-
|
5240
4577
|
# Details of the subscription item to remove.
|
5241
4578
|
attr_accessor :remove
|
5242
|
-
|
5243
4579
|
# 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.
|
5244
4580
|
attr_accessor :set
|
5245
|
-
|
5246
4581
|
# Determines the type of item action.
|
5247
4582
|
attr_accessor :type
|
5248
4583
|
|
@@ -5257,13 +4592,10 @@ module Stripe
|
|
5257
4592
|
class MetadataAction < Stripe::RequestParams
|
5258
4593
|
# Key-value pairs to add to schedule phase metadata. These values will merge with existing schedule phase metadata.
|
5259
4594
|
attr_accessor :add
|
5260
|
-
|
5261
4595
|
# Keys to remove from schedule phase metadata.
|
5262
4596
|
attr_accessor :remove
|
5263
|
-
|
5264
4597
|
# Key-value pairs to set as schedule phase metadata. Existing schedule phase metadata will be overwritten.
|
5265
4598
|
attr_accessor :set
|
5266
|
-
|
5267
4599
|
# Select one of three ways to update phase-level `metadata` on subscription schedules.
|
5268
4600
|
attr_accessor :type
|
5269
4601
|
|
@@ -5286,7 +4618,6 @@ module Stripe
|
|
5286
4618
|
end
|
5287
4619
|
# Details of the pause_collection behavior to apply to the amendment.
|
5288
4620
|
attr_accessor :set
|
5289
|
-
|
5290
4621
|
# Determines the type of the pause_collection amendment.
|
5291
4622
|
attr_accessor :type
|
5292
4623
|
|
@@ -5314,31 +4645,22 @@ module Stripe
|
|
5314
4645
|
end
|
5315
4646
|
# 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.
|
5316
4647
|
attr_accessor :amendment_end
|
5317
|
-
|
5318
4648
|
# Details to identify the earliest timestamp where the proposed change should take effect.
|
5319
4649
|
attr_accessor :amendment_start
|
5320
|
-
|
5321
4650
|
# 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.
|
5322
4651
|
attr_accessor :billing_cycle_anchor
|
5323
|
-
|
5324
4652
|
# Changes to the coupons being redeemed or discounts being applied during the amendment time span.
|
5325
4653
|
attr_accessor :discount_actions
|
5326
|
-
|
5327
4654
|
# Changes to the subscription items during the amendment time span.
|
5328
4655
|
attr_accessor :item_actions
|
5329
|
-
|
5330
4656
|
# Instructions for how to modify phase metadata
|
5331
4657
|
attr_accessor :metadata_actions
|
5332
|
-
|
5333
4658
|
# 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`.
|
5334
4659
|
attr_accessor :proration_behavior
|
5335
|
-
|
5336
4660
|
# Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
|
5337
4661
|
attr_accessor :set_pause_collection
|
5338
|
-
|
5339
4662
|
# Ends the subscription schedule early as dictated by either the accompanying amendment's start or end.
|
5340
4663
|
attr_accessor :set_schedule_end
|
5341
|
-
|
5342
4664
|
# Settings related to subscription trials.
|
5343
4665
|
attr_accessor :trial_settings
|
5344
4666
|
|
@@ -5374,7 +4696,6 @@ module Stripe
|
|
5374
4696
|
class Duration < Stripe::RequestParams
|
5375
4697
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
5376
4698
|
attr_accessor :interval
|
5377
|
-
|
5378
4699
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
5379
4700
|
attr_accessor :interval_count
|
5380
4701
|
|
@@ -5385,10 +4706,8 @@ module Stripe
|
|
5385
4706
|
end
|
5386
4707
|
# Time span for the redeemed discount.
|
5387
4708
|
attr_accessor :duration
|
5388
|
-
|
5389
4709
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
5390
4710
|
attr_accessor :timestamp
|
5391
|
-
|
5392
4711
|
# The type of calculation made to determine when the discount ends.
|
5393
4712
|
attr_accessor :type
|
5394
4713
|
|
@@ -5400,13 +4719,10 @@ module Stripe
|
|
5400
4719
|
end
|
5401
4720
|
# ID of the coupon to create a new discount for.
|
5402
4721
|
attr_accessor :coupon
|
5403
|
-
|
5404
4722
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
5405
4723
|
attr_accessor :discount
|
5406
|
-
|
5407
4724
|
# Details to determine how long the discount should be applied for.
|
5408
4725
|
attr_accessor :discount_end
|
5409
|
-
|
5410
4726
|
# ID of the promotion code to create a new discount for.
|
5411
4727
|
attr_accessor :promotion_code
|
5412
4728
|
|
@@ -5421,16 +4737,12 @@ module Stripe
|
|
5421
4737
|
class PriceData < Stripe::RequestParams
|
5422
4738
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
5423
4739
|
attr_accessor :currency
|
5424
|
-
|
5425
4740
|
# The ID of the product that this price will belong to.
|
5426
4741
|
attr_accessor :product
|
5427
|
-
|
5428
4742
|
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
5429
4743
|
attr_accessor :tax_behavior
|
5430
|
-
|
5431
4744
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
|
5432
4745
|
attr_accessor :unit_amount
|
5433
|
-
|
5434
4746
|
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
5435
4747
|
attr_accessor :unit_amount_decimal
|
5436
4748
|
|
@@ -5450,16 +4762,12 @@ module Stripe
|
|
5450
4762
|
end
|
5451
4763
|
# The coupons to redeem into discounts for the item.
|
5452
4764
|
attr_accessor :discounts
|
5453
|
-
|
5454
4765
|
# The ID of the price object. One of `price` or `price_data` is required.
|
5455
4766
|
attr_accessor :price
|
5456
|
-
|
5457
4767
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
5458
4768
|
attr_accessor :price_data
|
5459
|
-
|
5460
4769
|
# Quantity for this item. Defaults to 1.
|
5461
4770
|
attr_accessor :quantity
|
5462
|
-
|
5463
4771
|
# The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
|
5464
4772
|
attr_accessor :tax_rates
|
5465
4773
|
|
@@ -5482,7 +4790,6 @@ module Stripe
|
|
5482
4790
|
class Liability < Stripe::RequestParams
|
5483
4791
|
# The connected account being referenced when `type` is `account`.
|
5484
4792
|
attr_accessor :account
|
5485
|
-
|
5486
4793
|
# Type of the account referenced in the request.
|
5487
4794
|
attr_accessor :type
|
5488
4795
|
|
@@ -5493,7 +4800,6 @@ module Stripe
|
|
5493
4800
|
end
|
5494
4801
|
# Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
|
5495
4802
|
attr_accessor :enabled
|
5496
|
-
|
5497
4803
|
# The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
|
5498
4804
|
attr_accessor :liability
|
5499
4805
|
|
@@ -5506,7 +4812,6 @@ module Stripe
|
|
5506
4812
|
class BillingThresholds < Stripe::RequestParams
|
5507
4813
|
# Monetary threshold that triggers the subscription to advance to a new billing period
|
5508
4814
|
attr_accessor :amount_gte
|
5509
|
-
|
5510
4815
|
# Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
|
5511
4816
|
attr_accessor :reset_billing_cycle_anchor
|
5512
4817
|
|
@@ -5521,7 +4826,6 @@ module Stripe
|
|
5521
4826
|
class Duration < Stripe::RequestParams
|
5522
4827
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
5523
4828
|
attr_accessor :interval
|
5524
|
-
|
5525
4829
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
5526
4830
|
attr_accessor :interval_count
|
5527
4831
|
|
@@ -5532,10 +4836,8 @@ module Stripe
|
|
5532
4836
|
end
|
5533
4837
|
# Time span for the redeemed discount.
|
5534
4838
|
attr_accessor :duration
|
5535
|
-
|
5536
4839
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
5537
4840
|
attr_accessor :timestamp
|
5538
|
-
|
5539
4841
|
# The type of calculation made to determine when the discount ends.
|
5540
4842
|
attr_accessor :type
|
5541
4843
|
|
@@ -5547,13 +4849,10 @@ module Stripe
|
|
5547
4849
|
end
|
5548
4850
|
# ID of the coupon to create a new discount for.
|
5549
4851
|
attr_accessor :coupon
|
5550
|
-
|
5551
4852
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
5552
4853
|
attr_accessor :discount
|
5553
|
-
|
5554
4854
|
# Details to determine how long the discount should be applied for.
|
5555
4855
|
attr_accessor :discount_end
|
5556
|
-
|
5557
4856
|
# ID of the promotion code to create a new discount for.
|
5558
4857
|
attr_accessor :promotion_code
|
5559
4858
|
|
@@ -5569,7 +4868,6 @@ module Stripe
|
|
5569
4868
|
class Issuer < Stripe::RequestParams
|
5570
4869
|
# The connected account being referenced when `type` is `account`.
|
5571
4870
|
attr_accessor :account
|
5572
|
-
|
5573
4871
|
# Type of the account referenced in the request.
|
5574
4872
|
attr_accessor :type
|
5575
4873
|
|
@@ -5580,10 +4878,8 @@ module Stripe
|
|
5580
4878
|
end
|
5581
4879
|
# The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
|
5582
4880
|
attr_accessor :account_tax_ids
|
5583
|
-
|
5584
4881
|
# Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
|
5585
4882
|
attr_accessor :days_until_due
|
5586
|
-
|
5587
4883
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
5588
4884
|
attr_accessor :issuer
|
5589
4885
|
|
@@ -5609,7 +4905,6 @@ module Stripe
|
|
5609
4905
|
class Duration < Stripe::RequestParams
|
5610
4906
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
5611
4907
|
attr_accessor :interval
|
5612
|
-
|
5613
4908
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
5614
4909
|
attr_accessor :interval_count
|
5615
4910
|
|
@@ -5620,10 +4915,8 @@ module Stripe
|
|
5620
4915
|
end
|
5621
4916
|
# Time span for the redeemed discount.
|
5622
4917
|
attr_accessor :duration
|
5623
|
-
|
5624
4918
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
5625
4919
|
attr_accessor :timestamp
|
5626
|
-
|
5627
4920
|
# The type of calculation made to determine when the discount ends.
|
5628
4921
|
attr_accessor :type
|
5629
4922
|
|
@@ -5635,13 +4928,10 @@ module Stripe
|
|
5635
4928
|
end
|
5636
4929
|
# ID of the coupon to create a new discount for.
|
5637
4930
|
attr_accessor :coupon
|
5638
|
-
|
5639
4931
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
5640
4932
|
attr_accessor :discount
|
5641
|
-
|
5642
4933
|
# Details to determine how long the discount should be applied for.
|
5643
4934
|
attr_accessor :discount_end
|
5644
|
-
|
5645
4935
|
# ID of the promotion code to create a new discount for.
|
5646
4936
|
attr_accessor :promotion_code
|
5647
4937
|
|
@@ -5657,7 +4947,6 @@ module Stripe
|
|
5657
4947
|
class Recurring < Stripe::RequestParams
|
5658
4948
|
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
5659
4949
|
attr_accessor :interval
|
5660
|
-
|
5661
4950
|
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
|
5662
4951
|
attr_accessor :interval_count
|
5663
4952
|
|
@@ -5668,19 +4957,14 @@ module Stripe
|
|
5668
4957
|
end
|
5669
4958
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
5670
4959
|
attr_accessor :currency
|
5671
|
-
|
5672
4960
|
# The ID of the product that this price will belong to.
|
5673
4961
|
attr_accessor :product
|
5674
|
-
|
5675
4962
|
# The recurring components of a price such as `interval` and `interval_count`.
|
5676
4963
|
attr_accessor :recurring
|
5677
|
-
|
5678
4964
|
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
5679
4965
|
attr_accessor :tax_behavior
|
5680
|
-
|
5681
4966
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
5682
4967
|
attr_accessor :unit_amount
|
5683
|
-
|
5684
4968
|
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
5685
4969
|
attr_accessor :unit_amount_decimal
|
5686
4970
|
|
@@ -5704,7 +4988,6 @@ module Stripe
|
|
5704
4988
|
class Trial < Stripe::RequestParams
|
5705
4989
|
# 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.
|
5706
4990
|
attr_accessor :converts_to
|
5707
|
-
|
5708
4991
|
# Determines the type of trial for this item.
|
5709
4992
|
attr_accessor :type
|
5710
4993
|
|
@@ -5715,28 +4998,20 @@ module Stripe
|
|
5715
4998
|
end
|
5716
4999
|
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
|
5717
5000
|
attr_accessor :billing_thresholds
|
5718
|
-
|
5719
5001
|
# The coupons to redeem into discounts for the subscription item.
|
5720
5002
|
attr_accessor :discounts
|
5721
|
-
|
5722
5003
|
# 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`.
|
5723
5004
|
attr_accessor :metadata
|
5724
|
-
|
5725
5005
|
# The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
|
5726
5006
|
attr_accessor :plan
|
5727
|
-
|
5728
5007
|
# The ID of the price object.
|
5729
5008
|
attr_accessor :price
|
5730
|
-
|
5731
5009
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
|
5732
5010
|
attr_accessor :price_data
|
5733
|
-
|
5734
5011
|
# Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
|
5735
5012
|
attr_accessor :quantity
|
5736
|
-
|
5737
5013
|
# 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.
|
5738
5014
|
attr_accessor :tax_rates
|
5739
|
-
|
5740
5015
|
# Options that configure the trial on the subscription item.
|
5741
5016
|
attr_accessor :trial
|
5742
5017
|
|
@@ -5775,7 +5050,6 @@ module Stripe
|
|
5775
5050
|
class TransferData < Stripe::RequestParams
|
5776
5051
|
# A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
|
5777
5052
|
attr_accessor :amount_percent
|
5778
|
-
|
5779
5053
|
# ID of an existing, connected Stripe account.
|
5780
5054
|
attr_accessor :destination
|
5781
5055
|
|
@@ -5803,79 +5077,54 @@ module Stripe
|
|
5803
5077
|
end
|
5804
5078
|
# 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.
|
5805
5079
|
attr_accessor :add_invoice_items
|
5806
|
-
|
5807
5080
|
# 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).
|
5808
5081
|
attr_accessor :application_fee_percent
|
5809
|
-
|
5810
5082
|
# Automatic tax settings for this phase.
|
5811
5083
|
attr_accessor :automatic_tax
|
5812
|
-
|
5813
5084
|
# Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
|
5814
5085
|
attr_accessor :billing_cycle_anchor
|
5815
|
-
|
5816
5086
|
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
|
5817
5087
|
attr_accessor :billing_thresholds
|
5818
|
-
|
5819
5088
|
# Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
|
5820
5089
|
attr_accessor :collection_method
|
5821
|
-
|
5822
5090
|
# The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
|
5823
5091
|
attr_accessor :coupon
|
5824
|
-
|
5825
5092
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
5826
5093
|
attr_accessor :currency
|
5827
|
-
|
5828
5094
|
# ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
|
5829
5095
|
attr_accessor :default_payment_method
|
5830
|
-
|
5831
5096
|
# A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
|
5832
5097
|
attr_accessor :default_tax_rates
|
5833
|
-
|
5834
5098
|
# Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
|
5835
5099
|
attr_accessor :description
|
5836
|
-
|
5837
5100
|
# The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
|
5838
5101
|
attr_accessor :discounts
|
5839
|
-
|
5840
5102
|
# The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
|
5841
5103
|
attr_accessor :end_date
|
5842
|
-
|
5843
5104
|
# All invoices will be billed using the specified settings.
|
5844
5105
|
attr_accessor :invoice_settings
|
5845
|
-
|
5846
5106
|
# List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
|
5847
5107
|
attr_accessor :items
|
5848
|
-
|
5849
5108
|
# Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.
|
5850
5109
|
attr_accessor :iterations
|
5851
|
-
|
5852
5110
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
|
5853
5111
|
attr_accessor :metadata
|
5854
|
-
|
5855
5112
|
# The account on behalf of which to charge, for each of the associated subscription's invoices.
|
5856
5113
|
attr_accessor :on_behalf_of
|
5857
|
-
|
5858
5114
|
# 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).
|
5859
5115
|
attr_accessor :pause_collection
|
5860
|
-
|
5861
5116
|
# 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.
|
5862
5117
|
attr_accessor :proration_behavior
|
5863
|
-
|
5864
5118
|
# The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
|
5865
5119
|
attr_accessor :start_date
|
5866
|
-
|
5867
5120
|
# The data with which to automatically create a Transfer for each of the associated subscription's invoices.
|
5868
5121
|
attr_accessor :transfer_data
|
5869
|
-
|
5870
5122
|
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
5871
5123
|
attr_accessor :trial
|
5872
|
-
|
5873
5124
|
# Specify trial behavior when crossing phase boundaries
|
5874
5125
|
attr_accessor :trial_continuation
|
5875
|
-
|
5876
5126
|
# 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`
|
5877
5127
|
attr_accessor :trial_end
|
5878
|
-
|
5879
5128
|
# Settings related to subscription trials.
|
5880
5129
|
attr_accessor :trial_settings
|
5881
5130
|
|
@@ -5950,7 +5199,6 @@ module Stripe
|
|
5950
5199
|
class Duration < Stripe::RequestParams
|
5951
5200
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
5952
5201
|
attr_accessor :interval
|
5953
|
-
|
5954
5202
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
5955
5203
|
attr_accessor :interval_count
|
5956
5204
|
|
@@ -5961,13 +5209,10 @@ module Stripe
|
|
5961
5209
|
end
|
5962
5210
|
# End the prebilled period when a specified amendment ends.
|
5963
5211
|
attr_accessor :amendment_end
|
5964
|
-
|
5965
5212
|
# Time span for prebilling, starting from `bill_from`.
|
5966
5213
|
attr_accessor :duration
|
5967
|
-
|
5968
5214
|
# End the prebilled period at a precise integer timestamp, starting from the Unix epoch.
|
5969
5215
|
attr_accessor :timestamp
|
5970
|
-
|
5971
5216
|
# Select one of several ways to pass the `bill_until` value.
|
5972
5217
|
attr_accessor :type
|
5973
5218
|
|
@@ -5980,7 +5225,6 @@ module Stripe
|
|
5980
5225
|
end
|
5981
5226
|
# The end of the prebilled time period.
|
5982
5227
|
attr_accessor :bill_until
|
5983
|
-
|
5984
5228
|
# This is used to determine the number of billing cycles to prebill.
|
5985
5229
|
attr_accessor :iterations
|
5986
5230
|
|
@@ -5991,19 +5235,14 @@ module Stripe
|
|
5991
5235
|
end
|
5992
5236
|
# Changes to apply to the phases of the subscription schedule, in the order provided.
|
5993
5237
|
attr_accessor :amendments
|
5994
|
-
|
5995
5238
|
# 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.
|
5996
5239
|
attr_accessor :billing_behavior
|
5997
|
-
|
5998
5240
|
# 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.
|
5999
5241
|
attr_accessor :end_behavior
|
6000
|
-
|
6001
5242
|
# 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.
|
6002
5243
|
attr_accessor :phases
|
6003
|
-
|
6004
5244
|
# Provide any time periods to bill in advance.
|
6005
5245
|
attr_accessor :prebilling
|
6006
|
-
|
6007
5246
|
# In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
|
6008
5247
|
attr_accessor :proration_behavior
|
6009
5248
|
|
@@ -6040,7 +5279,6 @@ module Stripe
|
|
6040
5279
|
class Duration < Stripe::RequestParams
|
6041
5280
|
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
6042
5281
|
attr_accessor :interval
|
6043
|
-
|
6044
5282
|
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
6045
5283
|
attr_accessor :interval_count
|
6046
5284
|
|
@@ -6051,10 +5289,8 @@ module Stripe
|
|
6051
5289
|
end
|
6052
5290
|
# Time span for the redeemed discount.
|
6053
5291
|
attr_accessor :duration
|
6054
|
-
|
6055
5292
|
# A precise Unix timestamp for the discount to end. Must be in the future.
|
6056
5293
|
attr_accessor :timestamp
|
6057
|
-
|
6058
5294
|
# The type of calculation made to determine when the discount ends.
|
6059
5295
|
attr_accessor :type
|
6060
5296
|
|
@@ -6066,13 +5302,10 @@ module Stripe
|
|
6066
5302
|
end
|
6067
5303
|
# ID of the coupon to create a new discount for.
|
6068
5304
|
attr_accessor :coupon
|
6069
|
-
|
6070
5305
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
6071
5306
|
attr_accessor :discount
|
6072
|
-
|
6073
5307
|
# Details to determine how long the discount should be applied for.
|
6074
5308
|
attr_accessor :discount_end
|
6075
|
-
|
6076
5309
|
# ID of the promotion code to create a new discount for.
|
6077
5310
|
attr_accessor :promotion_code
|
6078
5311
|
|
@@ -6088,7 +5321,6 @@ module Stripe
|
|
6088
5321
|
class Recurring < Stripe::RequestParams
|
6089
5322
|
# Specifies billing frequency. Either `day`, `week`, `month` or `year`.
|
6090
5323
|
attr_accessor :interval
|
6091
|
-
|
6092
5324
|
# The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
|
6093
5325
|
attr_accessor :interval_count
|
6094
5326
|
|
@@ -6099,19 +5331,14 @@ module Stripe
|
|
6099
5331
|
end
|
6100
5332
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
6101
5333
|
attr_accessor :currency
|
6102
|
-
|
6103
5334
|
# The ID of the product that this price will belong to.
|
6104
5335
|
attr_accessor :product
|
6105
|
-
|
6106
5336
|
# The recurring components of a price such as `interval` and `interval_count`.
|
6107
5337
|
attr_accessor :recurring
|
6108
|
-
|
6109
5338
|
# Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
|
6110
5339
|
attr_accessor :tax_behavior
|
6111
|
-
|
6112
5340
|
# A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
|
6113
5341
|
attr_accessor :unit_amount
|
6114
|
-
|
6115
5342
|
# Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
|
6116
5343
|
attr_accessor :unit_amount_decimal
|
6117
5344
|
|
@@ -6133,34 +5360,24 @@ module Stripe
|
|
6133
5360
|
end
|
6134
5361
|
# Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
|
6135
5362
|
attr_accessor :billing_thresholds
|
6136
|
-
|
6137
5363
|
# Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
|
6138
5364
|
attr_accessor :clear_usage
|
6139
|
-
|
6140
5365
|
# A flag that, if set to `true`, will delete the specified item.
|
6141
5366
|
attr_accessor :deleted
|
6142
|
-
|
6143
5367
|
# The coupons to redeem into discounts for the subscription item.
|
6144
5368
|
attr_accessor :discounts
|
6145
|
-
|
6146
5369
|
# Subscription item to update.
|
6147
5370
|
attr_accessor :id
|
6148
|
-
|
6149
5371
|
# 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`.
|
6150
5372
|
attr_accessor :metadata
|
6151
|
-
|
6152
5373
|
# Plan ID for this item, as a string.
|
6153
5374
|
attr_accessor :plan
|
6154
|
-
|
6155
5375
|
# The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
|
6156
5376
|
attr_accessor :price
|
6157
|
-
|
6158
5377
|
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
6159
5378
|
attr_accessor :price_data
|
6160
|
-
|
6161
5379
|
# Quantity for this item.
|
6162
5380
|
attr_accessor :quantity
|
6163
|
-
|
6164
5381
|
# 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.
|
6165
5382
|
attr_accessor :tax_rates
|
6166
5383
|
|
@@ -6201,37 +5418,26 @@ module Stripe
|
|
6201
5418
|
end
|
6202
5419
|
# 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`.
|
6203
5420
|
attr_accessor :billing_cycle_anchor
|
6204
|
-
|
6205
5421
|
# 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.
|
6206
5422
|
attr_accessor :cancel_at
|
6207
|
-
|
6208
5423
|
# Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
|
6209
5424
|
attr_accessor :cancel_at_period_end
|
6210
|
-
|
6211
5425
|
# This simulates the subscription being canceled or expired immediately.
|
6212
5426
|
attr_accessor :cancel_now
|
6213
|
-
|
6214
5427
|
# If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set.
|
6215
5428
|
attr_accessor :default_tax_rates
|
6216
|
-
|
6217
5429
|
# A list of up to 20 subscription items, each with an attached price.
|
6218
5430
|
attr_accessor :items
|
6219
|
-
|
6220
5431
|
# The pre-billing to apply to the subscription as a preview.
|
6221
5432
|
attr_accessor :prebilling
|
6222
|
-
|
6223
5433
|
# 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`.
|
6224
5434
|
attr_accessor :proration_behavior
|
6225
|
-
|
6226
5435
|
# 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'.
|
6227
5436
|
attr_accessor :proration_date
|
6228
|
-
|
6229
5437
|
# For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.
|
6230
5438
|
attr_accessor :resume_at
|
6231
|
-
|
6232
5439
|
# Date a subscription is intended to start (can be future or past).
|
6233
5440
|
attr_accessor :start_date
|
6234
|
-
|
6235
5441
|
# If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_details.items` or `subscription` is required.
|
6236
5442
|
attr_accessor :trial_end
|
6237
5443
|
|
@@ -6265,46 +5471,32 @@ module Stripe
|
|
6265
5471
|
end
|
6266
5472
|
# Settings for automatic tax lookup for this invoice preview.
|
6267
5473
|
attr_accessor :automatic_tax
|
6268
|
-
|
6269
5474
|
# The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
|
6270
5475
|
attr_accessor :coupon
|
6271
|
-
|
6272
5476
|
# The currency to preview this invoice in. Defaults to that of `customer` if not specified.
|
6273
5477
|
attr_accessor :currency
|
6274
|
-
|
6275
5478
|
# 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.
|
6276
5479
|
attr_accessor :customer
|
6277
|
-
|
6278
5480
|
# 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.
|
6279
5481
|
attr_accessor :customer_details
|
6280
|
-
|
6281
5482
|
# 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.
|
6282
5483
|
attr_accessor :discounts
|
6283
|
-
|
6284
5484
|
# Specifies which fields in the response should be expanded.
|
6285
5485
|
attr_accessor :expand
|
6286
|
-
|
6287
5486
|
# List of invoice items to add or update in the upcoming invoice preview (up to 250).
|
6288
5487
|
attr_accessor :invoice_items
|
6289
|
-
|
6290
5488
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
6291
5489
|
attr_accessor :issuer
|
6292
|
-
|
6293
5490
|
# The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
|
6294
5491
|
attr_accessor :on_behalf_of
|
6295
|
-
|
6296
5492
|
# Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.
|
6297
5493
|
attr_accessor :preview_mode
|
6298
|
-
|
6299
5494
|
# The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.
|
6300
5495
|
attr_accessor :schedule
|
6301
|
-
|
6302
5496
|
# The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.
|
6303
5497
|
attr_accessor :schedule_details
|
6304
|
-
|
6305
5498
|
# The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.
|
6306
5499
|
attr_accessor :subscription
|
6307
|
-
|
6308
5500
|
# The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.
|
6309
5501
|
attr_accessor :subscription_details
|
6310
5502
|
|