class Stripe::PostCheckoutSessionsRequest

• Stripe::PostCheckoutSessionsRequest
• Reference
• Object

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

Constant Summary

ERROR_MESSAGE_FOR_BILLING_ADDRESS_COLLECTION = "invalid value for \"billing_address_collection\", must be one of [auto, required]."

ERROR_MESSAGE_FOR_CUSTOMER_CREATION = "invalid value for \"customer_creation\", must be one of [always, if_required]."

ERROR_MESSAGE_FOR_LOCALE = "invalid value for \"locale\", must be one of [auto, bg, cs, da, de, el, en, en-GB, es, es-419, et, fi, fil, fr, fr-CA, hr, hu, id, it, ja, ko, lt, lv, ms, mt, nb, nl, pl, pt, pt-BR, ro, ru, sk, sl, sv, th, tr, vi, zh, zh-HK, zh-TW]."

ERROR_MESSAGE_FOR_MODE = "invalid value for \"mode\", must be one of [payment, setup, subscription]."

ERROR_MESSAGE_FOR_PAYMENT_METHOD_COLLECTION = "invalid value for \"payment_method_collection\", must be one of [always, if_required]."

ERROR_MESSAGE_FOR_PAYMENT_METHOD_TYPES = "invalid value for \"payment_method_types\", must be one of [acss_debit, affirm, afterpay_clearpay, alipay, amazon_pay, au_becs_debit, bacs_debit, bancontact, blik, boleto, card, cashapp, customer_balance, eps, fpx, giropay, grabpay, ideal, klarna, konbini, link, mobilepay, multibanco, oxxo, p24, paynow, paypal, pix, promptpay, revolut_pay, sepa_debit, sofort, swish, twint, us_bank_account, wechat_pay, zip]."

ERROR_MESSAGE_FOR_REDIRECT_ON_COMPLETION = "invalid value for \"redirect_on_completion\", must be one of [always, if_required, never]."

ERROR_MESSAGE_FOR_SUBMIT_TYPE = "invalid value for \"submit_type\", must be one of [auto, book, donate, pay]."

ERROR_MESSAGE_FOR_UI_MODE = "invalid value for \"ui_mode\", must be one of [embedded, hosted]."

MAX_LENGTH_FOR_CANCEL_URL = 5000

MAX_LENGTH_FOR_CLIENT_REFERENCE_ID = 200

MAX_LENGTH_FOR_CUSTOMER = 5000

MAX_LENGTH_FOR_PAYMENT_METHOD_CONFIGURATION = 100

MAX_LENGTH_FOR_RETURN_URL = 5000

MAX_LENGTH_FOR_SUCCESS_URL = 5000

VALID_VALUES_FOR_BILLING_ADDRESS_COLLECTION = String.static_array("auto", "required")

VALID_VALUES_FOR_CUSTOMER_CREATION = String.static_array("always", "if_required")

VALID_VALUES_FOR_LOCALE = String.static_array("auto", "bg", "cs", "da", "de", "el", "en", "en-GB", "es", "es-419", "et", "fi", "fil", "fr", "fr-CA", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "ms", "mt", "nb", "nl", "pl", "pt", "pt-BR", "ro", "ru", "sk", "sl", "sv", "th", "tr", "vi", "zh", "zh-HK", "zh-TW")

VALID_VALUES_FOR_MODE = String.static_array("payment", "setup", "subscription")

VALID_VALUES_FOR_PAYMENT_METHOD_COLLECTION = String.static_array("always", "if_required")

