Create an invoice

POST {{baseUrl}}/v1/invoices

This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

Request Body

[{"name"=>"account_tax_ids[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"account_tax_ids[1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"application_fee_amount", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"auto_advance", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"automatic_tax[enabled]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"automatic_tax[liability][type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"automatic_tax[liability][account]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"collection_method", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"currency", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_fields[0][name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_fields[0][value]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_fields[1][name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"custom_fields[1][value]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"customer", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"days_until_due", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"default_payment_method", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"default_source", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"default_tax_rates[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"default_tax_rates[1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"description", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"discounts[0][coupon]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"discounts[0][discount]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"discounts[0][promotion_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"discounts[1][coupon]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"discounts[1][discount]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"discounts[1][promotion_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"due_date", "value"=>"<unix-time>", "datatype"=>"string"}, {"name"=>"effective_at", "value"=>"<unix-time>", "datatype"=>"string"}, {"name"=>"expand[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expand[1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"footer", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"from_invoice[action]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"from_invoice[invoice]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"issuer[type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"issuer[account]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"number", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"on_behalf_of", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_settings[default_mandate]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_settings[payment_method_options][acss_debit][mandate_options][transaction_type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_settings[payment_method_options][acss_debit][verification_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_settings[payment_method_options][bancontact][preferred_language]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_settings[payment_method_options][card][installments][enabled]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"payment_settings[payment_method_options][card][installments][plan][count]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"payment_settings[payment_method_options][card][installments][plan][interval]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_settings[payment_method_options][card][installments][plan][type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_settings[payment_method_options][card][request_three_d_secure]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_settings[payment_method_options][customer_balance][bank_transfer][eu_bank_transfer][country]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_settings[payment_method_options][customer_balance][bank_transfer][type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_settings[payment_method_options][customer_balance][funding_type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_settings[payment_method_options][us_bank_account][financial_connections][permissions][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_settings[payment_method_options][us_bank_account][financial_connections][permissions][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_settings[payment_method_options][us_bank_account][financial_connections][prefetch][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_settings[payment_method_options][us_bank_account][financial_connections][prefetch][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_settings[payment_method_options][us_bank_account][verification_method]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_settings[payment_method_types][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"payment_settings[payment_method_types][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"pending_invoice_items_behavior", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"rendering[amount_tax_display]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"rendering[pdf][page_size]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_cost[shipping_rate]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_cost[shipping_rate_data][display_name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_cost[shipping_rate_data][delivery_estimate][maximum][unit]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_cost[shipping_rate_data][delivery_estimate][maximum][value]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"shipping_cost[shipping_rate_data][delivery_estimate][minimum][unit]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_cost[shipping_rate_data][delivery_estimate][minimum][value]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"shipping_cost[shipping_rate_data][fixed_amount][amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"shipping_cost[shipping_rate_data][fixed_amount][currency]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_cost[shipping_rate_data][fixed_amount][currency_options]", "value"=>"<object>", "datatype"=>"string"}, {"name"=>"shipping_cost[shipping_rate_data][metadata]", "value"=>"<object>", "datatype"=>"string"}, {"name"=>"shipping_cost[shipping_rate_data][tax_behavior]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_cost[shipping_rate_data][tax_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_cost[shipping_rate_data][type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_details[address][city]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_details[address][country]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_details[address][line1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_details[address][line2]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_details[address][postal_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_details[address][state]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_details[name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"shipping_details[phone]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"statement_descriptor", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"subscription", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"transfer_data[destination]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"transfer_data[amount]", "value"=>"<integer>", "datatype"=>"string"}]

HEADERS