@gofynd/fdk-client-javascript 1.0.2 → 1.0.3

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.
Files changed (310) hide show
  1. package/documentation/application/CART.md +5934 -4502
  2. package/documentation/application/CATALOG.md +6338 -7245
  3. package/documentation/application/COMMON.md +95 -222
  4. package/documentation/application/COMMUNICATION.md +106 -186
  5. package/documentation/application/CONFIGURATION.md +903 -1597
  6. package/documentation/application/CONTENT.md +557 -1279
  7. package/documentation/application/FILESTORAGE.md +84 -220
  8. package/documentation/application/LEAD.md +314 -660
  9. package/documentation/application/LOGISTIC.md +229 -305
  10. package/documentation/application/ORDER.md +642 -1137
  11. package/documentation/application/PAYMENT.md +2285 -3031
  12. package/documentation/application/POSCART.md +6079 -4642
  13. package/documentation/application/REWARDS.md +94 -248
  14. package/documentation/application/SHARE.md +152 -250
  15. package/documentation/application/THEME.md +952 -1235
  16. package/documentation/application/USER.md +1228 -1765
  17. package/documentation/platform/ANALYTICS.md +207 -349
  18. package/documentation/platform/AUDITTRAIL.md +121 -204
  19. package/documentation/platform/BILLING.md +865 -1376
  20. package/documentation/platform/CART.md +2814 -3662
  21. package/documentation/platform/CATALOG.md +14453 -17192
  22. package/documentation/platform/COMMON.md +95 -222
  23. package/documentation/platform/COMMUNICATION.md +1632 -2380
  24. package/documentation/platform/COMPANYPROFILE.md +572 -957
  25. package/documentation/platform/CONFIGURATION.md +3050 -4073
  26. package/documentation/platform/CONTENT.md +3438 -4172
  27. package/documentation/platform/DISCOUNT.md +140 -236
  28. package/documentation/platform/FILESTORAGE.md +187 -323
  29. package/documentation/platform/INVENTORY.md +268 -911
  30. package/documentation/platform/LEAD.md +2195 -2541
  31. package/documentation/platform/ORDER.md +3400 -5361
  32. package/documentation/platform/PARTNER.md +9 -36
  33. package/documentation/platform/PAYMENT.md +903 -1213
  34. package/documentation/platform/REWARDS.md +183 -347
  35. package/documentation/platform/SHARE.md +120 -213
  36. package/documentation/platform/THEME.md +12956 -13239
  37. package/documentation/platform/USER.md +975 -1120
  38. package/documentation/platform/WEBHOOK.md +78 -184
  39. package/documentation/public/CONFIGURATION.md +95 -222
  40. package/documentation/public/INVENTORY.md +100 -282
  41. package/documentation/public/WEBHOOK.md +27 -133
  42. package/package.json +1 -1
  43. package/sdk/application/Cart/CartApplicationClient.d.ts +243 -243
  44. package/sdk/application/Cart/CartApplicationClient.js +567 -567
  45. package/sdk/application/Cart/CartApplicationModel.d.ts +64 -63
  46. package/sdk/application/Cart/CartApplicationModel.js +489 -886
  47. package/sdk/application/Cart/CartApplicationValidator.d.ts +17 -17
  48. package/sdk/application/Cart/CartApplicationValidator.js +98 -98
  49. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +358 -358
  50. package/sdk/application/Catalog/CatalogApplicationClient.js +1036 -1036
  51. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
  52. package/sdk/application/Catalog/CatalogApplicationModel.js +677 -1243
  53. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +19 -19
  54. package/sdk/application/Catalog/CatalogApplicationValidator.js +110 -110
  55. package/sdk/application/Common/CommonApplicationClient.d.ts +13 -13
  56. package/sdk/application/Common/CommonApplicationClient.js +38 -38
  57. package/sdk/application/Common/CommonApplicationModel.d.ts +12 -12
  58. package/sdk/application/Common/CommonApplicationModel.js +83 -160
  59. package/sdk/application/Common/CommonApplicationValidator.d.ts +1 -1
  60. package/sdk/application/Common/CommonApplicationValidator.js +6 -6
  61. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +11 -11
  62. package/sdk/application/Communication/CommunicationApplicationClient.js +26 -26
  63. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +6 -6
  64. package/sdk/application/Communication/CommunicationApplicationModel.js +38 -83
  65. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  66. package/sdk/application/Communication/CommunicationApplicationValidator.js +4 -4
  67. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +116 -116
  68. package/sdk/application/Configuration/ConfigurationApplicationClient.js +330 -330
  69. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +85 -85
  70. package/sdk/application/Configuration/ConfigurationApplicationModel.js +480 -851
  71. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +8 -8
  72. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +33 -33
  73. package/sdk/application/Content/ContentApplicationClient.d.ts +67 -67
  74. package/sdk/application/Content/ContentApplicationClient.js +191 -191
  75. package/sdk/application/Content/ContentApplicationModel.d.ts +76 -76
  76. package/sdk/application/Content/ContentApplicationModel.js +467 -884
  77. package/sdk/application/Content/ContentApplicationValidator.d.ts +5 -5
  78. package/sdk/application/Content/ContentApplicationValidator.js +24 -24
  79. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +25 -25
  80. package/sdk/application/FileStorage/FileStorageApplicationClient.js +59 -59
  81. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +13 -13
  82. package/sdk/application/FileStorage/FileStorageApplicationModel.js +86 -169
  83. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  84. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +7 -7
  85. package/sdk/application/Lead/LeadApplicationClient.d.ts +24 -24
  86. package/sdk/application/Lead/LeadApplicationClient.js +100 -100
  87. package/sdk/application/Lead/LeadApplicationModel.d.ts +35 -35
  88. package/sdk/application/Lead/LeadApplicationModel.js +267 -474
  89. package/sdk/application/Lead/LeadApplicationValidator.d.ts +2 -2
  90. package/sdk/application/Lead/LeadApplicationValidator.js +11 -11
  91. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +30 -19
  92. package/sdk/application/Logistic/LogisticApplicationClient.js +110 -43
  93. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +17 -14
  94. package/sdk/application/Logistic/LogisticApplicationModel.js +133 -201
  95. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +3 -2
  96. package/sdk/application/Logistic/LogisticApplicationValidator.js +14 -8
  97. package/sdk/application/Order/OrderApplicationClient.d.ts +85 -85
  98. package/sdk/application/Order/OrderApplicationClient.js +232 -232
  99. package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
  100. package/sdk/application/Order/OrderApplicationModel.js +352 -656
  101. package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -7
  102. package/sdk/application/Order/OrderApplicationValidator.js +28 -28
  103. package/sdk/application/Payment/PaymentApplicationClient.d.ts +318 -318
  104. package/sdk/application/Payment/PaymentApplicationClient.js +739 -739
  105. package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
  106. package/sdk/application/Payment/PaymentApplicationModel.js +570 -1038
  107. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +28 -28
  108. package/sdk/application/Payment/PaymentApplicationValidator.js +107 -107
  109. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +254 -254
  110. package/sdk/application/PosCart/PosCartApplicationClient.js +617 -617
  111. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +64 -63
  112. package/sdk/application/PosCart/PosCartApplicationModel.js +475 -871
  113. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +18 -18
  114. package/sdk/application/PosCart/PosCartApplicationValidator.js +103 -103
  115. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +27 -27
  116. package/sdk/application/Rewards/RewardsApplicationClient.js +112 -112
  117. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +14 -14
  118. package/sdk/application/Rewards/RewardsApplicationModel.js +96 -191
  119. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +3 -3
  120. package/sdk/application/Rewards/RewardsApplicationValidator.js +12 -12
  121. package/sdk/application/Share/ShareApplicationClient.d.ts +37 -37
  122. package/sdk/application/Share/ShareApplicationClient.js +84 -84
  123. package/sdk/application/Share/ShareApplicationModel.d.ts +8 -8
  124. package/sdk/application/Share/ShareApplicationModel.js +63 -123
  125. package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -4
  126. package/sdk/application/Share/ShareApplicationValidator.js +12 -12
  127. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  128. package/sdk/application/Theme/ThemeApplicationClient.js +31 -31
  129. package/sdk/application/Theme/ThemeApplicationModel.d.ts +34 -34
  130. package/sdk/application/Theme/ThemeApplicationModel.js +190 -336
  131. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +1 -1
  132. package/sdk/application/Theme/ThemeApplicationValidator.js +4 -4
  133. package/sdk/application/User/UserApplicationClient.d.ts +280 -280
  134. package/sdk/application/User/UserApplicationClient.js +581 -581
  135. package/sdk/application/User/UserApplicationModel.d.ts +79 -72
  136. package/sdk/application/User/UserApplicationModel.js +440 -689
  137. package/sdk/application/User/UserApplicationValidator.d.ts +24 -24
  138. package/sdk/application/User/UserApplicationValidator.js +89 -89
  139. package/sdk/common/AxiosHelper.js +1 -1
  140. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +51 -51
  141. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +179 -179
  142. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
  143. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +20 -20
  144. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
  145. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
  146. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +10 -10
  147. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +41 -41
  148. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +10 -10
  149. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +50 -89
  150. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  151. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +6 -6
  152. package/sdk/platform/Billing/BillingPlatformClient.d.ts +60 -60
  153. package/sdk/platform/Billing/BillingPlatformClient.js +181 -181
  154. package/sdk/platform/Billing/BillingPlatformModel.d.ts +40 -40
  155. package/sdk/platform/Billing/BillingPlatformModel.js +342 -668
  156. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +8 -8
  157. package/sdk/platform/Billing/BillingPlatformValidator.js +25 -25
  158. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +168 -168
  159. package/sdk/platform/Cart/CartPlatformApplicationClient.js +553 -553
  160. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -11
  161. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +63 -63
  162. package/sdk/platform/Cart/CartPlatformModel.d.ts +84 -83
  163. package/sdk/platform/Cart/CartPlatformModel.js +671 -1205
  164. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +632 -632
  165. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1525 -1525
  166. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
  167. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +174 -174
  168. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +682 -682
  169. package/sdk/platform/Catalog/CatalogPlatformClient.js +1557 -1557
  170. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +291 -291
  171. package/sdk/platform/Catalog/CatalogPlatformModel.js +2127 -3904
  172. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -66
  173. package/sdk/platform/Catalog/CatalogPlatformValidator.js +229 -229
  174. package/sdk/platform/Common/CommonPlatformClient.d.ts +12 -12
  175. package/sdk/platform/Common/CommonPlatformClient.js +41 -41
  176. package/sdk/platform/Common/CommonPlatformModel.d.ts +12 -12
  177. package/sdk/platform/Common/CommonPlatformModel.js +83 -160
  178. package/sdk/platform/Common/CommonPlatformValidator.d.ts +1 -1
  179. package/sdk/platform/Common/CommonPlatformValidator.js +6 -6
  180. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +326 -326
  181. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +943 -943
  182. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
  183. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +87 -87
  184. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
  185. package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
  186. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +55 -55
  187. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +212 -212
  188. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +27 -27
  189. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +279 -542
  190. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
  191. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +24 -24
  192. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +163 -153
  193. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +615 -552
  194. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
  195. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +69 -63
  196. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +125 -125
  197. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +342 -342
  198. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +148 -146
  199. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +854 -1508
  200. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -9
  201. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +38 -38
  202. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +534 -534
  203. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1324 -1324
  204. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +50 -50
  205. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +156 -156
  206. package/sdk/platform/Content/ContentPlatformModel.d.ts +78 -78
  207. package/sdk/platform/Content/ContentPlatformModel.js +484 -907
  208. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +65 -65
  209. package/sdk/platform/Discount/DiscountPlatformClient.js +216 -216
  210. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +7 -7
  211. package/sdk/platform/Discount/DiscountPlatformModel.js +60 -121
  212. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +6 -6
  213. package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -29
  214. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +24 -24
  215. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +58 -58
  216. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  217. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +8 -8
  218. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +52 -52
  219. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +123 -123
  220. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -13
  221. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +86 -169
  222. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +3 -3
  223. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -11
  224. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +63 -63
  225. package/sdk/platform/Inventory/InventoryPlatformClient.js +228 -228
  226. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +30 -30
  227. package/sdk/platform/Inventory/InventoryPlatformModel.js +497 -964
  228. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +7 -7
  229. package/sdk/platform/Inventory/InventoryPlatformValidator.js +28 -28
  230. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +73 -73
  231. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +200 -200
  232. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
  233. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +28 -28
  234. package/sdk/platform/Lead/LeadPlatformClient.d.ts +80 -80
  235. package/sdk/platform/Lead/LeadPlatformClient.js +212 -212
  236. package/sdk/platform/Lead/LeadPlatformModel.d.ts +35 -35
  237. package/sdk/platform/Lead/LeadPlatformModel.js +267 -474
  238. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +6 -6
  239. package/sdk/platform/Lead/LeadPlatformValidator.js +24 -24
  240. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
  241. package/sdk/platform/Order/OrderPlatformApplicationClient.js +65 -65
  242. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
  243. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +6 -6
  244. package/sdk/platform/Order/OrderPlatformClient.d.ts +357 -357
  245. package/sdk/platform/Order/OrderPlatformClient.js +1035 -1035
  246. package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -196
  247. package/sdk/platform/Order/OrderPlatformModel.js +1574 -2861
  248. package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
  249. package/sdk/platform/Order/OrderPlatformValidator.js +160 -160
  250. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -1
  251. package/sdk/platform/Partner/PartnerPlatformModel.js +10 -26
  252. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +57 -57
  253. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +167 -167
  254. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
  255. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +23 -23
  256. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +42 -42
  257. package/sdk/platform/Payment/PaymentPlatformClient.js +153 -153
  258. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
  259. package/sdk/platform/Payment/PaymentPlatformModel.js +222 -410
  260. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
  261. package/sdk/platform/Payment/PaymentPlatformValidator.js +21 -21
  262. package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10325
  263. package/sdk/platform/PlatformApplicationClient.js +1584 -13899
  264. package/sdk/platform/PlatformClient.d.ts +7965 -7885
  265. package/sdk/platform/PlatformClient.js +8672 -10105
  266. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +83 -83
  267. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +275 -275
  268. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +8 -8
  269. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +34 -34
  270. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +15 -15
  271. package/sdk/platform/Rewards/RewardsPlatformModel.js +92 -194
  272. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
  273. package/sdk/platform/Share/SharePlatformApplicationClient.js +59 -59
  274. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  275. package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -6
  276. package/sdk/platform/Share/SharePlatformModel.d.ts +8 -8
  277. package/sdk/platform/Share/SharePlatformModel.js +60 -118
  278. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +132 -132
  279. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +310 -310
  280. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +15 -15
  281. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +44 -44
  282. package/sdk/platform/Theme/ThemePlatformModel.d.ts +34 -34
  283. package/sdk/platform/Theme/ThemePlatformModel.js +190 -336
  284. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +136 -69
  285. package/sdk/platform/User/UserPlatformApplicationClient.js +505 -166
  286. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +12 -7
  287. package/sdk/platform/User/UserPlatformApplicationValidator.js +61 -23
  288. package/sdk/platform/User/UserPlatformModel.d.ts +79 -72
  289. package/sdk/platform/User/UserPlatformModel.js +440 -689
  290. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +31 -31
  291. package/sdk/platform/Webhook/WebhookPlatformClient.js +88 -88
  292. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +7 -7
  293. package/sdk/platform/Webhook/WebhookPlatformModel.js +68 -136
  294. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +3 -3
  295. package/sdk/platform/Webhook/WebhookPlatformValidator.js +14 -14
  296. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +13 -13
  297. package/sdk/public/Configuration/ConfigurationPublicClient.js +38 -38
  298. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +12 -12
  299. package/sdk/public/Configuration/ConfigurationPublicModel.js +85 -162
  300. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -1
  301. package/sdk/public/Configuration/ConfigurationPublicValidator.js +6 -6
  302. package/sdk/public/Inventory/InventoryPublicClient.d.ts +34 -34
  303. package/sdk/public/Inventory/InventoryPublicClient.js +113 -113
  304. package/sdk/public/Inventory/InventoryPublicModel.d.ts +10 -10
  305. package/sdk/public/Inventory/InventoryPublicModel.js +119 -245
  306. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +3 -3
  307. package/sdk/public/Inventory/InventoryPublicValidator.js +15 -15
  308. package/sdk/public/Webhook/WebhookPublicModel.d.ts +7 -7
  309. package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
  310. package/tests/application/catalog.spec.js +7 -0
