Skip to main content
POST
Update Item Quantity

Path Parameters

customer_type
enum<string>
required

The type of customer

Available options:
user,
team,
custom
Example:

"user"

customer_id
string
required

The ID of the customer

Example:

"user_1234567890abcdef"

item_id
string
required

The ID of the item to update

Example:

"credits"

Query Parameters

allow_negative
enum<string>
required

Whether to allow the quantity to go negative

Available options:
true,
false
Example:

"false"

Body

application/json
delta
integer
required

The amount to change the quantity by (positive to increase, negative to decrease)

Example:

100

expires_at
string

Optional expiration date for this quantity change (ISO 8601 format)

Example:

"2024-12-31T23:59:59Z"

description
string

Optional description for this quantity change

Example:

"Monthly subscription renewal"

Response

200 - application/json

Successful response

The response is of type object.