stripe 13.6.0.pre.beta.1 → 14.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +699 -1457
- data/OPENAPI_VERSION +1 -1
- data/README.md +29 -0
- data/VERSION +1 -1
- data/lib/stripe/api_requestor.rb +2 -0
- data/lib/stripe/api_version.rb +1 -1
- data/lib/stripe/errors.rb +0 -7
- data/lib/stripe/object_types.rb +0 -26
- data/lib/stripe/resources/account.rb +83 -614
- data/lib/stripe/resources/account_session.rb +1 -247
- data/lib/stripe/resources/apple_pay_domain.rb +0 -9
- data/lib/stripe/resources/application_fee.rb +1 -10
- data/lib/stripe/resources/balance.rb +0 -9
- data/lib/stripe/resources/balance_transaction.rb +2 -11
- data/lib/stripe/resources/bank_account.rb +1 -1
- data/lib/stripe/resources/billing/alert.rb +0 -9
- data/lib/stripe/resources/billing/credit_balance_summary.rb +0 -48
- data/lib/stripe/resources/billing/credit_balance_transaction.rb +0 -9
- data/lib/stripe/resources/billing/credit_grant.rb +4 -13
- data/lib/stripe/resources/billing/meter.rb +1 -10
- data/lib/stripe/resources/billing_portal/configuration.rb +0 -9
- data/lib/stripe/resources/card.rb +2 -4
- data/lib/stripe/resources/charge.rb +35 -1457
- data/lib/stripe/resources/checkout/session.rb +100 -293
- data/lib/stripe/resources/climate/order.rb +0 -9
- data/lib/stripe/resources/climate/product.rb +0 -9
- data/lib/stripe/resources/climate/supplier.rb +0 -9
- data/lib/stripe/resources/confirmation_token.rb +74 -156
- data/lib/stripe/resources/country_spec.rb +0 -9
- data/lib/stripe/resources/coupon.rb +0 -9
- data/lib/stripe/resources/credit_note.rb +14 -35
- data/lib/stripe/resources/credit_note_line_item.rb +14 -12
- data/lib/stripe/resources/customer.rb +12 -28
- data/lib/stripe/resources/customer_balance_transaction.rb +3 -1
- data/lib/stripe/resources/dispute.rb +0 -9
- data/lib/stripe/resources/entitlements/active_entitlement.rb +0 -9
- data/lib/stripe/resources/entitlements/feature.rb +0 -9
- data/lib/stripe/resources/event.rb +0 -40
- data/lib/stripe/resources/exchange_rate.rb +0 -9
- data/lib/stripe/resources/file.rb +0 -9
- data/lib/stripe/resources/file_link.rb +0 -9
- data/lib/stripe/resources/financial_connections/account.rb +0 -23
- data/lib/stripe/resources/financial_connections/session.rb +1 -65
- data/lib/stripe/resources/financial_connections/transaction.rb +0 -9
- data/lib/stripe/resources/forwarding/request.rb +0 -9
- data/lib/stripe/resources/identity/verification_report.rb +0 -9
- data/lib/stripe/resources/identity/verification_session.rb +0 -9
- data/lib/stripe/resources/invoice.rb +225 -5120
- data/lib/stripe/resources/invoice_item.rb +65 -110
- data/lib/stripe/resources/invoice_line_item.rb +106 -89
- data/lib/stripe/resources/invoice_payment.rb +53 -4
- data/lib/stripe/resources/invoice_rendering_template.rb +0 -12
- data/lib/stripe/resources/issuing/authorization.rb +0 -9
- data/lib/stripe/resources/issuing/card.rb +0 -9
- data/lib/stripe/resources/issuing/cardholder.rb +1 -11
- data/lib/stripe/resources/issuing/dispute.rb +0 -9
- data/lib/stripe/resources/issuing/personalization_design.rb +0 -9
- data/lib/stripe/resources/issuing/physical_bundle.rb +0 -9
- data/lib/stripe/resources/issuing/token.rb +0 -9
- data/lib/stripe/resources/issuing/transaction.rb +0 -15
- data/lib/stripe/resources/line_item.rb +0 -28
- data/lib/stripe/resources/mandate.rb +6 -33
- data/lib/stripe/resources/payment_intent.rb +642 -4975
- data/lib/stripe/resources/payment_link.rb +84 -15
- data/lib/stripe/resources/payment_method.rb +74 -187
- data/lib/stripe/resources/payment_method_configuration.rb +87 -214
- data/lib/stripe/resources/payment_method_domain.rb +9 -18
- data/lib/stripe/resources/payout.rb +0 -9
- data/lib/stripe/resources/person.rb +9 -9
- data/lib/stripe/resources/plan.rb +0 -15
- data/lib/stripe/resources/price.rb +2 -47
- data/lib/stripe/resources/product.rb +0 -68
- data/lib/stripe/resources/promotion_code.rb +0 -9
- data/lib/stripe/resources/quote.rb +8 -2037
- data/lib/stripe/resources/radar/early_fraud_warning.rb +0 -9
- data/lib/stripe/resources/radar/value_list.rb +0 -9
- data/lib/stripe/resources/radar/value_list_item.rb +0 -9
- data/lib/stripe/resources/refund.rb +13 -18
- data/lib/stripe/resources/reporting/report_run.rb +0 -9
- data/lib/stripe/resources/reporting/report_type.rb +0 -9
- data/lib/stripe/resources/review.rb +2 -11
- data/lib/stripe/resources/setup_attempt.rb +11 -16
- data/lib/stripe/resources/setup_intent.rb +158 -540
- data/lib/stripe/resources/shipping_rate.rb +0 -9
- data/lib/stripe/resources/sigma/scheduled_query_run.rb +0 -9
- data/lib/stripe/resources/source.rb +0 -41
- data/lib/stripe/resources/subscription.rb +14 -385
- data/lib/stripe/resources/subscription_item.rb +9 -134
- data/lib/stripe/resources/subscription_schedule.rb +14 -1135
- data/lib/stripe/resources/tax/calculation.rb +0 -9
- data/lib/stripe/resources/tax/registration.rb +1 -10
- data/lib/stripe/resources/tax/settings.rb +0 -9
- data/lib/stripe/resources/tax/transaction.rb +0 -9
- data/lib/stripe/resources/tax_code.rb +0 -9
- data/lib/stripe/resources/tax_id.rb +0 -9
- data/lib/stripe/resources/tax_rate.rb +0 -9
- data/lib/stripe/resources/terminal/configuration.rb +214 -14
- data/lib/stripe/resources/terminal/location.rb +0 -9
- data/lib/stripe/resources/terminal/reader.rb +0 -408
- data/lib/stripe/resources/test_helpers/test_clock.rb +0 -9
- data/lib/stripe/resources/token.rb +1 -10
- data/lib/stripe/resources/topup.rb +0 -9
- data/lib/stripe/resources/transfer.rb +0 -9
- data/lib/stripe/resources/treasury/credit_reversal.rb +0 -9
- data/lib/stripe/resources/treasury/debit_reversal.rb +0 -9
- data/lib/stripe/resources/treasury/financial_account.rb +4 -32
- data/lib/stripe/resources/treasury/financial_account_features.rb +0 -2
- data/lib/stripe/resources/treasury/inbound_transfer.rb +0 -9
- data/lib/stripe/resources/treasury/outbound_payment.rb +0 -9
- data/lib/stripe/resources/treasury/outbound_transfer.rb +0 -46
- data/lib/stripe/resources/treasury/received_credit.rb +1 -47
- data/lib/stripe/resources/treasury/received_debit.rb +1 -49
- data/lib/stripe/resources/treasury/transaction.rb +0 -9
- data/lib/stripe/resources/treasury/transaction_entry.rb +0 -9
- data/lib/stripe/resources/v2/event.rb +1 -0
- data/lib/stripe/resources/v2/event_destination.rb +1 -0
- data/lib/stripe/resources/webhook_endpoint.rb +0 -9
- data/lib/stripe/resources.rb +0 -25
- data/lib/stripe/services/account_external_account_service.rb +1 -1
- data/lib/stripe/services/account_service.rb +68 -509
- data/lib/stripe/services/account_session_service.rb +1 -217
- data/lib/stripe/services/balance_transaction_service.rb +1 -1
- data/lib/stripe/services/billing/credit_balance_summary_service.rb +2 -2
- data/lib/stripe/services/billing/credit_grant_service.rb +2 -2
- data/lib/stripe/services/billing/meter_service.rb +1 -1
- data/lib/stripe/services/charge_service.rb +1 -1335
- data/lib/stripe/services/checkout/session_service.rb +60 -168
- data/lib/stripe/services/credit_note_preview_lines_service.rb +0 -4
- data/lib/stripe/services/credit_note_service.rb +0 -8
- data/lib/stripe/services/customer_service.rb +0 -16
- data/lib/stripe/services/financial_connections/account_service.rb +1 -3
- data/lib/stripe/services/financial_connections/session_service.rb +1 -30
- data/lib/stripe/services/financial_connections_service.rb +1 -2
- data/lib/stripe/services/invoice_item_service.rb +34 -88
- data/lib/stripe/services/invoice_line_item_service.rb +25 -41
- data/lib/stripe/services/invoice_payment_service.rb +33 -5
- data/lib/stripe/services/invoice_service.rb +210 -3147
- data/lib/stripe/services/issuing/cardholder_service.rb +1 -2
- data/lib/stripe/services/issuing/transaction_service.rb +0 -4
- data/lib/stripe/services/issuing_service.rb +1 -5
- data/lib/stripe/services/payment_intent_service.rb +568 -4513
- data/lib/stripe/services/payment_link_service.rb +59 -6
- data/lib/stripe/services/payment_method_configuration_service.rb +62 -146
- data/lib/stripe/services/payment_method_domain_service.rb +6 -6
- data/lib/stripe/services/payment_method_service.rb +49 -119
- data/lib/stripe/services/plan_service.rb +0 -4
- data/lib/stripe/services/price_service.rb +2 -25
- data/lib/stripe/services/product_service.rb +0 -38
- data/lib/stripe/services/quote_service.rb +9 -1716
- data/lib/stripe/services/setup_intent_service.rb +158 -492
- data/lib/stripe/services/subscription_item_service.rb +5 -111
- data/lib/stripe/services/subscription_schedule_service.rb +14 -1005
- data/lib/stripe/services/subscription_service.rb +13 -323
- data/lib/stripe/services/tax/registration_service.rb +1 -1
- data/lib/stripe/services/tax_service.rb +1 -3
- data/lib/stripe/services/terminal/configuration_service.rb +170 -4
- data/lib/stripe/services/terminal/reader_service.rb +0 -177
- data/lib/stripe/services/terminal_service.rb +1 -2
- data/lib/stripe/services/test_helpers/confirmation_token_service.rb +49 -87
- data/lib/stripe/services/test_helpers/terminal/reader_service.rb +0 -43
- data/lib/stripe/services/test_helpers/treasury/received_credit_service.rb +1 -25
- data/lib/stripe/services/test_helpers/treasury/received_debit_service.rb +1 -25
- data/lib/stripe/services/token_service.rb +1 -1
- data/lib/stripe/services/treasury/financial_account_features_service.rb +1 -4
- data/lib/stripe/services/treasury/financial_account_service.rb +3 -17
- data/lib/stripe/services/treasury/outbound_transfer_service.rb +0 -24
- data/lib/stripe/services/v1_services.rb +2 -8
- data/lib/stripe/services/v2/core/event_destination_service.rb +1 -4
- data/lib/stripe/services/v2/core/event_service.rb +1 -4
- data/lib/stripe/services.rb +0 -27
- data/lib/stripe/stripe_client.rb +1 -0
- data/lib/stripe/stripe_configuration.rb +1 -3
- data/lib/stripe/util.rb +1 -7
- data/lib/stripe/version.rb +1 -1
- data/lib/stripe.rb +0 -45
- data/rbi/stripe/resources/account.rbi +1131 -1479
- data/rbi/stripe/resources/account_link.rbi +9 -9
- data/rbi/stripe/resources/account_session.rbi +118 -367
- data/rbi/stripe/resources/apple_pay_domain.rbi +8 -15
- data/rbi/stripe/resources/application_fee.rbi +15 -20
- data/rbi/stripe/resources/apps/secret.rbi +20 -20
- data/rbi/stripe/resources/balance.rbi +0 -7
- data/rbi/stripe/resources/balance_transaction.rbi +19 -24
- data/rbi/stripe/resources/bank_account.rbi +1 -1
- data/rbi/stripe/resources/billing/alert.rbi +23 -28
- data/rbi/stripe/resources/billing/credit_balance_summary.rbi +0 -53
- data/rbi/stripe/resources/billing/credit_balance_transaction.rbi +6 -13
- data/rbi/stripe/resources/billing/credit_grant.rbi +30 -37
- data/rbi/stripe/resources/billing/meter.rbi +19 -26
- data/rbi/stripe/resources/billing/meter_event.rbi +4 -4
- data/rbi/stripe/resources/billing/meter_event_adjustment.rbi +5 -5
- data/rbi/stripe/resources/billing_portal/configuration.rbi +86 -81
- data/rbi/stripe/resources/billing_portal/session.rbi +31 -27
- data/rbi/stripe/resources/card.rbi +2 -5
- data/rbi/stripe/resources/charge.rbi +136 -1576
- data/rbi/stripe/resources/checkout/session.rbi +631 -748
- data/rbi/stripe/resources/climate/order.rbi +20 -25
- data/rbi/stripe/resources/climate/product.rbi +5 -12
- data/rbi/stripe/resources/climate/supplier.rbi +5 -12
- data/rbi/stripe/resources/confirmation_token.rbi +274 -268
- data/rbi/stripe/resources/country_spec.rbi +5 -12
- data/rbi/stripe/resources/coupon.rbi +34 -39
- data/rbi/stripe/resources/credit_note.rbi +134 -146
- data/rbi/stripe/resources/credit_note_line_item.rbi +20 -18
- data/rbi/stripe/resources/customer.rbi +172 -164
- data/rbi/stripe/resources/customer_balance_transaction.rbi +4 -1
- data/rbi/stripe/resources/customer_session.rbi +19 -15
- data/rbi/stripe/resources/dispute.rbi +92 -95
- data/rbi/stripe/resources/entitlements/active_entitlement.rbi +5 -12
- data/rbi/stripe/resources/entitlements/feature.rbi +15 -22
- data/rbi/stripe/resources/ephemeral_key.rbi +2 -2
- data/rbi/stripe/resources/event.rbi +16 -60
- data/rbi/stripe/resources/exchange_rate.rbi +5 -12
- data/rbi/stripe/resources/file.rbi +20 -25
- data/rbi/stripe/resources/file_link.rbi +23 -28
- data/rbi/stripe/resources/financial_connections/account.rbi +25 -44
- data/rbi/stripe/resources/financial_connections/session.rbi +12 -75
- data/rbi/stripe/resources/financial_connections/transaction.rbi +16 -19
- data/rbi/stripe/resources/forwarding/request.rbi +21 -24
- data/rbi/stripe/resources/identity/verification_report.rbi +18 -21
- data/rbi/stripe/resources/identity/verification_session.rbi +60 -61
- data/rbi/stripe/resources/invoice.rbi +723 -5918
- data/rbi/stripe/resources/invoice_item.rbi +138 -177
- data/rbi/stripe/resources/invoice_line_item.rbi +199 -264
- data/rbi/stripe/resources/invoice_payment.rbi +51 -7
- data/rbi/stripe/resources/invoice_rendering_template.rbi +10 -20
- data/rbi/stripe/resources/issuing/authorization.rbi +216 -199
- data/rbi/stripe/resources/issuing/card.rbi +104 -101
- data/rbi/stripe/resources/issuing/cardholder.rbi +120 -108
- data/rbi/stripe/resources/issuing/dispute.rbi +164 -151
- data/rbi/stripe/resources/issuing/personalization_design.rbi +61 -56
- data/rbi/stripe/resources/issuing/physical_bundle.rbi +7 -14
- data/rbi/stripe/resources/issuing/token.rbi +16 -21
- data/rbi/stripe/resources/issuing/transaction.rbi +180 -176
- data/rbi/stripe/resources/line_item.rbi +0 -36
- data/rbi/stripe/resources/mandate.rbi +8 -40
- data/rbi/stripe/resources/payment_intent.rbi +2252 -6482
- data/rbi/stripe/resources/payment_link.rbi +346 -211
- data/rbi/stripe/resources/payment_method.rbi +226 -330
- data/rbi/stripe/resources/payment_method_configuration.rbi +602 -685
- data/rbi/stripe/resources/payment_method_domain.rbi +26 -31
- data/rbi/stripe/resources/payout.rbi +43 -42
- data/rbi/stripe/resources/person.rbi +9 -9
- data/rbi/stripe/resources/plan.rbi +51 -63
- data/rbi/stripe/resources/price.rbi +114 -151
- data/rbi/stripe/resources/product.rbi +90 -152
- data/rbi/stripe/resources/promotion_code.rbi +42 -47
- data/rbi/stripe/resources/quote.rbi +168 -2231
- data/rbi/stripe/resources/radar/early_fraud_warning.rbi +17 -20
- data/rbi/stripe/resources/radar/value_list.rbi +24 -29
- data/rbi/stripe/resources/radar/value_list_item.rbi +18 -21
- data/rbi/stripe/resources/refund.rbi +52 -51
- data/rbi/stripe/resources/reporting/report_run.rbi +27 -30
- data/rbi/stripe/resources/reporting/report_type.rbi +2 -9
- data/rbi/stripe/resources/review.rbi +17 -22
- data/rbi/stripe/resources/setup_attempt.rbi +25 -32
- data/rbi/stripe/resources/setup_intent.rbi +900 -1102
- data/rbi/stripe/resources/shipping_rate.rbi +41 -46
- data/rbi/stripe/resources/sigma/scheduled_query_run.rbi +5 -12
- data/rbi/stripe/resources/source.rbi +132 -179
- data/rbi/stripe/resources/subscription.rbi +363 -707
- data/rbi/stripe/resources/subscription_item.rbi +69 -177
- data/rbi/stripe/resources/subscription_schedule.rbi +289 -1447
- data/rbi/stripe/resources/tax/calculation.rbi +43 -48
- data/rbi/stripe/resources/tax/registration.rbi +217 -170
- data/rbi/stripe/resources/tax/settings.rbi +14 -21
- data/rbi/stripe/resources/tax/transaction.rbi +20 -25
- data/rbi/stripe/resources/tax_code.rbi +5 -12
- data/rbi/stripe/resources/tax_id.rbi +15 -22
- data/rbi/stripe/resources/tax_rate.rbi +34 -39
- data/rbi/stripe/resources/terminal/configuration.rbi +457 -212
- data/rbi/stripe/resources/terminal/connection_token.rbi +3 -3
- data/rbi/stripe/resources/terminal/location.rbi +28 -35
- data/rbi/stripe/resources/terminal/reader.rbi +71 -441
- data/rbi/stripe/resources/test_helpers/test_clock.rbi +12 -17
- data/rbi/stripe/resources/token.rbi +288 -263
- data/rbi/stripe/resources/topup.rbi +35 -38
- data/rbi/stripe/resources/transfer.rbi +27 -32
- data/rbi/stripe/resources/treasury/credit_reversal.rbi +10 -17
- data/rbi/stripe/resources/treasury/debit_reversal.rbi +11 -18
- data/rbi/stripe/resources/treasury/financial_account.rbi +125 -130
- data/rbi/stripe/resources/treasury/financial_account_features.rbi +0 -3
- data/rbi/stripe/resources/treasury/inbound_transfer.rbi +22 -29
- data/rbi/stripe/resources/treasury/outbound_payment.rbi +82 -79
- data/rbi/stripe/resources/treasury/outbound_transfer.rbi +44 -86
- data/rbi/stripe/resources/treasury/received_credit.rbi +18 -64
- data/rbi/stripe/resources/treasury/received_debit.rbi +17 -66
- data/rbi/stripe/resources/treasury/transaction.rbi +27 -28
- data/rbi/stripe/resources/treasury/transaction_entry.rbi +25 -26
- data/rbi/stripe/resources/v2/amount.rbi +1 -1
- data/rbi/stripe/resources/v2/event.rbi +1 -0
- data/rbi/stripe/resources/v2/event_destination.rbi +1 -0
- data/rbi/stripe/resources/webhook_endpoint.rbi +18 -25
- data/rbi/stripe/services/account_capability_service.rbi +7 -7
- data/rbi/stripe/services/account_external_account_service.rbi +52 -52
- data/rbi/stripe/services/account_link_service.rbi +9 -9
- data/rbi/stripe/services/account_login_link_service.rbi +2 -2
- data/rbi/stripe/services/account_person_service.rbi +221 -201
- data/rbi/stripe/services/account_service.rbi +1221 -1345
- data/rbi/stripe/services/account_session_service.rbi +115 -346
- data/rbi/stripe/services/apple_pay_domain_service.rbi +10 -10
- data/rbi/stripe/services/application_fee_refund_service.rbi +16 -14
- data/rbi/stripe/services/application_fee_service.rbi +18 -14
- data/rbi/stripe/services/apps/secret_service.rbi +20 -20
- data/rbi/stripe/services/balance_service.rbi +2 -2
- data/rbi/stripe/services/balance_transaction_service.rbi +22 -18
- data/rbi/stripe/services/billing/alert_service.rbi +23 -23
- data/rbi/stripe/services/billing/credit_balance_summary_service.rbi +10 -10
- data/rbi/stripe/services/billing/credit_balance_transaction_service.rbi +8 -8
- data/rbi/stripe/services/billing/credit_grant_service.rbi +32 -30
- data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi +7 -5
- data/rbi/stripe/services/billing/meter_event_service.rbi +4 -4
- data/rbi/stripe/services/billing/meter_event_summary_service.rbi +6 -6
- data/rbi/stripe/services/billing/meter_service.rbi +21 -21
- data/rbi/stripe/services/billing_portal/configuration_service.rbi +90 -76
- data/rbi/stripe/services/billing_portal/session_service.rbi +29 -27
- data/rbi/stripe/services/charge_service.rbi +96 -1464
- data/rbi/stripe/services/checkout/session_line_item_service.rbi +5 -5
- data/rbi/stripe/services/checkout/session_service.rbi +555 -591
- data/rbi/stripe/services/climate/order_service.rbi +22 -20
- data/rbi/stripe/services/climate/product_service.rbi +7 -7
- data/rbi/stripe/services/climate/supplier_service.rbi +7 -7
- data/rbi/stripe/services/confirmation_token_service.rbi +2 -2
- data/rbi/stripe/services/country_spec_service.rbi +7 -7
- data/rbi/stripe/services/coupon_service.rbi +40 -34
- data/rbi/stripe/services/credit_note_line_item_service.rbi +5 -5
- data/rbi/stripe/services/credit_note_preview_lines_service.rbi +35 -35
- data/rbi/stripe/services/credit_note_service.rbi +81 -85
- data/rbi/stripe/services/customer_balance_transaction_service.rbi +15 -15
- data/rbi/stripe/services/customer_cash_balance_service.rbi +7 -7
- data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +7 -7
- data/rbi/stripe/services/customer_funding_instructions_service.rbi +5 -5
- data/rbi/stripe/services/customer_payment_method_service.rbi +9 -9
- data/rbi/stripe/services/customer_payment_source_service.rbi +48 -44
- data/rbi/stripe/services/customer_service.rbi +143 -139
- data/rbi/stripe/services/customer_session_service.rbi +21 -15
- data/rbi/stripe/services/customer_tax_id_service.rbi +9 -9
- data/rbi/stripe/services/dispute_service.rbi +92 -90
- data/rbi/stripe/services/entitlements/active_entitlement_service.rbi +7 -7
- data/rbi/stripe/services/entitlements/feature_service.rbi +17 -17
- data/rbi/stripe/services/ephemeral_key_service.rbi +8 -8
- data/rbi/stripe/services/event_service.rbi +18 -16
- data/rbi/stripe/services/exchange_rate_service.rbi +7 -7
- data/rbi/stripe/services/file_link_service.rbi +25 -23
- data/rbi/stripe/services/file_service.rbi +22 -20
- data/rbi/stripe/services/financial_connections/account_owner_service.rbi +5 -5
- data/rbi/stripe/services/financial_connections/account_service.rbi +22 -21
- data/rbi/stripe/services/financial_connections/session_service.rbi +16 -39
- data/rbi/stripe/services/financial_connections/transaction_service.rbi +16 -14
- data/rbi/stripe/services/financial_connections_service.rbi +0 -1
- data/rbi/stripe/services/forwarding/request_service.rbi +21 -19
- data/rbi/stripe/services/identity/verification_report_service.rbi +18 -16
- data/rbi/stripe/services/identity/verification_session_service.rbi +62 -56
- data/rbi/stripe/services/invoice_item_service.rbi +99 -155
- data/rbi/stripe/services/invoice_line_item_service.rbi +71 -82
- data/rbi/stripe/services/invoice_payment_service.rbi +39 -12
- data/rbi/stripe/services/invoice_rendering_template_service.rbi +13 -13
- data/rbi/stripe/services/invoice_service.rbi +679 -3799
- data/rbi/stripe/services/issuing/authorization_service.rbi +32 -26
- data/rbi/stripe/services/issuing/card_service.rbi +102 -86
- data/rbi/stripe/services/issuing/cardholder_service.rbi +122 -103
- data/rbi/stripe/services/issuing/dispute_service.rbi +152 -146
- data/rbi/stripe/services/issuing/personalization_design_service.rbi +52 -42
- data/rbi/stripe/services/issuing/physical_bundle_service.rbi +9 -9
- data/rbi/stripe/services/issuing/token_service.rbi +20 -16
- data/rbi/stripe/services/issuing/transaction_service.rbi +25 -23
- data/rbi/stripe/services/issuing_service.rbi +0 -3
- data/rbi/stripe/services/mandate_service.rbi +2 -2
- data/rbi/stripe/services/payment_intent_service.rbi +2312 -6081
- data/rbi/stripe/services/payment_link_line_item_service.rbi +5 -5
- data/rbi/stripe/services/payment_link_service.rbi +303 -201
- data/rbi/stripe/services/payment_method_configuration_service.rbi +616 -620
- data/rbi/stripe/services/payment_method_domain_service.rbi +25 -23
- data/rbi/stripe/services/payment_method_service.rbi +192 -249
- data/rbi/stripe/services/payout_service.rbi +45 -37
- data/rbi/stripe/services/plan_service.rbi +53 -55
- data/rbi/stripe/services/price_service.rbi +124 -129
- data/rbi/stripe/services/product_feature_service.rbi +9 -9
- data/rbi/stripe/services/product_service.rbi +94 -122
- data/rbi/stripe/services/promotion_code_service.rbi +46 -42
- data/rbi/stripe/services/quote_computed_upfront_line_items_service.rbi +5 -5
- data/rbi/stripe/services/quote_line_item_service.rbi +5 -5
- data/rbi/stripe/services/quote_service.rbi +159 -1863
- data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +17 -15
- data/rbi/stripe/services/radar/value_list_item_service.rbi +20 -16
- data/rbi/stripe/services/radar/value_list_service.rbi +28 -24
- data/rbi/stripe/services/refund_service.rbi +37 -33
- data/rbi/stripe/services/reporting/report_run_service.rbi +29 -25
- data/rbi/stripe/services/reporting/report_type_service.rbi +4 -4
- data/rbi/stripe/services/review_service.rbi +17 -15
- data/rbi/stripe/services/setup_attempt_service.rbi +13 -11
- data/rbi/stripe/services/setup_intent_service.rbi +1028 -1062
- data/rbi/stripe/services/shipping_rate_service.rbi +47 -41
- data/rbi/stripe/services/sigma/scheduled_query_run_service.rbi +7 -7
- data/rbi/stripe/services/source_service.rbi +149 -133
- data/rbi/stripe/services/source_transaction_service.rbi +5 -5
- data/rbi/stripe/services/subscription_item_service.rbi +61 -159
- data/rbi/stripe/services/subscription_schedule_service.rbi +289 -1305
- data/rbi/stripe/services/subscription_service.rbi +366 -640
- data/rbi/stripe/services/tax/calculation_line_item_service.rbi +5 -5
- data/rbi/stripe/services/tax/calculation_service.rbi +40 -38
- data/rbi/stripe/services/tax/registration_service.rbi +337 -165
- data/rbi/stripe/services/tax/settings_service.rbi +16 -16
- data/rbi/stripe/services/tax/transaction_line_item_service.rbi +5 -5
- data/rbi/stripe/services/tax/transaction_service.rbi +19 -15
- data/rbi/stripe/services/tax_code_service.rbi +7 -7
- data/rbi/stripe/services/tax_id_service.rbi +17 -17
- data/rbi/stripe/services/tax_rate_service.rbi +36 -34
- data/rbi/stripe/services/tax_service.rbi +0 -2
- data/rbi/stripe/services/terminal/configuration_service.rbi +464 -204
- data/rbi/stripe/services/terminal/connection_token_service.rbi +3 -3
- data/rbi/stripe/services/terminal/location_service.rbi +30 -30
- data/rbi/stripe/services/terminal/reader_service.rbi +57 -226
- data/rbi/stripe/services/terminal_service.rbi +0 -1
- data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +157 -198
- data/rbi/stripe/services/test_helpers/customer_service.rbi +3 -3
- data/rbi/stripe/services/test_helpers/issuing/authorization_service.rbi +180 -168
- data/rbi/stripe/services/test_helpers/issuing/card_service.rbi +10 -10
- data/rbi/stripe/services/test_helpers/issuing/personalization_design_service.rbi +11 -9
- data/rbi/stripe/services/test_helpers/issuing/transaction_service.rbi +151 -145
- data/rbi/stripe/services/test_helpers/refund_service.rbi +2 -2
- data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +10 -39
- data/rbi/stripe/services/test_helpers/test_clock_service.rbi +14 -12
- data/rbi/stripe/services/test_helpers/treasury/inbound_transfer_service.rbi +9 -9
- data/rbi/stripe/services/test_helpers/treasury/outbound_payment_service.rbi +20 -18
- data/rbi/stripe/services/test_helpers/treasury/outbound_transfer_service.rbi +20 -18
- data/rbi/stripe/services/test_helpers/treasury/received_credit_service.rbi +11 -38
- data/rbi/stripe/services/test_helpers/treasury/received_debit_service.rbi +11 -38
- data/rbi/stripe/services/token_service.rbi +292 -258
- data/rbi/stripe/services/topup_service.rbi +37 -33
- data/rbi/stripe/services/transfer_reversal_service.rbi +18 -16
- data/rbi/stripe/services/transfer_service.rbi +29 -27
- data/rbi/stripe/services/treasury/credit_reversal_service.rbi +12 -12
- data/rbi/stripe/services/treasury/debit_reversal_service.rbi +13 -13
- data/rbi/stripe/services/treasury/financial_account_features_service.rbi +23 -26
- data/rbi/stripe/services/treasury/financial_account_service.rbi +92 -96
- data/rbi/stripe/services/treasury/inbound_transfer_service.rbi +15 -15
- data/rbi/stripe/services/treasury/outbound_payment_service.rbi +60 -56
- data/rbi/stripe/services/treasury/outbound_transfer_service.rbi +24 -49
- data/rbi/stripe/services/treasury/received_credit_service.rbi +11 -9
- data/rbi/stripe/services/treasury/received_debit_service.rbi +8 -8
- data/rbi/stripe/services/treasury/transaction_entry_service.rbi +25 -21
- data/rbi/stripe/services/treasury/transaction_service.rbi +31 -23
- data/rbi/stripe/services/v1_services.rbi +1 -7
- data/rbi/stripe/services/v2/billing/meter_event_service.rbi +3 -3
- data/rbi/stripe/services/v2/billing/meter_event_stream_service.rbi +3 -3
- data/rbi/stripe/services/v2/core/event_destination_service.rbi +21 -24
- data/rbi/stripe/services/v2/core/event_service.rbi +3 -6
- data/rbi/stripe/services/webhook_endpoint_service.rbi +20 -20
- metadata +4 -109
- data/lib/stripe/request_signing_authenticator.rb +0 -79
- data/lib/stripe/resources/account_notice.rb +0 -132
- data/lib/stripe/resources/billing/meter_error_report.rb +0 -59
- data/lib/stripe/resources/capital/financing_offer.rb +0 -188
- data/lib/stripe/resources/capital/financing_summary.rb +0 -64
- data/lib/stripe/resources/capital/financing_transaction.rb +0 -123
- data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -27
- data/lib/stripe/resources/financial_connections/institution.rb +0 -99
- data/lib/stripe/resources/gift_cards/card.rb +0 -217
- data/lib/stripe/resources/gift_cards/transaction.rb +0 -281
- data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -611
- data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -84
- data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -95
- data/lib/stripe/resources/issuing/settlement.rb +0 -49
- data/lib/stripe/resources/margin.rb +0 -124
- data/lib/stripe/resources/order.rb +0 -2868
- data/lib/stripe/resources/payment_attempt_record.rb +0 -184
- data/lib/stripe/resources/payment_record.rb +0 -715
- data/lib/stripe/resources/quote_line.rb +0 -274
- data/lib/stripe/resources/quote_preview_invoice.rb +0 -652
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -362
- data/lib/stripe/resources/tax/association.rb +0 -89
- data/lib/stripe/resources/tax/form.rb +0 -220
- data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -40
- data/lib/stripe/resources/usage_record.rb +0 -30
- data/lib/stripe/resources/usage_record_summary.rb +0 -33
- data/lib/stripe/services/account_notice_service.rb +0 -101
- data/lib/stripe/services/capital/financing_offer_service.rb +0 -112
- data/lib/stripe/services/capital/financing_summary_service.rb +0 -28
- data/lib/stripe/services/capital/financing_transaction_service.rb +0 -79
- data/lib/stripe/services/capital_service.rb +0 -15
- data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +0 -37
- data/lib/stripe/services/financial_connections/institution_service.rb +0 -57
- data/lib/stripe/services/gift_cards/card_service.rb +0 -170
- data/lib/stripe/services/gift_cards/transaction_service.rb +0 -209
- data/lib/stripe/services/gift_cards_service.rb +0 -14
- data/lib/stripe/services/invoice_upcoming_lines_service.rb +0 -1881
- data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -504
- data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -66
- data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -83
- data/lib/stripe/services/margin_service.rb +0 -119
- data/lib/stripe/services/order_line_item_service.rb +0 -35
- data/lib/stripe/services/order_service.rb +0 -2268
- data/lib/stripe/services/payment_attempt_record_service.rb +0 -49
- data/lib/stripe/services/payment_record_service.rb +0 -542
- data/lib/stripe/services/quote_line_service.rb +0 -35
- data/lib/stripe/services/quote_preview_invoice_service.rb +0 -35
- data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -35
- data/lib/stripe/services/subscription_item_usage_record_service.rb +0 -41
- data/lib/stripe/services/subscription_item_usage_record_summary_service.rb +0 -37
- data/lib/stripe/services/tax/association_service.rb +0 -31
- data/lib/stripe/services/tax/form_service.rb +0 -100
- data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -28
- data/rbi/stripe/resources/account_notice.rbi +0 -139
- data/rbi/stripe/resources/billing/meter_error_report.rbi +0 -71
- data/rbi/stripe/resources/capital/financing_offer.rbi +0 -190
- data/rbi/stripe/resources/capital/financing_summary.rbi +0 -74
- data/rbi/stripe/resources/capital/financing_transaction.rbi +0 -130
- data/rbi/stripe/resources/financial_connections/account_inferred_balance.rbi +0 -27
- data/rbi/stripe/resources/financial_connections/institution.rbi +0 -99
- data/rbi/stripe/resources/gift_cards/card.rbi +0 -206
- data/rbi/stripe/resources/gift_cards/transaction.rbi +0 -257
- data/rbi/stripe/resources/issuing/credit_underwriting_record.rbi +0 -622
- data/rbi/stripe/resources/issuing/dispute_settlement_detail.rbi +0 -83
- data/rbi/stripe/resources/issuing/fraud_liability_debit.rbi +0 -90
- data/rbi/stripe/resources/issuing/settlement.rbi +0 -62
- data/rbi/stripe/resources/margin.rbi +0 -127
- data/rbi/stripe/resources/order.rbi +0 -3036
- data/rbi/stripe/resources/payment_attempt_record.rbi +0 -215
- data/rbi/stripe/resources/payment_record.rbi +0 -722
- data/rbi/stripe/resources/quote_line.rbi +0 -350
- data/rbi/stripe/resources/quote_preview_invoice.rbi +0 -850
- data/rbi/stripe/resources/quote_preview_subscription_schedule.rbi +0 -474
- data/rbi/stripe/resources/tax/association.rbi +0 -94
- data/rbi/stripe/resources/tax/form.rbi +0 -224
- data/rbi/stripe/resources/terminal/reader_collected_data.rbi +0 -41
- data/rbi/stripe/resources/usage_record.rbi +0 -32
- data/rbi/stripe/resources/usage_record_summary.rbi +0 -38
- data/rbi/stripe/services/account_notice_service.rbi +0 -90
- data/rbi/stripe/services/capital/financing_offer_service.rbi +0 -95
- data/rbi/stripe/services/capital/financing_summary_service.rbi +0 -22
- data/rbi/stripe/services/capital/financing_transaction_service.rbi +0 -68
- data/rbi/stripe/services/capital_service.rbi +0 -11
- data/rbi/stripe/services/financial_connections/account_inferred_balance_service.rbi +0 -33
- data/rbi/stripe/services/financial_connections/institution_service.rbi +0 -46
- data/rbi/stripe/services/gift_cards/card_service.rbi +0 -142
- data/rbi/stripe/services/gift_cards/transaction_service.rbi +0 -174
- data/rbi/stripe/services/gift_cards_service.rbi +0 -10
- data/rbi/stripe/services/invoice_upcoming_lines_service.rbi +0 -2023
- data/rbi/stripe/services/issuing/credit_underwriting_record_service.rbi +0 -498
- data/rbi/stripe/services/issuing/dispute_settlement_detail_service.rbi +0 -55
- data/rbi/stripe/services/issuing/fraud_liability_debit_service.rbi +0 -73
- data/rbi/stripe/services/margin_service.rbi +0 -104
- data/rbi/stripe/services/order_line_item_service.rbi +0 -31
- data/rbi/stripe/services/order_service.rbi +0 -2320
- data/rbi/stripe/services/payment_attempt_record_service.rbi +0 -36
- data/rbi/stripe/services/payment_record_service.rbi +0 -521
- data/rbi/stripe/services/quote_line_service.rbi +0 -31
- data/rbi/stripe/services/quote_preview_invoice_service.rbi +0 -31
- data/rbi/stripe/services/quote_preview_subscription_schedule_service.rbi +0 -31
- data/rbi/stripe/services/subscription_item_usage_record_service.rbi +0 -37
- data/rbi/stripe/services/subscription_item_usage_record_summary_service.rbi +0 -33
- data/rbi/stripe/services/tax/association_service.rbi +0 -25
- data/rbi/stripe/services/tax/form_service.rbi +0 -85
- data/rbi/stripe/services/terminal/reader_collected_data_service.rbi +0 -22
@@ -2,7 +2,6 @@
|
|
2
2
|
# frozen_string_literal: true
|
3
3
|
|
4
4
|
# typed: true
|
5
|
-
|
6
5
|
module Stripe
|
7
6
|
# Invoice Line Items represent the individual lines within an [invoice](https://stripe.com/docs/api/invoices) and only exist within the context of an invoice.
|
8
7
|
#
|
@@ -12,327 +11,273 @@ module Stripe
|
|
12
11
|
# The amount, in cents (or local equivalent), of the discount.
|
13
12
|
sig { returns(Integer) }
|
14
13
|
attr_reader :amount
|
15
|
-
|
16
14
|
# The discount that was applied to get this discount amount.
|
17
15
|
sig { returns(T.any(String, Stripe::Discount)) }
|
18
16
|
attr_reader :discount
|
19
17
|
end
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
18
|
+
class Parent < Stripe::StripeObject
|
19
|
+
class InvoiceItemDetails < Stripe::StripeObject
|
20
|
+
class ProrationDetails < Stripe::StripeObject
|
21
|
+
class CreditedItems < Stripe::StripeObject
|
22
|
+
# Invoice containing the credited invoice line items
|
23
|
+
sig { returns(String) }
|
24
|
+
attr_reader :invoice
|
25
|
+
# Credited invoice line items
|
26
|
+
sig { returns(T::Array[String]) }
|
27
|
+
attr_reader :invoice_line_items
|
28
|
+
end
|
29
|
+
# For a credit proration `line_item`, the original debit line_items to which the credit proration applies.
|
30
|
+
sig { returns(T.nilable(CreditedItems)) }
|
31
|
+
attr_reader :credited_items
|
32
|
+
end
|
33
|
+
# The invoice item that generated this line item
|
34
|
+
sig { returns(String) }
|
35
|
+
attr_reader :invoice_item
|
36
|
+
# Whether this is a proration
|
37
|
+
sig { returns(T::Boolean) }
|
38
|
+
attr_reader :proration
|
39
|
+
# Additional details for proration line items
|
40
|
+
sig { returns(T.nilable(ProrationDetails)) }
|
41
|
+
attr_reader :proration_details
|
42
|
+
# The subscription that the invoice item belongs to
|
43
|
+
sig { returns(T.nilable(String)) }
|
44
|
+
attr_reader :subscription
|
45
|
+
end
|
46
|
+
class SubscriptionItemDetails < Stripe::StripeObject
|
47
|
+
class ProrationDetails < Stripe::StripeObject
|
48
|
+
class CreditedItems < Stripe::StripeObject
|
49
|
+
# Invoice containing the credited invoice line items
|
50
|
+
sig { returns(String) }
|
51
|
+
attr_reader :invoice
|
52
|
+
# Credited invoice line items
|
53
|
+
sig { returns(T::Array[String]) }
|
54
|
+
attr_reader :invoice_line_items
|
55
|
+
end
|
56
|
+
# For a credit proration `line_item`, the original debit line_items to which the credit proration applies.
|
57
|
+
sig { returns(T.nilable(CreditedItems)) }
|
58
|
+
attr_reader :credited_items
|
59
|
+
end
|
60
|
+
# The invoice item that generated this line item
|
61
|
+
sig { returns(T.nilable(String)) }
|
62
|
+
attr_reader :invoice_item
|
63
|
+
# Whether this is a proration
|
64
|
+
sig { returns(T::Boolean) }
|
65
|
+
attr_reader :proration
|
66
|
+
# Additional details for proration line items
|
67
|
+
sig { returns(T.nilable(ProrationDetails)) }
|
68
|
+
attr_reader :proration_details
|
69
|
+
# The subscription that the subscription item belongs to
|
70
|
+
sig { returns(String) }
|
71
|
+
attr_reader :subscription
|
72
|
+
# The subscription item that generated this line item
|
73
|
+
sig { returns(String) }
|
74
|
+
attr_reader :subscription_item
|
75
|
+
end
|
76
|
+
# Details about the invoice item that generated this line item
|
77
|
+
sig { returns(T.nilable(InvoiceItemDetails)) }
|
78
|
+
attr_reader :invoice_item_details
|
79
|
+
# Details about the subscription item that generated this line item
|
80
|
+
sig { returns(T.nilable(SubscriptionItemDetails)) }
|
81
|
+
attr_reader :subscription_item_details
|
82
|
+
# The type of parent that generated this line item
|
83
|
+
sig { returns(String) }
|
84
|
+
attr_reader :type
|
29
85
|
end
|
30
|
-
|
31
86
|
class Period < Stripe::StripeObject
|
32
87
|
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
|
33
88
|
sig { returns(Integer) }
|
34
89
|
attr_reader :end
|
35
|
-
|
36
90
|
# The start of the period. This value is inclusive.
|
37
91
|
sig { returns(Integer) }
|
38
92
|
attr_reader :start
|
39
93
|
end
|
40
|
-
|
41
94
|
class PretaxCreditAmount < Stripe::StripeObject
|
42
95
|
# The amount, in cents (or local equivalent), of the pretax credit amount.
|
43
96
|
sig { returns(Integer) }
|
44
97
|
attr_reader :amount
|
45
|
-
|
46
98
|
# The credit balance transaction that was applied to get this pretax credit amount.
|
47
99
|
sig { returns(T.nilable(T.any(String, Stripe::Billing::CreditBalanceTransaction))) }
|
48
100
|
attr_reader :credit_balance_transaction
|
49
|
-
|
50
101
|
# The discount that was applied to get this pretax credit amount.
|
51
102
|
sig { returns(T.any(String, Stripe::Discount)) }
|
52
103
|
attr_reader :discount
|
53
|
-
|
54
|
-
# The margin that was applied to get this pretax credit amount.
|
55
|
-
sig { returns(T.any(String, Stripe::Margin)) }
|
56
|
-
attr_reader :margin
|
57
|
-
|
58
104
|
# Type of the pretax credit amount referenced.
|
59
105
|
sig { returns(String) }
|
60
106
|
attr_reader :type
|
61
107
|
end
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
# Invoice containing the credited invoice line items
|
108
|
+
class Pricing < Stripe::StripeObject
|
109
|
+
class PriceDetails < Stripe::StripeObject
|
110
|
+
# The ID of the price this item is associated with.
|
66
111
|
sig { returns(String) }
|
67
|
-
attr_reader :
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
attr_reader :invoice_line_items
|
112
|
+
attr_reader :price
|
113
|
+
# The ID of the product this item is associated with.
|
114
|
+
sig { returns(String) }
|
115
|
+
attr_reader :product
|
72
116
|
end
|
73
|
-
#
|
74
|
-
sig { returns(
|
75
|
-
attr_reader :
|
117
|
+
# Attribute for field price_details
|
118
|
+
sig { returns(PriceDetails) }
|
119
|
+
attr_reader :price_details
|
120
|
+
# The type of the pricing details.
|
121
|
+
sig { returns(String) }
|
122
|
+
attr_reader :type
|
123
|
+
# The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.
|
124
|
+
sig { returns(T.nilable(String)) }
|
125
|
+
attr_reader :unit_amount_decimal
|
76
126
|
end
|
77
|
-
|
78
|
-
|
79
|
-
|
127
|
+
class Tax < Stripe::StripeObject
|
128
|
+
class TaxRateDetails < Stripe::StripeObject
|
129
|
+
# Attribute for field tax_rate
|
130
|
+
sig { returns(String) }
|
131
|
+
attr_reader :tax_rate
|
132
|
+
end
|
133
|
+
# The amount of the tax, in cents (or local equivalent).
|
80
134
|
sig { returns(Integer) }
|
81
135
|
attr_reader :amount
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
sig { returns(T.any(String, Stripe::TaxRate)) }
|
89
|
-
attr_reader :tax_rate
|
90
|
-
|
136
|
+
# Whether this tax is inclusive or exclusive.
|
137
|
+
sig { returns(String) }
|
138
|
+
attr_reader :tax_behavior
|
139
|
+
# Additional details about the tax rate. Only present when `type` is `tax_rate_details`.
|
140
|
+
sig { returns(T.nilable(TaxRateDetails)) }
|
141
|
+
attr_reader :tax_rate_details
|
91
142
|
# The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
|
92
|
-
sig { returns(
|
143
|
+
sig { returns(String) }
|
93
144
|
attr_reader :taxability_reason
|
94
|
-
|
95
145
|
# The amount on which tax is calculated, in cents (or local equivalent).
|
96
146
|
sig { returns(T.nilable(Integer)) }
|
97
147
|
attr_reader :taxable_amount
|
148
|
+
# The type of tax information.
|
149
|
+
sig { returns(String) }
|
150
|
+
attr_reader :type
|
98
151
|
end
|
99
152
|
# The amount, in cents (or local equivalent).
|
100
153
|
sig { returns(Integer) }
|
101
154
|
attr_reader :amount
|
102
|
-
|
103
|
-
# The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts.
|
104
|
-
sig { returns(T.nilable(Integer)) }
|
105
|
-
attr_reader :amount_excluding_tax
|
106
|
-
|
107
155
|
# 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).
|
108
156
|
sig { returns(String) }
|
109
157
|
attr_reader :currency
|
110
|
-
|
111
158
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
112
159
|
sig { returns(T.nilable(String)) }
|
113
160
|
attr_reader :description
|
114
|
-
|
115
161
|
# The amount of discount calculated per discount for this line item.
|
116
162
|
sig { returns(T.nilable(T::Array[DiscountAmount])) }
|
117
163
|
attr_reader :discount_amounts
|
118
|
-
|
119
164
|
# If true, discounts will apply to this line item. Always false for prorations.
|
120
165
|
sig { returns(T::Boolean) }
|
121
166
|
attr_reader :discountable
|
122
|
-
|
123
167
|
# The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
|
124
168
|
sig { returns(T::Array[T.any(String, Stripe::Discount)]) }
|
125
169
|
attr_reader :discounts
|
126
|
-
|
127
170
|
# Unique identifier for the object.
|
128
171
|
sig { returns(String) }
|
129
172
|
attr_reader :id
|
130
|
-
|
131
173
|
# The ID of the invoice that contains this line item.
|
132
174
|
sig { returns(T.nilable(String)) }
|
133
175
|
attr_reader :invoice
|
134
|
-
|
135
|
-
# The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any.
|
136
|
-
sig { returns(T.any(String, Stripe::InvoiceItem)) }
|
137
|
-
attr_reader :invoice_item
|
138
|
-
|
139
176
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
140
177
|
sig { returns(T::Boolean) }
|
141
178
|
attr_reader :livemode
|
142
|
-
|
143
|
-
# The amount of margin calculated per margin for this line item.
|
144
|
-
sig { returns(T.nilable(T::Array[MarginAmount])) }
|
145
|
-
attr_reader :margin_amounts
|
146
|
-
|
147
|
-
# The margins applied to the line item. When set, the `default_margins` on the invoice do not apply to the line item. Use `expand[]=margins` to expand each margin.
|
148
|
-
sig { returns(T.nilable(T::Array[T.any(String, Stripe::Margin)])) }
|
149
|
-
attr_reader :margins
|
150
|
-
|
151
179
|
# 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. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.
|
152
180
|
sig { returns(T::Hash[String, String]) }
|
153
181
|
attr_reader :metadata
|
154
|
-
|
155
182
|
# String representing the object's type. Objects of the same type share the same value.
|
156
183
|
sig { returns(String) }
|
157
184
|
attr_reader :object
|
158
|
-
|
185
|
+
# The parent that generated this invoice
|
186
|
+
sig { returns(T.nilable(Parent)) }
|
187
|
+
attr_reader :parent
|
159
188
|
# Attribute for field period
|
160
189
|
sig { returns(Period) }
|
161
190
|
attr_reader :period
|
162
|
-
|
163
|
-
# The plan of the subscription, if the line item is a subscription or a proration.
|
164
|
-
sig { returns(T.nilable(Stripe::Plan)) }
|
165
|
-
attr_reader :plan
|
166
|
-
|
167
191
|
# Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item.
|
168
192
|
sig { returns(T.nilable(T::Array[PretaxCreditAmount])) }
|
169
193
|
attr_reader :pretax_credit_amounts
|
170
|
-
|
171
|
-
|
172
|
-
|
173
|
-
attr_reader :price
|
174
|
-
|
175
|
-
# Whether this is a proration.
|
176
|
-
sig { returns(T::Boolean) }
|
177
|
-
attr_reader :proration
|
178
|
-
|
179
|
-
# Additional details for proration line items
|
180
|
-
sig { returns(T.nilable(ProrationDetails)) }
|
181
|
-
attr_reader :proration_details
|
182
|
-
|
194
|
+
# The pricing information of the line item.
|
195
|
+
sig { returns(T.nilable(Pricing)) }
|
196
|
+
attr_reader :pricing
|
183
197
|
# The quantity of the subscription, if the line item is a subscription or a proration.
|
184
198
|
sig { returns(T.nilable(Integer)) }
|
185
199
|
attr_reader :quantity
|
186
|
-
|
187
|
-
# The subscription that the invoice item pertains to, if any.
|
200
|
+
# Attribute for field subscription
|
188
201
|
sig { returns(T.nilable(T.any(String, Stripe::Subscription))) }
|
189
202
|
attr_reader :subscription
|
190
|
-
|
191
|
-
|
192
|
-
|
193
|
-
attr_reader :subscription_item
|
194
|
-
|
195
|
-
# The amount of tax calculated per tax rate for this line item
|
196
|
-
sig { returns(T::Array[TaxAmount]) }
|
197
|
-
attr_reader :tax_amounts
|
198
|
-
|
199
|
-
# The tax rates which apply to the line item.
|
200
|
-
sig { returns(T::Array[Stripe::TaxRate]) }
|
201
|
-
attr_reader :tax_rates
|
202
|
-
|
203
|
-
# A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`.
|
204
|
-
sig { returns(String) }
|
205
|
-
attr_reader :type
|
206
|
-
|
207
|
-
# The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts.
|
208
|
-
sig { returns(T.nilable(String)) }
|
209
|
-
attr_reader :unit_amount_excluding_tax
|
210
|
-
|
203
|
+
# The tax information of the line item.
|
204
|
+
sig { returns(T.nilable(T::Array[Tax])) }
|
205
|
+
attr_reader :taxes
|
211
206
|
class UpdateParams < Stripe::RequestParams
|
212
207
|
class Discount < Stripe::RequestParams
|
213
|
-
class DiscountEnd < Stripe::RequestParams
|
214
|
-
class Duration < Stripe::RequestParams
|
215
|
-
# Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
|
216
|
-
sig { returns(String) }
|
217
|
-
attr_accessor :interval
|
218
|
-
|
219
|
-
# The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
|
220
|
-
sig { returns(Integer) }
|
221
|
-
attr_accessor :interval_count
|
222
|
-
|
223
|
-
sig { params(interval: String, interval_count: Integer).void }
|
224
|
-
def initialize(interval: nil, interval_count: nil); end
|
225
|
-
end
|
226
|
-
# Time span for the redeemed discount.
|
227
|
-
sig { returns(::Stripe::InvoiceLineItem::UpdateParams::Discount::DiscountEnd::Duration) }
|
228
|
-
attr_accessor :duration
|
229
|
-
|
230
|
-
# A precise Unix timestamp for the discount to end. Must be in the future.
|
231
|
-
sig { returns(Integer) }
|
232
|
-
attr_accessor :timestamp
|
233
|
-
|
234
|
-
# The type of calculation made to determine when the discount ends.
|
235
|
-
sig { returns(String) }
|
236
|
-
attr_accessor :type
|
237
|
-
|
238
|
-
sig do
|
239
|
-
params(duration: ::Stripe::InvoiceLineItem::UpdateParams::Discount::DiscountEnd::Duration,
|
240
|
-
timestamp: Integer, type: String).void
|
241
|
-
end
|
242
|
-
def initialize(duration: nil, timestamp: nil, type: nil); end
|
243
|
-
end
|
244
208
|
# ID of the coupon to create a new discount for.
|
245
|
-
sig { returns(String) }
|
209
|
+
sig { returns(T.nilable(String)) }
|
246
210
|
attr_accessor :coupon
|
247
|
-
|
248
211
|
# ID of an existing discount on the object (or one of its ancestors) to reuse.
|
249
|
-
sig { returns(String) }
|
212
|
+
sig { returns(T.nilable(String)) }
|
250
213
|
attr_accessor :discount
|
251
|
-
|
252
|
-
# Details to determine how long the discount should be applied for.
|
253
|
-
sig { returns(::Stripe::InvoiceLineItem::UpdateParams::Discount::DiscountEnd) }
|
254
|
-
attr_accessor :discount_end
|
255
|
-
|
256
214
|
# ID of the promotion code to create a new discount for.
|
257
|
-
sig { returns(String) }
|
215
|
+
sig { returns(T.nilable(String)) }
|
258
216
|
attr_accessor :promotion_code
|
259
|
-
|
260
|
-
|
261
|
-
|
262
|
-
|
263
|
-
end
|
264
|
-
def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil); end
|
217
|
+
sig {
|
218
|
+
params(coupon: T.nilable(String), discount: T.nilable(String), promotion_code: T.nilable(String)).void
|
219
|
+
}
|
220
|
+
def initialize(coupon: nil, discount: nil, promotion_code: nil); end
|
265
221
|
end
|
266
|
-
|
267
222
|
class Period < Stripe::RequestParams
|
268
223
|
# The end of the period, which must be greater than or equal to the start. This value is inclusive.
|
269
224
|
sig { returns(Integer) }
|
270
225
|
attr_accessor :end
|
271
|
-
|
272
226
|
# The start of the period. This value is inclusive.
|
273
227
|
sig { returns(Integer) }
|
274
228
|
attr_accessor :start
|
275
|
-
|
276
229
|
sig { params(end_: Integer, start: Integer).void }
|
277
230
|
def initialize(end_: nil, start: nil); end
|
278
231
|
end
|
279
|
-
|
280
232
|
class PriceData < Stripe::RequestParams
|
281
233
|
class ProductData < Stripe::RequestParams
|
282
234
|
# 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.
|
283
|
-
sig { returns(String) }
|
235
|
+
sig { returns(T.nilable(String)) }
|
284
236
|
attr_accessor :description
|
285
|
-
|
286
237
|
# A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
|
287
|
-
sig { returns(T::Array[String]) }
|
238
|
+
sig { returns(T.nilable(T::Array[String])) }
|
288
239
|
attr_accessor :images
|
289
|
-
|
290
240
|
# 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`.
|
291
|
-
sig { returns(T::Hash[String, String]) }
|
241
|
+
sig { returns(T.nilable(T::Hash[String, String])) }
|
292
242
|
attr_accessor :metadata
|
293
|
-
|
294
243
|
# The product's name, meant to be displayable to the customer.
|
295
244
|
sig { returns(String) }
|
296
245
|
attr_accessor :name
|
297
|
-
|
298
246
|
# A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
|
299
|
-
sig { returns(String) }
|
247
|
+
sig { returns(T.nilable(String)) }
|
300
248
|
attr_accessor :tax_code
|
301
|
-
|
302
|
-
|
303
|
-
|
304
|
-
|
305
|
-
|
306
|
-
|
249
|
+
sig {
|
250
|
+
params(description: T.nilable(String), images: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), name: String, tax_code: T.nilable(String)).void
|
251
|
+
}
|
252
|
+
def initialize(
|
253
|
+
description: nil,
|
254
|
+
images: nil,
|
255
|
+
metadata: nil,
|
256
|
+
name: nil,
|
257
|
+
tax_code: nil
|
258
|
+
); end
|
307
259
|
end
|
308
260
|
# 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).
|
309
261
|
sig { returns(String) }
|
310
262
|
attr_accessor :currency
|
311
|
-
|
312
|
-
|
313
|
-
sig { returns(String) }
|
263
|
+
# The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
|
264
|
+
sig { returns(T.nilable(String)) }
|
314
265
|
attr_accessor :product
|
315
|
-
|
316
|
-
|
317
|
-
sig { returns(::Stripe::InvoiceLineItem::UpdateParams::PriceData::ProductData) }
|
266
|
+
# Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
|
267
|
+
sig { returns(T.nilable(::Stripe::InvoiceLineItem::UpdateParams::PriceData::ProductData)) }
|
318
268
|
attr_accessor :product_data
|
319
|
-
|
320
269
|
# 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.
|
321
|
-
sig { returns(String) }
|
270
|
+
sig { returns(T.nilable(String)) }
|
322
271
|
attr_accessor :tax_behavior
|
323
|
-
|
324
272
|
# A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
|
325
|
-
sig { returns(Integer) }
|
273
|
+
sig { returns(T.nilable(Integer)) }
|
326
274
|
attr_accessor :unit_amount
|
327
|
-
|
328
275
|
# 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.
|
329
|
-
sig { returns(String) }
|
276
|
+
sig { returns(T.nilable(String)) }
|
330
277
|
attr_accessor :unit_amount_decimal
|
331
|
-
|
332
|
-
|
333
|
-
|
334
|
-
product_data: ::Stripe::InvoiceLineItem::UpdateParams::PriceData::ProductData, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
|
335
|
-
end
|
278
|
+
sig {
|
279
|
+
params(currency: String, product: T.nilable(String), product_data: T.nilable(::Stripe::InvoiceLineItem::UpdateParams::PriceData::ProductData), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
|
280
|
+
}
|
336
281
|
def initialize(
|
337
282
|
currency: nil,
|
338
283
|
product: nil,
|
@@ -342,51 +287,52 @@ module Stripe
|
|
342
287
|
unit_amount_decimal: nil
|
343
288
|
); end
|
344
289
|
end
|
345
|
-
|
290
|
+
class Pricing < Stripe::RequestParams
|
291
|
+
# The ID of the price object.
|
292
|
+
sig { returns(T.nilable(String)) }
|
293
|
+
attr_accessor :price
|
294
|
+
sig { params(price: T.nilable(String)).void }
|
295
|
+
def initialize(price: nil); end
|
296
|
+
end
|
346
297
|
class TaxAmount < Stripe::RequestParams
|
347
298
|
class TaxRateData < Stripe::RequestParams
|
348
299
|
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
349
|
-
sig { returns(String) }
|
300
|
+
sig { returns(T.nilable(String)) }
|
350
301
|
attr_accessor :country
|
351
|
-
|
352
302
|
# An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
|
353
|
-
sig { returns(String) }
|
303
|
+
sig { returns(T.nilable(String)) }
|
354
304
|
attr_accessor :description
|
355
|
-
|
356
305
|
# The display name of the tax rate, which will be shown to users.
|
357
306
|
sig { returns(String) }
|
358
307
|
attr_accessor :display_name
|
359
|
-
|
360
308
|
# This specifies if the tax rate is inclusive or exclusive.
|
361
309
|
sig { returns(T::Boolean) }
|
362
310
|
attr_accessor :inclusive
|
363
|
-
|
364
311
|
# The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
|
365
|
-
sig { returns(String) }
|
312
|
+
sig { returns(T.nilable(String)) }
|
366
313
|
attr_accessor :jurisdiction
|
367
|
-
|
314
|
+
# The level of the jurisdiction that imposes this tax rate.
|
315
|
+
sig { returns(T.nilable(String)) }
|
316
|
+
attr_accessor :jurisdiction_level
|
368
317
|
# 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.
|
369
318
|
sig { returns(Float) }
|
370
319
|
attr_accessor :percentage
|
371
|
-
|
372
320
|
# [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.
|
373
|
-
sig { returns(String) }
|
321
|
+
sig { returns(T.nilable(String)) }
|
374
322
|
attr_accessor :state
|
375
|
-
|
376
323
|
# The high-level tax type, such as `vat` or `sales_tax`.
|
377
|
-
sig { returns(String) }
|
324
|
+
sig { returns(T.nilable(String)) }
|
378
325
|
attr_accessor :tax_type
|
379
|
-
|
380
|
-
|
381
|
-
|
382
|
-
jurisdiction: String, percentage: Float, state: String, tax_type: String).void
|
383
|
-
end
|
326
|
+
sig {
|
327
|
+
params(country: T.nilable(String), description: T.nilable(String), display_name: String, inclusive: T::Boolean, jurisdiction: T.nilable(String), jurisdiction_level: T.nilable(String), percentage: Float, state: T.nilable(String), tax_type: T.nilable(String)).void
|
328
|
+
}
|
384
329
|
def initialize(
|
385
330
|
country: nil,
|
386
331
|
description: nil,
|
387
332
|
display_name: nil,
|
388
333
|
inclusive: nil,
|
389
334
|
jurisdiction: nil,
|
335
|
+
jurisdiction_level: nil,
|
390
336
|
percentage: nil,
|
391
337
|
state: nil,
|
392
338
|
tax_type: nil
|
@@ -395,90 +341,80 @@ module Stripe
|
|
395
341
|
# The amount, in cents (or local equivalent), of the tax.
|
396
342
|
sig { returns(Integer) }
|
397
343
|
attr_accessor :amount
|
398
|
-
|
399
344
|
# Data to find or create a TaxRate object.
|
400
345
|
#
|
401
346
|
# 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.
|
402
347
|
sig { returns(::Stripe::InvoiceLineItem::UpdateParams::TaxAmount::TaxRateData) }
|
403
348
|
attr_accessor :tax_rate_data
|
404
|
-
|
349
|
+
# The reasoning behind this tax, for example, if the product is tax exempt.
|
350
|
+
sig { returns(T.nilable(String)) }
|
351
|
+
attr_accessor :taxability_reason
|
405
352
|
# The amount on which tax is calculated, in cents (or local equivalent).
|
406
353
|
sig { returns(Integer) }
|
407
354
|
attr_accessor :taxable_amount
|
408
|
-
|
409
|
-
|
410
|
-
|
411
|
-
|
412
|
-
|
413
|
-
|
355
|
+
sig {
|
356
|
+
params(amount: Integer, tax_rate_data: ::Stripe::InvoiceLineItem::UpdateParams::TaxAmount::TaxRateData, taxability_reason: T.nilable(String), taxable_amount: Integer).void
|
357
|
+
}
|
358
|
+
def initialize(
|
359
|
+
amount: nil,
|
360
|
+
tax_rate_data: nil,
|
361
|
+
taxability_reason: nil,
|
362
|
+
taxable_amount: nil
|
363
|
+
); end
|
414
364
|
end
|
415
365
|
# 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.
|
416
|
-
sig { returns(Integer) }
|
366
|
+
sig { returns(T.nilable(Integer)) }
|
417
367
|
attr_accessor :amount
|
418
|
-
|
419
368
|
# An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
|
420
|
-
sig { returns(String) }
|
369
|
+
sig { returns(T.nilable(String)) }
|
421
370
|
attr_accessor :description
|
422
|
-
|
423
371
|
# 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.
|
424
|
-
sig { returns(T::Boolean) }
|
372
|
+
sig { returns(T.nilable(T::Boolean)) }
|
425
373
|
attr_accessor :discountable
|
426
|
-
|
427
374
|
# 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.
|
428
|
-
sig {
|
375
|
+
sig {
|
376
|
+
returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItem::UpdateParams::Discount]))))
|
377
|
+
}
|
429
378
|
attr_accessor :discounts
|
430
|
-
|
431
379
|
# Specifies which fields in the response should be expanded.
|
432
|
-
sig { returns(T::Array[String]) }
|
433
|
-
attr_accessor :expand
|
434
|
-
|
435
|
-
# 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.
|
436
380
|
sig { returns(T.nilable(T::Array[String])) }
|
437
|
-
attr_accessor :
|
438
|
-
|
381
|
+
attr_accessor :expand
|
439
382
|
# 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.
|
440
|
-
sig { returns(T.nilable(T::Hash[String, String])) }
|
383
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
|
441
384
|
attr_accessor :metadata
|
442
|
-
|
443
385
|
# 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.
|
444
|
-
sig { returns(::Stripe::InvoiceLineItem::UpdateParams::Period) }
|
386
|
+
sig { returns(T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Period)) }
|
445
387
|
attr_accessor :period
|
446
|
-
|
447
|
-
|
448
|
-
sig { returns(String) }
|
449
|
-
attr_accessor :price
|
450
|
-
|
451
|
-
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
|
452
|
-
sig { returns(::Stripe::InvoiceLineItem::UpdateParams::PriceData) }
|
388
|
+
# Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
|
389
|
+
sig { returns(T.nilable(::Stripe::InvoiceLineItem::UpdateParams::PriceData)) }
|
453
390
|
attr_accessor :price_data
|
454
|
-
|
391
|
+
# The pricing information for the invoice item.
|
392
|
+
sig { returns(T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Pricing)) }
|
393
|
+
attr_accessor :pricing
|
455
394
|
# Non-negative integer. The quantity of units for the line item.
|
456
|
-
sig { returns(Integer) }
|
395
|
+
sig { returns(T.nilable(Integer)) }
|
457
396
|
attr_accessor :quantity
|
458
|
-
|
459
397
|
# 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.
|
460
|
-
sig {
|
398
|
+
sig {
|
399
|
+
returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItem::UpdateParams::TaxAmount]))))
|
400
|
+
}
|
461
401
|
attr_accessor :tax_amounts
|
462
|
-
|
463
402
|
# 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.
|
464
|
-
sig { returns(T.nilable(T::Array[String])) }
|
403
|
+
sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
|
465
404
|
attr_accessor :tax_rates
|
466
|
-
|
467
|
-
|
468
|
-
|
469
|
-
discounts: T.nilable(T::Array[::Stripe::InvoiceLineItem::UpdateParams::Discount]), expand: T::Array[String], margins: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), period: ::Stripe::InvoiceLineItem::UpdateParams::Period, price: String, price_data: ::Stripe::InvoiceLineItem::UpdateParams::PriceData, quantity: Integer, tax_amounts: T.nilable(T::Array[::Stripe::InvoiceLineItem::UpdateParams::TaxAmount]), tax_rates: T.nilable(T::Array[String])).void
|
470
|
-
end
|
405
|
+
sig {
|
406
|
+
params(amount: T.nilable(Integer), description: T.nilable(String), discountable: T.nilable(T::Boolean), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItem::UpdateParams::Discount]))), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), period: T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Period), price_data: T.nilable(::Stripe::InvoiceLineItem::UpdateParams::PriceData), pricing: T.nilable(::Stripe::InvoiceLineItem::UpdateParams::Pricing), quantity: T.nilable(Integer), tax_amounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::InvoiceLineItem::UpdateParams::TaxAmount]))), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void
|
407
|
+
}
|
471
408
|
def initialize(
|
472
409
|
amount: nil,
|
473
410
|
description: nil,
|
474
411
|
discountable: nil,
|
475
412
|
discounts: nil,
|
476
413
|
expand: nil,
|
477
|
-
margins: nil,
|
478
414
|
metadata: nil,
|
479
415
|
period: nil,
|
480
|
-
price: nil,
|
481
416
|
price_data: nil,
|
417
|
+
pricing: nil,
|
482
418
|
quantity: nil,
|
483
419
|
tax_amounts: nil,
|
484
420
|
tax_rates: nil
|
@@ -488,10 +424,9 @@ module Stripe
|
|
488
424
|
# so they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice
|
489
425
|
# item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.
|
490
426
|
# Updating an invoice's line item is only possible before the invoice is finalized.
|
491
|
-
sig
|
492
|
-
params(invoice: String, line_item_id: String,
|
493
|
-
|
494
|
-
end
|
427
|
+
sig {
|
428
|
+
params(invoice: String, line_item_id: String, params: T.any(::Stripe::InvoiceLineItem::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::InvoiceLineItem)
|
429
|
+
}
|
495
430
|
def self.update(invoice, line_item_id, params = {}, opts = {}); end
|
496
431
|
end
|
497
|
-
end
|
432
|
+
end
|