@@ -8,18 +8,18 @@
8
8
  ## Billing Methods
9
9
  Handle platform subscription
10
10
 
11
+ * [activateSubscriptionPlan](#activatesubscriptionplan)
12
+ * [cancelSubscriptionCharge](#cancelsubscriptioncharge)
13
+ * [cancelSubscriptionPlan](#cancelsubscriptionplan)
11
14
  * [checkCouponValidity](#checkcouponvalidity)
12
15
  * [createSubscriptionCharge](#createsubscriptioncharge)
13
- * [getSubscriptionCharge](#getsubscriptioncharge)
14
- * [cancelSubscriptionCharge](#cancelsubscriptioncharge)
15
- * [getInvoices](#getinvoices)
16
- * [getInvoiceById](#getinvoicebyid)
17
16
  * [getCustomerDetail](#getcustomerdetail)
18
- * [upsertCustomerDetail](#upsertcustomerdetail)
19
- * [getSubscription](#getsubscription)
20
17
  * [getFeatureLimitConfig](#getfeaturelimitconfig)
21
- * [activateSubscriptionPlan](#activatesubscriptionplan)
22
- * [cancelSubscriptionPlan](#cancelsubscriptionplan)
18
+ * [getInvoiceById](#getinvoicebyid)
19
+ * [getInvoices](#getinvoices)
20
+ * [getSubscription](#getsubscription)
21
+ * [getSubscriptionCharge](#getsubscriptioncharge)
22
+ * [upsertCustomerDetail](#upsertcustomerdetail)
23
23
 
24
24
 
25
25
 
@@ -28,19 +28,17 @@ Handle platform subscription
28
28
 
29
29
 
30
30
 
31
- ### checkCouponValidity
32
- Check coupon validity
31
+ ### activateSubscriptionPlan
32
+ Activate subscription
33
33
 
34
34
 
35
35
 
36
36
  ```javascript
37
37
  // Promise
38
- const promise = client.billing.checkCouponValidity({ plan : value,
39
- couponCode : value });
38
+ const promise = client.billing.activateSubscriptionPlan({ body : value });
40
39
 
41
40
  // Async/Await
42
- const data = await client.billing.checkCouponValidity({ plan : value,
43
- couponCode : value });
41
+ const data = await client.billing.activateSubscriptionPlan({ body : value });
44
42
  ```
45
43
 
46
44
 
@@ -48,20 +46,18 @@ const data = await client.billing.checkCouponValidity({ plan : value,
48
46
 
49
47
 
50
48
  | Argument | Type | Required | Description |
51
- | --------- | ----- | -------- | ----------- |
52
- | plan | string | yes | ID of the plan. |
53
- | couponCode | string | yes | Coupon code. |
54
-
49
+ | --------- | ----- | -------- | ----------- |
50
+ | body | [SubscriptionActivateReq](#SubscriptionActivateReq) | yes | Request body |
55
51
 
56
52
 
57
- Check coupon validity.
53
+ It will activate subscription plan for customer
58
54
 
59
55
  *Returned Response:*
60
56
 
61
57
 
62
58
 
63
59
 
64
- [CheckValidityResponse](#CheckValidityResponse)
60
+ [SubscriptionActivateRes](#SubscriptionActivateRes)
65
61
 
66
62
  Success
67
63
 
@@ -69,13 +65,69 @@ Success
69
65
 
70
66
 
71
67
  <details>
72
- <summary><i>&nbsp; Example:</i></summary>
68
+ <summary><i>&nbsp; Examples:</i></summary>
73
69
 
74
- ```json
75
70
 
71
+ <details>
72
+ <summary><i>&nbsp; default</i></summary>
73
+
74
+ ```json
75
+ {
76
+ "value": {
77
+ "success": true,
78
+ "data": {
79
+ "pause_collection": {},
80
+ "trial": {},
81
+ "invoice_settings": {
82
+ "generation": true,
83
+ "charging": true
84
+ },
85
+ "is_active": true,
86
+ "cancel_at_period_end": false,
87
+ "_id": "601b8e4a32d3e837ec662f5c",
88
+ "subscriber_id": "5ef5f810961ddf004c1457ac",
89
+ "plan_id": "5f3a8786c90d780037723a12",
90
+ "product_suite_id": "5f3a8786c90d7800377239f3",
91
+ "plan_data": {
92
+ "recurring": {
93
+ "interval": "month",
94
+ "interval_count": 1
95
+ },
96
+ "is_trial_plan": false,
97
+ "plan_group": "default",
98
+ "tag_lines": [],
99
+ "currency": "INR",
100
+ "is_active": true,
101
+ "is_visible": true,
102
+ "trial_period": 0,
103
+ "addons": [],
104
+ "tags": [],
105
+ "type": "public",
106
+ "country": "IN",
107
+ "_id": "5f3a8786c90d780037723a12",
108
+ "name": "Standard",
109
+ "description": "Standard",
110
+ "amount": 999,
111
+ "product_suite_id": "5f3a8786c90d7800377239f3",
112
+ "created_at": "2020-08-17T13:35:02.547Z",
113
+ "modified_at": "2020-08-17T13:35:02.547Z"
114
+ },
115
+ "current_period": {
116
+ "start": "2021-02-04T06:03:54.567Z",
117
+ "end": "2021-03-04T06:03:54.567Z"
118
+ },
119
+ "current_status": "active",
120
+ "collection_method": "charge_automatically",
121
+ "created_at": "2021-02-04T06:03:54.580Z",
122
+ "modified_at": "2021-02-04T06:03:54.580Z"
123
+ }
124
+ }
125
+ }
76
126
  ```
77
127
  </details>
78
128
 
129
+ </details>
130
+
79
131
 
80
132
 
81
133
 
@@ -87,19 +139,19 @@ Success
87
139
  ---
88
140
 
89
141
 
90
- ### createSubscriptionCharge
91
- Create subscription charge
142
+ ### cancelSubscriptionCharge
143
+ Cancel subscription charge
92
144
 
93
145
 
94
146
 
95
147
  ```javascript
96
148
  // Promise
97
- const promise = client.billing.createSubscriptionCharge({ extensionId : value,
98
- body : value });
149
+ const promise = client.billing.cancelSubscriptionCharge({ extensionId : value,
150
+ subscriptionId : value });
99
151
 
100
152
  // Async/Await
101
- const data = await client.billing.createSubscriptionCharge({ extensionId : value,
102
- body : value });
153
+ const data = await client.billing.cancelSubscriptionCharge({ extensionId : value,
154
+ subscriptionId : value });
103
155
  ```
104
156
 
105
157
 
@@ -108,18 +160,19 @@ const data = await client.billing.createSubscriptionCharge({ extensionId : valu
108
160
 
109
161
  | Argument | Type | Required | Description |
110
162
  | --------- | ----- | -------- | ----------- |
111
- | extensionId | string | yes | Extension _id |
112
- | body | [CreateSubscriptionCharge](#CreateSubscriptionCharge) | yes | Request body |
163
+ | extensionId | string | yes | Extension _id |
164
+ | subscriptionId | string | yes | Subscription charge _id |
113
165
 
114
166
 
115
- Register subscription charge for a seller of your extension.
167
+
168
+ Cancel subscription and attached charges.
116
169
 
117
170
  *Returned Response:*
118
171
 
119
172
 
120
173
 
121
174
 
122
- [CreateSubscriptionResponse](#CreateSubscriptionResponse)
175
+ [EntitySubscription](#EntitySubscription)
123
176
 
124
177
  Success
125
178
 
@@ -145,19 +198,17 @@ Success
145
198
  ---
146
199
 
147
200
 
148
- ### getSubscriptionCharge
149
- Get subscription charge details
201
+ ### cancelSubscriptionPlan
202
+ Cancel subscription
150
203
 
151
204
 
152
205
 
153
206
  ```javascript
154
207
  // Promise
155
- const promise = client.billing.getSubscriptionCharge({ extensionId : value,
156
- subscriptionId : value });
208
+ const promise = client.billing.cancelSubscriptionPlan({ body : value });
157
209
 
158
210
  // Async/Await
159
- const data = await client.billing.getSubscriptionCharge({ extensionId : value,
160
- subscriptionId : value });
211
+ const data = await client.billing.cancelSubscriptionPlan({ body : value });
161
212
  ```
162
213
 
163
214
 
@@ -165,20 +216,18 @@ const data = await client.billing.getSubscriptionCharge({ extensionId : value,
165
216
 
166
217
 
167
218
  | Argument | Type | Required | Description |
168
- | --------- | ----- | -------- | ----------- |
169
- | extensionId | string | yes | Extension _id |
170
- | subscriptionId | string | yes | Subscription charge _id |
171
-
219
+ | --------- | ----- | -------- | ----------- |
220
+ | body | [CancelSubscriptionReq](#CancelSubscriptionReq) | yes | Request body |
172
221
 
173
222
 
174
- Get created subscription charge details
223
+ It will cancel current active subscription.
175
224
 
176
225
  *Returned Response:*
177
226
 
178
227
 
179
228
 
180
229
 
181
- [EntitySubscription](#EntitySubscription)
230
+ [CancelSubscriptionRes](#CancelSubscriptionRes)
182
231
 
183
232
  Success
184
233
 
@@ -186,13 +235,71 @@ Success
186
235
 
187
236
 
188
237
  <details>
189
- <summary><i>&nbsp; Example:</i></summary>
238
+ <summary><i>&nbsp; Examples:</i></summary>
190
239
 
191
- ```json
192
240
 
241
+ <details>
242
+ <summary><i>&nbsp; default</i></summary>
243
+
244
+ ```json
245
+ {
246
+ "value": {
247
+ "success": true,
248
+ "data": {
249
+ "current_period": {
250
+ "start": "2021-02-04T06:03:54.567Z",
251
+ "end": "2021-03-04T06:03:54.567Z"
252
+ },
253
+ "pause_collection": {},
254
+ "trial": {},
255
+ "invoice_settings": {
256
+ "generation": true,
257
+ "charging": true
258
+ },
259
+ "is_active": false,
260
+ "cancel_at_period_end": false,
261
+ "_id": "601b8e4a32d3e837ec662f5c",
262
+ "subscriber_id": "5ef5f810961ddf004c1457ac",
263
+ "plan_id": "5f3a8786c90d780037723a12",
264
+ "product_suite_id": "5f3a8786c90d7800377239f3",
265
+ "plan_data": {
266
+ "recurring": {
267
+ "interval": "month",
268
+ "interval_count": 1
269
+ },
270
+ "is_trial_plan": false,
271
+ "plan_group": "default",
272
+ "tag_lines": [],
273
+ "currency": "INR",
274
+ "is_active": true,
275
+ "is_visible": true,
276
+ "trial_period": 0,
277
+ "addons": [],
278
+ "tags": [],
279
+ "type": "public",
280
+ "country": "IN",
281
+ "_id": "5f3a8786c90d780037723a12",
282
+ "name": "Standard",
283
+ "description": "Standard",
284
+ "amount": 999,
285
+ "product_suite_id": "5f3a8786c90d7800377239f3",
286
+ "created_at": "2020-08-17T13:35:02.547Z",
287
+ "modified_at": "2020-08-17T13:35:02.547Z"
288
+ },
289
+ "current_status": "canceled",
290
+ "collection_method": "charge_automatically",
291
+ "created_at": "2021-02-04T06:03:54.580Z",
292
+ "modified_at": "2021-02-04T08:52:25.806Z",
293
+ "cancel_at": "2021-02-04T08:52:25.802Z",
294
+ "canceled_at": "2021-02-04T08:52:25.802Z"
295
+ }
296
+ }
297
+ }
193
298
  ```
194
299
  </details>
195
300
 
301
+ </details>
302
+
196
303
 
197
304
 
198
305
 
@@ -204,19 +311,19 @@ Success
204
311
  ---
205
312
 
206
313
 
207
- ### cancelSubscriptionCharge
208
- Cancel subscription charge
314
+ ### checkCouponValidity
315
+ Check coupon validity
209
316
 
210
317
 
211
318
 
212
319
  ```javascript
213
320
  // Promise
214
- const promise = client.billing.cancelSubscriptionCharge({ extensionId : value,
215
- subscriptionId : value });
321
+ const promise = client.billing.checkCouponValidity({ plan : value,
322
+ couponCode : value });
216
323
 
217
324
  // Async/Await
218
- const data = await client.billing.cancelSubscriptionCharge({ extensionId : value,
219
- subscriptionId : value });
325
+ const data = await client.billing.checkCouponValidity({ plan : value,
326
+ couponCode : value });
220
327
  ```
221
328
 
222
329
 
@@ -225,19 +332,19 @@ const data = await client.billing.cancelSubscriptionCharge({ extensionId : valu
225
332
 
226
333
  | Argument | Type | Required | Description |
227
334
  | --------- | ----- | -------- | ----------- |
228
- | extensionId | string | yes | Extension _id |
229
- | subscriptionId | string | yes | Subscription charge _id |
335
+ | plan | string | yes | ID of the plan. |
336
+ | couponCode | string | yes | Coupon code. |
230
337
 
231
338
 
232
339
 
233
- Cancel subscription and attached charges.
340
+ Check coupon validity.
234
341
 
235
342
  *Returned Response:*
236
343
 
237
344
 
238
345
 
239
346
 
240
- [EntitySubscription](#EntitySubscription)
347
+ [CheckValidityResponse](#CheckValidityResponse)
241
348
 
242
349
  Success
243
350
 
@@ -263,32 +370,39 @@ Success
263
370
  ---
264
371
 
265
372
 
266
- ### getInvoices
267
- Get invoices
373
+ ### createSubscriptionCharge
374
+ Create subscription charge
268
375
 
269
376
 
270
377
 
271
378
  ```javascript
272
379
  // Promise
273
- const promise = client.billing.getInvoices();
380
+ const promise = client.billing.createSubscriptionCharge({ extensionId : value,
381
+ body : value });
274
382
 
275
383
  // Async/Await
276
- const data = await client.billing.getInvoices();
384
+ const data = await client.billing.createSubscriptionCharge({ extensionId : value,
385
+ body : value });
277
386
  ```
278
387
 
279
388
 
280
389
 
281
390
 
282
391
 
392
+ | Argument | Type | Required | Description |
393
+ | --------- | ----- | -------- | ----------- |
394
+ | extensionId | string | yes | Extension _id |
395
+ | body | [CreateSubscriptionCharge](#CreateSubscriptionCharge) | yes | Request body |
396
+
283
397
 
284
- Get invoices.
398
+ Register subscription charge for a seller of your extension.
285
399
 
286
400
  *Returned Response:*
287
401
 
288
402
 
289
403
 
290
404
 
291
- [Invoices](#Invoices)
405
+ [CreateSubscriptionResponse](#CreateSubscriptionResponse)
292
406
 
293
407
  Success
294
408
 
@@ -296,252 +410,12 @@ Success
296
410
 
297
411
 
298
412
  <details>
299
- <summary><i>&nbsp; Examples:</i></summary>
413
+ <summary><i>&nbsp; Example:</i></summary>
300
414
 
415
+ ```json
301
416
 
302
- <details>
303
- <summary><i>&nbsp; default</i></summary>
304
-
305
- ```json
306
- {
307
- "value": {
308
- "data": [
309
- {
310
- "_id": "5f7acb709e76da30e3b92cdb",
311
- "client": {
312
- "name": "RELIANCE RETAIL LTD",
313
- "email": "ZAK@GMAIL.COM",
314
- "phone": "91 1234567890",
315
- "address_lines": [
316
- "TV TOWER, Foot Over Bridge Khar",
317
- null,
318
- "Mumbai, 400079, Maharashtra, India"
319
- ]
320
- },
321
- "auto_advance": true,
322
- "currency": "INR",
323
- "paid": true,
324
- "attemp": 3,
325
- "collection_method": "charge_automatically",
326
- "subscriber_id": "5ee773e1351e5e84289ed9cf",
327
- "invoice_url": "",
328
- "number": "FP-1-72020-736",
329
- "pg_data": {},
330
- "period": {
331
- "start": "2020-08-17T13:45:36.722Z",
332
- "end": "2020-09-17T13:45:36.722Z"
333
- },
334
- "receipt_number": "5fd9b08464dc6ac048a08988",
335
- "statement_descriptor": "RELIANCE RETAIL LTD",
336
- "current_status": "paid",
337
- "status_trail": [
338
- {
339
- "_id": "5f7ad29bd562744eab216379",
340
- "value": "draft",
341
- "timestamp": "2020-10-05T08:00:27.753Z"
342
- },
343
- {
344
- "_id": "5fcf40ce1613c029aff417dd",
345
- "value": "open",
346
- "timestamp": "2020-12-08T09:01:02.038Z"
347
- },
348
- {
349
- "_id": "5fd9b08664dc6a1ad0a08989",
350
- "value": "paid",
351
- "timestamp": "2020-12-16T07:00:22.973Z"
352
- }
353
- ],
354
- "subtotal": 15720.08,
355
- "total": 15720.08,
356
- "subscription": "5f3a8a00668947663b7fbd38",
357
- "next_action_time": "2020-10-05T09:00:27.754Z",
358
- "created_at": "2020-10-05T07:29:52.876Z",
359
- "modified_at": "2020-12-16T07:00:22.980Z",
360
- "hash_identifier": "575999aca03e36f0fa54db5235bc7f25",
361
- "payment_method": {
362
- "pg_payment_method_id": null
363
- },
364
- "invoice_items": [
365
- {
366
- "_id": "5f7acb709e76da48b1b92cdd",
367
- "currency": "INR",
368
- "plan": {
369
- "recurring": {
370
- "interval": "month",
371
- "interval_count": 1
372
- },
373
- "is_trial_plan": false,
374
- "plan_group": "default",
375
- "tag_lines": [],
376
- "currency": "INR",
377
- "is_active": true,
378
- "is_visible": true,
379
- "trial_period": 0,
380
- "addons": [],
381
- "tags": [],
382
- "type": "public",
383
- "country": "IN",
384
- "_id": "5f3a8786c90d780037723a14",
385
- "name": "Professional",
386
- "description": "Professional",
387
- "amount": 1499,
388
- "product_suite_id": "5f3a8786c90d7800377239f3",
389
- "created_at": "2020-08-17T13:35:02.802Z",
390
- "modified_at": "2020-08-17T13:35:02.802Z"
391
- },
392
- "name": "Professional",
393
- "quantity": 1,
394
- "description": "Professional",
395
- "period": {
396
- "start": "2020-08-17T13:45:36.722Z",
397
- "end": "2020-10-05T07:29:52.868Z"
398
- },
399
- "unit_amount": 2356.77,
400
- "amount": 2356.77,
401
- "type": "subscription",
402
- "invoice_id": "5f7acb709e76da30e3b92cdb",
403
- "created_at": "2020-10-05T07:29:52.886Z",
404
- "modified_at": "2020-10-05T07:29:52.886Z"
405
- },
406
- {
407
- "_id": "5f7acf199aa6830c4fe5e984",
408
- "currency": "INR",
409
- "plan": {
410
- "recurring": {
411
- "interval": "month",
412
- "interval_count": 1
413
- },
414
- "is_trial_plan": false,
415
- "plan_group": "default",
416
- "tag_lines": [],
417
- "currency": "INR",
418
- "is_active": true,
419
- "is_visible": true,
420
- "trial_period": 0,
421
- "addons": [],
422
- "tags": [
423
- "popular"
424
- ],
425
- "type": "public",
426
- "country": "IN",
427
- "_id": "5f3a8786c90d780037723a13",
428
- "name": "Premium",
429
- "description": "Premium",
430
- "amount": 2499,
431
- "product_suite_id": "5f3a8786c90d7800377239f3",
432
- "created_at": "2020-08-17T13:35:02.547Z",
433
- "modified_at": "2020-08-17T13:35:02.547Z"
434
- },
435
- "name": "Premium",
436
- "quantity": 1,
437
- "description": "Premium",
438
- "period": {
439
- "start": "2020-08-17T13:45:36.722Z",
440
- "end": "2020-10-05T07:45:29.755Z"
441
- },
442
- "unit_amount": 3929.87,
443
- "amount": 3929.87,
444
- "type": "subscription",
445
- "invoice_id": "5f7acb709e76da30e3b92cdb",
446
- "created_at": "2020-10-05T07:45:29.765Z",
447
- "modified_at": "2020-10-05T07:45:29.765Z"
448
- },
449
- {
450
- "_id": "5f7acf7da10a707fc502dcd4",
451
- "currency": "INR",
452
- "plan": {
453
- "recurring": {
454
- "interval": "month",
455
- "interval_count": 1
456
- },
457
- "is_trial_plan": false,
458
- "plan_group": "default",
459
- "tag_lines": [],
460
- "currency": "INR",
461
- "is_active": true,
462
- "is_visible": true,
463
- "trial_period": 0,
464
- "addons": [],
465
- "tags": [],
466
- "type": "public",
467
- "country": "IN",
468
- "_id": "5f3a8786c90d780037723a16",
469
- "name": "Ultra Premium",
470
- "description": "Ultra Premium",
471
- "amount": 2999,
472
- "product_suite_id": "5f3a8786c90d7800377239f3",
473
- "created_at": "2020-08-17T13:35:02.802Z",
474
- "modified_at": "2020-08-17T13:35:02.802Z"
475
- },
476
- "name": "Ultra Premium",
477
- "quantity": 1,
478
- "description": "Ultra Premium",
479
- "period": {
480
- "start": "2020-08-17T13:45:36.722Z",
481
- "end": "2020-10-05T07:47:09.532Z"
482
- },
483
- "unit_amount": 4716.27,
484
- "amount": 4716.27,
485
- "type": "subscription",
486
- "invoice_id": "5f7acb709e76da30e3b92cdb",
487
- "created_at": "2020-10-05T07:47:09.541Z",
488
- "modified_at": "2020-10-05T07:47:09.541Z"
489
- },
490
- {
491
- "_id": "5f7ad29bd56274f23321637a",
492
- "currency": "INR",
493
- "plan": {
494
- "recurring": {
495
- "interval": "month",
496
- "interval_count": 1
497
- },
498
- "is_trial_plan": false,
499
- "plan_group": "default",
500
- "tag_lines": [],
501
- "currency": "INR",
502
- "is_active": true,
503
- "is_visible": true,
504
- "trial_period": 0,
505
- "addons": [],
506
- "tags": [],
507
- "type": "public",
508
- "country": "IN",
509
- "_id": "5f3a8786c90d780037723a16",
510
- "name": "Ultra Premium",
511
- "description": "Ultra Premium",
512
- "amount": 2999,
513
- "product_suite_id": "5f3a8786c90d7800377239f3",
514
- "created_at": "2020-08-17T13:35:02.802Z",
515
- "modified_at": "2020-08-17T13:35:02.802Z"
516
- },
517
- "name": "Ultra Premium",
518
- "quantity": 1,
519
- "description": "Ultra Premium",
520
- "period": {
521
- "start": "2020-08-17T13:45:36.722Z",
522
- "end": "2020-10-05T08:00:27.753Z"
523
- },
524
- "unit_amount": 4717.17,
525
- "amount": 4717.17,
526
- "type": "subscription",
527
- "invoice_id": "5f7acb709e76da30e3b92cdb",
528
- "created_at": "2020-10-05T08:00:27.768Z",
529
- "modified_at": "2020-10-05T08:00:27.768Z"
530
- }
531
- ]
532
- }
533
- ],
534
- "start": 0,
535
- "end": 10,
536
- "limit": 10,
537
- "page": 1,
538
- "total": 1
539
- }
540
- }
541
- ```
542
- </details>
543
-
544
- </details>
417
+ ```
418
+ </details>
545
419
 
546
420
 
547
421
 
@@ -554,37 +428,32 @@ Success
554
428
  ---
555
429
 
556
430
 
557
- ### getInvoiceById
558
- Get invoice by id
431
+ ### getCustomerDetail
432
+ Get subscription customer detail
559
433
 
560
434
 
561
435
 
562
436
  ```javascript
563
437
  // Promise
564
- const promise = client.billing.getInvoiceById({ invoiceId : value });
438
+ const promise = client.billing.getCustomerDetail();
565
439
 
566
440
  // Async/Await
567
- const data = await client.billing.getInvoiceById({ invoiceId : value });
441
+ const data = await client.billing.getCustomerDetail();
568
442
  ```
569
443
 
570
444
 
571
445
 
572
446
 
573
447
 
574
- | Argument | Type | Required | Description |
575
- | --------- | ----- | -------- | ----------- |
576
- | invoiceId | string | yes | Invoice id |
577
-
578
-
579
448
 
580
- Get invoice by id.
449
+ Get subscription customer detail.
581
450
 
582
451
  *Returned Response:*
583
452
 
584
453
 
585
454
 
586
455
 
587
- [Invoice](#Invoice)
456
+ [SubscriptionCustomer](#SubscriptionCustomer)
588
457
 
589
458
  Success
590
459
 
@@ -601,15 +470,190 @@ Success
601
470
  ```json
602
471
  {
603
472
  "value": {
604
- "invoice": {
605
- "period": {
606
- "start": "2020-08-17T13:45:36.722Z",
607
- "end": "2020-09-17T13:45:36.722Z"
608
- },
609
- "client": {
610
- "address_lines": [
611
- "TV TOWER, Foot Over Bridge Khar",
612
- null,
473
+ "phone": {
474
+ "phone_number": "1234567890",
475
+ "phone_country_code": "91"
476
+ },
477
+ "billing_address": {
478
+ "country": "India",
479
+ "state": "Maharastra",
480
+ "city": "Mumbai",
481
+ "line1": "test1",
482
+ "line2": "test2",
483
+ "postal_code": "400059"
484
+ },
485
+ "_id": "5ee773e1351e5e84289ed9cf",
486
+ "unique_id": "1",
487
+ "type": "company",
488
+ "name": "test retail",
489
+ "email": "test@gmail.com",
490
+ "created_at": "2020-06-15T13:13:05.267Z",
491
+ "modified_at": "2021-02-04T00:58:45.356Z",
492
+ "data": {
493
+ "pg_user_exists": true,
494
+ "id": 2
495
+ }
496
+ }
497
+ }
498
+ ```
499
+ </details>
500
+
501
+ </details>
502
+
503
+
504
+
505
+
506
+
507
+
508
+
509
+
510
+
511
+ ---
512
+
513
+
514
+ ### getFeatureLimitConfig
515
+ Get subscription subscription limits
516
+
517
+
518
+
519
+ ```javascript
520
+ // Promise
521
+ const promise = client.billing.getFeatureLimitConfig();
522
+
523
+ // Async/Await
524
+ const data = await client.billing.getFeatureLimitConfig();
525
+ ```
526
+
527
+
528
+
529
+
530
+
531
+
532
+ Get subscription subscription limits.
533
+
534
+ *Returned Response:*
535
+
536
+
537
+
538
+
539
+ [SubscriptionLimit](#SubscriptionLimit)
540
+
541
+ Success
542
+
543
+
544
+
545
+
546
+ <details>
547
+ <summary><i>&nbsp; Examples:</i></summary>
548
+
549
+
550
+ <details>
551
+ <summary><i>&nbsp; default</i></summary>
552
+
553
+ ```json
554
+ {
555
+ "value": {
556
+ "application": {
557
+ "enabled": true,
558
+ "hard_limit": 25,
559
+ "soft_limit": 25
560
+ },
561
+ "marketplace": {
562
+ "enabled": true
563
+ },
564
+ "other_platform": {
565
+ "enabled": true
566
+ },
567
+ "team": {
568
+ "limit": -1
569
+ },
570
+ "products": {
571
+ "bulk": true,
572
+ "limit": -1
573
+ },
574
+ "extensions": {
575
+ "enabled": true,
576
+ "limit": -1
577
+ },
578
+ "integrations": {
579
+ "enabled": true,
580
+ "limit": -1
581
+ },
582
+ "is_trial_plan": false
583
+ }
584
+ }
585
+ ```
586
+ </details>
587
+
588
+ </details>
589
+
590
+
591
+
592
+
593
+
594
+
595
+
596
+
597
+
598
+ ---
599
+
600
+
601
+ ### getInvoiceById
602
+ Get invoice by id
603
+
604
+
605
+
606
+ ```javascript
607
+ // Promise
608
+ const promise = client.billing.getInvoiceById({ invoiceId : value });
609
+
610
+ // Async/Await
611
+ const data = await client.billing.getInvoiceById({ invoiceId : value });
612
+ ```
613
+
614
+
615
+
616
+
617
+
618
+ | Argument | Type | Required | Description |
619
+ | --------- | ----- | -------- | ----------- |
620
+ | invoiceId | string | yes | Invoice id |
621
+
622
+
623
+
624
+ Get invoice by id.
625
+
626
+ *Returned Response:*
627
+
628
+
629
+
630
+
631
+ [Invoice](#Invoice)
632
+
633
+ Success
634
+
635
+
636
+
637
+
638
+ <details>
639
+ <summary><i>&nbsp; Examples:</i></summary>
640
+
641
+
642
+ <details>
643
+ <summary><i>&nbsp; default</i></summary>
644
+
645
+ ```json
646
+ {
647
+ "value": {
648
+ "invoice": {
649
+ "period": {
650
+ "start": "2020-08-17T13:45:36.722Z",
651
+ "end": "2020-09-17T13:45:36.722Z"
652
+ },
653
+ "client": {
654
+ "address_lines": [
655
+ "TV TOWER, Foot Over Bridge Khar",
656
+ null,
613
657
  "Mumbai, 400079, Maharashtra, India"
614
658
  ],
615
659
  "name": "RELIANCE RETAIL LTD",
@@ -843,17 +887,17 @@ Success
843
887
  ---
844
888
 
845
889
 
846
- ### getCustomerDetail
847
- Get subscription customer detail
890
+ ### getInvoices
891
+ Get invoices
848
892
 
849
893
 
850
894
 
851
895
  ```javascript
852
896
  // Promise
853
- const promise = client.billing.getCustomerDetail();
897
+ const promise = client.billing.getInvoices();
854
898
 
855
899
  // Async/Await
856
- const data = await client.billing.getCustomerDetail();
900
+ const data = await client.billing.getInvoices();
857
901
  ```
858
902
 
859
903
 
@@ -861,14 +905,14 @@ const data = await client.billing.getCustomerDetail();
861
905
 
862
906
 
863
907
 
864
- Get subscription customer detail.
908
+ Get invoices.
865
909
 
866
910
  *Returned Response:*
867
911
 
868
912
 
869
913
 
870
914
 
871
- [SubscriptionCustomer](#SubscriptionCustomer)
915
+ [Invoices](#Invoices)
872
916
 
873
917
  Success
874
918
 
@@ -885,116 +929,237 @@ Success
885
929
  ```json
886
930
  {
887
931
  "value": {
888
- "phone": {
889
- "phone_number": "1234567890",
890
- "phone_country_code": "91"
891
- },
892
- "billing_address": {
893
- "country": "India",
894
- "state": "Maharastra",
895
- "city": "Mumbai",
896
- "line1": "test1",
897
- "line2": "test2",
898
- "postal_code": "400059"
899
- },
900
- "_id": "5ee773e1351e5e84289ed9cf",
901
- "unique_id": "1",
902
- "type": "company",
903
- "name": "test retail",
904
- "email": "test@gmail.com",
905
- "created_at": "2020-06-15T13:13:05.267Z",
906
- "modified_at": "2021-02-04T00:58:45.356Z",
907
- "data": {
908
- "pg_user_exists": true,
909
- "id": 2
910
- }
911
- }
912
- }
913
- ```
914
- </details>
915
-
916
- </details>
917
-
918
-
919
-
920
-
921
-
922
-
923
-
924
-
925
-
926
- ---
927
-
928
-
929
- ### upsertCustomerDetail
930
- Upsert subscription customer detail
931
-
932
-
933
-
934
- ```javascript
935
- // Promise
936
- const promise = client.billing.upsertCustomerDetail({ body : value });
937
-
938
- // Async/Await
939
- const data = await client.billing.upsertCustomerDetail({ body : value });
940
- ```
941
-
942
-
943
-
944
-
945
-
946
- | Argument | Type | Required | Description |
947
- | --------- | ----- | -------- | ----------- |
948
- | body | [SubscriptionCustomerCreate](#SubscriptionCustomerCreate) | yes | Request body |
949
-
950
-
951
- Upsert subscription customer detail.
952
-
953
- *Returned Response:*
954
-
955
-
956
-
957
-
958
- [SubscriptionCustomer](#SubscriptionCustomer)
959
-
960
- Success
961
-
962
-
963
-
964
-
965
- <details>
966
- <summary><i>&nbsp; Examples:</i></summary>
967
-
968
-
969
- <details>
970
- <summary><i>&nbsp; default</i></summary>
971
-
972
- ```json
973
- {
974
- "value": {
975
- "phone": {
976
- "phone_number": "1234567890",
977
- "phone_country_code": "91"
978
- },
979
- "billing_address": {
980
- "country": "India",
981
- "state": "Maharastra",
982
- "city": "Mumbai",
983
- "line1": "test1",
984
- "line2": "test2",
985
- "postal_code": "400059"
986
- },
987
- "_id": "5ee773e1351e5e84289ed9cf",
988
- "unique_id": "1",
989
- "type": "company",
990
- "name": "test retail",
991
- "email": "test@gmail.com",
992
- "created_at": "2020-06-15T13:13:05.267Z",
993
- "modified_at": "2021-02-04T00:58:45.356Z",
994
- "data": {
995
- "pg_user_exists": true,
996
- "id": 2
997
- }
932
+ "data": [
933
+ {
934
+ "_id": "5f7acb709e76da30e3b92cdb",
935
+ "client": {
936
+ "name": "RELIANCE RETAIL LTD",
937
+ "email": "ZAK@GMAIL.COM",
938
+ "phone": "91 1234567890",
939
+ "address_lines": [
940
+ "TV TOWER, Foot Over Bridge Khar",
941
+ null,
942
+ "Mumbai, 400079, Maharashtra, India"
943
+ ]
944
+ },
945
+ "auto_advance": true,
946
+ "currency": "INR",
947
+ "paid": true,
948
+ "attemp": 3,
949
+ "collection_method": "charge_automatically",
950
+ "subscriber_id": "5ee773e1351e5e84289ed9cf",
951
+ "invoice_url": "",
952
+ "number": "FP-1-72020-736",
953
+ "pg_data": {},
954
+ "period": {
955
+ "start": "2020-08-17T13:45:36.722Z",
956
+ "end": "2020-09-17T13:45:36.722Z"
957
+ },
958
+ "receipt_number": "5fd9b08464dc6ac048a08988",
959
+ "statement_descriptor": "RELIANCE RETAIL LTD",
960
+ "current_status": "paid",
961
+ "status_trail": [
962
+ {
963
+ "_id": "5f7ad29bd562744eab216379",
964
+ "value": "draft",
965
+ "timestamp": "2020-10-05T08:00:27.753Z"
966
+ },
967
+ {
968
+ "_id": "5fcf40ce1613c029aff417dd",
969
+ "value": "open",
970
+ "timestamp": "2020-12-08T09:01:02.038Z"
971
+ },
972
+ {
973
+ "_id": "5fd9b08664dc6a1ad0a08989",
974
+ "value": "paid",
975
+ "timestamp": "2020-12-16T07:00:22.973Z"
976
+ }
977
+ ],
978
+ "subtotal": 15720.08,
979
+ "total": 15720.08,
980
+ "subscription": "5f3a8a00668947663b7fbd38",
981
+ "next_action_time": "2020-10-05T09:00:27.754Z",
982
+ "created_at": "2020-10-05T07:29:52.876Z",
983
+ "modified_at": "2020-12-16T07:00:22.980Z",
984
+ "hash_identifier": "575999aca03e36f0fa54db5235bc7f25",
985
+ "payment_method": {
986
+ "pg_payment_method_id": null
987
+ },
988
+ "invoice_items": [
989
+ {
990
+ "_id": "5f7acb709e76da48b1b92cdd",
991
+ "currency": "INR",
992
+ "plan": {
993
+ "recurring": {
994
+ "interval": "month",
995
+ "interval_count": 1
996
+ },
997
+ "is_trial_plan": false,
998
+ "plan_group": "default",
999
+ "tag_lines": [],
1000
+ "currency": "INR",
1001
+ "is_active": true,
1002
+ "is_visible": true,
1003
+ "trial_period": 0,
1004
+ "addons": [],
1005
+ "tags": [],
1006
+ "type": "public",
1007
+ "country": "IN",
1008
+ "_id": "5f3a8786c90d780037723a14",
1009
+ "name": "Professional",
1010
+ "description": "Professional",
1011
+ "amount": 1499,
1012
+ "product_suite_id": "5f3a8786c90d7800377239f3",
1013
+ "created_at": "2020-08-17T13:35:02.802Z",
1014
+ "modified_at": "2020-08-17T13:35:02.802Z"
1015
+ },
1016
+ "name": "Professional",
1017
+ "quantity": 1,
1018
+ "description": "Professional",
1019
+ "period": {
1020
+ "start": "2020-08-17T13:45:36.722Z",
1021
+ "end": "2020-10-05T07:29:52.868Z"
1022
+ },
1023
+ "unit_amount": 2356.77,
1024
+ "amount": 2356.77,
1025
+ "type": "subscription",
1026
+ "invoice_id": "5f7acb709e76da30e3b92cdb",
1027
+ "created_at": "2020-10-05T07:29:52.886Z",
1028
+ "modified_at": "2020-10-05T07:29:52.886Z"
1029
+ },
1030
+ {
1031
+ "_id": "5f7acf199aa6830c4fe5e984",
1032
+ "currency": "INR",
1033
+ "plan": {
1034
+ "recurring": {
1035
+ "interval": "month",
1036
+ "interval_count": 1
1037
+ },
1038
+ "is_trial_plan": false,
1039
+ "plan_group": "default",
1040
+ "tag_lines": [],
1041
+ "currency": "INR",
1042
+ "is_active": true,
1043
+ "is_visible": true,
1044
+ "trial_period": 0,
1045
+ "addons": [],
1046
+ "tags": [
1047
+ "popular"
1048
+ ],
1049
+ "type": "public",
1050
+ "country": "IN",
1051
+ "_id": "5f3a8786c90d780037723a13",
1052
+ "name": "Premium",
1053
+ "description": "Premium",
1054
+ "amount": 2499,
1055
+ "product_suite_id": "5f3a8786c90d7800377239f3",
1056
+ "created_at": "2020-08-17T13:35:02.547Z",
1057
+ "modified_at": "2020-08-17T13:35:02.547Z"
1058
+ },
1059
+ "name": "Premium",
1060
+ "quantity": 1,
1061
+ "description": "Premium",
1062
+ "period": {
1063
+ "start": "2020-08-17T13:45:36.722Z",
1064
+ "end": "2020-10-05T07:45:29.755Z"
1065
+ },
1066
+ "unit_amount": 3929.87,
1067
+ "amount": 3929.87,
1068
+ "type": "subscription",
1069
+ "invoice_id": "5f7acb709e76da30e3b92cdb",
1070
+ "created_at": "2020-10-05T07:45:29.765Z",
1071
+ "modified_at": "2020-10-05T07:45:29.765Z"
1072
+ },
1073
+ {
1074
+ "_id": "5f7acf7da10a707fc502dcd4",
1075
+ "currency": "INR",
1076
+ "plan": {
1077
+ "recurring": {
1078
+ "interval": "month",
1079
+ "interval_count": 1
1080
+ },
1081
+ "is_trial_plan": false,
1082
+ "plan_group": "default",
1083
+ "tag_lines": [],
1084
+ "currency": "INR",
1085
+ "is_active": true,
1086
+ "is_visible": true,
1087
+ "trial_period": 0,
1088
+ "addons": [],
1089
+ "tags": [],
1090
+ "type": "public",
1091
+ "country": "IN",
1092
+ "_id": "5f3a8786c90d780037723a16",
1093
+ "name": "Ultra Premium",
1094
+ "description": "Ultra Premium",
1095
+ "amount": 2999,
1096
+ "product_suite_id": "5f3a8786c90d7800377239f3",
1097
+ "created_at": "2020-08-17T13:35:02.802Z",
1098
+ "modified_at": "2020-08-17T13:35:02.802Z"
1099
+ },
1100
+ "name": "Ultra Premium",
1101
+ "quantity": 1,
1102
+ "description": "Ultra Premium",
1103
+ "period": {
1104
+ "start": "2020-08-17T13:45:36.722Z",
1105
+ "end": "2020-10-05T07:47:09.532Z"
1106
+ },
1107
+ "unit_amount": 4716.27,
1108
+ "amount": 4716.27,
1109
+ "type": "subscription",
1110
+ "invoice_id": "5f7acb709e76da30e3b92cdb",
1111
+ "created_at": "2020-10-05T07:47:09.541Z",
1112
+ "modified_at": "2020-10-05T07:47:09.541Z"
1113
+ },
1114
+ {
1115
+ "_id": "5f7ad29bd56274f23321637a",
1116
+ "currency": "INR",
1117
+ "plan": {
1118
+ "recurring": {
1119
+ "interval": "month",
1120
+ "interval_count": 1
1121
+ },
1122
+ "is_trial_plan": false,
1123
+ "plan_group": "default",
1124
+ "tag_lines": [],
1125
+ "currency": "INR",
1126
+ "is_active": true,
1127
+ "is_visible": true,
1128
+ "trial_period": 0,
1129
+ "addons": [],
1130
+ "tags": [],
1131
+ "type": "public",
1132
+ "country": "IN",
1133
+ "_id": "5f3a8786c90d780037723a16",
1134
+ "name": "Ultra Premium",
1135
+ "description": "Ultra Premium",
1136
+ "amount": 2999,
1137
+ "product_suite_id": "5f3a8786c90d7800377239f3",
1138
+ "created_at": "2020-08-17T13:35:02.802Z",
1139
+ "modified_at": "2020-08-17T13:35:02.802Z"
1140
+ },
1141
+ "name": "Ultra Premium",
1142
+ "quantity": 1,
1143
+ "description": "Ultra Premium",
1144
+ "period": {
1145
+ "start": "2020-08-17T13:45:36.722Z",
1146
+ "end": "2020-10-05T08:00:27.753Z"
1147
+ },
1148
+ "unit_amount": 4717.17,
1149
+ "amount": 4717.17,
1150
+ "type": "subscription",
1151
+ "invoice_id": "5f7acb709e76da30e3b92cdb",
1152
+ "created_at": "2020-10-05T08:00:27.768Z",
1153
+ "modified_at": "2020-10-05T08:00:27.768Z"
1154
+ }
1155
+ ]
1156
+ }
1157
+ ],
1158
+ "start": 0,
1159
+ "end": 10,
1160
+ "limit": 10,
1161
+ "page": 1,
1162
+ "total": 1
998
1163
  }
999
1164
  }
1000
1165
  ```
@@ -1031,227 +1196,15 @@ const data = await client.billing.getSubscription();
1031
1196
 
1032
1197
 
1033
1198
 
1034
- If subscription is active then it will return is_enabled true and return subscription object. If subscription is not active then is_enabled false and message.
1035
-
1036
-
1037
- *Returned Response:*
1038
-
1039
-
1040
-
1041
-
1042
- [SubscriptionStatus](#SubscriptionStatus)
1043
-
1044
- Success
1045
-
1046
-
1047
-
1048
-
1049
- <details>
1050
- <summary><i>&nbsp; Examples:</i></summary>
1051
-
1052
-
1053
- <details>
1054
- <summary><i>&nbsp; Active subscription</i></summary>
1055
-
1056
- ```json
1057
- {
1058
- "value": {
1059
- "is_enabled": true,
1060
- "subscription": {
1061
- "current_period": {
1062
- "start": "2020-12-17T13:45:36.722Z",
1063
- "end": "2021-01-17T13:45:36.722Z"
1064
- },
1065
- "pause_collection": {},
1066
- "trial": {},
1067
- "invoice_settings": {
1068
- "generation": true,
1069
- "charging": true
1070
- },
1071
- "is_active": true,
1072
- "cancel_at_period_end": false,
1073
- "_id": "5f3a8a00668947663b7fbd38",
1074
- "subscriber_id": "5ee773e1351e5e84289ed9cf",
1075
- "plan_id": "5f3a8786c90d780037723a12",
1076
- "product_suite_id": "5f3a8786c90d7800377239f3",
1077
- "plan_data": {
1078
- "recurring": {
1079
- "interval": "month",
1080
- "interval_count": 1
1081
- },
1082
- "is_trial_plan": false,
1083
- "plan_group": "default",
1084
- "tag_lines": [],
1085
- "currency": "INR",
1086
- "is_active": true,
1087
- "is_visible": true,
1088
- "trial_period": 0,
1089
- "addons": [],
1090
- "tags": [],
1091
- "type": "public",
1092
- "country": "IN",
1093
- "_id": "5f3a8786c90d780037723a12",
1094
- "name": "Standard",
1095
- "description": "Standard",
1096
- "amount": 999,
1097
- "product_suite_id": "5f3a8786c90d7800377239f3",
1098
- "created_at": "2020-08-17T13:35:02.547Z",
1099
- "modified_at": "2020-08-17T13:35:02.547Z"
1100
- },
1101
- "current_status": "active",
1102
- "collection_method": "charge_automatically",
1103
- "created_at": "2020-08-17T13:45:36.731Z",
1104
- "modified_at": "2020-12-17T11:01:15.960Z",
1105
- "latest_invoice": "5fdb3a7bfc849c2153b944d5"
1106
- }
1107
- }
1108
- }
1109
- ```
1110
- </details>
1111
-
1112
- <details>
1113
- <summary><i>&nbsp; Inactive subscription</i></summary>
1114
-
1115
- ```json
1116
- {
1117
- "value": {
1118
- "is_enabled": true,
1119
- "message": "Subscription not enabled"
1120
- }
1121
- }
1122
- ```
1123
- </details>
1124
-
1125
- </details>
1126
-
1127
-
1128
-
1129
-
1130
-
1131
-
1132
-
1133
-
1134
-
1135
- ---
1136
-
1137
-
1138
- ### getFeatureLimitConfig
1139
- Get subscription subscription limits
1140
-
1141
-
1142
-
1143
- ```javascript
1144
- // Promise
1145
- const promise = client.billing.getFeatureLimitConfig();
1146
-
1147
- // Async/Await
1148
- const data = await client.billing.getFeatureLimitConfig();
1149
- ```
1150
-
1151
-
1152
-
1153
-
1154
-
1155
-
1156
- Get subscription subscription limits.
1157
-
1158
- *Returned Response:*
1159
-
1160
-
1161
-
1162
-
1163
- [SubscriptionLimit](#SubscriptionLimit)
1164
-
1165
- Success
1166
-
1167
-
1168
-
1169
-
1170
- <details>
1171
- <summary><i>&nbsp; Examples:</i></summary>
1172
-
1173
-
1174
- <details>
1175
- <summary><i>&nbsp; default</i></summary>
1176
-
1177
- ```json
1178
- {
1179
- "value": {
1180
- "application": {
1181
- "enabled": true,
1182
- "hard_limit": 25,
1183
- "soft_limit": 25
1184
- },
1185
- "marketplace": {
1186
- "enabled": true
1187
- },
1188
- "other_platform": {
1189
- "enabled": true
1190
- },
1191
- "team": {
1192
- "limit": -1
1193
- },
1194
- "products": {
1195
- "bulk": true,
1196
- "limit": -1
1197
- },
1198
- "extensions": {
1199
- "enabled": true,
1200
- "limit": -1
1201
- },
1202
- "integrations": {
1203
- "enabled": true,
1204
- "limit": -1
1205
- },
1206
- "is_trial_plan": false
1207
- }
1208
- }
1209
- ```
1210
- </details>
1211
-
1212
- </details>
1213
-
1214
-
1215
-
1216
-
1217
-
1218
-
1219
-
1220
-
1221
-
1222
- ---
1223
-
1224
-
1225
- ### activateSubscriptionPlan
1226
- Activate subscription
1227
-
1228
-
1229
-
1230
- ```javascript
1231
- // Promise
1232
- const promise = client.billing.activateSubscriptionPlan({ body : value });
1233
-
1234
- // Async/Await
1235
- const data = await client.billing.activateSubscriptionPlan({ body : value });
1236
- ```
1237
-
1238
-
1239
-
1240
-
1241
-
1242
- | Argument | Type | Required | Description |
1243
- | --------- | ----- | -------- | ----------- |
1244
- | body | [SubscriptionActivateReq](#SubscriptionActivateReq) | yes | Request body |
1245
-
1246
-
1247
- It will activate subscription plan for customer
1199
+ If subscription is active then it will return is_enabled true and return subscription object. If subscription is not active then is_enabled false and message.
1200
+
1248
1201
 
1249
1202
  *Returned Response:*
1250
1203
 
1251
1204
 
1252
1205
 
1253
1206
 
1254
- [SubscriptionActivateRes](#SubscriptionActivateRes)
1207
+ [SubscriptionStatus](#SubscriptionStatus)
1255
1208
 
1256
1209
  Success
1257
1210
 
@@ -1263,13 +1216,17 @@ Success
1263
1216
 
1264
1217
 
1265
1218
  <details>
1266
- <summary><i>&nbsp; default</i></summary>
1219
+ <summary><i>&nbsp; Active subscription</i></summary>
1267
1220
 
1268
1221
  ```json
1269
1222
  {
1270
1223
  "value": {
1271
- "success": true,
1272
- "data": {
1224
+ "is_enabled": true,
1225
+ "subscription": {
1226
+ "current_period": {
1227
+ "start": "2020-12-17T13:45:36.722Z",
1228
+ "end": "2021-01-17T13:45:36.722Z"
1229
+ },
1273
1230
  "pause_collection": {},
1274
1231
  "trial": {},
1275
1232
  "invoice_settings": {
@@ -1278,8 +1235,8 @@ Success
1278
1235
  },
1279
1236
  "is_active": true,
1280
1237
  "cancel_at_period_end": false,
1281
- "_id": "601b8e4a32d3e837ec662f5c",
1282
- "subscriber_id": "5ef5f810961ddf004c1457ac",
1238
+ "_id": "5f3a8a00668947663b7fbd38",
1239
+ "subscriber_id": "5ee773e1351e5e84289ed9cf",
1283
1240
  "plan_id": "5f3a8786c90d780037723a12",
1284
1241
  "product_suite_id": "5f3a8786c90d7800377239f3",
1285
1242
  "plan_data": {
@@ -1306,20 +1263,30 @@ Success
1306
1263
  "created_at": "2020-08-17T13:35:02.547Z",
1307
1264
  "modified_at": "2020-08-17T13:35:02.547Z"
1308
1265
  },
1309
- "current_period": {
1310
- "start": "2021-02-04T06:03:54.567Z",
1311
- "end": "2021-03-04T06:03:54.567Z"
1312
- },
1313
1266
  "current_status": "active",
1314
1267
  "collection_method": "charge_automatically",
1315
- "created_at": "2021-02-04T06:03:54.580Z",
1316
- "modified_at": "2021-02-04T06:03:54.580Z"
1268
+ "created_at": "2020-08-17T13:45:36.731Z",
1269
+ "modified_at": "2020-12-17T11:01:15.960Z",
1270
+ "latest_invoice": "5fdb3a7bfc849c2153b944d5"
1317
1271
  }
1318
1272
  }
1319
1273
  }
1320
1274
  ```
1321
1275
  </details>
1322
1276
 
1277
+ <details>
1278
+ <summary><i>&nbsp; Inactive subscription</i></summary>
1279
+
1280
+ ```json
1281
+ {
1282
+ "value": {
1283
+ "is_enabled": true,
1284
+ "message": "Subscription not enabled"
1285
+ }
1286
+ }
1287
+ ```
1288
+ </details>
1289
+
1323
1290
  </details>
1324
1291
 
1325
1292
 
@@ -1333,17 +1300,76 @@ Success
1333
1300
  ---
1334
1301
 
1335
1302
 
1336
- ### cancelSubscriptionPlan
1337
- Cancel subscription
1303
+ ### getSubscriptionCharge
1304
+ Get subscription charge details
1338
1305
 
1339
1306
 
1340
1307
 
1341
1308
  ```javascript
1342
1309
  // Promise
1343
- const promise = client.billing.cancelSubscriptionPlan({ body : value });
1310
+ const promise = client.billing.getSubscriptionCharge({ extensionId : value,
1311
+ subscriptionId : value });
1344
1312
 
1345
1313
  // Async/Await
1346
- const data = await client.billing.cancelSubscriptionPlan({ body : value });
1314
+ const data = await client.billing.getSubscriptionCharge({ extensionId : value,
1315
+ subscriptionId : value });
1316
+ ```
1317
+
1318
+
1319
+
1320
+
1321
+
1322
+ | Argument | Type | Required | Description |
1323
+ | --------- | ----- | -------- | ----------- |
1324
+ | extensionId | string | yes | Extension _id |
1325
+ | subscriptionId | string | yes | Subscription charge _id |
1326
+
1327
+
1328
+
1329
+ Get created subscription charge details
1330
+
1331
+ *Returned Response:*
1332
+
1333
+
1334
+
1335
+
1336
+ [EntitySubscription](#EntitySubscription)
1337
+
1338
+ Success
1339
+
1340
+
1341
+
1342
+
1343
+ <details>
1344
+ <summary><i>&nbsp; Example:</i></summary>
1345
+
1346
+ ```json
1347
+
1348
+ ```
1349
+ </details>
1350
+
1351
+
1352
+
1353
+
1354
+
1355
+
1356
+
1357
+
1358
+
1359
+ ---
1360
+
1361
+
1362
+ ### upsertCustomerDetail
1363
+ Upsert subscription customer detail
1364
+
1365
+
1366
+
1367
+ ```javascript
1368
+ // Promise
1369
+ const promise = client.billing.upsertCustomerDetail({ body : value });
1370
+
1371
+ // Async/Await
1372
+ const data = await client.billing.upsertCustomerDetail({ body : value });
1347
1373
  ```
1348
1374
 
1349
1375
 
@@ -1352,17 +1378,17 @@ const data = await client.billing.cancelSubscriptionPlan({ body : value });
1352
1378
 
1353
1379
  | Argument | Type | Required | Description |
1354
1380
  | --------- | ----- | -------- | ----------- |
1355
- | body | [CancelSubscriptionReq](#CancelSubscriptionReq) | yes | Request body |
1381
+ | body | [SubscriptionCustomerCreate](#SubscriptionCustomerCreate) | yes | Request body |
1356
1382
 
1357
1383
 
1358
- It will cancel current active subscription.
1384
+ Upsert subscription customer detail.
1359
1385
 
1360
1386
  *Returned Response:*
1361
1387
 
1362
1388
 
1363
1389
 
1364
1390
 
1365
- [CancelSubscriptionRes](#CancelSubscriptionRes)
1391
+ [SubscriptionCustomer](#SubscriptionCustomer)
1366
1392
 
1367
1393
  Success
1368
1394
 
@@ -1379,54 +1405,28 @@ Success
1379
1405
  ```json
1380
1406
  {
1381
1407
  "value": {
1382
- "success": true,
1408
+ "phone": {
1409
+ "phone_number": "1234567890",
1410
+ "phone_country_code": "91"
1411
+ },
1412
+ "billing_address": {
1413
+ "country": "India",
1414
+ "state": "Maharastra",
1415
+ "city": "Mumbai",
1416
+ "line1": "test1",
1417
+ "line2": "test2",
1418
+ "postal_code": "400059"
1419
+ },
1420
+ "_id": "5ee773e1351e5e84289ed9cf",
1421
+ "unique_id": "1",
1422
+ "type": "company",
1423
+ "name": "test retail",
1424
+ "email": "test@gmail.com",
1425
+ "created_at": "2020-06-15T13:13:05.267Z",
1426
+ "modified_at": "2021-02-04T00:58:45.356Z",
1383
1427
  "data": {
1384
- "current_period": {
1385
- "start": "2021-02-04T06:03:54.567Z",
1386
- "end": "2021-03-04T06:03:54.567Z"
1387
- },
1388
- "pause_collection": {},
1389
- "trial": {},
1390
- "invoice_settings": {
1391
- "generation": true,
1392
- "charging": true
1393
- },
1394
- "is_active": false,
1395
- "cancel_at_period_end": false,
1396
- "_id": "601b8e4a32d3e837ec662f5c",
1397
- "subscriber_id": "5ef5f810961ddf004c1457ac",
1398
- "plan_id": "5f3a8786c90d780037723a12",
1399
- "product_suite_id": "5f3a8786c90d7800377239f3",
1400
- "plan_data": {
1401
- "recurring": {
1402
- "interval": "month",
1403
- "interval_count": 1
1404
- },
1405
- "is_trial_plan": false,
1406
- "plan_group": "default",
1407
- "tag_lines": [],
1408
- "currency": "INR",
1409
- "is_active": true,
1410
- "is_visible": true,
1411
- "trial_period": 0,
1412
- "addons": [],
1413
- "tags": [],
1414
- "type": "public",
1415
- "country": "IN",
1416
- "_id": "5f3a8786c90d780037723a12",
1417
- "name": "Standard",
1418
- "description": "Standard",
1419
- "amount": 999,
1420
- "product_suite_id": "5f3a8786c90d7800377239f3",
1421
- "created_at": "2020-08-17T13:35:02.547Z",
1422
- "modified_at": "2020-08-17T13:35:02.547Z"
1423
- },
1424
- "current_status": "canceled",
1425
- "collection_method": "charge_automatically",
1426
- "created_at": "2021-02-04T06:03:54.580Z",
1427
- "modified_at": "2021-02-04T08:52:25.806Z",
1428
- "cancel_at": "2021-02-04T08:52:25.802Z",
1429
- "canceled_at": "2021-02-04T08:52:25.802Z"
1428
+ "pg_user_exists": true,
1429
+ "id": 2
1430
1430
  }
1431
1431
  }
1432
1432
  }
@@ -1449,949 +1449,438 @@ Success
1449
1449
 
1450
1450
  ### Schemas
1451
1451
 
1452
-
1453
-
1454
- #### [Page](#Page)
1452
+
1453
+ #### [BadRequest](#BadRequest)
1455
1454
 
1456
1455
  | Properties | Type | Nullable | Description |
1457
- | ---------- | ---- | -------- | ----------- |
1458
- | item_total | number | no | |
1459
- | next_id | string | no | |
1460
- | has_previous | boolean | no | |
1461
- | has_next | boolean | no | |
1462
- | current | number | no | |
1463
- | type | string | yes | |
1464
- | size | number | no | |
1456
+ | ---------- | ---- | -------- | ----------- || message | string | no | |
1465
1457
 
1466
1458
  ---
1467
1459
 
1468
-
1469
-
1470
-
1471
- #### [UnauthenticatedUser](#UnauthenticatedUser)
1460
+ #### [CancelSubscriptionReq](#CancelSubscriptionReq)
1472
1461
 
1473
1462
  | Properties | Type | Nullable | Description |
1474
- | ---------- | ---- | -------- | ----------- |
1475
- | message | string | no | Failure message. |
1463
+ | ---------- | ---- | -------- | ----------- || product_suite | string | no | || subscription_id | string | no | || type | string | no | || unique_id | string | no | |
1476
1464
 
1477
1465
  ---
1478
1466
 
1479
-
1480
-
1481
-
1482
- #### [UnauthenticatedApplication](#UnauthenticatedApplication)
1467
+ #### [CancelSubscriptionRes](#CancelSubscriptionRes)
1483
1468
 
1484
1469
  | Properties | Type | Nullable | Description |
1485
- | ---------- | ---- | -------- | ----------- |
1486
- | message | string | no | Failure message. |
1470
+ | ---------- | ---- | -------- | ----------- || data | [Subscription](#Subscription) | no | || success | boolean | no | |
1487
1471
 
1488
1472
  ---
1489
1473
 
1490
-
1491
-
1492
-
1493
- #### [BadRequest](#BadRequest)
1474
+ #### [ChargeLineItem](#ChargeLineItem)
1494
1475
 
1495
1476
  | Properties | Type | Nullable | Description |
1496
- | ---------- | ---- | -------- | ----------- |
1497
- | message | string | no | Failure message. |
1477
+ | ---------- | ---- | -------- | ----------- || capped_amount | number | no | || is_test | boolean | no | || metadata | string | no | || name | string | yes | || price | [EntityChargePrice](#EntityChargePrice) | yes | || pricing_type | string | yes | || recurring | [EntityChargeRecurring](#EntityChargeRecurring) | no | || term | string | yes | || trial_days | number | no | |
1498
1478
 
1499
1479
  ---
1500
1480
 
1501
-
1502
-
1503
-
1504
- #### [ResourceNotFound](#ResourceNotFound)
1481
+ #### [CheckValidityResponse](#CheckValidityResponse)
1505
1482
 
1506
1483
  | Properties | Type | Nullable | Description |
1507
- | ---------- | ---- | -------- | ----------- |
1508
- | message | string | no | Resource not found with {id} |
1484
+ | ---------- | ---- | -------- | ----------- || discount_amount | number | no | || is_valid | boolean | no | |
1509
1485
 
1510
1486
  ---
1511
1487
 
1512
-
1513
-
1514
-
1515
- #### [InternalServerError](#InternalServerError)
1488
+ #### [CreateSubscriptionCharge](#CreateSubscriptionCharge)
1516
1489
 
1517
1490
  | Properties | Type | Nullable | Description |
1518
- | ---------- | ---- | -------- | ----------- |
1519
- | message | string | no | Internal server Server error |
1520
- | code | string | no | Error code |
1491
+ | ---------- | ---- | -------- | ----------- || is_test | boolean | no | || line_items | [[ChargeLineItem](#ChargeLineItem)] | yes | || name | string | yes | || return_url | string | yes | || trial_days | number | no | |
1521
1492
 
1522
1493
  ---
1523
1494
 
1524
-
1525
-
1526
-
1527
- #### [CheckValidityResponse](#CheckValidityResponse)
1495
+ #### [CreateSubscriptionResponse](#CreateSubscriptionResponse)
1528
1496
 
1529
1497
  | Properties | Type | Nullable | Description |
1530
- | ---------- | ---- | -------- | ----------- |
1531
- | is_valid | boolean | no | |
1532
- | discount_amount | number | no | |
1498
+ | ---------- | ---- | -------- | ----------- || confirm_url | string | no | || subscription | [EntitySubscription](#EntitySubscription) | no | |
1533
1499
 
1534
1500
  ---
1535
1501
 
1536
-
1537
-
1538
-
1539
- #### [PlanRecurring](#PlanRecurring)
1502
+ #### [CurrentPeriod](#CurrentPeriod)
1540
1503
 
1541
1504
  | Properties | Type | Nullable | Description |
1542
- | ---------- | ---- | -------- | ----------- |
1543
- | interval | string | no | |
1544
- | interval_count | number | no | |
1505
+ | ---------- | ---- | -------- | ----------- || end_date | string | no | || start_date | string | no | |
1545
1506
 
1546
1507
  ---
1547
1508
 
1548
-
1549
-
1550
-
1551
- #### [Plan](#Plan)
1509
+ #### [DetailedPlan](#DetailedPlan)
1552
1510
 
1553
1511
  | Properties | Type | Nullable | Description |
1554
- | ---------- | ---- | -------- | ----------- |
1555
- | recurring | [PlanRecurring](#PlanRecurring) | no | |
1556
- | is_trial_plan | boolean | no | |
1557
- | plan_group | string | no | |
1558
- | tag_lines | [string] | no | |
1559
- | currency | string | no | |
1560
- | is_active | boolean | no | |
1561
- | is_visible | boolean | no | |
1562
- | trial_period | number | no | |
1563
- | addons | [string] | no | |
1564
- | tags | [string] | no | |
1565
- | type | string | no | |
1566
- | country | string | no | |
1567
- | _id | string | no | |
1568
- | name | string | no | |
1569
- | description | string | no | |
1570
- | amount | number | no | |
1571
- | product_suite_id | string | no | |
1572
- | created_at | string | no | |
1573
- | modified_at | string | no | |
1574
-
1575
- ---
1576
-
1577
-
1578
-
1579
-
1580
- #### [DetailedPlanComponents](#DetailedPlanComponents)
1512
+ | ---------- | ---- | -------- | ----------- || _id | string | no | || addons | [string] | no | || amount | number | no | || components | [[DetailedPlanComponents](#DetailedPlanComponents)] | no | || country | string | no | || created_at | string | no | || currency | string | no | || description | string | no | || is_active | boolean | no | || is_trial_plan | boolean | no | || is_visible | boolean | no | || modified_at | string | no | || name | string | no | || plan_group | string | no | || product_suite_id | string | no | || recurring | [PlanRecurring](#PlanRecurring) | no | || tag_lines | [string] | no | || tags | [string] | no | || trial_period | number | no | || type | string | no | |
1513
+
1514
+ ---
1515
+
1516
+ #### [DetailedPlanComponents](#DetailedPlanComponents)
1581
1517
 
1582
1518
  | Properties | Type | Nullable | Description |
1583
- | ---------- | ---- | -------- | ----------- |
1584
- | name | string | no | |
1585
- | slug | string | no | |
1586
- | description | string | no | |
1587
- | group | string | no | |
1588
- | icon | string | no | |
1589
- | links | string | no | |
1590
- | enabled | boolean | no | |
1591
- | display_text | string | no | |
1519
+ | ---------- | ---- | -------- | ----------- || description | string | no | || display_text | string | no | || enabled | boolean | no | || group | string | no | || icon | string | no | || links | string | no | || name | string | no | || slug | string | no | |
1592
1520
 
1593
1521
  ---
1594
1522
 
1595
-
1596
-
1597
-
1598
- #### [DetailedPlan](#DetailedPlan)
1523
+ #### [EntityChargePrice](#EntityChargePrice)
1599
1524
 
1600
1525
  | Properties | Type | Nullable | Description |
1601
- | ---------- | ---- | -------- | ----------- |
1602
- | recurring | [PlanRecurring](#PlanRecurring) | no | |
1603
- | is_trial_plan | boolean | no | |
1604
- | plan_group | string | no | |
1605
- | tag_lines | [string] | no | |
1606
- | currency | string | no | |
1607
- | is_active | boolean | no | |
1608
- | is_visible | boolean | no | |
1609
- | trial_period | number | no | |
1610
- | addons | [string] | no | |
1611
- | tags | [string] | no | |
1612
- | type | string | no | |
1613
- | country | string | no | |
1614
- | _id | string | no | |
1615
- | name | string | no | |
1616
- | description | string | no | |
1617
- | amount | number | no | |
1618
- | product_suite_id | string | no | |
1619
- | created_at | string | no | |
1620
- | modified_at | string | no | |
1621
- | components | [[DetailedPlanComponents](#DetailedPlanComponents)] | no | |
1622
-
1623
- ---
1624
-
1625
-
1626
-
1627
-
1628
- #### [SubscriptionTrialPeriod](#SubscriptionTrialPeriod)
1526
+ | ---------- | ---- | -------- | ----------- || amount | number | yes | || currency_code | string | yes | |
1527
+
1528
+ ---
1529
+
1530
+ #### [EntityChargeRecurring](#EntityChargeRecurring)
1629
1531
 
1630
1532
  | Properties | Type | Nullable | Description |
1631
- | ---------- | ---- | -------- | ----------- |
1632
- | start_date | string | no | |
1633
- | end_date | string | no | |
1533
+ | ---------- | ---- | -------- | ----------- || interval | string | yes | |
1634
1534
 
1635
1535
  ---
1636
1536
 
1637
-
1638
-
1639
-
1640
- #### [EntityChargePrice](#EntityChargePrice)
1537
+ #### [EntitySubscription](#EntitySubscription)
1641
1538
 
1642
1539
  | Properties | Type | Nullable | Description |
1643
- | ---------- | ---- | -------- | ----------- |
1644
- | amount | number | yes | Amount for price. Minimum value 1 |
1645
- | currency_code | string | yes | |
1540
+ | ---------- | ---- | -------- | ----------- || _id | string | no | || activated_on | string | no | || cancelled_on | string | no | || company_id | number | no | || line_items | [[SubscriptionCharge](#SubscriptionCharge)] | no | || metadata | string | no | || name | string | no | || status | string | no | || trial_days | number | no | || trial_period | [SubscriptionTrialPeriod](#SubscriptionTrialPeriod) | no | |
1646
1541
 
1647
1542
  ---
1648
1543
 
1649
-
1650
-
1651
-
1652
- #### [EntityChargeRecurring](#EntityChargeRecurring)
1544
+ #### [InternalServerError](#InternalServerError)
1653
1545
 
1654
1546
  | Properties | Type | Nullable | Description |
1655
- | ---------- | ---- | -------- | ----------- |
1656
- | interval | string | yes | |
1547
+ | ---------- | ---- | -------- | ----------- || code | string | no | || message | string | no | |
1657
1548
 
1658
1549
  ---
1659
1550
 
1660
-
1661
-
1662
-
1663
- #### [ChargeLineItem](#ChargeLineItem)
1551
+ #### [Invoice](#Invoice)
1664
1552
 
1665
1553
  | Properties | Type | Nullable | Description |
1666
- | ---------- | ---- | -------- | ----------- |
1667
- | name | string | yes | |
1668
- | term | string | yes | |
1669
- | pricing_type | string | yes | |
1670
- | price | [EntityChargePrice](#EntityChargePrice) | yes | |
1671
- | recurring | [EntityChargeRecurring](#EntityChargeRecurring) | no | |
1672
- | capped_amount | number | no | |
1673
- | trial_days | number | no | |
1674
- | is_test | boolean | no | |
1675
- | metadata | string | no | |
1554
+ | ---------- | ---- | -------- | ----------- || invoice | [InvoiceDetails](#InvoiceDetails) | no | || invoice_items | [[InvoiceItems](#InvoiceItems)] | no | |
1676
1555
 
1677
1556
  ---
1678
1557
 
1679
-
1680
-
1681
-
1682
- #### [CreateSubscriptionCharge](#CreateSubscriptionCharge)
1558
+ #### [InvoiceDetails](#InvoiceDetails)
1683
1559
 
1684
1560
  | Properties | Type | Nullable | Description |
1685
- | ---------- | ---- | -------- | ----------- |
1686
- | name | string | yes | |
1687
- | trial_days | number | no | |
1688
- | line_items | [[ChargeLineItem](#ChargeLineItem)] | yes | |
1689
- | is_test | boolean | no | |
1690
- | return_url | string | yes | |
1561
+ | ---------- | ---- | -------- | ----------- || _id | string | no | || attemp | number | no | || auto_advance | boolean | no | || client | [InvoiceDetailsClient](#InvoiceDetailsClient) | no | || collection_method | string | no | || created_at | string | no | || currency | string | no | || current_status | string | no | || hash_identifier | string | no | || invoice_url | string | no | || modified_at | string | no | || next_action_time | string | no | || number | string | no | || paid | boolean | no | || payment_method | [InvoicePaymentMethod](#InvoicePaymentMethod) | no | || period | [InvoiceDetailsPeriod](#InvoiceDetailsPeriod) | no | || pg_data | string | no | || receipt_number | string | no | || statement_descriptor | string | no | || status_trail | [[InvoiceDetailsStatusTrail](#InvoiceDetailsStatusTrail)] | no | || subscriber_id | string | no | || subscription | string | no | || subtotal | number | no | || total | number | no | |
1691
1562
 
1692
1563
  ---
1693
1564
 
1694
-
1695
-
1696
-
1697
- #### [CurrentPeriod](#CurrentPeriod)
1565
+ #### [InvoiceDetailsClient](#InvoiceDetailsClient)
1698
1566
 
1699
1567
  | Properties | Type | Nullable | Description |
1700
- | ---------- | ---- | -------- | ----------- |
1701
- | start_date | string | no | |
1702
- | end_date | string | no | |
1568
+ | ---------- | ---- | -------- | ----------- || address_lines | [string] | no | || email | string | no | || name | string | no | || phone | string | no | |
1703
1569
 
1704
1570
  ---
1705
1571
 
1706
-
1707
-
1708
-
1709
- #### [SubscriptionCharge](#SubscriptionCharge)
1572
+ #### [InvoiceDetailsPaymentMethods](#InvoiceDetailsPaymentMethods)
1710
1573
 
1711
1574
  | Properties | Type | Nullable | Description |
1712
- | ---------- | ---- | -------- | ----------- |
1713
- | _id | string | no | |
1714
- | name | string | no | |
1715
- | term | string | no | |
1716
- | pricing_type | string | no | |
1717
- | price | [EntityChargePrice](#EntityChargePrice) | no | |
1718
- | recurring | [EntityChargeRecurring](#EntityChargeRecurring) | no | |
1719
- | capped_amount | number | no | |
1720
- | activated_on | string | no | |
1721
- | cancelled_on | string | no | |
1722
- | billing_date | string | no | |
1723
- | current_period | [CurrentPeriod](#CurrentPeriod) | no | |
1724
- | status | string | no | |
1725
- | is_test | boolean | no | |
1726
- | metadata | string | no | |
1575
+ | ---------- | ---- | -------- | ----------- || data | [InvoiceDetailsPaymentMethodsData](#InvoiceDetailsPaymentMethodsData) | no | || id | number | no | || is_default | boolean | no | || pg_payment_method_id | string | no | || type | string | no | |
1727
1576
 
1728
1577
  ---
1729
1578
 
1730
-
1731
-
1732
-
1733
- #### [EntitySubscription](#EntitySubscription)
1579
+ #### [InvoiceDetailsPaymentMethodsData](#InvoiceDetailsPaymentMethodsData)
1734
1580
 
1735
1581
  | Properties | Type | Nullable | Description |
1736
- | ---------- | ---- | -------- | ----------- |
1737
- | _id | string | no | |
1738
- | name | string | no | |
1739
- | status | string | no | |
1740
- | company_id | number | no | |
1741
- | activated_on | string | no | |
1742
- | cancelled_on | string | no | |
1743
- | trial_days | number | no | |
1744
- | trial_period | [SubscriptionTrialPeriod](#SubscriptionTrialPeriod) | no | |
1745
- | metadata | string | no | |
1746
- | line_items | [[SubscriptionCharge](#SubscriptionCharge)] | no | |
1582
+ | ---------- | ---- | -------- | ----------- || brand | string | no | || checks | [InvoiceDetailsPaymentMethodsDataChecks](#InvoiceDetailsPaymentMethodsDataChecks) | no | || country | string | no | || exp_month | number | no | || exp_year | number | no | || fingerprint | string | no | || funding | string | no | || generated_from | string | no | || last4 | string | no | || networks | [InvoiceDetailsPaymentMethodsDataNetworks](#InvoiceDetailsPaymentMethodsDataNetworks) | no | || three_d_secure_usage | [InvoiceDetailsPaymentMethodsDataThreeDSecureUsage](#InvoiceDetailsPaymentMethodsDataThreeDSecureUsage) | no | || wallet | string | no | |
1747
1583
 
1748
1584
  ---
1749
1585
 
1750
-
1751
-
1752
-
1753
- #### [CreateSubscriptionResponse](#CreateSubscriptionResponse)
1586
+ #### [InvoiceDetailsPaymentMethodsDataChecks](#InvoiceDetailsPaymentMethodsDataChecks)
1754
1587
 
1755
1588
  | Properties | Type | Nullable | Description |
1756
- | ---------- | ---- | -------- | ----------- |
1757
- | subscription | [EntitySubscription](#EntitySubscription) | no | |
1758
- | confirm_url | string | no | |
1589
+ | ---------- | ---- | -------- | ----------- || address_line1_check | string | no | || address_postal_code_check | string | no | || cvc_check | string | no | |
1759
1590
 
1760
1591
  ---
1761
1592
 
1762
-
1763
-
1764
-
1765
- #### [InvoiceDetailsPeriod](#InvoiceDetailsPeriod)
1593
+ #### [InvoiceDetailsPaymentMethodsDataNetworks](#InvoiceDetailsPaymentMethodsDataNetworks)
1766
1594
 
1767
1595
  | Properties | Type | Nullable | Description |
1768
- | ---------- | ---- | -------- | ----------- |
1769
- | start | string | no | |
1770
- | end | string | no | |
1596
+ | ---------- | ---- | -------- | ----------- || available | [string] | no | || preferred | string | no | |
1771
1597
 
1772
1598
  ---
1773
1599
 
1774
-
1775
-
1776
-
1777
- #### [InvoiceDetailsClient](#InvoiceDetailsClient)
1600
+ #### [InvoiceDetailsPaymentMethodsDataThreeDSecureUsage](#InvoiceDetailsPaymentMethodsDataThreeDSecureUsage)
1778
1601
 
1779
1602
  | Properties | Type | Nullable | Description |
1780
- | ---------- | ---- | -------- | ----------- |
1781
- | address_lines | [string] | no | |
1782
- | name | string | no | |
1783
- | email | string | no | |
1784
- | phone | string | no | |
1603
+ | ---------- | ---- | -------- | ----------- || supported | boolean | no | |
1785
1604
 
1786
1605
  ---
1787
1606
 
1788
-
1789
-
1790
-
1791
- #### [InvoiceDetailsStatusTrail](#InvoiceDetailsStatusTrail)
1607
+ #### [InvoiceDetailsPeriod](#InvoiceDetailsPeriod)
1792
1608
 
1793
1609
  | Properties | Type | Nullable | Description |
1794
- | ---------- | ---- | -------- | ----------- |
1795
- | _id | string | no | |
1796
- | value | string | no | |
1797
- | timestamp | string | no | |
1610
+ | ---------- | ---- | -------- | ----------- || end | string | no | || start | string | no | |
1798
1611
 
1799
1612
  ---
1800
1613
 
1801
-
1802
-
1803
-
1804
- #### [InvoiceDetailsPaymentMethodsDataChecks](#InvoiceDetailsPaymentMethodsDataChecks)
1614
+ #### [InvoiceDetailsStatusTrail](#InvoiceDetailsStatusTrail)
1805
1615
 
1806
1616
  | Properties | Type | Nullable | Description |
1807
- | ---------- | ---- | -------- | ----------- |
1808
- | cvc_check | string | no | |
1809
- | address_line1_check | string | no | |
1810
- | address_postal_code_check | string | no | |
1617
+ | ---------- | ---- | -------- | ----------- || _id | string | no | || timestamp | string | no | || value | string | no | |
1811
1618
 
1812
1619
  ---
1813
1620
 
1814
-
1815
-
1816
-
1817
- #### [InvoiceDetailsPaymentMethodsDataNetworks](#InvoiceDetailsPaymentMethodsDataNetworks)
1621
+ #### [InvoiceItems](#InvoiceItems)
1818
1622
 
1819
1623
  | Properties | Type | Nullable | Description |
1820
- | ---------- | ---- | -------- | ----------- |
1821
- | available | [string] | no | |
1822
- | preferred | string | no | |
1624
+ | ---------- | ---- | -------- | ----------- || _id | string | no | || amount | number | no | || created_at | string | no | || currency | string | no | || description | string | no | || invoice_id | string | no | || modified_at | string | no | || name | string | no | || period | [InvoiceItemsPeriod](#InvoiceItemsPeriod) | no | || plan | [InvoiceItemsPlan](#InvoiceItemsPlan) | no | || quantity | number | no | || type | string | no | || unit_amount | number | no | |
1823
1625
 
1824
1626
  ---
1825
1627
 
1826
-
1827
-
1828
-
1829
- #### [InvoiceDetailsPaymentMethodsDataThreeDSecureUsage](#InvoiceDetailsPaymentMethodsDataThreeDSecureUsage)
1628
+ #### [InvoiceItemsPeriod](#InvoiceItemsPeriod)
1830
1629
 
1831
1630
  | Properties | Type | Nullable | Description |
1832
- | ---------- | ---- | -------- | ----------- |
1833
- | supported | boolean | no | |
1631
+ | ---------- | ---- | -------- | ----------- || end | string | no | || start | string | no | |
1834
1632
 
1835
1633
  ---
1836
1634
 
1837
-
1838
-
1839
-
1840
- #### [InvoiceDetailsPaymentMethodsData](#InvoiceDetailsPaymentMethodsData)
1635
+ #### [InvoiceItemsPlan](#InvoiceItemsPlan)
1841
1636
 
1842
1637
  | Properties | Type | Nullable | Description |
1843
- | ---------- | ---- | -------- | ----------- |
1844
- | brand | string | no | |
1845
- | last4 | string | no | |
1846
- | checks | [InvoiceDetailsPaymentMethodsDataChecks](#InvoiceDetailsPaymentMethodsDataChecks) | no | |
1847
- | wallet | string | no | |
1848
- | country | string | no | |
1849
- | funding | string | no | |
1850
- | exp_year | number | no | |
1851
- | networks | [InvoiceDetailsPaymentMethodsDataNetworks](#InvoiceDetailsPaymentMethodsDataNetworks) | no | |
1852
- | exp_month | number | no | |
1853
- | fingerprint | string | no | |
1854
- | generated_from | string | no | |
1855
- | three_d_secure_usage | [InvoiceDetailsPaymentMethodsDataThreeDSecureUsage](#InvoiceDetailsPaymentMethodsDataThreeDSecureUsage) | no | |
1638
+ | ---------- | ---- | -------- | ----------- || _id | string | no | || addons | [string] | no | || amount | number | no | || country | string | no | || created_at | string | no | || currency | string | no | || description | string | no | || is_active | boolean | no | || is_trial_plan | boolean | no | || is_visible | boolean | no | || modified_at | string | no | || name | string | no | || plan_group | string | no | || product_suite_id | string | no | || recurring | [InvoiceItemsPlanRecurring](#InvoiceItemsPlanRecurring) | no | || tag_lines | [string] | no | || tags | [string] | no | || trial_period | number | no | || type | string | no | |
1856
1639
 
1857
1640
  ---
1858
1641
 
1859
-
1860
-
1861
-
1862
- #### [InvoiceDetailsPaymentMethods](#InvoiceDetailsPaymentMethods)
1642
+ #### [InvoiceItemsPlanRecurring](#InvoiceItemsPlanRecurring)
1863
1643
 
1864
1644
  | Properties | Type | Nullable | Description |
1865
- | ---------- | ---- | -------- | ----------- |
1866
- | id | number | no | |
1867
- | type | string | no | |
1868
- | pg_payment_method_id | string | no | |
1869
- | data | [InvoiceDetailsPaymentMethodsData](#InvoiceDetailsPaymentMethodsData) | no | |
1870
- | is_default | boolean | no | |
1645
+ | ---------- | ---- | -------- | ----------- || interval | string | no | || interval_count | number | no | |
1871
1646
 
1872
1647
  ---
1873
1648
 
1874
-
1875
-
1876
-
1877
- #### [InvoicePaymentMethod](#InvoicePaymentMethod)
1649
+ #### [InvoicePaymentMethod](#InvoicePaymentMethod)
1878
1650
 
1879
1651
  | Properties | Type | Nullable | Description |
1880
- | ---------- | ---- | -------- | ----------- |
1881
- | pg_payment_method_id | string | no | |
1652
+ | ---------- | ---- | -------- | ----------- || pg_payment_method_id | string | no | |
1882
1653
 
1883
1654
  ---
1884
1655
 
1885
-
1886
-
1887
-
1888
- #### [InvoiceDetails](#InvoiceDetails)
1656
+ #### [Invoices](#Invoices)
1889
1657
 
1890
1658
  | Properties | Type | Nullable | Description |
1891
- | ---------- | ---- | -------- | ----------- |
1892
- | period | [InvoiceDetailsPeriod](#InvoiceDetailsPeriod) | no | |
1893
- | client | [InvoiceDetailsClient](#InvoiceDetailsClient) | no | |
1894
- | auto_advance | boolean | no | |
1895
- | currency | string | no | |
1896
- | paid | boolean | no | |
1897
- | attemp | number | no | |
1898
- | _id | string | no | |
1899
- | collection_method | string | no | |
1900
- | subscriber_id | string | no | |
1901
- | invoice_url | string | no | |
1902
- | number | string | no | |
1903
- | pg_data | string | no | |
1904
- | receipt_number | string | no | |
1905
- | statement_descriptor | string | no | |
1906
- | current_status | string | no | |
1907
- | status_trail | [[InvoiceDetailsStatusTrail](#InvoiceDetailsStatusTrail)] | no | |
1908
- | subtotal | number | no | |
1909
- | total | number | no | |
1910
- | subscription | string | no | |
1911
- | next_action_time | string | no | |
1912
- | created_at | string | no | |
1913
- | modified_at | string | no | |
1914
- | hash_identifier | string | no | |
1915
- | payment_method | [InvoicePaymentMethod](#InvoicePaymentMethod) | no | |
1916
-
1917
- ---
1918
-
1919
-
1920
-
1921
-
1922
- #### [InvoiceItemsPlanRecurring](#InvoiceItemsPlanRecurring)
1659
+ | ---------- | ---- | -------- | ----------- || data | [[InvoicesData](#InvoicesData)] | no | || end | number | no | || limit | number | no | || page | number | no | || start | number | no | || total | number | no | |
1660
+
1661
+ ---
1662
+
1663
+ #### [InvoicesData](#InvoicesData)
1923
1664
 
1924
1665
  | Properties | Type | Nullable | Description |
1925
- | ---------- | ---- | -------- | ----------- |
1926
- | interval | string | no | |
1927
- | interval_count | number | no | |
1666
+ | ---------- | ---- | -------- | ----------- || _id | string | no | || attemp | number | no | || auto_advance | boolean | no | || client | [InvoicesDataClient](#InvoicesDataClient) | no | || collection_method | string | no | || created_at | string | no | || currency | string | no | || current_status | string | no | || hash_identifier | string | no | || invoice_items | [[InvoiceItems](#InvoiceItems)] | no | || invoice_url | string | no | || modified_at | string | no | || next_action_time | string | no | || number | string | no | || paid | boolean | no | || payment_method | [InvoicesDataPaymentMethod](#InvoicesDataPaymentMethod) | no | || period | [InvoicesDataPeriod](#InvoicesDataPeriod) | no | || pg_data | string | no | || receipt_number | string | no | || statement_descriptor | string | no | || status_trail | [[InvoiceDetailsStatusTrail](#InvoiceDetailsStatusTrail)] | no | || subscriber_id | string | no | || subscription | string | no | || subtotal | number | no | || total | number | no | |
1928
1667
 
1929
1668
  ---
1930
1669
 
1931
-
1932
-
1933
-
1934
- #### [InvoiceItemsPlan](#InvoiceItemsPlan)
1670
+ #### [InvoicesDataClient](#InvoicesDataClient)
1935
1671
 
1936
1672
  | Properties | Type | Nullable | Description |
1937
- | ---------- | ---- | -------- | ----------- |
1938
- | recurring | [InvoiceItemsPlanRecurring](#InvoiceItemsPlanRecurring) | no | |
1939
- | is_trial_plan | boolean | no | |
1940
- | plan_group | string | no | |
1941
- | tag_lines | [string] | no | |
1942
- | currency | string | no | |
1943
- | is_active | boolean | no | |
1944
- | is_visible | boolean | no | |
1945
- | trial_period | number | no | |
1946
- | addons | [string] | no | |
1947
- | tags | [string] | no | |
1948
- | type | string | no | |
1949
- | country | string | no | |
1950
- | _id | string | no | |
1951
- | name | string | no | |
1952
- | description | string | no | |
1953
- | amount | number | no | |
1954
- | product_suite_id | string | no | |
1955
- | created_at | string | no | |
1956
- | modified_at | string | no | |
1957
-
1958
- ---
1959
-
1960
-
1961
-
1962
-
1963
- #### [InvoiceItemsPeriod](#InvoiceItemsPeriod)
1673
+ | ---------- | ---- | -------- | ----------- || address_lines | [string] | no | || email | string | no | || name | string | no | || phone | string | no | |
1674
+
1675
+ ---
1676
+
1677
+ #### [InvoicesDataPaymentMethod](#InvoicesDataPaymentMethod)
1964
1678
 
1965
1679
  | Properties | Type | Nullable | Description |
1966
- | ---------- | ---- | -------- | ----------- |
1967
- | start | string | no | |
1968
- | end | string | no | |
1680
+ | ---------- | ---- | -------- | ----------- || pg_payment_method_id | string | no | |
1969
1681
 
1970
1682
  ---
1971
1683
 
1972
-
1973
-
1974
-
1975
- #### [InvoiceItems](#InvoiceItems)
1684
+ #### [InvoicesDataPeriod](#InvoicesDataPeriod)
1976
1685
 
1977
1686
  | Properties | Type | Nullable | Description |
1978
- | ---------- | ---- | -------- | ----------- |
1979
- | _id | string | no | |
1980
- | currency | string | no | |
1981
- | plan | [InvoiceItemsPlan](#InvoiceItemsPlan) | no | |
1982
- | name | string | no | |
1983
- | quantity | number | no | |
1984
- | description | string | no | |
1985
- | period | [InvoiceItemsPeriod](#InvoiceItemsPeriod) | no | |
1986
- | unit_amount | number | no | |
1987
- | amount | number | no | |
1988
- | type | string | no | |
1989
- | invoice_id | string | no | |
1990
- | created_at | string | no | |
1991
- | modified_at | string | no | |
1687
+ | ---------- | ---- | -------- | ----------- || end | string | no | || start | string | no | |
1992
1688
 
1993
1689
  ---
1994
1690
 
1995
-
1996
-
1997
-
1998
- #### [Invoice](#Invoice)
1691
+ #### [Page](#Page)
1999
1692
 
2000
1693
  | Properties | Type | Nullable | Description |
2001
- | ---------- | ---- | -------- | ----------- |
2002
- | invoice | [InvoiceDetails](#InvoiceDetails) | no | |
2003
- | invoice_items | [[InvoiceItems](#InvoiceItems)] | no | |
1694
+ | ---------- | ---- | -------- | ----------- || current | number | no | || has_next | boolean | no | || has_previous | boolean | no | || item_total | number | no | || next_id | string | no | || size | number | no | || type | string | yes | |
2004
1695
 
2005
1696
  ---
2006
1697
 
2007
-
2008
-
2009
-
2010
- #### [InvoicesDataClient](#InvoicesDataClient)
1698
+ #### [Phone](#Phone)
2011
1699
 
2012
1700
  | Properties | Type | Nullable | Description |
2013
- | ---------- | ---- | -------- | ----------- |
2014
- | name | string | no | |
2015
- | email | string | no | |
2016
- | phone | string | no | |
2017
- | address_lines | [string] | no | |
1701
+ | ---------- | ---- | -------- | ----------- || phone_country_code | string | no | || phone_number | string | no | |
2018
1702
 
2019
1703
  ---
2020
1704
 
2021
-
2022
-
2023
-
2024
- #### [InvoicesDataPeriod](#InvoicesDataPeriod)
1705
+ #### [Plan](#Plan)
2025
1706
 
2026
1707
  | Properties | Type | Nullable | Description |
2027
- | ---------- | ---- | -------- | ----------- |
2028
- | start | string | no | |
2029
- | end | string | no | |
1708
+ | ---------- | ---- | -------- | ----------- || _id | string | no | || addons | [string] | no | || amount | number | no | || country | string | no | || created_at | string | no | || currency | string | no | || description | string | no | || is_active | boolean | no | || is_trial_plan | boolean | no | || is_visible | boolean | no | || modified_at | string | no | || name | string | no | || plan_group | string | no | || product_suite_id | string | no | || recurring | [PlanRecurring](#PlanRecurring) | no | || tag_lines | [string] | no | || tags | [string] | no | || trial_period | number | no | || type | string | no | |
2030
1709
 
2031
1710
  ---
2032
1711
 
2033
-
2034
-
2035
-
2036
- #### [InvoicesDataPaymentMethod](#InvoicesDataPaymentMethod)
1712
+ #### [PlanRecurring](#PlanRecurring)
2037
1713
 
2038
1714
  | Properties | Type | Nullable | Description |
2039
- | ---------- | ---- | -------- | ----------- |
2040
- | pg_payment_method_id | string | no | |
1715
+ | ---------- | ---- | -------- | ----------- || interval | string | no | || interval_count | number | no | |
2041
1716
 
2042
1717
  ---
2043
1718
 
2044
-
2045
-
2046
-
2047
- #### [InvoicesData](#InvoicesData)
1719
+ #### [ResourceNotFound](#ResourceNotFound)
2048
1720
 
2049
1721
  | Properties | Type | Nullable | Description |
2050
- | ---------- | ---- | -------- | ----------- |
2051
- | _id | string | no | |
2052
- | client | [InvoicesDataClient](#InvoicesDataClient) | no | |
2053
- | auto_advance | boolean | no | |
2054
- | currency | string | no | |
2055
- | paid | boolean | no | |
2056
- | attemp | number | no | |
2057
- | collection_method | string | no | |
2058
- | subscriber_id | string | no | |
2059
- | invoice_url | string | no | |
2060
- | number | string | no | |
2061
- | pg_data | string | no | |
2062
- | period | [InvoicesDataPeriod](#InvoicesDataPeriod) | no | |
2063
- | receipt_number | string | no | |
2064
- | statement_descriptor | string | no | |
2065
- | current_status | string | no | |
2066
- | status_trail | [[InvoiceDetailsStatusTrail](#InvoiceDetailsStatusTrail)] | no | |
2067
- | subtotal | number | no | |
2068
- | total | number | no | |
2069
- | subscription | string | no | |
2070
- | next_action_time | string | no | |
2071
- | created_at | string | no | |
2072
- | modified_at | string | no | |
2073
- | hash_identifier | string | no | |
2074
- | payment_method | [InvoicesDataPaymentMethod](#InvoicesDataPaymentMethod) | no | |
2075
- | invoice_items | [[InvoiceItems](#InvoiceItems)] | no | |
2076
-
2077
- ---
2078
-
2079
-
2080
-
2081
-
2082
- #### [Invoices](#Invoices)
1722
+ | ---------- | ---- | -------- | ----------- || message | string | no | |
1723
+
1724
+ ---
1725
+
1726
+ #### [Subscription](#Subscription)
2083
1727
 
2084
1728
  | Properties | Type | Nullable | Description |
2085
- | ---------- | ---- | -------- | ----------- |
2086
- | data | [[InvoicesData](#InvoicesData)] | no | |
2087
- | start | number | no | |
2088
- | end | number | no | |
2089
- | limit | number | no | |
2090
- | page | number | no | |
2091
- | total | number | no | |
1729
+ | ---------- | ---- | -------- | ----------- || _id | string | no | || cancel_at_period_end | boolean | no | || collection_method | string | no | || created_at | string | no | || current_period | [SubscriptionCurrentPeriod](#SubscriptionCurrentPeriod) | no | || current_status | string | no | || invoice_settings | [SubscriptionInvoiceSettings](#SubscriptionInvoiceSettings) | no | || is_active | boolean | no | || latest_invoice | string | no | || modified_at | string | no | || pause_collection | [SubscriptionPauseCollection](#SubscriptionPauseCollection) | no | || plan_data | [Plan](#Plan) | no | || plan_id | string | no | || product_suite_id | string | no | || subscriber_id | string | no | || trial | [SubscriptionTrial](#SubscriptionTrial) | no | |
2092
1730
 
2093
1731
  ---
2094
1732
 
2095
-
2096
-
2097
-
2098
- #### [Phone](#Phone)
1733
+ #### [SubscriptionActivateReq](#SubscriptionActivateReq)
2099
1734
 
2100
1735
  | Properties | Type | Nullable | Description |
2101
- | ---------- | ---- | -------- | ----------- |
2102
- | phone_number | string | no | |
2103
- | phone_country_code | string | no | |
1736
+ | ---------- | ---- | -------- | ----------- || payment_method | string | no | || plan_id | string | no | || product_suite | string | no | || type | string | no | || unique_id | string | no | |
2104
1737
 
2105
1738
  ---
2106
1739
 
2107
-
2108
-
2109
-
2110
- #### [SubscriptionBillingAddress](#SubscriptionBillingAddress)
1740
+ #### [SubscriptionActivateRes](#SubscriptionActivateRes)
2111
1741
 
2112
1742
  | Properties | Type | Nullable | Description |
2113
- | ---------- | ---- | -------- | ----------- |
2114
- | country | string | no | |
2115
- | state | string | no | |
2116
- | city | string | no | |
2117
- | line1 | string | no | |
2118
- | line2 | string | no | |
2119
- | postal_code | string | no | |
1743
+ | ---------- | ---- | -------- | ----------- || data | [Subscription](#Subscription) | no | || success | boolean | no | |
2120
1744
 
2121
1745
  ---
2122
1746
 
2123
-
2124
-
2125
-
2126
- #### [SubscriptionCustomer](#SubscriptionCustomer)
1747
+ #### [SubscriptionBillingAddress](#SubscriptionBillingAddress)
2127
1748
 
2128
1749
  | Properties | Type | Nullable | Description |
2129
- | ---------- | ---- | -------- | ----------- |
2130
- | phone | [Phone](#Phone) | no | |
2131
- | billing_address | [SubscriptionBillingAddress](#SubscriptionBillingAddress) | no | |
2132
- | _id | string | no | |
2133
- | unique_id | string | no | |
2134
- | type | string | no | |
2135
- | name | string | no | |
2136
- | email | string | no | |
2137
- | created_at | string | no | |
2138
- | modified_at | string | no | |
2139
- | data | string | no | |
1750
+ | ---------- | ---- | -------- | ----------- || city | string | no | || country | string | no | || line1 | string | no | || line2 | string | no | || postal_code | string | no | || state | string | no | |
2140
1751
 
2141
1752
  ---
2142
1753
 
2143
-
2144
-
2145
-
2146
- #### [SubscriptionCustomerCreate](#SubscriptionCustomerCreate)
1754
+ #### [SubscriptionCharge](#SubscriptionCharge)
2147
1755
 
2148
1756
  | Properties | Type | Nullable | Description |
2149
- | ---------- | ---- | -------- | ----------- |
2150
- | phone | [Phone](#Phone) | no | |
2151
- | billing_address | [SubscriptionBillingAddress](#SubscriptionBillingAddress) | no | |
2152
- | unique_id | string | no | |
2153
- | type | string | no | |
2154
- | name | string | no | |
2155
- | email | string | no | |
1757
+ | ---------- | ---- | -------- | ----------- || _id | string | no | || activated_on | string | no | || billing_date | string | no | || cancelled_on | string | no | || capped_amount | number | no | || current_period | [CurrentPeriod](#CurrentPeriod) | no | || is_test | boolean | no | || metadata | string | no | || name | string | no | || price | [EntityChargePrice](#EntityChargePrice) | no | || pricing_type | string | no | || recurring | [EntityChargeRecurring](#EntityChargeRecurring) | no | || status | string | no | || term | string | no | |
2156
1758
 
2157
1759
  ---
2158
1760
 
2159
-
2160
-
2161
-
2162
- #### [SubscriptionCurrentPeriod](#SubscriptionCurrentPeriod)
1761
+ #### [SubscriptionCurrentPeriod](#SubscriptionCurrentPeriod)
2163
1762
 
2164
1763
  | Properties | Type | Nullable | Description |
2165
- | ---------- | ---- | -------- | ----------- |
2166
- | start | string | no | |
2167
- | end | string | no | |
1764
+ | ---------- | ---- | -------- | ----------- || end | string | no | || start | string | no | |
2168
1765
 
2169
1766
  ---
2170
1767
 
2171
-
2172
-
2173
-
2174
- #### [SubscriptionPauseCollection](#SubscriptionPauseCollection)
1768
+ #### [SubscriptionCustomer](#SubscriptionCustomer)
2175
1769
 
2176
1770
  | Properties | Type | Nullable | Description |
2177
- | ---------- | ---- | -------- | ----------- |
2178
- | behavior | string | no | |
2179
- | resume_at | string | no | |
1771
+ | ---------- | ---- | -------- | ----------- || _id | string | no | || billing_address | [SubscriptionBillingAddress](#SubscriptionBillingAddress) | no | || created_at | string | no | || data | string | no | || email | string | no | || modified_at | string | no | || name | string | no | || phone | [Phone](#Phone) | no | || type | string | no | || unique_id | string | no | |
2180
1772
 
2181
1773
  ---
2182
1774
 
2183
-
2184
-
2185
-
2186
- #### [SubscriptionTrial](#SubscriptionTrial)
1775
+ #### [SubscriptionCustomerCreate](#SubscriptionCustomerCreate)
2187
1776
 
2188
1777
  | Properties | Type | Nullable | Description |
2189
- | ---------- | ---- | -------- | ----------- |
2190
- | start | string | no | |
2191
- | end | string | no | |
1778
+ | ---------- | ---- | -------- | ----------- || billing_address | [SubscriptionBillingAddress](#SubscriptionBillingAddress) | no | || email | string | no | || name | string | no | || phone | [Phone](#Phone) | no | || type | string | no | || unique_id | string | no | |
2192
1779
 
2193
1780
  ---
2194
1781
 
2195
-
2196
-
2197
-
2198
- #### [SubscriptionInvoiceSettings](#SubscriptionInvoiceSettings)
1782
+ #### [SubscriptionInvoiceSettings](#SubscriptionInvoiceSettings)
2199
1783
 
2200
1784
  | Properties | Type | Nullable | Description |
2201
- | ---------- | ---- | -------- | ----------- |
2202
- | generation | boolean | no | |
2203
- | charging | boolean | no | |
1785
+ | ---------- | ---- | -------- | ----------- || charging | boolean | no | || generation | boolean | no | |
2204
1786
 
2205
1787
  ---
2206
1788
 
2207
-
2208
-
2209
-
2210
- #### [Subscription](#Subscription)
1789
+ #### [SubscriptionLimit](#SubscriptionLimit)
2211
1790
 
2212
1791
  | Properties | Type | Nullable | Description |
2213
- | ---------- | ---- | -------- | ----------- |
2214
- | current_period | [SubscriptionCurrentPeriod](#SubscriptionCurrentPeriod) | no | |
2215
- | pause_collection | [SubscriptionPauseCollection](#SubscriptionPauseCollection) | no | |
2216
- | trial | [SubscriptionTrial](#SubscriptionTrial) | no | |
2217
- | invoice_settings | [SubscriptionInvoiceSettings](#SubscriptionInvoiceSettings) | no | |
2218
- | is_active | boolean | no | |
2219
- | cancel_at_period_end | boolean | no | |
2220
- | _id | string | no | |
2221
- | subscriber_id | string | no | |
2222
- | plan_id | string | no | |
2223
- | product_suite_id | string | no | |
2224
- | plan_data | [Plan](#Plan) | no | |
2225
- | current_status | string | no | |
2226
- | collection_method | string | no | |
2227
- | created_at | string | no | |
2228
- | modified_at | string | no | |
2229
- | latest_invoice | string | no | |
2230
-
2231
- ---
2232
-
2233
-
2234
-
2235
-
2236
- #### [SubscriptionStatus](#SubscriptionStatus)
1792
+ | ---------- | ---- | -------- | ----------- || application | [SubscriptionLimitApplication](#SubscriptionLimitApplication) | no | || extensions | [SubscriptionLimitExtensions](#SubscriptionLimitExtensions) | no | || integrations | [SubscriptionLimitIntegrations](#SubscriptionLimitIntegrations) | no | || is_trial_plan | boolean | no | || marketplace | [SubscriptionLimitMarketplace](#SubscriptionLimitMarketplace) | no | || other_platform | [SubscriptionLimitOtherPlatform](#SubscriptionLimitOtherPlatform) | no | || products | [SubscriptionLimitProducts](#SubscriptionLimitProducts) | no | || team | [SubscriptionLimitTeam](#SubscriptionLimitTeam) | no | |
1793
+
1794
+ ---
1795
+
1796
+ #### [SubscriptionLimitApplication](#SubscriptionLimitApplication)
2237
1797
 
2238
1798
  | Properties | Type | Nullable | Description |
2239
- | ---------- | ---- | -------- | ----------- |
2240
- | is_enabled | boolean | no | |
2241
- | subscription | [Subscription](#Subscription) | no | |
1799
+ | ---------- | ---- | -------- | ----------- || enabled | boolean | no | || hard_limit | number | no | || soft_limit | number | no | |
2242
1800
 
2243
1801
  ---
2244
1802
 
2245
-
2246
-
2247
-
2248
- #### [SubscriptionLimitApplication](#SubscriptionLimitApplication)
1803
+ #### [SubscriptionLimitExtensions](#SubscriptionLimitExtensions)
2249
1804
 
2250
1805
  | Properties | Type | Nullable | Description |
2251
- | ---------- | ---- | -------- | ----------- |
2252
- | enabled | boolean | no | |
2253
- | hard_limit | number | no | |
2254
- | soft_limit | number | no | |
1806
+ | ---------- | ---- | -------- | ----------- || enabled | boolean | no | || limit | number | no | |
2255
1807
 
2256
1808
  ---
2257
1809
 
2258
-
2259
-
2260
-
2261
- #### [SubscriptionLimitMarketplace](#SubscriptionLimitMarketplace)
1810
+ #### [SubscriptionLimitIntegrations](#SubscriptionLimitIntegrations)
2262
1811
 
2263
1812
  | Properties | Type | Nullable | Description |
2264
- | ---------- | ---- | -------- | ----------- |
2265
- | enabled | boolean | no | |
1813
+ | ---------- | ---- | -------- | ----------- || enabled | boolean | no | || limit | number | no | |
2266
1814
 
2267
1815
  ---
2268
1816
 
2269
-
2270
-
2271
-
2272
- #### [SubscriptionLimitOtherPlatform](#SubscriptionLimitOtherPlatform)
1817
+ #### [SubscriptionLimitMarketplace](#SubscriptionLimitMarketplace)
2273
1818
 
2274
1819
  | Properties | Type | Nullable | Description |
2275
- | ---------- | ---- | -------- | ----------- |
2276
- | enabled | boolean | no | |
1820
+ | ---------- | ---- | -------- | ----------- || enabled | boolean | no | |
2277
1821
 
2278
1822
  ---
2279
1823
 
2280
-
2281
-
2282
-
2283
- #### [SubscriptionLimitTeam](#SubscriptionLimitTeam)
1824
+ #### [SubscriptionLimitOtherPlatform](#SubscriptionLimitOtherPlatform)
2284
1825
 
2285
1826
  | Properties | Type | Nullable | Description |
2286
- | ---------- | ---- | -------- | ----------- |
2287
- | limit | number | no | |
1827
+ | ---------- | ---- | -------- | ----------- || enabled | boolean | no | |
2288
1828
 
2289
1829
  ---
2290
1830
 
2291
-
2292
-
2293
-
2294
- #### [SubscriptionLimitProducts](#SubscriptionLimitProducts)
1831
+ #### [SubscriptionLimitProducts](#SubscriptionLimitProducts)
2295
1832
 
2296
1833
  | Properties | Type | Nullable | Description |
2297
- | ---------- | ---- | -------- | ----------- |
2298
- | bulk | boolean | no | |
2299
- | limit | number | no | |
1834
+ | ---------- | ---- | -------- | ----------- || bulk | boolean | no | || limit | number | no | |
2300
1835
 
2301
1836
  ---
2302
1837
 
2303
-
2304
-
2305
-
2306
- #### [SubscriptionLimitExtensions](#SubscriptionLimitExtensions)
1838
+ #### [SubscriptionLimitTeam](#SubscriptionLimitTeam)
2307
1839
 
2308
1840
  | Properties | Type | Nullable | Description |
2309
- | ---------- | ---- | -------- | ----------- |
2310
- | enabled | boolean | no | |
2311
- | limit | number | no | |
1841
+ | ---------- | ---- | -------- | ----------- || limit | number | no | |
2312
1842
 
2313
1843
  ---
2314
1844
 
2315
-
2316
-
2317
-
2318
- #### [SubscriptionLimitIntegrations](#SubscriptionLimitIntegrations)
1845
+ #### [SubscriptionPauseCollection](#SubscriptionPauseCollection)
2319
1846
 
2320
1847
  | Properties | Type | Nullable | Description |
2321
- | ---------- | ---- | -------- | ----------- |
2322
- | enabled | boolean | no | |
2323
- | limit | number | no | |
1848
+ | ---------- | ---- | -------- | ----------- || behavior | string | no | || resume_at | string | no | |
2324
1849
 
2325
1850
  ---
2326
1851
 
2327
-
2328
-
2329
-
2330
- #### [SubscriptionLimit](#SubscriptionLimit)
1852
+ #### [SubscriptionStatus](#SubscriptionStatus)
2331
1853
 
2332
1854
  | Properties | Type | Nullable | Description |
2333
- | ---------- | ---- | -------- | ----------- |
2334
- | application | [SubscriptionLimitApplication](#SubscriptionLimitApplication) | no | |
2335
- | marketplace | [SubscriptionLimitMarketplace](#SubscriptionLimitMarketplace) | no | |
2336
- | other_platform | [SubscriptionLimitOtherPlatform](#SubscriptionLimitOtherPlatform) | no | |
2337
- | team | [SubscriptionLimitTeam](#SubscriptionLimitTeam) | no | |
2338
- | products | [SubscriptionLimitProducts](#SubscriptionLimitProducts) | no | |
2339
- | extensions | [SubscriptionLimitExtensions](#SubscriptionLimitExtensions) | no | |
2340
- | integrations | [SubscriptionLimitIntegrations](#SubscriptionLimitIntegrations) | no | |
2341
- | is_trial_plan | boolean | no | |
1855
+ | ---------- | ---- | -------- | ----------- || is_enabled | boolean | no | || subscription | [Subscription](#Subscription) | no | |
2342
1856
 
2343
1857
  ---
2344
1858
 
2345
-
2346
-
2347
-
2348
- #### [SubscriptionActivateReq](#SubscriptionActivateReq)
1859
+ #### [SubscriptionTrial](#SubscriptionTrial)
2349
1860
 
2350
1861
  | Properties | Type | Nullable | Description |
2351
- | ---------- | ---- | -------- | ----------- |
2352
- | unique_id | string | no | |
2353
- | type | string | no | |
2354
- | product_suite | string | no | |
2355
- | plan_id | string | no | |
2356
- | payment_method | string | no | |
1862
+ | ---------- | ---- | -------- | ----------- || end | string | no | || start | string | no | |
2357
1863
 
2358
1864
  ---
2359
1865
 
2360
-
2361
-
2362
-
2363
- #### [SubscriptionActivateRes](#SubscriptionActivateRes)
1866
+ #### [SubscriptionTrialPeriod](#SubscriptionTrialPeriod)
2364
1867
 
2365
1868
  | Properties | Type | Nullable | Description |
2366
- | ---------- | ---- | -------- | ----------- |
2367
- | success | boolean | no | |
2368
- | data | [Subscription](#Subscription) | no | |
1869
+ | ---------- | ---- | -------- | ----------- || end_date | string | no | || start_date | string | no | |
2369
1870
 
2370
1871
  ---
2371
1872
 
2372
-
2373
-
2374
-
2375
- #### [CancelSubscriptionReq](#CancelSubscriptionReq)
1873
+ #### [UnauthenticatedApplication](#UnauthenticatedApplication)
2376
1874
 
2377
1875
  | Properties | Type | Nullable | Description |
2378
- | ---------- | ---- | -------- | ----------- |
2379
- | unique_id | string | no | |
2380
- | type | string | no | |
2381
- | product_suite | string | no | |
2382
- | subscription_id | string | no | |
1876
+ | ---------- | ---- | -------- | ----------- || message | string | no | |
2383
1877
 
2384
1878
  ---
2385
1879
 
2386
-
2387
-
2388
-
2389
- #### [CancelSubscriptionRes](#CancelSubscriptionRes)
1880
+ #### [UnauthenticatedUser](#UnauthenticatedUser)
2390
1881
 
2391
1882
  | Properties | Type | Nullable | Description |
2392
- | ---------- | ---- | -------- | ----------- |
2393
- | success | boolean | no | |
2394
- | data | [Subscription](#Subscription) | no | |
1883
+ | ---------- | ---- | -------- | ----------- || message | string | no | |
2395
1884
 
2396
1885
  ---
2397
1886