DELETE /v1/subscription_items/{item}

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

Servers

Path parameters

Name Type Required Description
item String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
proration_date Integer No

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.

clear_usage Boolean No

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

proration_behavior String No

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.

Possible values:

  • "create_prorations"
  • "always_invoice"
  • "none"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.