Skip to main content
inputSalesSubscriptionScheduleInput

Fields

cadence
SalesSubscriptionCadence!
required

How often the line item becomes due.

every
Int

Required for the custom cadence, not allowed for the others: the number of units between two due dates, 1 to 999.

unit
SalesSubscriptionIntervalUnit

Required for the custom cadence, not allowed for the others: the unit of 'every'.

startDate
DateTime!
required

The first day the schedule applies. Only the date counts; a time part is ignored.

endDate
DateTime

The last day a period can be due; not before the start date. Only the date counts; a time part is ignored.

leadTimeDays
Int

How many days before the due date the follow-up sales order is created, 0 to 9999. Defaults to 1.

nextDueDate
DateTime

The first period to bill. If it is not on the cadence, the next cadence date after it is used. Defaults to the first cadence date on or after the start date, even if that is in the past; then the past periods are billed one after the other. Only the date counts; a time part is ignored.