Omnichannel subscription item scheduled change

Represents a future change to an omnichannel_subscription_item that the store will apply later (typically at the end of the current term).

Apple App Store: Created when the customer schedules a downgrade within the same subscription group (DID_CHANGE_RENEWAL_PREF / DOWNGRADE). change_type is typically downgrade. Upgrades apply immediately and do not create this resource.

Google Play Store: Created when a product change uses the DEFERRED replacement mode (applied at term end). Immediate changes use CHARGE_PRORATED_PRICE and do not create this resource. A change_type of pause may appear for scheduled pause flows; confirm mapping against omnichannel events.

Retrieve scheduled changes with List scheduled changes for an omnichannel subscription item when has_scheduled_changes is true.

Omnichannel subscription item scheduled change attributes

optional, string, max chars=40

Uniquely identifies an omnichannel_subscription_item_scheduled_change.

omnichannel_subscription_item_id

optional, string, max chars=100

The id of the omnichannel subscription item associated with this scheduled change.

scheduled_at

required, timestamp(UTC) in seconds

Timestamp when the scheduled change is expected to take effect (typically at the end of the current term).

change_type

required, enumerated string

Indicates the type of scheduled change.

Apple App Store: Scheduled product downgrades typically use downgrade.

Google Play Store: Deferred product replacements (DEFERRED replacement mode) are represented here. Immediate prorated replacements do not create this resource.

See also omnichannel events for store notification mappings.

Enum Values

downgrade

A scheduled product change to a different (typically lower) product / plan, applied later (usually at term end).

Apple App Store: Created for scheduled downgrades (DID_CHANGE_RENEWAL_PREF / DOWNGRADE).

Google Play Store: Used for deferred product changes (DEFERRED replacement mode). Confirm with your integration whether all deferred replacements use this enum or only true downgrades.

pause

A scheduled pause of the subscription item, applied later (usually at term end).

Google Play Store: May correspond to a pause that is scheduled rather than applied immediately (for example, pause-schedule notifications). Confirm store mapping with your Chargebee omnichannel configuration.

Apple App Store: Pause scheduling is generally not applicable in the same way.

created_at

required, timestamp(UTC) in seconds

Timestamp when the omnichannel_subscription_item_scheduled_change was created in Chargebee.

modified_at

required, timestamp(UTC) in seconds

Timestamp when the omnichannel_subscription_item_scheduled_change was last modified in Chargebee.

resource_version

optional, long

Version number of this resource. The resource_version is updated with a new timestamp in milliseconds for every change made to the resource.

current_state

Snapshot of relevant item attributes before the scheduled change takes effect.

scheduled_state

Snapshot of the attributes that will apply after the scheduled change takes effect.