Create a Session

POST {{baseUrl}}/v1/checkout/sessions

Creates a Session object.

Request Body

[{"name"=>"cancel_url", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"success_url", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"after_expiration[recovery][enabled]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"after_expiration[recovery][allow_promotion_codes]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"allow_promotion_codes", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"automatic_tax[enabled]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"billing_address_collection", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"client_reference_id", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"consent_collection[promotions]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"consent_collection[terms_of_service]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"currency", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"customer", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"customer_creation", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"customer_email", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"customer_update[address]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"customer_update[name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"customer_update[shipping]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"discounts[0][coupon]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"discounts[0][promotion_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"discounts[1][coupon]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"discounts[1][promotion_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expand[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expand[1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expires_at", "value"=>"<unix-time>", "datatype"=>"string"}, {"name"=>"line_items[0][adjustable_quantity][enabled]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"line_items[0][adjustable_quantity][maximum]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"line_items[0][adjustable_quantity][minimum]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"line_items[0][dynamic_tax_rates][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[0][dynamic_tax_rates][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[0][price]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[0][price_data][currency]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[0][price_data][product]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[0][price_data][product_data][name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[0][price_data][product_data][description]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[0][price_data][product_data][images][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[0][price_data][product_data][images][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[0][price_data][product_data][metadata]", "value"=>"<object>", "datatype"=>"string"}, {"name"=>"line_items[0][price_data][product_data][tax_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[0][price_data][recurring][interval]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[0][price_data][recurring][interval_count]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"line_items[0][price_data][tax_behavior]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[0][price_data][unit_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"line_items[0][price_data][unit_amount_decimal]", "value"=>"<decimal>", "datatype"=>"string"}, {"name"=>"line_items[0][quantity]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"line_items[0][tax_rates][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[0][tax_rates][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[1][adjustable_quantity][enabled]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"line_items[1][adjustable_quantity][maximum]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"line_items[1][adjustable_quantity][minimum]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"line_items[1][dynamic_tax_rates][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[1][dynamic_tax_rates][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[1][price]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[1][price_data][currency]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[1][price_data][product]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[1][price_data][product_data][name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[1][price_data][product_data][description]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[1][price_data][product_data][images][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[1][price_data][product_data][images][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[1][price_data][product_data][metadata]", "value"=>"<object>", "datatype"=>"string"}, {"name"=>"line_items[1][price_data][product_data][tax_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[1][price_data][recurring][interval]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[1][price_data][recurring][interval_count]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"line_items[1][price_data][tax_behavior]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[1][price_data][unit_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"line_items[1][price_data][unit_amount_decimal]", "value"=>"<decimal>", "datatype"=>"string"}, {"name"=>"line_items[1][quantity]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"line_items[1][tax_rates][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[1][tax_rates][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"locale", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"mode", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[application_fee_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"payment_intent_data[capture_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[description]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[metadata]", "value"=>"<object>", "datatype"=>"string"}, {"name"=>"payment_intent_data[on_behalf_of]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[receipt_email]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[shipping][address][line1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[shipping][address][city]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[shipping][address][country]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[shipping][address][line2]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[shipping][address][postal_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[shipping][address][state]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[shipping][name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[shipping][carrier]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[shipping][phone]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[shipping][tracking_number]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[statement_descriptor]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[statement_descriptor_suffix]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[transfer_data][destination]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[transfer_data][amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"payment_intent_data[transfer_group]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_collection", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[acss_debit][currency]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[acss_debit][mandate_options][custom_mandate_url]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[acss_debit][mandate_options][default_for][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[acss_debit][mandate_options][default_for][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[acss_debit][mandate_options][interval_description]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[acss_debit][mandate_options][payment_schedule]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[acss_debit][mandate_options][transaction_type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[acss_debit][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[acss_debit][verification_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[affirm][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[afterpay_clearpay][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[alipay][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[au_becs_debit][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[bacs_debit][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[bancontact][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[boleto][expires_after_days]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"payment_method_options[boleto][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][installments][enabled]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][statement_descriptor_suffix_kana]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[card][statement_descriptor_suffix_kanji]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[customer_balance][bank_transfer][type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[customer_balance][bank_transfer][eu_bank_transfer][country]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[customer_balance][bank_transfer][requested_address_types][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[customer_balance][bank_transfer][requested_address_types][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[customer_balance][funding_type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[customer_balance][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[eps][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[fpx][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[giropay][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[grabpay][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[ideal][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[klarna][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[konbini][expires_after_days]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"payment_method_options[konbini][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[oxxo][expires_after_days]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"payment_method_options[oxxo][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[p24][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[p24][tos_shown_and_accepted]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"payment_method_options[paynow][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[paynow][tos_shown_and_accepted]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"payment_method_options[pix][expires_after_seconds]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"payment_method_options[sepa_debit][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[sofort][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[us_bank_account][financial_connections][permissions][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[us_bank_account][financial_connections][permissions][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[us_bank_account][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[us_bank_account][verification_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[wechat_pay][client]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[wechat_pay][app_id]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_options[wechat_pay][setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_types[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_types[1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"phone_number_collection[enabled]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"setup_intent_data[description]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"setup_intent_data[metadata]", "value"=>"<object>", "datatype"=>"string"}, {"name"=>"setup_intent_data[on_behalf_of]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_address_collection[allowed_countries][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_address_collection[allowed_countries][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_options[0][shipping_rate]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_options[0][shipping_rate_data][display_name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_options[0][shipping_rate_data][delivery_estimate][maximum][unit]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_options[0][shipping_rate_data][delivery_estimate][maximum][value]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"shipping_options[0][shipping_rate_data][delivery_estimate][minimum][unit]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_options[0][shipping_rate_data][delivery_estimate][minimum][value]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"shipping_options[0][shipping_rate_data][fixed_amount][amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"shipping_options[0][shipping_rate_data][fixed_amount][currency]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_options[0][shipping_rate_data][fixed_amount][currency_options]", "value"=>"<object>", "datatype"=>"string"}, {"name"=>"shipping_options[0][shipping_rate_data][metadata]", "value"=>"<object>", "datatype"=>"string"}, {"name"=>"shipping_options[0][shipping_rate_data][tax_behavior]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_options[0][shipping_rate_data][tax_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_options[0][shipping_rate_data][type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_options[1][shipping_rate]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_options[1][shipping_rate_data][display_name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_options[1][shipping_rate_data][delivery_estimate][maximum][unit]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_options[1][shipping_rate_data][delivery_estimate][maximum][value]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"shipping_options[1][shipping_rate_data][delivery_estimate][minimum][unit]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_options[1][shipping_rate_data][delivery_estimate][minimum][value]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"shipping_options[1][shipping_rate_data][fixed_amount][amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"shipping_options[1][shipping_rate_data][fixed_amount][currency]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_options[1][shipping_rate_data][fixed_amount][currency_options]", "value"=>"<object>", "datatype"=>"string"}, {"name"=>"shipping_options[1][shipping_rate_data][metadata]", "value"=>"<object>", "datatype"=>"string"}, {"name"=>"shipping_options[1][shipping_rate_data][tax_behavior]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_options[1][shipping_rate_data][tax_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_options[1][shipping_rate_data][type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"submit_type", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"subscription_data[application_fee_percent]", "value"=>"<number>", "datatype"=>"string"}, {"name"=>"subscription_data[default_tax_rates][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"subscription_data[default_tax_rates][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"subscription_data[description]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"subscription_data[metadata]", "value"=>"<object>", "datatype"=>"string"}, {"name"=>"subscription_data[on_behalf_of]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"subscription_data[transfer_data][destination]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"subscription_data[transfer_data][amount_percent]", "value"=>"<number>", "datatype"=>"string"}, {"name"=>"subscription_data[trial_end]", "value"=>"<unix-time>", "datatype"=>"string"}, {"name"=>"subscription_data[trial_period_days]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"tax_id_collection[enabled]", "value"=>"<boolean>", "datatype"=>"string"}]

HEADERS