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
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"id":"ii_1MZl7EDy2QwnkKHJwn3tJuAW","object":"invoiceitem","amount":600,"currency":"usd","customer":"cus_NKPlpMOIsnRj4D","date":1675991368,"description":null,"discountable":true,"discounts":[],"invoice":"in_1MZl7DDy2QwnkKHJh0T8XrT8","livemode":false,"metadata":{},"period":{"end":1675991368,"start":1675991368},"plan":null,"price":{"id":"price_1MZl7EDy2QwnkKHJxJ1YFLMN","object":"price","active":false,"billing_scheme":"per_unit","created":1675991368,"currency":"usd","custom_unit_amount":null,"livemode":false,"lookup_key":null,"metadata":{},"nickname":null,"product":"prod_NKPxbRRxvalvYb","recurring":null,"tax_behavior":"unspecified","tiers_mode":null,"transform_quantity":null,"type":"one_time","unit_amount":600,"unit_amount_decimal":"600"},"proration":false,"quantity":1,"subscription":null,"tax_rates":[],"test_clock":null,"unit_amount":600,"unit_amount_decimal":"600"}