POST /v1/subscription_items

Adds a new item to an existing subscription. No existing items will be changed or replaced.

Servers

https://api.stripe.com/

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
`discounts`		No	The coupons to redeem into discounts for the subscription item.
`price`	String	No	The ID of the price object.
`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.
`subscription`	String	Yes	The identifier of the subscription to modify.
`tax_rates`		No	A list of Tax Rate ids. These Tax Rates will override the `default_tax_rates` on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
`billing_thresholds`		No	Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
`expand[]`	Array	No	Specifies which fields in the response should be expanded.
`price_data`	Object	No	Data used to generate a new Price object inline.
`price_data.unit_amount`	Integer	No
`price_data.unit_amount_decimal`	String	No
`price_data.product`	String	Yes
`price_data.recurring`	Object	Yes
`price_data.recurring.interval`	String	Yes	Valid values: `"month"` `"day"` `"week"` `"year"`
`price_data.recurring.interval_count`	Integer	No
`price_data.tax_behavior`	String	No	Valid values: `"inclusive"` `"unspecified"` `"exclusive"`
`price_data.currency`	String	Yes
`payment_behavior`	String	No	Controls how Stripe handles payment when a subscription update requires payment and `collection_method=charge_automatically`. Valid values: `"pending_if_incomplete"` `"error_if_incomplete"` `"default_incomplete"` `"allow_incomplete"`
`quantity`	Integer	No	The quantity you'd like to apply to the subscription item you're creating.
`metadata`	Object	No	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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
`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`. Valid values: `"create_prorations"` `"always_invoice"` `"none"`

How to start integrating

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.