Create an invoice item

POST {{baseUrl}}/v1/invoiceitems

Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.

Request Body

[{"name"=>"customer", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"amount", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"currency", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"description", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"discountable", "value"=>"<boolean>", "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"=>"expand[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expand[1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"invoice", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"period[end]", "value"=>"<unix-time>", "datatype"=>"string"}, {"name"=>"period[start]", "value"=>"<unix-time>", "datatype"=>"string"}, {"name"=>"price", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"price_data[currency]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"price_data[product]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"price_data[tax_behavior]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"price_data[unit_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"price_data[unit_amount_decimal]", "value"=>"<decimal>", "datatype"=>"string"}, {"name"=>"quantity", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"subscription", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_behavior", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_rates[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_rates[1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"unit_amount", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"unit_amount_decimal", "value"=>"<decimal>", "datatype"=>"string"}]

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{&quot;id&quot;:&quot;ii_1MZl7EDy2QwnkKHJwn3tJuAW&quot;,&quot;object&quot;:&quot;invoiceitem&quot;,&quot;amount&quot;:600,&quot;currency&quot;:&quot;usd&quot;,&quot;customer&quot;:&quot;cus_NKPlpMOIsnRj4D&quot;,&quot;date&quot;:1675991368,&quot;description&quot;:null,&quot;discountable&quot;:true,&quot;discounts&quot;:[],&quot;invoice&quot;:&quot;in_1MZl7DDy2QwnkKHJh0T8XrT8&quot;,&quot;livemode&quot;:false,&quot;metadata&quot;:{},&quot;period&quot;:{&quot;end&quot;:1675991368,&quot;start&quot;:1675991368},&quot;plan&quot;:null,&quot;price&quot;:{&quot;id&quot;:&quot;price_1MZl7EDy2QwnkKHJxJ1YFLMN&quot;,&quot;object&quot;:&quot;price&quot;,&quot;active&quot;:false,&quot;billing_scheme&quot;:&quot;per_unit&quot;,&quot;created&quot;:1675991368,&quot;currency&quot;:&quot;usd&quot;,&quot;custom_unit_amount&quot;:null,&quot;livemode&quot;:false,&quot;lookup_key&quot;:null,&quot;metadata&quot;:{},&quot;nickname&quot;:null,&quot;product&quot;:&quot;prod_NKPxbRRxvalvYb&quot;,&quot;recurring&quot;:null,&quot;tax_behavior&quot;:&quot;unspecified&quot;,&quot;tiers_mode&quot;:null,&quot;transform_quantity&quot;:null,&quot;type&quot;:&quot;one_time&quot;,&quot;unit_amount&quot;:600,&quot;unit_amount_decimal&quot;:&quot;600&quot;},&quot;proration&quot;:false,&quot;quantity&quot;:1,&quot;subscription&quot;:null,&quot;tax_rates&quot;:[],&quot;test_clock&quot;:null,&quot;unit_amount&quot;:600,&quot;unit_amount_decimal&quot;:&quot;600&quot;}