Adds a Line Item to an Invoice Schedule
Required permission: Recurring Invoices - Edit
Most fields only apply to one kind of line, chosen with recurring_type_id; the descriptions say which. POST /schedules/{id}/add_line_item is an older alias for this endpoint and behaves identically.
Path parameters
Request body
Product billed by this line. When given, name, description and product_category default from the product.
Required unless a product_id supplies one.
Required unless a product_id supplies one.
Ignored for the line types that derive their own quantity (asset, contact, remote access, policy folder, vendor and Kabuto subscriptions).
Price charged, in cents.
Your cost, in cents.
Price charged, in currency units. Alternative to retail_cents.
Your cost, in currency units. Alternative to cost_cents.
Sort order on the generated invoice. Defaults to the bottom of the list.
Overwritten by the product's own category when product_id is given.
Bill this line once and then stop, rather than on every run.
Employee credited with the line. Defaults to the owner of the API token.
What kind of line this is, which decides how its quantity is calculated. 1 recurring invoice, 2 data backup, 3 general subscription, 4 asset, 5 Kabuto, 6 contact, 7 Syncro Backup, 8 remote access, 9 policy folder, 10 third-party vendor, 11 Cloudberry.
Asset subscriptions (recurring_type_id 4): bill for the customer's assets of this type.
Asset subscriptions: bill for the assets matching this saved search instead of an asset type.
Contact subscriptions (recurring_type_id 6): bill for contacts by this custom field.
Contact subscriptions: bill only for contacts whose answer to that field is this one.
Policy folder subscriptions (recurring_type_id 9): bill for the assets in this folder.
Policy folder subscriptions: include assets in the folder's sub-folders.
Third-party vendor lines (recurring_type_id 10): the vendor to read usage from.
Third-party vendor lines: the vendor product to bill.
Bill every unit reported, rather than only those over bill_units_threshold.
Number of units included before billing starts. Required when bill_all_units is false.
Keep the line on the invoice even when it bills nothing.
Microsoft 365 vendor lines: bill licensed (all) or consumed (consumed) seats.
Syncro Backup lines (recurring_type_id 7): bill per licence or per GB of cloud storage.
Syncro Backup storage lines: whether the included storage is a global or per-asset allowance.
Syncro Backup lines: bill all usage, ignoring the included allowance.
Syncro Backup licence lines: licences included before billing starts.
Syncro Backup storage lines: GB included before billing starts.
Response
successful