Input objects
TerminateSalesSubscriptionCommandRequestInput
Ends a subscription at a date. Every recurring line item without an end date, or with a later one, gets this end date. Periods due up to the end date are still billed; next due dates after it are removed. Follow-up sales orders that were already created are not changed. Undo it by removing or moving the end dates of the line items. - Request
input
TerminateSalesSubscriptionCommandRequestInputFields
salesSubscriptionId
ID!
required
The ID of the subscription.
endDate
DateTime
The last day a period can be due. Defaults to today. Only the date counts; a time part is ignored.
idempotencyKey
String
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?