class Stripe::Checkout::Session

• Stripe::Checkout::Session
• Reference
• Object

Overview

https://stripe.com/docs/api/checkout/sessions/create

Included Modules

• JSON::Serializable
• StripeMethods

Defined in:

Constructors

• .new(pull : JSON::PullParser)
• .new(*, __pull_for_json_serializable pull : JSON::PullParser)

Class Method Summary

• .create(mode : String | Stripe::Checkout::Session::Mode, payment_method_types : Array(String), cancel_url : String, success_url : String, client_reference_id : String | Nil = nil, customer : String | Nil | Stripe::Customer | Nil = nil, customer_email : String | Nil = nil, line_items : Array(NamedTuple(quantity: Int32, price: String) | NamedTuple(quantity: Int32, price_data: NamedTuple(currency: String, product_data: NamedTuple(name: String) | Nil, unit_amount: Int32 | Nil, unit_amount_decimal: String | Nil, recurring: NamedTuple(interval: String, interval_count: Int32 | Nil) | Nil, tax_behavior: String | Nil))) | Nil = nil, expand : Array(String) | Nil = nil, subscription_data : NamedTuple(metadata: Hash(String, String) | Nil) | Nil = nil, allow_promotion_codes : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, discounts : Array(NamedTuple(coupon: String) | NamedTuple(promotion_code: String)) | Nil = nil, payment_intent_data : Hash(String, String) | Nil = nil, billing_address_collection : Stripe::Checkout::Session::BillingAddressCollection | Nil = nil, automatic_tax : NamedTuple(enabled: Bool) | Nil = nil, phone_number_collection : NamedTuple(enabled: Bool) | Nil = nil, shipping_address_collection : NamedTuple(allowed_countries: Array(String)) | Nil = nil, shipping_options : Array(NamedTuple(shipping_rate: String)) | Nil = nil, submit_type : Stripe::Checkout::Session::SubmitType | Nil = nil, tax_id_collection : NamedTuple(enabled: Bool) | Nil = nil, expires_at : Time | Nil = nil, ui_mode : String | Nil = nil, return_url : String | Nil = nil, redirect_on_completion : String | Nil = nil, customer_update : NamedTuple | Nil = nil, customer_creation : String | NamedTuple | Nil = nil, invoice_creation : NamedTuple | Nil = nil, payment_method_collection : String | Nil = nil, payment_method_configuration : String | Nil = nil, payment_method_options : NamedTuple | Nil = nil, consent_collection : NamedTuple | Nil = nil, custom_fields : Array(NamedTuple) | Nil = nil, custom_text : NamedTuple | Nil = nil, after_expiration : NamedTuple | Nil = nil) : Stripe::Checkout::Session
• .expire(id : String | Stripe::Checkout::Session, expand : Array(String) | Nil = nil) : Stripe::Checkout::Session
• .line_items(id : String | Stripe::Checkout::Session, limit : Int32 | Nil = nil, starting_after : String | Nil = nil, ending_before : String | Nil = nil) : List(Stripe::Checkout::LineItem)
• .list(payment_intent : String | Nil | Stripe::PaymentIntent | Nil = nil, subscription : String | Nil | Stripe::Subscription | Nil = nil, limit : Int32 | Nil = nil, starting_after : String | Nil = nil, ending_before : String | Nil = nil) : List(Stripe::Checkout::Session)
• .retrieve(id : String)
• .retrieve(checkout_session : Stripe::Checkout::Session)
• .update(id : String | Stripe::Checkout::Session, metadata : Hash(String, String) | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::Checkout::Session

Instance Method Summary

• #adaptive_pricing : Hash(String, String | Bool | Nil) | Nil
• #allow_promotion_codes : Bool | Nil
• #amount_subtotal : Int32 | Nil
• #amount_total : Int32 | Nil
• #automatic_tax : Hash(String, String | Bool | Nil) | Nil
• #billing_address_collection : BillingAddressCollection | Nil
• #cancel_url : String
• #client_reference_id : String | Nil
• #consent : Hash(String, String | Bool | Nil) | Nil
• #consent_collection : Hash(String, String | Bool | Nil) | Nil
• #created : Time | Nil

  Newer fields

• #currency : String | Nil
• #custom_fields : Array(Hash(String, String | Bool | Hash(String, String | Bool) | Array(Hash(String, String | Bool)))) | Nil
• #custom_text : Hash(String, String | Hash(String, String | Nil) | Nil) | Nil
• #customer : String | Nil | Stripe::Customer | Nil
• #customer_creation : String | Nil
• #customer_details : Hash(String, Bool | String | Hash(String, String | Bool | Array(Hash(String, String))) | Array(Hash(String, String)) | Nil) | Nil
• #customer_email : String | Nil
• #expires_at : Time | Nil
• #id : String
• #invoice : String | Nil | Stripe::Invoice | Nil
• #invoice_creation : Hash(String, String | Bool | Hash(String, String | Bool)) | Nil
• #line_items : Array(Hash(String, String | Int32)) | Nil
• #livemode : Bool | Nil
• #metadata : Hash(String, String) | Nil
• #mode : String | Mode
• #object : String | Nil
• #payment_intent : String | Nil | Stripe::PaymentIntent | Nil
• #payment_intent_data : Hash(String, String) | Nil
• #payment_link : String | Nil
• #payment_method_collection : String | Nil
• #payment_method_configuration : String | Nil
• #payment_method_options : Hash(String, String | Bool | Int32 | Hash(String, String | Bool | Int32)) | Nil
• #payment_method_types : Array(String)
• #payment_status : PaymentStatus
• #phone_number_collection : Hash(String, Bool) | Nil
• #recovered_from : String | Nil
• #return_url : String | Nil
• #setup_intent : String | Nil | Stripe::SetupIntent | Nil
• #shipping : Hash(String, String | Hash(String, String)) | Nil
• #shipping_address_collection : Hash(String, Array(String)) | Nil
• #shipping_cost : Hash(String, String | Int32 | Bool | Hash(String, String | Int32 | Bool)) | Nil
• #shipping_details : Hash(String, String | Hash(String, String | Hash(String, String)) | Nil) | Nil
• #shipping_options : Array(Hash(String, String | Int32 | Bool | Hash(String, String | Int32 | Bool))) | Nil
• #status : Status | Nil
• #submit_type : SubmitType | Nil
• #subscription : String | Nil | Stripe::Subscription | Nil
• #success_url : String
• #tax_id_collection : Hash(String, Bool) | Nil
• #total_details : Hash(String, Int32) | Nil
• #ui_mode : String | Nil
• #url : String | Nil

Constructor Detail

Class Method Detail

Instance Method Detail