Billing Checkout Line Item Input
Input representation of a single line item being purchased in the checkout transaction.
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
billingDayOfMonth | Integer | The day of the month a recurring billing process is scheduled to occur for the transaction. Required when periodBoundary is DayOfPeriod. | Optional | 68.0 |
billingTerm | Integer | Number of billing term units. Must be 1 for OneTime selling models. | Optional | 68.0 |
billingTermUnit | String | Unit 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. | Optional | 68.0 |
billingTreatmentId | String | ID 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. | Optional | 68.0 |
bundleProductDetails | Bundle Product Details Input[] | Array of child products. Its presence indicates that this line item is a bundle parent. Supports nested bundles. | Optional | 68.0 |
endDate | String | End 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. | Optional | 68.0 |
lineTotal | Double | Net unit price multiplied by quantity. | Required | 68.0 |
netUnitPrice | Double | Net unit price after discount calculation. | Optional | 68.0 |
periodBoundary | String | Period boundary for the billing schedule. Required when sellingModelType is TermDefined or Evergreen. Valid values are AlignToCalendar, Anniversary, DayOfPeriod, or LastDayOfPeriod. | Optional | 68.0 |
productId | String | Unique product ID of the item. | Required | 68.0 |
productName | String | Unique product name of the item. | Optional | 68.0 |
quantity | Integer | Quantity of the product being purchased. | Required | 68.0 |
ramps | Billing Checkout Ramp Input[] | Schedule of changes in quantity or price for this line item. | Optional | 68.0 |
sellingModelType | String | Selling model of the line item. Defaults to OneTime. A TermDefined or Evergreen value requires billingTermUnit. Valid values are OneTime, TermDefined, or Evergreen. | Optional | 68.0 |
startDate | String | Start date for the line item’s billing schedule (YYYY-MM-DD). Defaults to the invoice date. | Optional | 68.0 |
taxTreatmentId | String | The tax treatment ID used to calculate tax for the transaction. If you don’t specify a taxTreatmentId, the org-default taxTreatmentId is considered. | Optional | 68.0 |
transactionId | String | Client-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. | Optional | 68.0 |
unitPrice | Double | Price per unit before any discounts are applied. | Required | 68.0 |
-
Input representation of a bundle line item’s child product. Recursive to support nested bundles.
-
Input representation of a ramp period describing a change in quantity or price for a line item over time.