VALID_VALUES_FOR_PAYMENT_METHOD_TYPES = String.static_array("acss_debit", "affirm", "afterpay_clearpay", "alipay", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "blik", "boleto", "card", "cashapp", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "klarna", "konbini", "link", "mobilepay", "multibanco", "oxxo", "p24", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip")

VALID_VALUES_FOR_REDIRECT_ON_COMPLETION = String.static_array("always", "if_required", "never")

VALID_VALUES_FOR_SUBMIT_TYPE = String.static_array("auto", "book", "donate", "pay")

VALID_VALUES_FOR_UI_MODE = String.static_array("embedded", "hosted")

Constructors

• .new(pull : JSON::PullParser)
• .new(*, after_expiration : Stripe::AfterExpirationParams | Nil = nil, allow_promotion_codes : Bool | Nil = nil, automatic_tax : Stripe::AutomaticTaxParams | Nil = nil, billing_address_collection : String | Nil = nil, cancel_url : String | Nil = nil, client_reference_id : String | Nil = nil, consent_collection : Stripe::ConsentCollectionParams | Nil = nil, currency : String | Nil = nil, custom_fields : Array(Stripe::CustomFieldParam) | Nil = nil, custom_text : Stripe::CustomTextParam | Nil = nil, customer : String | Nil = nil, customer_creation : String | Nil = nil, customer_email : String | Nil = nil, customer_update : Stripe::CustomerUpdateParams | Nil = nil, discounts : Array(Stripe::DiscountParams) | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil, invoice_creation : Stripe::InvoiceCreationParams | Nil = nil, line_items : Array(Stripe::LineItemParams) | Nil = nil, locale : String | Nil = nil, metadata : Hash(String, String) | Nil = nil, mode : String | Nil = nil, payment_intent_data : Stripe::PaymentIntentDataParams | Nil = nil, payment_method_collection : String | Nil = nil, payment_method_configuration : String | Nil = nil, payment_method_data : Stripe::PaymentMethodDataParam | Nil = nil, payment_method_options : Stripe::PaymentMethodOptionsParam | Nil = nil, payment_method_types : Array(String) | Nil = nil, phone_number_collection : Stripe::PhoneNumberCollectionParams | Nil = nil, redirect_on_completion : String | Nil = nil, return_url : String | Nil = nil, saved_payment_method_options : Stripe::SavedPaymentMethodOptionsParam | Nil = nil, setup_intent_data : Stripe::SetupIntentDataParam | Nil = nil, shipping_address_collection : Stripe::ShippingAddressCollectionParams | Nil = nil, shipping_options : Array(Stripe::ShippingOptionParams) | Nil = nil, submit_type : String | Nil = nil, subscription_data : Stripe::SubscriptionDataParams | Nil = nil, success_url : String | Nil = nil, tax_id_collection : Stripe::TaxIdCollectionParams | Nil = nil, ui_mode : String | Nil = nil)

  Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance Method Summary

• #==(other : self)

  Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.

• #after_expiration : Stripe::AfterExpirationParams | Nil
• #after_expiration=(new_value : Stripe::AfterExpirationParams | Nil)

  Custom attribute writer method checking allowed values (enum).

• #allow_promotion_codes : Bool | Nil
• #allow_promotion_codes=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #automatic_tax : Stripe::AutomaticTaxParams | Nil
• #automatic_tax=(new_value : Stripe::AutomaticTaxParams | Nil)

  Custom attribute writer method checking allowed values (enum).

• #billing_address_collection : String | Nil
• #billing_address_collection=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #cancel_url : String | Nil
• #cancel_url=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #client_reference_id : String | Nil
• #client_reference_id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #consent_collection : Stripe::ConsentCollectionParams | Nil
• #consent_collection=(new_value : Stripe::ConsentCollectionParams | Nil)

  Custom attribute writer method checking allowed values (enum).

• #currency : String | Nil
• #currency=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #custom_fields : Array(Stripe::CustomFieldParam) | Nil
• #custom_fields=(new_value : Array(Stripe::CustomFieldParam) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #custom_text : Stripe::CustomTextParam | Nil
• #custom_text=(new_value : Stripe::CustomTextParam | Nil)

  Custom attribute writer method checking allowed values (enum).

• #customer : String | Nil
• #customer=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #customer_creation : String | Nil
• #customer_creation=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #customer_email : String | Nil
• #customer_email=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #customer_update : Stripe::CustomerUpdateParams | Nil
• #customer_update=(new_value : Stripe::CustomerUpdateParams | Nil)

  Custom attribute writer method checking allowed values (enum).

• #discounts : Array(Stripe::DiscountParams) | Nil
• #discounts=(new_value : Array(Stripe::DiscountParams) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #expand : Array(String) | Nil
• #expand=(new_value : Array(String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #expires_at : Int64 | Nil
• #expires_at=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

  Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.

• #invoice_creation : Stripe::InvoiceCreationParams | Nil
• #invoice_creation=(new_value : Stripe::InvoiceCreationParams | Nil)

  Custom attribute writer method checking allowed values (enum).

• #line_items : Array(Stripe::LineItemParams) | Nil
• #line_items=(new_value : Array(Stripe::LineItemParams) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #locale : String | Nil
• #locale=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #metadata : Hash(String, String) | Nil
• #metadata=(new_value : Hash(String, String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #mode : String | Nil
• #mode=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #payment_intent_data : Stripe::PaymentIntentDataParams | Nil
• #payment_intent_data=(new_value : Stripe::PaymentIntentDataParams | Nil)

  Custom attribute writer method checking allowed values (enum).

• #payment_method_collection : String | Nil
• #payment_method_collection=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #payment_method_configuration : String | Nil
• #payment_method_configuration=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #payment_method_data : Stripe::PaymentMethodDataParam | Nil
• #payment_method_data=(new_value : Stripe::PaymentMethodDataParam | Nil)

  Custom attribute writer method checking allowed values (enum).

• #payment_method_options : Stripe::PaymentMethodOptionsParam | Nil
• #payment_method_options=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

  Custom attribute writer method checking allowed values (enum).

• #payment_method_types : Array(String) | Nil
• #payment_method_types=(new_value : Array(String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #phone_number_collection : Stripe::PhoneNumberCollectionParams | Nil
• #phone_number_collection=(new_value : Stripe::PhoneNumberCollectionParams | Nil)

  Custom attribute writer method checking allowed values (enum).

• #redirect_on_completion : String | Nil
• #redirect_on_completion=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #return_url : String | Nil
• #return_url=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #saved_payment_method_options : Stripe::SavedPaymentMethodOptionsParam | Nil
• #saved_payment_method_options=(new_value : Stripe::SavedPaymentMethodOptionsParam | Nil)

  Custom attribute writer method checking allowed values (enum).

• #setup_intent_data : Stripe::SetupIntentDataParam | Nil
• #setup_intent_data=(new_value : Stripe::SetupIntentDataParam | Nil)

  Custom attribute writer method checking allowed values (enum).

• #shipping_address_collection : Stripe::ShippingAddressCollectionParams | Nil
• #shipping_address_collection=(new_value : Stripe::ShippingAddressCollectionParams | Nil)

  Custom attribute writer method checking allowed values (enum).

• #shipping_options : Array(Stripe::ShippingOptionParams) | Nil
• #shipping_options=(new_value : Array(Stripe::ShippingOptionParams) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #submit_type : String | Nil
• #submit_type=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #subscription_data : Stripe::SubscriptionDataParams | Nil
• #subscription_data=(new_value : Stripe::SubscriptionDataParams | Nil)

  Custom attribute writer method checking allowed values (enum).

• #success_url : String | Nil
• #success_url=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #tax_id_collection : Stripe::TaxIdCollectionParams | Nil
• #tax_id_collection=(new_value : Stripe::TaxIdCollectionParams | Nil)

  Custom attribute writer method checking allowed values (enum).

• #ui_mode : String | Nil
• #ui_mode=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

  Check to see if the all the properties in the model are valid @return true if the model is valid

Constructor Detail

Instance Method Detail