# ChangeContractPlanPriceDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Payload for re-pricing a plan: the new amounts, and when they start applying to the contracts
already subscribed.

## Fields
- `billSubtotalAmount` (number(double)): The new base amount charged each cycle, before tax. (min 0)
- `taxAmount` (number(double)): The new tax added to the base amount each cycle. Leave empty for no tax line. (nullable, min 0)
- `totalAmount` (number(double)): The new total charged to a subscriber each cycle. (greater than 0)
- `policy` ([ContractPlanPriceChangePolicy](https://devportal.demo.winkpg.io/docs/api/models/ContractPlanPriceChangePolicy.md)): When the new price starts applying to existing subscribers.
  Values:
  - `Immediate`: The new price applies to every charge executed from the moment the change was saved, including a charge that was already due and has not run yet.
  - `NextCycle`: The new price applies only to charges that fall due after the change was saved. A charge that was already due when the price changed still bills at the old price, so a subscriber is never re-priced part-way through a cycle they have already entered.
  - `Scheduled`: The new price applies to charges executed on or after an operator-chosen effective moment. Until then every subscriber keeps billing at the previous price.
- `effectiveFrom` (string(date-time)): The moment the new price takes effect, in UTC. Required for  `Scheduled` and ignored for the other two policies,  which derive their effective moment from when the change is saved. Required: When Policy == Scheduled. (nullable)
- `note` (string): Why the price is changing, in the operator's own words. Kept with the revision so the reason  survives alongside the amount. (nullable, max length 512)
- `concurrencyStamp` (string): The concurrency stamp read with the plan, so a price change cannot be applied on top of  someone else's. (nullable)

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.