UpdateSalesSubscriptionLineItemScheduleCommandRequestInput
Changes the schedule of a recurring line item. Only the properties that are sent change. The next due date is never recalculated by itself: it stays unless it is sent, and an end date before it ends the line item. To pause or skip periods, move the next due date. A line item that has ended needs a new next due date when its end date is removed or moved. - Request
UpdateSalesSubscriptionLineItemScheduleCommandRequestInputFields
The ID of the subscription.
The ID of the line item.
How often the line item becomes due. Changing away from the custom cadence removes 'every' and 'unit'.
For the custom cadence: the number of units between two due dates, 1 to 999.
For the custom cadence: the unit of 'every'.
The first day the schedule applies. Only the date counts; a time part is ignored.
The last day a period can be due; not before the start date. Null removes the end date. Only the date counts; a time part is ignored.
How many days before the due date the follow-up sales order is created, 0 to 9999.
The date of the next period to bill; not before the start date, not after the end date, never null. If it is not on the cadence, the next cadence date after it is used. Only the date counts; a time part is ignored.
Client-supplied idempotency key. When provided, a repeated request with the same key and payload replays the original result instead of re-executing the mutation.
Was this page helpful?