Skip to main content
inputCreateSalesSubscriptionCustomLineItemCommandRequestInput

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.

name
String!
required

The name printed on the sales order; not empty.

quantity
Decimal!
required

The quantity billed per period; greater than 0.

salesPriceNet
Decimal!
required

The net price per unit.

taxClassId
ID

The ID of the tax class. Defaults to the default tax class.

discountPercent
Decimal

The discount in percent, 0 to 100.

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.