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.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
billSubtotalAmount
required |
number (double) | The new base amount charged each cycle, before tax.
min 0
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
taxAmount
required |
number (double) | The new tax added to the base amount each cycle. Leave empty for no tax line.
nullablemin 0
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
totalAmount
required |
number (double) | The new total charged to a subscriber each cycle.
greater than 0
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
policy
required |
ContractPlanPriceChangePolicy ContractPlanPriceChangePolicy | When the new price starts applying to existing subscribers.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
effectiveFrom
required |
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
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
note
required |
string | Why the price is changing, in the operator's own words. Kept with the revision so the reason
survives alongside the amount.
nullablemax length 512
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
concurrencyStamp
required |
string | The concurrency stamp read with the plan, so a price change cannot be applied on top of
someone else's.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.