@gofynd/fdk-client-javascript 1.4.7 → 1.4.8-beta.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.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +16 -3
- package/sdk/application/Cart/CartApplicationClient.js +118 -13
- package/sdk/application/Cart/CartApplicationModel.d.ts +121 -45
- package/sdk/application/Cart/CartApplicationModel.js +98 -26
- package/sdk/application/Cart/CartApplicationValidator.d.ts +45 -1
- package/sdk/application/Cart/CartApplicationValidator.js +26 -0
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +4 -2
- package/sdk/application/Catalog/CatalogApplicationModel.js +4 -2
- package/sdk/application/Content/ContentApplicationClient.d.ts +1 -1
- package/sdk/application/Content/ContentApplicationClient.js +5 -3
- package/sdk/application/Content/ContentApplicationModel.d.ts +7 -18
- package/sdk/application/Content/ContentApplicationModel.js +6 -20
- package/sdk/application/Content/ContentApplicationValidator.d.ts +10 -0
- package/sdk/application/Content/ContentApplicationValidator.js +4 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +0 -27
- package/sdk/application/Lead/LeadApplicationClient.js +0 -167
- package/sdk/application/Lead/LeadApplicationModel.d.ts +1 -146
- package/sdk/application/Lead/LeadApplicationModel.js +0 -126
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -25
- package/sdk/application/Lead/LeadApplicationValidator.js +0 -24
- package/sdk/application/Logistic/LogisticApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +2 -0
- package/sdk/application/Logistic/LogisticApplicationModel.js +2 -0
- package/sdk/application/Order/OrderApplicationModel.d.ts +4 -0
- package/sdk/application/Order/OrderApplicationModel.js +4 -0
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +9 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +5 -2
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +2 -0
- package/sdk/application/Theme/ThemeApplicationModel.js +2 -0
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +0 -23
- package/sdk/partner/Lead/LeadPartnerClient.js +0 -157
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +12 -581
- package/sdk/partner/Lead/LeadPartnerModel.js +14 -403
- package/sdk/partner/Lead/LeadPartnerValidator.d.ts +0 -2
- package/sdk/partner/Lead/LeadPartnerValidator.js +0 -12
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +47 -1
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +56 -4
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +2 -2
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +22 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +162 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +119 -1
- package/sdk/partner/Theme/ThemePartnerModel.js +142 -0
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +2 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +14 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +304 -43
- package/sdk/platform/Billing/BillingPlatformClient.js +2218 -118
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +1330 -282
- package/sdk/platform/Billing/BillingPlatformModel.js +1808 -590
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +324 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +340 -12
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +28 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +198 -5
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +81 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +48 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +214 -40
- package/sdk/platform/Cart/CartPlatformModel.js +164 -24
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +20 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +37 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +16 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.js +18 -2
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +4 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.js +4 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +28 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +12 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +18 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +25 -0
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +10 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +8 -4
- package/sdk/platform/Content/ContentPlatformModel.js +8 -4
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +49 -28
- package/sdk/platform/Finance/FinancePlatformClient.js +181 -28
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +369 -129
- package/sdk/platform/Finance/FinancePlatformModel.js +404 -110
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +56 -43
- package/sdk/platform/Finance/FinancePlatformValidator.js +61 -42
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +0 -47
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +0 -321
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -46
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +0 -48
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -25
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -167
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +82 -204
- package/sdk/platform/Lead/LeadPlatformModel.js +98 -178
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -25
- package/sdk/platform/Lead/LeadPlatformValidator.js +0 -24
- package/sdk/platform/Order/OrderPlatformModel.d.ts +126 -15
- package/sdk/platform/Order/OrderPlatformModel.js +55 -14
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +12 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +5 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +20 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +26 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +4 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +12 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +82 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -1
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +14 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +67 -1
- package/sdk/platform/Theme/ThemePlatformModel.js +78 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +0 -2
- package/sdk/platform/User/UserPlatformModel.js +0 -2
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +0 -40
- package/sdk/platform/Webhook/WebhookPlatformClient.js +0 -307
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +94 -146
- package/sdk/platform/Webhook/WebhookPlatformModel.js +100 -151
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +9 -35
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +8 -46
- package/sdk/public/Billing/BillingPublicClient.d.ts +24 -2
- package/sdk/public/Billing/BillingPublicClient.js +156 -3
- package/sdk/public/Billing/BillingPublicModel.d.ts +368 -26
- package/sdk/public/Billing/BillingPublicModel.js +317 -18
- package/sdk/public/Billing/BillingPublicValidator.d.ts +19 -3
- package/sdk/public/Billing/BillingPublicValidator.js +22 -3
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +22 -22
- package/sdk/public/Webhook/WebhookPublicModel.js +22 -22
|
@@ -1,4 +1,138 @@
|
|
|
1
1
|
export = BillingPlatformModel;
|
|
2
|
+
/**
|
|
3
|
+
* @typedef CompanyInfo
|
|
4
|
+
* @property {string} [company_name]
|
|
5
|
+
* @property {string} [gstin]
|
|
6
|
+
* @property {string} [address]
|
|
7
|
+
* @property {AddressDetails} [address_details]
|
|
8
|
+
* @property {string} [pan]
|
|
9
|
+
* @property {string} [phone]
|
|
10
|
+
* @property {string} [email]
|
|
11
|
+
* @property {string} [cin]
|
|
12
|
+
*/
|
|
13
|
+
/**
|
|
14
|
+
* @typedef AddressDetails
|
|
15
|
+
* @property {string} [address_line_1]
|
|
16
|
+
* @property {string} [address_line_2]
|
|
17
|
+
* @property {string} [city]
|
|
18
|
+
* @property {string} [pincode]
|
|
19
|
+
* @property {string} [state]
|
|
20
|
+
* @property {string} [country]
|
|
21
|
+
*/
|
|
22
|
+
/**
|
|
23
|
+
* @typedef InvoiceData
|
|
24
|
+
* @property {InvoiceDetailsData} [invoice]
|
|
25
|
+
* @property {InvoiceItems[]} [invoice_items]
|
|
26
|
+
* @property {CompanyInfo} [shopsense_details]
|
|
27
|
+
*/
|
|
28
|
+
/**
|
|
29
|
+
* @typedef InvoiceDetailsData
|
|
30
|
+
* @property {number} [attemp]
|
|
31
|
+
* @property {Object} [documents]
|
|
32
|
+
* @property {Object} [payment]
|
|
33
|
+
* @property {Period} [period]
|
|
34
|
+
* @property {Client} [client]
|
|
35
|
+
* @property {Object} [discount]
|
|
36
|
+
* @property {Object} [taxation]
|
|
37
|
+
* @property {string} [_id]
|
|
38
|
+
* @property {boolean} [auto_advance]
|
|
39
|
+
* @property {string} [collection_method]
|
|
40
|
+
* @property {string} [subscriber_id]
|
|
41
|
+
* @property {string} [currency]
|
|
42
|
+
* @property {string} [invoice_url]
|
|
43
|
+
* @property {string} [number]
|
|
44
|
+
* @property {boolean} [paid]
|
|
45
|
+
* @property {Object} [pg_data]
|
|
46
|
+
* @property {string} [receipt_number]
|
|
47
|
+
* @property {string} [statement_descriptor]
|
|
48
|
+
* @property {string} [current_status]
|
|
49
|
+
* @property {StatusTrail[]} [status_trail]
|
|
50
|
+
* @property {number} [subtotal]
|
|
51
|
+
* @property {number} [total]
|
|
52
|
+
* @property {number} [old_settlement]
|
|
53
|
+
* @property {number} [credit_balance]
|
|
54
|
+
* @property {string} [subscription]
|
|
55
|
+
* @property {number} [attempt]
|
|
56
|
+
* @property {string} [next_action_time]
|
|
57
|
+
* @property {number} [credit_note_amount]
|
|
58
|
+
* @property {string} [created_at]
|
|
59
|
+
* @property {string} [modified_at]
|
|
60
|
+
*/
|
|
61
|
+
/**
|
|
62
|
+
* @typedef Client
|
|
63
|
+
* @property {string} [name]
|
|
64
|
+
* @property {string} [email]
|
|
65
|
+
* @property {string} [phone]
|
|
66
|
+
* @property {string[]} [address_lines]
|
|
67
|
+
*/
|
|
68
|
+
/**
|
|
69
|
+
* @typedef Period
|
|
70
|
+
* @property {string} [start]
|
|
71
|
+
* @property {string} [end]
|
|
72
|
+
*/
|
|
73
|
+
/**
|
|
74
|
+
* @typedef StatusTrail
|
|
75
|
+
* @property {string} [value]
|
|
76
|
+
* @property {string} [timestamp]
|
|
77
|
+
* @property {string} [_id]
|
|
78
|
+
*/
|
|
79
|
+
/**
|
|
80
|
+
* @typedef PaymentCollectRes
|
|
81
|
+
* @property {string} [transaction_id]
|
|
82
|
+
* @property {string} [current_status]
|
|
83
|
+
*/
|
|
84
|
+
/**
|
|
85
|
+
* @typedef SubscriptionChargeRes
|
|
86
|
+
* @property {string} [_id]
|
|
87
|
+
* @property {string} [product_suit_id]
|
|
88
|
+
* @property {string} [entity_id]
|
|
89
|
+
* @property {string} [entity_type]
|
|
90
|
+
* @property {string} [name]
|
|
91
|
+
* @property {string} [status]
|
|
92
|
+
* @property {number} [trial_days]
|
|
93
|
+
* @property {string} [activated_on]
|
|
94
|
+
* @property {string} [cancelled_on]
|
|
95
|
+
* @property {boolean} [is_test]
|
|
96
|
+
* @property {string} [created_at]
|
|
97
|
+
* @property {string} [modified_at]
|
|
98
|
+
* @property {string} [company_id]
|
|
99
|
+
* @property {Object[]} [line_items]
|
|
100
|
+
*/
|
|
101
|
+
/**
|
|
102
|
+
* @typedef PostDowngradeRes
|
|
103
|
+
* @property {boolean} [success]
|
|
104
|
+
* @property {DowngradeRes} [data]
|
|
105
|
+
*/
|
|
106
|
+
/**
|
|
107
|
+
* @typedef DowngradeRes
|
|
108
|
+
* @property {string} [_id]
|
|
109
|
+
* @property {string} [status]
|
|
110
|
+
* @property {string} [subscriber_id]
|
|
111
|
+
* @property {boolean} [activated]
|
|
112
|
+
* @property {string} [created_at]
|
|
113
|
+
* @property {string} [modified_at]
|
|
114
|
+
* @property {string} [plan_id]
|
|
115
|
+
* @property {string} [reason]
|
|
116
|
+
* @property {string} [request_user_id]
|
|
117
|
+
* @property {string} [subscription_id]
|
|
118
|
+
*/
|
|
119
|
+
/**
|
|
120
|
+
* @typedef PaymentStatusData
|
|
121
|
+
* @property {string} [_id]
|
|
122
|
+
* @property {string} [journey]
|
|
123
|
+
* @property {Object[]} [webhook_response]
|
|
124
|
+
* @property {string} [aggregator_status]
|
|
125
|
+
* @property {string} [current_status]
|
|
126
|
+
* @property {string} [created_at]
|
|
127
|
+
* @property {string} [modified_at]
|
|
128
|
+
* @property {number} [__v]
|
|
129
|
+
* @property {string} [aggregator_order_id]
|
|
130
|
+
*/
|
|
131
|
+
/**
|
|
132
|
+
* @typedef PaymentStatusResponse
|
|
133
|
+
* @property {string} [status]
|
|
134
|
+
* @property {PaymentStatusData} [data]
|
|
135
|
+
*/
|
|
2
136
|
/**
|
|
3
137
|
* @typedef BadRequest
|
|
4
138
|
* @property {string} [message] - Failure message.
|
|
@@ -6,6 +140,8 @@ export = BillingPlatformModel;
|
|
|
6
140
|
/**
|
|
7
141
|
* @typedef ResourceNotFound
|
|
8
142
|
* @property {string} [message] - Resource not found with {id}
|
|
143
|
+
* @property {Object} [code]
|
|
144
|
+
* @property {Object} [success]
|
|
9
145
|
*/
|
|
10
146
|
/**
|
|
11
147
|
* @typedef InternalServerError
|
|
@@ -22,8 +158,15 @@ export = BillingPlatformModel;
|
|
|
22
158
|
* @property {string} [interval]
|
|
23
159
|
* @property {number} [interval_count]
|
|
24
160
|
*/
|
|
161
|
+
/**
|
|
162
|
+
* @typedef PlanMeta
|
|
163
|
+
* @property {string} [seller_status]
|
|
164
|
+
* @property {string} [company]
|
|
165
|
+
* @property {string} [plan_platform_display_name]
|
|
166
|
+
*/
|
|
25
167
|
/**
|
|
26
168
|
* @typedef Plan
|
|
169
|
+
* @property {Object[]} [fee_components]
|
|
27
170
|
* @property {PlanRecurring} [recurring]
|
|
28
171
|
* @property {boolean} [is_trial_plan]
|
|
29
172
|
* @property {string} [plan_group]
|
|
@@ -43,6 +186,16 @@ export = BillingPlatformModel;
|
|
|
43
186
|
* @property {string} [product_suite_id]
|
|
44
187
|
* @property {string} [created_at]
|
|
45
188
|
* @property {string} [modified_at]
|
|
189
|
+
* @property {Taxation} [taxation]
|
|
190
|
+
* @property {OneTimeFees} [one_time_fees]
|
|
191
|
+
* @property {CreditLine} [credit_line]
|
|
192
|
+
* @property {string} [current_status]
|
|
193
|
+
* @property {string} [channel_type]
|
|
194
|
+
* @property {Object[]} [company_ids]
|
|
195
|
+
* @property {string} [platform]
|
|
196
|
+
* @property {string} [activated_on]
|
|
197
|
+
* @property {PlanMeta} [meta]
|
|
198
|
+
* @property {string} [created_by]
|
|
46
199
|
*/
|
|
47
200
|
/**
|
|
48
201
|
* @typedef SubscriptionTrialPeriod
|
|
@@ -51,87 +204,64 @@ export = BillingPlatformModel;
|
|
|
51
204
|
*/
|
|
52
205
|
/**
|
|
53
206
|
* @typedef EntityChargePrice
|
|
54
|
-
* @property {number} amount - Amount for price. Minimum value 1
|
|
55
|
-
* @property {string} currency_code
|
|
56
|
-
*/
|
|
57
|
-
/**
|
|
58
|
-
* @typedef EntityChargeRecurring
|
|
59
|
-
* @property {string} interval
|
|
60
|
-
*/
|
|
61
|
-
/**
|
|
62
|
-
* @typedef ChargeLineItem
|
|
63
|
-
* @property {string} name
|
|
64
|
-
* @property {string} term
|
|
65
|
-
* @property {string} pricing_type
|
|
66
|
-
* @property {EntityChargePrice} price
|
|
67
|
-
* @property {EntityChargeRecurring} [recurring]
|
|
68
|
-
* @property {number} [capped_amount]
|
|
69
|
-
* @property {number} [trial_days]
|
|
70
|
-
* @property {boolean} [is_test]
|
|
71
|
-
* @property {Object} [metadata]
|
|
72
|
-
*/
|
|
73
|
-
/**
|
|
74
|
-
* @typedef CreateSubscriptionCharge
|
|
75
|
-
* @property {string} name
|
|
76
|
-
* @property {number} [trial_days]
|
|
77
|
-
* @property {ChargeLineItem[]} line_items
|
|
78
|
-
* @property {boolean} [is_test]
|
|
79
|
-
* @property {string} return_url
|
|
207
|
+
* @property {number} [amount] - Amount for price. Minimum value 1
|
|
208
|
+
* @property {string} [currency_code]
|
|
80
209
|
*/
|
|
81
210
|
/**
|
|
82
211
|
* @typedef OneTimeChargeItem
|
|
83
|
-
* @property {string} name
|
|
212
|
+
* @property {string} [name]
|
|
84
213
|
* @property {string} [term]
|
|
85
|
-
* @property {string} pricing_type
|
|
86
|
-
* @property {EntityChargePrice} price
|
|
214
|
+
* @property {string} [pricing_type]
|
|
215
|
+
* @property {EntityChargePrice} [price]
|
|
87
216
|
* @property {number} [capped_amount]
|
|
88
217
|
* @property {boolean} [is_test]
|
|
89
218
|
* @property {Object} [metadata]
|
|
90
219
|
*/
|
|
91
220
|
/**
|
|
92
221
|
* @typedef CreateOneTimeCharge
|
|
93
|
-
* @property {string} name
|
|
94
|
-
* @property {OneTimeChargeItem} charge
|
|
222
|
+
* @property {string} [name]
|
|
223
|
+
* @property {OneTimeChargeItem} [charge]
|
|
95
224
|
* @property {boolean} [is_test]
|
|
96
|
-
* @property {string} return_url
|
|
225
|
+
* @property {string} [return_url]
|
|
97
226
|
*/
|
|
98
227
|
/**
|
|
99
|
-
* @typedef
|
|
100
|
-
* @property {string} [
|
|
101
|
-
* @property {
|
|
228
|
+
* @typedef ChargeRecurring
|
|
229
|
+
* @property {string} [interval]
|
|
230
|
+
* @property {number} [interval_time]
|
|
102
231
|
*/
|
|
103
232
|
/**
|
|
104
|
-
* @typedef
|
|
233
|
+
* @typedef ChargeDetails
|
|
105
234
|
* @property {string} [_id]
|
|
235
|
+
* @property {string} [entity_type]
|
|
236
|
+
* @property {string} [entity_id]
|
|
106
237
|
* @property {string} [name]
|
|
107
|
-
* @property {string} [term]
|
|
238
|
+
* @property {string} [term]
|
|
239
|
+
* @property {string} [charge_type]
|
|
108
240
|
* @property {string} [pricing_type]
|
|
109
241
|
* @property {EntityChargePrice} [price]
|
|
110
|
-
* @property {
|
|
242
|
+
* @property {ChargeRecurring} [recurring]
|
|
243
|
+
* @property {string} [status]
|
|
111
244
|
* @property {number} [capped_amount]
|
|
112
245
|
* @property {string} [activated_on]
|
|
113
246
|
* @property {string} [cancelled_on]
|
|
114
247
|
* @property {string} [billing_date]
|
|
115
|
-
* @property {
|
|
116
|
-
* @property {string} [
|
|
248
|
+
* @property {SubscriptionTrialPeriod} [current_period]
|
|
249
|
+
* @property {string} [modified_at]
|
|
250
|
+
* @property {string} [created_at]
|
|
117
251
|
* @property {boolean} [is_test]
|
|
118
|
-
* @property {
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
* @typedef EntitySubscription
|
|
122
|
-
* @property {string} [_id]
|
|
123
|
-
* @property {string} [name]
|
|
124
|
-
* @property {string} [status]
|
|
125
|
-
* @property {number} [company_id]
|
|
126
|
-
* @property {string} [activated_on]
|
|
127
|
-
* @property {string} [cancelled_on]
|
|
128
|
-
* @property {number} [trial_days]
|
|
129
|
-
* @property {SubscriptionTrialPeriod} [trial_period]
|
|
130
|
-
* @property {Object} [metadata]
|
|
131
|
-
* @property {SubscriptionCharge[]} [line_items]
|
|
252
|
+
* @property {string} [company_id]
|
|
253
|
+
* @property {Object} [meta]
|
|
254
|
+
* @property {number} [__v]
|
|
132
255
|
*/
|
|
133
256
|
/**
|
|
134
257
|
* @typedef OneTimeChargeEntity
|
|
258
|
+
* @property {string} [term]
|
|
259
|
+
* @property {string} [charge_type]
|
|
260
|
+
* @property {number} [capped_amount]
|
|
261
|
+
* @property {string} [billing_date]
|
|
262
|
+
* @property {string} [created_at]
|
|
263
|
+
* @property {string} [modified_at]
|
|
264
|
+
* @property {number} [__v]
|
|
135
265
|
* @property {string} [_id]
|
|
136
266
|
* @property {string} [name]
|
|
137
267
|
* @property {string} [status]
|
|
@@ -149,25 +279,12 @@ export = BillingPlatformModel;
|
|
|
149
279
|
*/
|
|
150
280
|
/**
|
|
151
281
|
* @typedef CreateOneTimeChargeResponse
|
|
152
|
-
* @property {
|
|
282
|
+
* @property {Charge} [charge]
|
|
153
283
|
* @property {string} [confirm_url]
|
|
154
284
|
*/
|
|
155
285
|
/**
|
|
156
|
-
* @typedef
|
|
157
|
-
* @property {
|
|
158
|
-
* @property {string} [confirm_url]
|
|
159
|
-
*/
|
|
160
|
-
/**
|
|
161
|
-
* @typedef InvoiceDetailsPeriod
|
|
162
|
-
* @property {string} [start]
|
|
163
|
-
* @property {string} [end]
|
|
164
|
-
*/
|
|
165
|
-
/**
|
|
166
|
-
* @typedef InvoiceDetailsClient
|
|
167
|
-
* @property {string[]} [address_lines]
|
|
168
|
-
* @property {string} [name]
|
|
169
|
-
* @property {string} [email]
|
|
170
|
-
* @property {string} [phone]
|
|
286
|
+
* @typedef Charge
|
|
287
|
+
* @property {OneTimeChargeEntity} [final_charge]
|
|
171
288
|
*/
|
|
172
289
|
/**
|
|
173
290
|
* @typedef InvoiceDetailsStatusTrail
|
|
@@ -175,37 +292,6 @@ export = BillingPlatformModel;
|
|
|
175
292
|
* @property {string} [value]
|
|
176
293
|
* @property {string} [timestamp]
|
|
177
294
|
*/
|
|
178
|
-
/**
|
|
179
|
-
* @typedef InvoicePaymentMethod
|
|
180
|
-
* @property {string} [pg_payment_method_id]
|
|
181
|
-
*/
|
|
182
|
-
/**
|
|
183
|
-
* @typedef InvoiceDetails
|
|
184
|
-
* @property {InvoiceDetailsPeriod} [period]
|
|
185
|
-
* @property {InvoiceDetailsClient} [client]
|
|
186
|
-
* @property {boolean} [auto_advance]
|
|
187
|
-
* @property {string} [currency]
|
|
188
|
-
* @property {boolean} [paid]
|
|
189
|
-
* @property {number} [attemp]
|
|
190
|
-
* @property {string} [_id]
|
|
191
|
-
* @property {string} [collection_method]
|
|
192
|
-
* @property {string} [subscriber_id]
|
|
193
|
-
* @property {string} [invoice_url]
|
|
194
|
-
* @property {string} [number]
|
|
195
|
-
* @property {Object} [pg_data]
|
|
196
|
-
* @property {string} [receipt_number]
|
|
197
|
-
* @property {string} [statement_descriptor]
|
|
198
|
-
* @property {string} [current_status]
|
|
199
|
-
* @property {InvoiceDetailsStatusTrail[]} [status_trail]
|
|
200
|
-
* @property {number} [subtotal]
|
|
201
|
-
* @property {number} [total]
|
|
202
|
-
* @property {string} [subscription]
|
|
203
|
-
* @property {string} [next_action_time]
|
|
204
|
-
* @property {string} [created_at]
|
|
205
|
-
* @property {string} [modified_at]
|
|
206
|
-
* @property {string} [hash_identifier]
|
|
207
|
-
* @property {InvoicePaymentMethod} [payment_method]
|
|
208
|
-
*/
|
|
209
295
|
/**
|
|
210
296
|
* @typedef InvoiceItemsPlanRecurring
|
|
211
297
|
* @property {string} [interval]
|
|
@@ -254,11 +340,6 @@ export = BillingPlatformModel;
|
|
|
254
340
|
* @property {string} [created_at]
|
|
255
341
|
* @property {string} [modified_at]
|
|
256
342
|
*/
|
|
257
|
-
/**
|
|
258
|
-
* @typedef Invoice
|
|
259
|
-
* @property {InvoiceDetails} [invoice]
|
|
260
|
-
* @property {InvoiceItems[]} [invoice_items]
|
|
261
|
-
*/
|
|
262
343
|
/**
|
|
263
344
|
* @typedef InvoicesDataClient
|
|
264
345
|
* @property {string} [name]
|
|
@@ -278,6 +359,13 @@ export = BillingPlatformModel;
|
|
|
278
359
|
/**
|
|
279
360
|
* @typedef InvoicesData
|
|
280
361
|
* @property {string} [_id]
|
|
362
|
+
* @property {Object} [documents]
|
|
363
|
+
* @property {Object} [payment]
|
|
364
|
+
* @property {number} [old_settlement]
|
|
365
|
+
* @property {number} [credit_balance]
|
|
366
|
+
* @property {Object} [discount]
|
|
367
|
+
* @property {Object} [taxation]
|
|
368
|
+
* @property {number} [credit_note_amount]
|
|
281
369
|
* @property {InvoicesDataClient} [client]
|
|
282
370
|
* @property {boolean} [auto_advance]
|
|
283
371
|
* @property {string} [currency]
|
|
@@ -338,6 +426,11 @@ export = BillingPlatformModel;
|
|
|
338
426
|
* @property {string} [created_at]
|
|
339
427
|
* @property {string} [modified_at]
|
|
340
428
|
* @property {Object} [data]
|
|
429
|
+
* @property {Object} [documents]
|
|
430
|
+
* @property {boolean} [consent]
|
|
431
|
+
* @property {boolean} [comms]
|
|
432
|
+
* @property {number} [credit_balance]
|
|
433
|
+
* @property {BusinessCountryInfo} [business_country_info]
|
|
341
434
|
*/
|
|
342
435
|
/**
|
|
343
436
|
* @typedef SubscriptionCustomerCreate
|
|
@@ -370,6 +463,7 @@ export = BillingPlatformModel;
|
|
|
370
463
|
*/
|
|
371
464
|
/**
|
|
372
465
|
* @typedef Subscription
|
|
466
|
+
* @property {Object} [meta]
|
|
373
467
|
* @property {SubscriptionCurrentPeriod} [current_period]
|
|
374
468
|
* @property {SubscriptionPauseCollection} [pause_collection]
|
|
375
469
|
* @property {SubscriptionTrial} [trial]
|
|
@@ -387,6 +481,9 @@ export = BillingPlatformModel;
|
|
|
387
481
|
* @property {string} [modified_at]
|
|
388
482
|
* @property {string} [latest_invoice]
|
|
389
483
|
* @property {string} [channel_type]
|
|
484
|
+
* @property {boolean} [freezed]
|
|
485
|
+
* @property {string} [cancel_at]
|
|
486
|
+
* @property {string} [canceled_at]
|
|
390
487
|
*/
|
|
391
488
|
/**
|
|
392
489
|
* @typedef SubscriptionStatus
|
|
@@ -395,7 +492,8 @@ export = BillingPlatformModel;
|
|
|
395
492
|
* @property {InvoicesData} [latest_invoice]
|
|
396
493
|
* @property {Plan} [next_plan]
|
|
397
494
|
* @property {Subscription[]} [current_subscriptions]
|
|
398
|
-
* @property {
|
|
495
|
+
* @property {number} [mandate_amount]
|
|
496
|
+
* @property {string} [message]
|
|
399
497
|
*/
|
|
400
498
|
/**
|
|
401
499
|
* @typedef SubscriptionLimitApplication
|
|
@@ -441,6 +539,18 @@ export = BillingPlatformModel;
|
|
|
441
539
|
* @property {SubscriptionLimitIntegrations} [integrations]
|
|
442
540
|
* @property {boolean} [is_trial_plan]
|
|
443
541
|
*/
|
|
542
|
+
/**
|
|
543
|
+
* @typedef IntentReq
|
|
544
|
+
* @property {string} [unique_external_id]
|
|
545
|
+
* @property {string} [plan_id]
|
|
546
|
+
*/
|
|
547
|
+
/**
|
|
548
|
+
* @typedef PutIntentReq
|
|
549
|
+
* @property {string} [unique_external_id]
|
|
550
|
+
* @property {string} [setup_intent_id]
|
|
551
|
+
* @property {string} [payment_method_id]
|
|
552
|
+
* @property {boolean} [set_default]
|
|
553
|
+
*/
|
|
444
554
|
/**
|
|
445
555
|
* @typedef SubscriptionActivateReq
|
|
446
556
|
* @property {string} [unique_id]
|
|
@@ -448,6 +558,9 @@ export = BillingPlatformModel;
|
|
|
448
558
|
* @property {string} [product_suite]
|
|
449
559
|
* @property {string} [plan_id]
|
|
450
560
|
* @property {string} [payment_method]
|
|
561
|
+
* @property {string} [subscription_id]
|
|
562
|
+
* @property {string} [coupon]
|
|
563
|
+
* @property {Object} [meta]
|
|
451
564
|
*/
|
|
452
565
|
/**
|
|
453
566
|
* @typedef SubscriptionActivateRes
|
|
@@ -494,41 +607,562 @@ export = BillingPlatformModel;
|
|
|
494
607
|
* @property {Meta} [meta]
|
|
495
608
|
*/
|
|
496
609
|
/**
|
|
497
|
-
* @typedef
|
|
610
|
+
* @typedef EntityDetail
|
|
611
|
+
* @property {string} [entity]
|
|
612
|
+
* @property {Subscription} [item]
|
|
613
|
+
*/
|
|
614
|
+
/**
|
|
615
|
+
* @typedef PaymentOptions
|
|
616
|
+
* @property {string} [_id]
|
|
498
617
|
* @property {string} [name]
|
|
499
|
-
* @property {string} [slug]
|
|
500
618
|
* @property {string} [description]
|
|
501
|
-
* @property {string} [
|
|
502
|
-
* @property {
|
|
503
|
-
* @property {string} [
|
|
619
|
+
* @property {string} [logo]
|
|
620
|
+
* @property {string} [aggregator_id]
|
|
621
|
+
* @property {string} [aggregator]
|
|
622
|
+
* @property {string} [created_at]
|
|
623
|
+
* @property {string} [modified_at]
|
|
624
|
+
* @property {number} [__v]
|
|
504
625
|
*/
|
|
505
626
|
/**
|
|
506
|
-
* @typedef
|
|
507
|
-
* @property {string
|
|
508
|
-
* @property {string
|
|
509
|
-
* @property {
|
|
510
|
-
* @property {
|
|
511
|
-
* @property {string} [
|
|
512
|
-
* @property {Object} [settle_cycle_period]
|
|
513
|
-
* @property {Object[]} [components]
|
|
627
|
+
* @typedef VerifyPaymentReq
|
|
628
|
+
* @property {string} [razorpay_payment_id]
|
|
629
|
+
* @property {string} [razorpay_order_id]
|
|
630
|
+
* @property {string} [razorpay_signature]
|
|
631
|
+
* @property {number} [status_code]
|
|
632
|
+
* @property {string} [provider_type]
|
|
514
633
|
*/
|
|
515
634
|
/**
|
|
516
|
-
* @typedef
|
|
517
|
-
* @property {
|
|
518
|
-
* @property {
|
|
635
|
+
* @typedef Documents
|
|
636
|
+
* @property {string} [pan]
|
|
637
|
+
* @property {string} [gst]
|
|
638
|
+
*/
|
|
639
|
+
/**
|
|
640
|
+
* @typedef BillingAddress
|
|
641
|
+
* @property {string} [country]
|
|
642
|
+
* @property {string} [state]
|
|
643
|
+
* @property {string} [city]
|
|
644
|
+
* @property {string} [line1]
|
|
645
|
+
* @property {string} [line2]
|
|
646
|
+
* @property {string} [postal_code]
|
|
647
|
+
* @property {string} [country_code]
|
|
648
|
+
*/
|
|
649
|
+
/**
|
|
650
|
+
* @typedef Currency
|
|
651
|
+
* @property {string} [code]
|
|
652
|
+
* @property {string} [symbol]
|
|
653
|
+
* @property {string} [name]
|
|
654
|
+
*/
|
|
655
|
+
/**
|
|
656
|
+
* @typedef BusinessCountryInfo
|
|
657
|
+
* @property {string} [country]
|
|
658
|
+
* @property {string} [country_code]
|
|
659
|
+
* @property {Currency} [currency]
|
|
660
|
+
* @property {string} [timezone]
|
|
661
|
+
*/
|
|
662
|
+
/**
|
|
663
|
+
* @typedef SubscriberData
|
|
664
|
+
* @property {boolean} [pg_user_exists]
|
|
665
|
+
* @property {Object} [id]
|
|
666
|
+
* @property {string} [pg_customer_id]
|
|
667
|
+
* @property {string} [default_payment_method]
|
|
668
|
+
*/
|
|
669
|
+
/**
|
|
670
|
+
* @typedef Subscriber
|
|
671
|
+
* @property {Documents} [documents]
|
|
672
|
+
* @property {Object} [phone]
|
|
673
|
+
* @property {BillingAddress} [billing_address]
|
|
674
|
+
* @property {boolean} [consent]
|
|
675
|
+
* @property {boolean} [comms]
|
|
676
|
+
* @property {string} [_id]
|
|
677
|
+
* @property {string} [type]
|
|
678
|
+
* @property {string} [unique_id]
|
|
679
|
+
* @property {string} [name]
|
|
680
|
+
* @property {string} [email]
|
|
681
|
+
* @property {BusinessCountryInfo} [business_country_info]
|
|
682
|
+
* @property {string} [created_at]
|
|
683
|
+
* @property {string} [modified_at]
|
|
684
|
+
* @property {number} [credit_balance]
|
|
685
|
+
* @property {SubscriberData} [data]
|
|
686
|
+
*/
|
|
687
|
+
/**
|
|
688
|
+
* @typedef Author
|
|
689
|
+
* @property {Object} [modified_by_details]
|
|
690
|
+
*/
|
|
691
|
+
/**
|
|
692
|
+
* @typedef EndingBalance
|
|
693
|
+
* @property {number} [amount]
|
|
694
|
+
* @property {string} [old_entry_ref]
|
|
519
695
|
*/
|
|
520
696
|
/**
|
|
521
|
-
* @typedef
|
|
697
|
+
* @typedef PaymentData
|
|
698
|
+
* @property {string} [transaction_id]
|
|
699
|
+
* @property {string} [aggregator]
|
|
700
|
+
* @property {string} [aggregator_order_id]
|
|
701
|
+
*/
|
|
702
|
+
/**
|
|
703
|
+
* @typedef CreditTransaction
|
|
704
|
+
* @property {Object} [entity]
|
|
705
|
+
* @property {Author} [author]
|
|
706
|
+
* @property {string} [_id]
|
|
707
|
+
* @property {number} [amount]
|
|
708
|
+
* @property {string} [currency]
|
|
709
|
+
* @property {string} [subscriber_id]
|
|
710
|
+
* @property {string} [description]
|
|
711
|
+
* @property {Object} [is_test]
|
|
712
|
+
* @property {EndingBalance} [ending_balance]
|
|
713
|
+
* @property {PaymentData} [payment]
|
|
714
|
+
* @property {string} [type]
|
|
715
|
+
* @property {string} [created_at]
|
|
716
|
+
* @property {string} [modified_at]
|
|
717
|
+
*/
|
|
718
|
+
/**
|
|
719
|
+
* @typedef VerifyPaymentData
|
|
522
720
|
* @property {boolean} [success]
|
|
523
|
-
* @property {
|
|
524
|
-
* @property {
|
|
525
|
-
|
|
721
|
+
* @property {Subscriber} [subscriber]
|
|
722
|
+
* @property {CreditTransaction} [credit_transaction]
|
|
723
|
+
*/
|
|
724
|
+
/**
|
|
725
|
+
* @typedef VerifyPaymentRes
|
|
726
|
+
* @property {string} [status]
|
|
727
|
+
* @property {VerifyPaymentData} [data]
|
|
728
|
+
*/
|
|
729
|
+
/**
|
|
730
|
+
* @typedef DefaultMerchants
|
|
731
|
+
* @property {string} [stripe]
|
|
732
|
+
*/
|
|
733
|
+
/**
|
|
734
|
+
* @typedef GlobalSettingsPayment
|
|
735
|
+
* @property {DefaultMerchants} [default_merchants]
|
|
736
|
+
*/
|
|
737
|
+
/**
|
|
738
|
+
* @typedef GlobalSettingsData
|
|
739
|
+
* @property {GlobalSettingsPayment} [payment]
|
|
740
|
+
* @property {boolean} [freeze_panel]
|
|
741
|
+
* @property {string} [_id]
|
|
742
|
+
* @property {string} [created_at]
|
|
743
|
+
* @property {string} [modified_at]
|
|
744
|
+
*/
|
|
745
|
+
/**
|
|
746
|
+
* @typedef GlobalSettings
|
|
747
|
+
* @property {string} [status]
|
|
748
|
+
* @property {GlobalSettingsData} [data]
|
|
749
|
+
*/
|
|
750
|
+
/**
|
|
751
|
+
* @typedef MethodChecks
|
|
752
|
+
* @property {string} [address_line1_check]
|
|
753
|
+
* @property {string} [address_postal_code_check]
|
|
754
|
+
* @property {string} [cvc_check]
|
|
755
|
+
*/
|
|
756
|
+
/**
|
|
757
|
+
* @typedef MethodNetworks
|
|
758
|
+
* @property {string[]} [available]
|
|
759
|
+
* @property {string} [preferred]
|
|
760
|
+
*/
|
|
761
|
+
/**
|
|
762
|
+
* @typedef MethodSecureUsage
|
|
763
|
+
* @property {boolean} [supported]
|
|
764
|
+
*/
|
|
765
|
+
/**
|
|
766
|
+
* @typedef MethodDetails
|
|
767
|
+
* @property {string} [id]
|
|
768
|
+
* @property {string} [type]
|
|
769
|
+
* @property {boolean} [mandate_available]
|
|
770
|
+
* @property {number} [mandate_amount]
|
|
771
|
+
* @property {string} [pg_payment_method_id]
|
|
772
|
+
* @property {boolean} [is_default]
|
|
773
|
+
* @property {SubscriptionMethodData} [data]
|
|
774
|
+
*/
|
|
775
|
+
/**
|
|
776
|
+
* @typedef SubscriptionMethodData
|
|
777
|
+
* @property {string} [brand]
|
|
778
|
+
* @property {MethodChecks} [checks]
|
|
779
|
+
* @property {string} [country]
|
|
780
|
+
* @property {number} [exp_month]
|
|
781
|
+
* @property {number} [exp_year]
|
|
782
|
+
* @property {string} [fingerprint]
|
|
783
|
+
* @property {string} [funding]
|
|
784
|
+
* @property {string} [generated_from]
|
|
785
|
+
* @property {string} [last4]
|
|
786
|
+
* @property {MethodNetworks} [networks]
|
|
787
|
+
* @property {MethodSecureUsage} [three_d_secure_usage]
|
|
788
|
+
* @property {string} [wallet]
|
|
789
|
+
* @property {string} [name]
|
|
790
|
+
* @property {boolean} [is_default]
|
|
791
|
+
*/
|
|
792
|
+
/**
|
|
793
|
+
* @typedef SubscriptionMethods
|
|
794
|
+
* @property {boolean} [success]
|
|
795
|
+
* @property {MethodDetails[]} [data]
|
|
796
|
+
*/
|
|
797
|
+
/**
|
|
798
|
+
* @typedef ConfigPublicKey
|
|
799
|
+
* @property {string} [public_key]
|
|
800
|
+
*/
|
|
801
|
+
/**
|
|
802
|
+
* @typedef ConfigRes
|
|
803
|
+
* @property {boolean} [success]
|
|
804
|
+
* @property {string} [aggregator]
|
|
805
|
+
* @property {ConfigPublicKey} [config]
|
|
806
|
+
*/
|
|
807
|
+
/**
|
|
808
|
+
* @typedef PlanChangeData
|
|
809
|
+
* @property {number} [total]
|
|
810
|
+
* @property {number} [credit_note_amount]
|
|
811
|
+
* @property {number} [settlement]
|
|
812
|
+
* @property {number} [taxable_amount]
|
|
813
|
+
* @property {number} [gst_amount]
|
|
814
|
+
* @property {number} [gross_total]
|
|
815
|
+
* @property {number} [gst]
|
|
816
|
+
* @property {number} [discount]
|
|
817
|
+
*/
|
|
818
|
+
/**
|
|
819
|
+
* @typedef PlanChangeDetails
|
|
820
|
+
* @property {string} [status]
|
|
821
|
+
* @property {PlanChangeData} [data]
|
|
822
|
+
*/
|
|
823
|
+
/**
|
|
824
|
+
* @typedef TransactionMeta
|
|
825
|
+
* @property {string} [invoice_id]
|
|
826
|
+
*/
|
|
827
|
+
/**
|
|
828
|
+
* @typedef PaymentTransactionDetails
|
|
829
|
+
* @property {Object} [aggregator]
|
|
830
|
+
* @property {string} [currency]
|
|
831
|
+
* @property {string} [current_status]
|
|
832
|
+
* @property {string} [_id]
|
|
833
|
+
* @property {string} [subscriber_id]
|
|
834
|
+
* @property {number} [amount]
|
|
835
|
+
* @property {string} [entity_type]
|
|
836
|
+
* @property {string} [collection_type]
|
|
837
|
+
* @property {TransactionMeta} [meta]
|
|
838
|
+
* @property {string} [created_at]
|
|
839
|
+
* @property {string} [modified_at]
|
|
840
|
+
*/
|
|
841
|
+
/**
|
|
842
|
+
* @typedef PaymentItems
|
|
843
|
+
* @property {string} [name]
|
|
844
|
+
* @property {string} [code]
|
|
845
|
+
* @property {string} [aggregator]
|
|
846
|
+
*/
|
|
847
|
+
/**
|
|
848
|
+
* @typedef GetPaymentOptions
|
|
849
|
+
* @property {PaymentItems[]} [payment_options]
|
|
850
|
+
*/
|
|
851
|
+
/**
|
|
852
|
+
* @typedef TopupReq
|
|
853
|
+
* @property {number} [amount]
|
|
854
|
+
* @property {string} [currency]
|
|
855
|
+
* @property {string} [provider_type]
|
|
856
|
+
*/
|
|
857
|
+
/**
|
|
858
|
+
* @typedef SetupMandateReq
|
|
859
|
+
* @property {string} [intent_id]
|
|
860
|
+
* @property {string} [payment_method_id]
|
|
861
|
+
*/
|
|
862
|
+
/**
|
|
863
|
+
* @typedef SetupPaymentReq
|
|
864
|
+
* @property {string} [payment_method]
|
|
865
|
+
* @property {string} [payment_id]
|
|
866
|
+
* @property {string} [plan_id]
|
|
867
|
+
* @property {string} [invoice_id]
|
|
868
|
+
*/
|
|
869
|
+
/**
|
|
870
|
+
* @typedef SubscriptionRenewReq
|
|
871
|
+
* @property {string} [invoice_id]
|
|
872
|
+
* @property {string} [entity_type]
|
|
873
|
+
* @property {string} [collection_type]
|
|
874
|
+
* @property {string} [callback_url]
|
|
875
|
+
* @property {RenewMeta} [meta]
|
|
876
|
+
*/
|
|
877
|
+
/**
|
|
878
|
+
* @typedef RenewMeta
|
|
879
|
+
* @property {boolean} [invoice_payment]
|
|
880
|
+
* @property {boolean} [renew]
|
|
881
|
+
*/
|
|
882
|
+
/**
|
|
883
|
+
* @typedef SubscriptionMethodsReq
|
|
884
|
+
* @property {string} [unique_external_id]
|
|
885
|
+
* @property {string} [setup_intent_id]
|
|
886
|
+
* @property {string} [pg_payment_method_id]
|
|
887
|
+
* @property {boolean} [set_default]
|
|
888
|
+
*/
|
|
889
|
+
/**
|
|
890
|
+
* @typedef CreditTransactionResponse
|
|
891
|
+
* @property {number} [total] - Total number of transactions
|
|
892
|
+
* @property {number} [limit] - Maximum number of transactions per page
|
|
893
|
+
* @property {number} [page] - Current page number
|
|
894
|
+
* @property {number} [pages] - Total number of pages
|
|
895
|
+
* @property {CreditTransaction[]} [items]
|
|
896
|
+
*/
|
|
897
|
+
/**
|
|
898
|
+
* @typedef DowngradePlanReq
|
|
899
|
+
* @property {string} [unique_id]
|
|
900
|
+
* @property {string} [type]
|
|
901
|
+
* @property {string} [product_suite]
|
|
902
|
+
* @property {string} [plan_id]
|
|
903
|
+
* @property {string} [reason]
|
|
904
|
+
* @property {string} [platform]
|
|
905
|
+
*/
|
|
906
|
+
/**
|
|
907
|
+
* @typedef Taxation
|
|
908
|
+
* @property {number} [gst] - GST percentage
|
|
909
|
+
*/
|
|
910
|
+
/**
|
|
911
|
+
* @typedef OneTimeFees
|
|
912
|
+
* @property {number} [developement]
|
|
913
|
+
* @property {number} [marketing]
|
|
914
|
+
*/
|
|
915
|
+
/**
|
|
916
|
+
* @typedef CreditLine
|
|
917
|
+
* @property {boolean} [is_active]
|
|
918
|
+
*/
|
|
919
|
+
/**
|
|
920
|
+
* @typedef StatusMessage
|
|
921
|
+
* @property {string} [status]
|
|
922
|
+
* @property {string} [message]
|
|
923
|
+
* @property {boolean} [success]
|
|
924
|
+
* @property {string} [code]
|
|
925
|
+
*/
|
|
926
|
+
/**
|
|
927
|
+
* @typedef PaymentCollectReq
|
|
928
|
+
* @property {string} [transaction_id]
|
|
929
|
+
* @property {boolean} [credit_balance]
|
|
930
|
+
* @property {string} [payment_mode]
|
|
931
|
+
* @property {string} [payment_method]
|
|
932
|
+
* @property {string} [invoice_id]
|
|
933
|
+
*/
|
|
934
|
+
/**
|
|
935
|
+
* @typedef SubscriptionRenewResMeta
|
|
936
|
+
* @property {boolean} [invoice_payment]
|
|
937
|
+
* @property {boolean} [renew]
|
|
938
|
+
*/
|
|
939
|
+
/**
|
|
940
|
+
* @typedef SubscriptionRenewRes
|
|
941
|
+
* @property {string} [redirect_url]
|
|
942
|
+
* @property {string} [transaction_id]
|
|
943
|
+
* @property {string} [current_status]
|
|
944
|
+
* @property {SubscriptionRenewResMeta} [meta]
|
|
945
|
+
*/
|
|
946
|
+
/**
|
|
947
|
+
* @typedef SetupIntentRes
|
|
948
|
+
* @property {boolean} [success]
|
|
949
|
+
* @property {SetupIntentData} [data]
|
|
950
|
+
*/
|
|
951
|
+
/**
|
|
952
|
+
* @typedef SetupIntentData
|
|
953
|
+
* @property {string} [id]
|
|
954
|
+
* @property {string} [client_secret]
|
|
955
|
+
* @property {Object} [customer]
|
|
956
|
+
* @property {string} [status]
|
|
957
|
+
*/
|
|
958
|
+
/**
|
|
959
|
+
* @typedef SetupPayment
|
|
960
|
+
* @property {string} [id]
|
|
961
|
+
* @property {string} [status]
|
|
962
|
+
* @property {Object} [customer]
|
|
963
|
+
* @property {string} [client_secret]
|
|
964
|
+
* @property {string} [payment_method]
|
|
965
|
+
* @property {string} [mandate]
|
|
966
|
+
* @property {PaymentMethodOptions} [payment_method_options]
|
|
967
|
+
*/
|
|
968
|
+
/**
|
|
969
|
+
* @typedef PaymentMethodOptions
|
|
970
|
+
* @property {Card} [card]
|
|
971
|
+
*/
|
|
972
|
+
/**
|
|
973
|
+
* @typedef Card
|
|
974
|
+
* @property {MandateOptions} [mandate_options]
|
|
975
|
+
*/
|
|
976
|
+
/**
|
|
977
|
+
* @typedef MandateOptions
|
|
978
|
+
* @property {number} [amount]
|
|
979
|
+
*/
|
|
980
|
+
/**
|
|
981
|
+
* @typedef Message
|
|
982
|
+
* @property {string} [message]
|
|
983
|
+
*/
|
|
984
|
+
/**
|
|
985
|
+
* @typedef TopupRes
|
|
986
|
+
* @property {string} [status]
|
|
987
|
+
* @property {string} [aggregator_order_id]
|
|
988
|
+
* @property {number} [amount]
|
|
989
|
+
* @property {string} [currency]
|
|
990
|
+
* @property {string} [transaction_id]
|
|
991
|
+
*/
|
|
992
|
+
/**
|
|
993
|
+
* @typedef CancelTopupReq
|
|
994
|
+
* @property {string} [order_id]
|
|
995
|
+
*/
|
|
996
|
+
/**
|
|
997
|
+
* @typedef CancelTopupRes
|
|
998
|
+
* @property {string} [_id]
|
|
999
|
+
* @property {string} [subscriber_id]
|
|
1000
|
+
* @property {number} [amount]
|
|
1001
|
+
* @property {string} [currency]
|
|
1002
|
+
* @property {string} [aggregator]
|
|
1003
|
+
* @property {string} [aggregator_order_id]
|
|
1004
|
+
* @property {string} [created_at]
|
|
1005
|
+
* @property {string} [modified_at]
|
|
1006
|
+
* @property {number} [__v]
|
|
1007
|
+
* @property {string} [aggregator_status]
|
|
1008
|
+
* @property {string} [current_status]
|
|
1009
|
+
*/
|
|
1010
|
+
/**
|
|
1011
|
+
* @typedef DefaultReq
|
|
1012
|
+
* @property {string} [payment_method_id]
|
|
526
1013
|
*/
|
|
527
1014
|
declare class BillingPlatformModel {
|
|
528
1015
|
}
|
|
529
1016
|
declare namespace BillingPlatformModel {
|
|
530
|
-
export {
|
|
1017
|
+
export { CompanyInfo, AddressDetails, InvoiceData, InvoiceDetailsData, Client, Period, StatusTrail, PaymentCollectRes, SubscriptionChargeRes, PostDowngradeRes, DowngradeRes, PaymentStatusData, PaymentStatusResponse, BadRequest, ResourceNotFound, InternalServerError, CheckValidityResponse, PlanRecurring, PlanMeta, Plan, SubscriptionTrialPeriod, EntityChargePrice, OneTimeChargeItem, CreateOneTimeCharge, ChargeRecurring, ChargeDetails, OneTimeChargeEntity, CreateOneTimeChargeResponse, Charge, InvoiceDetailsStatusTrail, InvoiceItemsPlanRecurring, InvoiceItemsPlan, InvoiceItemsPeriod, InvoiceItems, InvoicesDataClient, InvoicesDataPeriod, InvoicesDataPaymentMethod, InvoicesData, Invoices, Phone, SubscriptionBillingAddress, SubscriptionCustomer, SubscriptionCustomerCreate, SubscriptionCurrentPeriod, SubscriptionPauseCollection, SubscriptionTrial, SubscriptionInvoiceSettings, Subscription, SubscriptionStatus, SubscriptionLimitApplication, SubscriptionLimitMarketplace, SubscriptionLimitOtherPlatform, SubscriptionLimitTeam, SubscriptionLimitProducts, SubscriptionLimitExtensions, SubscriptionLimitIntegrations, SubscriptionLimit, IntentReq, PutIntentReq, SubscriptionActivateReq, SubscriptionActivateRes, CancelSubscriptionReq, CancelSubscriptionRes, PlanStatusUpdateReq, SunscribePlan, Meta, SubscribePlanRes, EntityDetail, PaymentOptions, VerifyPaymentReq, Documents, BillingAddress, Currency, BusinessCountryInfo, SubscriberData, Subscriber, Author, EndingBalance, PaymentData, CreditTransaction, VerifyPaymentData, VerifyPaymentRes, DefaultMerchants, GlobalSettingsPayment, GlobalSettingsData, GlobalSettings, MethodChecks, MethodNetworks, MethodSecureUsage, MethodDetails, SubscriptionMethodData, SubscriptionMethods, ConfigPublicKey, ConfigRes, PlanChangeData, PlanChangeDetails, TransactionMeta, PaymentTransactionDetails, PaymentItems, GetPaymentOptions, TopupReq, SetupMandateReq, SetupPaymentReq, SubscriptionRenewReq, RenewMeta, SubscriptionMethodsReq, CreditTransactionResponse, DowngradePlanReq, Taxation, OneTimeFees, CreditLine, StatusMessage, PaymentCollectReq, SubscriptionRenewResMeta, SubscriptionRenewRes, SetupIntentRes, SetupIntentData, SetupPayment, PaymentMethodOptions, Card, MandateOptions, Message, TopupRes, CancelTopupReq, CancelTopupRes, DefaultReq };
|
|
531
1018
|
}
|
|
1019
|
+
/** @returns {CompanyInfo} */
|
|
1020
|
+
declare function CompanyInfo(): CompanyInfo;
|
|
1021
|
+
type CompanyInfo = {
|
|
1022
|
+
company_name?: string;
|
|
1023
|
+
gstin?: string;
|
|
1024
|
+
address?: string;
|
|
1025
|
+
address_details?: AddressDetails;
|
|
1026
|
+
pan?: string;
|
|
1027
|
+
phone?: string;
|
|
1028
|
+
email?: string;
|
|
1029
|
+
cin?: string;
|
|
1030
|
+
};
|
|
1031
|
+
/** @returns {AddressDetails} */
|
|
1032
|
+
declare function AddressDetails(): AddressDetails;
|
|
1033
|
+
type AddressDetails = {
|
|
1034
|
+
address_line_1?: string;
|
|
1035
|
+
address_line_2?: string;
|
|
1036
|
+
city?: string;
|
|
1037
|
+
pincode?: string;
|
|
1038
|
+
state?: string;
|
|
1039
|
+
country?: string;
|
|
1040
|
+
};
|
|
1041
|
+
/** @returns {InvoiceData} */
|
|
1042
|
+
declare function InvoiceData(): InvoiceData;
|
|
1043
|
+
type InvoiceData = {
|
|
1044
|
+
invoice?: InvoiceDetailsData;
|
|
1045
|
+
invoice_items?: InvoiceItems[];
|
|
1046
|
+
shopsense_details?: CompanyInfo;
|
|
1047
|
+
};
|
|
1048
|
+
/** @returns {InvoiceDetailsData} */
|
|
1049
|
+
declare function InvoiceDetailsData(): InvoiceDetailsData;
|
|
1050
|
+
type InvoiceDetailsData = {
|
|
1051
|
+
attemp?: number;
|
|
1052
|
+
documents?: any;
|
|
1053
|
+
payment?: any;
|
|
1054
|
+
period?: Period;
|
|
1055
|
+
client?: Client;
|
|
1056
|
+
discount?: any;
|
|
1057
|
+
taxation?: any;
|
|
1058
|
+
_id?: string;
|
|
1059
|
+
auto_advance?: boolean;
|
|
1060
|
+
collection_method?: string;
|
|
1061
|
+
subscriber_id?: string;
|
|
1062
|
+
currency?: string;
|
|
1063
|
+
invoice_url?: string;
|
|
1064
|
+
number?: string;
|
|
1065
|
+
paid?: boolean;
|
|
1066
|
+
pg_data?: any;
|
|
1067
|
+
receipt_number?: string;
|
|
1068
|
+
statement_descriptor?: string;
|
|
1069
|
+
current_status?: string;
|
|
1070
|
+
status_trail?: StatusTrail[];
|
|
1071
|
+
subtotal?: number;
|
|
1072
|
+
total?: number;
|
|
1073
|
+
old_settlement?: number;
|
|
1074
|
+
credit_balance?: number;
|
|
1075
|
+
subscription?: string;
|
|
1076
|
+
attempt?: number;
|
|
1077
|
+
next_action_time?: string;
|
|
1078
|
+
credit_note_amount?: number;
|
|
1079
|
+
created_at?: string;
|
|
1080
|
+
modified_at?: string;
|
|
1081
|
+
};
|
|
1082
|
+
/** @returns {Client} */
|
|
1083
|
+
declare function Client(): Client;
|
|
1084
|
+
type Client = {
|
|
1085
|
+
name?: string;
|
|
1086
|
+
email?: string;
|
|
1087
|
+
phone?: string;
|
|
1088
|
+
address_lines?: string[];
|
|
1089
|
+
};
|
|
1090
|
+
/** @returns {Period} */
|
|
1091
|
+
declare function Period(): Period;
|
|
1092
|
+
type Period = {
|
|
1093
|
+
start?: string;
|
|
1094
|
+
end?: string;
|
|
1095
|
+
};
|
|
1096
|
+
/** @returns {StatusTrail} */
|
|
1097
|
+
declare function StatusTrail(): StatusTrail;
|
|
1098
|
+
type StatusTrail = {
|
|
1099
|
+
value?: string;
|
|
1100
|
+
timestamp?: string;
|
|
1101
|
+
_id?: string;
|
|
1102
|
+
};
|
|
1103
|
+
/** @returns {PaymentCollectRes} */
|
|
1104
|
+
declare function PaymentCollectRes(): PaymentCollectRes;
|
|
1105
|
+
type PaymentCollectRes = {
|
|
1106
|
+
transaction_id?: string;
|
|
1107
|
+
current_status?: string;
|
|
1108
|
+
};
|
|
1109
|
+
/** @returns {SubscriptionChargeRes} */
|
|
1110
|
+
declare function SubscriptionChargeRes(): SubscriptionChargeRes;
|
|
1111
|
+
type SubscriptionChargeRes = {
|
|
1112
|
+
_id?: string;
|
|
1113
|
+
product_suit_id?: string;
|
|
1114
|
+
entity_id?: string;
|
|
1115
|
+
entity_type?: string;
|
|
1116
|
+
name?: string;
|
|
1117
|
+
status?: string;
|
|
1118
|
+
trial_days?: number;
|
|
1119
|
+
activated_on?: string;
|
|
1120
|
+
cancelled_on?: string;
|
|
1121
|
+
is_test?: boolean;
|
|
1122
|
+
created_at?: string;
|
|
1123
|
+
modified_at?: string;
|
|
1124
|
+
company_id?: string;
|
|
1125
|
+
line_items?: any[];
|
|
1126
|
+
};
|
|
1127
|
+
/** @returns {PostDowngradeRes} */
|
|
1128
|
+
declare function PostDowngradeRes(): PostDowngradeRes;
|
|
1129
|
+
type PostDowngradeRes = {
|
|
1130
|
+
success?: boolean;
|
|
1131
|
+
data?: DowngradeRes;
|
|
1132
|
+
};
|
|
1133
|
+
/** @returns {DowngradeRes} */
|
|
1134
|
+
declare function DowngradeRes(): DowngradeRes;
|
|
1135
|
+
type DowngradeRes = {
|
|
1136
|
+
_id?: string;
|
|
1137
|
+
status?: string;
|
|
1138
|
+
subscriber_id?: string;
|
|
1139
|
+
activated?: boolean;
|
|
1140
|
+
created_at?: string;
|
|
1141
|
+
modified_at?: string;
|
|
1142
|
+
plan_id?: string;
|
|
1143
|
+
reason?: string;
|
|
1144
|
+
request_user_id?: string;
|
|
1145
|
+
subscription_id?: string;
|
|
1146
|
+
};
|
|
1147
|
+
/** @returns {PaymentStatusData} */
|
|
1148
|
+
declare function PaymentStatusData(): PaymentStatusData;
|
|
1149
|
+
type PaymentStatusData = {
|
|
1150
|
+
_id?: string;
|
|
1151
|
+
journey?: string;
|
|
1152
|
+
webhook_response?: any[];
|
|
1153
|
+
aggregator_status?: string;
|
|
1154
|
+
current_status?: string;
|
|
1155
|
+
created_at?: string;
|
|
1156
|
+
modified_at?: string;
|
|
1157
|
+
__v?: number;
|
|
1158
|
+
aggregator_order_id?: string;
|
|
1159
|
+
};
|
|
1160
|
+
/** @returns {PaymentStatusResponse} */
|
|
1161
|
+
declare function PaymentStatusResponse(): PaymentStatusResponse;
|
|
1162
|
+
type PaymentStatusResponse = {
|
|
1163
|
+
status?: string;
|
|
1164
|
+
data?: PaymentStatusData;
|
|
1165
|
+
};
|
|
532
1166
|
/** @returns {BadRequest} */
|
|
533
1167
|
declare function BadRequest(): BadRequest;
|
|
534
1168
|
type BadRequest = {
|
|
@@ -544,6 +1178,8 @@ type ResourceNotFound = {
|
|
|
544
1178
|
* - Resource not found with {id}
|
|
545
1179
|
*/
|
|
546
1180
|
message?: string;
|
|
1181
|
+
code?: any;
|
|
1182
|
+
success?: any;
|
|
547
1183
|
};
|
|
548
1184
|
/** @returns {InternalServerError} */
|
|
549
1185
|
declare function InternalServerError(): InternalServerError;
|
|
@@ -569,9 +1205,17 @@ type PlanRecurring = {
|
|
|
569
1205
|
interval?: string;
|
|
570
1206
|
interval_count?: number;
|
|
571
1207
|
};
|
|
1208
|
+
/** @returns {PlanMeta} */
|
|
1209
|
+
declare function PlanMeta(): PlanMeta;
|
|
1210
|
+
type PlanMeta = {
|
|
1211
|
+
seller_status?: string;
|
|
1212
|
+
company?: string;
|
|
1213
|
+
plan_platform_display_name?: string;
|
|
1214
|
+
};
|
|
572
1215
|
/** @returns {Plan} */
|
|
573
1216
|
declare function Plan(): Plan;
|
|
574
1217
|
type Plan = {
|
|
1218
|
+
fee_components?: any[];
|
|
575
1219
|
recurring?: PlanRecurring;
|
|
576
1220
|
is_trial_plan?: boolean;
|
|
577
1221
|
plan_group?: string;
|
|
@@ -591,6 +1235,16 @@ type Plan = {
|
|
|
591
1235
|
product_suite_id?: string;
|
|
592
1236
|
created_at?: string;
|
|
593
1237
|
modified_at?: string;
|
|
1238
|
+
taxation?: Taxation;
|
|
1239
|
+
one_time_fees?: OneTimeFees;
|
|
1240
|
+
credit_line?: CreditLine;
|
|
1241
|
+
current_status?: string;
|
|
1242
|
+
channel_type?: string;
|
|
1243
|
+
company_ids?: any[];
|
|
1244
|
+
platform?: string;
|
|
1245
|
+
activated_on?: string;
|
|
1246
|
+
meta?: PlanMeta;
|
|
1247
|
+
created_by?: string;
|
|
594
1248
|
};
|
|
595
1249
|
/** @returns {SubscriptionTrialPeriod} */
|
|
596
1250
|
declare function SubscriptionTrialPeriod(): SubscriptionTrialPeriod;
|
|
@@ -604,43 +1258,16 @@ type EntityChargePrice = {
|
|
|
604
1258
|
/**
|
|
605
1259
|
* - Amount for price. Minimum value 1
|
|
606
1260
|
*/
|
|
607
|
-
amount
|
|
608
|
-
currency_code
|
|
609
|
-
};
|
|
610
|
-
/** @returns {EntityChargeRecurring} */
|
|
611
|
-
declare function EntityChargeRecurring(): EntityChargeRecurring;
|
|
612
|
-
type EntityChargeRecurring = {
|
|
613
|
-
interval: string;
|
|
614
|
-
};
|
|
615
|
-
/** @returns {ChargeLineItem} */
|
|
616
|
-
declare function ChargeLineItem(): ChargeLineItem;
|
|
617
|
-
type ChargeLineItem = {
|
|
618
|
-
name: string;
|
|
619
|
-
term: string;
|
|
620
|
-
pricing_type: string;
|
|
621
|
-
price: EntityChargePrice;
|
|
622
|
-
recurring?: EntityChargeRecurring;
|
|
623
|
-
capped_amount?: number;
|
|
624
|
-
trial_days?: number;
|
|
625
|
-
is_test?: boolean;
|
|
626
|
-
metadata?: any;
|
|
627
|
-
};
|
|
628
|
-
/** @returns {CreateSubscriptionCharge} */
|
|
629
|
-
declare function CreateSubscriptionCharge(): CreateSubscriptionCharge;
|
|
630
|
-
type CreateSubscriptionCharge = {
|
|
631
|
-
name: string;
|
|
632
|
-
trial_days?: number;
|
|
633
|
-
line_items: ChargeLineItem[];
|
|
634
|
-
is_test?: boolean;
|
|
635
|
-
return_url: string;
|
|
1261
|
+
amount?: number;
|
|
1262
|
+
currency_code?: string;
|
|
636
1263
|
};
|
|
637
1264
|
/** @returns {OneTimeChargeItem} */
|
|
638
1265
|
declare function OneTimeChargeItem(): OneTimeChargeItem;
|
|
639
1266
|
type OneTimeChargeItem = {
|
|
640
|
-
name
|
|
1267
|
+
name?: string;
|
|
641
1268
|
term?: string;
|
|
642
|
-
pricing_type
|
|
643
|
-
price
|
|
1269
|
+
pricing_type?: string;
|
|
1270
|
+
price?: EntityChargePrice;
|
|
644
1271
|
capped_amount?: number;
|
|
645
1272
|
is_test?: boolean;
|
|
646
1273
|
metadata?: any;
|
|
@@ -648,55 +1275,52 @@ type OneTimeChargeItem = {
|
|
|
648
1275
|
/** @returns {CreateOneTimeCharge} */
|
|
649
1276
|
declare function CreateOneTimeCharge(): CreateOneTimeCharge;
|
|
650
1277
|
type CreateOneTimeCharge = {
|
|
651
|
-
name
|
|
652
|
-
charge
|
|
1278
|
+
name?: string;
|
|
1279
|
+
charge?: OneTimeChargeItem;
|
|
653
1280
|
is_test?: boolean;
|
|
654
|
-
return_url
|
|
1281
|
+
return_url?: string;
|
|
655
1282
|
};
|
|
656
|
-
/** @returns {
|
|
657
|
-
declare function
|
|
658
|
-
type
|
|
659
|
-
|
|
660
|
-
|
|
1283
|
+
/** @returns {ChargeRecurring} */
|
|
1284
|
+
declare function ChargeRecurring(): ChargeRecurring;
|
|
1285
|
+
type ChargeRecurring = {
|
|
1286
|
+
interval?: string;
|
|
1287
|
+
interval_time?: number;
|
|
661
1288
|
};
|
|
662
|
-
/** @returns {
|
|
663
|
-
declare function
|
|
664
|
-
type
|
|
1289
|
+
/** @returns {ChargeDetails} */
|
|
1290
|
+
declare function ChargeDetails(): ChargeDetails;
|
|
1291
|
+
type ChargeDetails = {
|
|
665
1292
|
_id?: string;
|
|
1293
|
+
entity_type?: string;
|
|
1294
|
+
entity_id?: string;
|
|
666
1295
|
name?: string;
|
|
667
|
-
/**
|
|
668
|
-
* - Brief description for a charge
|
|
669
|
-
*/
|
|
670
1296
|
term?: string;
|
|
1297
|
+
charge_type?: string;
|
|
671
1298
|
pricing_type?: string;
|
|
672
1299
|
price?: EntityChargePrice;
|
|
673
|
-
recurring?:
|
|
1300
|
+
recurring?: ChargeRecurring;
|
|
1301
|
+
status?: string;
|
|
674
1302
|
capped_amount?: number;
|
|
675
1303
|
activated_on?: string;
|
|
676
1304
|
cancelled_on?: string;
|
|
677
1305
|
billing_date?: string;
|
|
678
|
-
current_period?:
|
|
679
|
-
|
|
1306
|
+
current_period?: SubscriptionTrialPeriod;
|
|
1307
|
+
modified_at?: string;
|
|
1308
|
+
created_at?: string;
|
|
680
1309
|
is_test?: boolean;
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
declare function EntitySubscription(): EntitySubscription;
|
|
685
|
-
type EntitySubscription = {
|
|
686
|
-
_id?: string;
|
|
687
|
-
name?: string;
|
|
688
|
-
status?: string;
|
|
689
|
-
company_id?: number;
|
|
690
|
-
activated_on?: string;
|
|
691
|
-
cancelled_on?: string;
|
|
692
|
-
trial_days?: number;
|
|
693
|
-
trial_period?: SubscriptionTrialPeriod;
|
|
694
|
-
metadata?: any;
|
|
695
|
-
line_items?: SubscriptionCharge[];
|
|
1310
|
+
company_id?: string;
|
|
1311
|
+
meta?: any;
|
|
1312
|
+
__v?: number;
|
|
696
1313
|
};
|
|
697
1314
|
/** @returns {OneTimeChargeEntity} */
|
|
698
1315
|
declare function OneTimeChargeEntity(): OneTimeChargeEntity;
|
|
699
1316
|
type OneTimeChargeEntity = {
|
|
1317
|
+
term?: string;
|
|
1318
|
+
charge_type?: string;
|
|
1319
|
+
capped_amount?: number;
|
|
1320
|
+
billing_date?: string;
|
|
1321
|
+
created_at?: string;
|
|
1322
|
+
modified_at?: string;
|
|
1323
|
+
__v?: number;
|
|
700
1324
|
_id?: string;
|
|
701
1325
|
name?: string;
|
|
702
1326
|
status?: string;
|
|
@@ -715,28 +1339,13 @@ type OneTimeChargeEntity = {
|
|
|
715
1339
|
/** @returns {CreateOneTimeChargeResponse} */
|
|
716
1340
|
declare function CreateOneTimeChargeResponse(): CreateOneTimeChargeResponse;
|
|
717
1341
|
type CreateOneTimeChargeResponse = {
|
|
718
|
-
charge?:
|
|
719
|
-
confirm_url?: string;
|
|
720
|
-
};
|
|
721
|
-
/** @returns {CreateSubscriptionResponse} */
|
|
722
|
-
declare function CreateSubscriptionResponse(): CreateSubscriptionResponse;
|
|
723
|
-
type CreateSubscriptionResponse = {
|
|
724
|
-
subscription?: EntitySubscription;
|
|
1342
|
+
charge?: Charge;
|
|
725
1343
|
confirm_url?: string;
|
|
726
1344
|
};
|
|
727
|
-
/** @returns {
|
|
728
|
-
declare function
|
|
729
|
-
type
|
|
730
|
-
|
|
731
|
-
end?: string;
|
|
732
|
-
};
|
|
733
|
-
/** @returns {InvoiceDetailsClient} */
|
|
734
|
-
declare function InvoiceDetailsClient(): InvoiceDetailsClient;
|
|
735
|
-
type InvoiceDetailsClient = {
|
|
736
|
-
address_lines?: string[];
|
|
737
|
-
name?: string;
|
|
738
|
-
email?: string;
|
|
739
|
-
phone?: string;
|
|
1345
|
+
/** @returns {Charge} */
|
|
1346
|
+
declare function Charge(): Charge;
|
|
1347
|
+
type Charge = {
|
|
1348
|
+
final_charge?: OneTimeChargeEntity;
|
|
740
1349
|
};
|
|
741
1350
|
/** @returns {InvoiceDetailsStatusTrail} */
|
|
742
1351
|
declare function InvoiceDetailsStatusTrail(): InvoiceDetailsStatusTrail;
|
|
@@ -745,39 +1354,6 @@ type InvoiceDetailsStatusTrail = {
|
|
|
745
1354
|
value?: string;
|
|
746
1355
|
timestamp?: string;
|
|
747
1356
|
};
|
|
748
|
-
/** @returns {InvoicePaymentMethod} */
|
|
749
|
-
declare function InvoicePaymentMethod(): InvoicePaymentMethod;
|
|
750
|
-
type InvoicePaymentMethod = {
|
|
751
|
-
pg_payment_method_id?: string;
|
|
752
|
-
};
|
|
753
|
-
/** @returns {InvoiceDetails} */
|
|
754
|
-
declare function InvoiceDetails(): InvoiceDetails;
|
|
755
|
-
type InvoiceDetails = {
|
|
756
|
-
period?: InvoiceDetailsPeriod;
|
|
757
|
-
client?: InvoiceDetailsClient;
|
|
758
|
-
auto_advance?: boolean;
|
|
759
|
-
currency?: string;
|
|
760
|
-
paid?: boolean;
|
|
761
|
-
attemp?: number;
|
|
762
|
-
_id?: string;
|
|
763
|
-
collection_method?: string;
|
|
764
|
-
subscriber_id?: string;
|
|
765
|
-
invoice_url?: string;
|
|
766
|
-
number?: string;
|
|
767
|
-
pg_data?: any;
|
|
768
|
-
receipt_number?: string;
|
|
769
|
-
statement_descriptor?: string;
|
|
770
|
-
current_status?: string;
|
|
771
|
-
status_trail?: InvoiceDetailsStatusTrail[];
|
|
772
|
-
subtotal?: number;
|
|
773
|
-
total?: number;
|
|
774
|
-
subscription?: string;
|
|
775
|
-
next_action_time?: string;
|
|
776
|
-
created_at?: string;
|
|
777
|
-
modified_at?: string;
|
|
778
|
-
hash_identifier?: string;
|
|
779
|
-
payment_method?: InvoicePaymentMethod;
|
|
780
|
-
};
|
|
781
1357
|
/** @returns {InvoiceItemsPlanRecurring} */
|
|
782
1358
|
declare function InvoiceItemsPlanRecurring(): InvoiceItemsPlanRecurring;
|
|
783
1359
|
type InvoiceItemsPlanRecurring = {
|
|
@@ -830,12 +1406,6 @@ type InvoiceItems = {
|
|
|
830
1406
|
created_at?: string;
|
|
831
1407
|
modified_at?: string;
|
|
832
1408
|
};
|
|
833
|
-
/** @returns {Invoice} */
|
|
834
|
-
declare function Invoice(): Invoice;
|
|
835
|
-
type Invoice = {
|
|
836
|
-
invoice?: InvoiceDetails;
|
|
837
|
-
invoice_items?: InvoiceItems[];
|
|
838
|
-
};
|
|
839
1409
|
/** @returns {InvoicesDataClient} */
|
|
840
1410
|
declare function InvoicesDataClient(): InvoicesDataClient;
|
|
841
1411
|
type InvoicesDataClient = {
|
|
@@ -859,6 +1429,13 @@ type InvoicesDataPaymentMethod = {
|
|
|
859
1429
|
declare function InvoicesData(): InvoicesData;
|
|
860
1430
|
type InvoicesData = {
|
|
861
1431
|
_id?: string;
|
|
1432
|
+
documents?: any;
|
|
1433
|
+
payment?: any;
|
|
1434
|
+
old_settlement?: number;
|
|
1435
|
+
credit_balance?: number;
|
|
1436
|
+
discount?: any;
|
|
1437
|
+
taxation?: any;
|
|
1438
|
+
credit_note_amount?: number;
|
|
862
1439
|
client?: InvoicesDataClient;
|
|
863
1440
|
auto_advance?: boolean;
|
|
864
1441
|
currency?: string;
|
|
@@ -923,6 +1500,11 @@ type SubscriptionCustomer = {
|
|
|
923
1500
|
created_at?: string;
|
|
924
1501
|
modified_at?: string;
|
|
925
1502
|
data?: any;
|
|
1503
|
+
documents?: any;
|
|
1504
|
+
consent?: boolean;
|
|
1505
|
+
comms?: boolean;
|
|
1506
|
+
credit_balance?: number;
|
|
1507
|
+
business_country_info?: BusinessCountryInfo;
|
|
926
1508
|
};
|
|
927
1509
|
/** @returns {SubscriptionCustomerCreate} */
|
|
928
1510
|
declare function SubscriptionCustomerCreate(): SubscriptionCustomerCreate;
|
|
@@ -961,6 +1543,7 @@ type SubscriptionInvoiceSettings = {
|
|
|
961
1543
|
/** @returns {Subscription} */
|
|
962
1544
|
declare function Subscription(): Subscription;
|
|
963
1545
|
type Subscription = {
|
|
1546
|
+
meta?: any;
|
|
964
1547
|
current_period?: SubscriptionCurrentPeriod;
|
|
965
1548
|
pause_collection?: SubscriptionPauseCollection;
|
|
966
1549
|
trial?: SubscriptionTrial;
|
|
@@ -978,6 +1561,9 @@ type Subscription = {
|
|
|
978
1561
|
modified_at?: string;
|
|
979
1562
|
latest_invoice?: string;
|
|
980
1563
|
channel_type?: string;
|
|
1564
|
+
freezed?: boolean;
|
|
1565
|
+
cancel_at?: string;
|
|
1566
|
+
canceled_at?: string;
|
|
981
1567
|
};
|
|
982
1568
|
/** @returns {SubscriptionStatus} */
|
|
983
1569
|
declare function SubscriptionStatus(): SubscriptionStatus;
|
|
@@ -987,7 +1573,8 @@ type SubscriptionStatus = {
|
|
|
987
1573
|
latest_invoice?: InvoicesData;
|
|
988
1574
|
next_plan?: Plan;
|
|
989
1575
|
current_subscriptions?: Subscription[];
|
|
990
|
-
mandate_amount?:
|
|
1576
|
+
mandate_amount?: number;
|
|
1577
|
+
message?: string;
|
|
991
1578
|
};
|
|
992
1579
|
/** @returns {SubscriptionLimitApplication} */
|
|
993
1580
|
declare function SubscriptionLimitApplication(): SubscriptionLimitApplication;
|
|
@@ -1041,6 +1628,20 @@ type SubscriptionLimit = {
|
|
|
1041
1628
|
integrations?: SubscriptionLimitIntegrations;
|
|
1042
1629
|
is_trial_plan?: boolean;
|
|
1043
1630
|
};
|
|
1631
|
+
/** @returns {IntentReq} */
|
|
1632
|
+
declare function IntentReq(): IntentReq;
|
|
1633
|
+
type IntentReq = {
|
|
1634
|
+
unique_external_id?: string;
|
|
1635
|
+
plan_id?: string;
|
|
1636
|
+
};
|
|
1637
|
+
/** @returns {PutIntentReq} */
|
|
1638
|
+
declare function PutIntentReq(): PutIntentReq;
|
|
1639
|
+
type PutIntentReq = {
|
|
1640
|
+
unique_external_id?: string;
|
|
1641
|
+
setup_intent_id?: string;
|
|
1642
|
+
payment_method_id?: string;
|
|
1643
|
+
set_default?: boolean;
|
|
1644
|
+
};
|
|
1044
1645
|
/** @returns {SubscriptionActivateReq} */
|
|
1045
1646
|
declare function SubscriptionActivateReq(): SubscriptionActivateReq;
|
|
1046
1647
|
type SubscriptionActivateReq = {
|
|
@@ -1049,6 +1650,9 @@ type SubscriptionActivateReq = {
|
|
|
1049
1650
|
product_suite?: string;
|
|
1050
1651
|
plan_id?: string;
|
|
1051
1652
|
payment_method?: string;
|
|
1653
|
+
subscription_id?: string;
|
|
1654
|
+
coupon?: string;
|
|
1655
|
+
meta?: any;
|
|
1052
1656
|
};
|
|
1053
1657
|
/** @returns {SubscriptionActivateRes} */
|
|
1054
1658
|
declare function SubscriptionActivateRes(): SubscriptionActivateRes;
|
|
@@ -1101,38 +1705,482 @@ type SubscribePlanRes = {
|
|
|
1101
1705
|
current_status?: string;
|
|
1102
1706
|
meta?: Meta;
|
|
1103
1707
|
};
|
|
1104
|
-
/** @returns {
|
|
1105
|
-
declare function
|
|
1106
|
-
type
|
|
1708
|
+
/** @returns {EntityDetail} */
|
|
1709
|
+
declare function EntityDetail(): EntityDetail;
|
|
1710
|
+
type EntityDetail = {
|
|
1711
|
+
entity?: string;
|
|
1712
|
+
item?: Subscription;
|
|
1713
|
+
};
|
|
1714
|
+
/** @returns {PaymentOptions} */
|
|
1715
|
+
declare function PaymentOptions(): PaymentOptions;
|
|
1716
|
+
type PaymentOptions = {
|
|
1717
|
+
_id?: string;
|
|
1107
1718
|
name?: string;
|
|
1108
|
-
slug?: string;
|
|
1109
1719
|
description?: string;
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1720
|
+
logo?: string;
|
|
1721
|
+
aggregator_id?: string;
|
|
1722
|
+
aggregator?: string;
|
|
1723
|
+
created_at?: string;
|
|
1724
|
+
modified_at?: string;
|
|
1725
|
+
__v?: number;
|
|
1726
|
+
};
|
|
1727
|
+
/** @returns {VerifyPaymentReq} */
|
|
1728
|
+
declare function VerifyPaymentReq(): VerifyPaymentReq;
|
|
1729
|
+
type VerifyPaymentReq = {
|
|
1730
|
+
razorpay_payment_id?: string;
|
|
1731
|
+
razorpay_order_id?: string;
|
|
1732
|
+
razorpay_signature?: string;
|
|
1733
|
+
status_code?: number;
|
|
1734
|
+
provider_type?: string;
|
|
1735
|
+
};
|
|
1736
|
+
/** @returns {Documents} */
|
|
1737
|
+
declare function Documents(): Documents;
|
|
1738
|
+
type Documents = {
|
|
1739
|
+
pan?: string;
|
|
1740
|
+
gst?: string;
|
|
1741
|
+
};
|
|
1742
|
+
/** @returns {BillingAddress} */
|
|
1743
|
+
declare function BillingAddress(): BillingAddress;
|
|
1744
|
+
type BillingAddress = {
|
|
1745
|
+
country?: string;
|
|
1746
|
+
state?: string;
|
|
1747
|
+
city?: string;
|
|
1748
|
+
line1?: string;
|
|
1749
|
+
line2?: string;
|
|
1750
|
+
postal_code?: string;
|
|
1751
|
+
country_code?: string;
|
|
1752
|
+
};
|
|
1753
|
+
/** @returns {Currency} */
|
|
1754
|
+
declare function Currency(): Currency;
|
|
1755
|
+
type Currency = {
|
|
1756
|
+
code?: string;
|
|
1757
|
+
symbol?: string;
|
|
1758
|
+
name?: string;
|
|
1759
|
+
};
|
|
1760
|
+
/** @returns {BusinessCountryInfo} */
|
|
1761
|
+
declare function BusinessCountryInfo(): BusinessCountryInfo;
|
|
1762
|
+
type BusinessCountryInfo = {
|
|
1763
|
+
country?: string;
|
|
1764
|
+
country_code?: string;
|
|
1765
|
+
currency?: Currency;
|
|
1766
|
+
timezone?: string;
|
|
1767
|
+
};
|
|
1768
|
+
/** @returns {SubscriberData} */
|
|
1769
|
+
declare function SubscriberData(): SubscriberData;
|
|
1770
|
+
type SubscriberData = {
|
|
1771
|
+
pg_user_exists?: boolean;
|
|
1772
|
+
id?: any;
|
|
1773
|
+
pg_customer_id?: string;
|
|
1774
|
+
default_payment_method?: string;
|
|
1775
|
+
};
|
|
1776
|
+
/** @returns {Subscriber} */
|
|
1777
|
+
declare function Subscriber(): Subscriber;
|
|
1778
|
+
type Subscriber = {
|
|
1779
|
+
documents?: Documents;
|
|
1780
|
+
phone?: any;
|
|
1781
|
+
billing_address?: BillingAddress;
|
|
1782
|
+
consent?: boolean;
|
|
1783
|
+
comms?: boolean;
|
|
1784
|
+
_id?: string;
|
|
1785
|
+
type?: string;
|
|
1786
|
+
unique_id?: string;
|
|
1787
|
+
name?: string;
|
|
1788
|
+
email?: string;
|
|
1789
|
+
business_country_info?: BusinessCountryInfo;
|
|
1790
|
+
created_at?: string;
|
|
1791
|
+
modified_at?: string;
|
|
1792
|
+
credit_balance?: number;
|
|
1793
|
+
data?: SubscriberData;
|
|
1794
|
+
};
|
|
1795
|
+
/** @returns {Author} */
|
|
1796
|
+
declare function Author(): Author;
|
|
1797
|
+
type Author = {
|
|
1798
|
+
modified_by_details?: any;
|
|
1799
|
+
};
|
|
1800
|
+
/** @returns {EndingBalance} */
|
|
1801
|
+
declare function EndingBalance(): EndingBalance;
|
|
1802
|
+
type EndingBalance = {
|
|
1803
|
+
amount?: number;
|
|
1804
|
+
old_entry_ref?: string;
|
|
1805
|
+
};
|
|
1806
|
+
/** @returns {PaymentData} */
|
|
1807
|
+
declare function PaymentData(): PaymentData;
|
|
1808
|
+
type PaymentData = {
|
|
1809
|
+
transaction_id?: string;
|
|
1810
|
+
aggregator?: string;
|
|
1811
|
+
aggregator_order_id?: string;
|
|
1812
|
+
};
|
|
1813
|
+
/** @returns {CreditTransaction} */
|
|
1814
|
+
declare function CreditTransaction(): CreditTransaction;
|
|
1815
|
+
type CreditTransaction = {
|
|
1816
|
+
entity?: any;
|
|
1817
|
+
author?: Author;
|
|
1818
|
+
_id?: string;
|
|
1819
|
+
amount?: number;
|
|
1820
|
+
currency?: string;
|
|
1821
|
+
subscriber_id?: string;
|
|
1822
|
+
description?: string;
|
|
1823
|
+
is_test?: any;
|
|
1824
|
+
ending_balance?: EndingBalance;
|
|
1825
|
+
payment?: PaymentData;
|
|
1826
|
+
type?: string;
|
|
1827
|
+
created_at?: string;
|
|
1828
|
+
modified_at?: string;
|
|
1829
|
+
};
|
|
1830
|
+
/** @returns {VerifyPaymentData} */
|
|
1831
|
+
declare function VerifyPaymentData(): VerifyPaymentData;
|
|
1832
|
+
type VerifyPaymentData = {
|
|
1833
|
+
success?: boolean;
|
|
1834
|
+
subscriber?: Subscriber;
|
|
1835
|
+
credit_transaction?: CreditTransaction;
|
|
1836
|
+
};
|
|
1837
|
+
/** @returns {VerifyPaymentRes} */
|
|
1838
|
+
declare function VerifyPaymentRes(): VerifyPaymentRes;
|
|
1839
|
+
type VerifyPaymentRes = {
|
|
1840
|
+
status?: string;
|
|
1841
|
+
data?: VerifyPaymentData;
|
|
1842
|
+
};
|
|
1843
|
+
/** @returns {DefaultMerchants} */
|
|
1844
|
+
declare function DefaultMerchants(): DefaultMerchants;
|
|
1845
|
+
type DefaultMerchants = {
|
|
1846
|
+
stripe?: string;
|
|
1847
|
+
};
|
|
1848
|
+
/** @returns {GlobalSettingsPayment} */
|
|
1849
|
+
declare function GlobalSettingsPayment(): GlobalSettingsPayment;
|
|
1850
|
+
type GlobalSettingsPayment = {
|
|
1851
|
+
default_merchants?: DefaultMerchants;
|
|
1852
|
+
};
|
|
1853
|
+
/** @returns {GlobalSettingsData} */
|
|
1854
|
+
declare function GlobalSettingsData(): GlobalSettingsData;
|
|
1855
|
+
type GlobalSettingsData = {
|
|
1856
|
+
payment?: GlobalSettingsPayment;
|
|
1857
|
+
freeze_panel?: boolean;
|
|
1858
|
+
_id?: string;
|
|
1859
|
+
created_at?: string;
|
|
1860
|
+
modified_at?: string;
|
|
1861
|
+
};
|
|
1862
|
+
/** @returns {GlobalSettings} */
|
|
1863
|
+
declare function GlobalSettings(): GlobalSettings;
|
|
1864
|
+
type GlobalSettings = {
|
|
1865
|
+
status?: string;
|
|
1866
|
+
data?: GlobalSettingsData;
|
|
1867
|
+
};
|
|
1868
|
+
/** @returns {MethodChecks} */
|
|
1869
|
+
declare function MethodChecks(): MethodChecks;
|
|
1870
|
+
type MethodChecks = {
|
|
1871
|
+
address_line1_check?: string;
|
|
1872
|
+
address_postal_code_check?: string;
|
|
1873
|
+
cvc_check?: string;
|
|
1874
|
+
};
|
|
1875
|
+
/** @returns {MethodNetworks} */
|
|
1876
|
+
declare function MethodNetworks(): MethodNetworks;
|
|
1877
|
+
type MethodNetworks = {
|
|
1878
|
+
available?: string[];
|
|
1879
|
+
preferred?: string;
|
|
1880
|
+
};
|
|
1881
|
+
/** @returns {MethodSecureUsage} */
|
|
1882
|
+
declare function MethodSecureUsage(): MethodSecureUsage;
|
|
1883
|
+
type MethodSecureUsage = {
|
|
1884
|
+
supported?: boolean;
|
|
1885
|
+
};
|
|
1886
|
+
/** @returns {MethodDetails} */
|
|
1887
|
+
declare function MethodDetails(): MethodDetails;
|
|
1888
|
+
type MethodDetails = {
|
|
1889
|
+
id?: string;
|
|
1890
|
+
type?: string;
|
|
1891
|
+
mandate_available?: boolean;
|
|
1892
|
+
mandate_amount?: number;
|
|
1893
|
+
pg_payment_method_id?: string;
|
|
1894
|
+
is_default?: boolean;
|
|
1895
|
+
data?: SubscriptionMethodData;
|
|
1896
|
+
};
|
|
1897
|
+
/** @returns {SubscriptionMethodData} */
|
|
1898
|
+
declare function SubscriptionMethodData(): SubscriptionMethodData;
|
|
1899
|
+
type SubscriptionMethodData = {
|
|
1900
|
+
brand?: string;
|
|
1901
|
+
checks?: MethodChecks;
|
|
1902
|
+
country?: string;
|
|
1903
|
+
exp_month?: number;
|
|
1904
|
+
exp_year?: number;
|
|
1905
|
+
fingerprint?: string;
|
|
1906
|
+
funding?: string;
|
|
1907
|
+
generated_from?: string;
|
|
1908
|
+
last4?: string;
|
|
1909
|
+
networks?: MethodNetworks;
|
|
1910
|
+
three_d_secure_usage?: MethodSecureUsage;
|
|
1911
|
+
wallet?: string;
|
|
1912
|
+
name?: string;
|
|
1913
|
+
is_default?: boolean;
|
|
1914
|
+
};
|
|
1915
|
+
/** @returns {SubscriptionMethods} */
|
|
1916
|
+
declare function SubscriptionMethods(): SubscriptionMethods;
|
|
1917
|
+
type SubscriptionMethods = {
|
|
1918
|
+
success?: boolean;
|
|
1919
|
+
data?: MethodDetails[];
|
|
1920
|
+
};
|
|
1921
|
+
/** @returns {ConfigPublicKey} */
|
|
1922
|
+
declare function ConfigPublicKey(): ConfigPublicKey;
|
|
1923
|
+
type ConfigPublicKey = {
|
|
1924
|
+
public_key?: string;
|
|
1925
|
+
};
|
|
1926
|
+
/** @returns {ConfigRes} */
|
|
1927
|
+
declare function ConfigRes(): ConfigRes;
|
|
1928
|
+
type ConfigRes = {
|
|
1134
1929
|
success?: boolean;
|
|
1930
|
+
aggregator?: string;
|
|
1931
|
+
config?: ConfigPublicKey;
|
|
1932
|
+
};
|
|
1933
|
+
/** @returns {PlanChangeData} */
|
|
1934
|
+
declare function PlanChangeData(): PlanChangeData;
|
|
1935
|
+
type PlanChangeData = {
|
|
1936
|
+
total?: number;
|
|
1937
|
+
credit_note_amount?: number;
|
|
1938
|
+
settlement?: number;
|
|
1939
|
+
taxable_amount?: number;
|
|
1940
|
+
gst_amount?: number;
|
|
1941
|
+
gross_total?: number;
|
|
1942
|
+
gst?: number;
|
|
1943
|
+
discount?: number;
|
|
1944
|
+
};
|
|
1945
|
+
/** @returns {PlanChangeDetails} */
|
|
1946
|
+
declare function PlanChangeDetails(): PlanChangeDetails;
|
|
1947
|
+
type PlanChangeDetails = {
|
|
1948
|
+
status?: string;
|
|
1949
|
+
data?: PlanChangeData;
|
|
1950
|
+
};
|
|
1951
|
+
/** @returns {TransactionMeta} */
|
|
1952
|
+
declare function TransactionMeta(): TransactionMeta;
|
|
1953
|
+
type TransactionMeta = {
|
|
1954
|
+
invoice_id?: string;
|
|
1955
|
+
};
|
|
1956
|
+
/** @returns {PaymentTransactionDetails} */
|
|
1957
|
+
declare function PaymentTransactionDetails(): PaymentTransactionDetails;
|
|
1958
|
+
type PaymentTransactionDetails = {
|
|
1959
|
+
aggregator?: any;
|
|
1960
|
+
currency?: string;
|
|
1961
|
+
current_status?: string;
|
|
1962
|
+
_id?: string;
|
|
1963
|
+
subscriber_id?: string;
|
|
1964
|
+
amount?: number;
|
|
1965
|
+
entity_type?: string;
|
|
1966
|
+
collection_type?: string;
|
|
1967
|
+
meta?: TransactionMeta;
|
|
1968
|
+
created_at?: string;
|
|
1969
|
+
modified_at?: string;
|
|
1970
|
+
};
|
|
1971
|
+
/** @returns {PaymentItems} */
|
|
1972
|
+
declare function PaymentItems(): PaymentItems;
|
|
1973
|
+
type PaymentItems = {
|
|
1974
|
+
name?: string;
|
|
1975
|
+
code?: string;
|
|
1976
|
+
aggregator?: string;
|
|
1977
|
+
};
|
|
1978
|
+
/** @returns {GetPaymentOptions} */
|
|
1979
|
+
declare function GetPaymentOptions(): GetPaymentOptions;
|
|
1980
|
+
type GetPaymentOptions = {
|
|
1981
|
+
payment_options?: PaymentItems[];
|
|
1982
|
+
};
|
|
1983
|
+
/** @returns {TopupReq} */
|
|
1984
|
+
declare function TopupReq(): TopupReq;
|
|
1985
|
+
type TopupReq = {
|
|
1986
|
+
amount?: number;
|
|
1987
|
+
currency?: string;
|
|
1988
|
+
provider_type?: string;
|
|
1989
|
+
};
|
|
1990
|
+
/** @returns {SetupMandateReq} */
|
|
1991
|
+
declare function SetupMandateReq(): SetupMandateReq;
|
|
1992
|
+
type SetupMandateReq = {
|
|
1993
|
+
intent_id?: string;
|
|
1994
|
+
payment_method_id?: string;
|
|
1995
|
+
};
|
|
1996
|
+
/** @returns {SetupPaymentReq} */
|
|
1997
|
+
declare function SetupPaymentReq(): SetupPaymentReq;
|
|
1998
|
+
type SetupPaymentReq = {
|
|
1999
|
+
payment_method?: string;
|
|
2000
|
+
payment_id?: string;
|
|
2001
|
+
plan_id?: string;
|
|
2002
|
+
invoice_id?: string;
|
|
2003
|
+
};
|
|
2004
|
+
/** @returns {SubscriptionRenewReq} */
|
|
2005
|
+
declare function SubscriptionRenewReq(): SubscriptionRenewReq;
|
|
2006
|
+
type SubscriptionRenewReq = {
|
|
2007
|
+
invoice_id?: string;
|
|
2008
|
+
entity_type?: string;
|
|
2009
|
+
collection_type?: string;
|
|
2010
|
+
callback_url?: string;
|
|
2011
|
+
meta?: RenewMeta;
|
|
2012
|
+
};
|
|
2013
|
+
/** @returns {RenewMeta} */
|
|
2014
|
+
declare function RenewMeta(): RenewMeta;
|
|
2015
|
+
type RenewMeta = {
|
|
2016
|
+
invoice_payment?: boolean;
|
|
2017
|
+
renew?: boolean;
|
|
2018
|
+
};
|
|
2019
|
+
/** @returns {SubscriptionMethodsReq} */
|
|
2020
|
+
declare function SubscriptionMethodsReq(): SubscriptionMethodsReq;
|
|
2021
|
+
type SubscriptionMethodsReq = {
|
|
2022
|
+
unique_external_id?: string;
|
|
2023
|
+
setup_intent_id?: string;
|
|
2024
|
+
pg_payment_method_id?: string;
|
|
2025
|
+
set_default?: boolean;
|
|
2026
|
+
};
|
|
2027
|
+
/** @returns {CreditTransactionResponse} */
|
|
2028
|
+
declare function CreditTransactionResponse(): CreditTransactionResponse;
|
|
2029
|
+
type CreditTransactionResponse = {
|
|
2030
|
+
/**
|
|
2031
|
+
* - Total number of transactions
|
|
2032
|
+
*/
|
|
2033
|
+
total?: number;
|
|
2034
|
+
/**
|
|
2035
|
+
* - Maximum number of transactions per page
|
|
2036
|
+
*/
|
|
2037
|
+
limit?: number;
|
|
2038
|
+
/**
|
|
2039
|
+
* - Current page number
|
|
2040
|
+
*/
|
|
1135
2041
|
page?: number;
|
|
1136
|
-
|
|
1137
|
-
|
|
2042
|
+
/**
|
|
2043
|
+
* - Total number of pages
|
|
2044
|
+
*/
|
|
2045
|
+
pages?: number;
|
|
2046
|
+
items?: CreditTransaction[];
|
|
2047
|
+
};
|
|
2048
|
+
/** @returns {DowngradePlanReq} */
|
|
2049
|
+
declare function DowngradePlanReq(): DowngradePlanReq;
|
|
2050
|
+
type DowngradePlanReq = {
|
|
2051
|
+
unique_id?: string;
|
|
2052
|
+
type?: string;
|
|
2053
|
+
product_suite?: string;
|
|
2054
|
+
plan_id?: string;
|
|
2055
|
+
reason?: string;
|
|
2056
|
+
platform?: string;
|
|
2057
|
+
};
|
|
2058
|
+
/** @returns {Taxation} */
|
|
2059
|
+
declare function Taxation(): Taxation;
|
|
2060
|
+
type Taxation = {
|
|
2061
|
+
/**
|
|
2062
|
+
* - GST percentage
|
|
2063
|
+
*/
|
|
2064
|
+
gst?: number;
|
|
2065
|
+
};
|
|
2066
|
+
/** @returns {OneTimeFees} */
|
|
2067
|
+
declare function OneTimeFees(): OneTimeFees;
|
|
2068
|
+
type OneTimeFees = {
|
|
2069
|
+
developement?: number;
|
|
2070
|
+
marketing?: number;
|
|
2071
|
+
};
|
|
2072
|
+
/** @returns {CreditLine} */
|
|
2073
|
+
declare function CreditLine(): CreditLine;
|
|
2074
|
+
type CreditLine = {
|
|
2075
|
+
is_active?: boolean;
|
|
2076
|
+
};
|
|
2077
|
+
/** @returns {StatusMessage} */
|
|
2078
|
+
declare function StatusMessage(): StatusMessage;
|
|
2079
|
+
type StatusMessage = {
|
|
2080
|
+
status?: string;
|
|
2081
|
+
message?: string;
|
|
2082
|
+
success?: boolean;
|
|
2083
|
+
code?: string;
|
|
2084
|
+
};
|
|
2085
|
+
/** @returns {PaymentCollectReq} */
|
|
2086
|
+
declare function PaymentCollectReq(): PaymentCollectReq;
|
|
2087
|
+
type PaymentCollectReq = {
|
|
2088
|
+
transaction_id?: string;
|
|
2089
|
+
credit_balance?: boolean;
|
|
2090
|
+
payment_mode?: string;
|
|
2091
|
+
payment_method?: string;
|
|
2092
|
+
invoice_id?: string;
|
|
2093
|
+
};
|
|
2094
|
+
/** @returns {SubscriptionRenewResMeta} */
|
|
2095
|
+
declare function SubscriptionRenewResMeta(): SubscriptionRenewResMeta;
|
|
2096
|
+
type SubscriptionRenewResMeta = {
|
|
2097
|
+
invoice_payment?: boolean;
|
|
2098
|
+
renew?: boolean;
|
|
2099
|
+
};
|
|
2100
|
+
/** @returns {SubscriptionRenewRes} */
|
|
2101
|
+
declare function SubscriptionRenewRes(): SubscriptionRenewRes;
|
|
2102
|
+
type SubscriptionRenewRes = {
|
|
2103
|
+
redirect_url?: string;
|
|
2104
|
+
transaction_id?: string;
|
|
2105
|
+
current_status?: string;
|
|
2106
|
+
meta?: SubscriptionRenewResMeta;
|
|
2107
|
+
};
|
|
2108
|
+
/** @returns {SetupIntentRes} */
|
|
2109
|
+
declare function SetupIntentRes(): SetupIntentRes;
|
|
2110
|
+
type SetupIntentRes = {
|
|
2111
|
+
success?: boolean;
|
|
2112
|
+
data?: SetupIntentData;
|
|
2113
|
+
};
|
|
2114
|
+
/** @returns {SetupIntentData} */
|
|
2115
|
+
declare function SetupIntentData(): SetupIntentData;
|
|
2116
|
+
type SetupIntentData = {
|
|
2117
|
+
id?: string;
|
|
2118
|
+
client_secret?: string;
|
|
2119
|
+
customer?: any;
|
|
2120
|
+
status?: string;
|
|
2121
|
+
};
|
|
2122
|
+
/** @returns {SetupPayment} */
|
|
2123
|
+
declare function SetupPayment(): SetupPayment;
|
|
2124
|
+
type SetupPayment = {
|
|
2125
|
+
id?: string;
|
|
2126
|
+
status?: string;
|
|
2127
|
+
customer?: any;
|
|
2128
|
+
client_secret?: string;
|
|
2129
|
+
payment_method?: string;
|
|
2130
|
+
mandate?: string;
|
|
2131
|
+
payment_method_options?: PaymentMethodOptions;
|
|
2132
|
+
};
|
|
2133
|
+
/** @returns {PaymentMethodOptions} */
|
|
2134
|
+
declare function PaymentMethodOptions(): PaymentMethodOptions;
|
|
2135
|
+
type PaymentMethodOptions = {
|
|
2136
|
+
card?: Card;
|
|
2137
|
+
};
|
|
2138
|
+
/** @returns {Card} */
|
|
2139
|
+
declare function Card(): Card;
|
|
2140
|
+
type Card = {
|
|
2141
|
+
mandate_options?: MandateOptions;
|
|
2142
|
+
};
|
|
2143
|
+
/** @returns {MandateOptions} */
|
|
2144
|
+
declare function MandateOptions(): MandateOptions;
|
|
2145
|
+
type MandateOptions = {
|
|
2146
|
+
amount?: number;
|
|
2147
|
+
};
|
|
2148
|
+
/** @returns {Message} */
|
|
2149
|
+
declare function Message(): Message;
|
|
2150
|
+
type Message = {
|
|
2151
|
+
message?: string;
|
|
2152
|
+
};
|
|
2153
|
+
/** @returns {TopupRes} */
|
|
2154
|
+
declare function TopupRes(): TopupRes;
|
|
2155
|
+
type TopupRes = {
|
|
2156
|
+
status?: string;
|
|
2157
|
+
aggregator_order_id?: string;
|
|
2158
|
+
amount?: number;
|
|
2159
|
+
currency?: string;
|
|
2160
|
+
transaction_id?: string;
|
|
2161
|
+
};
|
|
2162
|
+
/** @returns {CancelTopupReq} */
|
|
2163
|
+
declare function CancelTopupReq(): CancelTopupReq;
|
|
2164
|
+
type CancelTopupReq = {
|
|
2165
|
+
order_id?: string;
|
|
2166
|
+
};
|
|
2167
|
+
/** @returns {CancelTopupRes} */
|
|
2168
|
+
declare function CancelTopupRes(): CancelTopupRes;
|
|
2169
|
+
type CancelTopupRes = {
|
|
2170
|
+
_id?: string;
|
|
2171
|
+
subscriber_id?: string;
|
|
2172
|
+
amount?: number;
|
|
2173
|
+
currency?: string;
|
|
2174
|
+
aggregator?: string;
|
|
2175
|
+
aggregator_order_id?: string;
|
|
2176
|
+
created_at?: string;
|
|
2177
|
+
modified_at?: string;
|
|
2178
|
+
__v?: number;
|
|
2179
|
+
aggregator_status?: string;
|
|
2180
|
+
current_status?: string;
|
|
2181
|
+
};
|
|
2182
|
+
/** @returns {DefaultReq} */
|
|
2183
|
+
declare function DefaultReq(): DefaultReq;
|
|
2184
|
+
type DefaultReq = {
|
|
2185
|
+
payment_method_id?: string;
|
|
1138
2186
|
};
|