Billing Checkout Line Item Input

Input representation of a single line item being purchased in the checkout transaction.

NameTypeDescriptionRequired or OptionalAvailable Version
billing​Day​Of​MonthIntegerThe day of the month a recurring billing process is scheduled to occur for the transaction. Required when periodBoundary is DayOfPeriod.Optional68.0
billing​TermIntegerNumber of billing term units. Must be 1 for OneTime selling models.Optional68.0
billing​Term​UnitStringUnit of measurement for the billing term. Required when sellingModelType is TermDefined or Evergreen. Valid values are OneTime, Day, Week, Month, Quarter, SemiAnnual, Year, or BillingMilestonePlan.Optional68.0
billing​Treatment​IdStringID of the billing treatment used to create the billing schedule for the transaction. If you don’t specify a billingTreatmentId, the org-default billingTreatmentId is considered.Optional68.0
bundle​Product​DetailsBundle Product Details Input[]Array of child products. Its presence indicates that this line item is a bundle parent. Supports nested bundles.Optional68.0
end​DateStringEnd date for the line item’s billing schedule (YYYY-MM-DD). Required when sellingModelType is TermDefined or a billingTermUnit is provided. Defaults to the invoice date when omitted.Optional68.0
line​TotalDoubleNet unit price multiplied by quantity.Required68.0
net​Unit​PriceDoubleNet unit price after discount calculation.Optional68.0
period​BoundaryStringPeriod boundary for the billing schedule. Required when sellingModelType is TermDefined or Evergreen. Valid values are AlignToCalendar, Anniversary, DayOfPeriod, or LastDayOfPeriod.Optional68.0
product​IdStringUnique product ID of the item.Required68.0
product​NameStringUnique product name of the item.Optional68.0
quantityIntegerQuantity of the product being purchased.Required68.0
rampsBilling Checkout Ramp Input[]Schedule of changes in quantity or price for this line item.Optional68.0
selling​Model​TypeStringSelling model of the line item. Defaults to OneTime. A TermDefined or Evergreen value requires billingTermUnit. Valid values are OneTime, TermDefined, or Evergreen.Optional68.0
start​DateStringStart date for the line item’s billing schedule (YYYY-MM-DD). Defaults to the invoice date.Optional68.0
tax​Treatment​IdStringThe tax treatment ID used to calculate tax for the transaction. If you don’t specify a taxTreatmentId, the org-default taxTreatmentId is considered.Optional68.0
transaction​IdStringClient-supplied transaction identifier for this line item. Used as the transaction ID on the generated billing transaction and as the grouping key for its ramp segments and bundle components. Defaults to the product name or product ID when omitted.Optional68.0
unit​PriceDoublePrice per unit before any discounts are applied.Required68.0