Billing Checkout Ramp Input

Input representation of a ramp period describing a change in quantity or price for a line item over time.

JSON Example 

1{
2  "productId": "01txx0000004C91",
3  "startDate": "2026-01-01",
4  "endDate": "2026-06-30",
5  "quantity": 5,
6  "unitPrice": 90.00,
7  "netUnitPrice": 81.00,
8  "lineTotal": 450.00,
9  "sellingModelType": "TermDefined",
10  "periodBoundary": "DayOfPeriod",
11  "billingDayOfMonth": 1,
12  "billingTermUnit": "Month",
13  "billingTerm": 6,
14  "taxTreatmentId": "0cXxx0000004C93",
15  "billingTreatmentId": "0cYxx0000004C94"
16}

Properties 

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
end​DateStringEnd date for this ramp period (YYYY-MM-DD).Optional68.0
line​TotalDoubleTotal price for this ramp period.Required68.0
net​Unit​PriceDoubleNet unit price after discount calculation. Auto-calculated.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​IdStringID of the ramped product.Optional68.0
quantityIntegerQuantity for this specific period.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 this ramp period (YYYY-MM-DD).Optional68.0
tax​Treatment​IdStringID of the tax treatment used to calculate tax for the transaction. If you don’t specify a taxTreatmentId, the org-default taxTreatmentId is considered.Optional68.0
unit​PriceDoublePrice per unit before any discounts are applied.Optional68.0