Store Config JSON Schema

AppStoreModel

Object containing the following properties:

Property	Type
schemaVersion (*)	string
appId (*)	string
versionString	string
pricing	PriceSchedule
availableTerritories	AvailableTerritories
inAppPurchases	Array of InAppPurchase items
subscriptionGroups	Array of SubscriptionGroup items
primaryLocale	LocaleCode
localizations	Array of AppStoreLocalization items
copyright	string

(*) Required.

AppStoreAppInfoLocalization

Object containing the following properties:

Property	Type
name	string
subtitle	string
privacyPolicyUrl	string (url)
privacyChoicesUrl	string (url)

All properties are optional.

AppStoreLocalization

Intersection of the following types:

• Object with properties:
  • locale (*): LocaleCode
  and AppStoreAppInfoLocalization
• AppStoreVersionLocalization

AppStoreVersionLocalization

Object containing the following properties:

Property	Type
description	string
keywords	string
marketingUrl	string (url)
promotionalText	string
supportUrl	string (url)
whatsNew	string

All properties are optional.

Availability

Object containing the following properties:

Property	Type
availableInNewTerritories (*)	boolean
availableTerritories (*)	AvailableTerritories

(*) Required.

AvailableTerritories

Union of the following possible types:

• Array of TerritoryCode items
• 'worldwide'

InAppPurchase

Object containing the following properties:

Property	Type
productId (*)	string
type (*)	'CONSUMABLE' | 'NON_CONSUMABLE' | 'NON_RENEWING_SUBSCRIPTION'
referenceName (*)	string
familySharable (*)	boolean
reviewNote	string
pricing	PriceSchedule
availability	Availability
localizations	Array of Localization items

(*) Required.

IntroductoryOffer

Union of the following possible types:

• Object with properties:
  • type (*): 'PAY_AS_YOU_GO'
  • numberOfPeriods (*): number
  • pricing (*): PriceSchedule
  • availableTerritories (*): AvailableTerritories
• Object with properties:
  • type (*): 'PAY_UP_FRONT'
  • duration (*): SubscriptionOfferDuration
  • pricing (*): PriceSchedule
  • availableTerritories (*): AvailableTerritories
• Object with properties:
  • type (*): 'FREE_TRIAL'
  • duration (*): SubscriptionOfferDuration
  • availableTerritories (*): AvailableTerritories

LocaleCode

Enum, one of the following possible values:

Expand for full list of 39 values

• 'ar-SA'
• 'ca'
• 'zh-Hans'
• 'zh-Hant'
• 'hr'
• 'cs'
• 'da'
• 'nl-NL'
• 'en-AU'
• 'en-CA'
• 'en-GB'
• 'en-US'
• 'fi'
• 'fr-FR'
• 'fr-CA'
• 'de-DE'
• 'el'
• 'he'
• 'hi'
• 'hu'
• 'id'
• 'it'
• 'ja'
• 'ko'
• 'ms'
• 'no'
• 'pl'
• 'pt-BR'
• 'pt-PT'
• 'ro'
• 'ru'
• 'sk'
• 'es-MX'
• 'es-ES'
• 'sv'
• 'th'
• 'tr'
• 'uk'
• 'vi'

Localization

Object containing the following properties:

Property	Type
locale (*)	LocaleCode
name (*)	string
description (*)	string

(*) Required.

PriceSchedule

Object containing the following properties:

Property	Type
baseTerritory (*)	TerritoryCode
prices (*)	Array of Price items

(*) Required.

Price

Object containing the following properties:

Property	Type
price (*)	string
territory (*)	TerritoryCode

(*) Required.

SubscriptionGroupLocalization

Object containing the following properties:

Property	Type
locale (*)	LocaleCode
name (*)	string
customName (*)	string (nullable)

(*) Required.

SubscriptionGroup

Object containing the following properties:

Property	Type
referenceName (*)	string
localizations (*)	Array of SubscriptionGroupLocalization items
subscriptions (*)	Array of Subscription items

(*) Required.

SubscriptionOfferDuration

Enum, one of the following possible values:

• 'THREE_DAYS'
• 'ONE_WEEK'
• 'TWO_WEEKS'
• 'ONE_MONTH'
• 'TWO_MONTHS'
• 'THREE_MONTHS'
• 'SIX_MONTHS'
• 'ONE_YEAR'

