Delete a subscription item

Changed on

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

delete/v1/subscription_items/{item}

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/subscription_items/{item}
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

itemstring required

Request body application/x-www-form-urlencoded

clear_usageboolean

Delete all usage for the given subscription item. Allowed only when the current plan's usage_type is metered.

payment_behavior'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete'

Controls how Stripe handles payment when a subscription update requires payment and collection_method=charge_automatically.

proration_behavior'always_invoice' | 'create_prorations' | 'none'

Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting billing_cycle_anchor=now, or starting a trial), or if an item's quantity changes. The default value is create_prorations.

proration_dateinteger

If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.

Response

Successful response.

deletedtrue required

Always true for a deleted object

idstring required

Unique identifier for the object.

object'subscription_item' required

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

Changes

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.