---
title: "Update Subscription Item Price"
method: POST
path: "/subscription/updatesubscriptionitemprice"
tags: ["Subscription API"]
---

# Update Subscription Item Price

`POST /subscription/updatesubscriptionitemprice`

Updates (or creates a preview of an update to) the price of an existing subscription. If <code>AlignToCurrentInterval</code> is set to <code>true</code>, the response returns a prorated price that will be applied to the subscription item immediately. Optionally, it also allows you adjust the quantity of a subscription item.<br /> For XML examples and schemas, see the [Additional Examples - Update Subscription Item Price](https://dev.cleverbridge.com/page/additional-examples-update-subscription-item-price).

## Headers

- `Accept` 'application/json' | 'application/xml'
- `Content-Type` 'application/json' | 'application/xml'

## Request body

- CleverbridgeBackEndRestApiSubscriptionClassesUpdateSubscriptionItemPriceRequest
  - `AlignmentSettings` CleverbridgeBackEndRestApiSubscriptionClassesSubscriptionAlignmentSettings — Define the behavior when adding or updating a subscription item. For more information, see [Alignment Settings](https://dev.cleverbridge.com/docs/subscription-api-get-started#alignment-settings).
    - `AlignToCurrentInterval` boolean, required — Set to <code>true</code> if you want the customer to be charged immediately for the updated item (for example, a quantity increase). Otherwise, the customer will be charged at the next renewal.
    - `ExtendInterval` boolean — Set to <code>true</code> if you want to charge a full interval for the updated item (for example, a quantity increase). Otherwise, the customer will be charged a pro-rated amount for the updated item that corresponds to the time between the update and the next renewal. Important: <code>AlignToCurrentInterval</code> must be set to <code>true</code> if <code>ExtendInterval</code> is set to <code>true</code>.
    - `GetCustomerPricePreviewOnly` boolean, required — Set to <code>true</code> if you only want to obtain preview data in the response. You can use this data to display a price preview to a customer or for testing purposes.
  - `CustomerPrice` CleverbridgeBackEndRestApiSubscriptionClassesCustomerPrice — Pricing information that the customer receives during the purchase process.
    - `CurrencyId` string — Currency code in capital letters, see [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
    - `IsGross` boolean — Set to <code>true</code> if taxes should be included in the item price. Set to <code>false</code> if taxes should be added on top of the item price. For more information, see [Using the IsGross Subparameter](https://dev.cleverbridge.com/docs/subscription-api-get-started#using-the-isgross-subparameter).
    - `Value` number, double — New price to be paid by the customer.
  - `GenerateMail` boolean — Set to <code>false</code> if you want to suppress the automatically generated email that informs the customer about the subscription update. Important: If set to <code>false</code>, you must send the email yourself. For more information, see [Best Practices: Obtaining Customer Consent](https://docs.cleverbridge.com/public/all/using-the-platform/best-practices-obtain-customer-consent.htm?utm_source=developer-docs&amp;utm_medium=api-reference).
  - `Quantity` integer — Number of items. If you want to only increase the quantity of an existing subscription item, use <code>/subscription/increasesubscriptionitemquantity</code> instead.
  - `RunningNumber` integer, required — Running number of the item in the subscription.
  - `SubscriptionId` string, required — Unique ID of the subscription, with or without an initial 'S'.
  - `UpdateAction` 'Update' | 'Upgrade' | 'Downgrade', required — Type of update. This is used for reporting only. It does not affect the subscription.
  - `ForcePriceRecalculation` boolean — Set to <code>true</code> if you want to update the price of the subscription item based on the current product price. You can use the parameter independent of any other price-relevant updates, such as a quantity or product change. For more information, see [Use Case: Update Existing Subscription with New Product Pricing](https://dev.cleverbridge.com/docs/update-existing-subscription-with-new-product-pricing).

## Response `200`

OK

- CleverbridgeBackEndRestApiSubscriptionClassesUpdateSubscriptionItemPriceResponse
  - `AlignmentCustomerGrossPrice` number, double — Total gross price for alignment interval. Only for <code>CustomerPricePreview-Mode</code>.
  - `AlignmentCustomerNetPrice` number, double — Total net price for alignment interval. Only for <code>CustomerPricePreview-Mode</code>.
  - `AlignmentCustomerVatPrice` number, double — Total VAT amount for alignment interval. Only for <code>CustomerPricePreview-Mode</code>.
  - `NextBillingCustomerGrossPrice` number, double — Total gross price for next billing interval. Only for <code>CustomerPricePreview-Mode</code>.
  - `NextBillingCustomerNetPrice` number, double — Total net price next billing interval. Only for <code>CustomerPricePreview-Mode</code>.
  - `NextBillingCustomerVatPrice` number, double — Total VAT amount for next billing interval. Only for <code>CustomerPricePreview-Mode</code>.
  - `NextRenewalCustomerGrossPrice` number, double — Total gross price for next subscription interval. Only for <code>CustomerPricePreview-Mode</code>.
  - `NextRenewalCustomerNetPrice` number, double — Total net price next subscription interval. Only for <code>CustomerPricePreview-Mode</code>.
  - `NextRenewalCustomerVatPrice` number, double — Total VAT amount for next subscription interval. Only for <code>CustomerPricePreview-Mode</code>.
  - `PriceCurrencyId` string — Currency code in capital letters, see [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  - `ResultMessage` string — Optional result or error message.

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/cleverbridge/apis/backend-rest-apis.md) · [All operations](https://skmtc.net/cleverbridge/apis/backend-rest-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cleverbridge/backend-rest-apis/versions/b7007b62f4c0/schema)