chargebee 2.51.0 → 2.53.0
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/CHANGELOG.md +83 -0
- package/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +103 -5
- package/package.json +1 -1
- package/types/core.d.ts +6 -6
- package/types/index.d.ts +10 -0
- package/types/resources/Addon.d.ts +3 -3
- package/types/resources/Address.d.ts +2 -194
- package/types/resources/AdvanceInvoiceSchedule.d.ts +5 -67
- package/types/resources/AttachedItem.d.ts +1 -1
- package/types/resources/Attribute.d.ts +4 -1
- package/types/resources/BillingConfiguration.d.ts +21 -0
- package/types/resources/Brand.d.ts +12 -0
- package/types/resources/BusinessEntity.d.ts +10 -8
- package/types/resources/BusinessEntityTransfer.d.ts +10 -7
- package/types/resources/Card.d.ts +11 -311
- package/types/resources/Comment.d.ts +10 -125
- package/types/resources/Contact.d.ts +2 -44
- package/types/resources/ContractTerm.d.ts +4 -72
- package/types/resources/Coupon.d.ts +4 -41
- package/types/resources/CouponCode.d.ts +67 -35
- package/types/resources/CouponSet.d.ts +12 -121
- package/types/resources/CreditNote.d.ts +89 -95
- package/types/resources/Currency.d.ts +8 -5
- package/types/resources/Customer.d.ts +96 -95
- package/types/resources/CustomerEntitlement.d.ts +3 -1
- package/types/resources/DifferentialPrice.d.ts +1 -1
- package/types/resources/Discount.d.ts +5 -90
- package/types/resources/Download.d.ts +2 -14
- package/types/resources/Entitlement.d.ts +15 -103
- package/types/resources/EntitlementOverride.d.ts +4 -89
- package/types/resources/Estimate.d.ts +6 -14
- package/types/resources/Event.d.ts +24 -109
- package/types/resources/Export.d.ts +116 -432
- package/types/resources/Feature.d.ts +19 -321
- package/types/resources/GatewayErrorDetail.d.ts +6 -48
- package/types/resources/Gift.d.ts +34 -294
- package/types/resources/Hierarchy.d.ts +4 -24
- package/types/resources/HostedPage.d.ts +4 -4
- package/types/resources/ImpactedCustomer.d.ts +23 -0
- package/types/resources/ImpactedItem.d.ts +4 -36
- package/types/resources/ImpactedItemPrice.d.ts +5 -2
- package/types/resources/ImpactedSubscription.d.ts +3 -30
- package/types/resources/InAppSubscription.d.ts +13 -355
- package/types/resources/Invoice.d.ts +112 -126
- package/types/resources/InvoiceEstimate.d.ts +1 -1
- package/types/resources/Item.d.ts +4 -11
- package/types/resources/ItemEntitlement.d.ts +15 -155
- package/types/resources/ItemFamily.d.ts +3 -3
- package/types/resources/ItemPrice.d.ts +7 -7
- package/types/resources/NonSubscription.d.ts +9 -6
- package/types/resources/OmnichannelOneTimeOrder.d.ts +90 -0
- package/types/resources/OmnichannelOneTimeOrderItem.d.ts +24 -0
- package/types/resources/OmnichannelSubscription.d.ts +2 -2
- package/types/resources/OmnichannelSubscriptionItem.d.ts +1 -1
- package/types/resources/OmnichannelSubscriptionItemScheduledChange.d.ts +1 -1
- package/types/resources/Order.d.ts +3 -3
- package/types/resources/PaymentIntent.d.ts +9 -255
- package/types/resources/PaymentReferenceNumber.d.ts +3 -20
- package/types/resources/PaymentSource.d.ts +4 -4
- package/types/resources/PaymentVoucher.d.ts +22 -205
- package/types/resources/Plan.d.ts +3 -3
- package/types/resources/PortalSession.d.ts +4 -146
- package/types/resources/PriceVariant.d.ts +2 -2
- package/types/resources/PricingPageSession.d.ts +2 -2
- package/types/resources/PromotionalCredit.d.ts +12 -215
- package/types/resources/Purchase.d.ts +5 -3
- package/types/resources/Quote.d.ts +32 -14
- package/types/resources/QuotedCharge.d.ts +7 -0
- package/types/resources/QuotedRamp.d.ts +11 -16
- package/types/resources/Ramp.d.ts +7 -7
- package/types/resources/RecordedPurchase.d.ts +8 -1
- package/types/resources/ResourceMigration.d.ts +2 -54
- package/types/resources/SiteMigrationDetail.d.ts +13 -55
- package/types/resources/Subscription.d.ts +33 -29
- package/types/resources/SubscriptionEntitlement.d.ts +6 -106
- package/types/resources/SubscriptionEntitlementsCreatedDetail.d.ts +12 -0
- package/types/resources/SubscriptionEntitlementsUpdatedDetail.d.ts +12 -0
- package/types/resources/SubscriptionEstimate.d.ts +14 -11
- package/types/resources/TaxWithheld.d.ts +14 -26
- package/types/resources/ThirdPartyPaymentMethod.d.ts +2 -19
- package/types/resources/TimeMachine.d.ts +3 -64
- package/types/resources/Token.d.ts +3 -60
- package/types/resources/Transaction.d.ts +8 -8
- package/types/resources/UnbilledCharge.d.ts +1 -1
- package/types/resources/Usage.d.ts +21 -165
- package/types/resources/UsageFile.d.ts +5 -5
- package/types/resources/VirtualBankAccount.d.ts +1 -1
- package/types/resources/WebhookEndpoint.d.ts +117 -0
|
@@ -1,134 +1,46 @@
|
|
|
1
1
|
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
2
3
|
declare module 'chargebee' {
|
|
3
4
|
export interface PromotionalCredit {
|
|
4
5
|
|
|
5
|
-
/**
|
|
6
|
-
* @description Unique reference ID provided for promotional credits
|
|
7
6
|
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
7
|
id:string;
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
* @description Identifier of the customer.
|
|
14
8
|
|
|
15
|
-
*/
|
|
16
|
-
|
|
17
9
|
customer_id:string;
|
|
18
|
-
|
|
19
|
-
/**
|
|
20
|
-
* @description Type of promotional credits \* decrement - Decrement \* increment - Increment
|
|
21
10
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
type:'decrement' | 'increment';
|
|
25
|
-
|
|
26
|
-
/**
|
|
27
|
-
* @description Amount in decimal
|
|
11
|
+
type:'increment' | 'decrement';
|
|
28
12
|
|
|
29
|
-
*/
|
|
30
|
-
|
|
31
13
|
amount_in_decimal?:string;
|
|
32
|
-
|
|
33
|
-
/**
|
|
34
|
-
* @description Promotional credits amount
|
|
35
14
|
|
|
36
|
-
*/
|
|
37
|
-
|
|
38
15
|
amount:number;
|
|
39
|
-
|
|
40
|
-
/**
|
|
41
|
-
* @description The currency code (ISO 4217 format) for promotional credit
|
|
42
16
|
|
|
43
|
-
*/
|
|
44
|
-
|
|
45
17
|
currency_code:string;
|
|
46
|
-
|
|
47
|
-
/**
|
|
48
|
-
* @description Detailed description of this promotional credits.
|
|
49
18
|
|
|
50
|
-
*/
|
|
51
|
-
|
|
52
19
|
description:string;
|
|
53
|
-
|
|
54
|
-
/**
|
|
55
|
-
* @description Type of promotional credits provided to customer \* referral_rewards - Referral \* loyalty_credits - Loyalty Credits \* general - General
|
|
56
20
|
|
|
57
|
-
*/
|
|
58
|
-
|
|
59
21
|
credit_type:CreditType;
|
|
60
|
-
|
|
61
|
-
/**
|
|
62
|
-
* @description Describes why promotional credits were provided
|
|
63
22
|
|
|
64
|
-
*/
|
|
65
|
-
|
|
66
23
|
reference?:string;
|
|
67
|
-
|
|
68
|
-
/**
|
|
69
|
-
* @description Closing balance as on end date.
|
|
70
24
|
|
|
71
|
-
*/
|
|
72
|
-
|
|
73
25
|
closing_balance:number;
|
|
74
|
-
|
|
75
|
-
/**
|
|
76
|
-
* @description The user who added/deducted the credit. If created via API, this contains the name given for the API key used.
|
|
77
26
|
|
|
78
|
-
*/
|
|
79
|
-
|
|
80
27
|
done_by?:string;
|
|
81
|
-
|
|
82
|
-
/**
|
|
83
|
-
* @description Timestamp indicating when this promotional credit resource is created.
|
|
84
28
|
|
|
85
|
-
*/
|
|
86
|
-
|
|
87
29
|
created_at:number;
|
|
30
|
+
|
|
31
|
+
business_entity_id?:string;
|
|
32
|
+
|
|
88
33
|
}
|
|
89
34
|
export namespace PromotionalCredit {
|
|
90
35
|
export class PromotionalCreditResource {
|
|
91
|
-
/**
|
|
92
|
-
* @description This API call can be used to add promotional credits to a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
|
|
93
|
-
|
|
94
|
-
For example, if a customer has credits of $10, if you pass the **amount** as $10, then the customer's credit balance would become $20.
|
|
95
|
-
|
|
96
|
-
*/
|
|
97
|
-
|
|
98
36
|
add(input:AddInputParam):ChargebeeRequest<AddResponse>;
|
|
99
37
|
|
|
100
|
-
/**
|
|
101
|
-
* @description This API call can be used to deduct promotional credits for a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
|
|
102
|
-
|
|
103
|
-
For example, if a customer has a credit balance of $20, if you pass the **amount** as $5, then the customer's credit balance would become $15.
|
|
104
|
-
|
|
105
|
-
If you do not pass any amount as the input parameter then, it will deduct the whole available amount from the credit balance.
|
|
106
|
-
|
|
107
|
-
*/
|
|
108
|
-
|
|
109
38
|
deduct(input:DeductInputParam):ChargebeeRequest<DeductResponse>;
|
|
110
39
|
|
|
111
|
-
/**
|
|
112
|
-
* @description This API call can be used to set the promotional credits balance of a customer. [Learn more about Promotional Credits](https://www.chargebee.com/docs/2.0/credit-notes.html#creating-promotional-credits).
|
|
113
|
-
|
|
114
|
-
For example, if a customer has a credit balance of $10 and if you would like to set the balance to $100, you could pass the **amount** as $100.
|
|
115
|
-
|
|
116
|
-
*/
|
|
117
|
-
|
|
118
40
|
set(input:SetInputParam):ChargebeeRequest<SetResponse>;
|
|
119
41
|
|
|
120
|
-
/**
|
|
121
|
-
* @description This endpoint lists the promotional credits set for a customer
|
|
122
|
-
|
|
123
|
-
*/
|
|
124
|
-
|
|
125
42
|
list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
|
|
126
43
|
|
|
127
|
-
/**
|
|
128
|
-
* @description This endpoint retrieves the promotional credit based on the promotional credit id
|
|
129
|
-
|
|
130
|
-
*/
|
|
131
|
-
|
|
132
44
|
retrieve(account_credit_id:string):ChargebeeRequest<RetrieveResponse>;
|
|
133
45
|
}
|
|
134
46
|
export interface AddResponse {
|
|
@@ -138,53 +50,18 @@ For example, if a customer has a credit balance of $10 and if you would like to
|
|
|
138
50
|
}
|
|
139
51
|
export interface AddInputParam {
|
|
140
52
|
|
|
141
|
-
/**
|
|
142
|
-
* @description Identifier of the customer.
|
|
143
|
-
|
|
144
|
-
*/
|
|
145
|
-
|
|
146
53
|
customer_id:string;
|
|
147
54
|
|
|
148
|
-
/**
|
|
149
|
-
* @description Promotional credits amount.
|
|
150
|
-
|
|
151
|
-
*/
|
|
152
|
-
|
|
153
55
|
amount?:number;
|
|
154
56
|
|
|
155
|
-
/**
|
|
156
|
-
* @description Amount in decimal.
|
|
157
|
-
|
|
158
|
-
*/
|
|
159
|
-
|
|
160
57
|
amount_in_decimal?:string;
|
|
161
58
|
|
|
162
|
-
/**
|
|
163
|
-
* @description The currency code (ISO 4217 format) for promotional credit.
|
|
164
|
-
|
|
165
|
-
*/
|
|
166
|
-
|
|
167
59
|
currency_code?:string;
|
|
168
60
|
|
|
169
|
-
/**
|
|
170
|
-
* @description Detailed description of this promotional credits.
|
|
171
|
-
|
|
172
|
-
*/
|
|
173
|
-
|
|
174
61
|
description:string;
|
|
175
62
|
|
|
176
|
-
/**
|
|
177
|
-
* @description Type of promotional credits provided to customer. \* general - General \* referral_rewards - Referral \* loyalty_credits - Loyalty Credits
|
|
178
|
-
|
|
179
|
-
*/
|
|
180
|
-
|
|
181
63
|
credit_type?:CreditType;
|
|
182
64
|
|
|
183
|
-
/**
|
|
184
|
-
* @description Describes why promotional credits were provided.
|
|
185
|
-
|
|
186
|
-
*/
|
|
187
|
-
|
|
188
65
|
reference?:string;
|
|
189
66
|
}
|
|
190
67
|
export interface DeductResponse {
|
|
@@ -194,53 +71,18 @@ For example, if a customer has a credit balance of $10 and if you would like to
|
|
|
194
71
|
}
|
|
195
72
|
export interface DeductInputParam {
|
|
196
73
|
|
|
197
|
-
/**
|
|
198
|
-
* @description Identifier of the customer.
|
|
199
|
-
|
|
200
|
-
*/
|
|
201
|
-
|
|
202
74
|
customer_id:string;
|
|
203
75
|
|
|
204
|
-
/**
|
|
205
|
-
* @description Promotional credits amount.
|
|
206
|
-
|
|
207
|
-
*/
|
|
208
|
-
|
|
209
76
|
amount?:number;
|
|
210
77
|
|
|
211
|
-
/**
|
|
212
|
-
* @description Amount in decimal.
|
|
213
|
-
|
|
214
|
-
*/
|
|
215
|
-
|
|
216
78
|
amount_in_decimal?:string;
|
|
217
79
|
|
|
218
|
-
/**
|
|
219
|
-
* @description The currency code (ISO 4217 format) for promotional credit.
|
|
220
|
-
|
|
221
|
-
*/
|
|
222
|
-
|
|
223
80
|
currency_code?:string;
|
|
224
81
|
|
|
225
|
-
/**
|
|
226
|
-
* @description Detailed description of this promotional credits.
|
|
227
|
-
|
|
228
|
-
*/
|
|
229
|
-
|
|
230
82
|
description:string;
|
|
231
83
|
|
|
232
|
-
/**
|
|
233
|
-
* @description Type of promotional credits provided to customer. \* general - General \* referral_rewards - Referral \* loyalty_credits - Loyalty Credits
|
|
234
|
-
|
|
235
|
-
*/
|
|
236
|
-
|
|
237
84
|
credit_type?:CreditType;
|
|
238
85
|
|
|
239
|
-
/**
|
|
240
|
-
* @description Describes why promotional credits were provided.
|
|
241
|
-
|
|
242
|
-
*/
|
|
243
|
-
|
|
244
86
|
reference?:string;
|
|
245
87
|
}
|
|
246
88
|
export interface SetResponse {
|
|
@@ -250,109 +92,64 @@ For example, if a customer has a credit balance of $10 and if you would like to
|
|
|
250
92
|
}
|
|
251
93
|
export interface SetInputParam {
|
|
252
94
|
|
|
253
|
-
/**
|
|
254
|
-
* @description Identifier of the customer.
|
|
255
|
-
|
|
256
|
-
*/
|
|
257
|
-
|
|
258
95
|
customer_id:string;
|
|
259
96
|
|
|
260
|
-
/**
|
|
261
|
-
* @description Promotional credits amount.
|
|
262
|
-
|
|
263
|
-
*/
|
|
264
|
-
|
|
265
97
|
amount?:number;
|
|
266
98
|
|
|
267
|
-
/**
|
|
268
|
-
* @description Amount in decimal.
|
|
269
|
-
|
|
270
|
-
*/
|
|
271
|
-
|
|
272
99
|
amount_in_decimal?:string;
|
|
273
100
|
|
|
274
|
-
/**
|
|
275
|
-
* @description The currency code (ISO 4217 format) for promotional credit.
|
|
276
|
-
|
|
277
|
-
*/
|
|
278
|
-
|
|
279
101
|
currency_code?:string;
|
|
280
102
|
|
|
281
|
-
/**
|
|
282
|
-
* @description Detailed description of this promotional credits.
|
|
283
|
-
|
|
284
|
-
*/
|
|
285
|
-
|
|
286
103
|
description:string;
|
|
287
104
|
|
|
288
|
-
/**
|
|
289
|
-
* @description Type of promotional credits provided to customer. \* general - General \* referral_rewards - Referral \* loyalty_credits - Loyalty Credits
|
|
290
|
-
|
|
291
|
-
*/
|
|
292
|
-
|
|
293
105
|
credit_type?:CreditType;
|
|
294
106
|
|
|
295
|
-
/**
|
|
296
|
-
* @description Describes why promotional credits were provided.
|
|
297
|
-
|
|
298
|
-
*/
|
|
299
|
-
|
|
300
107
|
reference?:string;
|
|
301
108
|
}
|
|
302
109
|
export interface ListResponse {
|
|
303
|
-
/**
|
|
304
|
-
* @description This endpoint lists the promotional credits set for a customer
|
|
305
|
-
|
|
306
|
-
*/
|
|
307
|
-
|
|
308
110
|
list:{promotional_credit:PromotionalCredit}[];
|
|
309
111
|
|
|
310
|
-
/**
|
|
311
|
-
* @description This endpoint lists the promotional credits set for a customer
|
|
312
|
-
|
|
313
|
-
*/
|
|
314
|
-
|
|
315
112
|
next_offset?:string;
|
|
316
113
|
}
|
|
317
114
|
export interface ListInputParam {
|
|
318
115
|
[key : string]: any;
|
|
319
116
|
/**
|
|
320
|
-
* @description
|
|
117
|
+
* @description The number of resources to be returned.
|
|
321
118
|
|
|
322
119
|
*/
|
|
323
120
|
|
|
324
121
|
limit?:number;
|
|
325
122
|
|
|
326
123
|
/**
|
|
327
|
-
* @description
|
|
124
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
328
125
|
|
|
329
126
|
*/
|
|
330
127
|
|
|
331
128
|
offset?:string;
|
|
332
129
|
|
|
333
130
|
/**
|
|
334
|
-
* @description
|
|
131
|
+
* @description Unique reference ID provided for promotional credits
|
|
335
132
|
|
|
336
133
|
*/
|
|
337
134
|
|
|
338
135
|
id?:{is?:string,is_not?:string,starts_with?:string};
|
|
339
136
|
|
|
340
137
|
/**
|
|
341
|
-
* @description
|
|
138
|
+
* @description Timestamp indicating when this promotional credit resource is created.
|
|
342
139
|
|
|
343
140
|
*/
|
|
344
141
|
|
|
345
142
|
created_at?:{after?:string,before?:string,between?:string,on?:string};
|
|
346
143
|
|
|
347
144
|
/**
|
|
348
|
-
* @description
|
|
145
|
+
* @description Type of promotional credits
|
|
349
146
|
|
|
350
147
|
*/
|
|
351
148
|
|
|
352
|
-
type?:{in?:string,is?:'
|
|
149
|
+
type?:{in?:string,is?:'increment' | 'decrement',is_not?:'increment' | 'decrement',not_in?:string};
|
|
353
150
|
|
|
354
151
|
/**
|
|
355
|
-
* @description
|
|
152
|
+
* @description Identifier of the customer.
|
|
356
153
|
|
|
357
154
|
*/
|
|
358
155
|
|
|
@@ -34,7 +34,7 @@ declare module 'chargebee' {
|
|
|
34
34
|
|
|
35
35
|
statement_descriptor?:{descriptor?:string};
|
|
36
36
|
|
|
37
|
-
payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
|
|
37
|
+
payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact',reference_id?:string};
|
|
38
38
|
|
|
39
39
|
purchase_items:{index:number,item_price_id:string,quantity?:number,quantity_in_decimal?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
|
|
40
40
|
|
|
@@ -42,7 +42,7 @@ declare module 'chargebee' {
|
|
|
42
42
|
|
|
43
43
|
shipping_addresses?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string}[];
|
|
44
44
|
|
|
45
|
-
discounts?:{amount?:number,coupon_id?:string,included_in_mrr?:boolean,index?:number,percentage?:number}[];
|
|
45
|
+
discounts?:{amount?:number,coupon_id?:string,included_in_mrr?:boolean,index?:number,percentage?:number,quantity?:number}[];
|
|
46
46
|
|
|
47
47
|
subscription_info:{billing_cycles?:number,contract_term_billing_cycle_on_renewal?:number,index:number,meta_data?:object,subscription_id?:string}[];
|
|
48
48
|
|
|
@@ -51,6 +51,8 @@ declare module 'chargebee' {
|
|
|
51
51
|
customer_id:string;
|
|
52
52
|
|
|
53
53
|
payment_source_id?:string;
|
|
54
|
+
|
|
55
|
+
replace_primary_payment_source?:boolean;
|
|
54
56
|
}
|
|
55
57
|
export interface EstimateResponse {
|
|
56
58
|
estimate:Estimate;
|
|
@@ -67,7 +69,7 @@ declare module 'chargebee' {
|
|
|
67
69
|
|
|
68
70
|
shipping_addresses?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string}[];
|
|
69
71
|
|
|
70
|
-
discounts?:{amount?:number,coupon_id?:string,included_in_mrr?:boolean,index?:number,percentage?:number}[];
|
|
72
|
+
discounts?:{amount?:number,coupon_id?:string,included_in_mrr?:boolean,index?:number,percentage?:number,quantity?:number}[];
|
|
71
73
|
|
|
72
74
|
subscription_info:{billing_cycles?:number,contract_term_billing_cycle_on_renewal?:number,index:number,subscription_id?:string}[];
|
|
73
75
|
|
|
@@ -135,6 +135,8 @@ declare module 'chargebee' {
|
|
|
135
135
|
quoted_subscription?:QuotedSubscription;
|
|
136
136
|
|
|
137
137
|
quoted_charge?:QuotedCharge;
|
|
138
|
+
|
|
139
|
+
quoted_ramp?:QuotedRamp;
|
|
138
140
|
}
|
|
139
141
|
|
|
140
142
|
export interface CreateSubForCustomerQuoteResponse {
|
|
@@ -363,9 +365,11 @@ declare module 'chargebee' {
|
|
|
363
365
|
quote:Quote;
|
|
364
366
|
|
|
365
367
|
quoted_subscription?:QuotedSubscription;
|
|
368
|
+
|
|
369
|
+
quoted_ramp?:QuotedRamp;
|
|
366
370
|
}
|
|
367
371
|
export interface CreateSubItemsForCustomerQuoteInputParam {
|
|
368
|
-
|
|
372
|
+
|
|
369
373
|
subscription?:{contract_term_billing_cycle_on_renewal?:number,id?:string,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
370
374
|
|
|
371
375
|
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
@@ -376,7 +380,7 @@ declare module 'chargebee' {
|
|
|
376
380
|
|
|
377
381
|
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,end_date?:number,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,ramp_tier_id?:string,service_period_days?:number,start_date?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
378
382
|
|
|
379
|
-
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,end_date?:number,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit,start_date?:number}[];
|
|
383
|
+
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,end_date?:number,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit,quantity?:number,start_date?:number}[];
|
|
380
384
|
|
|
381
385
|
item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,ramp_tier_id?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
|
|
382
386
|
|
|
@@ -406,9 +410,11 @@ declare module 'chargebee' {
|
|
|
406
410
|
quote:Quote;
|
|
407
411
|
|
|
408
412
|
quoted_subscription?:QuotedSubscription;
|
|
413
|
+
|
|
414
|
+
quoted_ramp?:QuotedRamp;
|
|
409
415
|
}
|
|
410
416
|
export interface EditCreateSubCustomerQuoteForItemsInputParam {
|
|
411
|
-
|
|
417
|
+
|
|
412
418
|
subscription?:{contract_term_billing_cycle_on_renewal?:number,id?:string,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
413
419
|
|
|
414
420
|
shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
@@ -419,7 +425,7 @@ declare module 'chargebee' {
|
|
|
419
425
|
|
|
420
426
|
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,end_date?:number,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,ramp_tier_id?:string,service_period_days?:number,start_date?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
421
427
|
|
|
422
|
-
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,end_date?:number,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit,start_date?:number}[];
|
|
428
|
+
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,end_date?:number,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit,quantity?:number,start_date?:number}[];
|
|
423
429
|
|
|
424
430
|
item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,ramp_tier_id?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
|
|
425
431
|
|
|
@@ -447,9 +453,11 @@ declare module 'chargebee' {
|
|
|
447
453
|
quote:Quote;
|
|
448
454
|
|
|
449
455
|
quoted_subscription?:QuotedSubscription;
|
|
456
|
+
|
|
457
|
+
quoted_ramp?:QuotedRamp;
|
|
450
458
|
}
|
|
451
459
|
export interface UpdateSubscriptionQuoteForItemsInputParam {
|
|
452
|
-
|
|
460
|
+
|
|
453
461
|
subscription:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,id:string,offline_payment_method?:OfflinePaymentMethod,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
454
462
|
|
|
455
463
|
billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
@@ -462,7 +470,7 @@ declare module 'chargebee' {
|
|
|
462
470
|
|
|
463
471
|
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,end_date?:number,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,ramp_tier_id?:string,service_period_days?:number,start_date?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
464
472
|
|
|
465
|
-
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,end_date?:number,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit,start_date?:number}[];
|
|
473
|
+
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,end_date?:number,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit,quantity?:number,start_date?:number}[];
|
|
466
474
|
|
|
467
475
|
item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,ramp_tier_id?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
|
|
468
476
|
|
|
@@ -504,9 +512,11 @@ declare module 'chargebee' {
|
|
|
504
512
|
quote:Quote;
|
|
505
513
|
|
|
506
514
|
quoted_subscription?:QuotedSubscription;
|
|
515
|
+
|
|
516
|
+
quoted_ramp?:QuotedRamp;
|
|
507
517
|
}
|
|
508
518
|
export interface EditUpdateSubscriptionQuoteForItemsInputParam {
|
|
509
|
-
|
|
519
|
+
|
|
510
520
|
subscription?:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,offline_payment_method?:OfflinePaymentMethod,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
511
521
|
|
|
512
522
|
billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
|
|
@@ -519,7 +529,7 @@ declare module 'chargebee' {
|
|
|
519
529
|
|
|
520
530
|
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,end_date?:number,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,ramp_tier_id?:string,service_period_days?:number,start_date?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
521
531
|
|
|
522
|
-
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,end_date?:number,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit,start_date?:number}[];
|
|
532
|
+
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,end_date?:number,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit,quantity?:number,start_date?:number}[];
|
|
523
533
|
|
|
524
534
|
item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,package_size?:number,price?:number,price_in_decimal?:string,pricing_type?:PricingType,ramp_tier_id?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
|
|
525
535
|
|
|
@@ -572,7 +582,7 @@ declare module 'chargebee' {
|
|
|
572
582
|
|
|
573
583
|
charges?:{amount?:number,amount_in_decimal?:string,avalara_sale_type?:AvalaraSaleType,avalara_service_type?:number,avalara_transaction_type?:number,description?:string,service_period?:number}[];
|
|
574
584
|
|
|
575
|
-
discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
|
|
585
|
+
discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number,quantity?:number}[];
|
|
576
586
|
|
|
577
587
|
tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
|
|
578
588
|
|
|
@@ -609,7 +619,7 @@ declare module 'chargebee' {
|
|
|
609
619
|
|
|
610
620
|
charges?:{amount?:number,amount_in_decimal?:string,avalara_sale_type?:AvalaraSaleType,avalara_service_type?:number,avalara_transaction_type?:number,description?:string,service_period?:number}[];
|
|
611
621
|
|
|
612
|
-
discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
|
|
622
|
+
discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number,quantity?:number}[];
|
|
613
623
|
|
|
614
624
|
tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
|
|
615
625
|
|
|
@@ -626,7 +636,7 @@ declare module 'chargebee' {
|
|
|
626
636
|
coupon_ids?:string[];
|
|
627
637
|
}
|
|
628
638
|
export interface ListResponse {
|
|
629
|
-
list:{quote:Quote,quoted_subscription?:QuotedSubscription}[];
|
|
639
|
+
list:{quote:Quote,quoted_subscription?:QuotedSubscription,quoted_ramp?:QuotedRamp}[];
|
|
630
640
|
|
|
631
641
|
next_offset?:string;
|
|
632
642
|
}
|
|
@@ -640,7 +650,7 @@ declare module 'chargebee' {
|
|
|
640
650
|
limit?:number;
|
|
641
651
|
|
|
642
652
|
/**
|
|
643
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
653
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
644
654
|
|
|
645
655
|
*/
|
|
646
656
|
|
|
@@ -696,7 +706,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
696
706
|
|
|
697
707
|
updated_at?:{after?:string,before?:string,between?:string,on?:string};
|
|
698
708
|
|
|
699
|
-
sort_by?:
|
|
709
|
+
sort_by?:object;
|
|
700
710
|
}
|
|
701
711
|
export interface QuoteLineGroupsForQuoteResponse {
|
|
702
712
|
list:{quote_line_group:QuoteLineGroup}[];
|
|
@@ -713,7 +723,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
713
723
|
limit?:number;
|
|
714
724
|
|
|
715
725
|
/**
|
|
716
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
726
|
+
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
|
|
717
727
|
|
|
718
728
|
*/
|
|
719
729
|
|
|
@@ -726,6 +736,8 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
726
736
|
|
|
727
737
|
quoted_charge?:QuotedCharge;
|
|
728
738
|
|
|
739
|
+
quoted_ramp?:QuotedRamp;
|
|
740
|
+
|
|
729
741
|
customer:Customer;
|
|
730
742
|
|
|
731
743
|
subscription?:Subscription;
|
|
@@ -754,6 +766,8 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
754
766
|
quoted_subscription?:QuotedSubscription;
|
|
755
767
|
|
|
756
768
|
quoted_charge?:QuotedCharge;
|
|
769
|
+
|
|
770
|
+
quoted_ramp?:QuotedRamp;
|
|
757
771
|
}
|
|
758
772
|
export interface UpdateStatusInputParam {
|
|
759
773
|
|
|
@@ -767,6 +781,8 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
767
781
|
quoted_subscription?:QuotedSubscription;
|
|
768
782
|
|
|
769
783
|
quoted_charge?:QuotedCharge;
|
|
784
|
+
|
|
785
|
+
quoted_ramp?:QuotedRamp;
|
|
770
786
|
}
|
|
771
787
|
export interface ExtendExpiryDateInputParam {
|
|
772
788
|
|
|
@@ -778,6 +794,8 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
778
794
|
quoted_subscription?:QuotedSubscription;
|
|
779
795
|
|
|
780
796
|
quoted_charge?:QuotedCharge;
|
|
797
|
+
|
|
798
|
+
quoted_ramp?:QuotedRamp;
|
|
781
799
|
}
|
|
782
800
|
export interface DeleteInputParam {
|
|
783
801
|
|
|
@@ -14,6 +14,8 @@ declare module 'chargebee' {
|
|
|
14
14
|
|
|
15
15
|
coupons?:QuotedCharge.Coupon[];
|
|
16
16
|
|
|
17
|
+
coupon_applicability_mappings?:QuotedCharge.CouponApplicabilityMapping[];
|
|
18
|
+
|
|
17
19
|
}
|
|
18
20
|
export namespace QuotedCharge {
|
|
19
21
|
|
|
@@ -85,5 +87,10 @@ declare module 'chargebee' {
|
|
|
85
87
|
export interface Coupon {
|
|
86
88
|
coupon_id:string;
|
|
87
89
|
}
|
|
90
|
+
export interface CouponApplicabilityMapping {
|
|
91
|
+
coupon_id?:string;
|
|
92
|
+
|
|
93
|
+
applicable_item_price_ids?:string[];
|
|
94
|
+
}
|
|
88
95
|
}
|
|
89
96
|
}
|
|
@@ -12,6 +12,8 @@ declare module 'chargebee' {
|
|
|
12
12
|
|
|
13
13
|
item_tiers?:QuotedRamp.ItemTier[];
|
|
14
14
|
|
|
15
|
+
coupon_applicability_mappings?:QuotedRamp.CouponApplicabilityMapping[];
|
|
16
|
+
|
|
15
17
|
}
|
|
16
18
|
export namespace QuotedRamp {
|
|
17
19
|
|
|
@@ -59,14 +61,6 @@ declare module 'chargebee' {
|
|
|
59
61
|
|
|
60
62
|
ramp_tier_id?:string;
|
|
61
63
|
|
|
62
|
-
discount_amount?:number;
|
|
63
|
-
|
|
64
|
-
md_discount_amount?:string;
|
|
65
|
-
|
|
66
|
-
item_level_discount_amount?:number;
|
|
67
|
-
|
|
68
|
-
md_item_level_discount_amount?:string;
|
|
69
|
-
|
|
70
64
|
discount_per_billing_cycle?:number;
|
|
71
65
|
|
|
72
66
|
discount_per_billing_cycle_in_decimal?:string;
|
|
@@ -75,10 +69,6 @@ declare module 'chargebee' {
|
|
|
75
69
|
|
|
76
70
|
item_level_discount_per_billing_cycle_in_decimal?:string;
|
|
77
71
|
|
|
78
|
-
net_amount?:number;
|
|
79
|
-
|
|
80
|
-
md_net_amount?:string;
|
|
81
|
-
|
|
82
72
|
amount_per_billing_cycle?:number;
|
|
83
73
|
|
|
84
74
|
amount_per_billing_cycle_in_decimal?:string;
|
|
@@ -90,8 +80,6 @@ declare module 'chargebee' {
|
|
|
90
80
|
export interface Discount {
|
|
91
81
|
id:string;
|
|
92
82
|
|
|
93
|
-
name:string;
|
|
94
|
-
|
|
95
83
|
invoice_name?:string;
|
|
96
84
|
|
|
97
85
|
type:'fixed_amount' | 'percentage';
|
|
@@ -114,8 +102,6 @@ declare module 'chargebee' {
|
|
|
114
102
|
|
|
115
103
|
apply_on:'invoice_amount' | 'specific_item_price';
|
|
116
104
|
|
|
117
|
-
apply_on_item_type?:'plan' | 'addon' | 'charge';
|
|
118
|
-
|
|
119
105
|
item_price_id?:string;
|
|
120
106
|
|
|
121
107
|
created_at:number;
|
|
@@ -142,6 +128,15 @@ declare module 'chargebee' {
|
|
|
142
128
|
price_in_decimal?:string;
|
|
143
129
|
|
|
144
130
|
ramp_tier_id?:string;
|
|
131
|
+
|
|
132
|
+
pricing_type?:'per_unit' | 'flat_fee' | 'package';
|
|
133
|
+
|
|
134
|
+
package_size?:number;
|
|
135
|
+
}
|
|
136
|
+
export interface CouponApplicabilityMapping {
|
|
137
|
+
coupon_id?:string;
|
|
138
|
+
|
|
139
|
+
applicable_item_price_ids?:string[];
|
|
145
140
|
}
|
|
146
141
|
}
|
|
147
142
|
}
|