Skip to main content

RemoveSubscriptionItem removes an item from the subscription.

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

Removes a subscription item either immediately or at the end of the current billing period. Items with active usage may require at_period_end=true.

Authorization​

Requires billing:manage permission.

Behavior​

  • at_period_end=true: Item continues until period end, then removed
  • at_period_end=false: Item removed immediately, prorated credit may apply

Errors​

  • NOT_FOUND: Item with specified ID does not exist
  • FAILED_PRECONDITION: Item has active usage and at_period_end=false
  • PERMISSION_DENIED: Caller lacks billing:manage permission

Request​

Responses​

A successful response.