Getting started with Appstore connector v2 setup
This document will assist you in integrating App Store Connector v2 with your Zuora site by outlining the necessary prerequisites.
Prerequisites
In order to get started, please provide Zuora with the following data.
- Tenant ID for a non-production environment to start the evaluation.
Contact Zuora Global support or the product management team to activate the Subscription Event Gateway for a particular tenant as a private early availability feature. - Basic auth credentials tied to an API user in the tenant identified.
- Refer the documentation below to view a detailed configuration of Apple or Google Play store.
Zuora Billing Connector for Apple App Store
Zuora Billing Connector for Google Play Store
Tenant Setup
To address processing and reporting needs, your tenant will be configured with some custom fields. Please find attached the necessary custom fields for different objects.
- Subscription:
- Source System User ID
- Description: Unique identifier of subscriber on app store channel (i.e. Original Transaction ID).
- Type: String (indexed)
- External Name: SourceSystemUserID__c
- Source System
- Description: App store channel name (Apple, Google, etc)
- Type: String (indexed)
- External Name: SourceSystem__c (string)
- Paused Schedule Time
- Description: Identifying when Google Pause time occurs.
- Type: String (indexed)
- External Name: Paused_Schedule_Time__c
- Unpause Schedule Time
- Description: Identifying when Google unpause time event occurs.
- Type: String (indexed)
- External Name: Unpause_Schedule_Time__c
- Pause From
- Description: Identifying when Google pause date event starts from.
- Type: Date
- External Name: Pause_From__c
- Pause Until
- Description: Identifying when Google pause date event goes until.
- Type: Date
- External Name:Pause_Until__c(date)
- Source System User ID
- SubscriptionRatePlan (aka RatePlan):
- Source System User ID
- Description: Unique identifier of subscriber on app store channel (i.e. Original Transaction ID).
- Type: String (indexed)
- External Name: SourceSystemUserID__c
- Source System
- Description: App store channel name (Apple, Google, etc)
- Type: String (indexed)
- External Name: SourceSystem__c (string)
- Source System User ID
- ProductRatePlan:
- Type
- Description: Enforces logic to process product as an annual subscription, monthly subscription or one time charge.
Note: Monthly subscriptions are treated as evergreen subscriptions and annual subscriptions are treated as termed in current logic. - Type: Picklist
- Values: ‘Annual’, ‘Monthly’, ‘One-Time’
- External Name: Type__c
- Description: Enforces logic to process product as an annual subscription, monthly subscription or one time charge.
- Type
App Store Setup
Within the app store or media channel, you'll need to set up event notifications to be sent to Zuora for processing. The endpoint is dependent on the tenant type and channel, for example:
Apple
- https://rest-staging2.zuora.com/v1/event-gateway/apple
- https://rest.pt1.zuora.com/v1/event-gateway/apple
- https://rest.apisandbox.zuora.com/v1/event-gateway/apple
- https://rest.zuora.com/event-gateway/apple
- https://rest-staging2.zuora.com/v1/event-gateway/google
- https://rest.pt1.zuora.com/v1/event-gateway/google
- https://rest.apisandbox.zuora.com/v1/event-gateway/google
- https://rest.zuora.com/event-gateway/google
Your app store and media authentication details must be shared with Zuora to accept the event.