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"=>"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[1][coupon]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"discounts[1][discount]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"due_date", "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"=>"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][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_options[amount_tax_display]", "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

RESPONSES

status: OK

{"id":"in_1MZkYpDy2QwnkKHJBl2Uldjt","object":"invoice","account_country":"US","account_name":null,"account_tax_ids":null,"amount_due":0,"amount_paid":0,"amount_remaining":0,"amount_shipping":0,"application":null,"application_fee_amount":null,"attempt_count":0,"attempted":false,"auto_advance":false,"automatic_tax":{"enabled":false,"status":null},"billing_reason":"manual","charge":null,"collection_method":"send_invoice","created":1675989235,"currency":"usd","custom_fields":null,"customer":"cus_NKPNiNJ3QoejNy","customer_address":null,"customer_email":"daniel.kimmelmann@postman.com","customer_name":"Big Business","customer_phone":null,"customer_shipping":null,"customer_tax_exempt":"none","customer_tax_ids":[],"default_payment_method":null,"default_source":null,"default_tax_rates":[],"description":null,"discount":null,"discounts":[],"due_date":1676594035,"ending_balance":null,"footer":null,"from_invoice":null,"hosted_invoice_url":null,"invoice_pdf":null,"last_finalization_error":null,"latest_revision":null,"lines":{"object":"list","data":[],"has_more":false,"total_count":0,"url":"/v1/invoices/in_1MZkYpDy2QwnkKHJBl2Uldjt/lines"},"livemode":false,"metadata":{},"next_payment_attempt":null,"number":null,"on_behalf_of":null,"paid":false,"paid_out_of_band":false,"payment_intent":null,"payment_settings":{"default_mandate":null,"payment_method_options":null,"payment_method_types":null},"period_end":1675989235,"period_start":1675989235,"post_payment_credit_notes_amount":0,"pre_payment_credit_notes_amount":0,"quote":null,"receipt_number":null,"rendering_options":null,"shipping_cost":null,"shipping_details":null,"starting_balance":0,"statement_descriptor":null,"status":"draft","status_transitions":{"finalized_at":null,"marked_uncollectible_at":null,"paid_at":null,"voided_at":null},"subscription":null,"subtotal":0,"subtotal_excluding_tax":0,"tax":null,"test_clock":null,"total":0,"total_discount_amounts":[],"total_excluding_tax":0,"total_tax_amounts":[],"transfer_data":null,"webhooks_delivered_at":1675989235}