v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Update a subscription item

Updates the plan or quantity of an item on a current subscription.

post/v1/subscription_items/{item}

Path parameters

itemstring required

Response

Successful response.

billed_untilinteger

The time period the subscription item has been billed for.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

current_period_endinteger required

The end time of this subscription item's current billing period.

current_period_startinteger required

The start time of this subscription item's current billing period.

idstring required

Unique identifier for the object.

metadataobject required

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

object'subscription_item' required

String representing the object's type. Objects of the same type share the same value.

quantityinteger

The quantity of the plan to which the customer should be subscribed.

subscriptionstring required

The subscription this subscription_item belongs to.