Swap Up

The Swap Up widget allows subscribers to upgrade or change their current subscription product directly from email without leaving their inbox.

​

How It Works

1. Subscriber receives an email with a swap option tied to their current subscription
2. Zaymo loads the customer’s current subscription and matching swap configuration
3. Subscriber selects the new product option they want
4. Zaymo calls your swap endpoint to execute the product change
5. The subscriber receives confirmation directly in the email

​

Product Configuration Requirements

Swap Up performs a whole-product replacement: it swaps the subscriber’s current subscription item for a single target product, identified by id. Because of this, your catalog must be modeled so that every swappable option is its own distinct product. To make Swap Up work, your store must meet the following requirements:

1. Each swappable option is a distinct product with its own stable id. Zaymo’s custom integration model is flat — there is no separate variant or selling-plan concept. If customers should be able to swap between, for example, three sizes or flavors, each one must be its own product with a unique id.
2. Ids must be consistent across endpoints. The id you return for a product from Get Products must be the same id that appears as items[].id in Get Current Subscription when a customer is subscribed to that product. Zaymo matches a subscriber’s current item to a configured swap by this id, so the same product must always resolve to the same id.
3. The swap is executed as id → id. When a subscriber swaps, Zaymo calls Swap Subscription Product with current_item_id (the subscriber’s current items[].id) and new_product_id (the selected product’s id). Your endpoint is responsible for replacing the item and applying your own pricing and billing-frequency rules for the new product.

​

Not supported

​

Required Endpoints

​

Getting Started

Swap Up works best when you already know which existing subscription products should map to which upgrade or replacement products. Zaymo handles the customer experience and selection flow, then sends your API the current subscription item and the newly selected product.