Skip to main content

UpdateSubscriptionItem updates the quantity of a subscription item.

PATCH 
/api/v1/billing/subscription/items/:id

Changes the quantity of an existing subscription item. Set quantity to 0 to effectively remove the item. Proration may apply based on billing settings.

Authorization​

Requires billing:manage permission.

Response​

Returns updated SubscriptionItem.

Errors​

  • NOT_FOUND: Item with specified ID does not exist
  • INVALID_ARGUMENT: Quantity must be >= 0
  • FAILED_PRECONDITION: Cannot reduce below active usage
  • PERMISSION_DENIED: Caller lacks billing:manage permission

Request​

Responses​

A successful response.