stripe 19.4.0.pre.alpha.2 → 19.4.0.pre.alpha.4
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/lib/stripe/api_requestor.rb +2 -27
- data/lib/stripe/api_version.rb +1 -1
- data/lib/stripe/error_object.rb +48 -19
- data/lib/stripe/event_types.rb +15 -0
- data/lib/stripe/events/v2_billing_contract_activated_event.rb +44 -0
- data/lib/stripe/events/v2_billing_contract_canceled_event.rb +44 -0
- data/lib/stripe/events/v2_billing_contract_created_event.rb +44 -0
- data/lib/stripe/events/v2_billing_contract_ended_event.rb +44 -0
- data/lib/stripe/events/v2_billing_contract_updated_event.rb +44 -0
- data/lib/stripe/object_types.rb +0 -1
- data/lib/stripe/params/account_create_params.rb +2 -0
- data/lib/stripe/params/account_person_create_params.rb +6 -0
- data/lib/stripe/params/account_person_update_params.rb +6 -0
- data/lib/stripe/params/account_session_create_params.rb +0 -42
- data/lib/stripe/params/account_update_params.rb +2 -0
- data/lib/stripe/params/billing_portal/configuration_create_params.rb +1 -1
- data/lib/stripe/params/billing_portal/configuration_update_params.rb +1 -1
- data/lib/stripe/params/capital/financing_transaction_list_params.rb +2 -2
- data/lib/stripe/params/checkout/session_create_params.rb +1 -1
- data/lib/stripe/params/invoice_create_preview_params.rb +2 -2
- data/lib/stripe/params/issuing/authorization_capture_params.rb +1 -1
- data/lib/stripe/params/issuing/authorization_create_params.rb +1 -1
- data/lib/stripe/params/issuing/authorization_finalize_amount_params.rb +1 -1
- data/lib/stripe/params/issuing/transaction_create_force_capture_params.rb +1 -1
- data/lib/stripe/params/issuing/transaction_create_unlinked_refund_params.rb +1 -1
- data/lib/stripe/params/payment_intent_confirm_params.rb +10 -1
- data/lib/stripe/params/payment_intent_create_params.rb +10 -1
- data/lib/stripe/params/payment_intent_update_params.rb +10 -1
- data/lib/stripe/params/payment_record_create_params.rb +109 -0
- data/lib/stripe/params/promotion_code_create_params.rb +1 -1
- data/lib/stripe/params/promotion_code_update_params.rb +1 -1
- data/lib/stripe/params/refund_create_params.rb +4 -0
- data/lib/stripe/params/subscription_schedule_create_params.rb +138 -2
- data/lib/stripe/params/subscription_schedule_list_params.rb +1 -1
- data/lib/stripe/params/subscription_schedule_update_params.rb +139 -3
- data/lib/stripe/params/terminal/reader_activate_gift_card_params.rb +35 -0
- data/lib/stripe/params/terminal/reader_cashout_gift_card_params.rb +21 -0
- data/lib/stripe/params/terminal/reader_check_gift_card_balance_params.rb +21 -0
- data/lib/stripe/params/terminal/reader_collect_payment_method_params.rb +4 -0
- data/lib/stripe/params/terminal/reader_process_payment_intent_params.rb +4 -0
- data/lib/stripe/params/terminal/reader_reload_gift_card_params.rb +27 -0
- data/lib/stripe/params/test_helpers/issuing/authorization_capture_params.rb +1 -1
- data/lib/stripe/params/test_helpers/issuing/authorization_create_params.rb +1 -1
- data/lib/stripe/params/test_helpers/issuing/authorization_finalize_amount_params.rb +1 -1
- data/lib/stripe/params/test_helpers/issuing/transaction_create_force_capture_params.rb +1 -1
- data/lib/stripe/params/test_helpers/issuing/transaction_create_unlinked_refund_params.rb +1 -1
- data/lib/stripe/params/token_create_params.rb +8 -0
- data/lib/stripe/params/v2/billing/contract_cancel_params.rb +1 -1
- data/lib/stripe/params/v2/billing/contract_create_params.rb +13 -175
- data/lib/stripe/params/v2/billing/contract_list_params.rb +1 -1
- data/lib/stripe/params/v2/billing/contract_update_params.rb +48 -495
- data/lib/stripe/params/v2/core/account_list_params.rb +9 -1
- data/lib/stripe/params/v2/data/analytics/metric_query_create_params.rb +2 -2
- data/lib/stripe/params.rb +10 -8
- data/lib/stripe/resources/account.rb +55 -3
- data/lib/stripe/resources/account_session.rb +8 -0
- data/lib/stripe/resources/balance_transaction.rb +1 -1
- data/lib/stripe/resources/bank_account.rb +2 -2
- data/lib/stripe/resources/billing/alert_recovered.rb +17 -1
- data/lib/stripe/resources/billing_portal/configuration.rb +1 -1
- data/lib/stripe/resources/capability.rb +2 -2
- data/lib/stripe/resources/capital/financing_transaction.rb +1 -1
- data/lib/stripe/resources/charge.rb +1 -1
- data/lib/stripe/resources/checkout/session.rb +23 -5
- data/lib/stripe/resources/confirmation_token.rb +1 -1
- data/lib/stripe/resources/dispute.rb +4 -2
- data/lib/stripe/resources/financial_connections/session.rb +5 -0
- data/lib/stripe/resources/invoice.rb +4 -1
- data/lib/stripe/resources/issuing/authorization.rb +52 -1
- data/lib/stripe/resources/issuing/card.rb +2 -0
- data/lib/stripe/resources/issuing/transaction.rb +48 -2
- data/lib/stripe/resources/order.rb +1 -1
- data/lib/stripe/resources/payment_attempt_record.rb +2 -2
- data/lib/stripe/resources/payment_intent.rb +28 -0
- data/lib/stripe/resources/payment_method.rb +3 -3
- data/lib/stripe/resources/payment_record.rb +14 -2
- data/lib/stripe/resources/person.rb +2 -2
- data/lib/stripe/resources/profile.rb +14 -14
- data/lib/stripe/resources/quote.rb +22 -1
- data/lib/stripe/resources/quote_preview_invoice.rb +4 -1
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +169 -2
- data/lib/stripe/resources/setup_attempt.rb +16 -0
- data/lib/stripe/resources/setup_intent.rb +3 -0
- data/lib/stripe/resources/shared_payment/granted_token.rb +1 -1
- data/lib/stripe/resources/shared_payment/issued_token.rb +18 -1
- data/lib/stripe/resources/subscription_schedule.rb +169 -2
- data/lib/stripe/resources/tax/calculation.rb +1 -1
- data/lib/stripe/resources/tax/registration.rb +32 -0
- data/lib/stripe/resources/tax/transaction.rb +1 -1
- data/lib/stripe/resources/terminal/reader.rb +173 -0
- data/lib/stripe/resources/v2/billing/contract.rb +47 -330
- data/lib/stripe/resources/v2/billing/contract_pricing_line_quantity_change.rb +2 -2
- data/lib/stripe/resources/v2/core/account.rb +18 -0
- data/lib/stripe/resources/v2/money_management/payout_method.rb +16 -0
- data/lib/stripe/resources/v2/money_management/received_credit.rb +30 -0
- data/lib/stripe/resources/v2/signals/account_signal.rb +4 -1
- data/lib/stripe/resources.rb +15 -2
- data/lib/stripe/services/account_person_service.rb +1 -1
- data/lib/stripe/services/account_service.rb +1 -1
- data/lib/stripe/services/dispute_service.rb +1 -1
- data/lib/stripe/services/payment_method_service.rb +1 -1
- data/lib/stripe/services/payment_record_service.rb +12 -0
- data/lib/stripe/services/terminal/reader_service.rb +44 -0
- data/lib/stripe/services/v1_services.rb +1 -2
- data/lib/stripe/services/v2/billing/contract_service.rb +7 -7
- data/lib/stripe/services/v2/signals/account_signal_service.rb +1 -1
- data/lib/stripe/services.rb +0 -2
- data/lib/stripe/stripe_event_notification_handler.rb +30 -0
- data/lib/stripe/telemetry_id.rb +65 -0
- data/lib/stripe/version.rb +1 -1
- data/lib/stripe.rb +2 -0
- data/rbi/stripe.rbi +2023 -1531
- metadata +13 -8
- data/lib/stripe/params/fr_meal_vouchers_onboarding_create_params.rb +0 -25
- data/lib/stripe/params/fr_meal_vouchers_onboarding_list_params.rb +0 -22
- data/lib/stripe/params/fr_meal_vouchers_onboarding_retrieve_params.rb +0 -13
- data/lib/stripe/params/fr_meal_vouchers_onboarding_update_params.rb +0 -16
- data/lib/stripe/resources/fr_meal_vouchers_onboarding.rb +0 -153
- data/lib/stripe/services/fr_meal_vouchers_onboarding_service.rb +0 -57
|
@@ -146,6 +146,8 @@ module Stripe
|
|
|
146
146
|
attr_reader :address
|
|
147
147
|
# Address validation details for the shipment.
|
|
148
148
|
attr_reader :address_validation
|
|
149
|
+
# The name of the business at the shipping address, used on the shipping label to ensure delivery when the card is shipped to a cardholder's workplace.
|
|
150
|
+
attr_reader :business_name
|
|
149
151
|
# The delivery company that shipped a card.
|
|
150
152
|
attr_reader :carrier
|
|
151
153
|
# Additional information that may be required for clearing customs.
|
|
@@ -185,17 +185,43 @@ module Stripe
|
|
|
185
185
|
end
|
|
186
186
|
|
|
187
187
|
class NetworkData < ::Stripe::StripeObject
|
|
188
|
+
class TraceId < ::Stripe::StripeObject
|
|
189
|
+
# The unique reference number within the specified financial network on the specified network date.
|
|
190
|
+
attr_reader :banknet_reference_number
|
|
191
|
+
# The identifier of the program or service.
|
|
192
|
+
attr_reader :financial_network_code
|
|
193
|
+
# The card network's record date for this transaction.
|
|
194
|
+
attr_reader :network_date
|
|
195
|
+
|
|
196
|
+
def self.inner_class_types
|
|
197
|
+
@inner_class_types = {}
|
|
198
|
+
end
|
|
199
|
+
|
|
200
|
+
def self.field_remappings
|
|
201
|
+
@field_remappings = {}
|
|
202
|
+
end
|
|
203
|
+
end
|
|
188
204
|
# The network-provided acquirer reference number for this transaction, if available. Use this value for downstream operational workflows such as filing disputes with the card network.
|
|
189
205
|
attr_reader :acquirer_reference_number
|
|
206
|
+
# The two-letter country code of the acquirer ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
|
207
|
+
attr_reader :acquiring_institution_country
|
|
208
|
+
# Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be null.
|
|
209
|
+
attr_reader :acquiring_institution_id
|
|
190
210
|
# A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations.
|
|
191
211
|
attr_reader :authorization_code
|
|
192
212
|
# The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.
|
|
193
213
|
attr_reader :processing_date
|
|
214
|
+
# Identifier assigned by the acquirer to track all messages related to this transaction.
|
|
215
|
+
attr_reader :retrieval_reference_number
|
|
216
|
+
# The card network over which Stripe received the transaction. This field may differ from the associated card’s primary network.
|
|
217
|
+
attr_reader :routed_network
|
|
218
|
+
# Mastercard identifier assigned by the card network for the transaction.
|
|
219
|
+
attr_reader :trace_id
|
|
194
220
|
# Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.
|
|
195
221
|
attr_reader :transaction_id
|
|
196
222
|
|
|
197
223
|
def self.inner_class_types
|
|
198
|
-
@inner_class_types = {}
|
|
224
|
+
@inner_class_types = { trace_id: TraceId }
|
|
199
225
|
end
|
|
200
226
|
|
|
201
227
|
def self.field_remappings
|
|
@@ -228,7 +254,7 @@ module Stripe
|
|
|
228
254
|
|
|
229
255
|
class ReportedBreakdown < ::Stripe::StripeObject
|
|
230
256
|
class Fuel < ::Stripe::StripeObject
|
|
231
|
-
# Gross fuel amount that should equal Fuel Volume
|
|
257
|
+
# Gross fuel amount that should equal Fuel Volume multiplied by Fuel Unit Cost, inclusive of taxes.
|
|
232
258
|
attr_reader :gross_amount_decimal
|
|
233
259
|
|
|
234
260
|
def self.inner_class_types
|
|
@@ -524,6 +550,23 @@ module Stripe
|
|
|
524
550
|
end
|
|
525
551
|
end
|
|
526
552
|
|
|
553
|
+
class SettlementDetails < ::Stripe::StripeObject
|
|
554
|
+
# `merchant_amount` in the settlement currency.
|
|
555
|
+
attr_reader :amount
|
|
556
|
+
# Settlement currency.
|
|
557
|
+
attr_reader :currency
|
|
558
|
+
# Exchange rate used by the network to convert the `merchant_amount` to `settlement_details.amount`. The `merchant_amount` multiplied with this rate will equal to the `settlement_details.amount`.
|
|
559
|
+
attr_reader :exchange_rate
|
|
560
|
+
|
|
561
|
+
def self.inner_class_types
|
|
562
|
+
@inner_class_types = {}
|
|
563
|
+
end
|
|
564
|
+
|
|
565
|
+
def self.field_remappings
|
|
566
|
+
@field_remappings = {}
|
|
567
|
+
end
|
|
568
|
+
end
|
|
569
|
+
|
|
527
570
|
class Treasury < ::Stripe::StripeObject
|
|
528
571
|
# The Treasury [ReceivedCredit](https://docs.stripe.com/api/treasury/received_credits) representing this Issuing transaction if it is a refund
|
|
529
572
|
attr_reader :received_credit
|
|
@@ -582,6 +625,8 @@ module Stripe
|
|
|
582
625
|
attr_reader :redaction
|
|
583
626
|
# The ID of the [settlement](https://docs.stripe.com/api/issuing/settlements) to which this transaction belongs.
|
|
584
627
|
attr_reader :settlement
|
|
628
|
+
# Details about the transaction for settlement reconciliation.
|
|
629
|
+
attr_reader :settlement_details
|
|
585
630
|
# [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null.
|
|
586
631
|
attr_reader :token
|
|
587
632
|
# [Treasury](https://docs.stripe.com/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts
|
|
@@ -670,6 +715,7 @@ module Stripe
|
|
|
670
715
|
network_data: NetworkData,
|
|
671
716
|
purchase_details: PurchaseDetails,
|
|
672
717
|
redaction: Redaction,
|
|
718
|
+
settlement_details: SettlementDetails,
|
|
673
719
|
treasury: Treasury,
|
|
674
720
|
}
|
|
675
721
|
end
|
|
@@ -722,7 +722,7 @@ module Stripe
|
|
|
722
722
|
|
|
723
723
|
class TaxDetails < ::Stripe::StripeObject
|
|
724
724
|
class TaxId < ::Stripe::StripeObject
|
|
725
|
-
# The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `it_cf`, `fo_vat`, `gi_tin`, `py_ruc`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`
|
|
725
|
+
# The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `it_cf`, `fo_vat`, `gi_tin`, `py_ruc`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, `ic_nif`, or `unknown`
|
|
726
726
|
attr_reader :type
|
|
727
727
|
# The value of the tax ID.
|
|
728
728
|
attr_reader :value
|
|
@@ -285,7 +285,7 @@ module Stripe
|
|
|
285
285
|
class AmazonPay < ::Stripe::StripeObject
|
|
286
286
|
class Funding < ::Stripe::StripeObject
|
|
287
287
|
class Card < ::Stripe::StripeObject
|
|
288
|
-
# Card brand. Can be `
|
|
288
|
+
# Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
|
|
289
289
|
attr_reader :brand
|
|
290
290
|
# The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
|
|
291
291
|
attr_reader :brand_product
|
|
@@ -932,7 +932,7 @@ module Stripe
|
|
|
932
932
|
class Fpx < ::Stripe::StripeObject
|
|
933
933
|
# Account holder type, if provided. Can be one of `individual` or `company`.
|
|
934
934
|
attr_reader :account_holder_type
|
|
935
|
-
# The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.
|
|
935
|
+
# The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bnp_paribas`, `bank_rakyat`, `bsn`, `cimb`, `citibank`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `mbsb_bank`, `pb_enterprise`, or `bank_of_china`.
|
|
936
936
|
attr_reader :bank
|
|
937
937
|
# Unique transaction id generated by FPX for every request from the merchant
|
|
938
938
|
attr_reader :transaction_id
|
|
@@ -365,6 +365,9 @@ module Stripe
|
|
|
365
365
|
attr_reader :decline_code
|
|
366
366
|
# A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported.
|
|
367
367
|
attr_reader :doc_url
|
|
368
|
+
# A GiftCardOperation represents an operation performed on a third-party gift card,
|
|
369
|
+
# such as activation, reload, cashout, balance check, or void.
|
|
370
|
+
attr_reader :gift_card_operation
|
|
368
371
|
# A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
|
|
369
372
|
attr_reader :message
|
|
370
373
|
# For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
|
|
@@ -4288,6 +4291,14 @@ module Stripe
|
|
|
4288
4291
|
class Payco < ::Stripe::StripeObject
|
|
4289
4292
|
# Controls when the funds will be captured from the customer's account.
|
|
4290
4293
|
attr_reader :capture_method
|
|
4294
|
+
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
4295
|
+
#
|
|
4296
|
+
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
4297
|
+
#
|
|
4298
|
+
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
4299
|
+
#
|
|
4300
|
+
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
|
4301
|
+
attr_reader :setup_future_usage
|
|
4291
4302
|
|
|
4292
4303
|
def self.inner_class_types
|
|
4293
4304
|
@inner_class_types = {}
|
|
@@ -4389,6 +4400,15 @@ module Stripe
|
|
|
4389
4400
|
end
|
|
4390
4401
|
|
|
4391
4402
|
class Paypay < ::Stripe::StripeObject
|
|
4403
|
+
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
4404
|
+
#
|
|
4405
|
+
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
4406
|
+
#
|
|
4407
|
+
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
4408
|
+
#
|
|
4409
|
+
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
|
4410
|
+
attr_reader :setup_future_usage
|
|
4411
|
+
|
|
4392
4412
|
def self.inner_class_types
|
|
4393
4413
|
@inner_class_types = {}
|
|
4394
4414
|
end
|
|
@@ -4566,6 +4586,14 @@ module Stripe
|
|
|
4566
4586
|
class SamsungPay < ::Stripe::StripeObject
|
|
4567
4587
|
# Controls when the funds will be captured from the customer's account.
|
|
4568
4588
|
attr_reader :capture_method
|
|
4589
|
+
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
|
4590
|
+
#
|
|
4591
|
+
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
|
4592
|
+
#
|
|
4593
|
+
# If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
|
|
4594
|
+
#
|
|
4595
|
+
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
|
4596
|
+
attr_reader :setup_future_usage
|
|
4569
4597
|
|
|
4570
4598
|
def self.inner_class_types
|
|
4571
4599
|
@inner_class_types = {}
|
|
@@ -927,7 +927,7 @@ module Stripe
|
|
|
927
927
|
class Fpx < ::Stripe::StripeObject
|
|
928
928
|
# Account holder type, if provided. Can be one of `individual` or `company`.
|
|
929
929
|
attr_reader :account_holder_type
|
|
930
|
-
# The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.
|
|
930
|
+
# The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bnp_paribas`, `bank_rakyat`, `bsn`, `cimb`, `citibank`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `mbsb_bank`, `pb_enterprise`, or `bank_of_china`.
|
|
931
931
|
attr_reader :bank
|
|
932
932
|
|
|
933
933
|
def self.inner_class_types
|
|
@@ -1908,7 +1908,7 @@ module Stripe
|
|
|
1908
1908
|
request_stripe_object(method: :post, path: "/v1/payment_methods", params: params, opts: opts)
|
|
1909
1909
|
end
|
|
1910
1910
|
|
|
1911
|
-
# Detaches a PaymentMethod object from a Customer.
|
|
1911
|
+
# Detaches a PaymentMethod object from a Customer. Detachment is permanent and irreversible — once detached, a PaymentMethod can no longer be used for payments or re-attached to a Customer.
|
|
1912
1912
|
def detach(params = {}, opts = {})
|
|
1913
1913
|
request_stripe_object(
|
|
1914
1914
|
method: :post,
|
|
@@ -1918,7 +1918,7 @@ module Stripe
|
|
|
1918
1918
|
)
|
|
1919
1919
|
end
|
|
1920
1920
|
|
|
1921
|
-
# Detaches a PaymentMethod object from a Customer.
|
|
1921
|
+
# Detaches a PaymentMethod object from a Customer. Detachment is permanent and irreversible — once detached, a PaymentMethod can no longer be used for payments or re-attached to a Customer.
|
|
1922
1922
|
def self.detach(payment_method, params = {}, opts = {})
|
|
1923
1923
|
request_stripe_object(
|
|
1924
1924
|
method: :post,
|
|
@@ -7,6 +7,7 @@ module Stripe
|
|
|
7
7
|
# in order to mark an Invoice as paid and a Subscription as active. Payment Records consist of one or
|
|
8
8
|
# more Payment Attempt Records, which represent individual attempts made on a payment network.
|
|
9
9
|
class PaymentRecord < APIResource
|
|
10
|
+
extend Stripe::APIOperations::Create
|
|
10
11
|
extend Stripe::APIOperations::Search
|
|
11
12
|
|
|
12
13
|
OBJECT_NAME = "payment_record"
|
|
@@ -285,7 +286,7 @@ module Stripe
|
|
|
285
286
|
class AmazonPay < ::Stripe::StripeObject
|
|
286
287
|
class Funding < ::Stripe::StripeObject
|
|
287
288
|
class Card < ::Stripe::StripeObject
|
|
288
|
-
# Card brand. Can be `
|
|
289
|
+
# Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
|
|
289
290
|
attr_reader :brand
|
|
290
291
|
# The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
|
|
291
292
|
attr_reader :brand_product
|
|
@@ -932,7 +933,7 @@ module Stripe
|
|
|
932
933
|
class Fpx < ::Stripe::StripeObject
|
|
933
934
|
# Account holder type, if provided. Can be one of `individual` or `company`.
|
|
934
935
|
attr_reader :account_holder_type
|
|
935
|
-
# The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.
|
|
936
|
+
# The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bnp_paribas`, `bank_rakyat`, `bsn`, `cimb`, `citibank`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `mbsb_bank`, `pb_enterprise`, or `bank_of_china`.
|
|
936
937
|
attr_reader :bank
|
|
937
938
|
# Unique transaction id generated by FPX for every request from the merchant
|
|
938
939
|
attr_reader :transaction_id
|
|
@@ -2359,6 +2360,17 @@ module Stripe
|
|
|
2359
2360
|
# Shipping information for this payment.
|
|
2360
2361
|
attr_reader :shipping_details
|
|
2361
2362
|
|
|
2363
|
+
# Report that the most recent payment attempt on the specified Payment Record
|
|
2364
|
+
# was disputed.
|
|
2365
|
+
def self.create(id, params = {}, opts = {})
|
|
2366
|
+
request_stripe_object(
|
|
2367
|
+
method: :post,
|
|
2368
|
+
path: format("/v1/payment_records/%<id>s/report_dispute", { id: CGI.escape(id) }),
|
|
2369
|
+
params: params,
|
|
2370
|
+
opts: opts
|
|
2371
|
+
)
|
|
2372
|
+
end
|
|
2373
|
+
|
|
2362
2374
|
# Report a new Payment Record. You may report a Payment Record as it is
|
|
2363
2375
|
# initialized and later report updates through the other report_* methods, or report Payment
|
|
2364
2376
|
# Records in a terminal state directly, through this method.
|
|
@@ -193,7 +193,7 @@ module Stripe
|
|
|
193
193
|
attr_reader :alternatives
|
|
194
194
|
# Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition.
|
|
195
195
|
attr_reader :currently_due
|
|
196
|
-
#
|
|
196
|
+
# Fields that are `currently_due` and need to be collected again because validation or verification failed.
|
|
197
197
|
attr_reader :errors
|
|
198
198
|
# Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set.
|
|
199
199
|
attr_reader :eventually_due
|
|
@@ -297,7 +297,7 @@ module Stripe
|
|
|
297
297
|
attr_reader :alternatives
|
|
298
298
|
# Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled.
|
|
299
299
|
attr_reader :currently_due
|
|
300
|
-
#
|
|
300
|
+
# Fields that are `currently_due` and need to be collected again because validation or verification failed.
|
|
301
301
|
attr_reader :errors
|
|
302
302
|
# Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set.
|
|
303
303
|
attr_reader :eventually_due
|
|
@@ -11,7 +11,7 @@ module Stripe
|
|
|
11
11
|
|
|
12
12
|
class Branding < ::Stripe::StripeObject
|
|
13
13
|
class Icon < ::Stripe::StripeObject
|
|
14
|
-
#
|
|
14
|
+
# The original image.
|
|
15
15
|
attr_reader :original
|
|
16
16
|
|
|
17
17
|
def self.inner_class_types
|
|
@@ -24,7 +24,7 @@ module Stripe
|
|
|
24
24
|
end
|
|
25
25
|
|
|
26
26
|
class Logo < ::Stripe::StripeObject
|
|
27
|
-
#
|
|
27
|
+
# The original image.
|
|
28
28
|
attr_reader :original
|
|
29
29
|
|
|
30
30
|
def self.inner_class_types
|
|
@@ -35,13 +35,13 @@ module Stripe
|
|
|
35
35
|
@field_remappings = {}
|
|
36
36
|
end
|
|
37
37
|
end
|
|
38
|
-
#
|
|
38
|
+
# Profile icon image.
|
|
39
39
|
attr_reader :icon
|
|
40
|
-
#
|
|
40
|
+
# Profile logo image.
|
|
41
41
|
attr_reader :logo
|
|
42
|
-
#
|
|
42
|
+
# The primary brand color for the profile.
|
|
43
43
|
attr_reader :primary_color
|
|
44
|
-
#
|
|
44
|
+
# The secondary brand color for the profile.
|
|
45
45
|
attr_reader :secondary_color
|
|
46
46
|
|
|
47
47
|
def self.inner_class_types
|
|
@@ -52,21 +52,21 @@ module Stripe
|
|
|
52
52
|
@field_remappings = {}
|
|
53
53
|
end
|
|
54
54
|
end
|
|
55
|
-
#
|
|
55
|
+
# Branding information for the Stripe profile.
|
|
56
56
|
attr_reader :branding
|
|
57
|
-
#
|
|
57
|
+
# A description of the business or entity represented by the Stripe profile.
|
|
58
58
|
attr_reader :description
|
|
59
|
-
#
|
|
59
|
+
# The display name shown for the Stripe profile.
|
|
60
60
|
attr_reader :display_name
|
|
61
|
-
#
|
|
61
|
+
# Unique identifier for the Stripe profile.
|
|
62
62
|
attr_reader :id
|
|
63
|
-
#
|
|
63
|
+
# If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
|
|
64
64
|
attr_reader :livemode
|
|
65
|
-
#
|
|
65
|
+
# String representing the object's type. Objects of the same type share the same value.
|
|
66
66
|
attr_reader :object
|
|
67
|
-
#
|
|
67
|
+
# The external website URL associated with the Stripe profile.
|
|
68
68
|
attr_reader :url
|
|
69
|
-
#
|
|
69
|
+
# The unique username for the Stripe profile.
|
|
70
70
|
attr_reader :username
|
|
71
71
|
|
|
72
72
|
def self.inner_class_types
|
|
@@ -300,6 +300,21 @@ module Stripe
|
|
|
300
300
|
end
|
|
301
301
|
|
|
302
302
|
class InvoiceSettings < ::Stripe::StripeObject
|
|
303
|
+
class CustomField < ::Stripe::StripeObject
|
|
304
|
+
# The name of the custom field.
|
|
305
|
+
attr_reader :name
|
|
306
|
+
# The value of the custom field.
|
|
307
|
+
attr_reader :value
|
|
308
|
+
|
|
309
|
+
def self.inner_class_types
|
|
310
|
+
@inner_class_types = {}
|
|
311
|
+
end
|
|
312
|
+
|
|
313
|
+
def self.field_remappings
|
|
314
|
+
@field_remappings = {}
|
|
315
|
+
end
|
|
316
|
+
end
|
|
317
|
+
|
|
303
318
|
class Issuer < ::Stripe::StripeObject
|
|
304
319
|
# The connected account being referenced when `type` is `account`.
|
|
305
320
|
attr_reader :account
|
|
@@ -314,13 +329,19 @@ module Stripe
|
|
|
314
329
|
@field_remappings = {}
|
|
315
330
|
end
|
|
316
331
|
end
|
|
332
|
+
# A list of up to 4 custom fields to be displayed on the invoice.
|
|
333
|
+
attr_reader :custom_fields
|
|
317
334
|
# Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.
|
|
318
335
|
attr_reader :days_until_due
|
|
336
|
+
# An arbitrary string attached to the object. Often useful for displaying to users.
|
|
337
|
+
attr_reader :description
|
|
338
|
+
# Footer to be displayed on the invoice.
|
|
339
|
+
attr_reader :footer
|
|
319
340
|
# Attribute for field issuer
|
|
320
341
|
attr_reader :issuer
|
|
321
342
|
|
|
322
343
|
def self.inner_class_types
|
|
323
|
-
@inner_class_types = { issuer: Issuer }
|
|
344
|
+
@inner_class_types = { custom_fields: CustomField, issuer: Issuer }
|
|
324
345
|
end
|
|
325
346
|
|
|
326
347
|
def self.field_remappings
|
|
@@ -216,7 +216,7 @@ module Stripe
|
|
|
216
216
|
end
|
|
217
217
|
|
|
218
218
|
class CustomerTaxId < ::Stripe::StripeObject
|
|
219
|
-
# The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `it_cf`, `fo_vat`, `gi_tin`, `py_ruc`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`
|
|
219
|
+
# The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `it_cf`, `fo_vat`, `gi_tin`, `py_ruc`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, `ic_nif`, or `unknown`
|
|
220
220
|
attr_reader :type
|
|
221
221
|
# The value of the tax ID.
|
|
222
222
|
attr_reader :value
|
|
@@ -271,6 +271,9 @@ module Stripe
|
|
|
271
271
|
attr_reader :decline_code
|
|
272
272
|
# A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported.
|
|
273
273
|
attr_reader :doc_url
|
|
274
|
+
# A GiftCardOperation represents an operation performed on a third-party gift card,
|
|
275
|
+
# such as activation, reload, cashout, balance check, or void.
|
|
276
|
+
attr_reader :gift_card_operation
|
|
274
277
|
# A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
|
|
275
278
|
attr_reader :message
|
|
276
279
|
# For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
|
|
@@ -181,6 +181,21 @@ module Stripe
|
|
|
181
181
|
end
|
|
182
182
|
|
|
183
183
|
class InvoiceSettings < ::Stripe::StripeObject
|
|
184
|
+
class CustomField < ::Stripe::StripeObject
|
|
185
|
+
# The name of the custom field.
|
|
186
|
+
attr_reader :name
|
|
187
|
+
# The value of the custom field.
|
|
188
|
+
attr_reader :value
|
|
189
|
+
|
|
190
|
+
def self.inner_class_types
|
|
191
|
+
@inner_class_types = {}
|
|
192
|
+
end
|
|
193
|
+
|
|
194
|
+
def self.field_remappings
|
|
195
|
+
@field_remappings = {}
|
|
196
|
+
end
|
|
197
|
+
end
|
|
198
|
+
|
|
184
199
|
class Issuer < ::Stripe::StripeObject
|
|
185
200
|
# The connected account being referenced when `type` is `account`.
|
|
186
201
|
attr_reader :account
|
|
@@ -197,13 +212,19 @@ module Stripe
|
|
|
197
212
|
end
|
|
198
213
|
# The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
|
|
199
214
|
attr_reader :account_tax_ids
|
|
215
|
+
# A list of up to 4 custom fields to be displayed on the invoice.
|
|
216
|
+
attr_reader :custom_fields
|
|
200
217
|
# 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`.
|
|
201
218
|
attr_reader :days_until_due
|
|
219
|
+
# An arbitrary string attached to the object. Often useful for displaying to users.
|
|
220
|
+
attr_reader :description
|
|
221
|
+
# Footer to be displayed on the invoice.
|
|
222
|
+
attr_reader :footer
|
|
202
223
|
# Attribute for field issuer
|
|
203
224
|
attr_reader :issuer
|
|
204
225
|
|
|
205
226
|
def self.inner_class_types
|
|
206
|
-
@inner_class_types = { issuer: Issuer }
|
|
227
|
+
@inner_class_types = { custom_fields: CustomField, issuer: Issuer }
|
|
207
228
|
end
|
|
208
229
|
|
|
209
230
|
def self.field_remappings
|
|
@@ -293,6 +314,126 @@ module Stripe
|
|
|
293
314
|
end
|
|
294
315
|
end
|
|
295
316
|
|
|
317
|
+
class PauseSchedule < ::Stripe::StripeObject
|
|
318
|
+
class Pause < ::Stripe::StripeObject
|
|
319
|
+
class Settings < ::Stripe::StripeObject
|
|
320
|
+
class BillFor < ::Stripe::StripeObject
|
|
321
|
+
class OutstandingUsageThrough < ::Stripe::StripeObject
|
|
322
|
+
# The type of outstanding usage billing behavior.
|
|
323
|
+
attr_reader :type
|
|
324
|
+
|
|
325
|
+
def self.inner_class_types
|
|
326
|
+
@inner_class_types = {}
|
|
327
|
+
end
|
|
328
|
+
|
|
329
|
+
def self.field_remappings
|
|
330
|
+
@field_remappings = {}
|
|
331
|
+
end
|
|
332
|
+
end
|
|
333
|
+
|
|
334
|
+
class UnusedTimeFrom < ::Stripe::StripeObject
|
|
335
|
+
# The type of unused time credit behavior.
|
|
336
|
+
attr_reader :type
|
|
337
|
+
|
|
338
|
+
def self.inner_class_types
|
|
339
|
+
@inner_class_types = {}
|
|
340
|
+
end
|
|
341
|
+
|
|
342
|
+
def self.field_remappings
|
|
343
|
+
@field_remappings = {}
|
|
344
|
+
end
|
|
345
|
+
end
|
|
346
|
+
# Attribute for field outstanding_usage_through
|
|
347
|
+
attr_reader :outstanding_usage_through
|
|
348
|
+
# Attribute for field unused_time_from
|
|
349
|
+
attr_reader :unused_time_from
|
|
350
|
+
|
|
351
|
+
def self.inner_class_types
|
|
352
|
+
@inner_class_types = {
|
|
353
|
+
outstanding_usage_through: OutstandingUsageThrough,
|
|
354
|
+
unused_time_from: UnusedTimeFrom,
|
|
355
|
+
}
|
|
356
|
+
end
|
|
357
|
+
|
|
358
|
+
def self.field_remappings
|
|
359
|
+
@field_remappings = {}
|
|
360
|
+
end
|
|
361
|
+
end
|
|
362
|
+
# Attribute for field bill_for
|
|
363
|
+
attr_reader :bill_for
|
|
364
|
+
# Determines how to handle debits and credits when pausing.
|
|
365
|
+
attr_reader :invoicing_behavior
|
|
366
|
+
# The type of pause settings.
|
|
367
|
+
attr_reader :type
|
|
368
|
+
|
|
369
|
+
def self.inner_class_types
|
|
370
|
+
@inner_class_types = { bill_for: BillFor }
|
|
371
|
+
end
|
|
372
|
+
|
|
373
|
+
def self.field_remappings
|
|
374
|
+
@field_remappings = {}
|
|
375
|
+
end
|
|
376
|
+
end
|
|
377
|
+
# Time at which the subscription pauses.
|
|
378
|
+
attr_reader :pause_at
|
|
379
|
+
# Settings controlling billing behavior during the pause.
|
|
380
|
+
attr_reader :settings
|
|
381
|
+
|
|
382
|
+
def self.inner_class_types
|
|
383
|
+
@inner_class_types = { settings: Settings }
|
|
384
|
+
end
|
|
385
|
+
|
|
386
|
+
def self.field_remappings
|
|
387
|
+
@field_remappings = {}
|
|
388
|
+
end
|
|
389
|
+
end
|
|
390
|
+
|
|
391
|
+
class Resume < ::Stripe::StripeObject
|
|
392
|
+
class Settings < ::Stripe::StripeObject
|
|
393
|
+
# The billing cycle anchor that applies when the subscription is resumed.
|
|
394
|
+
attr_reader :billing_cycle_anchor
|
|
395
|
+
# Controls whether Stripe attempts payment on the resumption invoice and how that affects the subscription's status.
|
|
396
|
+
attr_reader :payment_behavior
|
|
397
|
+
# Determines how to handle prorations resulting from the billing_cycle_anchor change on resume.
|
|
398
|
+
attr_reader :proration_behavior
|
|
399
|
+
|
|
400
|
+
def self.inner_class_types
|
|
401
|
+
@inner_class_types = {}
|
|
402
|
+
end
|
|
403
|
+
|
|
404
|
+
def self.field_remappings
|
|
405
|
+
@field_remappings = {}
|
|
406
|
+
end
|
|
407
|
+
end
|
|
408
|
+
# Time at which the subscription resumes.
|
|
409
|
+
attr_reader :resume_at
|
|
410
|
+
# Attribute for field settings
|
|
411
|
+
attr_reader :settings
|
|
412
|
+
|
|
413
|
+
def self.inner_class_types
|
|
414
|
+
@inner_class_types = { settings: Settings }
|
|
415
|
+
end
|
|
416
|
+
|
|
417
|
+
def self.field_remappings
|
|
418
|
+
@field_remappings = {}
|
|
419
|
+
end
|
|
420
|
+
end
|
|
421
|
+
# A unique identifier for this pause schedule.
|
|
422
|
+
attr_reader :key
|
|
423
|
+
# Attribute for field pause
|
|
424
|
+
attr_reader :pause
|
|
425
|
+
# Details about when and how the subscription resumes.
|
|
426
|
+
attr_reader :resume
|
|
427
|
+
|
|
428
|
+
def self.inner_class_types
|
|
429
|
+
@inner_class_types = { pause: Pause, resume: Resume }
|
|
430
|
+
end
|
|
431
|
+
|
|
432
|
+
def self.field_remappings
|
|
433
|
+
@field_remappings = {}
|
|
434
|
+
end
|
|
435
|
+
end
|
|
436
|
+
|
|
296
437
|
class Phase < ::Stripe::StripeObject
|
|
297
438
|
class AddInvoiceItem < ::Stripe::StripeObject
|
|
298
439
|
class Discount < ::Stripe::StripeObject
|
|
@@ -526,6 +667,21 @@ module Stripe
|
|
|
526
667
|
end
|
|
527
668
|
|
|
528
669
|
class InvoiceSettings < ::Stripe::StripeObject
|
|
670
|
+
class CustomField < ::Stripe::StripeObject
|
|
671
|
+
# The name of the custom field.
|
|
672
|
+
attr_reader :name
|
|
673
|
+
# The value of the custom field.
|
|
674
|
+
attr_reader :value
|
|
675
|
+
|
|
676
|
+
def self.inner_class_types
|
|
677
|
+
@inner_class_types = {}
|
|
678
|
+
end
|
|
679
|
+
|
|
680
|
+
def self.field_remappings
|
|
681
|
+
@field_remappings = {}
|
|
682
|
+
end
|
|
683
|
+
end
|
|
684
|
+
|
|
529
685
|
class Issuer < ::Stripe::StripeObject
|
|
530
686
|
# The connected account being referenced when `type` is `account`.
|
|
531
687
|
attr_reader :account
|
|
@@ -542,13 +698,19 @@ module Stripe
|
|
|
542
698
|
end
|
|
543
699
|
# 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.
|
|
544
700
|
attr_reader :account_tax_ids
|
|
701
|
+
# A list of up to 4 custom fields to be displayed on the invoice.
|
|
702
|
+
attr_reader :custom_fields
|
|
545
703
|
# 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`.
|
|
546
704
|
attr_reader :days_until_due
|
|
705
|
+
# An arbitrary string attached to the object. Often useful for displaying to users.
|
|
706
|
+
attr_reader :description
|
|
707
|
+
# Footer to be displayed on the invoice.
|
|
708
|
+
attr_reader :footer
|
|
547
709
|
# The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
|
|
548
710
|
attr_reader :issuer
|
|
549
711
|
|
|
550
712
|
def self.inner_class_types
|
|
551
|
-
@inner_class_types = { issuer: Issuer }
|
|
713
|
+
@inner_class_types = { custom_fields: CustomField, issuer: Issuer }
|
|
552
714
|
end
|
|
553
715
|
|
|
554
716
|
def self.field_remappings
|
|
@@ -794,6 +956,8 @@ module Stripe
|
|
|
794
956
|
attr_reader :start_date
|
|
795
957
|
# The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
|
|
796
958
|
attr_reader :transfer_data
|
|
959
|
+
# If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
|
|
960
|
+
attr_reader :trial
|
|
797
961
|
# Specify behavior of the trial when crossing schedule phase boundaries
|
|
798
962
|
attr_reader :trial_continuation
|
|
799
963
|
# When the trial ends within the phase.
|
|
@@ -876,6 +1040,8 @@ module Stripe
|
|
|
876
1040
|
attr_reader :metadata
|
|
877
1041
|
# String representing the object's type. Objects of the same type share the same value.
|
|
878
1042
|
attr_reader :object
|
|
1043
|
+
# The pause schedules for this subscription schedule.
|
|
1044
|
+
attr_reader :pause_schedules
|
|
879
1045
|
# Configuration for the subscription schedule's phases.
|
|
880
1046
|
attr_reader :phases
|
|
881
1047
|
# Time period and invoice for a Subscription billed in advance.
|
|
@@ -899,6 +1065,7 @@ module Stripe
|
|
|
899
1065
|
current_phase: CurrentPhase,
|
|
900
1066
|
default_settings: DefaultSettings,
|
|
901
1067
|
last_price_migration_error: LastPriceMigrationError,
|
|
1068
|
+
pause_schedules: PauseSchedule,
|
|
902
1069
|
phases: Phase,
|
|
903
1070
|
prebilling: Prebilling,
|
|
904
1071
|
}
|