SubscriptionPeriod

Enum, one of the following possible values:

• 'ONE_WEEK'
• 'ONE_MONTH'
• 'TWO_MONTHS'
• 'THREE_MONTHS'
• 'SIX_MONTHS'
• 'ONE_YEAR'

Subscription

Object containing the following properties:

Property	Type
productId (*)	string
referenceName (*)	string
groupLevel (*)	number
subscriptionPeriod (*)	SubscriptionPeriod
familySharable (*)	boolean
reviewNote	string
pricing	PriceSchedule
introductoryOffers	Array of IntroductoryOffer items
availability	Availability
localizations	Array of Localization items

(*) Required.

TerritoryCode

Enum, one of the following possible values:

Expand for full list of 175 values

• 'AFG'
• 'AGO'
• 'AIA'
• 'ALB'
• 'ARE'
• 'ARG'
• 'ARM'
• 'ATG'
• 'AUS'
• 'AUT'
• 'AZE'
• 'BEL'
• 'BEN'
• 'BFA'
• 'BGR'
• 'BHR'
• 'BHS'
• 'BIH'
• 'BLR'
• 'BLZ'
• 'BMU'
• 'BOL'
• 'BRA'
• 'BRB'
• 'BRN'
• 'BTN'
• 'BWA'
• 'CAN'
• 'CHE'
• 'CHL'
• 'CHN'
• 'CIV'
• 'CMR'
• 'COD'
• 'COG'
• 'COL'
• 'CPV'
• 'CRI'
• 'CYM'
• 'CYP'
• 'CZE'
• 'DEU'
• 'DMA'
• 'DNK'
• 'DOM'
• 'DZA'
• 'ECU'
• 'EGY'
• 'ESP'
• 'EST'
• 'FIN'
• 'FJI'
• 'FRA'
• 'FSM'
• 'GAB'
• 'GBR'
• 'GEO'
• 'GHA'
• 'GMB'
• 'GNB'
• 'GRC'
• 'GRD'
• 'GTM'
• 'GUY'
• 'HKG'
• 'HND'
• 'HRV'
• 'HUN'
• 'IDN'
• 'IND'
• 'IRL'
• 'IRQ'
• 'ISL'
• 'ISR'
• 'ITA'
• 'JAM'
• 'JOR'
• 'JPN'
• 'KAZ'
• 'KEN'
• 'KGZ'
• 'KHM'
• 'KNA'
• 'KOR'
• 'KWT'
• 'LAO'
• 'LBN'
• 'LBR'
• 'LBY'
• 'LCA'
• 'LKA'
• 'LTU'
• 'LUX'
• 'LVA'
• 'MAC'
• 'MAR'
• 'MDA'
• 'MDG'
• 'MDV'
• 'MEX'
• 'MKD'
• 'MLI'
• 'MLT'
• 'MMR'
• 'MNE'
• 'MNG'
• 'MOZ'
• 'MRT'
• 'MSR'
• 'MUS'
• 'MWI'
• 'MYS'
• 'NAM'
• 'NER'
• 'NGA'
• 'NIC'
• 'NLD'
• 'NOR'
• 'NPL'
• 'NRU'
• 'NZL'
• 'OMN'
• 'PAK'
• 'PAN'
• 'PER'
• 'PHL'
• 'PLW'
• 'PNG'
• 'POL'
• 'PRT'
• 'PRY'
• 'QAT'
• 'ROU'
• 'RUS'
• 'RWA'
• 'SAU'
• 'SEN'
• 'SGP'
• 'SLB'
• 'SLE'
• 'SLV'
• 'SRB'
• 'STP'
• 'SUR'
• 'SVK'
• 'SVN'
• 'SWE'
• 'SWZ'
• 'SYC'
• 'TCA'
• 'TCD'
• 'THA'
• 'TJK'
• 'TKM'
• 'TON'
• 'TTO'
• 'TUN'
• 'TUR'
• 'TWN'
• 'TZA'
• 'UGA'
• 'UKR'
• 'URY'
• 'USA'
• 'UZB'
• 'VCT'
• 'VEN'
• 'VGB'
• 'VNM'
• 'VUT'
• 'XKS'
• 'YEM'
• 'ZAF'
• 'ZMB'
• 'ZWE'