Skip to main content
inputCreateSalesSubscriptionChargeLineItemCommandRequestInput

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.

chargeType
String!
required

The type of the charge. Known values: SHIPPING, SHIPPING_SURCHARGE, SHIPPING_SURCHARGE_ITEM, PAYMENT_FEE, CASH_ON_DELIVERY_FEE, GIFT_WRAP, INTEREST, HANDLING_FEE, TRUSTED_SHOPS, RETURN_DELIVERY, FREE_GIFT. The type of a charge line item.

itemId
ID

Required for 'FreeGift' and 'ShippingSurchargeItem', not allowed for the other types: the ID of the item.

name
String!
required

The name printed on the sales order; not empty.

salesPriceNet
Decimal!
required

The net amount of the charge.

quantity
Decimal

The quantity; greater than 0. Defaults to 1.

taxClassId
ID

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

note
String

A note on the line item.

sortOrder
Int

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

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.