chargebee 2.52.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 +56 -0
- package/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +90 -5
- package/package.json +1 -1
- package/types/core.d.ts +2 -2
- package/types/index.d.ts +8 -0
- package/types/resources/Addon.d.ts +3 -3
- package/types/resources/AttachedItem.d.ts +1 -1
- package/types/resources/BusinessEntity.d.ts +2 -2
- package/types/resources/Comment.d.ts +5 -3
- package/types/resources/Coupon.d.ts +4 -4
- package/types/resources/CouponCode.d.ts +1 -1
- package/types/resources/CouponSet.d.ts +1 -1
- package/types/resources/CreditNote.d.ts +89 -89
- package/types/resources/Customer.d.ts +7 -7
- package/types/resources/CustomerEntitlement.d.ts +3 -1
- package/types/resources/DifferentialPrice.d.ts +1 -1
- package/types/resources/Discount.d.ts +3 -1
- package/types/resources/Entitlement.d.ts +1 -1
- package/types/resources/EntitlementOverride.d.ts +1 -1
- package/types/resources/Estimate.d.ts +4 -4
- package/types/resources/Event.d.ts +3 -3
- package/types/resources/Feature.d.ts +3 -3
- package/types/resources/Gift.d.ts +1 -1
- package/types/resources/HostedPage.d.ts +4 -4
- package/types/resources/ImpactedCustomer.d.ts +23 -0
- package/types/resources/Invoice.d.ts +110 -110
- package/types/resources/Item.d.ts +4 -4
- package/types/resources/ItemEntitlement.d.ts +2 -2
- package/types/resources/ItemFamily.d.ts +3 -3
- package/types/resources/ItemPrice.d.ts +7 -7
- 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/PaymentSource.d.ts +2 -2
- package/types/resources/PaymentVoucher.d.ts +4 -4
- package/types/resources/Plan.d.ts +3 -3
- package/types/resources/PriceVariant.d.ts +2 -2
- package/types/resources/PricingPageSession.d.ts +2 -2
- package/types/resources/PromotionalCredit.d.ts +3 -1
- package/types/resources/Purchase.d.ts +2 -2
- package/types/resources/Quote.d.ts +13 -13
- package/types/resources/QuotedCharge.d.ts +7 -0
- package/types/resources/Ramp.d.ts +7 -7
- package/types/resources/RecordedPurchase.d.ts +6 -1
- package/types/resources/SiteMigrationDetail.d.ts +1 -1
- package/types/resources/Subscription.d.ts +22 -20
- package/types/resources/SubscriptionEntitlement.d.ts +1 -1
- package/types/resources/SubscriptionEntitlementsCreatedDetail.d.ts +12 -0
- package/types/resources/SubscriptionEntitlementsUpdatedDetail.d.ts +12 -0
- package/types/resources/Transaction.d.ts +6 -6
- package/types/resources/UnbilledCharge.d.ts +1 -1
- package/types/resources/Usage.d.ts +2 -2
- package/types/resources/UsageFile.d.ts +5 -5
- package/types/resources/VirtualBankAccount.d.ts +1 -1
- package/types/resources/WebhookEndpoint.d.ts +117 -0
|
@@ -50,7 +50,7 @@ declare module 'chargebee' {
|
|
|
50
50
|
limit?:number;
|
|
51
51
|
|
|
52
52
|
/**
|
|
53
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
53
|
+
* @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.
|
|
54
54
|
|
|
55
55
|
*/
|
|
56
56
|
|
|
@@ -80,7 +80,7 @@ declare module 'chargebee' {
|
|
|
80
80
|
limit?:number;
|
|
81
81
|
|
|
82
82
|
/**
|
|
83
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
83
|
+
* @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.
|
|
84
84
|
|
|
85
85
|
*/
|
|
86
86
|
|
|
@@ -58,7 +58,7 @@ declare module 'chargebee' {
|
|
|
58
58
|
limit?:number;
|
|
59
59
|
|
|
60
60
|
/**
|
|
61
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
61
|
+
* @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.
|
|
62
62
|
|
|
63
63
|
*/
|
|
64
64
|
|
|
@@ -316,7 +316,7 @@ declare module 'chargebee' {
|
|
|
316
316
|
limit?:number;
|
|
317
317
|
|
|
318
318
|
/**
|
|
319
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
319
|
+
* @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.
|
|
320
320
|
|
|
321
321
|
*/
|
|
322
322
|
|
|
@@ -429,7 +429,7 @@ declare module 'chargebee' {
|
|
|
429
429
|
|
|
430
430
|
original_order_id?:{is?:string,is_not?:string,starts_with?:string};
|
|
431
431
|
|
|
432
|
-
sort_by?:
|
|
432
|
+
sort_by?:object;
|
|
433
433
|
}
|
|
434
434
|
export interface OrdersForInvoiceResponse {
|
|
435
435
|
list:{order:Order}[];
|
|
@@ -446,7 +446,7 @@ declare module 'chargebee' {
|
|
|
446
446
|
limit?:number;
|
|
447
447
|
|
|
448
448
|
/**
|
|
449
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
449
|
+
* @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.
|
|
450
450
|
|
|
451
451
|
*/
|
|
452
452
|
|
|
@@ -258,7 +258,7 @@ declare module 'chargebee' {
|
|
|
258
258
|
limit?:number;
|
|
259
259
|
|
|
260
260
|
/**
|
|
261
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
261
|
+
* @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.
|
|
262
262
|
|
|
263
263
|
*/
|
|
264
264
|
|
|
@@ -303,7 +303,7 @@ declare module 'chargebee' {
|
|
|
303
303
|
|
|
304
304
|
created_at?:{after?:string,before?:string,between?:string,on?:string};
|
|
305
305
|
|
|
306
|
-
sort_by?:
|
|
306
|
+
sort_by?:object;
|
|
307
307
|
}
|
|
308
308
|
export interface SwitchGatewayAccountResponse {
|
|
309
309
|
customer:Customer;
|
|
@@ -87,7 +87,7 @@ declare module 'chargebee' {
|
|
|
87
87
|
limit?:number;
|
|
88
88
|
|
|
89
89
|
/**
|
|
90
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
90
|
+
* @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.
|
|
91
91
|
|
|
92
92
|
*/
|
|
93
93
|
|
|
@@ -100,7 +100,7 @@ declare module 'chargebee' {
|
|
|
100
100
|
|
|
101
101
|
status?:{in?:string,is?:'active' | 'consumed' | 'expired' | 'failure',is_not?:'active' | 'consumed' | 'expired' | 'failure',not_in?:string};
|
|
102
102
|
|
|
103
|
-
sort_by?:
|
|
103
|
+
sort_by?:object;
|
|
104
104
|
}
|
|
105
105
|
export interface PaymentVouchersForCustomerResponse {
|
|
106
106
|
list:{payment_voucher:PaymentVoucher}[];
|
|
@@ -117,7 +117,7 @@ declare module 'chargebee' {
|
|
|
117
117
|
limit?:number;
|
|
118
118
|
|
|
119
119
|
/**
|
|
120
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
120
|
+
* @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.
|
|
121
121
|
|
|
122
122
|
*/
|
|
123
123
|
|
|
@@ -130,7 +130,7 @@ declare module 'chargebee' {
|
|
|
130
130
|
|
|
131
131
|
status?:{in?:string,is?:'active' | 'consumed' | 'expired' | 'failure',is_not?:'active' | 'consumed' | 'expired' | 'failure',not_in?:string};
|
|
132
132
|
|
|
133
|
-
sort_by?:
|
|
133
|
+
sort_by?:object;
|
|
134
134
|
}
|
|
135
135
|
export interface LinkedInvoice {
|
|
136
136
|
invoice_id:string;
|
|
@@ -137,7 +137,7 @@ declare module 'chargebee' {
|
|
|
137
137
|
plan:Plan;
|
|
138
138
|
}
|
|
139
139
|
export interface CreateInputParam {
|
|
140
|
-
|
|
140
|
+
|
|
141
141
|
tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
|
|
142
142
|
|
|
143
143
|
tax_providers_fields:{field_id:string,field_value:string,provider_name:string}[];
|
|
@@ -246,7 +246,7 @@ declare module 'chargebee' {
|
|
|
246
246
|
plan:Plan;
|
|
247
247
|
}
|
|
248
248
|
export interface UpdateInputParam {
|
|
249
|
-
|
|
249
|
+
|
|
250
250
|
tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
|
|
251
251
|
|
|
252
252
|
tax_providers_fields:{field_id:string,field_value:string,provider_name:string}[];
|
|
@@ -358,7 +358,7 @@ declare module 'chargebee' {
|
|
|
358
358
|
limit?:number;
|
|
359
359
|
|
|
360
360
|
/**
|
|
361
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
361
|
+
* @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.
|
|
362
362
|
|
|
363
363
|
*/
|
|
364
364
|
|
|
@@ -102,7 +102,7 @@ declare module 'chargebee' {
|
|
|
102
102
|
limit?:number;
|
|
103
103
|
|
|
104
104
|
/**
|
|
105
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
105
|
+
* @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.
|
|
106
106
|
|
|
107
107
|
*/
|
|
108
108
|
|
|
@@ -156,7 +156,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
156
156
|
|
|
157
157
|
include_site_level_resources?:{is?:'true' | 'false'};
|
|
158
158
|
|
|
159
|
-
sort_by?:
|
|
159
|
+
sort_by?:object;
|
|
160
160
|
}
|
|
161
161
|
export interface Attribute {
|
|
162
162
|
name:string;
|
|
@@ -34,7 +34,7 @@ declare module 'chargebee' {
|
|
|
34
34
|
|
|
35
35
|
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};
|
|
36
36
|
|
|
37
|
-
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,label?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
37
|
+
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,label?:string,percentage?:number,period?:number,period_unit?:PeriodUnit,quantity?:number}[];
|
|
38
38
|
|
|
39
39
|
redirect_url?:string;
|
|
40
40
|
|
|
@@ -49,7 +49,7 @@ declare module 'chargebee' {
|
|
|
49
49
|
|
|
50
50
|
subscription:object;
|
|
51
51
|
|
|
52
|
-
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,label?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
52
|
+
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,label?:string,percentage?:number,period?:number,period_unit?:PeriodUnit,quantity?:number}[];
|
|
53
53
|
|
|
54
54
|
redirect_url?:string;
|
|
55
55
|
}
|
|
@@ -28,6 +28,8 @@ declare module 'chargebee' {
|
|
|
28
28
|
|
|
29
29
|
created_at:number;
|
|
30
30
|
|
|
31
|
+
business_entity_id?:string;
|
|
32
|
+
|
|
31
33
|
}
|
|
32
34
|
export namespace PromotionalCredit {
|
|
33
35
|
export class PromotionalCreditResource {
|
|
@@ -119,7 +121,7 @@ declare module 'chargebee' {
|
|
|
119
121
|
limit?:number;
|
|
120
122
|
|
|
121
123
|
/**
|
|
122
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
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.
|
|
123
125
|
|
|
124
126
|
*/
|
|
125
127
|
|
|
@@ -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
|
|
|
@@ -69,7 +69,7 @@ declare module 'chargebee' {
|
|
|
69
69
|
|
|
70
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}[];
|
|
71
71
|
|
|
72
|
-
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}[];
|
|
73
73
|
|
|
74
74
|
subscription_info:{billing_cycles?:number,contract_term_billing_cycle_on_renewal?:number,index:number,subscription_id?:string}[];
|
|
75
75
|
|
|
@@ -369,7 +369,7 @@ declare module 'chargebee' {
|
|
|
369
369
|
quoted_ramp?:QuotedRamp;
|
|
370
370
|
}
|
|
371
371
|
export interface CreateSubItemsForCustomerQuoteInputParam {
|
|
372
|
-
|
|
372
|
+
|
|
373
373
|
subscription?:{contract_term_billing_cycle_on_renewal?:number,id?:string,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
374
374
|
|
|
375
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};
|
|
@@ -380,7 +380,7 @@ declare module 'chargebee' {
|
|
|
380
380
|
|
|
381
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}[];
|
|
382
382
|
|
|
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,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}[];
|
|
384
384
|
|
|
385
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}[];
|
|
386
386
|
|
|
@@ -414,7 +414,7 @@ declare module 'chargebee' {
|
|
|
414
414
|
quoted_ramp?:QuotedRamp;
|
|
415
415
|
}
|
|
416
416
|
export interface EditCreateSubCustomerQuoteForItemsInputParam {
|
|
417
|
-
|
|
417
|
+
|
|
418
418
|
subscription?:{contract_term_billing_cycle_on_renewal?:number,id?:string,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
419
419
|
|
|
420
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};
|
|
@@ -425,7 +425,7 @@ declare module 'chargebee' {
|
|
|
425
425
|
|
|
426
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}[];
|
|
427
427
|
|
|
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,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}[];
|
|
429
429
|
|
|
430
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}[];
|
|
431
431
|
|
|
@@ -457,7 +457,7 @@ declare module 'chargebee' {
|
|
|
457
457
|
quoted_ramp?:QuotedRamp;
|
|
458
458
|
}
|
|
459
459
|
export interface UpdateSubscriptionQuoteForItemsInputParam {
|
|
460
|
-
|
|
460
|
+
|
|
461
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};
|
|
462
462
|
|
|
463
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};
|
|
@@ -470,7 +470,7 @@ declare module 'chargebee' {
|
|
|
470
470
|
|
|
471
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}[];
|
|
472
472
|
|
|
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,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}[];
|
|
474
474
|
|
|
475
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}[];
|
|
476
476
|
|
|
@@ -516,7 +516,7 @@ declare module 'chargebee' {
|
|
|
516
516
|
quoted_ramp?:QuotedRamp;
|
|
517
517
|
}
|
|
518
518
|
export interface EditUpdateSubscriptionQuoteForItemsInputParam {
|
|
519
|
-
|
|
519
|
+
|
|
520
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};
|
|
521
521
|
|
|
522
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};
|
|
@@ -529,7 +529,7 @@ declare module 'chargebee' {
|
|
|
529
529
|
|
|
530
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}[];
|
|
531
531
|
|
|
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,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}[];
|
|
533
533
|
|
|
534
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}[];
|
|
535
535
|
|
|
@@ -582,7 +582,7 @@ declare module 'chargebee' {
|
|
|
582
582
|
|
|
583
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}[];
|
|
584
584
|
|
|
585
|
-
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}[];
|
|
586
586
|
|
|
587
587
|
tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
|
|
588
588
|
|
|
@@ -619,7 +619,7 @@ declare module 'chargebee' {
|
|
|
619
619
|
|
|
620
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}[];
|
|
621
621
|
|
|
622
|
-
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}[];
|
|
623
623
|
|
|
624
624
|
tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
|
|
625
625
|
|
|
@@ -650,7 +650,7 @@ declare module 'chargebee' {
|
|
|
650
650
|
limit?:number;
|
|
651
651
|
|
|
652
652
|
/**
|
|
653
|
-
* @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.
|
|
654
654
|
|
|
655
655
|
*/
|
|
656
656
|
|
|
@@ -706,7 +706,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
706
706
|
|
|
707
707
|
updated_at?:{after?:string,before?:string,between?:string,on?:string};
|
|
708
708
|
|
|
709
|
-
sort_by?:
|
|
709
|
+
sort_by?:object;
|
|
710
710
|
}
|
|
711
711
|
export interface QuoteLineGroupsForQuoteResponse {
|
|
712
712
|
list:{quote_line_group:QuoteLineGroup}[];
|
|
@@ -723,7 +723,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
723
723
|
limit?:number;
|
|
724
724
|
|
|
725
725
|
/**
|
|
726
|
-
* @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.
|
|
727
727
|
|
|
728
728
|
*/
|
|
729
729
|
|
|
@@ -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
|
}
|
|
@@ -83,15 +83,15 @@ declare module 'chargebee' {
|
|
|
83
83
|
}
|
|
84
84
|
export interface UpdateInputParam {
|
|
85
85
|
|
|
86
|
-
items_to_add:{billing_cycles?:
|
|
86
|
+
items_to_add:{billing_cycles?:any,item_price_id:any,quantity?:any,quantity_in_decimal?:any,service_period_days?:any,unit_price?:any,unit_price_in_decimal?:any}[];
|
|
87
87
|
|
|
88
|
-
items_to_update:{billing_cycles?:
|
|
88
|
+
items_to_update:{billing_cycles?:any,item_price_id:any,quantity?:any,quantity_in_decimal?:any,service_period_days?:any,unit_price?:any,unit_price_in_decimal?:any}[];
|
|
89
89
|
|
|
90
|
-
item_tiers?:{ending_unit?:
|
|
90
|
+
item_tiers?:{ending_unit?:any,ending_unit_in_decimal?:any,item_price_id?:any,package_size?:any,price?:any,price_in_decimal?:any,pricing_type?:any,starting_unit?:any,starting_unit_in_decimal?:any}[];
|
|
91
91
|
|
|
92
|
-
coupons_to_add?:{apply_till?:
|
|
92
|
+
coupons_to_add?:{apply_till?:any,coupon_id?:any}[];
|
|
93
93
|
|
|
94
|
-
discounts_to_add:{amount?:
|
|
94
|
+
discounts_to_add:{amount?:any,apply_on:any,duration_type:any,included_in_mrr?:any,item_price_id?:any,percentage?:any,period?:any,period_unit?:any}[];
|
|
95
95
|
|
|
96
96
|
effective_from:number;
|
|
97
97
|
|
|
@@ -126,7 +126,7 @@ declare module 'chargebee' {
|
|
|
126
126
|
limit?:number;
|
|
127
127
|
|
|
128
128
|
/**
|
|
129
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
129
|
+
* @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.
|
|
130
130
|
|
|
131
131
|
*/
|
|
132
132
|
|
|
@@ -167,7 +167,7 @@ declare module 'chargebee' {
|
|
|
167
167
|
|
|
168
168
|
updated_at?:{after?:string,before?:string,between?:string,on?:string};
|
|
169
169
|
|
|
170
|
-
sort_by?:
|
|
170
|
+
sort_by?:object;
|
|
171
171
|
}
|
|
172
172
|
export interface ItemsToAdd {
|
|
173
173
|
item_price_id:string;
|
|
@@ -22,6 +22,8 @@ declare module 'chargebee' {
|
|
|
22
22
|
|
|
23
23
|
linked_omnichannel_subscriptions?:RecordedPurchase.LinkedOmnichannelSubscription[];
|
|
24
24
|
|
|
25
|
+
linked_omnichannel_one_time_orders?:RecordedPurchase.LinkedOmnichannelOneTimeOrder[];
|
|
26
|
+
|
|
25
27
|
error_detail?:RecordedPurchase.ErrorDetail;
|
|
26
28
|
|
|
27
29
|
}
|
|
@@ -42,7 +44,7 @@ declare module 'chargebee' {
|
|
|
42
44
|
|
|
43
45
|
apple_app_store?:{product_id?:string,receipt?:string,transaction_id?:string};
|
|
44
46
|
|
|
45
|
-
google_play_store?:{purchase_token?:string};
|
|
47
|
+
google_play_store?:{order_id?:string,product_id?:string,purchase_token?:string};
|
|
46
48
|
|
|
47
49
|
omnichannel_subscription?:{id?:string};
|
|
48
50
|
|
|
@@ -55,6 +57,9 @@ declare module 'chargebee' {
|
|
|
55
57
|
export interface LinkedOmnichannelSubscription {
|
|
56
58
|
omnichannel_subscription_id?:string;
|
|
57
59
|
}
|
|
60
|
+
export interface LinkedOmnichannelOneTimeOrder {
|
|
61
|
+
omnichannel_one_time_order_id?:string;
|
|
62
|
+
}
|
|
58
63
|
export interface ErrorDetail {
|
|
59
64
|
error_message?:string;
|
|
60
65
|
}
|
|
@@ -36,7 +36,7 @@ declare module 'chargebee' {
|
|
|
36
36
|
limit?:number;
|
|
37
37
|
|
|
38
38
|
/**
|
|
39
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
39
|
+
* @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.
|
|
40
40
|
|
|
41
41
|
*/
|
|
42
42
|
|
|
@@ -253,7 +253,7 @@ declare module 'chargebee' {
|
|
|
253
253
|
unbilled_charges?:UnbilledCharge[];
|
|
254
254
|
}
|
|
255
255
|
export interface CreateInputParam {
|
|
256
|
-
|
|
256
|
+
|
|
257
257
|
customer?:object;
|
|
258
258
|
|
|
259
259
|
card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway?:Gateway,gateway_account_id?:string,ip_address?:string,last_name?:string,number?:string,preferred_scheme?:'cartes_bancaires' | 'mastercard' | 'visa',tmp_token?:string};
|
|
@@ -356,7 +356,7 @@ declare module 'chargebee' {
|
|
|
356
356
|
unbilled_charges?:UnbilledCharge[];
|
|
357
357
|
}
|
|
358
358
|
export interface CreateForCustomerInputParam {
|
|
359
|
-
|
|
359
|
+
|
|
360
360
|
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};
|
|
361
361
|
|
|
362
362
|
statement_descriptor?:{descriptor?:string};
|
|
@@ -443,7 +443,7 @@ declare module 'chargebee' {
|
|
|
443
443
|
unbilled_charges?:UnbilledCharge[];
|
|
444
444
|
}
|
|
445
445
|
export interface CreateWithItemsInputParam {
|
|
446
|
-
|
|
446
|
+
|
|
447
447
|
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};
|
|
448
448
|
|
|
449
449
|
statement_descriptor?:{descriptor?:string};
|
|
@@ -456,7 +456,7 @@ declare module 'chargebee' {
|
|
|
456
456
|
|
|
457
457
|
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string,usage_accumulation_reset_frequency?:UsageAccumulationResetFrequency}[];
|
|
458
458
|
|
|
459
|
-
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
459
|
+
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit,quantity?:number}[];
|
|
460
460
|
|
|
461
461
|
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,starting_unit?:number,starting_unit_in_decimal?:string}[];
|
|
462
462
|
|
|
@@ -535,7 +535,7 @@ declare module 'chargebee' {
|
|
|
535
535
|
limit?:number;
|
|
536
536
|
|
|
537
537
|
/**
|
|
538
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
538
|
+
* @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.
|
|
539
539
|
|
|
540
540
|
*/
|
|
541
541
|
|
|
@@ -620,7 +620,7 @@ declare module 'chargebee' {
|
|
|
620
620
|
created_at?:{after?:string,before?:string,between?:string,on?:string};
|
|
621
621
|
|
|
622
622
|
/**
|
|
623
|
-
* @description Time at which the subscription
|
|
623
|
+
* @description Time at which the subscription?`status`?last changed to? `active`. For example, this value is updated when an?`in_trial`?or? `cancelled`?subscription activates.
|
|
624
624
|
|
|
625
625
|
*/
|
|
626
626
|
|
|
@@ -675,7 +675,7 @@ declare module 'chargebee' {
|
|
|
675
675
|
|
|
676
676
|
override_relationship?:{is?:'true' | 'false'};
|
|
677
677
|
|
|
678
|
-
sort_by?:
|
|
678
|
+
sort_by?:object;
|
|
679
679
|
|
|
680
680
|
/**
|
|
681
681
|
* @description The unique ID of the [business entity](/docs/api?prod_cat_ver=2#mbe) of this subscription. This is always the same as the [business entity](/docs/api/subscriptions?prod_cat_ver=2#subscription_customer_id) of the customer.
|
|
@@ -710,7 +710,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
710
710
|
limit?:number;
|
|
711
711
|
|
|
712
712
|
/**
|
|
713
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
713
|
+
* @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.
|
|
714
714
|
|
|
715
715
|
*/
|
|
716
716
|
|
|
@@ -731,13 +731,13 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
731
731
|
limit?:number;
|
|
732
732
|
|
|
733
733
|
/**
|
|
734
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
734
|
+
* @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.
|
|
735
735
|
|
|
736
736
|
*/
|
|
737
737
|
|
|
738
738
|
offset?:string;
|
|
739
739
|
|
|
740
|
-
sort_by?:
|
|
740
|
+
sort_by?:object;
|
|
741
741
|
}
|
|
742
742
|
export interface ListDiscountsResponse {
|
|
743
743
|
list:{discount:Discount}[];
|
|
@@ -754,7 +754,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
754
754
|
limit?:number;
|
|
755
755
|
|
|
756
756
|
/**
|
|
757
|
-
* @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
|
|
757
|
+
* @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.
|
|
758
758
|
|
|
759
759
|
*/
|
|
760
760
|
|
|
@@ -826,7 +826,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
826
826
|
credit_notes?:CreditNote[];
|
|
827
827
|
}
|
|
828
828
|
export interface UpdateInputParam {
|
|
829
|
-
|
|
829
|
+
|
|
830
830
|
card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway?:Gateway,gateway_account_id?:string,ip_address?:string,last_name?:string,number?:string,preferred_scheme?:'cartes_bancaires' | 'mastercard' | 'visa',tmp_token?:string};
|
|
831
831
|
|
|
832
832
|
payment_method?:{additional_information?:object,gateway?:Gateway,gateway_account_id?:string,issuing_country?:string,reference_id?:string,tmp_token?:string,type?:Type};
|
|
@@ -935,7 +935,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
935
935
|
credit_notes?:CreditNote[];
|
|
936
936
|
}
|
|
937
937
|
export interface UpdateForItemsInputParam {
|
|
938
|
-
|
|
938
|
+
|
|
939
939
|
card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway?:Gateway,gateway_account_id?:string,ip_address?:string,last_name?:string,number?:string,preferred_scheme?:'cartes_bancaires' | 'mastercard' | 'visa',tmp_token?:string};
|
|
940
940
|
|
|
941
941
|
payment_method?:{additional_information?:object,gateway?:Gateway,gateway_account_id?:string,issuing_country?:string,reference_id?:string,tmp_token?:string,type?:Type};
|
|
@@ -956,7 +956,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
956
956
|
|
|
957
957
|
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,proration_type?:ProrationType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string,usage_accumulation_reset_frequency?:UsageAccumulationResetFrequency}[];
|
|
958
958
|
|
|
959
|
-
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
959
|
+
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit,quantity?:number}[];
|
|
960
960
|
|
|
961
961
|
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,starting_unit?:number,starting_unit_in_decimal?:string}[];
|
|
962
962
|
|
|
@@ -1208,7 +1208,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
1208
1208
|
invoice?:Invoice;
|
|
1209
1209
|
}
|
|
1210
1210
|
export interface ImportSubscriptionInputParam {
|
|
1211
|
-
|
|
1211
|
+
|
|
1212
1212
|
customer?:object;
|
|
1213
1213
|
|
|
1214
1214
|
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',billing_cycle?:number,cancellation_cutoff_period?:number,contract_start?:number,created_at?:number,id?:string,total_amount_raised?:number,total_amount_raised_before_tax?:number};
|
|
@@ -1297,7 +1297,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
1297
1297
|
invoice?:Invoice;
|
|
1298
1298
|
}
|
|
1299
1299
|
export interface ImportForCustomerInputParam {
|
|
1300
|
-
|
|
1300
|
+
|
|
1301
1301
|
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',billing_cycle?:number,cancellation_cutoff_period?:number,contract_start?:number,created_at?:number,id?:string,total_amount_raised?:number,total_amount_raised_before_tax?:number};
|
|
1302
1302
|
|
|
1303
1303
|
transaction?:{amount?:number,date?:number,payment_method?:PaymentMethod,reference_number?:string};
|
|
@@ -1380,7 +1380,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
1380
1380
|
}
|
|
1381
1381
|
export interface ImportUnbilledChargesInputParam {
|
|
1382
1382
|
|
|
1383
|
-
unbilled_charges:{amount?:number,amount_in_decimal?:string,date_from:number,date_to:number,description?:string,discount_amount?:number,entity_id?:string,entity_type:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price',id?:string,is_advance_charge?:boolean,quantity?:number,quantity_in_decimal?:string,unit_amount?:number,unit_amount_in_decimal?:string,use_for_proration?:boolean}[];
|
|
1383
|
+
unbilled_charges:{amount?:number,amount_in_decimal?:string,date_from:number,date_to:number,description?:string,discount_amount?:number,entity_id?:string,entity_type:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'plan_setup' | 'plan' | 'addon',id?:string,is_advance_charge?:boolean,quantity?:number,quantity_in_decimal?:string,unit_amount?:number,unit_amount_in_decimal?:string,use_for_proration?:boolean}[];
|
|
1384
1384
|
|
|
1385
1385
|
discounts:{amount:number,description?:string,entity_id?:string,entity_type?:'item_level_coupon' | 'document_level_coupon' | 'item_level_discount' | 'document_level_discount',unbilled_charge_id?:string}[];
|
|
1386
1386
|
|
|
@@ -1396,7 +1396,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
1396
1396
|
invoice?:Invoice;
|
|
1397
1397
|
}
|
|
1398
1398
|
export interface ImportForItemsInputParam {
|
|
1399
|
-
|
|
1399
|
+
|
|
1400
1400
|
contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',billing_cycle?:number,cancellation_cutoff_period?:number,contract_start?:number,created_at?:number,id?:string,total_amount_raised?:number,total_amount_raised_before_tax?:number};
|
|
1401
1401
|
|
|
1402
1402
|
transaction?:{amount?:number,date?:number,payment_method?:PaymentMethod,reference_number?:string};
|
|
@@ -1405,7 +1405,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
1405
1405
|
|
|
1406
1406
|
subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
|
|
1407
1407
|
|
|
1408
|
-
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
|
|
1408
|
+
discounts:{amount?:number,apply_on?:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit,quantity?:number}[];
|
|
1409
1409
|
|
|
1410
1410
|
charged_items?:{item_price_id?:string,last_charged_at?:number}[];
|
|
1411
1411
|
|
|
@@ -1861,12 +1861,14 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
1861
1861
|
|
|
1862
1862
|
invoice_name?:string;
|
|
1863
1863
|
|
|
1864
|
-
type:'fixed_amount' | 'percentage';
|
|
1864
|
+
type:'fixed_amount' | 'percentage' | 'offer_quantity';
|
|
1865
1865
|
|
|
1866
1866
|
percentage?:number;
|
|
1867
1867
|
|
|
1868
1868
|
amount?:number;
|
|
1869
1869
|
|
|
1870
|
+
quantity?:number;
|
|
1871
|
+
|
|
1870
1872
|
currency_code?:string;
|
|
1871
1873
|
|
|
1872
1874
|
duration_type:'one_time' | 'forever' | 'limited_period';
|