ScheduledChange

A pending change on a subscription that takes effect at the end of the current billing period, such as a tier downgrade or cancellation.

In the following list, the required parameters are described first.

changeType

The type of pending change. Possible values are DOWNGRADE (a tier change to a lower level) and CANCELLATION (subscription termination).

Type: String

Valid Values: DOWNGRADE | CANCELLATION

Required: Yes

effectiveDate

The date and time when the change takes effect, in ISO 8601 format. This value is populated after the change is confirmed by the billing system.

Type: Timestamp

Required: No

planTier

For downgrades, the tier level that the subscription will change to. Not present for cancellations.

Type: String

Required: No

usageLevel

For downgrades, the target usage level after the change takes effect.

Type: String

Required: No

Contents