ContractPlanPriceDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
One priced revision of a plan, as published to callers.
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 | ||||||
|---|---|---|---|---|---|---|---|---|
id
required |
string (uuid) | Identifies this revision.
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.
| ||||||
billSubtotalAmount
required |
number (double) | The base amount charged each cycle, before tax.
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 tax added to the base amount each cycle, or null when the plan carries no tax line.
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.
| ||||||
totalAmount
required |
number (double) | The total charged to the subscriber's payment method each cycle.
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 this revision starts applying, in UTC.
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 | The propagation policy the revision was saved under.
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.
| ||||||
recordedAt
required |
string (date-time) | When the revision was saved, in UTC.
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.
| ||||||
recordedByUserId
required |
string (uuid) | The operator who saved the revision, or null when the platform wrote it.
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 changed, in the operator's own words.
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.