PATCH /subscriptions/{id}/items/{itemId}

Updates a subscription order item. This is an experimental endpoint and may be changed or removed in the future.

Servers

Request headers

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

Default value: "application/json"

Request body fields

Name Type Required Description
excludeFromMrr Boolean No

Specifies if this item should be excluded from monthly recurring revenue calculations.

plan Object No

Details of the subscription item plan.

plan.productOptions Object No

Name-value pairs that specify the product options.

quantityFilled Number No

Filled quantity of the subscription item (experimental property).

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.