chargebee 3.10.0 → 3.11.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 +27 -0
- package/cjs/environment.js +1 -1
- package/cjs/resources/api_endpoints.js +13 -0
- package/esm/environment.js +1 -1
- package/esm/resources/api_endpoints.js +13 -0
- package/package.json +1 -1
- package/types/core.d.ts +7 -3
- package/types/index.d.ts +2 -0
- package/types/resources/BillingConfiguration.d.ts +18 -0
- package/types/resources/Brand.d.ts +9 -0
- package/types/resources/Card.d.ts +1 -0
- package/types/resources/CreditNote.d.ts +6 -0
- package/types/resources/Customer.d.ts +23 -2
- package/types/resources/Entitlement.d.ts +2 -0
- package/types/resources/Estimate.d.ts +4 -2
- package/types/resources/Gift.d.ts +4 -2
- package/types/resources/Hierarchy.d.ts +1 -0
- package/types/resources/Invoice.d.ts +10 -2
- package/types/resources/PaymentIntent.d.ts +8 -4
- package/types/resources/PaymentSource.d.ts +2 -1
- package/types/resources/Purchase.d.ts +3 -1
- package/types/resources/Quote.d.ts +14 -1
- package/types/resources/QuotedRamp.d.ts +7 -8
- package/types/resources/RecordedPurchase.d.ts +4 -0
- package/types/resources/Subscription.d.ts +21 -7
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,30 @@
|
|
|
1
|
+
### v3.11.0 (2025-07-18)
|
|
2
|
+
* * *
|
|
3
|
+
|
|
4
|
+
### New Resources:
|
|
5
|
+
* BillingConfiguration has been added.
|
|
6
|
+
* Brand has been added.
|
|
7
|
+
|
|
8
|
+
### New Attributes:
|
|
9
|
+
* has_children has been added to Hierarchy
|
|
10
|
+
* coupon_applicability_mappings has been added to QuotedRamp.
|
|
11
|
+
|
|
12
|
+
### New Endpoint:
|
|
13
|
+
* listHierarchyDetail has been added to Customer.
|
|
14
|
+
|
|
15
|
+
### New Input parameters:
|
|
16
|
+
* change_reason children has been added to Entitlement#CreateRequest.
|
|
17
|
+
* entitlements[apply_grandfathering] has been added to Entitlement#CreateRequest.
|
|
18
|
+
* replace_primary_payment_source has been added to Purchase#CreateRequest.
|
|
19
|
+
* omnichannel_subscription has been added to RecordedPurchase#CreateRequest.
|
|
20
|
+
* contract_term has been added to Subscription#RemoveScheduledCancellationRequest.
|
|
21
|
+
* contract_term_billing_cycle_on_renewal has been added to Subscription#RemoveScheduledCancellationRequest.
|
|
22
|
+
|
|
23
|
+
### New Enums:
|
|
24
|
+
* payconiq_by_bancontact has been added to PaymentMethodType.
|
|
25
|
+
* solidgate has been added to Gateway.
|
|
26
|
+
* solidgate has been added to PaymentMethod.
|
|
27
|
+
|
|
1
28
|
### v3.10.0 (2025-06-30)
|
|
2
29
|
* * *
|
|
3
30
|
|
package/cjs/environment.js
CHANGED
|
@@ -11,7 +11,7 @@ exports.Environment = {
|
|
|
11
11
|
hostSuffix: '.chargebee.com',
|
|
12
12
|
apiPath: '/api/v2',
|
|
13
13
|
timeout: DEFAULT_TIME_OUT,
|
|
14
|
-
clientVersion: 'v3.
|
|
14
|
+
clientVersion: 'v3.11.0',
|
|
15
15
|
port: DEFAULT_PORT,
|
|
16
16
|
timemachineWaitInMillis: DEFAULT_TIME_MACHINE_WAIT,
|
|
17
17
|
exportWaitInMillis: DEFAULT_EXPORT_WAIT,
|
|
@@ -769,6 +769,17 @@ exports.Endpoints = {
|
|
|
769
769
|
},
|
|
770
770
|
],
|
|
771
771
|
['hierarchy', 'GET', '/customers', '/hierarchy', true, null, false, {}, {}],
|
|
772
|
+
[
|
|
773
|
+
'listHierarchyDetail',
|
|
774
|
+
'GET',
|
|
775
|
+
'/customers',
|
|
776
|
+
'/hierarchy_detail',
|
|
777
|
+
true,
|
|
778
|
+
null,
|
|
779
|
+
false,
|
|
780
|
+
{},
|
|
781
|
+
{},
|
|
782
|
+
],
|
|
772
783
|
[
|
|
773
784
|
'updateHierarchySettings',
|
|
774
785
|
'POST',
|
|
@@ -2940,6 +2951,7 @@ exports.Endpoints = {
|
|
|
2940
2951
|
quotedSubscription: [],
|
|
2941
2952
|
quotedCharge: [],
|
|
2942
2953
|
quotedRamp: [],
|
|
2954
|
+
billingConfiguration: [],
|
|
2943
2955
|
quoteLineGroup: [],
|
|
2944
2956
|
plan: [
|
|
2945
2957
|
[
|
|
@@ -4718,4 +4730,5 @@ exports.Endpoints = {
|
|
|
4718
4730
|
{},
|
|
4719
4731
|
],
|
|
4720
4732
|
],
|
|
4733
|
+
brand: [],
|
|
4721
4734
|
};
|
package/esm/environment.js
CHANGED
|
@@ -8,7 +8,7 @@ export const Environment = {
|
|
|
8
8
|
hostSuffix: '.chargebee.com',
|
|
9
9
|
apiPath: '/api/v2',
|
|
10
10
|
timeout: DEFAULT_TIME_OUT,
|
|
11
|
-
clientVersion: 'v3.
|
|
11
|
+
clientVersion: 'v3.11.0',
|
|
12
12
|
port: DEFAULT_PORT,
|
|
13
13
|
timemachineWaitInMillis: DEFAULT_TIME_MACHINE_WAIT,
|
|
14
14
|
exportWaitInMillis: DEFAULT_EXPORT_WAIT,
|
|
@@ -766,6 +766,17 @@ export const Endpoints = {
|
|
|
766
766
|
},
|
|
767
767
|
],
|
|
768
768
|
['hierarchy', 'GET', '/customers', '/hierarchy', true, null, false, {}, {}],
|
|
769
|
+
[
|
|
770
|
+
'listHierarchyDetail',
|
|
771
|
+
'GET',
|
|
772
|
+
'/customers',
|
|
773
|
+
'/hierarchy_detail',
|
|
774
|
+
true,
|
|
775
|
+
null,
|
|
776
|
+
false,
|
|
777
|
+
{},
|
|
778
|
+
{},
|
|
779
|
+
],
|
|
769
780
|
[
|
|
770
781
|
'updateHierarchySettings',
|
|
771
782
|
'POST',
|
|
@@ -2937,6 +2948,7 @@ export const Endpoints = {
|
|
|
2937
2948
|
quotedSubscription: [],
|
|
2938
2949
|
quotedCharge: [],
|
|
2939
2950
|
quotedRamp: [],
|
|
2951
|
+
billingConfiguration: [],
|
|
2940
2952
|
quoteLineGroup: [],
|
|
2941
2953
|
plan: [
|
|
2942
2954
|
[
|
|
@@ -4715,4 +4727,5 @@ export const Endpoints = {
|
|
|
4715
4727
|
{},
|
|
4716
4728
|
],
|
|
4717
4729
|
],
|
|
4730
|
+
brand: [],
|
|
4718
4731
|
};
|
package/package.json
CHANGED
package/types/core.d.ts
CHANGED
|
@@ -409,6 +409,7 @@ declare module 'chargebee' {
|
|
|
409
409
|
| 'ebanx'
|
|
410
410
|
| 'dlocal'
|
|
411
411
|
| 'nuvei'
|
|
412
|
+
| 'solidgate'
|
|
412
413
|
| 'paystack'
|
|
413
414
|
| 'jp_morgan'
|
|
414
415
|
| 'gocardless'
|
|
@@ -484,7 +485,8 @@ declare module 'chargebee' {
|
|
|
484
485
|
| 'sepa_instant_transfer'
|
|
485
486
|
| 'automated_bank_transfer'
|
|
486
487
|
| 'klarna_pay_now'
|
|
487
|
-
| 'online_banking_poland'
|
|
488
|
+
| 'online_banking_poland'
|
|
489
|
+
| 'payconiq_by_bancontact';
|
|
488
490
|
type PaymentMethodTypeEnum =
|
|
489
491
|
| 'card'
|
|
490
492
|
| 'paypal_express_checkout'
|
|
@@ -509,7 +511,8 @@ declare module 'chargebee' {
|
|
|
509
511
|
| 'sepa_instant_transfer'
|
|
510
512
|
| 'automated_bank_transfer'
|
|
511
513
|
| 'klarna_pay_now'
|
|
512
|
-
| 'online_banking_poland'
|
|
514
|
+
| 'online_banking_poland'
|
|
515
|
+
| 'payconiq_by_bancontact';
|
|
513
516
|
type PaymentVoucherTypeEnum = 'boleto';
|
|
514
517
|
type PeriodUnitEnum = 'day' | 'week' | 'month' | 'year';
|
|
515
518
|
type PriceTypeEnum = 'tax_exclusive' | 'tax_inclusive';
|
|
@@ -600,7 +603,8 @@ declare module 'chargebee' {
|
|
|
600
603
|
| 'sepa_instant_transfer'
|
|
601
604
|
| 'automated_bank_transfer'
|
|
602
605
|
| 'klarna_pay_now'
|
|
603
|
-
| 'online_banking_poland'
|
|
606
|
+
| 'online_banking_poland'
|
|
607
|
+
| 'payconiq_by_bancontact';
|
|
604
608
|
type UnbilledChargesHandlingEnum = 'no_action' | 'invoice';
|
|
605
609
|
type UnbilledChargesOptionEnum = 'invoice' | 'delete';
|
|
606
610
|
type UnpaidInvoicesHandlingEnum = 'no_action' | 'schedule_payment_collection';
|
package/types/index.d.ts
CHANGED
|
@@ -3,6 +3,8 @@
|
|
|
3
3
|
///<reference path='./resources/AdvanceInvoiceSchedule.d.ts' />
|
|
4
4
|
///<reference path='./resources/AttachedItem.d.ts' />
|
|
5
5
|
///<reference path='./resources/Attribute.d.ts' />
|
|
6
|
+
///<reference path='./resources/BillingConfiguration.d.ts' />
|
|
7
|
+
///<reference path='./resources/Brand.d.ts' />
|
|
6
8
|
///<reference path='./resources/BusinessEntity.d.ts' />
|
|
7
9
|
///<reference path='./resources/BusinessEntityTransfer.d.ts' />
|
|
8
10
|
///<reference path='./resources/Card.d.ts' />
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
///<reference path='./../core.d.ts'/>
|
|
2
|
+
///<reference path='./../index.d.ts'/>
|
|
3
|
+
|
|
4
|
+
declare module 'chargebee' {
|
|
5
|
+
export interface BillingConfiguration {
|
|
6
|
+
is_calendar_billing_enabled: boolean;
|
|
7
|
+
billing_dates?: BillingConfiguration.BillingDate[];
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
export namespace BillingConfiguration {
|
|
11
|
+
export interface BillingDate {
|
|
12
|
+
start_date?: number;
|
|
13
|
+
end_date?: number;
|
|
14
|
+
}
|
|
15
|
+
// REQUEST PARAMS
|
|
16
|
+
//---------------
|
|
17
|
+
}
|
|
18
|
+
}
|
|
@@ -547,7 +547,13 @@ declare module 'chargebee' {
|
|
|
547
547
|
entity_id?: string;
|
|
548
548
|
}
|
|
549
549
|
export interface LineItemRetrieveInputParam {
|
|
550
|
+
/**
|
|
551
|
+
* @deprecated Please refer API docs to use other attributes
|
|
552
|
+
*/
|
|
550
553
|
subscription_id?: filter.String;
|
|
554
|
+
/**
|
|
555
|
+
* @deprecated Please refer API docs to use other attributes
|
|
556
|
+
*/
|
|
551
557
|
customer_id?: filter.String;
|
|
552
558
|
}
|
|
553
559
|
|
|
@@ -224,6 +224,12 @@ declare module 'chargebee' {
|
|
|
224
224
|
headers?: ChargebeeRequestHeader,
|
|
225
225
|
): Promise<ChargebeeResponse<HierarchyResponse>>;
|
|
226
226
|
|
|
227
|
+
listHierarchyDetail(
|
|
228
|
+
customer_id: string,
|
|
229
|
+
input: ListHierarchyDetailInputParam,
|
|
230
|
+
headers?: ChargebeeRequestHeader,
|
|
231
|
+
): Promise<ChargebeeResponse<ListHierarchyDetailResponse>>;
|
|
232
|
+
|
|
227
233
|
updateHierarchySettings(
|
|
228
234
|
customer_id: string,
|
|
229
235
|
input?: UpdateHierarchySettingsInputParam,
|
|
@@ -341,6 +347,11 @@ declare module 'chargebee' {
|
|
|
341
347
|
hierarchies: Hierarchy[];
|
|
342
348
|
}
|
|
343
349
|
|
|
350
|
+
export interface ListHierarchyDetailResponse {
|
|
351
|
+
list: { hierarchies: any[] }[];
|
|
352
|
+
next_offset?: string;
|
|
353
|
+
}
|
|
354
|
+
|
|
344
355
|
export interface UpdateHierarchySettingsResponse {
|
|
345
356
|
customer: Customer;
|
|
346
357
|
}
|
|
@@ -641,6 +652,14 @@ declare module 'chargebee' {
|
|
|
641
652
|
| 'subordinates'
|
|
642
653
|
| 'path_to_root';
|
|
643
654
|
}
|
|
655
|
+
export interface ListHierarchyDetailInputParam {
|
|
656
|
+
limit?: number;
|
|
657
|
+
offset?: string;
|
|
658
|
+
hierarchy_operation_type:
|
|
659
|
+
| 'complete_hierarchy'
|
|
660
|
+
| 'subordinates'
|
|
661
|
+
| 'path_to_root';
|
|
662
|
+
}
|
|
644
663
|
export interface UpdateHierarchySettingsInputParam {
|
|
645
664
|
use_default_hierarchy_settings?: boolean;
|
|
646
665
|
parent_account_access?: ParentAccountAccessUpdateHierarchySettingsInputParam;
|
|
@@ -717,7 +736,8 @@ declare module 'chargebee' {
|
|
|
717
736
|
| 'faster_payments'
|
|
718
737
|
| 'sepa_instant_transfer'
|
|
719
738
|
| 'klarna_pay_now'
|
|
720
|
-
| 'online_banking_poland'
|
|
739
|
+
| 'online_banking_poland'
|
|
740
|
+
| 'payconiq_by_bancontact';
|
|
721
741
|
reference_id?: string;
|
|
722
742
|
/**
|
|
723
743
|
* @deprecated Please refer API docs to use other attributes
|
|
@@ -888,7 +908,8 @@ declare module 'chargebee' {
|
|
|
888
908
|
| 'faster_payments'
|
|
889
909
|
| 'sepa_instant_transfer'
|
|
890
910
|
| 'klarna_pay_now'
|
|
891
|
-
| 'online_banking_poland'
|
|
911
|
+
| 'online_banking_poland'
|
|
912
|
+
| 'payconiq_by_bancontact';
|
|
892
913
|
/**
|
|
893
914
|
* @deprecated Please refer API docs to use other attributes
|
|
894
915
|
*/
|
|
@@ -54,6 +54,7 @@ declare module 'chargebee' {
|
|
|
54
54
|
}
|
|
55
55
|
export interface CreateInputParam {
|
|
56
56
|
action: ActionEnum;
|
|
57
|
+
change_reason?: string;
|
|
57
58
|
entitlements?: EntitlementsCreateInputParam[];
|
|
58
59
|
}
|
|
59
60
|
export interface EntitlementsCreateInputParam {
|
|
@@ -61,6 +62,7 @@ declare module 'chargebee' {
|
|
|
61
62
|
feature_id: string;
|
|
62
63
|
entity_type?: 'plan' | 'addon' | 'charge' | 'plan_price' | 'addon_price';
|
|
63
64
|
value?: string;
|
|
65
|
+
apply_grandfathering?: boolean;
|
|
64
66
|
}
|
|
65
67
|
}
|
|
66
68
|
}
|
|
@@ -1034,7 +1034,8 @@ declare module 'chargebee' {
|
|
|
1034
1034
|
| 'faster_payments'
|
|
1035
1035
|
| 'sepa_instant_transfer'
|
|
1036
1036
|
| 'klarna_pay_now'
|
|
1037
|
-
| 'online_banking_poland'
|
|
1037
|
+
| 'online_banking_poland'
|
|
1038
|
+
| 'payconiq_by_bancontact';
|
|
1038
1039
|
reference_id?: string;
|
|
1039
1040
|
/**
|
|
1040
1041
|
* @deprecated Please refer API docs to use other attributes
|
|
@@ -1111,7 +1112,8 @@ declare module 'chargebee' {
|
|
|
1111
1112
|
| 'faster_payments'
|
|
1112
1113
|
| 'sepa_instant_transfer'
|
|
1113
1114
|
| 'klarna_pay_now'
|
|
1114
|
-
| 'online_banking_poland'
|
|
1115
|
+
| 'online_banking_poland'
|
|
1116
|
+
| 'payconiq_by_bancontact';
|
|
1115
1117
|
reference_id?: string;
|
|
1116
1118
|
/**
|
|
1117
1119
|
* @deprecated Please refer API docs to use other attributes
|
|
@@ -200,7 +200,8 @@ declare module 'chargebee' {
|
|
|
200
200
|
| 'faster_payments'
|
|
201
201
|
| 'sepa_instant_transfer'
|
|
202
202
|
| 'klarna_pay_now'
|
|
203
|
-
| 'online_banking_poland'
|
|
203
|
+
| 'online_banking_poland'
|
|
204
|
+
| 'payconiq_by_bancontact';
|
|
204
205
|
reference_id?: string;
|
|
205
206
|
/**
|
|
206
207
|
* @deprecated Please refer API docs to use other attributes
|
|
@@ -271,7 +272,8 @@ declare module 'chargebee' {
|
|
|
271
272
|
| 'faster_payments'
|
|
272
273
|
| 'sepa_instant_transfer'
|
|
273
274
|
| 'klarna_pay_now'
|
|
274
|
-
| 'online_banking_poland'
|
|
275
|
+
| 'online_banking_poland'
|
|
276
|
+
| 'payconiq_by_bancontact';
|
|
275
277
|
reference_id?: string;
|
|
276
278
|
/**
|
|
277
279
|
* @deprecated Please refer API docs to use other attributes
|
|
@@ -1216,7 +1216,8 @@ declare module 'chargebee' {
|
|
|
1216
1216
|
| 'faster_payments'
|
|
1217
1217
|
| 'sepa_instant_transfer'
|
|
1218
1218
|
| 'klarna_pay_now'
|
|
1219
|
-
| 'online_banking_poland'
|
|
1219
|
+
| 'online_banking_poland'
|
|
1220
|
+
| 'payconiq_by_bancontact';
|
|
1220
1221
|
reference_id?: string;
|
|
1221
1222
|
/**
|
|
1222
1223
|
* @deprecated Please refer API docs to use other attributes
|
|
@@ -1362,7 +1363,8 @@ declare module 'chargebee' {
|
|
|
1362
1363
|
| 'faster_payments'
|
|
1363
1364
|
| 'sepa_instant_transfer'
|
|
1364
1365
|
| 'klarna_pay_now'
|
|
1365
|
-
| 'online_banking_poland'
|
|
1366
|
+
| 'online_banking_poland'
|
|
1367
|
+
| 'payconiq_by_bancontact';
|
|
1366
1368
|
reference_id?: string;
|
|
1367
1369
|
/**
|
|
1368
1370
|
* @deprecated Please refer API docs to use other attributes
|
|
@@ -1647,7 +1649,13 @@ declare module 'chargebee' {
|
|
|
1647
1649
|
}
|
|
1648
1650
|
|
|
1649
1651
|
export interface LineItemRetrieveInputParam {
|
|
1652
|
+
/**
|
|
1653
|
+
* @deprecated Please refer API docs to use other attributes
|
|
1654
|
+
*/
|
|
1650
1655
|
subscription_id?: filter.String;
|
|
1656
|
+
/**
|
|
1657
|
+
* @deprecated Please refer API docs to use other attributes
|
|
1658
|
+
*/
|
|
1651
1659
|
customer_id?: filter.String;
|
|
1652
1660
|
}
|
|
1653
1661
|
|
|
@@ -30,7 +30,8 @@ declare module 'chargebee' {
|
|
|
30
30
|
| 'faster_payments'
|
|
31
31
|
| 'sepa_instant_transfer'
|
|
32
32
|
| 'klarna_pay_now'
|
|
33
|
-
| 'online_banking_poland'
|
|
33
|
+
| 'online_banking_poland'
|
|
34
|
+
| 'payconiq_by_bancontact';
|
|
34
35
|
success_url?: string;
|
|
35
36
|
failure_url?: string;
|
|
36
37
|
created_at: number;
|
|
@@ -104,7 +105,8 @@ declare module 'chargebee' {
|
|
|
104
105
|
| 'faster_payments'
|
|
105
106
|
| 'sepa_instant_transfer'
|
|
106
107
|
| 'klarna_pay_now'
|
|
107
|
-
| 'online_banking_poland'
|
|
108
|
+
| 'online_banking_poland'
|
|
109
|
+
| 'payconiq_by_bancontact';
|
|
108
110
|
id_at_gateway?: string;
|
|
109
111
|
error_code?: string;
|
|
110
112
|
error_text?: string;
|
|
@@ -142,7 +144,8 @@ declare module 'chargebee' {
|
|
|
142
144
|
| 'faster_payments'
|
|
143
145
|
| 'sepa_instant_transfer'
|
|
144
146
|
| 'klarna_pay_now'
|
|
145
|
-
| 'online_banking_poland'
|
|
147
|
+
| 'online_banking_poland'
|
|
148
|
+
| 'payconiq_by_bancontact';
|
|
146
149
|
success_url?: string;
|
|
147
150
|
failure_url?: string;
|
|
148
151
|
}
|
|
@@ -170,7 +173,8 @@ declare module 'chargebee' {
|
|
|
170
173
|
| 'faster_payments'
|
|
171
174
|
| 'sepa_instant_transfer'
|
|
172
175
|
| 'klarna_pay_now'
|
|
173
|
-
| 'online_banking_poland'
|
|
176
|
+
| 'online_banking_poland'
|
|
177
|
+
| 'payconiq_by_bancontact';
|
|
174
178
|
success_url?: string;
|
|
175
179
|
failure_url?: string;
|
|
176
180
|
}
|
|
@@ -452,7 +452,8 @@ declare module 'chargebee' {
|
|
|
452
452
|
| 'faster_payments'
|
|
453
453
|
| 'sepa_instant_transfer'
|
|
454
454
|
| 'klarna_pay_now'
|
|
455
|
-
| 'online_banking_poland'
|
|
455
|
+
| 'online_banking_poland'
|
|
456
|
+
| 'payconiq_by_bancontact';
|
|
456
457
|
reference_id?: string;
|
|
457
458
|
/**
|
|
458
459
|
* @deprecated Please refer API docs to use other attributes
|
|
@@ -38,6 +38,7 @@ declare module 'chargebee' {
|
|
|
38
38
|
export interface CreateInputParam {
|
|
39
39
|
customer_id: string;
|
|
40
40
|
payment_source_id?: string;
|
|
41
|
+
replace_primary_payment_source?: boolean;
|
|
41
42
|
invoice_info?: InvoiceInfoCreateInputParam;
|
|
42
43
|
payment_schedule?: PaymentScheduleCreateInputParam;
|
|
43
44
|
statement_descriptor?: StatementDescriptorCreateInputParam;
|
|
@@ -96,7 +97,8 @@ declare module 'chargebee' {
|
|
|
96
97
|
| 'faster_payments'
|
|
97
98
|
| 'sepa_instant_transfer'
|
|
98
99
|
| 'klarna_pay_now'
|
|
99
|
-
| 'online_banking_poland'
|
|
100
|
+
| 'online_banking_poland'
|
|
101
|
+
| 'payconiq_by_bancontact';
|
|
100
102
|
reference_id?: string;
|
|
101
103
|
/**
|
|
102
104
|
* @deprecated Please refer API docs to use other attributes
|
|
@@ -184,6 +184,7 @@ declare module 'chargebee' {
|
|
|
184
184
|
quote: Quote;
|
|
185
185
|
quoted_subscription?: QuotedSubscription;
|
|
186
186
|
quoted_charge?: QuotedCharge;
|
|
187
|
+
quoted_ramp?: QuotedRamp;
|
|
187
188
|
}
|
|
188
189
|
|
|
189
190
|
export interface CreateSubForCustomerQuoteResponse {
|
|
@@ -219,21 +220,25 @@ declare module 'chargebee' {
|
|
|
219
220
|
export interface CreateSubItemsForCustomerQuoteResponse {
|
|
220
221
|
quote: Quote;
|
|
221
222
|
quoted_subscription?: QuotedSubscription;
|
|
223
|
+
quoted_ramp?: QuotedRamp;
|
|
222
224
|
}
|
|
223
225
|
|
|
224
226
|
export interface EditCreateSubCustomerQuoteForItemsResponse {
|
|
225
227
|
quote: Quote;
|
|
226
228
|
quoted_subscription?: QuotedSubscription;
|
|
229
|
+
quoted_ramp?: QuotedRamp;
|
|
227
230
|
}
|
|
228
231
|
|
|
229
232
|
export interface UpdateSubscriptionQuoteForItemsResponse {
|
|
230
233
|
quote: Quote;
|
|
231
234
|
quoted_subscription?: QuotedSubscription;
|
|
235
|
+
quoted_ramp?: QuotedRamp;
|
|
232
236
|
}
|
|
233
237
|
|
|
234
238
|
export interface EditUpdateSubscriptionQuoteForItemsResponse {
|
|
235
239
|
quote: Quote;
|
|
236
240
|
quoted_subscription?: QuotedSubscription;
|
|
241
|
+
quoted_ramp?: QuotedRamp;
|
|
237
242
|
}
|
|
238
243
|
|
|
239
244
|
export interface CreateForChargeItemsAndChargesResponse {
|
|
@@ -247,7 +252,11 @@ declare module 'chargebee' {
|
|
|
247
252
|
}
|
|
248
253
|
|
|
249
254
|
export interface ListResponse {
|
|
250
|
-
list: {
|
|
255
|
+
list: {
|
|
256
|
+
quote: Quote;
|
|
257
|
+
quoted_subscription?: QuotedSubscription;
|
|
258
|
+
quoted_ramp?: QuotedRamp;
|
|
259
|
+
}[];
|
|
251
260
|
next_offset?: string;
|
|
252
261
|
}
|
|
253
262
|
|
|
@@ -260,6 +269,7 @@ declare module 'chargebee' {
|
|
|
260
269
|
quote: Quote;
|
|
261
270
|
quoted_subscription?: QuotedSubscription;
|
|
262
271
|
quoted_charge?: QuotedCharge;
|
|
272
|
+
quoted_ramp?: QuotedRamp;
|
|
263
273
|
customer: Customer;
|
|
264
274
|
subscription?: Subscription;
|
|
265
275
|
invoice?: Invoice;
|
|
@@ -271,18 +281,21 @@ declare module 'chargebee' {
|
|
|
271
281
|
quote: Quote;
|
|
272
282
|
quoted_subscription?: QuotedSubscription;
|
|
273
283
|
quoted_charge?: QuotedCharge;
|
|
284
|
+
quoted_ramp?: QuotedRamp;
|
|
274
285
|
}
|
|
275
286
|
|
|
276
287
|
export interface ExtendExpiryDateResponse {
|
|
277
288
|
quote: Quote;
|
|
278
289
|
quoted_subscription?: QuotedSubscription;
|
|
279
290
|
quoted_charge?: QuotedCharge;
|
|
291
|
+
quoted_ramp?: QuotedRamp;
|
|
280
292
|
}
|
|
281
293
|
|
|
282
294
|
export interface DeleteResponse {
|
|
283
295
|
quote: Quote;
|
|
284
296
|
quoted_subscription?: QuotedSubscription;
|
|
285
297
|
quoted_charge?: QuotedCharge;
|
|
298
|
+
quoted_ramp?: QuotedRamp;
|
|
286
299
|
}
|
|
287
300
|
|
|
288
301
|
export interface PdfResponse {
|
|
@@ -7,6 +7,7 @@ declare module 'chargebee' {
|
|
|
7
7
|
line_items?: QuotedRamp.LineItem[];
|
|
8
8
|
discounts?: QuotedRamp.Discount[];
|
|
9
9
|
item_tiers?: QuotedRamp.ItemTier[];
|
|
10
|
+
coupon_applicability_mappings?: QuotedRamp.CouponApplicabilityMapping[];
|
|
10
11
|
}
|
|
11
12
|
|
|
12
13
|
export namespace QuotedRamp {
|
|
@@ -37,16 +38,10 @@ declare module 'chargebee' {
|
|
|
37
38
|
start_date?: number;
|
|
38
39
|
end_date?: number;
|
|
39
40
|
ramp_tier_id?: string;
|
|
40
|
-
discount_amount?: number;
|
|
41
|
-
md_discount_amount?: string;
|
|
42
|
-
item_level_discount_amount?: number;
|
|
43
|
-
md_item_level_discount_amount?: string;
|
|
44
41
|
discount_per_billing_cycle?: number;
|
|
45
42
|
discount_per_billing_cycle_in_decimal?: string;
|
|
46
43
|
item_level_discount_per_billing_cycle?: number;
|
|
47
44
|
item_level_discount_per_billing_cycle_in_decimal?: string;
|
|
48
|
-
net_amount?: number;
|
|
49
|
-
md_net_amount?: string;
|
|
50
45
|
amount_per_billing_cycle?: number;
|
|
51
46
|
amount_per_billing_cycle_in_decimal?: string;
|
|
52
47
|
net_amount_per_billing_cycle?: number;
|
|
@@ -54,7 +49,6 @@ declare module 'chargebee' {
|
|
|
54
49
|
}
|
|
55
50
|
export interface Discount {
|
|
56
51
|
id: string;
|
|
57
|
-
name: string;
|
|
58
52
|
invoice_name?: string;
|
|
59
53
|
type: 'fixed_amount' | 'percentage';
|
|
60
54
|
percentage?: number;
|
|
@@ -70,7 +64,6 @@ declare module 'chargebee' {
|
|
|
70
64
|
period_unit?: 'day' | 'week' | 'month' | 'year';
|
|
71
65
|
included_in_mrr: boolean;
|
|
72
66
|
apply_on: 'invoice_amount' | 'specific_item_price';
|
|
73
|
-
apply_on_item_type?: 'plan' | 'addon' | 'charge';
|
|
74
67
|
item_price_id?: string;
|
|
75
68
|
created_at: number;
|
|
76
69
|
updated_at?: number;
|
|
@@ -86,6 +79,12 @@ declare module 'chargebee' {
|
|
|
86
79
|
ending_unit_in_decimal?: string;
|
|
87
80
|
price_in_decimal?: string;
|
|
88
81
|
ramp_tier_id?: string;
|
|
82
|
+
pricing_type?: 'per_unit' | 'flat_fee' | 'package';
|
|
83
|
+
package_size?: number;
|
|
84
|
+
}
|
|
85
|
+
export interface CouponApplicabilityMapping {
|
|
86
|
+
coupon_id?: string;
|
|
87
|
+
applicable_item_price_ids?: string[];
|
|
89
88
|
}
|
|
90
89
|
// REQUEST PARAMS
|
|
91
90
|
//---------------
|
|
@@ -51,6 +51,7 @@ declare module 'chargebee' {
|
|
|
51
51
|
customer?: CustomerCreateInputParam;
|
|
52
52
|
apple_app_store?: AppleAppStoreCreateInputParam;
|
|
53
53
|
google_play_store?: GooglePlayStoreCreateInputParam;
|
|
54
|
+
omnichannel_subscription?: OmnichannelSubscriptionCreateInputParam;
|
|
54
55
|
}
|
|
55
56
|
export interface CustomerCreateInputParam {
|
|
56
57
|
id: string;
|
|
@@ -63,5 +64,8 @@ declare module 'chargebee' {
|
|
|
63
64
|
receipt?: string;
|
|
64
65
|
product_id?: string;
|
|
65
66
|
}
|
|
67
|
+
export interface OmnichannelSubscriptionCreateInputParam {
|
|
68
|
+
id?: string;
|
|
69
|
+
}
|
|
66
70
|
}
|
|
67
71
|
}
|
|
@@ -896,6 +896,8 @@ declare module 'chargebee' {
|
|
|
896
896
|
}
|
|
897
897
|
export interface RemoveScheduledCancellationInputParam {
|
|
898
898
|
billing_cycles?: number;
|
|
899
|
+
contract_term_billing_cycle_on_renewal?: number;
|
|
900
|
+
contract_term?: ContractTermRemoveScheduledCancellationInputParam;
|
|
899
901
|
}
|
|
900
902
|
export interface RemoveCouponsInputParam {
|
|
901
903
|
coupon_ids?: string[];
|
|
@@ -1397,7 +1399,8 @@ declare module 'chargebee' {
|
|
|
1397
1399
|
| 'faster_payments'
|
|
1398
1400
|
| 'sepa_instant_transfer'
|
|
1399
1401
|
| 'klarna_pay_now'
|
|
1400
|
-
| 'online_banking_poland'
|
|
1402
|
+
| 'online_banking_poland'
|
|
1403
|
+
| 'payconiq_by_bancontact';
|
|
1401
1404
|
reference_id?: string;
|
|
1402
1405
|
/**
|
|
1403
1406
|
* @deprecated Please refer API docs to use other attributes
|
|
@@ -1524,7 +1527,8 @@ declare module 'chargebee' {
|
|
|
1524
1527
|
| 'faster_payments'
|
|
1525
1528
|
| 'sepa_instant_transfer'
|
|
1526
1529
|
| 'klarna_pay_now'
|
|
1527
|
-
| 'online_banking_poland'
|
|
1530
|
+
| 'online_banking_poland'
|
|
1531
|
+
| 'payconiq_by_bancontact';
|
|
1528
1532
|
reference_id?: string;
|
|
1529
1533
|
/**
|
|
1530
1534
|
* @deprecated Please refer API docs to use other attributes
|
|
@@ -1618,7 +1622,8 @@ declare module 'chargebee' {
|
|
|
1618
1622
|
| 'faster_payments'
|
|
1619
1623
|
| 'sepa_instant_transfer'
|
|
1620
1624
|
| 'klarna_pay_now'
|
|
1621
|
-
| 'online_banking_poland'
|
|
1625
|
+
| 'online_banking_poland'
|
|
1626
|
+
| 'payconiq_by_bancontact';
|
|
1622
1627
|
reference_id?: string;
|
|
1623
1628
|
/**
|
|
1624
1629
|
* @deprecated Please refer API docs to use other attributes
|
|
@@ -1676,6 +1681,11 @@ declare module 'chargebee' {
|
|
|
1676
1681
|
pricing_type?: PricingTypeEnum;
|
|
1677
1682
|
package_size?: number;
|
|
1678
1683
|
}
|
|
1684
|
+
export interface ContractTermRemoveScheduledCancellationInputParam {
|
|
1685
|
+
action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
|
|
1686
|
+
cancellation_cutoff_period?: number;
|
|
1687
|
+
}
|
|
1688
|
+
|
|
1679
1689
|
export interface BillingAddressUpdateInputParam {
|
|
1680
1690
|
first_name?: string;
|
|
1681
1691
|
last_name?: string;
|
|
@@ -1761,7 +1771,8 @@ declare module 'chargebee' {
|
|
|
1761
1771
|
| 'faster_payments'
|
|
1762
1772
|
| 'sepa_instant_transfer'
|
|
1763
1773
|
| 'klarna_pay_now'
|
|
1764
|
-
| 'online_banking_poland'
|
|
1774
|
+
| 'online_banking_poland'
|
|
1775
|
+
| 'payconiq_by_bancontact';
|
|
1765
1776
|
reference_id?: string;
|
|
1766
1777
|
/**
|
|
1767
1778
|
* @deprecated Please refer API docs to use other attributes
|
|
@@ -1924,7 +1935,8 @@ declare module 'chargebee' {
|
|
|
1924
1935
|
| 'faster_payments'
|
|
1925
1936
|
| 'sepa_instant_transfer'
|
|
1926
1937
|
| 'klarna_pay_now'
|
|
1927
|
-
| 'online_banking_poland'
|
|
1938
|
+
| 'online_banking_poland'
|
|
1939
|
+
| 'payconiq_by_bancontact';
|
|
1928
1940
|
reference_id?: string;
|
|
1929
1941
|
/**
|
|
1930
1942
|
* @deprecated Please refer API docs to use other attributes
|
|
@@ -2042,7 +2054,8 @@ declare module 'chargebee' {
|
|
|
2042
2054
|
| 'faster_payments'
|
|
2043
2055
|
| 'sepa_instant_transfer'
|
|
2044
2056
|
| 'klarna_pay_now'
|
|
2045
|
-
| 'online_banking_poland'
|
|
2057
|
+
| 'online_banking_poland'
|
|
2058
|
+
| 'payconiq_by_bancontact';
|
|
2046
2059
|
reference_id?: string;
|
|
2047
2060
|
/**
|
|
2048
2061
|
* @deprecated Please refer API docs to use other attributes
|
|
@@ -2463,7 +2476,8 @@ declare module 'chargebee' {
|
|
|
2463
2476
|
| 'faster_payments'
|
|
2464
2477
|
| 'sepa_instant_transfer'
|
|
2465
2478
|
| 'klarna_pay_now'
|
|
2466
|
-
| 'online_banking_poland'
|
|
2479
|
+
| 'online_banking_poland'
|
|
2480
|
+
| 'payconiq_by_bancontact';
|
|
2467
2481
|
reference_id?: string;
|
|
2468
2482
|
/**
|
|
2469
2483
|
* @deprecated Please refer API docs to use other attributes
|