POST /storefront/subscriptions/{id}/change-items
Creates a quote for requested changes to items and quantities. This operation applies the requested changes to the subscription when the quote is accepted.
Servers
- https://api-sandbox.rebilly.com/organizations/{organizationId}
- https://api.rebilly.com/organizations/{organizationId}
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 |
|---|---|---|---|
autopay |
Boolean | No |
Specifies if payment attempts for the related subscription are made automatically.
If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at Default value: false |
preview |
Boolean | No |
Specifies if the quote must be previewed before it is created. Subscriptions cannot be changed in the preview. Default value: false |
items[] |
Array | No |
Details of items in the subscription. |
items[].usageLimits |
No | ||
items[].planId |
String | Yes |
ID of the plan. |
items[].quantity |
Integer | No |
Number of units of the product on the given plan. |
effectiveTime |
String | No |
Effective time when changes are applied. Valid values:
Default value: "now" |
keepTrial |
Boolean | No |
Specifies whether an active trial remains in the trial state or is upgraded to a paid subscription.
If this field is set to
Default value: true |
includeNextPeriod |
Boolean | No |
Specifies if next service period amount must be included in the quote.
This is applicable only for Default value: true |
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.