Skip to main content

CreateLineItemRequest

namestring
descriptionstringnullable
quantityinteger

Possible values: >= 1

unitPriceinteger<int64>

Unit price in integer minor currency units for a custom line (with name) that has no priceId. Sending unitPrice together with priceId returns 400; catalog lines are charged at the catalog price.

Possible values: >= 0

priceIdstringnullable

Catalog price identifier. The line is charged and stored at this price's unit amount; do not also send unitPrice. Its currency must match the session. The product's non-null taxRateBps is authoritative (zero means exempt, null inherits scoped/category rules). Tax-inclusive catalog prices are rejected rather than taxed twice; use custom net lines in PRECOMPUTED mode or an amount-only gross receivable.

taxablebooleannullable

Defaults to true for custom lines; a catalog product's explicit tax treatment cannot be overridden.

categoryCodestringnullable

Tax-provider category code matched against configured category tax rules, not a merchandising category ID.

Possible values: non-empty and <= 255 characters

taxAmountinteger<int64>nullable

Required on every PRECOMPUTED line, including zero-tax lines; exact line tax, not per-unit tax. Forbidden in AUTOMATIC mode.

Possible values: >= 0

CreateLineItemRequest
{
"name": "string",
"description": "string",
"quantity": 0,
"unitPrice": 0,
"priceId": "string",
"taxable": true,
"categoryCode": "string",
"taxAmount": 0
}