Skip to main content
inputCreateSalesSubscriptionItemLineItemCommandRequestInput

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.

itemId
ID!
required

The ID of the item. The item must exist and must not be a component of another item.

quantity
Decimal!
required

The quantity billed per period; greater than 0.

salesPriceNet
Decimal

The net price per unit. Defaults to the price of the item for the customer.

discountPercent
Decimal

The discount in percent, 0 to 100.

name
String

The name printed on the sales order. Defaults to the name of the item.

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.