Getting started with appstore connector setup
Prerequisites
To enable Apple integration for subscriptions within the system, ensure the following prerequisites are completed.
1. Account Creation
Set up the user account in the system, which will serve as the foundation for creating and managing subscriptions.
Steps:
- Verify that the user’s basic profile information (e.g., email, name, payment details) is available for account creation.
- Use the system's account creation API or user interface to establish the account in the relevant environment (e.g., staging, production).
- Confirm account creation success by retrieving and verifying the user’s unique account ID.
2. OmniChannel Subscription Creation
Enable the OmniChannel Subscription, which allows the account to manage and synchronize subscriptions across multiple platforms, including Apple.
Steps:
- Initialize an OmniChannel Subscription request in the system.
- Specify the account ID created in the previous step.
- Define the subscription type, billing cycle, and additional parameters based on the subscription level and Apple’s requirements.
- Execute the request and retrieve the OmniChannel Subscription ID for confirmation.
Required Fields: Account ID
3. ExternalSubscriptionId Field Mapping to Apple’s OriginalTransactionId
Map the ExternalSubscriptionId field in the system to Apple's OriginalTransactionId to synchronize Apple subscription transactions with system records.
Steps:
- Retrieve Apple’s OriginalTransactionId for the user’s subscription from Apple’s subscription API.
- Map this OriginalTransactionId to the system’s ExternalSubscriptionId field, ensuring accurate linkage between the platforms.
- Verify the mapping by confirming the external subscription data is accessible and aligned with Apple’s records.
Required Field Mappings:
- ExternalSubscriptionId ➔ Apple’s OriginalTransactionId
Setup instructions to integrate Apple products with Zuora
1. Create Apple Products in the Zuora Product Catalog (Optional)
Align Zuora product listings with Apple products available on app stores for improved management and reporting. This step is optional, as it is only necessary if you want to ensure that Zuora product listings are directly synchronized with the Apple products in the app stores, enhancing visibility and reporting accuracy.
Steps:
- Navigate to the Zuora Dashboard.
- Go to Product Catalog and select Add Product.
- Enter the necessary details for Apple products, including names, descriptions, and pricing information.
- Save the new products to the catalog.
2. Product Mapping
Ensure that subscription changes and purchases from the app store are accurately reflected in Zuora by mapping Apple product identifiers to Zuora product rate plans.
Steps:
- Go to the Product Catalog in Zuora.
- Select Rate Plans and choose the rate plans to map.
- Enter the Apple product identifier (e.g., Apple SKU or Product ID) in the corresponding fields, and add it to the
ExternallyManagedPlanID
field as needed. - Save the mappings to link Apple products with Zuora rate plans.
3. Subscription Management
Follow guidelines to effectively manage subscriptions and billing, ensuring proper handling of subscriber accounts and payment processes.
Steps:
- Refer to the Omnichannel User Guide for detailed instructions related to subscription management.
- Follow the guide to set up and manage subscriptions, configure billing settings, and handle subscription lifecycle events.
Setup instructions to integrate Google products with Zuora
1. Create Google Products in the Zuora Product Catalog (Optional)
Align Zuora product listings with Google Play products to improve management and reporting. This step is optional but helpful for maintaining synchronized and accurate records.
Steps:
- Navigate to the Zuora Dashboard.
- Go to the Product Catalog and select Add Product.
- Enter details for Google Play products, including names, descriptions, and pricing.
- Save the new products to the catalog.
2. Product Mapping
Ensure that subscription changes and purchases from the Google Play Store are accurately reflected in Zuora by mapping Google product identifiers to Zuora product rate plans.
Steps:
- Go to the Product Catalog in Zuora.
- Select Rate Plans and choose the rate plans to map.
- Enter the Google product identifier (e.g., purchaseToken or other relevant Google identifiers) in the corresponding fields and add it to the ExternallyManagedPlanID field as needed.
- Save the mappings to link Google Play products with Zuora rate plans.
3. Subscription Management
Follow the guidelines to manage subscriptions and billing, ensuring proper handling of subscriber accounts and payment processes.
Steps:
- Refer to the Omnichannel User Guide for detailed instructions on subscription management.
- Follow the guide to set up and manage subscriptions, configure billing settings, and handle lifecycle events like renewals, cancellations, or upgrades.
Setup instructions to integrate Roku products with Zuora
1. Credential Setup
Authenticate and connect to Roku Pay by providing necessary credentials in Zuora.
Steps:
- Obtain your Roku channel_id (the unique identifier for your Roku channel).
- Obtain your Roku api_key (the API key for accessing Roku Pay services).
- Add the channel_id and api_key to the Zuora configuration in the appropriate settings section.
2. Create Roku Products in the Zuora Product Catalog (Optional)
Maintain synchronization between Roku products and Zuora product listings to enhance visibility and reporting.
Steps:
- Navigate to the Zuora Dashboard.
- Go to the Product Catalog and select Add Product.
- Enter the necessary details for Roku products, including names, descriptions, and pricing.
- Save the new products to the catalog.
3. Product Mapping (Optional)
Ensure accurate reflection of subscription data from Roku Pay by mapping Roku product identifiers to Zuora product rate plans.
Steps:
- Go to the Product Catalog in Zuora.
- Select Rate Plans and choose the rate plans to map.
- Enter the Roku product identifier (e.g., channel_id) in the corresponding fields and add it to the ExternallyManagedPlanID field as needed.
- Save the mappings to link Roku products with Zuora rate plans.
4. Subscription Management
Effectively manage Roku subscriptions and billing to ensure proper handling of subscriber accounts and renewals.
Steps:
- Refer to the Omnichannel User Guide for detailed instructions on subscription management.
- Follow the guide to configure billing settings, manage renewals, and handle lifecycle events like cancellations or upgrades.
Benefits of Integration
- Improved Accuracy: Accurate reflection of data from the app store in Zuora reduces errors and discrepancies in billing and reporting.
- Unified View: Provides a comprehensive view of subscriber activities and product details across app stores and Zuora, streamlining reporting and analysis.
- Efficient Management: Simplifies subscription management and billing processes by automating data synchronization, saving time and effort.
- Scalability: Supports high-scale subscription businesses by processing a large volume of subscription changes in real-time, maintaining up-to-date records.