alternateProduct
A switch-plan message and product ID you provide in a real-time response to your Get Retention Message endpoint.
Declaration
object alternateProductProperties
| Name | Type | Description |
|---|---|---|
messageIdentifier Required | messageIdentifier | The message identifier of the text to display in the switch-plan retention message. |
productId Required | productId | The product identifier of the subscription the retention message suggests for your customer to switch to. |
billingPlanType | billingPlanType |
Mentioned in
Discussion
In your RealtimeResponseBody real-time response, you can choose from mutually exclusive options. Include alternateProduct in your response to provide a switch-plan retention message.
Use the product identifier in DecodedRealtimeRequestBody to determine the customer’s current subscription. Choose an alternative subscription from the same subscription group.
The message identifier needs to refer to a message that doesn’t include an image and that has a messageState of APPROVED; otherwise, the retention message fails. For more information about setting up messages, see Upload Message.