Create a payment link

POST {{baseUrl}}/v1/payment_links

Creates a payment link.

Request Body

[{"name"=>"line_items[0][price]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[0][quantity]", "value"=>"<integer>", "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[1][price]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"line_items[1][quantity]", "value"=>"<integer>", "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"=>"after_completion[type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"after_completion[hosted_confirmation][custom_message]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"after_completion[redirect][url]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"allow_promotion_codes", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"application_fee_amount", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"application_fee_percent", "value"=>"<number>", "datatype"=>"string"}, {"name"=>"automatic_tax[enabled]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"billing_address_collection", "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"=>"custom_fields[0][key]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_fields[0][label][custom]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_fields[0][label][type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_fields[0][type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_fields[0][dropdown][options][0][label]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_fields[0][dropdown][options][0][value]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_fields[0][dropdown][options][1][label]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_fields[0][dropdown][options][1][value]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_fields[0][numeric][maximum_length]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"custom_fields[0][numeric][minimum_length]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"custom_fields[0][optional]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"custom_fields[0][text][maximum_length]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"custom_fields[0][text][minimum_length]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"custom_fields[1][key]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_fields[1][label][custom]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_fields[1][label][type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_fields[1][type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_fields[1][dropdown][options][0][label]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_fields[1][dropdown][options][0][value]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_fields[1][dropdown][options][1][label]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_fields[1][dropdown][options][1][value]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_fields[1][numeric][maximum_length]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"custom_fields[1][numeric][minimum_length]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"custom_fields[1][optional]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"custom_fields[1][text][maximum_length]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"custom_fields[1][text][minimum_length]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"custom_text[shipping_address][message]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_text[submit][message]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"customer_creation", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expand[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expand[1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_creation[enabled]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"invoice_creation[invoice_data][account_tax_ids][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_creation[invoice_data][account_tax_ids][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_creation[invoice_data][custom_fields][0][name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_creation[invoice_data][custom_fields][0][value]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_creation[invoice_data][custom_fields][1][name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_creation[invoice_data][custom_fields][1][value]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_creation[invoice_data][description]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_creation[invoice_data][footer]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice_creation[invoice_data][metadata]", "value"=>"<object>", "datatype"=>"string"}, {"name"=>"invoice_creation[invoice_data][rendering_options][amount_tax_display]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"on_behalf_of", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[capture_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_intent_data[setup_future_usage]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_method_collection", "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"=>"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[1][shipping_rate]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"submit_type", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"subscription_data[description]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"subscription_data[trial_period_days]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"tax_id_collection[enabled]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"transfer_data[destination]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"transfer_data[amount]", "value"=>"<integer>", "datatype"=>"string"}]

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring