Skip to main content

Getting started with Appstore connector v2 setup

Zuora

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 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)
  • 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)
  • 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

Configure Events Sent to Zuora

Within the app store or media channel, you'll need to set up event notifications to be sent to Zuora for processing. The endpoint you need to configure is dependent on your Zuora tenant target environment and which connector you are configuring.

Data Center Production Environment APISandbox Environment Central Sandbox Environment
Apple
US Cloud Data Center 1 https://rest.na.zuora.com/event-gateway/apple https://rest.sandbox.na.zuora.com/event-gateway/apple https://rest.test.zuora.com/event-gateway/apple
US Cloud Data Center 2 https://rest.zuora.com/event-gateway/apple https://rest.apisandbox.zuora.com/event-gateway/apple n/a
EU Cloud Data Center https://rest.eu.zuora.com/event-gateway/apple https://rest.sandbox.eu.zuora.com/event-gateway/apple https://rest.test.eu.zuora.com/event-gateway/apple
Google
US Cloud Data Center 1 https://rest.na.zuora.com/event-gateway/google https://rest.sandbox.na.zuora.com/ev...gateway/google https://rest.test.zuora.com/event-gateway/google
US Cloud Data Center 2 https://rest.zuora.com/event-gateway/google https://rest.apisandbox.zuora.com/ev...gateway/google n/a
EU Cloud Data Center https://rest.eu.zuora.com/event-gateway/google https://rest.sandbox.eu.zuora.com/ev...gateway/google https://rest.test.eu.zuora.com/event-gateway/google

Your app store and media authentication details must be shared with Zuora to accept the event.