@revenuecat/purchases-capacitor 6.0.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +1446 -0
- package/RevenueCatPurchasesCapacitor.podspec +18 -0
- package/android/build.gradle +60 -0
- package/android/src/main/AndroidManifest.xml +2 -0
- package/android/src/main/java/com/revenuecat/purchases/capacitor/PurchasesPlugin.kt +699 -0
- package/android/src/main/res/.gitkeep +0 -0
- package/dist/docs.json +2985 -0
- package/dist/esm/definitions.d.ts +657 -0
- package/dist/esm/definitions.js +2 -0
- package/dist/esm/definitions.js.map +1 -0
- package/dist/esm/index.d.ts +4 -0
- package/dist/esm/index.js +7 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/web.d.ts +148 -0
- package/dist/esm/web.js +177 -0
- package/dist/esm/web.js.map +1 -0
- package/dist/plugin.cjs.js +200 -0
- package/dist/plugin.cjs.js.map +1 -0
- package/dist/plugin.js +202 -0
- package/dist/plugin.js.map +1 -0
- package/ios/Plugin/CAPPluginCallExtensions.swift +37 -0
- package/ios/Plugin/Info.plist +24 -0
- package/ios/Plugin/PluginHelperExtensions.swift +63 -0
- package/ios/Plugin/PropertySetterPluginExtensions.swift +146 -0
- package/ios/Plugin/PurchasesPlugin.h +10 -0
- package/ios/Plugin/PurchasesPlugin.m +63 -0
- package/ios/Plugin/PurchasesPlugin.swift +352 -0
- package/package.json +77 -0
package/dist/docs.json
ADDED
|
@@ -0,0 +1,2985 @@
|
|
|
1
|
+
{
|
|
2
|
+
"api": {
|
|
3
|
+
"name": "PurchasesPlugin",
|
|
4
|
+
"slug": "purchasesplugin",
|
|
5
|
+
"docs": "",
|
|
6
|
+
"tags": [],
|
|
7
|
+
"methods": [
|
|
8
|
+
{
|
|
9
|
+
"name": "configure",
|
|
10
|
+
"signature": "(configuration: PurchasesConfiguration) => Promise<void>",
|
|
11
|
+
"parameters": [
|
|
12
|
+
{
|
|
13
|
+
"name": "configuration",
|
|
14
|
+
"docs": "RevenueCat configuration object including the API key and other optional parameters. See {@link PurchasesConfiguration}",
|
|
15
|
+
"type": "PurchasesConfiguration"
|
|
16
|
+
}
|
|
17
|
+
],
|
|
18
|
+
"returns": "Promise<void>",
|
|
19
|
+
"tags": [
|
|
20
|
+
{
|
|
21
|
+
"name": "param",
|
|
22
|
+
"text": "configuration RevenueCat configuration object including the API key and other optional parameters. See {@link PurchasesConfiguration}"
|
|
23
|
+
}
|
|
24
|
+
],
|
|
25
|
+
"docs": "Sets up Purchases with your API key and an app user id.",
|
|
26
|
+
"complexTypes": [
|
|
27
|
+
"PurchasesConfiguration"
|
|
28
|
+
],
|
|
29
|
+
"slug": "configure"
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"name": "setFinishTransactions",
|
|
33
|
+
"signature": "(options: { finishTransactions: boolean; }) => Promise<void>",
|
|
34
|
+
"parameters": [
|
|
35
|
+
{
|
|
36
|
+
"name": "options",
|
|
37
|
+
"docs": "Set finishTransactions to false if you aren't using Purchases SDK to\nmake the purchase",
|
|
38
|
+
"type": "{ finishTransactions: boolean; }"
|
|
39
|
+
}
|
|
40
|
+
],
|
|
41
|
+
"returns": "Promise<void>",
|
|
42
|
+
"tags": [
|
|
43
|
+
{
|
|
44
|
+
"name": "param",
|
|
45
|
+
"text": "options Set finishTransactions to false if you aren't using Purchases SDK to\nmake the purchase"
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"name": "returns",
|
|
49
|
+
"text": "The promise will be rejected if configure has not been called yet."
|
|
50
|
+
}
|
|
51
|
+
],
|
|
52
|
+
"docs": "",
|
|
53
|
+
"complexTypes": [],
|
|
54
|
+
"slug": "setfinishtransactions"
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
"name": "setSimulatesAskToBuyInSandbox",
|
|
58
|
+
"signature": "(options: { simulatesAskToBuyInSandbox: boolean; }) => Promise<void>",
|
|
59
|
+
"parameters": [
|
|
60
|
+
{
|
|
61
|
+
"name": "options",
|
|
62
|
+
"docs": "Set this property to true *only* when testing the ask-to-buy / SCA\npurchases flow. More information: http://errors.rev.cat/ask-to-buy",
|
|
63
|
+
"type": "{ simulatesAskToBuyInSandbox: boolean; }"
|
|
64
|
+
}
|
|
65
|
+
],
|
|
66
|
+
"returns": "Promise<void>",
|
|
67
|
+
"tags": [
|
|
68
|
+
{
|
|
69
|
+
"name": "param",
|
|
70
|
+
"text": "options Set this property to true *only* when testing the ask-to-buy / SCA\npurchases flow. More information: http://errors.rev.cat/ask-to-buy"
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
"name": "returns",
|
|
74
|
+
"text": "The promise will be rejected if configure has not been called yet."
|
|
75
|
+
}
|
|
76
|
+
],
|
|
77
|
+
"docs": "iOS only.",
|
|
78
|
+
"complexTypes": [],
|
|
79
|
+
"slug": "setsimulatesasktobuyinsandbox"
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
"name": "addCustomerInfoUpdateListener",
|
|
83
|
+
"signature": "(customerInfoUpdateListener: CustomerInfoUpdateListener) => Promise<PurchasesCallbackId>",
|
|
84
|
+
"parameters": [
|
|
85
|
+
{
|
|
86
|
+
"name": "customerInfoUpdateListener",
|
|
87
|
+
"docs": "CustomerInfo update listener",
|
|
88
|
+
"type": "CustomerInfoUpdateListener"
|
|
89
|
+
}
|
|
90
|
+
],
|
|
91
|
+
"returns": "Promise<string>",
|
|
92
|
+
"tags": [
|
|
93
|
+
{
|
|
94
|
+
"name": "param",
|
|
95
|
+
"text": "customerInfoUpdateListener CustomerInfo update listener"
|
|
96
|
+
}
|
|
97
|
+
],
|
|
98
|
+
"docs": "Sets a function to be called on updated customer info",
|
|
99
|
+
"complexTypes": [
|
|
100
|
+
"CustomerInfoUpdateListener",
|
|
101
|
+
"PurchasesCallbackId"
|
|
102
|
+
],
|
|
103
|
+
"slug": "addcustomerinfoupdatelistener"
|
|
104
|
+
},
|
|
105
|
+
{
|
|
106
|
+
"name": "removeCustomerInfoUpdateListener",
|
|
107
|
+
"signature": "(listenerToRemove: PurchasesCallbackId) => Promise<{ wasRemoved: boolean; }>",
|
|
108
|
+
"parameters": [
|
|
109
|
+
{
|
|
110
|
+
"name": "listenerToRemove",
|
|
111
|
+
"docs": "CustomerInfoUpdateListener reference of the listener to remove",
|
|
112
|
+
"type": "string"
|
|
113
|
+
}
|
|
114
|
+
],
|
|
115
|
+
"returns": "Promise<{ wasRemoved: boolean; }>",
|
|
116
|
+
"tags": [
|
|
117
|
+
{
|
|
118
|
+
"name": "param",
|
|
119
|
+
"text": "listenerToRemove CustomerInfoUpdateListener reference of the listener to remove"
|
|
120
|
+
},
|
|
121
|
+
{
|
|
122
|
+
"name": "returns",
|
|
123
|
+
"text": "Promise with boolean. True if listener was removed, false otherwise"
|
|
124
|
+
}
|
|
125
|
+
],
|
|
126
|
+
"docs": "Removes a given CustomerInfoUpdateListener",
|
|
127
|
+
"complexTypes": [
|
|
128
|
+
"PurchasesCallbackId"
|
|
129
|
+
],
|
|
130
|
+
"slug": "removecustomerinfoupdatelistener"
|
|
131
|
+
},
|
|
132
|
+
{
|
|
133
|
+
"name": "getOfferings",
|
|
134
|
+
"signature": "() => Promise<PurchasesOfferings>",
|
|
135
|
+
"parameters": [],
|
|
136
|
+
"returns": "Promise<PurchasesOfferings>",
|
|
137
|
+
"tags": [
|
|
138
|
+
{
|
|
139
|
+
"name": "returns",
|
|
140
|
+
"text": "Promise of entitlements structure. The promise will be rejected if configure\nhas not been called yet."
|
|
141
|
+
}
|
|
142
|
+
],
|
|
143
|
+
"docs": "Gets the map of entitlements -> offerings -> products",
|
|
144
|
+
"complexTypes": [
|
|
145
|
+
"PurchasesOfferings"
|
|
146
|
+
],
|
|
147
|
+
"slug": "getofferings"
|
|
148
|
+
},
|
|
149
|
+
{
|
|
150
|
+
"name": "getProducts",
|
|
151
|
+
"signature": "(options: GetProductOptions) => Promise<{ products: PurchasesStoreProduct[]; }>",
|
|
152
|
+
"parameters": [
|
|
153
|
+
{
|
|
154
|
+
"name": "options",
|
|
155
|
+
"docs": "",
|
|
156
|
+
"type": "GetProductOptions"
|
|
157
|
+
}
|
|
158
|
+
],
|
|
159
|
+
"returns": "Promise<{ products: PurchasesStoreProduct[]; }>",
|
|
160
|
+
"tags": [
|
|
161
|
+
{
|
|
162
|
+
"name": "returns",
|
|
163
|
+
"text": "A promise containing an array of products. The promise will be rejected\nif the products are not properly configured in RevenueCat or if there is another error retrieving them.\nRejections return an error code, and a userInfo object with more information. The promise will also be rejected\nif configure has not been called yet."
|
|
164
|
+
}
|
|
165
|
+
],
|
|
166
|
+
"docs": "Fetch the product info",
|
|
167
|
+
"complexTypes": [
|
|
168
|
+
"PurchasesStoreProduct",
|
|
169
|
+
"GetProductOptions"
|
|
170
|
+
],
|
|
171
|
+
"slug": "getproducts"
|
|
172
|
+
},
|
|
173
|
+
{
|
|
174
|
+
"name": "purchaseStoreProduct",
|
|
175
|
+
"signature": "(options: PurchaseStoreProductOptions) => Promise<MakePurchaseResult>",
|
|
176
|
+
"parameters": [
|
|
177
|
+
{
|
|
178
|
+
"name": "options",
|
|
179
|
+
"docs": "",
|
|
180
|
+
"type": "PurchaseStoreProductOptions"
|
|
181
|
+
}
|
|
182
|
+
],
|
|
183
|
+
"returns": "Promise<MakePurchaseResult>",
|
|
184
|
+
"tags": [
|
|
185
|
+
{
|
|
186
|
+
"name": "returns",
|
|
187
|
+
"text": "A promise of an object containing\na customer info object and a product identifier. Rejections return an error code,\na boolean indicating if the user cancelled the purchase, and an object with more information. The promise will\nalso be rejected if configure has not been called yet."
|
|
188
|
+
}
|
|
189
|
+
],
|
|
190
|
+
"docs": "Make a purchase",
|
|
191
|
+
"complexTypes": [
|
|
192
|
+
"MakePurchaseResult",
|
|
193
|
+
"PurchaseStoreProductOptions"
|
|
194
|
+
],
|
|
195
|
+
"slug": "purchasestoreproduct"
|
|
196
|
+
},
|
|
197
|
+
{
|
|
198
|
+
"name": "purchaseDiscountedProduct",
|
|
199
|
+
"signature": "(options: PurchaseDiscountedProductOptions) => Promise<MakePurchaseResult>",
|
|
200
|
+
"parameters": [
|
|
201
|
+
{
|
|
202
|
+
"name": "options",
|
|
203
|
+
"docs": "",
|
|
204
|
+
"type": "PurchaseDiscountedProductOptions"
|
|
205
|
+
}
|
|
206
|
+
],
|
|
207
|
+
"returns": "Promise<MakePurchaseResult>",
|
|
208
|
+
"tags": [
|
|
209
|
+
{
|
|
210
|
+
"name": "returns",
|
|
211
|
+
"text": "A promise of an object containing\na customer info object and a product identifier. Rejections return an error code,\na boolean indicating if the user cancelled the purchase, and an object with more information. The promise will be\nrejected if configure has not been called yet."
|
|
212
|
+
}
|
|
213
|
+
],
|
|
214
|
+
"docs": "iOS only. Purchase a product applying a given discount.",
|
|
215
|
+
"complexTypes": [
|
|
216
|
+
"MakePurchaseResult",
|
|
217
|
+
"PurchaseDiscountedProductOptions"
|
|
218
|
+
],
|
|
219
|
+
"slug": "purchasediscountedproduct"
|
|
220
|
+
},
|
|
221
|
+
{
|
|
222
|
+
"name": "purchasePackage",
|
|
223
|
+
"signature": "(options: PurchasePackageOptions) => Promise<MakePurchaseResult>",
|
|
224
|
+
"parameters": [
|
|
225
|
+
{
|
|
226
|
+
"name": "options",
|
|
227
|
+
"docs": "",
|
|
228
|
+
"type": "PurchasePackageOptions"
|
|
229
|
+
}
|
|
230
|
+
],
|
|
231
|
+
"returns": "Promise<MakePurchaseResult>",
|
|
232
|
+
"tags": [
|
|
233
|
+
{
|
|
234
|
+
"name": "returns",
|
|
235
|
+
"text": "A promise of an object containing\na customer info object and a product identifier. Rejections return an error code, a boolean indicating if the\nuser cancelled the purchase, and an object with more information. The promise will be also be rejected if configure\nhas not been called yet."
|
|
236
|
+
}
|
|
237
|
+
],
|
|
238
|
+
"docs": "Make a purchase",
|
|
239
|
+
"complexTypes": [
|
|
240
|
+
"MakePurchaseResult",
|
|
241
|
+
"PurchasePackageOptions"
|
|
242
|
+
],
|
|
243
|
+
"slug": "purchasepackage"
|
|
244
|
+
},
|
|
245
|
+
{
|
|
246
|
+
"name": "purchaseSubscriptionOption",
|
|
247
|
+
"signature": "(options: PurchaseSubscriptionOptionOptions) => Promise<MakePurchaseResult>",
|
|
248
|
+
"parameters": [
|
|
249
|
+
{
|
|
250
|
+
"name": "options",
|
|
251
|
+
"docs": "",
|
|
252
|
+
"type": "PurchaseSubscriptionOptionOptions"
|
|
253
|
+
}
|
|
254
|
+
],
|
|
255
|
+
"returns": "Promise<MakePurchaseResult>",
|
|
256
|
+
"tags": [
|
|
257
|
+
{
|
|
258
|
+
"name": "returns",
|
|
259
|
+
"text": "A promise of an object containing\na customer info object and a product identifier. Rejections return an error code, a boolean indicating if the\nuser cancelled the purchase, and an object with more information. The promise will be also be rejected if configure\nhas not been called yet."
|
|
260
|
+
}
|
|
261
|
+
],
|
|
262
|
+
"docs": "Google only. Make a purchase of a subscriptionOption",
|
|
263
|
+
"complexTypes": [
|
|
264
|
+
"MakePurchaseResult",
|
|
265
|
+
"PurchaseSubscriptionOptionOptions"
|
|
266
|
+
],
|
|
267
|
+
"slug": "purchasesubscriptionoption"
|
|
268
|
+
},
|
|
269
|
+
{
|
|
270
|
+
"name": "purchaseDiscountedPackage",
|
|
271
|
+
"signature": "(options: PurchaseDiscountedPackageOptions) => Promise<MakePurchaseResult>",
|
|
272
|
+
"parameters": [
|
|
273
|
+
{
|
|
274
|
+
"name": "options",
|
|
275
|
+
"docs": "",
|
|
276
|
+
"type": "PurchaseDiscountedPackageOptions"
|
|
277
|
+
}
|
|
278
|
+
],
|
|
279
|
+
"returns": "Promise<MakePurchaseResult>",
|
|
280
|
+
"tags": [
|
|
281
|
+
{
|
|
282
|
+
"name": "returns",
|
|
283
|
+
"text": "A promise of an object containing\na customer info object and a product identifier. Rejections return an error code, a boolean indicating if the\nuser cancelled the purchase, and an object with more information. The promise will be also be rejected if configure\nhas not been called yet."
|
|
284
|
+
}
|
|
285
|
+
],
|
|
286
|
+
"docs": "iOS only. Purchase a package applying a given discount.",
|
|
287
|
+
"complexTypes": [
|
|
288
|
+
"MakePurchaseResult",
|
|
289
|
+
"PurchaseDiscountedPackageOptions"
|
|
290
|
+
],
|
|
291
|
+
"slug": "purchasediscountedpackage"
|
|
292
|
+
},
|
|
293
|
+
{
|
|
294
|
+
"name": "restorePurchases",
|
|
295
|
+
"signature": "() => Promise<{ customerInfo: CustomerInfo; }>",
|
|
296
|
+
"parameters": [],
|
|
297
|
+
"returns": "Promise<{ customerInfo: CustomerInfo; }>",
|
|
298
|
+
"tags": [
|
|
299
|
+
{
|
|
300
|
+
"name": "returns",
|
|
301
|
+
"text": "A promise of a customer info object. Rejections return an error code, and an\nuserInfo object with more information. The promise will be also be rejected if configure has not been called yet."
|
|
302
|
+
}
|
|
303
|
+
],
|
|
304
|
+
"docs": "Restores a user's previous purchases and links their appUserIDs to any user's also using those purchases.",
|
|
305
|
+
"complexTypes": [
|
|
306
|
+
"CustomerInfo"
|
|
307
|
+
],
|
|
308
|
+
"slug": "restorepurchases"
|
|
309
|
+
},
|
|
310
|
+
{
|
|
311
|
+
"name": "getAppUserID",
|
|
312
|
+
"signature": "() => Promise<{ appUserID: string; }>",
|
|
313
|
+
"parameters": [],
|
|
314
|
+
"returns": "Promise<{ appUserID: string; }>",
|
|
315
|
+
"tags": [
|
|
316
|
+
{
|
|
317
|
+
"name": "returns",
|
|
318
|
+
"text": "The app user id in a promise"
|
|
319
|
+
}
|
|
320
|
+
],
|
|
321
|
+
"docs": "Get the appUserID",
|
|
322
|
+
"complexTypes": [],
|
|
323
|
+
"slug": "getappuserid"
|
|
324
|
+
},
|
|
325
|
+
{
|
|
326
|
+
"name": "logIn",
|
|
327
|
+
"signature": "(options: { appUserID: string; }) => Promise<LogInResult>",
|
|
328
|
+
"parameters": [
|
|
329
|
+
{
|
|
330
|
+
"name": "options",
|
|
331
|
+
"docs": "The appUserID that should be linked to the current user",
|
|
332
|
+
"type": "{ appUserID: string; }"
|
|
333
|
+
}
|
|
334
|
+
],
|
|
335
|
+
"returns": "Promise<LogInResult>",
|
|
336
|
+
"tags": [
|
|
337
|
+
{
|
|
338
|
+
"name": "param",
|
|
339
|
+
"text": "options The appUserID that should be linked to the current user"
|
|
340
|
+
},
|
|
341
|
+
{
|
|
342
|
+
"name": "returns",
|
|
343
|
+
"text": "A promise of an object that contains the customerInfo after logging in, as well\nas a boolean indicating whether the user has just been created for the first time in the RevenueCat backend. The\npromise will be rejected if configure has not been called yet or if there's an issue logging in."
|
|
344
|
+
}
|
|
345
|
+
],
|
|
346
|
+
"docs": "This function will log in the current user with an appUserID. Typically, this would be used after a log in\nto identify a user without calling configure.",
|
|
347
|
+
"complexTypes": [
|
|
348
|
+
"LogInResult"
|
|
349
|
+
],
|
|
350
|
+
"slug": "login"
|
|
351
|
+
},
|
|
352
|
+
{
|
|
353
|
+
"name": "logOut",
|
|
354
|
+
"signature": "() => Promise<{ customerInfo: CustomerInfo; }>",
|
|
355
|
+
"parameters": [],
|
|
356
|
+
"returns": "Promise<{ customerInfo: CustomerInfo; }>",
|
|
357
|
+
"tags": [
|
|
358
|
+
{
|
|
359
|
+
"name": "returns",
|
|
360
|
+
"text": "A promise of a customer info object. Rejections return an error code,\nand a userInfo object with more information. The promise will be rejected if configure has not been called yet or if\nthere's an issue logging out."
|
|
361
|
+
}
|
|
362
|
+
],
|
|
363
|
+
"docs": "Logs out the Purchases client clearing the saved appUserID. This will generate a random user id and save it in the cache.",
|
|
364
|
+
"complexTypes": [
|
|
365
|
+
"CustomerInfo"
|
|
366
|
+
],
|
|
367
|
+
"slug": "logout"
|
|
368
|
+
},
|
|
369
|
+
{
|
|
370
|
+
"name": "setLogLevel",
|
|
371
|
+
"signature": "(options: { level: LOG_LEVEL; }) => Promise<void>",
|
|
372
|
+
"parameters": [
|
|
373
|
+
{
|
|
374
|
+
"name": "options",
|
|
375
|
+
"docs": "Log level to use to display logs.",
|
|
376
|
+
"type": "{ level: LOG_LEVEL; }"
|
|
377
|
+
}
|
|
378
|
+
],
|
|
379
|
+
"returns": "Promise<void>",
|
|
380
|
+
"tags": [
|
|
381
|
+
{
|
|
382
|
+
"name": "param",
|
|
383
|
+
"text": "options Log level to use to display logs."
|
|
384
|
+
}
|
|
385
|
+
],
|
|
386
|
+
"docs": "Used to set the log level. Useful for debugging issues with the lovely team @RevenueCat.\nThe default is {LOG_LEVEL.INFO} in release builds and {LOG_LEVEL.DEBUG} in debug builds.",
|
|
387
|
+
"complexTypes": [
|
|
388
|
+
"LOG_LEVEL"
|
|
389
|
+
],
|
|
390
|
+
"slug": "setloglevel"
|
|
391
|
+
},
|
|
392
|
+
{
|
|
393
|
+
"name": "setLogHandler",
|
|
394
|
+
"signature": "(logHandler: LogHandler) => Promise<void>",
|
|
395
|
+
"parameters": [
|
|
396
|
+
{
|
|
397
|
+
"name": "logHandler",
|
|
398
|
+
"docs": "It will get called for each log event.\nUse this function to redirect the log to your own logging system",
|
|
399
|
+
"type": "LogHandler"
|
|
400
|
+
}
|
|
401
|
+
],
|
|
402
|
+
"returns": "Promise<void>",
|
|
403
|
+
"tags": [
|
|
404
|
+
{
|
|
405
|
+
"name": "param",
|
|
406
|
+
"text": "logHandler It will get called for each log event.\nUse this function to redirect the log to your own logging system"
|
|
407
|
+
}
|
|
408
|
+
],
|
|
409
|
+
"docs": "Set a custom log handler for redirecting logs to your own logging system.\nBy default, this sends info, warning, and error messages.\nIf you wish to receive Debug level messages, see [setLogLevel].",
|
|
410
|
+
"complexTypes": [
|
|
411
|
+
"LogHandler"
|
|
412
|
+
],
|
|
413
|
+
"slug": "setloghandler"
|
|
414
|
+
},
|
|
415
|
+
{
|
|
416
|
+
"name": "getCustomerInfo",
|
|
417
|
+
"signature": "() => Promise<{ customerInfo: CustomerInfo; }>",
|
|
418
|
+
"parameters": [],
|
|
419
|
+
"returns": "Promise<{ customerInfo: CustomerInfo; }>",
|
|
420
|
+
"tags": [
|
|
421
|
+
{
|
|
422
|
+
"name": "returns",
|
|
423
|
+
"text": "A promise of a customer info object. Rejections return an error code, and an\nuserInfo object with more information. The promise will be rejected if configure has not been called yet or if\nthere's an issue getting the customer information."
|
|
424
|
+
}
|
|
425
|
+
],
|
|
426
|
+
"docs": "Gets current customer info",
|
|
427
|
+
"complexTypes": [
|
|
428
|
+
"CustomerInfo"
|
|
429
|
+
],
|
|
430
|
+
"slug": "getcustomerinfo"
|
|
431
|
+
},
|
|
432
|
+
{
|
|
433
|
+
"name": "syncPurchases",
|
|
434
|
+
"signature": "() => Promise<void>",
|
|
435
|
+
"parameters": [],
|
|
436
|
+
"returns": "Promise<void>",
|
|
437
|
+
"tags": [
|
|
438
|
+
{
|
|
439
|
+
"name": "warning",
|
|
440
|
+
"text": "This function should only be called if you're not calling purchaseProduct/purchaseStoreProduct/purchasePackage/purchaseSubscriptionOption."
|
|
441
|
+
},
|
|
442
|
+
{
|
|
443
|
+
"name": "returns",
|
|
444
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsyncing purchases."
|
|
445
|
+
}
|
|
446
|
+
],
|
|
447
|
+
"docs": "This method will send all the purchases to the RevenueCat backend. Call this when using your own implementation\nfor subscriptions anytime a sync is needed, like after a successful purchase.",
|
|
448
|
+
"complexTypes": [],
|
|
449
|
+
"slug": "syncpurchases"
|
|
450
|
+
},
|
|
451
|
+
{
|
|
452
|
+
"name": "syncObserverModeAmazonPurchase",
|
|
453
|
+
"signature": "(options: SyncObserverModeAmazonPurchaseOptions) => Promise<void>",
|
|
454
|
+
"parameters": [
|
|
455
|
+
{
|
|
456
|
+
"name": "options",
|
|
457
|
+
"docs": "",
|
|
458
|
+
"type": "SyncObserverModeAmazonPurchaseOptions"
|
|
459
|
+
}
|
|
460
|
+
],
|
|
461
|
+
"returns": "Promise<void>",
|
|
462
|
+
"tags": [
|
|
463
|
+
{
|
|
464
|
+
"name": "returns",
|
|
465
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsyncing purchases."
|
|
466
|
+
}
|
|
467
|
+
],
|
|
468
|
+
"docs": "This method will send a purchase to the RevenueCat backend. This function should only be called if you are\nin Amazon observer mode or performing a client side migration of your current users to RevenueCat.\n\nThe receipt IDs are cached if successfully posted, so they are not posted more than once.",
|
|
469
|
+
"complexTypes": [
|
|
470
|
+
"SyncObserverModeAmazonPurchaseOptions"
|
|
471
|
+
],
|
|
472
|
+
"slug": "syncobservermodeamazonpurchase"
|
|
473
|
+
},
|
|
474
|
+
{
|
|
475
|
+
"name": "enableAdServicesAttributionTokenCollection",
|
|
476
|
+
"signature": "() => Promise<void>",
|
|
477
|
+
"parameters": [],
|
|
478
|
+
"returns": "Promise<void>",
|
|
479
|
+
"tags": [
|
|
480
|
+
{
|
|
481
|
+
"name": "returns",
|
|
482
|
+
"text": "The promise will be rejected if configure has not been called yet."
|
|
483
|
+
}
|
|
484
|
+
],
|
|
485
|
+
"docs": "Enable automatic collection of Apple Search Ad attribution on iOS. Disabled by default. Supported in iOS 14.3+ only",
|
|
486
|
+
"complexTypes": [],
|
|
487
|
+
"slug": "enableadservicesattributiontokencollection"
|
|
488
|
+
},
|
|
489
|
+
{
|
|
490
|
+
"name": "isAnonymous",
|
|
491
|
+
"signature": "() => Promise<{ isAnonymous: boolean; }>",
|
|
492
|
+
"parameters": [],
|
|
493
|
+
"returns": "Promise<{ isAnonymous: boolean; }>",
|
|
494
|
+
"tags": [
|
|
495
|
+
{
|
|
496
|
+
"name": "returns",
|
|
497
|
+
"text": "If the `appUserID` has been generated by RevenueCat or not.\nThe promise will be rejected if configure has not been called yet."
|
|
498
|
+
}
|
|
499
|
+
],
|
|
500
|
+
"docs": "",
|
|
501
|
+
"complexTypes": [],
|
|
502
|
+
"slug": "isanonymous"
|
|
503
|
+
},
|
|
504
|
+
{
|
|
505
|
+
"name": "checkTrialOrIntroductoryPriceEligibility",
|
|
506
|
+
"signature": "(options: { productIdentifiers: string[]; }) => Promise<{ [productId: string]: IntroEligibility; }>",
|
|
507
|
+
"parameters": [
|
|
508
|
+
{
|
|
509
|
+
"name": "options",
|
|
510
|
+
"docs": "Array of product identifiers for which you want to compute eligibility",
|
|
511
|
+
"type": "{ productIdentifiers: string[]; }"
|
|
512
|
+
}
|
|
513
|
+
],
|
|
514
|
+
"returns": "Promise<{ [productId: string]: IntroEligibility; }>",
|
|
515
|
+
"tags": [
|
|
516
|
+
{
|
|
517
|
+
"name": "note",
|
|
518
|
+
"text": "Subscription groups are automatically collected for determining eligibility. If RevenueCat can't\ndefinitively compute the eligibility, most likely because of missing group information, it will return\n`INTRO_ELIGIBILITY_STATUS_UNKNOWN`. The best course of action on unknown status is to display the non-intro\npricing, to not create a misleading situation. To avoid this, make sure you are testing with the latest version of\niOS so that the subscription group can be collected by the SDK. Android always returns INTRO_ELIGIBILITY_STATUS_UNKNOWN."
|
|
519
|
+
},
|
|
520
|
+
{
|
|
521
|
+
"name": "param",
|
|
522
|
+
"text": "options Array of product identifiers for which you want to compute eligibility"
|
|
523
|
+
},
|
|
524
|
+
{
|
|
525
|
+
"name": "returns",
|
|
526
|
+
"text": ": IntroEligibility> } A map of IntroEligility per productId. The promise\nwill be rejected if configure has not been called yet or if there's in an error checking eligibility."
|
|
527
|
+
}
|
|
528
|
+
],
|
|
529
|
+
"docs": "iOS only. Computes whether a user is eligible for the introductory pricing period of a given product.\nYou should use this method to determine whether you show the user the normal product price or the\nintroductory price. This also applies to trials (trials are considered a type of introductory pricing).",
|
|
530
|
+
"complexTypes": [
|
|
531
|
+
"IntroEligibility"
|
|
532
|
+
],
|
|
533
|
+
"slug": "checktrialorintroductorypriceeligibility"
|
|
534
|
+
},
|
|
535
|
+
{
|
|
536
|
+
"name": "getPromotionalOffer",
|
|
537
|
+
"signature": "(options: GetPromotionalOfferOptions) => Promise<PurchasesPromotionalOffer | undefined>",
|
|
538
|
+
"parameters": [
|
|
539
|
+
{
|
|
540
|
+
"name": "options",
|
|
541
|
+
"docs": "",
|
|
542
|
+
"type": "GetPromotionalOfferOptions"
|
|
543
|
+
}
|
|
544
|
+
],
|
|
545
|
+
"returns": "Promise<PurchasesPromotionalOffer | undefined>",
|
|
546
|
+
"tags": [
|
|
547
|
+
{
|
|
548
|
+
"name": "returns",
|
|
549
|
+
"text": "Returns when the `PurchasesPaymentDiscount` is returned.\nNull is returned for Android and incompatible iOS versions. The promise will be rejected if configure has not been\ncalled yet or if there's an error getting the payment discount."
|
|
550
|
+
}
|
|
551
|
+
],
|
|
552
|
+
"docs": "iOS only. Use this function to retrieve the `PurchasesPromotionalOffer` for a given `PurchasesPackage`.",
|
|
553
|
+
"complexTypes": [
|
|
554
|
+
"PurchasesPromotionalOffer",
|
|
555
|
+
"GetPromotionalOfferOptions"
|
|
556
|
+
],
|
|
557
|
+
"slug": "getpromotionaloffer"
|
|
558
|
+
},
|
|
559
|
+
{
|
|
560
|
+
"name": "invalidateCustomerInfoCache",
|
|
561
|
+
"signature": "() => Promise<void>",
|
|
562
|
+
"parameters": [],
|
|
563
|
+
"returns": "Promise<void>",
|
|
564
|
+
"tags": [
|
|
565
|
+
{
|
|
566
|
+
"name": "returns",
|
|
567
|
+
"text": "The promise will be rejected if configure has not been called yet or there's an error\ninvalidating the customer info cache."
|
|
568
|
+
}
|
|
569
|
+
],
|
|
570
|
+
"docs": "Invalidates the cache for customer information.\n\nMost apps will not need to use this method; invalidating the cache can leave your app in an invalid state.\nRefer to https://docs.revenuecat.com/docs/customer-info#section-get-user-information for more information on\nusing the cache properly.\n\nThis is useful for cases where customer information might have been updated outside the app, like if a\npromotional subscription is granted through the RevenueCat dashboard.",
|
|
571
|
+
"complexTypes": [],
|
|
572
|
+
"slug": "invalidatecustomerinfocache"
|
|
573
|
+
},
|
|
574
|
+
{
|
|
575
|
+
"name": "presentCodeRedemptionSheet",
|
|
576
|
+
"signature": "() => Promise<void>",
|
|
577
|
+
"parameters": [],
|
|
578
|
+
"returns": "Promise<void>",
|
|
579
|
+
"tags": [
|
|
580
|
+
{
|
|
581
|
+
"name": "returns",
|
|
582
|
+
"text": "The promise will be rejected if configure has not been called yet or there's an error\npresenting the code redemption sheet."
|
|
583
|
+
}
|
|
584
|
+
],
|
|
585
|
+
"docs": "iOS 14.0+ only. Presents a code redemption sheet, useful for redeeming offer codes\nRefer to https://docs.revenuecat.com/docs/ios-subscription-offers#offer-codes for more information on how\nto configure and use offer codes",
|
|
586
|
+
"complexTypes": [],
|
|
587
|
+
"slug": "presentcoderedemptionsheet"
|
|
588
|
+
},
|
|
589
|
+
{
|
|
590
|
+
"name": "setAttributes",
|
|
591
|
+
"signature": "(attributes: { [key: string]: string | null; }) => Promise<void>",
|
|
592
|
+
"parameters": [
|
|
593
|
+
{
|
|
594
|
+
"name": "attributes",
|
|
595
|
+
"docs": "Map of attributes by key. Set the value as an empty string to delete an attribute.",
|
|
596
|
+
"type": "{ [key: string]: string | null; }"
|
|
597
|
+
}
|
|
598
|
+
],
|
|
599
|
+
"returns": "Promise<void>",
|
|
600
|
+
"tags": [
|
|
601
|
+
{
|
|
602
|
+
"name": "param",
|
|
603
|
+
"text": "attributes Map of attributes by key. Set the value as an empty string to delete an attribute."
|
|
604
|
+
},
|
|
605
|
+
{
|
|
606
|
+
"name": "returns",
|
|
607
|
+
"text": "The promise will be rejected if configure has not been called yet or there's an error\nsetting the subscriber attributes."
|
|
608
|
+
}
|
|
609
|
+
],
|
|
610
|
+
"docs": "Subscriber attributes are useful for storing additional, structured information on a user.\nSince attributes are writable using a public key they should not be used for\nmanaging secure or sensitive information such as subscription status, coins, etc.\n\nKey names starting with \"$\" are reserved names used by RevenueCat. For a full list of key\nrestrictions refer to our guide: https://docs.revenuecat.com/docs/subscriber-attributes",
|
|
611
|
+
"complexTypes": [],
|
|
612
|
+
"slug": "setattributes"
|
|
613
|
+
},
|
|
614
|
+
{
|
|
615
|
+
"name": "setEmail",
|
|
616
|
+
"signature": "(options: { email: string | null; }) => Promise<void>",
|
|
617
|
+
"parameters": [
|
|
618
|
+
{
|
|
619
|
+
"name": "options",
|
|
620
|
+
"docs": "Empty String or null will delete the subscriber attribute.",
|
|
621
|
+
"type": "{ email: string | null; }"
|
|
622
|
+
}
|
|
623
|
+
],
|
|
624
|
+
"returns": "Promise<void>",
|
|
625
|
+
"tags": [
|
|
626
|
+
{
|
|
627
|
+
"name": "param",
|
|
628
|
+
"text": "options Empty String or null will delete the subscriber attribute."
|
|
629
|
+
},
|
|
630
|
+
{
|
|
631
|
+
"name": "returns",
|
|
632
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting the email."
|
|
633
|
+
}
|
|
634
|
+
],
|
|
635
|
+
"docs": "Subscriber attribute associated with the email address for the user",
|
|
636
|
+
"complexTypes": [],
|
|
637
|
+
"slug": "setemail"
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
"name": "setPhoneNumber",
|
|
641
|
+
"signature": "(options: { phoneNumber: string | null; }) => Promise<void>",
|
|
642
|
+
"parameters": [
|
|
643
|
+
{
|
|
644
|
+
"name": "options",
|
|
645
|
+
"docs": "Empty String or null will delete the subscriber attribute.",
|
|
646
|
+
"type": "{ phoneNumber: string | null; }"
|
|
647
|
+
}
|
|
648
|
+
],
|
|
649
|
+
"returns": "Promise<void>",
|
|
650
|
+
"tags": [
|
|
651
|
+
{
|
|
652
|
+
"name": "param",
|
|
653
|
+
"text": "options Empty String or null will delete the subscriber attribute."
|
|
654
|
+
},
|
|
655
|
+
{
|
|
656
|
+
"name": "returns",
|
|
657
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting the phone number."
|
|
658
|
+
}
|
|
659
|
+
],
|
|
660
|
+
"docs": "Subscriber attribute associated with the phone number for the user",
|
|
661
|
+
"complexTypes": [],
|
|
662
|
+
"slug": "setphonenumber"
|
|
663
|
+
},
|
|
664
|
+
{
|
|
665
|
+
"name": "setDisplayName",
|
|
666
|
+
"signature": "(options: { displayName: string | null; }) => Promise<void>",
|
|
667
|
+
"parameters": [
|
|
668
|
+
{
|
|
669
|
+
"name": "options",
|
|
670
|
+
"docs": "Empty String or null will delete the subscriber attribute.",
|
|
671
|
+
"type": "{ displayName: string | null; }"
|
|
672
|
+
}
|
|
673
|
+
],
|
|
674
|
+
"returns": "Promise<void>",
|
|
675
|
+
"tags": [
|
|
676
|
+
{
|
|
677
|
+
"name": "param",
|
|
678
|
+
"text": "options Empty String or null will delete the subscriber attribute."
|
|
679
|
+
},
|
|
680
|
+
{
|
|
681
|
+
"name": "returns",
|
|
682
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting the display name."
|
|
683
|
+
}
|
|
684
|
+
],
|
|
685
|
+
"docs": "Subscriber attribute associated with the display name for the user",
|
|
686
|
+
"complexTypes": [],
|
|
687
|
+
"slug": "setdisplayname"
|
|
688
|
+
},
|
|
689
|
+
{
|
|
690
|
+
"name": "setPushToken",
|
|
691
|
+
"signature": "(options: { pushToken: string | null; }) => Promise<void>",
|
|
692
|
+
"parameters": [
|
|
693
|
+
{
|
|
694
|
+
"name": "options",
|
|
695
|
+
"docs": "null will delete the subscriber attribute.",
|
|
696
|
+
"type": "{ pushToken: string | null; }"
|
|
697
|
+
}
|
|
698
|
+
],
|
|
699
|
+
"returns": "Promise<void>",
|
|
700
|
+
"tags": [
|
|
701
|
+
{
|
|
702
|
+
"name": "param",
|
|
703
|
+
"text": "options null will delete the subscriber attribute."
|
|
704
|
+
},
|
|
705
|
+
{
|
|
706
|
+
"name": "returns",
|
|
707
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting the push token."
|
|
708
|
+
}
|
|
709
|
+
],
|
|
710
|
+
"docs": "Subscriber attribute associated with the push token for the user",
|
|
711
|
+
"complexTypes": [],
|
|
712
|
+
"slug": "setpushtoken"
|
|
713
|
+
},
|
|
714
|
+
{
|
|
715
|
+
"name": "setProxyURL",
|
|
716
|
+
"signature": "(options: { url: string; }) => Promise<void>",
|
|
717
|
+
"parameters": [
|
|
718
|
+
{
|
|
719
|
+
"name": "options",
|
|
720
|
+
"docs": "",
|
|
721
|
+
"type": "{ url: string; }"
|
|
722
|
+
}
|
|
723
|
+
],
|
|
724
|
+
"returns": "Promise<void>",
|
|
725
|
+
"tags": [
|
|
726
|
+
{
|
|
727
|
+
"name": "returns",
|
|
728
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting the proxy url."
|
|
729
|
+
}
|
|
730
|
+
],
|
|
731
|
+
"docs": "Set this property to your proxy URL before configuring Purchases *only* if you've received a proxy key value\nfrom your RevenueCat contact.",
|
|
732
|
+
"complexTypes": [],
|
|
733
|
+
"slug": "setproxyurl"
|
|
734
|
+
},
|
|
735
|
+
{
|
|
736
|
+
"name": "collectDeviceIdentifiers",
|
|
737
|
+
"signature": "() => Promise<void>",
|
|
738
|
+
"parameters": [],
|
|
739
|
+
"returns": "Promise<void>",
|
|
740
|
+
"tags": [
|
|
741
|
+
{
|
|
742
|
+
"name": "returns",
|
|
743
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting collecting the device identifiers."
|
|
744
|
+
}
|
|
745
|
+
],
|
|
746
|
+
"docs": "Automatically collect subscriber attributes associated with the device identifiers.\n$idfa, $idfv, $ip on iOS\n$gpsAdId, $androidId, $ip on Android",
|
|
747
|
+
"complexTypes": [],
|
|
748
|
+
"slug": "collectdeviceidentifiers"
|
|
749
|
+
},
|
|
750
|
+
{
|
|
751
|
+
"name": "setAdjustID",
|
|
752
|
+
"signature": "(options: { adjustID: string | null; }) => Promise<void>",
|
|
753
|
+
"parameters": [
|
|
754
|
+
{
|
|
755
|
+
"name": "options",
|
|
756
|
+
"docs": "Adjust ID to use in Adjust integration. Empty String or null will delete the subscriber attribute.",
|
|
757
|
+
"type": "{ adjustID: string | null; }"
|
|
758
|
+
}
|
|
759
|
+
],
|
|
760
|
+
"returns": "Promise<void>",
|
|
761
|
+
"tags": [
|
|
762
|
+
{
|
|
763
|
+
"name": "param",
|
|
764
|
+
"text": "options Adjust ID to use in Adjust integration. Empty String or null will delete the subscriber attribute."
|
|
765
|
+
},
|
|
766
|
+
{
|
|
767
|
+
"name": "returns",
|
|
768
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting Adjust ID."
|
|
769
|
+
}
|
|
770
|
+
],
|
|
771
|
+
"docs": "Subscriber attribute associated with the Adjust ID for the user\nRequired for the RevenueCat Adjust integration",
|
|
772
|
+
"complexTypes": [],
|
|
773
|
+
"slug": "setadjustid"
|
|
774
|
+
},
|
|
775
|
+
{
|
|
776
|
+
"name": "setAppsflyerID",
|
|
777
|
+
"signature": "(options: { appsflyerID: string | null; }) => Promise<void>",
|
|
778
|
+
"parameters": [
|
|
779
|
+
{
|
|
780
|
+
"name": "options",
|
|
781
|
+
"docs": "Appsflyer ID to use in Appsflyer integration. Empty String or null will delete the subscriber attribute.",
|
|
782
|
+
"type": "{ appsflyerID: string | null; }"
|
|
783
|
+
}
|
|
784
|
+
],
|
|
785
|
+
"returns": "Promise<void>",
|
|
786
|
+
"tags": [
|
|
787
|
+
{
|
|
788
|
+
"name": "param",
|
|
789
|
+
"text": "options Appsflyer ID to use in Appsflyer integration. Empty String or null will delete the subscriber attribute."
|
|
790
|
+
},
|
|
791
|
+
{
|
|
792
|
+
"name": "returns",
|
|
793
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting the Appsflyer ID."
|
|
794
|
+
}
|
|
795
|
+
],
|
|
796
|
+
"docs": "Subscriber attribute associated with the AppsFlyer ID for the user\nRequired for the RevenueCat AppsFlyer integration",
|
|
797
|
+
"complexTypes": [],
|
|
798
|
+
"slug": "setappsflyerid"
|
|
799
|
+
},
|
|
800
|
+
{
|
|
801
|
+
"name": "setFBAnonymousID",
|
|
802
|
+
"signature": "(options: { fbAnonymousID: string | null; }) => Promise<void>",
|
|
803
|
+
"parameters": [
|
|
804
|
+
{
|
|
805
|
+
"name": "options",
|
|
806
|
+
"docs": "Facebook Anonymous ID to use in Mparticle integration. Empty String or null will delete the subscriber attribute.",
|
|
807
|
+
"type": "{ fbAnonymousID: string | null; }"
|
|
808
|
+
}
|
|
809
|
+
],
|
|
810
|
+
"returns": "Promise<void>",
|
|
811
|
+
"tags": [
|
|
812
|
+
{
|
|
813
|
+
"name": "param",
|
|
814
|
+
"text": "options Facebook Anonymous ID to use in Mparticle integration. Empty String or null will delete the subscriber attribute."
|
|
815
|
+
},
|
|
816
|
+
{
|
|
817
|
+
"name": "returns",
|
|
818
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting the Facebook Anonymous ID."
|
|
819
|
+
}
|
|
820
|
+
],
|
|
821
|
+
"docs": "Subscriber attribute associated with the Facebook SDK Anonymous ID for the user\nRecommended for the RevenueCat Facebook integration",
|
|
822
|
+
"complexTypes": [],
|
|
823
|
+
"slug": "setfbanonymousid"
|
|
824
|
+
},
|
|
825
|
+
{
|
|
826
|
+
"name": "setMparticleID",
|
|
827
|
+
"signature": "(options: { mparticleID: string | null; }) => Promise<void>",
|
|
828
|
+
"parameters": [
|
|
829
|
+
{
|
|
830
|
+
"name": "options",
|
|
831
|
+
"docs": "Mparticle ID to use in Mparticle integration. Empty String or null will delete the subscriber attribute.",
|
|
832
|
+
"type": "{ mparticleID: string | null; }"
|
|
833
|
+
}
|
|
834
|
+
],
|
|
835
|
+
"returns": "Promise<void>",
|
|
836
|
+
"tags": [
|
|
837
|
+
{
|
|
838
|
+
"name": "param",
|
|
839
|
+
"text": "options Mparticle ID to use in Mparticle integration. Empty String or null will delete the subscriber attribute."
|
|
840
|
+
},
|
|
841
|
+
{
|
|
842
|
+
"name": "returns",
|
|
843
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting the Mparticle ID."
|
|
844
|
+
}
|
|
845
|
+
],
|
|
846
|
+
"docs": "Subscriber attribute associated with the mParticle ID for the user\nRecommended for the RevenueCat mParticle integration",
|
|
847
|
+
"complexTypes": [],
|
|
848
|
+
"slug": "setmparticleid"
|
|
849
|
+
},
|
|
850
|
+
{
|
|
851
|
+
"name": "setCleverTapID",
|
|
852
|
+
"signature": "(options: { cleverTapID: string | null; }) => Promise<void>",
|
|
853
|
+
"parameters": [
|
|
854
|
+
{
|
|
855
|
+
"name": "options",
|
|
856
|
+
"docs": "CleverTap user ID to use in CleverTap integration. Empty String or null will delete the subscriber attribute.",
|
|
857
|
+
"type": "{ cleverTapID: string | null; }"
|
|
858
|
+
}
|
|
859
|
+
],
|
|
860
|
+
"returns": "Promise<void>",
|
|
861
|
+
"tags": [
|
|
862
|
+
{
|
|
863
|
+
"name": "param",
|
|
864
|
+
"text": "options CleverTap user ID to use in CleverTap integration. Empty String or null will delete the subscriber attribute."
|
|
865
|
+
},
|
|
866
|
+
{
|
|
867
|
+
"name": "returns",
|
|
868
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting the CleverTap ID."
|
|
869
|
+
}
|
|
870
|
+
],
|
|
871
|
+
"docs": "Subscriber attribute associated with the CleverTap ID for the user\nRequired for the RevenueCat CleverTap integration",
|
|
872
|
+
"complexTypes": [],
|
|
873
|
+
"slug": "setclevertapid"
|
|
874
|
+
},
|
|
875
|
+
{
|
|
876
|
+
"name": "setMixpanelDistinctID",
|
|
877
|
+
"signature": "(options: { mixpanelDistinctID: string | null; }) => Promise<void>",
|
|
878
|
+
"parameters": [
|
|
879
|
+
{
|
|
880
|
+
"name": "options",
|
|
881
|
+
"docs": "Mixpanel Distinct ID to use in Mixpanel integration. Empty String or null will delete the subscriber attribute.",
|
|
882
|
+
"type": "{ mixpanelDistinctID: string | null; }"
|
|
883
|
+
}
|
|
884
|
+
],
|
|
885
|
+
"returns": "Promise<void>",
|
|
886
|
+
"tags": [
|
|
887
|
+
{
|
|
888
|
+
"name": "param",
|
|
889
|
+
"text": "options Mixpanel Distinct ID to use in Mixpanel integration. Empty String or null will delete the subscriber attribute."
|
|
890
|
+
},
|
|
891
|
+
{
|
|
892
|
+
"name": "returns",
|
|
893
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting the Mixpanel Distinct ID."
|
|
894
|
+
}
|
|
895
|
+
],
|
|
896
|
+
"docs": "Subscriber attribute associated with the Mixpanel Distinct ID for the user\nRequired for the RevenueCat Mixpanel integration",
|
|
897
|
+
"complexTypes": [],
|
|
898
|
+
"slug": "setmixpaneldistinctid"
|
|
899
|
+
},
|
|
900
|
+
{
|
|
901
|
+
"name": "setFirebaseAppInstanceID",
|
|
902
|
+
"signature": "(options: { firebaseAppInstanceID: string | null; }) => Promise<void>",
|
|
903
|
+
"parameters": [
|
|
904
|
+
{
|
|
905
|
+
"name": "options",
|
|
906
|
+
"docs": "Firebase App Instance ID to use in Firebase integration. Empty String or null will delete the subscriber attribute.",
|
|
907
|
+
"type": "{ firebaseAppInstanceID: string | null; }"
|
|
908
|
+
}
|
|
909
|
+
],
|
|
910
|
+
"returns": "Promise<void>",
|
|
911
|
+
"tags": [
|
|
912
|
+
{
|
|
913
|
+
"name": "param",
|
|
914
|
+
"text": "options Firebase App Instance ID to use in Firebase integration. Empty String or null will delete the subscriber attribute."
|
|
915
|
+
},
|
|
916
|
+
{
|
|
917
|
+
"name": "returns",
|
|
918
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting the Firebase App Instance ID."
|
|
919
|
+
}
|
|
920
|
+
],
|
|
921
|
+
"docs": "Subscriber attribute associated with the Firebase App Instance ID for the user\nRequired for the RevenueCat Firebase integration",
|
|
922
|
+
"complexTypes": [],
|
|
923
|
+
"slug": "setfirebaseappinstanceid"
|
|
924
|
+
},
|
|
925
|
+
{
|
|
926
|
+
"name": "setOnesignalID",
|
|
927
|
+
"signature": "(options: { onesignalID: string | null; }) => Promise<void>",
|
|
928
|
+
"parameters": [
|
|
929
|
+
{
|
|
930
|
+
"name": "options",
|
|
931
|
+
"docs": "OneSignal Player ID to use in OneSignal integration. Empty String or null will delete the subscriber attribute.",
|
|
932
|
+
"type": "{ onesignalID: string | null; }"
|
|
933
|
+
}
|
|
934
|
+
],
|
|
935
|
+
"returns": "Promise<void>",
|
|
936
|
+
"tags": [
|
|
937
|
+
{
|
|
938
|
+
"name": "param",
|
|
939
|
+
"text": "options OneSignal Player ID to use in OneSignal integration. Empty String or null will delete the subscriber attribute."
|
|
940
|
+
},
|
|
941
|
+
{
|
|
942
|
+
"name": "returns",
|
|
943
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting the OneSignal ID."
|
|
944
|
+
}
|
|
945
|
+
],
|
|
946
|
+
"docs": "Subscriber attribute associated with the OneSignal Player ID for the user\nRequired for the RevenueCat OneSignal integration",
|
|
947
|
+
"complexTypes": [],
|
|
948
|
+
"slug": "setonesignalid"
|
|
949
|
+
},
|
|
950
|
+
{
|
|
951
|
+
"name": "setAirshipChannelID",
|
|
952
|
+
"signature": "(options: { airshipChannelID: string | null; }) => Promise<void>",
|
|
953
|
+
"parameters": [
|
|
954
|
+
{
|
|
955
|
+
"name": "options",
|
|
956
|
+
"docs": "Airship Channel ID to use in Airship integration. Empty String or null will delete the subscriber attribute.",
|
|
957
|
+
"type": "{ airshipChannelID: string | null; }"
|
|
958
|
+
}
|
|
959
|
+
],
|
|
960
|
+
"returns": "Promise<void>",
|
|
961
|
+
"tags": [
|
|
962
|
+
{
|
|
963
|
+
"name": "param",
|
|
964
|
+
"text": "options Airship Channel ID to use in Airship integration. Empty String or null will delete the subscriber attribute."
|
|
965
|
+
},
|
|
966
|
+
{
|
|
967
|
+
"name": "returns",
|
|
968
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting the Airship Channel ID."
|
|
969
|
+
}
|
|
970
|
+
],
|
|
971
|
+
"docs": "Subscriber attribute associated with the Airship Channel ID for the user\nRequired for the RevenueCat Airship integration",
|
|
972
|
+
"complexTypes": [],
|
|
973
|
+
"slug": "setairshipchannelid"
|
|
974
|
+
},
|
|
975
|
+
{
|
|
976
|
+
"name": "setMediaSource",
|
|
977
|
+
"signature": "(options: { mediaSource: string | null; }) => Promise<void>",
|
|
978
|
+
"parameters": [
|
|
979
|
+
{
|
|
980
|
+
"name": "options",
|
|
981
|
+
"docs": "Empty String or null will delete the subscriber attribute.",
|
|
982
|
+
"type": "{ mediaSource: string | null; }"
|
|
983
|
+
}
|
|
984
|
+
],
|
|
985
|
+
"returns": "Promise<void>",
|
|
986
|
+
"tags": [
|
|
987
|
+
{
|
|
988
|
+
"name": "param",
|
|
989
|
+
"text": "options Empty String or null will delete the subscriber attribute."
|
|
990
|
+
},
|
|
991
|
+
{
|
|
992
|
+
"name": "returns",
|
|
993
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting the media source."
|
|
994
|
+
}
|
|
995
|
+
],
|
|
996
|
+
"docs": "Subscriber attribute associated with the install media source for the user",
|
|
997
|
+
"complexTypes": [],
|
|
998
|
+
"slug": "setmediasource"
|
|
999
|
+
},
|
|
1000
|
+
{
|
|
1001
|
+
"name": "setCampaign",
|
|
1002
|
+
"signature": "(options: { campaign: string | null; }) => Promise<void>",
|
|
1003
|
+
"parameters": [
|
|
1004
|
+
{
|
|
1005
|
+
"name": "options",
|
|
1006
|
+
"docs": "Empty String or null will delete the subscriber attribute.",
|
|
1007
|
+
"type": "{ campaign: string | null; }"
|
|
1008
|
+
}
|
|
1009
|
+
],
|
|
1010
|
+
"returns": "Promise<void>",
|
|
1011
|
+
"tags": [
|
|
1012
|
+
{
|
|
1013
|
+
"name": "param",
|
|
1014
|
+
"text": "options Empty String or null will delete the subscriber attribute."
|
|
1015
|
+
},
|
|
1016
|
+
{
|
|
1017
|
+
"name": "returns",
|
|
1018
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting the campaign."
|
|
1019
|
+
}
|
|
1020
|
+
],
|
|
1021
|
+
"docs": "Subscriber attribute associated with the install campaign for the user",
|
|
1022
|
+
"complexTypes": [],
|
|
1023
|
+
"slug": "setcampaign"
|
|
1024
|
+
},
|
|
1025
|
+
{
|
|
1026
|
+
"name": "setAdGroup",
|
|
1027
|
+
"signature": "(options: { adGroup: string | null; }) => Promise<void>",
|
|
1028
|
+
"parameters": [
|
|
1029
|
+
{
|
|
1030
|
+
"name": "options",
|
|
1031
|
+
"docs": "Empty String or null will delete the subscriber attribute.",
|
|
1032
|
+
"type": "{ adGroup: string | null; }"
|
|
1033
|
+
}
|
|
1034
|
+
],
|
|
1035
|
+
"returns": "Promise<void>",
|
|
1036
|
+
"tags": [
|
|
1037
|
+
{
|
|
1038
|
+
"name": "param",
|
|
1039
|
+
"text": "options Empty String or null will delete the subscriber attribute."
|
|
1040
|
+
},
|
|
1041
|
+
{
|
|
1042
|
+
"name": "returns",
|
|
1043
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting ad group."
|
|
1044
|
+
}
|
|
1045
|
+
],
|
|
1046
|
+
"docs": "Subscriber attribute associated with the install ad group for the user",
|
|
1047
|
+
"complexTypes": [],
|
|
1048
|
+
"slug": "setadgroup"
|
|
1049
|
+
},
|
|
1050
|
+
{
|
|
1051
|
+
"name": "setAd",
|
|
1052
|
+
"signature": "(options: { ad: string | null; }) => Promise<void>",
|
|
1053
|
+
"parameters": [
|
|
1054
|
+
{
|
|
1055
|
+
"name": "options",
|
|
1056
|
+
"docs": "Empty String or null will delete the subscriber attribute.",
|
|
1057
|
+
"type": "{ ad: string | null; }"
|
|
1058
|
+
}
|
|
1059
|
+
],
|
|
1060
|
+
"returns": "Promise<void>",
|
|
1061
|
+
"tags": [
|
|
1062
|
+
{
|
|
1063
|
+
"name": "param",
|
|
1064
|
+
"text": "options Empty String or null will delete the subscriber attribute."
|
|
1065
|
+
},
|
|
1066
|
+
{
|
|
1067
|
+
"name": "returns",
|
|
1068
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting the ad subscriber attribute."
|
|
1069
|
+
}
|
|
1070
|
+
],
|
|
1071
|
+
"docs": "Subscriber attribute associated with the install ad for the user",
|
|
1072
|
+
"complexTypes": [],
|
|
1073
|
+
"slug": "setad"
|
|
1074
|
+
},
|
|
1075
|
+
{
|
|
1076
|
+
"name": "setKeyword",
|
|
1077
|
+
"signature": "(options: { keyword: string | null; }) => Promise<void>",
|
|
1078
|
+
"parameters": [
|
|
1079
|
+
{
|
|
1080
|
+
"name": "options",
|
|
1081
|
+
"docs": "Empty String or null will delete the subscriber attribute.",
|
|
1082
|
+
"type": "{ keyword: string | null; }"
|
|
1083
|
+
}
|
|
1084
|
+
],
|
|
1085
|
+
"returns": "Promise<void>",
|
|
1086
|
+
"tags": [
|
|
1087
|
+
{
|
|
1088
|
+
"name": "param",
|
|
1089
|
+
"text": "options Empty String or null will delete the subscriber attribute."
|
|
1090
|
+
},
|
|
1091
|
+
{
|
|
1092
|
+
"name": "returns",
|
|
1093
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting the keyword."
|
|
1094
|
+
}
|
|
1095
|
+
],
|
|
1096
|
+
"docs": "Subscriber attribute associated with the install keyword for the user",
|
|
1097
|
+
"complexTypes": [],
|
|
1098
|
+
"slug": "setkeyword"
|
|
1099
|
+
},
|
|
1100
|
+
{
|
|
1101
|
+
"name": "setCreative",
|
|
1102
|
+
"signature": "(options: { creative: string | null; }) => Promise<void>",
|
|
1103
|
+
"parameters": [
|
|
1104
|
+
{
|
|
1105
|
+
"name": "options",
|
|
1106
|
+
"docs": "Empty String or null will delete the subscriber attribute.",
|
|
1107
|
+
"type": "{ creative: string | null; }"
|
|
1108
|
+
}
|
|
1109
|
+
],
|
|
1110
|
+
"returns": "Promise<void>",
|
|
1111
|
+
"tags": [
|
|
1112
|
+
{
|
|
1113
|
+
"name": "param",
|
|
1114
|
+
"text": "options Empty String or null will delete the subscriber attribute."
|
|
1115
|
+
},
|
|
1116
|
+
{
|
|
1117
|
+
"name": "returns",
|
|
1118
|
+
"text": "The promise will be rejected if configure has not been called yet or if there's an error\nsetting the creative subscriber attribute."
|
|
1119
|
+
}
|
|
1120
|
+
],
|
|
1121
|
+
"docs": "Subscriber attribute associated with the install ad creative for the user",
|
|
1122
|
+
"complexTypes": [],
|
|
1123
|
+
"slug": "setcreative"
|
|
1124
|
+
},
|
|
1125
|
+
{
|
|
1126
|
+
"name": "canMakePayments",
|
|
1127
|
+
"signature": "(options?: { features?: BILLING_FEATURE[] | undefined; } | undefined) => Promise<{ canMakePayments: boolean; }>",
|
|
1128
|
+
"parameters": [
|
|
1129
|
+
{
|
|
1130
|
+
"name": "options",
|
|
1131
|
+
"docs": "An array of feature types to check for support. Feature types must be one of\n[BILLING_FEATURE]. By default, is an empty list and no specific feature support will be checked.",
|
|
1132
|
+
"type": "{ features?: BILLING_FEATURE[] | undefined; } | undefined"
|
|
1133
|
+
}
|
|
1134
|
+
],
|
|
1135
|
+
"returns": "Promise<{ canMakePayments: boolean; }>",
|
|
1136
|
+
"tags": [
|
|
1137
|
+
{
|
|
1138
|
+
"name": "param",
|
|
1139
|
+
"text": "options An array of feature types to check for support. Feature types must be one of\n[BILLING_FEATURE]. By default, is an empty list and no specific feature support will be checked."
|
|
1140
|
+
},
|
|
1141
|
+
{
|
|
1142
|
+
"name": "returns",
|
|
1143
|
+
"text": "promise with boolean response. True if billing is supported, false otherwise."
|
|
1144
|
+
}
|
|
1145
|
+
],
|
|
1146
|
+
"docs": "Check if billing is supported for the current user (meaning IN-APP purchases are supported)\nand optionally, whether a list of specified feature types are supported.\n\nNote: Billing features are only relevant to Google Play Android users.\nFor other stores and platforms, billing features won't be checked.",
|
|
1147
|
+
"complexTypes": [
|
|
1148
|
+
"BILLING_FEATURE"
|
|
1149
|
+
],
|
|
1150
|
+
"slug": "canmakepayments"
|
|
1151
|
+
},
|
|
1152
|
+
{
|
|
1153
|
+
"name": "beginRefundRequestForActiveEntitlement",
|
|
1154
|
+
"signature": "() => Promise<{ refundRequestStatus: REFUND_REQUEST_STATUS; }>",
|
|
1155
|
+
"parameters": [],
|
|
1156
|
+
"returns": "Promise<{ refundRequestStatus: REFUND_REQUEST_STATUS; }>",
|
|
1157
|
+
"tags": [
|
|
1158
|
+
{
|
|
1159
|
+
"name": "returns",
|
|
1160
|
+
"text": "Returns refundRequestStatus: The status of the\nrefund request. Keep in mind the status could be REFUND_REQUEST_STATUS.USER_CANCELLED"
|
|
1161
|
+
}
|
|
1162
|
+
],
|
|
1163
|
+
"docs": "iOS 15+ only. Presents a refund request sheet in the current window scene for\nthe latest transaction associated with the active entitlement.\n\nIf the request was unsuccessful, no active entitlements could be found for\nthe user, or multiple active entitlements were found for the user,\nthe promise will return an error.\nIf called in an unsupported platform (Android or iOS < 15), an `UnsupportedPlatformException` will be thrown.\n\nImportant: This method should only be used if your user can only have a single active entitlement at a given time.\nIf a user could have more than one entitlement at a time, use `beginRefundRequestForEntitlement` instead.",
|
|
1164
|
+
"complexTypes": [
|
|
1165
|
+
"REFUND_REQUEST_STATUS"
|
|
1166
|
+
],
|
|
1167
|
+
"slug": "beginrefundrequestforactiveentitlement"
|
|
1168
|
+
},
|
|
1169
|
+
{
|
|
1170
|
+
"name": "beginRefundRequestForEntitlement",
|
|
1171
|
+
"signature": "(options: { entitlementInfo: PurchasesEntitlementInfo; }) => Promise<{ refundRequestStatus: REFUND_REQUEST_STATUS; }>",
|
|
1172
|
+
"parameters": [
|
|
1173
|
+
{
|
|
1174
|
+
"name": "options",
|
|
1175
|
+
"docs": "The entitlement to begin a refund request for.",
|
|
1176
|
+
"type": "{ entitlementInfo: PurchasesEntitlementInfo; }"
|
|
1177
|
+
}
|
|
1178
|
+
],
|
|
1179
|
+
"returns": "Promise<{ refundRequestStatus: REFUND_REQUEST_STATUS; }>",
|
|
1180
|
+
"tags": [
|
|
1181
|
+
{
|
|
1182
|
+
"name": "param",
|
|
1183
|
+
"text": "options The entitlement to begin a refund request for."
|
|
1184
|
+
},
|
|
1185
|
+
{
|
|
1186
|
+
"name": "returns",
|
|
1187
|
+
"text": "Returns refundRequestStatus: The status of the\nrefund request. Keep in mind the status could be REFUND_REQUEST_STATUS.USER_CANCELLED"
|
|
1188
|
+
}
|
|
1189
|
+
],
|
|
1190
|
+
"docs": "iOS 15+ only. Presents a refund request sheet in the current window scene for\nthe latest transaction associated with the `entitlement`.\n\nIf the request was unsuccessful, the promise will return an error.\nIf called in an unsupported platform (Android or iOS < 15), an `UnsupportedPlatformException` will be thrown.",
|
|
1191
|
+
"complexTypes": [
|
|
1192
|
+
"REFUND_REQUEST_STATUS",
|
|
1193
|
+
"PurchasesEntitlementInfo"
|
|
1194
|
+
],
|
|
1195
|
+
"slug": "beginrefundrequestforentitlement"
|
|
1196
|
+
},
|
|
1197
|
+
{
|
|
1198
|
+
"name": "beginRefundRequestForProduct",
|
|
1199
|
+
"signature": "(options: { storeProduct: PurchasesStoreProduct; }) => Promise<{ refundRequestStatus: REFUND_REQUEST_STATUS; }>",
|
|
1200
|
+
"parameters": [
|
|
1201
|
+
{
|
|
1202
|
+
"name": "options",
|
|
1203
|
+
"docs": "The StoreProduct to begin a refund request for.",
|
|
1204
|
+
"type": "{ storeProduct: PurchasesStoreProduct; }"
|
|
1205
|
+
}
|
|
1206
|
+
],
|
|
1207
|
+
"returns": "Promise<{ refundRequestStatus: REFUND_REQUEST_STATUS; }>",
|
|
1208
|
+
"tags": [
|
|
1209
|
+
{
|
|
1210
|
+
"name": "param",
|
|
1211
|
+
"text": "options The StoreProduct to begin a refund request for."
|
|
1212
|
+
},
|
|
1213
|
+
{
|
|
1214
|
+
"name": "returns",
|
|
1215
|
+
"text": "Returns a REFUND_REQUEST_STATUS: The status of the\nrefund request. Keep in mind the status could be REFUND_REQUEST_STATUS.USER_CANCELLED"
|
|
1216
|
+
}
|
|
1217
|
+
],
|
|
1218
|
+
"docs": "iOS 15+ only. Presents a refund request sheet in the current window scene for\nthe latest transaction associated with the `product`.\n\nIf the request was unsuccessful, the promise will return an error.\nIf called in an unsupported platform (Android or iOS < 15), an `UnsupportedPlatformException` will be thrown.",
|
|
1219
|
+
"complexTypes": [
|
|
1220
|
+
"REFUND_REQUEST_STATUS",
|
|
1221
|
+
"PurchasesStoreProduct"
|
|
1222
|
+
],
|
|
1223
|
+
"slug": "beginrefundrequestforproduct"
|
|
1224
|
+
},
|
|
1225
|
+
{
|
|
1226
|
+
"name": "isConfigured",
|
|
1227
|
+
"signature": "() => Promise<{ isConfigured: boolean; }>",
|
|
1228
|
+
"parameters": [],
|
|
1229
|
+
"returns": "Promise<{ isConfigured: boolean; }>",
|
|
1230
|
+
"tags": [
|
|
1231
|
+
{
|
|
1232
|
+
"name": "returns",
|
|
1233
|
+
"text": "promise with boolean response"
|
|
1234
|
+
}
|
|
1235
|
+
],
|
|
1236
|
+
"docs": "Check if configure has finished and Purchases has been configured.",
|
|
1237
|
+
"complexTypes": [],
|
|
1238
|
+
"slug": "isconfigured"
|
|
1239
|
+
}
|
|
1240
|
+
],
|
|
1241
|
+
"properties": []
|
|
1242
|
+
},
|
|
1243
|
+
"interfaces": [
|
|
1244
|
+
{
|
|
1245
|
+
"name": "PurchasesConfiguration",
|
|
1246
|
+
"slug": "purchasesconfiguration",
|
|
1247
|
+
"docs": "Holds parameters to initialize the SDK.",
|
|
1248
|
+
"tags": [],
|
|
1249
|
+
"methods": [],
|
|
1250
|
+
"properties": [
|
|
1251
|
+
{
|
|
1252
|
+
"name": "apiKey",
|
|
1253
|
+
"tags": [],
|
|
1254
|
+
"docs": "RevenueCat API Key. Needs to be a string",
|
|
1255
|
+
"complexTypes": [],
|
|
1256
|
+
"type": "string"
|
|
1257
|
+
},
|
|
1258
|
+
{
|
|
1259
|
+
"name": "appUserID",
|
|
1260
|
+
"tags": [],
|
|
1261
|
+
"docs": "A unique id for identifying the user",
|
|
1262
|
+
"complexTypes": [],
|
|
1263
|
+
"type": "string | null | undefined"
|
|
1264
|
+
},
|
|
1265
|
+
{
|
|
1266
|
+
"name": "observerMode",
|
|
1267
|
+
"tags": [],
|
|
1268
|
+
"docs": "An optional boolean. Set this to TRUE if you have your own IAP implementation and\nwant to use only RevenueCat's backend. Default is FALSE. If you are on Android and setting this to ON, you will have\nto acknowledge the purchases yourself.",
|
|
1269
|
+
"complexTypes": [],
|
|
1270
|
+
"type": "boolean | undefined"
|
|
1271
|
+
},
|
|
1272
|
+
{
|
|
1273
|
+
"name": "userDefaultsSuiteName",
|
|
1274
|
+
"tags": [],
|
|
1275
|
+
"docs": "An optional string. iOS-only, will be ignored for Android.\nSet this if you would like the RevenueCat SDK to store its preferences in a different NSUserDefaults\nsuite, otherwise it will use standardUserDefaults. Default is null, which will make the SDK use standardUserDefaults.",
|
|
1276
|
+
"complexTypes": [],
|
|
1277
|
+
"type": "string | undefined"
|
|
1278
|
+
},
|
|
1279
|
+
{
|
|
1280
|
+
"name": "usesStoreKit2IfAvailable",
|
|
1281
|
+
"tags": [
|
|
1282
|
+
{
|
|
1283
|
+
"text": "RevenueCat currently uses StoreKit 1 for purchases, as its stability in production scenarios has\nproven to be more performant than StoreKit 2.\nWe're collecting more data on the best approach, but StoreKit 1 vs StoreKit 2 is an implementation detail\nthat you shouldn't need to care about.\nWe recommend not using this parameter, letting RevenueCat decide for you which StoreKit implementation to use.",
|
|
1284
|
+
"name": "deprecated"
|
|
1285
|
+
}
|
|
1286
|
+
],
|
|
1287
|
+
"docs": "iOS-only, will be ignored for Android.\nSet this to TRUE to enable StoreKit2.\nDefault is FALSE.",
|
|
1288
|
+
"complexTypes": [],
|
|
1289
|
+
"type": "boolean | undefined"
|
|
1290
|
+
},
|
|
1291
|
+
{
|
|
1292
|
+
"name": "useAmazon",
|
|
1293
|
+
"tags": [],
|
|
1294
|
+
"docs": "An optional boolean. Android only. Required to configure the plugin to be used in the Amazon Appstore.",
|
|
1295
|
+
"complexTypes": [],
|
|
1296
|
+
"type": "boolean | undefined"
|
|
1297
|
+
}
|
|
1298
|
+
]
|
|
1299
|
+
},
|
|
1300
|
+
{
|
|
1301
|
+
"name": "CustomerInfo",
|
|
1302
|
+
"slug": "customerinfo",
|
|
1303
|
+
"docs": "",
|
|
1304
|
+
"tags": [],
|
|
1305
|
+
"methods": [],
|
|
1306
|
+
"properties": [
|
|
1307
|
+
{
|
|
1308
|
+
"name": "entitlements",
|
|
1309
|
+
"tags": [],
|
|
1310
|
+
"docs": "Entitlements attached to this customer info",
|
|
1311
|
+
"complexTypes": [
|
|
1312
|
+
"PurchasesEntitlementInfos"
|
|
1313
|
+
],
|
|
1314
|
+
"type": "PurchasesEntitlementInfos"
|
|
1315
|
+
},
|
|
1316
|
+
{
|
|
1317
|
+
"name": "activeSubscriptions",
|
|
1318
|
+
"tags": [],
|
|
1319
|
+
"docs": "Set of active subscription skus",
|
|
1320
|
+
"complexTypes": [],
|
|
1321
|
+
"type": "string[]"
|
|
1322
|
+
},
|
|
1323
|
+
{
|
|
1324
|
+
"name": "allPurchasedProductIdentifiers",
|
|
1325
|
+
"tags": [],
|
|
1326
|
+
"docs": "Set of purchased skus, active and inactive",
|
|
1327
|
+
"complexTypes": [],
|
|
1328
|
+
"type": "string[]"
|
|
1329
|
+
},
|
|
1330
|
+
{
|
|
1331
|
+
"name": "latestExpirationDate",
|
|
1332
|
+
"tags": [],
|
|
1333
|
+
"docs": "The latest expiration date of all purchased skus",
|
|
1334
|
+
"complexTypes": [],
|
|
1335
|
+
"type": "string | null"
|
|
1336
|
+
},
|
|
1337
|
+
{
|
|
1338
|
+
"name": "firstSeen",
|
|
1339
|
+
"tags": [],
|
|
1340
|
+
"docs": "The date this user was first seen in RevenueCat.",
|
|
1341
|
+
"complexTypes": [],
|
|
1342
|
+
"type": "string"
|
|
1343
|
+
},
|
|
1344
|
+
{
|
|
1345
|
+
"name": "originalAppUserId",
|
|
1346
|
+
"tags": [],
|
|
1347
|
+
"docs": "The original App User Id recorded for this user.",
|
|
1348
|
+
"complexTypes": [],
|
|
1349
|
+
"type": "string"
|
|
1350
|
+
},
|
|
1351
|
+
{
|
|
1352
|
+
"name": "requestDate",
|
|
1353
|
+
"tags": [],
|
|
1354
|
+
"docs": "Date when this info was requested",
|
|
1355
|
+
"complexTypes": [],
|
|
1356
|
+
"type": "string"
|
|
1357
|
+
},
|
|
1358
|
+
{
|
|
1359
|
+
"name": "allExpirationDates",
|
|
1360
|
+
"tags": [],
|
|
1361
|
+
"docs": "Map of skus to expiration dates",
|
|
1362
|
+
"complexTypes": [],
|
|
1363
|
+
"type": "{ [key: string]: string | null; }"
|
|
1364
|
+
},
|
|
1365
|
+
{
|
|
1366
|
+
"name": "allPurchaseDates",
|
|
1367
|
+
"tags": [],
|
|
1368
|
+
"docs": "Map of skus to purchase dates",
|
|
1369
|
+
"complexTypes": [],
|
|
1370
|
+
"type": "{ [key: string]: string | null; }"
|
|
1371
|
+
},
|
|
1372
|
+
{
|
|
1373
|
+
"name": "originalApplicationVersion",
|
|
1374
|
+
"tags": [],
|
|
1375
|
+
"docs": "Returns the version number for the version of the application when the\nuser bought the app. Use this for grandfathering users when migrating\nto subscriptions.\n\nThis corresponds to the value of CFBundleVersion (in iOS) in the\nInfo.plist file when the purchase was originally made. This is always null\nin Android",
|
|
1376
|
+
"complexTypes": [],
|
|
1377
|
+
"type": "string | null"
|
|
1378
|
+
},
|
|
1379
|
+
{
|
|
1380
|
+
"name": "originalPurchaseDate",
|
|
1381
|
+
"tags": [],
|
|
1382
|
+
"docs": "Returns the purchase date for the version of the application when the user bought the app.\nUse this for grandfathering users when migrating to subscriptions.",
|
|
1383
|
+
"complexTypes": [],
|
|
1384
|
+
"type": "string | null"
|
|
1385
|
+
},
|
|
1386
|
+
{
|
|
1387
|
+
"name": "managementURL",
|
|
1388
|
+
"tags": [],
|
|
1389
|
+
"docs": "URL to manage the active subscription of the user. If this user has an active iOS\nsubscription, this will point to the App Store, if the user has an active Play Store subscription\nit will point there. If there are no active subscriptions it will be null.\nIf there are multiple for different platforms, it will point to the device store.",
|
|
1390
|
+
"complexTypes": [],
|
|
1391
|
+
"type": "string | null"
|
|
1392
|
+
},
|
|
1393
|
+
{
|
|
1394
|
+
"name": "nonSubscriptionTransactions",
|
|
1395
|
+
"tags": [],
|
|
1396
|
+
"docs": "",
|
|
1397
|
+
"complexTypes": [
|
|
1398
|
+
"PurchasesStoreTransaction"
|
|
1399
|
+
],
|
|
1400
|
+
"type": "PurchasesStoreTransaction[]"
|
|
1401
|
+
}
|
|
1402
|
+
]
|
|
1403
|
+
},
|
|
1404
|
+
{
|
|
1405
|
+
"name": "PurchasesEntitlementInfos",
|
|
1406
|
+
"slug": "purchasesentitlementinfos",
|
|
1407
|
+
"docs": "Contains all the entitlements associated to the user.",
|
|
1408
|
+
"tags": [],
|
|
1409
|
+
"methods": [],
|
|
1410
|
+
"properties": [
|
|
1411
|
+
{
|
|
1412
|
+
"name": "all",
|
|
1413
|
+
"tags": [],
|
|
1414
|
+
"docs": "Map of all EntitlementInfo (`PurchasesEntitlementInfo`) objects (active and inactive) keyed by entitlement identifier.",
|
|
1415
|
+
"complexTypes": [
|
|
1416
|
+
"PurchasesEntitlementInfo"
|
|
1417
|
+
],
|
|
1418
|
+
"type": "{ [key: string]: PurchasesEntitlementInfo; }"
|
|
1419
|
+
},
|
|
1420
|
+
{
|
|
1421
|
+
"name": "active",
|
|
1422
|
+
"tags": [],
|
|
1423
|
+
"docs": "Map of active EntitlementInfo (`PurchasesEntitlementInfo`) objects keyed by entitlement identifier.",
|
|
1424
|
+
"complexTypes": [
|
|
1425
|
+
"PurchasesEntitlementInfo"
|
|
1426
|
+
],
|
|
1427
|
+
"type": "{ [key: string]: PurchasesEntitlementInfo; }"
|
|
1428
|
+
}
|
|
1429
|
+
]
|
|
1430
|
+
},
|
|
1431
|
+
{
|
|
1432
|
+
"name": "PurchasesEntitlementInfo",
|
|
1433
|
+
"slug": "purchasesentitlementinfo",
|
|
1434
|
+
"docs": "The EntitlementInfo object gives you access to all of the information about the status of a user entitlement.",
|
|
1435
|
+
"tags": [],
|
|
1436
|
+
"methods": [],
|
|
1437
|
+
"properties": [
|
|
1438
|
+
{
|
|
1439
|
+
"name": "identifier",
|
|
1440
|
+
"tags": [],
|
|
1441
|
+
"docs": "The entitlement identifier configured in the RevenueCat dashboard",
|
|
1442
|
+
"complexTypes": [],
|
|
1443
|
+
"type": "string"
|
|
1444
|
+
},
|
|
1445
|
+
{
|
|
1446
|
+
"name": "isActive",
|
|
1447
|
+
"tags": [],
|
|
1448
|
+
"docs": "True if the user has access to this entitlement",
|
|
1449
|
+
"complexTypes": [],
|
|
1450
|
+
"type": "boolean"
|
|
1451
|
+
},
|
|
1452
|
+
{
|
|
1453
|
+
"name": "willRenew",
|
|
1454
|
+
"tags": [],
|
|
1455
|
+
"docs": "True if the underlying subscription is set to renew at the end of the billing period (expirationDate).",
|
|
1456
|
+
"complexTypes": [],
|
|
1457
|
+
"type": "boolean"
|
|
1458
|
+
},
|
|
1459
|
+
{
|
|
1460
|
+
"name": "periodType",
|
|
1461
|
+
"tags": [],
|
|
1462
|
+
"docs": "The last period type this entitlement was in. Either: NORMAL, INTRO, TRIAL.",
|
|
1463
|
+
"complexTypes": [],
|
|
1464
|
+
"type": "string"
|
|
1465
|
+
},
|
|
1466
|
+
{
|
|
1467
|
+
"name": "latestPurchaseDate",
|
|
1468
|
+
"tags": [],
|
|
1469
|
+
"docs": "The latest purchase or renewal date for the entitlement in ISO8601 format.",
|
|
1470
|
+
"complexTypes": [],
|
|
1471
|
+
"type": "string"
|
|
1472
|
+
},
|
|
1473
|
+
{
|
|
1474
|
+
"name": "latestPurchaseDateMillis",
|
|
1475
|
+
"tags": [],
|
|
1476
|
+
"docs": "The latest purchase or renewal date for the entitlement in milliseconds.",
|
|
1477
|
+
"complexTypes": [],
|
|
1478
|
+
"type": "number"
|
|
1479
|
+
},
|
|
1480
|
+
{
|
|
1481
|
+
"name": "originalPurchaseDate",
|
|
1482
|
+
"tags": [],
|
|
1483
|
+
"docs": "The first date this entitlement was purchased in ISO8601 format.",
|
|
1484
|
+
"complexTypes": [],
|
|
1485
|
+
"type": "string"
|
|
1486
|
+
},
|
|
1487
|
+
{
|
|
1488
|
+
"name": "originalPurchaseDateMillis",
|
|
1489
|
+
"tags": [],
|
|
1490
|
+
"docs": "The first date this entitlement was purchased in milliseconds.",
|
|
1491
|
+
"complexTypes": [],
|
|
1492
|
+
"type": "number"
|
|
1493
|
+
},
|
|
1494
|
+
{
|
|
1495
|
+
"name": "expirationDate",
|
|
1496
|
+
"tags": [],
|
|
1497
|
+
"docs": "The expiration date for the entitlement in ISO8601, can be `null` for lifetime access.\nIf the `periodType` is `trial`, this is the trial expiration date.",
|
|
1498
|
+
"complexTypes": [],
|
|
1499
|
+
"type": "string | null"
|
|
1500
|
+
},
|
|
1501
|
+
{
|
|
1502
|
+
"name": "expirationDateMillis",
|
|
1503
|
+
"tags": [],
|
|
1504
|
+
"docs": "The expiration date for the entitlement in milliseconds, can be `null` for lifetime access.\nIf the `periodType` is `trial`, this is the trial expiration date.",
|
|
1505
|
+
"complexTypes": [],
|
|
1506
|
+
"type": "number | null"
|
|
1507
|
+
},
|
|
1508
|
+
{
|
|
1509
|
+
"name": "store",
|
|
1510
|
+
"tags": [],
|
|
1511
|
+
"docs": "The store where this entitlement was unlocked from.",
|
|
1512
|
+
"complexTypes": [],
|
|
1513
|
+
"type": "'PLAY_STORE' | 'APP_STORE' | 'STRIPE' | 'MAC_APP_STORE' | 'PROMOTIONAL' | 'AMAZON' | 'UNKNOWN_STORE'"
|
|
1514
|
+
},
|
|
1515
|
+
{
|
|
1516
|
+
"name": "productIdentifier",
|
|
1517
|
+
"tags": [],
|
|
1518
|
+
"docs": "The product identifier that unlocked this entitlement",
|
|
1519
|
+
"complexTypes": [],
|
|
1520
|
+
"type": "string"
|
|
1521
|
+
},
|
|
1522
|
+
{
|
|
1523
|
+
"name": "isSandbox",
|
|
1524
|
+
"tags": [],
|
|
1525
|
+
"docs": "False if this entitlement is unlocked via a production purchase",
|
|
1526
|
+
"complexTypes": [],
|
|
1527
|
+
"type": "boolean"
|
|
1528
|
+
},
|
|
1529
|
+
{
|
|
1530
|
+
"name": "unsubscribeDetectedAt",
|
|
1531
|
+
"tags": [
|
|
1532
|
+
{
|
|
1533
|
+
"text": ": Entitlement may still be active even if user has unsubscribed. Check the `isActive` property.",
|
|
1534
|
+
"name": "note"
|
|
1535
|
+
}
|
|
1536
|
+
],
|
|
1537
|
+
"docs": "The date an unsubscribe was detected in ISO8601 format. Can be `null`.",
|
|
1538
|
+
"complexTypes": [],
|
|
1539
|
+
"type": "string | null"
|
|
1540
|
+
},
|
|
1541
|
+
{
|
|
1542
|
+
"name": "unsubscribeDetectedAtMillis",
|
|
1543
|
+
"tags": [
|
|
1544
|
+
{
|
|
1545
|
+
"text": ": Entitlement may still be active even if user has unsubscribed. Check the `isActive` property.",
|
|
1546
|
+
"name": "note"
|
|
1547
|
+
}
|
|
1548
|
+
],
|
|
1549
|
+
"docs": "The date an unsubscribe was detected in milliseconds. Can be `null`.",
|
|
1550
|
+
"complexTypes": [],
|
|
1551
|
+
"type": "number | null"
|
|
1552
|
+
},
|
|
1553
|
+
{
|
|
1554
|
+
"name": "billingIssueDetectedAt",
|
|
1555
|
+
"tags": [
|
|
1556
|
+
{
|
|
1557
|
+
"text": ": Entitlement may still be active even if there is a billing issue. Check the `isActive` property.",
|
|
1558
|
+
"name": "note"
|
|
1559
|
+
}
|
|
1560
|
+
],
|
|
1561
|
+
"docs": "The date a billing issue was detected in ISO8601 format. Can be `null` if there is no billing issue or an\nissue has been resolved",
|
|
1562
|
+
"complexTypes": [],
|
|
1563
|
+
"type": "string | null"
|
|
1564
|
+
},
|
|
1565
|
+
{
|
|
1566
|
+
"name": "billingIssueDetectedAtMillis",
|
|
1567
|
+
"tags": [
|
|
1568
|
+
{
|
|
1569
|
+
"text": ": Entitlement may still be active even if there is a billing issue. Check the `isActive` property.",
|
|
1570
|
+
"name": "note"
|
|
1571
|
+
}
|
|
1572
|
+
],
|
|
1573
|
+
"docs": "The date a billing issue was detected in milliseconds. Can be `null` if there is no billing issue or an\nissue has been resolved",
|
|
1574
|
+
"complexTypes": [],
|
|
1575
|
+
"type": "number | null"
|
|
1576
|
+
},
|
|
1577
|
+
{
|
|
1578
|
+
"name": "ownershipType",
|
|
1579
|
+
"tags": [],
|
|
1580
|
+
"docs": "Supported ownership types for an entitlement.\nPURCHASED if the purchase was made directly by this user.\nFAMILY_SHARED if the purchase has been shared to this user by a family member.\nUNKNOWN if the purchase has no or an unknown ownership type.",
|
|
1581
|
+
"complexTypes": [],
|
|
1582
|
+
"type": "'FAMILY_SHARED' | 'PURCHASED' | 'UNKNOWN'"
|
|
1583
|
+
}
|
|
1584
|
+
]
|
|
1585
|
+
},
|
|
1586
|
+
{
|
|
1587
|
+
"name": "PurchasesStoreTransaction",
|
|
1588
|
+
"slug": "purchasesstoretransaction",
|
|
1589
|
+
"docs": "List of all non subscription transactions. Use this to fetch the history of\nnon-subscription purchases",
|
|
1590
|
+
"tags": [],
|
|
1591
|
+
"methods": [],
|
|
1592
|
+
"properties": [
|
|
1593
|
+
{
|
|
1594
|
+
"name": "transactionIdentifier",
|
|
1595
|
+
"tags": [],
|
|
1596
|
+
"docs": "Id of the transaction.",
|
|
1597
|
+
"complexTypes": [],
|
|
1598
|
+
"type": "string"
|
|
1599
|
+
},
|
|
1600
|
+
{
|
|
1601
|
+
"name": "productIdentifier",
|
|
1602
|
+
"tags": [],
|
|
1603
|
+
"docs": "Product Id associated with the transaction.",
|
|
1604
|
+
"complexTypes": [],
|
|
1605
|
+
"type": "string"
|
|
1606
|
+
},
|
|
1607
|
+
{
|
|
1608
|
+
"name": "purchaseDate",
|
|
1609
|
+
"tags": [],
|
|
1610
|
+
"docs": "Purchase date of the transaction in ISO 8601 format.",
|
|
1611
|
+
"complexTypes": [],
|
|
1612
|
+
"type": "string"
|
|
1613
|
+
}
|
|
1614
|
+
]
|
|
1615
|
+
},
|
|
1616
|
+
{
|
|
1617
|
+
"name": "PurchasesOfferings",
|
|
1618
|
+
"slug": "purchasesofferings",
|
|
1619
|
+
"docs": "Contains all the offerings configured in RevenueCat dashboard.\nFor more info see https://docs.revenuecat.com/docs/entitlements",
|
|
1620
|
+
"tags": [],
|
|
1621
|
+
"methods": [],
|
|
1622
|
+
"properties": [
|
|
1623
|
+
{
|
|
1624
|
+
"name": "all",
|
|
1625
|
+
"tags": [],
|
|
1626
|
+
"docs": "Map of all Offerings [PurchasesOffering] objects keyed by their identifier.",
|
|
1627
|
+
"complexTypes": [
|
|
1628
|
+
"PurchasesOffering"
|
|
1629
|
+
],
|
|
1630
|
+
"type": "{ [key: string]: PurchasesOffering; }"
|
|
1631
|
+
},
|
|
1632
|
+
{
|
|
1633
|
+
"name": "current",
|
|
1634
|
+
"tags": [],
|
|
1635
|
+
"docs": "Current offering configured in the RevenueCat dashboard.",
|
|
1636
|
+
"complexTypes": [
|
|
1637
|
+
"PurchasesOffering"
|
|
1638
|
+
],
|
|
1639
|
+
"type": "PurchasesOffering | null"
|
|
1640
|
+
}
|
|
1641
|
+
]
|
|
1642
|
+
},
|
|
1643
|
+
{
|
|
1644
|
+
"name": "PurchasesOffering",
|
|
1645
|
+
"slug": "purchasesoffering",
|
|
1646
|
+
"docs": "An offering is a collection of Packages (`PurchasesPackage`) available for the user to purchase.\nFor more info see https://docs.revenuecat.com/docs/entitlements",
|
|
1647
|
+
"tags": [],
|
|
1648
|
+
"methods": [],
|
|
1649
|
+
"properties": [
|
|
1650
|
+
{
|
|
1651
|
+
"name": "identifier",
|
|
1652
|
+
"tags": [],
|
|
1653
|
+
"docs": "Unique identifier defined in RevenueCat dashboard.",
|
|
1654
|
+
"complexTypes": [],
|
|
1655
|
+
"type": "string"
|
|
1656
|
+
},
|
|
1657
|
+
{
|
|
1658
|
+
"name": "serverDescription",
|
|
1659
|
+
"tags": [],
|
|
1660
|
+
"docs": "Offering description defined in RevenueCat dashboard.",
|
|
1661
|
+
"complexTypes": [],
|
|
1662
|
+
"type": "string"
|
|
1663
|
+
},
|
|
1664
|
+
{
|
|
1665
|
+
"name": "metadata",
|
|
1666
|
+
"tags": [],
|
|
1667
|
+
"docs": "Offering metadata defined in RevenueCat dashboard. To access values, you need\nto check the type beforehand. For example:\nconst my_unknown_value: unknown = offering.metadata['my_key'];\nconst my_string_value: string | undefined = typeof(my_unknown_value) === 'string' ? my_unknown_value : undefined;",
|
|
1668
|
+
"complexTypes": [],
|
|
1669
|
+
"type": "{ [key: string]: unknown; }"
|
|
1670
|
+
},
|
|
1671
|
+
{
|
|
1672
|
+
"name": "availablePackages",
|
|
1673
|
+
"tags": [],
|
|
1674
|
+
"docs": "Array of `Package` objects available for purchase.",
|
|
1675
|
+
"complexTypes": [
|
|
1676
|
+
"PurchasesPackage"
|
|
1677
|
+
],
|
|
1678
|
+
"type": "PurchasesPackage[]"
|
|
1679
|
+
},
|
|
1680
|
+
{
|
|
1681
|
+
"name": "lifetime",
|
|
1682
|
+
"tags": [],
|
|
1683
|
+
"docs": "Lifetime package type configured in the RevenueCat dashboard, if available.",
|
|
1684
|
+
"complexTypes": [
|
|
1685
|
+
"PurchasesPackage"
|
|
1686
|
+
],
|
|
1687
|
+
"type": "PurchasesPackage | null"
|
|
1688
|
+
},
|
|
1689
|
+
{
|
|
1690
|
+
"name": "annual",
|
|
1691
|
+
"tags": [],
|
|
1692
|
+
"docs": "Annual package type configured in the RevenueCat dashboard, if available.",
|
|
1693
|
+
"complexTypes": [
|
|
1694
|
+
"PurchasesPackage"
|
|
1695
|
+
],
|
|
1696
|
+
"type": "PurchasesPackage | null"
|
|
1697
|
+
},
|
|
1698
|
+
{
|
|
1699
|
+
"name": "sixMonth",
|
|
1700
|
+
"tags": [],
|
|
1701
|
+
"docs": "Six month package type configured in the RevenueCat dashboard, if available.",
|
|
1702
|
+
"complexTypes": [
|
|
1703
|
+
"PurchasesPackage"
|
|
1704
|
+
],
|
|
1705
|
+
"type": "PurchasesPackage | null"
|
|
1706
|
+
},
|
|
1707
|
+
{
|
|
1708
|
+
"name": "threeMonth",
|
|
1709
|
+
"tags": [],
|
|
1710
|
+
"docs": "Three month package type configured in the RevenueCat dashboard, if available.",
|
|
1711
|
+
"complexTypes": [
|
|
1712
|
+
"PurchasesPackage"
|
|
1713
|
+
],
|
|
1714
|
+
"type": "PurchasesPackage | null"
|
|
1715
|
+
},
|
|
1716
|
+
{
|
|
1717
|
+
"name": "twoMonth",
|
|
1718
|
+
"tags": [],
|
|
1719
|
+
"docs": "Two month package type configured in the RevenueCat dashboard, if available.",
|
|
1720
|
+
"complexTypes": [
|
|
1721
|
+
"PurchasesPackage"
|
|
1722
|
+
],
|
|
1723
|
+
"type": "PurchasesPackage | null"
|
|
1724
|
+
},
|
|
1725
|
+
{
|
|
1726
|
+
"name": "monthly",
|
|
1727
|
+
"tags": [],
|
|
1728
|
+
"docs": "Monthly package type configured in the RevenueCat dashboard, if available.",
|
|
1729
|
+
"complexTypes": [
|
|
1730
|
+
"PurchasesPackage"
|
|
1731
|
+
],
|
|
1732
|
+
"type": "PurchasesPackage | null"
|
|
1733
|
+
},
|
|
1734
|
+
{
|
|
1735
|
+
"name": "weekly",
|
|
1736
|
+
"tags": [],
|
|
1737
|
+
"docs": "Weekly package type configured in the RevenueCat dashboard, if available.",
|
|
1738
|
+
"complexTypes": [
|
|
1739
|
+
"PurchasesPackage"
|
|
1740
|
+
],
|
|
1741
|
+
"type": "PurchasesPackage | null"
|
|
1742
|
+
}
|
|
1743
|
+
]
|
|
1744
|
+
},
|
|
1745
|
+
{
|
|
1746
|
+
"name": "PurchasesPackage",
|
|
1747
|
+
"slug": "purchasespackage",
|
|
1748
|
+
"docs": "Contains information about the product available for the user to purchase.\nFor more info see https://docs.revenuecat.com/docs/entitlements",
|
|
1749
|
+
"tags": [],
|
|
1750
|
+
"methods": [],
|
|
1751
|
+
"properties": [
|
|
1752
|
+
{
|
|
1753
|
+
"name": "identifier",
|
|
1754
|
+
"tags": [],
|
|
1755
|
+
"docs": "Unique identifier for this package. Can be one a predefined package type or a custom one.",
|
|
1756
|
+
"complexTypes": [],
|
|
1757
|
+
"type": "string"
|
|
1758
|
+
},
|
|
1759
|
+
{
|
|
1760
|
+
"name": "packageType",
|
|
1761
|
+
"tags": [],
|
|
1762
|
+
"docs": "Package type for the product. Will be one of [PACKAGE_TYPE].",
|
|
1763
|
+
"complexTypes": [
|
|
1764
|
+
"PACKAGE_TYPE"
|
|
1765
|
+
],
|
|
1766
|
+
"type": "PACKAGE_TYPE"
|
|
1767
|
+
},
|
|
1768
|
+
{
|
|
1769
|
+
"name": "product",
|
|
1770
|
+
"tags": [],
|
|
1771
|
+
"docs": "Product assigned to this package.",
|
|
1772
|
+
"complexTypes": [
|
|
1773
|
+
"PurchasesStoreProduct"
|
|
1774
|
+
],
|
|
1775
|
+
"type": "PurchasesStoreProduct"
|
|
1776
|
+
},
|
|
1777
|
+
{
|
|
1778
|
+
"name": "offeringIdentifier",
|
|
1779
|
+
"tags": [],
|
|
1780
|
+
"docs": "Offering this package belongs to.",
|
|
1781
|
+
"complexTypes": [],
|
|
1782
|
+
"type": "string"
|
|
1783
|
+
}
|
|
1784
|
+
]
|
|
1785
|
+
},
|
|
1786
|
+
{
|
|
1787
|
+
"name": "PurchasesStoreProduct",
|
|
1788
|
+
"slug": "purchasesstoreproduct",
|
|
1789
|
+
"docs": "",
|
|
1790
|
+
"tags": [],
|
|
1791
|
+
"methods": [],
|
|
1792
|
+
"properties": [
|
|
1793
|
+
{
|
|
1794
|
+
"name": "identifier",
|
|
1795
|
+
"tags": [],
|
|
1796
|
+
"docs": "Product Id.",
|
|
1797
|
+
"complexTypes": [],
|
|
1798
|
+
"type": "string"
|
|
1799
|
+
},
|
|
1800
|
+
{
|
|
1801
|
+
"name": "description",
|
|
1802
|
+
"tags": [],
|
|
1803
|
+
"docs": "Description of the product.",
|
|
1804
|
+
"complexTypes": [],
|
|
1805
|
+
"type": "string"
|
|
1806
|
+
},
|
|
1807
|
+
{
|
|
1808
|
+
"name": "title",
|
|
1809
|
+
"tags": [],
|
|
1810
|
+
"docs": "Title of the product.",
|
|
1811
|
+
"complexTypes": [],
|
|
1812
|
+
"type": "string"
|
|
1813
|
+
},
|
|
1814
|
+
{
|
|
1815
|
+
"name": "price",
|
|
1816
|
+
"tags": [],
|
|
1817
|
+
"docs": "Price of the product in the local currency.\nContains the price value of defaultOption for Google Play.",
|
|
1818
|
+
"complexTypes": [],
|
|
1819
|
+
"type": "number"
|
|
1820
|
+
},
|
|
1821
|
+
{
|
|
1822
|
+
"name": "priceString",
|
|
1823
|
+
"tags": [],
|
|
1824
|
+
"docs": "Formatted price of the item, including its currency sign.\nContains the formatted price value of defaultOption for Google Play.",
|
|
1825
|
+
"complexTypes": [],
|
|
1826
|
+
"type": "string"
|
|
1827
|
+
},
|
|
1828
|
+
{
|
|
1829
|
+
"name": "currencyCode",
|
|
1830
|
+
"tags": [],
|
|
1831
|
+
"docs": "Currency code for price and original price.\nContains the currency code value of defaultOption for Google Play.",
|
|
1832
|
+
"complexTypes": [],
|
|
1833
|
+
"type": "string"
|
|
1834
|
+
},
|
|
1835
|
+
{
|
|
1836
|
+
"name": "introPrice",
|
|
1837
|
+
"tags": [],
|
|
1838
|
+
"docs": "Introductory price.",
|
|
1839
|
+
"complexTypes": [
|
|
1840
|
+
"PurchasesIntroPrice"
|
|
1841
|
+
],
|
|
1842
|
+
"type": "PurchasesIntroPrice | null"
|
|
1843
|
+
},
|
|
1844
|
+
{
|
|
1845
|
+
"name": "discounts",
|
|
1846
|
+
"tags": [],
|
|
1847
|
+
"docs": "Collection of discount offers for a product. Null for Android.",
|
|
1848
|
+
"complexTypes": [
|
|
1849
|
+
"PurchasesStoreProductDiscount"
|
|
1850
|
+
],
|
|
1851
|
+
"type": "PurchasesStoreProductDiscount[] | null"
|
|
1852
|
+
},
|
|
1853
|
+
{
|
|
1854
|
+
"name": "productCategory",
|
|
1855
|
+
"tags": [],
|
|
1856
|
+
"docs": "Product category.",
|
|
1857
|
+
"complexTypes": [
|
|
1858
|
+
"PRODUCT_CATEGORY"
|
|
1859
|
+
],
|
|
1860
|
+
"type": "PRODUCT_CATEGORY | null"
|
|
1861
|
+
},
|
|
1862
|
+
{
|
|
1863
|
+
"name": "subscriptionPeriod",
|
|
1864
|
+
"tags": [],
|
|
1865
|
+
"docs": "Subscription period, specified in ISO 8601 format. For example,\nP1W equates to one week, P1M equates to one month,\nP3M equates to three months, P6M equates to six months,\nand P1Y equates to one year.\nNote: Not available for Amazon.",
|
|
1866
|
+
"complexTypes": [],
|
|
1867
|
+
"type": "string | null"
|
|
1868
|
+
},
|
|
1869
|
+
{
|
|
1870
|
+
"name": "defaultOption",
|
|
1871
|
+
"tags": [],
|
|
1872
|
+
"docs": "Default subscription option for a product. Google Play only.",
|
|
1873
|
+
"complexTypes": [
|
|
1874
|
+
"SubscriptionOption"
|
|
1875
|
+
],
|
|
1876
|
+
"type": "SubscriptionOption | null"
|
|
1877
|
+
},
|
|
1878
|
+
{
|
|
1879
|
+
"name": "subscriptionOptions",
|
|
1880
|
+
"tags": [],
|
|
1881
|
+
"docs": "Collection of subscription options for a product. Google Play only.",
|
|
1882
|
+
"complexTypes": [
|
|
1883
|
+
"SubscriptionOption"
|
|
1884
|
+
],
|
|
1885
|
+
"type": "SubscriptionOption[] | null"
|
|
1886
|
+
},
|
|
1887
|
+
{
|
|
1888
|
+
"name": "presentedOfferingIdentifier",
|
|
1889
|
+
"tags": [],
|
|
1890
|
+
"docs": "Offering identifier the store product was presented from.\nNull if not using offerings or if fetched directly from store via getProducts.",
|
|
1891
|
+
"complexTypes": [],
|
|
1892
|
+
"type": "string | null"
|
|
1893
|
+
}
|
|
1894
|
+
]
|
|
1895
|
+
},
|
|
1896
|
+
{
|
|
1897
|
+
"name": "PurchasesIntroPrice",
|
|
1898
|
+
"slug": "purchasesintroprice",
|
|
1899
|
+
"docs": "",
|
|
1900
|
+
"tags": [],
|
|
1901
|
+
"methods": [],
|
|
1902
|
+
"properties": [
|
|
1903
|
+
{
|
|
1904
|
+
"name": "price",
|
|
1905
|
+
"tags": [],
|
|
1906
|
+
"docs": "Price in the local currency.",
|
|
1907
|
+
"complexTypes": [],
|
|
1908
|
+
"type": "number"
|
|
1909
|
+
},
|
|
1910
|
+
{
|
|
1911
|
+
"name": "priceString",
|
|
1912
|
+
"tags": [],
|
|
1913
|
+
"docs": "Formatted price, including its currency sign, such as €3.99.",
|
|
1914
|
+
"complexTypes": [],
|
|
1915
|
+
"type": "string"
|
|
1916
|
+
},
|
|
1917
|
+
{
|
|
1918
|
+
"name": "cycles",
|
|
1919
|
+
"tags": [],
|
|
1920
|
+
"docs": "Number of subscription billing periods for which the user will be given the discount, such as 3.",
|
|
1921
|
+
"complexTypes": [],
|
|
1922
|
+
"type": "number"
|
|
1923
|
+
},
|
|
1924
|
+
{
|
|
1925
|
+
"name": "period",
|
|
1926
|
+
"tags": [],
|
|
1927
|
+
"docs": "Billing period of the discount, specified in ISO 8601 format.",
|
|
1928
|
+
"complexTypes": [],
|
|
1929
|
+
"type": "string"
|
|
1930
|
+
},
|
|
1931
|
+
{
|
|
1932
|
+
"name": "periodUnit",
|
|
1933
|
+
"tags": [],
|
|
1934
|
+
"docs": "Unit for the billing period of the discount, can be DAY, WEEK, MONTH or YEAR.",
|
|
1935
|
+
"complexTypes": [],
|
|
1936
|
+
"type": "string"
|
|
1937
|
+
},
|
|
1938
|
+
{
|
|
1939
|
+
"name": "periodNumberOfUnits",
|
|
1940
|
+
"tags": [],
|
|
1941
|
+
"docs": "Number of units for the billing period of the discount.",
|
|
1942
|
+
"complexTypes": [],
|
|
1943
|
+
"type": "number"
|
|
1944
|
+
}
|
|
1945
|
+
]
|
|
1946
|
+
},
|
|
1947
|
+
{
|
|
1948
|
+
"name": "PurchasesStoreProductDiscount",
|
|
1949
|
+
"slug": "purchasesstoreproductdiscount",
|
|
1950
|
+
"docs": "",
|
|
1951
|
+
"tags": [],
|
|
1952
|
+
"methods": [],
|
|
1953
|
+
"properties": [
|
|
1954
|
+
{
|
|
1955
|
+
"name": "identifier",
|
|
1956
|
+
"tags": [],
|
|
1957
|
+
"docs": "Identifier of the discount.",
|
|
1958
|
+
"complexTypes": [],
|
|
1959
|
+
"type": "string"
|
|
1960
|
+
},
|
|
1961
|
+
{
|
|
1962
|
+
"name": "price",
|
|
1963
|
+
"tags": [],
|
|
1964
|
+
"docs": "Price in the local currency.",
|
|
1965
|
+
"complexTypes": [],
|
|
1966
|
+
"type": "number"
|
|
1967
|
+
},
|
|
1968
|
+
{
|
|
1969
|
+
"name": "priceString",
|
|
1970
|
+
"tags": [],
|
|
1971
|
+
"docs": "Formatted price, including its currency sign, such as €3.99.",
|
|
1972
|
+
"complexTypes": [],
|
|
1973
|
+
"type": "string"
|
|
1974
|
+
},
|
|
1975
|
+
{
|
|
1976
|
+
"name": "cycles",
|
|
1977
|
+
"tags": [],
|
|
1978
|
+
"docs": "Number of subscription billing periods for which the user will be given the discount, such as 3.",
|
|
1979
|
+
"complexTypes": [],
|
|
1980
|
+
"type": "number"
|
|
1981
|
+
},
|
|
1982
|
+
{
|
|
1983
|
+
"name": "period",
|
|
1984
|
+
"tags": [],
|
|
1985
|
+
"docs": "Billing period of the discount, specified in ISO 8601 format.",
|
|
1986
|
+
"complexTypes": [],
|
|
1987
|
+
"type": "string"
|
|
1988
|
+
},
|
|
1989
|
+
{
|
|
1990
|
+
"name": "periodUnit",
|
|
1991
|
+
"tags": [],
|
|
1992
|
+
"docs": "Unit for the billing period of the discount, can be DAY, WEEK, MONTH or YEAR.",
|
|
1993
|
+
"complexTypes": [],
|
|
1994
|
+
"type": "string"
|
|
1995
|
+
},
|
|
1996
|
+
{
|
|
1997
|
+
"name": "periodNumberOfUnits",
|
|
1998
|
+
"tags": [],
|
|
1999
|
+
"docs": "Number of units for the billing period of the discount.",
|
|
2000
|
+
"complexTypes": [],
|
|
2001
|
+
"type": "number"
|
|
2002
|
+
}
|
|
2003
|
+
]
|
|
2004
|
+
},
|
|
2005
|
+
{
|
|
2006
|
+
"name": "SubscriptionOption",
|
|
2007
|
+
"slug": "subscriptionoption",
|
|
2008
|
+
"docs": "Contains all details associated with a SubscriptionOption\nUsed only for Google",
|
|
2009
|
+
"tags": [],
|
|
2010
|
+
"methods": [],
|
|
2011
|
+
"properties": [
|
|
2012
|
+
{
|
|
2013
|
+
"name": "id",
|
|
2014
|
+
"tags": [],
|
|
2015
|
+
"docs": "Identifier of the subscription option\nIf this SubscriptionOption represents a base plan, this will be the basePlanId.\nIf it represents an offer, it will be {basePlanId}:{offerId}",
|
|
2016
|
+
"complexTypes": [],
|
|
2017
|
+
"type": "string"
|
|
2018
|
+
},
|
|
2019
|
+
{
|
|
2020
|
+
"name": "storeProductId",
|
|
2021
|
+
"tags": [],
|
|
2022
|
+
"docs": "Identifier of the StoreProduct associated with this SubscriptionOption\nThis will be {subId}:{basePlanId}",
|
|
2023
|
+
"complexTypes": [],
|
|
2024
|
+
"type": "string"
|
|
2025
|
+
},
|
|
2026
|
+
{
|
|
2027
|
+
"name": "productId",
|
|
2028
|
+
"tags": [],
|
|
2029
|
+
"docs": "Identifer of the subscription associated with this SubscriptionOption\nThis will be {subId}",
|
|
2030
|
+
"complexTypes": [],
|
|
2031
|
+
"type": "string"
|
|
2032
|
+
},
|
|
2033
|
+
{
|
|
2034
|
+
"name": "pricingPhases",
|
|
2035
|
+
"tags": [],
|
|
2036
|
+
"docs": "Pricing phases defining a user's payment plan for the product over time.",
|
|
2037
|
+
"complexTypes": [
|
|
2038
|
+
"PricingPhase"
|
|
2039
|
+
],
|
|
2040
|
+
"type": "PricingPhase[]"
|
|
2041
|
+
},
|
|
2042
|
+
{
|
|
2043
|
+
"name": "tags",
|
|
2044
|
+
"tags": [],
|
|
2045
|
+
"docs": "Tags defined on the base plan or offer. Empty for Amazon.",
|
|
2046
|
+
"complexTypes": [],
|
|
2047
|
+
"type": "string[]"
|
|
2048
|
+
},
|
|
2049
|
+
{
|
|
2050
|
+
"name": "isBasePlan",
|
|
2051
|
+
"tags": [],
|
|
2052
|
+
"docs": "True if this SubscriptionOption represents a subscription base plan (rather than an offer).",
|
|
2053
|
+
"complexTypes": [],
|
|
2054
|
+
"type": "boolean"
|
|
2055
|
+
},
|
|
2056
|
+
{
|
|
2057
|
+
"name": "billingPeriod",
|
|
2058
|
+
"tags": [],
|
|
2059
|
+
"docs": "The subscription period of fullPricePhase (after free and intro trials).",
|
|
2060
|
+
"complexTypes": [
|
|
2061
|
+
"Period"
|
|
2062
|
+
],
|
|
2063
|
+
"type": "Period | null"
|
|
2064
|
+
},
|
|
2065
|
+
{
|
|
2066
|
+
"name": "isPrepaid",
|
|
2067
|
+
"tags": [],
|
|
2068
|
+
"docs": "True if the subscription is pre-paid.",
|
|
2069
|
+
"complexTypes": [],
|
|
2070
|
+
"type": "boolean"
|
|
2071
|
+
},
|
|
2072
|
+
{
|
|
2073
|
+
"name": "fullPricePhase",
|
|
2074
|
+
"tags": [],
|
|
2075
|
+
"docs": "The full price PricingPhase of the subscription.\nLooks for the last price phase of the SubscriptionOption.",
|
|
2076
|
+
"complexTypes": [
|
|
2077
|
+
"PricingPhase"
|
|
2078
|
+
],
|
|
2079
|
+
"type": "PricingPhase | null"
|
|
2080
|
+
},
|
|
2081
|
+
{
|
|
2082
|
+
"name": "freePhase",
|
|
2083
|
+
"tags": [],
|
|
2084
|
+
"docs": "The free trial PricingPhase of the subscription.\nLooks for the first pricing phase of the SubscriptionOption where amountMicros is 0.\nThere can be a freeTrialPhase and an introductoryPhase in the same SubscriptionOption.",
|
|
2085
|
+
"complexTypes": [
|
|
2086
|
+
"PricingPhase"
|
|
2087
|
+
],
|
|
2088
|
+
"type": "PricingPhase | null"
|
|
2089
|
+
},
|
|
2090
|
+
{
|
|
2091
|
+
"name": "introPhase",
|
|
2092
|
+
"tags": [],
|
|
2093
|
+
"docs": "The intro trial PricingPhase of the subscription.\nLooks for the first pricing phase of the SubscriptionOption where amountMicros is greater than 0.\nThere can be a freeTrialPhase and an introductoryPhase in the same SubscriptionOption.",
|
|
2094
|
+
"complexTypes": [
|
|
2095
|
+
"PricingPhase"
|
|
2096
|
+
],
|
|
2097
|
+
"type": "PricingPhase | null"
|
|
2098
|
+
},
|
|
2099
|
+
{
|
|
2100
|
+
"name": "presentedOfferingIdentifier",
|
|
2101
|
+
"tags": [],
|
|
2102
|
+
"docs": "Offering identifier the subscription option was presented from",
|
|
2103
|
+
"complexTypes": [],
|
|
2104
|
+
"type": "string | null"
|
|
2105
|
+
}
|
|
2106
|
+
]
|
|
2107
|
+
},
|
|
2108
|
+
{
|
|
2109
|
+
"name": "PricingPhase",
|
|
2110
|
+
"slug": "pricingphase",
|
|
2111
|
+
"docs": "Contains all the details associated with a PricingPhase",
|
|
2112
|
+
"tags": [],
|
|
2113
|
+
"methods": [],
|
|
2114
|
+
"properties": [
|
|
2115
|
+
{
|
|
2116
|
+
"name": "billingPeriod",
|
|
2117
|
+
"tags": [],
|
|
2118
|
+
"docs": "Billing period for which the PricingPhase applies",
|
|
2119
|
+
"complexTypes": [
|
|
2120
|
+
"Period"
|
|
2121
|
+
],
|
|
2122
|
+
"type": "Period"
|
|
2123
|
+
},
|
|
2124
|
+
{
|
|
2125
|
+
"name": "recurrenceMode",
|
|
2126
|
+
"tags": [],
|
|
2127
|
+
"docs": "Recurrence mode of the PricingPhase",
|
|
2128
|
+
"complexTypes": [
|
|
2129
|
+
"RECURRENCE_MODE"
|
|
2130
|
+
],
|
|
2131
|
+
"type": "RECURRENCE_MODE | null"
|
|
2132
|
+
},
|
|
2133
|
+
{
|
|
2134
|
+
"name": "billingCycleCount",
|
|
2135
|
+
"tags": [],
|
|
2136
|
+
"docs": "Number of cycles for which the pricing phase applies.\nNull for infiniteRecurring or finiteRecurring recurrence modes.",
|
|
2137
|
+
"complexTypes": [],
|
|
2138
|
+
"type": "number | null"
|
|
2139
|
+
},
|
|
2140
|
+
{
|
|
2141
|
+
"name": "price",
|
|
2142
|
+
"tags": [],
|
|
2143
|
+
"docs": "Price of the PricingPhase",
|
|
2144
|
+
"complexTypes": [
|
|
2145
|
+
"Price"
|
|
2146
|
+
],
|
|
2147
|
+
"type": "Price"
|
|
2148
|
+
},
|
|
2149
|
+
{
|
|
2150
|
+
"name": "offerPaymentMode",
|
|
2151
|
+
"tags": [],
|
|
2152
|
+
"docs": "Indicates how the pricing phase is charged for finiteRecurring pricing phases",
|
|
2153
|
+
"complexTypes": [
|
|
2154
|
+
"OFFER_PAYMENT_MODE"
|
|
2155
|
+
],
|
|
2156
|
+
"type": "OFFER_PAYMENT_MODE | null"
|
|
2157
|
+
}
|
|
2158
|
+
]
|
|
2159
|
+
},
|
|
2160
|
+
{
|
|
2161
|
+
"name": "Period",
|
|
2162
|
+
"slug": "period",
|
|
2163
|
+
"docs": "Contains all the details associated with a Period",
|
|
2164
|
+
"tags": [],
|
|
2165
|
+
"methods": [],
|
|
2166
|
+
"properties": [
|
|
2167
|
+
{
|
|
2168
|
+
"name": "unit",
|
|
2169
|
+
"tags": [],
|
|
2170
|
+
"docs": "The number of period units: day, week, month, year, unknown",
|
|
2171
|
+
"complexTypes": [
|
|
2172
|
+
"PERIOD_UNIT"
|
|
2173
|
+
],
|
|
2174
|
+
"type": "PERIOD_UNIT"
|
|
2175
|
+
},
|
|
2176
|
+
{
|
|
2177
|
+
"name": "value",
|
|
2178
|
+
"tags": [],
|
|
2179
|
+
"docs": "The increment of time that a subscription period is specified in",
|
|
2180
|
+
"complexTypes": [],
|
|
2181
|
+
"type": "number"
|
|
2182
|
+
},
|
|
2183
|
+
{
|
|
2184
|
+
"name": "iso8601",
|
|
2185
|
+
"tags": [],
|
|
2186
|
+
"docs": "Specified in ISO 8601 format. For example, P1W equates to one week,\nP1M equates to one month, P3M equates to three months, P6M equates to six months,\nand P1Y equates to one year",
|
|
2187
|
+
"complexTypes": [],
|
|
2188
|
+
"type": "string"
|
|
2189
|
+
}
|
|
2190
|
+
]
|
|
2191
|
+
},
|
|
2192
|
+
{
|
|
2193
|
+
"name": "Price",
|
|
2194
|
+
"slug": "price",
|
|
2195
|
+
"docs": "Contains all the details associated with a Price",
|
|
2196
|
+
"tags": [],
|
|
2197
|
+
"methods": [],
|
|
2198
|
+
"properties": [
|
|
2199
|
+
{
|
|
2200
|
+
"name": "formatted",
|
|
2201
|
+
"tags": [],
|
|
2202
|
+
"docs": "Formatted price of the item, including its currency sign. For example $3.00",
|
|
2203
|
+
"complexTypes": [],
|
|
2204
|
+
"type": "string"
|
|
2205
|
+
},
|
|
2206
|
+
{
|
|
2207
|
+
"name": "amountMicros",
|
|
2208
|
+
"tags": [],
|
|
2209
|
+
"docs": "Price in micro-units, where 1,000,000 micro-units equal one unit of the currency.\n\nFor example, if price is \"€7.99\", price_amount_micros is 7,990,000. This value represents\nthe localized, rounded price for a particular currency.",
|
|
2210
|
+
"complexTypes": [],
|
|
2211
|
+
"type": "number"
|
|
2212
|
+
},
|
|
2213
|
+
{
|
|
2214
|
+
"name": "currencyCode",
|
|
2215
|
+
"tags": [],
|
|
2216
|
+
"docs": "Returns ISO 4217 currency code for price and original price.\n\nFor example, if price is specified in British pounds sterling, price_currency_code is \"GBP\".\nIf currency code cannot be determined, currency symbol is returned.",
|
|
2217
|
+
"complexTypes": [],
|
|
2218
|
+
"type": "string"
|
|
2219
|
+
}
|
|
2220
|
+
]
|
|
2221
|
+
},
|
|
2222
|
+
{
|
|
2223
|
+
"name": "GetProductOptions",
|
|
2224
|
+
"slug": "getproductoptions",
|
|
2225
|
+
"docs": "",
|
|
2226
|
+
"tags": [],
|
|
2227
|
+
"methods": [],
|
|
2228
|
+
"properties": [
|
|
2229
|
+
{
|
|
2230
|
+
"name": "productIdentifiers",
|
|
2231
|
+
"tags": [],
|
|
2232
|
+
"docs": "Array of product identifiers to obtain",
|
|
2233
|
+
"complexTypes": [],
|
|
2234
|
+
"type": "string[]"
|
|
2235
|
+
},
|
|
2236
|
+
{
|
|
2237
|
+
"name": "type",
|
|
2238
|
+
"tags": [],
|
|
2239
|
+
"docs": "Optional type of products to fetch, can be SUBSCRIPTION or NON_SUBSCRIPTION. SUBSCRIPTION by default. Ignored in iOS.",
|
|
2240
|
+
"complexTypes": [
|
|
2241
|
+
"PRODUCT_CATEGORY"
|
|
2242
|
+
],
|
|
2243
|
+
"type": "PRODUCT_CATEGORY"
|
|
2244
|
+
}
|
|
2245
|
+
]
|
|
2246
|
+
},
|
|
2247
|
+
{
|
|
2248
|
+
"name": "PurchaseStoreProductOptions",
|
|
2249
|
+
"slug": "purchasestoreproductoptions",
|
|
2250
|
+
"docs": "",
|
|
2251
|
+
"tags": [],
|
|
2252
|
+
"methods": [],
|
|
2253
|
+
"properties": [
|
|
2254
|
+
{
|
|
2255
|
+
"name": "product",
|
|
2256
|
+
"tags": [],
|
|
2257
|
+
"docs": "The product you want to purchase",
|
|
2258
|
+
"complexTypes": [
|
|
2259
|
+
"PurchasesStoreProduct"
|
|
2260
|
+
],
|
|
2261
|
+
"type": "PurchasesStoreProduct"
|
|
2262
|
+
},
|
|
2263
|
+
{
|
|
2264
|
+
"name": "googleProductChangeInfo",
|
|
2265
|
+
"tags": [],
|
|
2266
|
+
"docs": "Android only. Optional GoogleProductChangeInfo you\nwish to upgrade from containing the oldProductIdentifier and the optional prorationMode.",
|
|
2267
|
+
"complexTypes": [
|
|
2268
|
+
"GoogleProductChangeInfo"
|
|
2269
|
+
],
|
|
2270
|
+
"type": "GoogleProductChangeInfo | null | undefined"
|
|
2271
|
+
},
|
|
2272
|
+
{
|
|
2273
|
+
"name": "googleIsPersonalizedPrice",
|
|
2274
|
+
"tags": [],
|
|
2275
|
+
"docs": "Android and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU.\nFor compliance with EU regulations. User will see \"This price has been customized for you\" in the purchase dialog when true.\nSee https://developer.android.com/google/play/billing/integrate#personalized-price for more info.",
|
|
2276
|
+
"complexTypes": [],
|
|
2277
|
+
"type": "boolean | null | undefined"
|
|
2278
|
+
}
|
|
2279
|
+
]
|
|
2280
|
+
},
|
|
2281
|
+
{
|
|
2282
|
+
"name": "GoogleProductChangeInfo",
|
|
2283
|
+
"slug": "googleproductchangeinfo",
|
|
2284
|
+
"docs": "Holds the information used when upgrading from another sku. For Android use only.",
|
|
2285
|
+
"tags": [],
|
|
2286
|
+
"methods": [],
|
|
2287
|
+
"properties": [
|
|
2288
|
+
{
|
|
2289
|
+
"name": "oldProductIdentifier",
|
|
2290
|
+
"tags": [],
|
|
2291
|
+
"docs": "The old product identifier to upgrade from.",
|
|
2292
|
+
"complexTypes": [],
|
|
2293
|
+
"type": "string"
|
|
2294
|
+
},
|
|
2295
|
+
{
|
|
2296
|
+
"name": "prorationMode",
|
|
2297
|
+
"tags": [],
|
|
2298
|
+
"docs": "The [PRORATION_MODE] to use when upgrading the given oldSKU.",
|
|
2299
|
+
"complexTypes": [
|
|
2300
|
+
"PRORATION_MODE"
|
|
2301
|
+
],
|
|
2302
|
+
"type": "PRORATION_MODE"
|
|
2303
|
+
}
|
|
2304
|
+
]
|
|
2305
|
+
},
|
|
2306
|
+
{
|
|
2307
|
+
"name": "PurchaseDiscountedProductOptions",
|
|
2308
|
+
"slug": "purchasediscountedproductoptions",
|
|
2309
|
+
"docs": "",
|
|
2310
|
+
"tags": [],
|
|
2311
|
+
"methods": [],
|
|
2312
|
+
"properties": [
|
|
2313
|
+
{
|
|
2314
|
+
"name": "product",
|
|
2315
|
+
"tags": [],
|
|
2316
|
+
"docs": "The product you want to purchase",
|
|
2317
|
+
"complexTypes": [
|
|
2318
|
+
"PurchasesStoreProduct"
|
|
2319
|
+
],
|
|
2320
|
+
"type": "PurchasesStoreProduct"
|
|
2321
|
+
},
|
|
2322
|
+
{
|
|
2323
|
+
"name": "discount",
|
|
2324
|
+
"tags": [],
|
|
2325
|
+
"docs": "Discount to apply to this package. Retrieve this discount using getPromotionalOffer.",
|
|
2326
|
+
"complexTypes": [
|
|
2327
|
+
"PurchasesPromotionalOffer"
|
|
2328
|
+
],
|
|
2329
|
+
"type": "PurchasesPromotionalOffer"
|
|
2330
|
+
}
|
|
2331
|
+
]
|
|
2332
|
+
},
|
|
2333
|
+
{
|
|
2334
|
+
"name": "PurchasesPromotionalOffer",
|
|
2335
|
+
"slug": "purchasespromotionaloffer",
|
|
2336
|
+
"docs": "",
|
|
2337
|
+
"tags": [],
|
|
2338
|
+
"methods": [],
|
|
2339
|
+
"properties": [
|
|
2340
|
+
{
|
|
2341
|
+
"name": "identifier",
|
|
2342
|
+
"tags": [],
|
|
2343
|
+
"docs": "",
|
|
2344
|
+
"complexTypes": [],
|
|
2345
|
+
"type": "string"
|
|
2346
|
+
},
|
|
2347
|
+
{
|
|
2348
|
+
"name": "keyIdentifier",
|
|
2349
|
+
"tags": [],
|
|
2350
|
+
"docs": "",
|
|
2351
|
+
"complexTypes": [],
|
|
2352
|
+
"type": "string"
|
|
2353
|
+
},
|
|
2354
|
+
{
|
|
2355
|
+
"name": "nonce",
|
|
2356
|
+
"tags": [],
|
|
2357
|
+
"docs": "",
|
|
2358
|
+
"complexTypes": [],
|
|
2359
|
+
"type": "string"
|
|
2360
|
+
},
|
|
2361
|
+
{
|
|
2362
|
+
"name": "signature",
|
|
2363
|
+
"tags": [],
|
|
2364
|
+
"docs": "",
|
|
2365
|
+
"complexTypes": [],
|
|
2366
|
+
"type": "string"
|
|
2367
|
+
},
|
|
2368
|
+
{
|
|
2369
|
+
"name": "timestamp",
|
|
2370
|
+
"tags": [],
|
|
2371
|
+
"docs": "",
|
|
2372
|
+
"complexTypes": [],
|
|
2373
|
+
"type": "number"
|
|
2374
|
+
}
|
|
2375
|
+
]
|
|
2376
|
+
},
|
|
2377
|
+
{
|
|
2378
|
+
"name": "PurchasePackageOptions",
|
|
2379
|
+
"slug": "purchasepackageoptions",
|
|
2380
|
+
"docs": "",
|
|
2381
|
+
"tags": [],
|
|
2382
|
+
"methods": [],
|
|
2383
|
+
"properties": [
|
|
2384
|
+
{
|
|
2385
|
+
"name": "aPackage",
|
|
2386
|
+
"tags": [],
|
|
2387
|
+
"docs": "The Package you wish to purchase. You can get the Packages by calling getOfferings",
|
|
2388
|
+
"complexTypes": [
|
|
2389
|
+
"PurchasesPackage"
|
|
2390
|
+
],
|
|
2391
|
+
"type": "PurchasesPackage"
|
|
2392
|
+
},
|
|
2393
|
+
{
|
|
2394
|
+
"name": "googleProductChangeInfo",
|
|
2395
|
+
"tags": [],
|
|
2396
|
+
"docs": "Android only. Optional GoogleProductChangeInfo you\nwish to upgrade from containing the oldProductIdentifier and the optional prorationMode.",
|
|
2397
|
+
"complexTypes": [
|
|
2398
|
+
"GoogleProductChangeInfo"
|
|
2399
|
+
],
|
|
2400
|
+
"type": "GoogleProductChangeInfo | null | undefined"
|
|
2401
|
+
},
|
|
2402
|
+
{
|
|
2403
|
+
"name": "googleIsPersonalizedPrice",
|
|
2404
|
+
"tags": [],
|
|
2405
|
+
"docs": "Android and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU.\nFor compliance with EU regulations. User will see \"This price has been customized for you\" in the purchase dialog when true.\nSee https://developer.android.com/google/play/billing/integrate#personalized-price for more info.",
|
|
2406
|
+
"complexTypes": [],
|
|
2407
|
+
"type": "boolean | null | undefined"
|
|
2408
|
+
}
|
|
2409
|
+
]
|
|
2410
|
+
},
|
|
2411
|
+
{
|
|
2412
|
+
"name": "PurchaseSubscriptionOptionOptions",
|
|
2413
|
+
"slug": "purchasesubscriptionoptionoptions",
|
|
2414
|
+
"docs": "",
|
|
2415
|
+
"tags": [],
|
|
2416
|
+
"methods": [],
|
|
2417
|
+
"properties": [
|
|
2418
|
+
{
|
|
2419
|
+
"name": "subscriptionOption",
|
|
2420
|
+
"tags": [],
|
|
2421
|
+
"docs": "The SubscriptionOption you wish to purchase. You can get the SubscriptionOption from StoreProducts by calling getOfferings",
|
|
2422
|
+
"complexTypes": [
|
|
2423
|
+
"SubscriptionOption"
|
|
2424
|
+
],
|
|
2425
|
+
"type": "SubscriptionOption"
|
|
2426
|
+
},
|
|
2427
|
+
{
|
|
2428
|
+
"name": "googleProductChangeInfo",
|
|
2429
|
+
"tags": [],
|
|
2430
|
+
"docs": "Android only. Optional GoogleProductChangeInfo you\nwish to upgrade from containing the oldProductIdentifier and the optional prorationMode.",
|
|
2431
|
+
"complexTypes": [
|
|
2432
|
+
"GoogleProductChangeInfo"
|
|
2433
|
+
],
|
|
2434
|
+
"type": "GoogleProductChangeInfo | null | undefined"
|
|
2435
|
+
},
|
|
2436
|
+
{
|
|
2437
|
+
"name": "googleIsPersonalizedPrice",
|
|
2438
|
+
"tags": [],
|
|
2439
|
+
"docs": "Android and Google only. Optional boolean indicates personalized pricing on products available for purchase in the EU.\nFor compliance with EU regulations. User will see \"This price has been customized for you\" in the purchase dialog when true.\nSee https://developer.android.com/google/play/billing/integrate#personalized-price for more info.",
|
|
2440
|
+
"complexTypes": [],
|
|
2441
|
+
"type": "boolean | null | undefined"
|
|
2442
|
+
}
|
|
2443
|
+
]
|
|
2444
|
+
},
|
|
2445
|
+
{
|
|
2446
|
+
"name": "PurchaseDiscountedPackageOptions",
|
|
2447
|
+
"slug": "purchasediscountedpackageoptions",
|
|
2448
|
+
"docs": "",
|
|
2449
|
+
"tags": [],
|
|
2450
|
+
"methods": [],
|
|
2451
|
+
"properties": [
|
|
2452
|
+
{
|
|
2453
|
+
"name": "aPackage",
|
|
2454
|
+
"tags": [],
|
|
2455
|
+
"docs": "The Package you wish to purchase. You can get the Packages by calling getOfferings",
|
|
2456
|
+
"complexTypes": [
|
|
2457
|
+
"PurchasesPackage"
|
|
2458
|
+
],
|
|
2459
|
+
"type": "PurchasesPackage"
|
|
2460
|
+
},
|
|
2461
|
+
{
|
|
2462
|
+
"name": "discount",
|
|
2463
|
+
"tags": [],
|
|
2464
|
+
"docs": "Discount to apply to this package. Retrieve this discount using getPromotionalOffer.",
|
|
2465
|
+
"complexTypes": [
|
|
2466
|
+
"PurchasesPromotionalOffer"
|
|
2467
|
+
],
|
|
2468
|
+
"type": "PurchasesPromotionalOffer"
|
|
2469
|
+
}
|
|
2470
|
+
]
|
|
2471
|
+
},
|
|
2472
|
+
{
|
|
2473
|
+
"name": "LogInResult",
|
|
2474
|
+
"slug": "loginresult",
|
|
2475
|
+
"docs": "Holds the logIn result",
|
|
2476
|
+
"tags": [],
|
|
2477
|
+
"methods": [],
|
|
2478
|
+
"properties": [
|
|
2479
|
+
{
|
|
2480
|
+
"name": "customerInfo",
|
|
2481
|
+
"tags": [],
|
|
2482
|
+
"docs": "The Customer Info for the user.",
|
|
2483
|
+
"complexTypes": [
|
|
2484
|
+
"CustomerInfo"
|
|
2485
|
+
],
|
|
2486
|
+
"type": "CustomerInfo"
|
|
2487
|
+
},
|
|
2488
|
+
{
|
|
2489
|
+
"name": "created",
|
|
2490
|
+
"tags": [],
|
|
2491
|
+
"docs": "True if the call resulted in a new user getting created in the RevenueCat backend.",
|
|
2492
|
+
"complexTypes": [],
|
|
2493
|
+
"type": "boolean"
|
|
2494
|
+
}
|
|
2495
|
+
]
|
|
2496
|
+
},
|
|
2497
|
+
{
|
|
2498
|
+
"name": "SyncObserverModeAmazonPurchaseOptions",
|
|
2499
|
+
"slug": "syncobservermodeamazonpurchaseoptions",
|
|
2500
|
+
"docs": "",
|
|
2501
|
+
"tags": [],
|
|
2502
|
+
"methods": [],
|
|
2503
|
+
"properties": [
|
|
2504
|
+
{
|
|
2505
|
+
"name": "productID",
|
|
2506
|
+
"tags": [],
|
|
2507
|
+
"docs": "Product ID associated to the purchase.",
|
|
2508
|
+
"complexTypes": [],
|
|
2509
|
+
"type": "string"
|
|
2510
|
+
},
|
|
2511
|
+
{
|
|
2512
|
+
"name": "receiptID",
|
|
2513
|
+
"tags": [],
|
|
2514
|
+
"docs": "ReceiptId that represents the Amazon purchase.",
|
|
2515
|
+
"complexTypes": [],
|
|
2516
|
+
"type": "string"
|
|
2517
|
+
},
|
|
2518
|
+
{
|
|
2519
|
+
"name": "amazonUserID",
|
|
2520
|
+
"tags": [],
|
|
2521
|
+
"docs": "Amazon's userID. This parameter will be ignored when syncing a Google purchase.",
|
|
2522
|
+
"complexTypes": [],
|
|
2523
|
+
"type": "string"
|
|
2524
|
+
},
|
|
2525
|
+
{
|
|
2526
|
+
"name": "isoCurrencyCode",
|
|
2527
|
+
"tags": [],
|
|
2528
|
+
"docs": "Product's currency code in ISO 4217 format.",
|
|
2529
|
+
"complexTypes": [],
|
|
2530
|
+
"type": "string | null | undefined"
|
|
2531
|
+
},
|
|
2532
|
+
{
|
|
2533
|
+
"name": "price",
|
|
2534
|
+
"tags": [],
|
|
2535
|
+
"docs": "Product's price.",
|
|
2536
|
+
"complexTypes": [],
|
|
2537
|
+
"type": "number | null | undefined"
|
|
2538
|
+
}
|
|
2539
|
+
]
|
|
2540
|
+
},
|
|
2541
|
+
{
|
|
2542
|
+
"name": "IntroEligibility",
|
|
2543
|
+
"slug": "introeligibility",
|
|
2544
|
+
"docs": "Holds the introductory price status",
|
|
2545
|
+
"tags": [],
|
|
2546
|
+
"methods": [],
|
|
2547
|
+
"properties": [
|
|
2548
|
+
{
|
|
2549
|
+
"name": "status",
|
|
2550
|
+
"tags": [],
|
|
2551
|
+
"docs": "The introductory price eligibility status",
|
|
2552
|
+
"complexTypes": [
|
|
2553
|
+
"INTRO_ELIGIBILITY_STATUS"
|
|
2554
|
+
],
|
|
2555
|
+
"type": "INTRO_ELIGIBILITY_STATUS"
|
|
2556
|
+
},
|
|
2557
|
+
{
|
|
2558
|
+
"name": "description",
|
|
2559
|
+
"tags": [],
|
|
2560
|
+
"docs": "Description of the status",
|
|
2561
|
+
"complexTypes": [],
|
|
2562
|
+
"type": "string"
|
|
2563
|
+
}
|
|
2564
|
+
]
|
|
2565
|
+
},
|
|
2566
|
+
{
|
|
2567
|
+
"name": "GetPromotionalOfferOptions",
|
|
2568
|
+
"slug": "getpromotionalofferoptions",
|
|
2569
|
+
"docs": "",
|
|
2570
|
+
"tags": [],
|
|
2571
|
+
"methods": [],
|
|
2572
|
+
"properties": [
|
|
2573
|
+
{
|
|
2574
|
+
"name": "product",
|
|
2575
|
+
"tags": [],
|
|
2576
|
+
"docs": "The `PurchasesStoreProduct` the user intends to purchase.",
|
|
2577
|
+
"complexTypes": [
|
|
2578
|
+
"PurchasesStoreProduct"
|
|
2579
|
+
],
|
|
2580
|
+
"type": "PurchasesStoreProduct"
|
|
2581
|
+
},
|
|
2582
|
+
{
|
|
2583
|
+
"name": "discount",
|
|
2584
|
+
"tags": [],
|
|
2585
|
+
"docs": "The `PurchasesStoreProductDiscount` to apply to the product.",
|
|
2586
|
+
"complexTypes": [
|
|
2587
|
+
"PurchasesStoreProductDiscount"
|
|
2588
|
+
],
|
|
2589
|
+
"type": "PurchasesStoreProductDiscount"
|
|
2590
|
+
}
|
|
2591
|
+
]
|
|
2592
|
+
}
|
|
2593
|
+
],
|
|
2594
|
+
"enums": [
|
|
2595
|
+
{
|
|
2596
|
+
"name": "PACKAGE_TYPE",
|
|
2597
|
+
"slug": "package_type",
|
|
2598
|
+
"members": [
|
|
2599
|
+
{
|
|
2600
|
+
"name": "UNKNOWN",
|
|
2601
|
+
"value": "\"UNKNOWN\"",
|
|
2602
|
+
"tags": [],
|
|
2603
|
+
"docs": "A package that was defined with a custom identifier."
|
|
2604
|
+
},
|
|
2605
|
+
{
|
|
2606
|
+
"name": "CUSTOM",
|
|
2607
|
+
"value": "\"CUSTOM\"",
|
|
2608
|
+
"tags": [],
|
|
2609
|
+
"docs": "A package that was defined with a custom identifier."
|
|
2610
|
+
},
|
|
2611
|
+
{
|
|
2612
|
+
"name": "LIFETIME",
|
|
2613
|
+
"value": "\"LIFETIME\"",
|
|
2614
|
+
"tags": [],
|
|
2615
|
+
"docs": "A package configured with the predefined lifetime identifier."
|
|
2616
|
+
},
|
|
2617
|
+
{
|
|
2618
|
+
"name": "ANNUAL",
|
|
2619
|
+
"value": "\"ANNUAL\"",
|
|
2620
|
+
"tags": [],
|
|
2621
|
+
"docs": "A package configured with the predefined annual identifier."
|
|
2622
|
+
},
|
|
2623
|
+
{
|
|
2624
|
+
"name": "SIX_MONTH",
|
|
2625
|
+
"value": "\"SIX_MONTH\"",
|
|
2626
|
+
"tags": [],
|
|
2627
|
+
"docs": "A package configured with the predefined six month identifier."
|
|
2628
|
+
},
|
|
2629
|
+
{
|
|
2630
|
+
"name": "THREE_MONTH",
|
|
2631
|
+
"value": "\"THREE_MONTH\"",
|
|
2632
|
+
"tags": [],
|
|
2633
|
+
"docs": "A package configured with the predefined three month identifier."
|
|
2634
|
+
},
|
|
2635
|
+
{
|
|
2636
|
+
"name": "TWO_MONTH",
|
|
2637
|
+
"value": "\"TWO_MONTH\"",
|
|
2638
|
+
"tags": [],
|
|
2639
|
+
"docs": "A package configured with the predefined two month identifier."
|
|
2640
|
+
},
|
|
2641
|
+
{
|
|
2642
|
+
"name": "MONTHLY",
|
|
2643
|
+
"value": "\"MONTHLY\"",
|
|
2644
|
+
"tags": [],
|
|
2645
|
+
"docs": "A package configured with the predefined monthly identifier."
|
|
2646
|
+
},
|
|
2647
|
+
{
|
|
2648
|
+
"name": "WEEKLY",
|
|
2649
|
+
"value": "\"WEEKLY\"",
|
|
2650
|
+
"tags": [],
|
|
2651
|
+
"docs": "A package configured with the predefined weekly identifier."
|
|
2652
|
+
}
|
|
2653
|
+
]
|
|
2654
|
+
},
|
|
2655
|
+
{
|
|
2656
|
+
"name": "PRODUCT_CATEGORY",
|
|
2657
|
+
"slug": "product_category",
|
|
2658
|
+
"members": [
|
|
2659
|
+
{
|
|
2660
|
+
"name": "NON_SUBSCRIPTION",
|
|
2661
|
+
"value": "\"NON_SUBSCRIPTION\"",
|
|
2662
|
+
"tags": [],
|
|
2663
|
+
"docs": "A type of product for non-subscription."
|
|
2664
|
+
},
|
|
2665
|
+
{
|
|
2666
|
+
"name": "SUBSCRIPTION",
|
|
2667
|
+
"value": "\"SUBSCRIPTION\"",
|
|
2668
|
+
"tags": [],
|
|
2669
|
+
"docs": "A type of product for subscriptions."
|
|
2670
|
+
},
|
|
2671
|
+
{
|
|
2672
|
+
"name": "UNKNOWN",
|
|
2673
|
+
"value": "\"UNKNOWN\"",
|
|
2674
|
+
"tags": [],
|
|
2675
|
+
"docs": "A type of product for unknowns."
|
|
2676
|
+
}
|
|
2677
|
+
]
|
|
2678
|
+
},
|
|
2679
|
+
{
|
|
2680
|
+
"name": "PERIOD_UNIT",
|
|
2681
|
+
"slug": "period_unit",
|
|
2682
|
+
"members": [
|
|
2683
|
+
{
|
|
2684
|
+
"name": "DAY",
|
|
2685
|
+
"value": "\"DAY\"",
|
|
2686
|
+
"tags": [],
|
|
2687
|
+
"docs": ""
|
|
2688
|
+
},
|
|
2689
|
+
{
|
|
2690
|
+
"name": "WEEK",
|
|
2691
|
+
"value": "\"WEEK\"",
|
|
2692
|
+
"tags": [],
|
|
2693
|
+
"docs": ""
|
|
2694
|
+
},
|
|
2695
|
+
{
|
|
2696
|
+
"name": "MONTH",
|
|
2697
|
+
"value": "\"MONTH\"",
|
|
2698
|
+
"tags": [],
|
|
2699
|
+
"docs": ""
|
|
2700
|
+
},
|
|
2701
|
+
{
|
|
2702
|
+
"name": "YEAR",
|
|
2703
|
+
"value": "\"YEAR\"",
|
|
2704
|
+
"tags": [],
|
|
2705
|
+
"docs": ""
|
|
2706
|
+
},
|
|
2707
|
+
{
|
|
2708
|
+
"name": "UNKNOWN",
|
|
2709
|
+
"value": "\"UNKNOWN\"",
|
|
2710
|
+
"tags": [],
|
|
2711
|
+
"docs": ""
|
|
2712
|
+
}
|
|
2713
|
+
]
|
|
2714
|
+
},
|
|
2715
|
+
{
|
|
2716
|
+
"name": "RECURRENCE_MODE",
|
|
2717
|
+
"slug": "recurrence_mode",
|
|
2718
|
+
"members": [
|
|
2719
|
+
{
|
|
2720
|
+
"name": "INFINITE_RECURRING",
|
|
2721
|
+
"value": "1",
|
|
2722
|
+
"tags": [],
|
|
2723
|
+
"docs": "Pricing phase repeats infinitely until cancellation"
|
|
2724
|
+
},
|
|
2725
|
+
{
|
|
2726
|
+
"name": "FINITE_RECURRING",
|
|
2727
|
+
"value": "2",
|
|
2728
|
+
"tags": [],
|
|
2729
|
+
"docs": "Pricing phase repeats for a fixed number of billing periods"
|
|
2730
|
+
},
|
|
2731
|
+
{
|
|
2732
|
+
"name": "NON_RECURRING",
|
|
2733
|
+
"value": "3",
|
|
2734
|
+
"tags": [],
|
|
2735
|
+
"docs": "Pricing phase does not repeat"
|
|
2736
|
+
}
|
|
2737
|
+
]
|
|
2738
|
+
},
|
|
2739
|
+
{
|
|
2740
|
+
"name": "OFFER_PAYMENT_MODE",
|
|
2741
|
+
"slug": "offer_payment_mode",
|
|
2742
|
+
"members": [
|
|
2743
|
+
{
|
|
2744
|
+
"name": "FREE_TRIAL",
|
|
2745
|
+
"value": "\"FREE_TRIAL\"",
|
|
2746
|
+
"tags": [],
|
|
2747
|
+
"docs": "Subscribers don't pay until the specified period ends"
|
|
2748
|
+
},
|
|
2749
|
+
{
|
|
2750
|
+
"name": "SINGLE_PAYMENT",
|
|
2751
|
+
"value": "\"SINGLE_PAYMENT\"",
|
|
2752
|
+
"tags": [],
|
|
2753
|
+
"docs": "Subscribers pay up front for a specified period"
|
|
2754
|
+
},
|
|
2755
|
+
{
|
|
2756
|
+
"name": "DISCOUNTED_RECURRING_PAYMENT",
|
|
2757
|
+
"value": "\"DISCOUNTED_RECURRING_PAYMENT\"",
|
|
2758
|
+
"tags": [],
|
|
2759
|
+
"docs": "Subscribers pay a discounted amount for a specified number of periods"
|
|
2760
|
+
}
|
|
2761
|
+
]
|
|
2762
|
+
},
|
|
2763
|
+
{
|
|
2764
|
+
"name": "PRORATION_MODE",
|
|
2765
|
+
"slug": "proration_mode",
|
|
2766
|
+
"members": [
|
|
2767
|
+
{
|
|
2768
|
+
"name": "UNKNOWN_SUBSCRIPTION_UPGRADE_DOWNGRADE_POLICY",
|
|
2769
|
+
"value": "0",
|
|
2770
|
+
"tags": [],
|
|
2771
|
+
"docs": ""
|
|
2772
|
+
},
|
|
2773
|
+
{
|
|
2774
|
+
"name": "IMMEDIATE_WITH_TIME_PRORATION",
|
|
2775
|
+
"value": "1",
|
|
2776
|
+
"tags": [],
|
|
2777
|
+
"docs": "Replacement takes effect immediately, and the remaining time will be\nprorated and credited to the user. This is the current default behavior."
|
|
2778
|
+
},
|
|
2779
|
+
{
|
|
2780
|
+
"name": "IMMEDIATE_AND_CHARGE_PRORATED_PRICE",
|
|
2781
|
+
"value": "2",
|
|
2782
|
+
"tags": [],
|
|
2783
|
+
"docs": "Replacement takes effect immediately, and the billing cycle remains the\nsame. The price for the remaining period will be charged. This option is\nonly available for subscription upgrade."
|
|
2784
|
+
},
|
|
2785
|
+
{
|
|
2786
|
+
"name": "IMMEDIATE_WITHOUT_PRORATION",
|
|
2787
|
+
"value": "3",
|
|
2788
|
+
"tags": [],
|
|
2789
|
+
"docs": "Replacement takes effect immediately, and the new price will be charged on\nnext recurrence time. The billing cycle stays the same."
|
|
2790
|
+
},
|
|
2791
|
+
{
|
|
2792
|
+
"name": "DEFERRED",
|
|
2793
|
+
"value": "4",
|
|
2794
|
+
"tags": [],
|
|
2795
|
+
"docs": "Replacement takes effect when the old plan expires, and the new price will\nbe charged at the same time."
|
|
2796
|
+
},
|
|
2797
|
+
{
|
|
2798
|
+
"name": "IMMEDIATE_AND_CHARGE_FULL_PRICE",
|
|
2799
|
+
"value": "5",
|
|
2800
|
+
"tags": [],
|
|
2801
|
+
"docs": "Replacement takes effect immediately, and the user is charged full price\nof new plan and is given a full billing cycle of subscription,\nplus remaining prorated time from the old plan."
|
|
2802
|
+
}
|
|
2803
|
+
]
|
|
2804
|
+
},
|
|
2805
|
+
{
|
|
2806
|
+
"name": "LOG_LEVEL",
|
|
2807
|
+
"slug": "log_level",
|
|
2808
|
+
"members": [
|
|
2809
|
+
{
|
|
2810
|
+
"name": "VERBOSE",
|
|
2811
|
+
"value": "\"VERBOSE\"",
|
|
2812
|
+
"tags": [],
|
|
2813
|
+
"docs": ""
|
|
2814
|
+
},
|
|
2815
|
+
{
|
|
2816
|
+
"name": "DEBUG",
|
|
2817
|
+
"value": "\"DEBUG\"",
|
|
2818
|
+
"tags": [],
|
|
2819
|
+
"docs": ""
|
|
2820
|
+
},
|
|
2821
|
+
{
|
|
2822
|
+
"name": "INFO",
|
|
2823
|
+
"value": "\"INFO\"",
|
|
2824
|
+
"tags": [],
|
|
2825
|
+
"docs": ""
|
|
2826
|
+
},
|
|
2827
|
+
{
|
|
2828
|
+
"name": "WARN",
|
|
2829
|
+
"value": "\"WARN\"",
|
|
2830
|
+
"tags": [],
|
|
2831
|
+
"docs": ""
|
|
2832
|
+
},
|
|
2833
|
+
{
|
|
2834
|
+
"name": "ERROR",
|
|
2835
|
+
"value": "\"ERROR\"",
|
|
2836
|
+
"tags": [],
|
|
2837
|
+
"docs": ""
|
|
2838
|
+
}
|
|
2839
|
+
]
|
|
2840
|
+
},
|
|
2841
|
+
{
|
|
2842
|
+
"name": "INTRO_ELIGIBILITY_STATUS",
|
|
2843
|
+
"slug": "intro_eligibility_status",
|
|
2844
|
+
"members": [
|
|
2845
|
+
{
|
|
2846
|
+
"name": "INTRO_ELIGIBILITY_STATUS_UNKNOWN",
|
|
2847
|
+
"value": "0",
|
|
2848
|
+
"tags": [],
|
|
2849
|
+
"docs": "RevenueCat doesn't have enough information to determine eligibility."
|
|
2850
|
+
},
|
|
2851
|
+
{
|
|
2852
|
+
"name": "INTRO_ELIGIBILITY_STATUS_INELIGIBLE",
|
|
2853
|
+
"value": "1",
|
|
2854
|
+
"tags": [],
|
|
2855
|
+
"docs": "The user is not eligible for a free trial or intro pricing for this product."
|
|
2856
|
+
},
|
|
2857
|
+
{
|
|
2858
|
+
"name": "INTRO_ELIGIBILITY_STATUS_ELIGIBLE",
|
|
2859
|
+
"value": "2",
|
|
2860
|
+
"tags": [],
|
|
2861
|
+
"docs": "The user is eligible for a free trial or intro pricing for this product."
|
|
2862
|
+
},
|
|
2863
|
+
{
|
|
2864
|
+
"name": "INTRO_ELIGIBILITY_STATUS_NO_INTRO_OFFER_EXISTS",
|
|
2865
|
+
"value": "3",
|
|
2866
|
+
"tags": [],
|
|
2867
|
+
"docs": "There is no free trial or intro pricing for this product."
|
|
2868
|
+
}
|
|
2869
|
+
]
|
|
2870
|
+
},
|
|
2871
|
+
{
|
|
2872
|
+
"name": "BILLING_FEATURE",
|
|
2873
|
+
"slug": "billing_feature",
|
|
2874
|
+
"members": [
|
|
2875
|
+
{
|
|
2876
|
+
"name": "SUBSCRIPTIONS",
|
|
2877
|
+
"value": "0",
|
|
2878
|
+
"tags": [],
|
|
2879
|
+
"docs": "Purchase/query for subscriptions."
|
|
2880
|
+
},
|
|
2881
|
+
{
|
|
2882
|
+
"name": "SUBSCRIPTIONS_UPDATE",
|
|
2883
|
+
"value": "1",
|
|
2884
|
+
"tags": [],
|
|
2885
|
+
"docs": "Subscriptions update/replace."
|
|
2886
|
+
},
|
|
2887
|
+
{
|
|
2888
|
+
"name": "IN_APP_ITEMS_ON_VR",
|
|
2889
|
+
"value": "2",
|
|
2890
|
+
"tags": [],
|
|
2891
|
+
"docs": "Purchase/query for in-app items on VR."
|
|
2892
|
+
},
|
|
2893
|
+
{
|
|
2894
|
+
"name": "SUBSCRIPTIONS_ON_VR",
|
|
2895
|
+
"value": "3",
|
|
2896
|
+
"tags": [],
|
|
2897
|
+
"docs": "Purchase/query for subscriptions on VR."
|
|
2898
|
+
},
|
|
2899
|
+
{
|
|
2900
|
+
"name": "PRICE_CHANGE_CONFIRMATION",
|
|
2901
|
+
"value": "4",
|
|
2902
|
+
"tags": [],
|
|
2903
|
+
"docs": "Launch a price change confirmation flow."
|
|
2904
|
+
}
|
|
2905
|
+
]
|
|
2906
|
+
},
|
|
2907
|
+
{
|
|
2908
|
+
"name": "REFUND_REQUEST_STATUS",
|
|
2909
|
+
"slug": "refund_request_status",
|
|
2910
|
+
"members": [
|
|
2911
|
+
{
|
|
2912
|
+
"name": "SUCCESS",
|
|
2913
|
+
"value": "0",
|
|
2914
|
+
"tags": [],
|
|
2915
|
+
"docs": "Apple has received the refund request."
|
|
2916
|
+
},
|
|
2917
|
+
{
|
|
2918
|
+
"name": "USER_CANCELLED",
|
|
2919
|
+
"value": "1",
|
|
2920
|
+
"tags": [],
|
|
2921
|
+
"docs": "User canceled submission of the refund request."
|
|
2922
|
+
},
|
|
2923
|
+
{
|
|
2924
|
+
"name": "ERROR",
|
|
2925
|
+
"value": "2",
|
|
2926
|
+
"tags": [],
|
|
2927
|
+
"docs": "There was an error with the request. See message for more details."
|
|
2928
|
+
}
|
|
2929
|
+
]
|
|
2930
|
+
}
|
|
2931
|
+
],
|
|
2932
|
+
"typeAliases": [
|
|
2933
|
+
{
|
|
2934
|
+
"name": "CustomerInfoUpdateListener",
|
|
2935
|
+
"slug": "customerinfoupdatelistener",
|
|
2936
|
+
"docs": "Listener used on updated customer info",
|
|
2937
|
+
"types": [
|
|
2938
|
+
{
|
|
2939
|
+
"text": "(customerInfo: CustomerInfo): void",
|
|
2940
|
+
"complexTypes": [
|
|
2941
|
+
"CustomerInfo"
|
|
2942
|
+
]
|
|
2943
|
+
}
|
|
2944
|
+
]
|
|
2945
|
+
},
|
|
2946
|
+
{
|
|
2947
|
+
"name": "PurchasesCallbackId",
|
|
2948
|
+
"slug": "purchasescallbackid",
|
|
2949
|
+
"docs": "",
|
|
2950
|
+
"types": [
|
|
2951
|
+
{
|
|
2952
|
+
"text": "string",
|
|
2953
|
+
"complexTypes": []
|
|
2954
|
+
}
|
|
2955
|
+
]
|
|
2956
|
+
},
|
|
2957
|
+
{
|
|
2958
|
+
"name": "MakePurchaseResult",
|
|
2959
|
+
"slug": "makepurchaseresult",
|
|
2960
|
+
"docs": "",
|
|
2961
|
+
"types": [
|
|
2962
|
+
{
|
|
2963
|
+
"text": "{\n productIdentifier: string;\n customerInfo: CustomerInfo;\n}",
|
|
2964
|
+
"complexTypes": [
|
|
2965
|
+
"CustomerInfo"
|
|
2966
|
+
]
|
|
2967
|
+
}
|
|
2968
|
+
]
|
|
2969
|
+
},
|
|
2970
|
+
{
|
|
2971
|
+
"name": "LogHandler",
|
|
2972
|
+
"slug": "loghandler",
|
|
2973
|
+
"docs": "",
|
|
2974
|
+
"types": [
|
|
2975
|
+
{
|
|
2976
|
+
"text": "(logLevel: LOG_LEVEL, message: string): void",
|
|
2977
|
+
"complexTypes": [
|
|
2978
|
+
"LOG_LEVEL"
|
|
2979
|
+
]
|
|
2980
|
+
}
|
|
2981
|
+
]
|
|
2982
|
+
}
|
|
2983
|
+
],
|
|
2984
|
+
"pluginConfigs": []
|
|
2985
|
+
}
|