Add Line Item

POST

/api/:account_id/checkout-sessions/:external_id/line-items

Add a line item to a checkout session. Works for both User and API Key authentication. Account access is automatically validated via endpoint dependency.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

external_idstringRequired

account_idstringRequired

Request

This endpoint expects an object.

price_idstringRequired

Price Identifier

quantityintegerOptional>=1Defaults to 1

Quantity of items

descriptionstring or nullOptional

Line item description

Response

Successful Response

idstring

Unique line item identifier

product_idstring

Product Identifier

price_idstring

Price Identifier

quantityinteger>=1

Quantity of items

created_atdatetime

When the line item was created

updated_atdatetime

When the line item was last updated

descriptionstring or nullOptional

Line item description

Errors

422

Unprocessable Entity Error

$	curl -X POST https://app.paymentkit.com/api/account_id/checkout-sessions/external_id/line-items \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"price_id": "price_prod_9f8d7c6b"
>	}'

1	{
2	"id": "csli_prod_9f8d7c6b1a2b",
3	"product_id": "product_prod_4e5f6a7b",
4	"price_id": "price_prod_9f8d7c6b",
5	"quantity": 1,
6	"created_at": "2024-04-20T14:45:00Z",
7	"updated_at": "2024-04-20T14:45:00Z",
8	"description": "Premium subscription plan"
9	}