Skip to main content
inputCreateSalesSubscriptionVoucherLineItemCommandRequestInput

Fields

salesSubscriptionId
ID!
required

The ID of the subscription.

clientId
String

A temporary identifier chosen by the client, for example to match the answer to an optimistic update. It is not stored and is returned unchanged.

voucherType
SalesSubscriptionVoucherType!
required

The type of the voucher.

name
String!
required

The name printed on the sales order; not empty.

amount
Decimal!
required

The value of one voucher; greater than 0.

quantity
Decimal

The number of vouchers per period; greater than 0. Defaults to 1.

note
String

A note on the line item.

sortOrder
Int

The position of the line item. Defaults to the end.

schedule
SalesSubscriptionScheduleInput!
required

When the line item is billed.

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.