chargebee 2.53.0 → 2.53.1
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/.github/workflows/release.yml +34 -0
- package/CHANGELOG.md +7 -0
- package/lib/chargebee.js +1 -1
- package/package.json +1 -1
- package/types/resources/Addon.d.ts +2 -2
- package/types/resources/BusinessEntity.d.ts +1 -1
- package/types/resources/Comment.d.ts +1 -1
- package/types/resources/Coupon.d.ts +3 -3
- package/types/resources/CreditNote.d.ts +1 -1
- package/types/resources/Customer.d.ts +3 -3
- package/types/resources/Event.d.ts +1 -1
- package/types/resources/Feature.d.ts +2 -2
- package/types/resources/Gift.d.ts +1 -1
- package/types/resources/HostedPage.d.ts +11 -11
- package/types/resources/Invoice.d.ts +1 -1
- package/types/resources/Item.d.ts +3 -3
- package/types/resources/ItemFamily.d.ts +2 -2
- package/types/resources/ItemPrice.d.ts +4 -4
- package/types/resources/Order.d.ts +1 -1
- package/types/resources/PaymentSource.d.ts +1 -1
- package/types/resources/PaymentVoucher.d.ts +2 -2
- package/types/resources/Plan.d.ts +2 -2
- package/types/resources/PriceVariant.d.ts +1 -1
- package/types/resources/PricingPageSession.d.ts +3 -3
- package/types/resources/Quote.d.ts +5 -5
- package/types/resources/Ramp.d.ts +1 -1
- package/types/resources/Subscription.d.ts +12 -12
- package/types/resources/Transaction.d.ts +1 -1
- package/types/resources/Usage.d.ts +1 -1
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
name: Publish v2 to NPM (non-latest)
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
tags:
|
|
6
|
+
- 'v2*'
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
release:
|
|
10
|
+
if: startsWith(github.ref, 'refs/tags/v2')
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
|
|
13
|
+
steps:
|
|
14
|
+
- name: Checkout repo
|
|
15
|
+
uses: actions/checkout@v4
|
|
16
|
+
|
|
17
|
+
- name: Setup Node.js
|
|
18
|
+
uses: actions/setup-node@v4
|
|
19
|
+
with:
|
|
20
|
+
node-version: '22.x'
|
|
21
|
+
registry-url: 'https://registry.npmjs.org'
|
|
22
|
+
|
|
23
|
+
- name: Ensure package version is 2.x.x
|
|
24
|
+
run: |
|
|
25
|
+
VERSION=$(node -p "require('./package.json').version")
|
|
26
|
+
echo "Detected version: $VERSION"
|
|
27
|
+
case "$VERSION" in
|
|
28
|
+
2.*) echo "OK: version is 2.x.x" ;;
|
|
29
|
+
*) echo "ERROR: package.json version must be 2.x.x for v2 tags" && exit 1 ;;
|
|
30
|
+
esac
|
|
31
|
+
- name: Publish to NPM with dist-tag "v2"
|
|
32
|
+
run: npm publish --tag v2-latest --//registry.npmjs.org/:_authToken="$NPM_TOKEN"
|
|
33
|
+
env:
|
|
34
|
+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
package/CHANGELOG.md
CHANGED
package/lib/chargebee.js
CHANGED
package/package.json
CHANGED
|
@@ -113,7 +113,7 @@ declare module 'chargebee' {
|
|
|
113
113
|
addon:Addon;
|
|
114
114
|
}
|
|
115
115
|
export interface CreateInputParam {
|
|
116
|
-
|
|
116
|
+
[key : string] : any;
|
|
117
117
|
tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
|
|
118
118
|
|
|
119
119
|
tax_providers_fields:{field_id:string,field_value:string,provider_name:string}[];
|
|
@@ -198,7 +198,7 @@ declare module 'chargebee' {
|
|
|
198
198
|
addon:Addon;
|
|
199
199
|
}
|
|
200
200
|
export interface UpdateInputParam {
|
|
201
|
-
|
|
201
|
+
[key : string] : any;
|
|
202
202
|
tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
|
|
203
203
|
|
|
204
204
|
tax_providers_fields:{field_id:string,field_value:string,provider_name:string}[];
|
|
@@ -148,7 +148,7 @@ declare module 'chargebee' {
|
|
|
148
148
|
coupon:Coupon;
|
|
149
149
|
}
|
|
150
150
|
export interface CreateForItemsInputParam {
|
|
151
|
-
|
|
151
|
+
[key : string] : any;
|
|
152
152
|
item_constraints:{constraint:'none' | 'all' | 'specific' | 'criteria',item_price_ids?:any[],item_type:'plan' | 'addon' | 'charge'}[];
|
|
153
153
|
|
|
154
154
|
item_constraint_criteria?:{currencies?:any[],item_family_ids?:any[],item_price_periods?:any[],item_type?:'plan' | 'addon' | 'charge'}[];
|
|
@@ -199,7 +199,7 @@ declare module 'chargebee' {
|
|
|
199
199
|
coupon:Coupon;
|
|
200
200
|
}
|
|
201
201
|
export interface UpdateForItemsInputParam {
|
|
202
|
-
|
|
202
|
+
[key : string] : any;
|
|
203
203
|
item_constraints:{constraint:'none' | 'all' | 'specific' | 'criteria',item_price_ids?:any[],item_type:'plan' | 'addon' | 'charge'}[];
|
|
204
204
|
|
|
205
205
|
item_constraint_criteria?:{currencies?:any[],item_family_ids?:any[],item_price_periods?:any[],item_type?:'plan' | 'addon' | 'charge'}[];
|
|
@@ -329,7 +329,7 @@ Make sure that you [encode](https://www.urlencoder.org/) the name of the coupon
|
|
|
329
329
|
|
|
330
330
|
updated_at?:{after?:string,before?:string,between?:string,on?:string};
|
|
331
331
|
|
|
332
|
-
sort_by?:
|
|
332
|
+
sort_by?:{asc?:'created_at',desc?:'created_at'};
|
|
333
333
|
|
|
334
334
|
/**
|
|
335
335
|
* @description The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)) of the coupon. Applicable for *fixed_amount* coupons alone.
|
|
@@ -357,7 +357,7 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
|
|
|
357
357
|
|
|
358
358
|
updated_at?:{after?:string,before?:string,between?:string,on?:string};
|
|
359
359
|
|
|
360
|
-
sort_by?:
|
|
360
|
+
sort_by?:{asc?:'date',desc?:'date'};
|
|
361
361
|
|
|
362
362
|
/**
|
|
363
363
|
* @description The subscription channel this object originated from and is maintained in.
|
|
@@ -197,7 +197,7 @@ declare module 'chargebee' {
|
|
|
197
197
|
card?:Card;
|
|
198
198
|
}
|
|
199
199
|
export interface CreateInputParam {
|
|
200
|
-
|
|
200
|
+
[key : string] : any;
|
|
201
201
|
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};
|
|
202
202
|
|
|
203
203
|
bank_account?:{account_holder_type?:AccountHolderType,account_number?:string,account_type?:AccountType,bank_code?:string,bank_name?:string,billing_address?:object,company?:string,echeck_type?:EcheckType,email?:string,first_name?:string,gateway_account_id?:string,iban?:string,issuing_country?:string,last_name?:string,phone?:string,routing_number?:string,swedish_identity_number?:string};
|
|
@@ -417,7 +417,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
417
417
|
|
|
418
418
|
business_entity_id?:{is?:string};
|
|
419
419
|
|
|
420
|
-
sort_by?:
|
|
420
|
+
sort_by?:{asc?:'created_at' | 'updated_at',desc?:'created_at' | 'updated_at'};
|
|
421
421
|
}
|
|
422
422
|
export interface RetrieveResponse {
|
|
423
423
|
customer:Customer;
|
|
@@ -431,7 +431,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
431
431
|
card?:Card;
|
|
432
432
|
}
|
|
433
433
|
export interface UpdateInputParam {
|
|
434
|
-
|
|
434
|
+
[key : string] : any;
|
|
435
435
|
tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
|
|
436
436
|
|
|
437
437
|
first_name?:string;
|
|
@@ -97,7 +97,7 @@ declare module 'chargebee' {
|
|
|
97
97
|
feature:Feature;
|
|
98
98
|
}
|
|
99
99
|
export interface CreateInputParam {
|
|
100
|
-
|
|
100
|
+
[key : string] : any;
|
|
101
101
|
levels?:{is_unlimited?:boolean,level?:number,name?:string,value?:string}[];
|
|
102
102
|
|
|
103
103
|
id?:string;
|
|
@@ -114,7 +114,7 @@ declare module 'chargebee' {
|
|
|
114
114
|
feature:Feature;
|
|
115
115
|
}
|
|
116
116
|
export interface UpdateInputParam {
|
|
117
|
-
|
|
117
|
+
[key : string] : any;
|
|
118
118
|
levels?:{is_unlimited?:boolean,level?:number,name?:string,value?:string}[];
|
|
119
119
|
|
|
120
120
|
name?:string;
|
|
@@ -60,7 +60,7 @@ declare module 'chargebee' {
|
|
|
60
60
|
|
|
61
61
|
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};
|
|
62
62
|
|
|
63
|
-
subscription:
|
|
63
|
+
subscription:{plan_id:string,plan_quantity?:number,plan_quantity_in_decimal?:string};
|
|
64
64
|
|
|
65
65
|
addons?:{id?:string,quantity?:number,quantity_in_decimal?:string}[];
|
|
66
66
|
|
|
@@ -82,9 +82,9 @@ declare module 'chargebee' {
|
|
|
82
82
|
}
|
|
83
83
|
export interface CheckoutNewInputParam {
|
|
84
84
|
|
|
85
|
-
subscription:
|
|
85
|
+
subscription:{affiliate_token?:string,auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,id?:string,invoice_notes?:string,offline_payment_method?:OfflinePaymentMethod,plan_id:string,plan_quantity?:number,plan_quantity_in_decimal?:string,plan_unit_price?:number,plan_unit_price_in_decimal?:string,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
86
86
|
|
|
87
|
-
customer?:
|
|
87
|
+
customer?:{company?:string,consolidated_invoicing?:boolean,email?:string,first_name?:string,id?:string,last_name?:string,locale?:string,phone?:string,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
|
|
88
88
|
|
|
89
89
|
card?:{gateway?:Gateway,gateway_account_id?:string};
|
|
90
90
|
|
|
@@ -125,7 +125,7 @@ declare module 'chargebee' {
|
|
|
125
125
|
}
|
|
126
126
|
export interface CheckoutOneTimeInputParam {
|
|
127
127
|
|
|
128
|
-
customer?:
|
|
128
|
+
customer?:{company?:string,consolidated_invoicing?:boolean,email?:string,first_name?:string,id?:string,last_name?:string,locale?:string,phone?:string,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
|
|
129
129
|
|
|
130
130
|
invoice?:{po_number?:string};
|
|
131
131
|
|
|
@@ -162,7 +162,7 @@ declare module 'chargebee' {
|
|
|
162
162
|
}
|
|
163
163
|
export interface CheckoutOneTimeForItemsInputParam {
|
|
164
164
|
|
|
165
|
-
customer?:
|
|
165
|
+
customer?:{company?:string,consolidated_invoicing?:boolean,einvoicing_method?:EinvoicingMethod,email?:string,entity_identifier_scheme?:string,entity_identifier_standard?:string,first_name?:string,id?:string,is_einvoice_enabled?:boolean,last_name?:string,locale?:string,phone?:string,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
|
|
166
166
|
|
|
167
167
|
invoice?:{po_number?:string};
|
|
168
168
|
|
|
@@ -205,9 +205,9 @@ declare module 'chargebee' {
|
|
|
205
205
|
}
|
|
206
206
|
export interface CheckoutNewForItemsInputParam {
|
|
207
207
|
|
|
208
|
-
subscription?:
|
|
208
|
+
subscription?:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,id?:string,invoice_notes?:string,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
209
209
|
|
|
210
|
-
customer?:
|
|
210
|
+
customer?:{company?:string,einvoicing_method?:EinvoicingMethod,email?:string,entity_identifier_scheme?:string,entity_identifier_standard?:string,first_name?:string,id?:string,is_einvoice_enabled?:boolean,last_name?:string,locale?:string,phone?:string,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
|
|
211
211
|
|
|
212
212
|
card?:{gateway?:Gateway,gateway_account_id?:string};
|
|
213
213
|
|
|
@@ -252,9 +252,9 @@ declare module 'chargebee' {
|
|
|
252
252
|
}
|
|
253
253
|
export interface CheckoutExistingInputParam {
|
|
254
254
|
|
|
255
|
-
subscription:
|
|
255
|
+
subscription:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,id:string,invoice_notes?:string,offline_payment_method?:OfflinePaymentMethod,plan_id?:string,plan_quantity?:number,plan_quantity_in_decimal?:string,plan_unit_price?:number,plan_unit_price_in_decimal?:string,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
256
256
|
|
|
257
|
-
customer?:
|
|
257
|
+
customer?:{vat_number?:string,vat_number_prefix?:string};
|
|
258
258
|
|
|
259
259
|
card?:{gateway?:Gateway,gateway_account_id?:string};
|
|
260
260
|
|
|
@@ -303,9 +303,9 @@ declare module 'chargebee' {
|
|
|
303
303
|
}
|
|
304
304
|
export interface CheckoutExistingForItemsInputParam {
|
|
305
305
|
|
|
306
|
-
subscription:
|
|
306
|
+
subscription:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,id:string,invoice_notes?:string,offline_payment_method?:OfflinePaymentMethod,setup_fee?:number,start_date?:number,trial_end?:number};
|
|
307
307
|
|
|
308
|
-
customer?:
|
|
308
|
+
customer?:{entity_identifier_scheme?:string,entity_identifier_standard?:string,is_einvoice_enabled?:boolean,vat_number?:string,vat_number_prefix?:string};
|
|
309
309
|
|
|
310
310
|
card?:{gateway?:Gateway,gateway_account_id?:string};
|
|
311
311
|
|
|
@@ -446,7 +446,7 @@ declare module 'chargebee' {
|
|
|
446
446
|
|
|
447
447
|
gifter?:{customer_id?:string};
|
|
448
448
|
|
|
449
|
-
subscription:
|
|
449
|
+
subscription:{coupon?:string,plan_id:string,plan_quantity?:number,plan_quantity_in_decimal?:string};
|
|
450
450
|
|
|
451
451
|
addons?:{id?:string,quantity?:number,quantity_in_decimal?:string}[];
|
|
452
452
|
|
|
@@ -736,7 +736,7 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
|
|
|
736
736
|
|
|
737
737
|
void_reason_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
738
738
|
|
|
739
|
-
sort_by?:
|
|
739
|
+
sort_by?:{asc?:'date' | 'updated_at',desc?:'date' | 'updated_at'};
|
|
740
740
|
}
|
|
741
741
|
export interface InvoicesForCustomerResponse {
|
|
742
742
|
list:{invoice:Invoice}[];
|
|
@@ -79,7 +79,7 @@ declare module 'chargebee' {
|
|
|
79
79
|
item:Item;
|
|
80
80
|
}
|
|
81
81
|
export interface CreateInputParam {
|
|
82
|
-
|
|
82
|
+
[key : string] : any;
|
|
83
83
|
bundle_configuration?:{type?:'fixed'};
|
|
84
84
|
|
|
85
85
|
bundle_items_to_add?:{item_id?:string,item_type?:ItemType,price_allocation?:number,quantity?:number}[];
|
|
@@ -134,7 +134,7 @@ declare module 'chargebee' {
|
|
|
134
134
|
item:Item;
|
|
135
135
|
}
|
|
136
136
|
export interface UpdateInputParam {
|
|
137
|
-
|
|
137
|
+
[key : string] : any;
|
|
138
138
|
bundle_configuration?:{type?:'fixed'};
|
|
139
139
|
|
|
140
140
|
bundle_items_to_add?:{item_id?:string,item_type?:ItemType,price_allocation?:number,quantity?:number}[];
|
|
@@ -310,7 +310,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
310
310
|
|
|
311
311
|
include_site_level_resources?:{is?:'true' | 'false'};
|
|
312
312
|
|
|
313
|
-
sort_by?:
|
|
313
|
+
sort_by?:{asc?:'name' | 'id' | 'updated_at',desc?:'name' | 'id' | 'updated_at'};
|
|
314
314
|
}
|
|
315
315
|
export interface DeleteResponse {
|
|
316
316
|
item:Item;
|
|
@@ -39,7 +39,7 @@ declare module 'chargebee' {
|
|
|
39
39
|
item_family:ItemFamily;
|
|
40
40
|
}
|
|
41
41
|
export interface CreateInputParam {
|
|
42
|
-
|
|
42
|
+
[key : string] : any;
|
|
43
43
|
id:string;
|
|
44
44
|
|
|
45
45
|
name:string;
|
|
@@ -111,7 +111,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
111
111
|
item_family:ItemFamily;
|
|
112
112
|
}
|
|
113
113
|
export interface UpdateInputParam {
|
|
114
|
-
|
|
114
|
+
[key : string] : any;
|
|
115
115
|
name?:string;
|
|
116
116
|
|
|
117
117
|
description?:string;
|
|
@@ -111,7 +111,7 @@ declare module 'chargebee' {
|
|
|
111
111
|
item_price:ItemPrice;
|
|
112
112
|
}
|
|
113
113
|
export interface CreateInputParam {
|
|
114
|
-
|
|
114
|
+
[key : string] : any;
|
|
115
115
|
tax_detail?:{avalara_sale_type?:AvalaraSaleType,avalara_service_type?:number,avalara_tax_code?:string,avalara_transaction_type?:number,hsn_code?:string,tax_profile_id?:string,taxjar_product_code?:string};
|
|
116
116
|
|
|
117
117
|
accounting_detail?:{accounting_category1?:string,accounting_category2?:string,accounting_category3?:string,accounting_category4?:string,accounting_code?:string,sku?:string};
|
|
@@ -384,7 +384,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
384
384
|
|
|
385
385
|
channel?:{in?:string,is?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | 'play_store',not_in?:string};
|
|
386
386
|
|
|
387
|
-
sort_by?:
|
|
387
|
+
sort_by?:{asc?:'name' | 'id' | 'updated_at',desc?:'name' | 'id' | 'updated_at'};
|
|
388
388
|
}
|
|
389
389
|
export interface DeleteResponse {
|
|
390
390
|
item_price:ItemPrice;
|
|
@@ -411,7 +411,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
411
411
|
|
|
412
412
|
offset?:string;
|
|
413
413
|
|
|
414
|
-
sort_by?:
|
|
414
|
+
sort_by?:{asc?:'name' | 'id' | 'updated_at',desc?:'name' | 'id' | 'updated_at'};
|
|
415
415
|
}
|
|
416
416
|
export interface FindApplicableItemPricesResponse {
|
|
417
417
|
list:{item_price:ItemPrice}[];
|
|
@@ -436,7 +436,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
436
436
|
|
|
437
437
|
item_id?:string;
|
|
438
438
|
|
|
439
|
-
sort_by?:
|
|
439
|
+
sort_by?:{asc?:'name' | 'id' | 'updated_at',desc?:'name' | 'id' | 'updated_at'};
|
|
440
440
|
}
|
|
441
441
|
export interface Tier {
|
|
442
442
|
starting_unit:number;
|
|
@@ -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?:{asc?:'created_at' | 'updated_at',desc?:'created_at' | 'updated_at'};
|
|
433
433
|
}
|
|
434
434
|
export interface OrdersForInvoiceResponse {
|
|
435
435
|
list:{order:Order}[];
|
|
@@ -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?:{asc?:'created_at' | 'updated_at',desc?:'created_at' | 'updated_at'};
|
|
307
307
|
}
|
|
308
308
|
export interface SwitchGatewayAccountResponse {
|
|
309
309
|
customer:Customer;
|
|
@@ -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?:{asc?:'date' | 'updated_at',desc?:'date' | 'updated_at'};
|
|
104
104
|
}
|
|
105
105
|
export interface PaymentVouchersForCustomerResponse {
|
|
106
106
|
list:{payment_voucher:PaymentVoucher}[];
|
|
@@ -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?:{asc?:'date' | 'updated_at',desc?:'date' | 'updated_at'};
|
|
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
|
+
[key : string] : any;
|
|
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
|
+
[key : string] : any;
|
|
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}[];
|
|
@@ -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?:{asc?:'name' | 'id' | 'status' | 'created_at' | 'updated_at',desc?:'name' | 'id' | 'status' | 'created_at' | 'updated_at'};
|
|
160
160
|
}
|
|
161
161
|
export interface Attribute {
|
|
162
162
|
name:string;
|
|
@@ -26,9 +26,9 @@ declare module 'chargebee' {
|
|
|
26
26
|
|
|
27
27
|
pricing_page:{id:string};
|
|
28
28
|
|
|
29
|
-
subscription?:
|
|
29
|
+
subscription?:{id?:string};
|
|
30
30
|
|
|
31
|
-
customer?:
|
|
31
|
+
customer?:{company?:string,email?:string,first_name?:string,id?:string,last_name?:string,locale?:string,phone?:string};
|
|
32
32
|
|
|
33
33
|
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};
|
|
34
34
|
|
|
@@ -47,7 +47,7 @@ declare module 'chargebee' {
|
|
|
47
47
|
|
|
48
48
|
pricing_page:{id:string};
|
|
49
49
|
|
|
50
|
-
subscription:
|
|
50
|
+
subscription:{id:string};
|
|
51
51
|
|
|
52
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
|
|
|
@@ -369,7 +369,7 @@ declare module 'chargebee' {
|
|
|
369
369
|
quoted_ramp?:QuotedRamp;
|
|
370
370
|
}
|
|
371
371
|
export interface CreateSubItemsForCustomerQuoteInputParam {
|
|
372
|
-
|
|
372
|
+
[key : string] : any;
|
|
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};
|
|
@@ -414,7 +414,7 @@ declare module 'chargebee' {
|
|
|
414
414
|
quoted_ramp?:QuotedRamp;
|
|
415
415
|
}
|
|
416
416
|
export interface EditCreateSubCustomerQuoteForItemsInputParam {
|
|
417
|
-
|
|
417
|
+
[key : string] : any;
|
|
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};
|
|
@@ -457,7 +457,7 @@ declare module 'chargebee' {
|
|
|
457
457
|
quoted_ramp?:QuotedRamp;
|
|
458
458
|
}
|
|
459
459
|
export interface UpdateSubscriptionQuoteForItemsInputParam {
|
|
460
|
-
|
|
460
|
+
[key : string] : any;
|
|
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};
|
|
@@ -516,7 +516,7 @@ declare module 'chargebee' {
|
|
|
516
516
|
quoted_ramp?:QuotedRamp;
|
|
517
517
|
}
|
|
518
518
|
export interface EditUpdateSubscriptionQuoteForItemsInputParam {
|
|
519
|
-
|
|
519
|
+
[key : string] : any;
|
|
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};
|
|
@@ -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?:{asc?:'date',desc?:'date'};
|
|
710
710
|
}
|
|
711
711
|
export interface QuoteLineGroupsForQuoteResponse {
|
|
712
712
|
list:{quote_line_group:QuoteLineGroup}[];
|
|
@@ -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?:{asc?:'effective_from' | 'updated_at',desc?:'effective_from' | 'updated_at'};
|
|
171
171
|
}
|
|
172
172
|
export interface ItemsToAdd {
|
|
173
173
|
item_price_id:string;
|
|
@@ -253,8 +253,8 @@ declare module 'chargebee' {
|
|
|
253
253
|
unbilled_charges?:UnbilledCharge[];
|
|
254
254
|
}
|
|
255
255
|
export interface CreateInputParam {
|
|
256
|
-
|
|
257
|
-
customer?:
|
|
256
|
+
[key : string] : any;
|
|
257
|
+
customer?:{allow_direct_debit?:boolean,auto_collection?:AutoCollection,business_customer_without_vat_number?:boolean,company?:string,consolidated_invoicing?:boolean,customer_type?:CustomerType,einvoicing_method?:EinvoicingMethod,email?:string,entity_code?:EntityCode,entity_identifier_scheme?:string,entity_identifier_standard?:string,exempt_number?:string,exemption_details?:any[],first_name?:string,id?:string,is_einvoice_enabled?:boolean,last_name?:string,locale?:string,net_term_days?:number,offline_payment_method?:OfflinePaymentMethod,phone?:string,registered_for_gst?:boolean,taxability?:Taxability,taxjar_exemption_category?:TaxjarExemptionCategory,vat_number?:string,vat_number_prefix?:string};
|
|
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};
|
|
260
260
|
|
|
@@ -356,7 +356,7 @@ declare module 'chargebee' {
|
|
|
356
356
|
unbilled_charges?:UnbilledCharge[];
|
|
357
357
|
}
|
|
358
358
|
export interface CreateForCustomerInputParam {
|
|
359
|
-
|
|
359
|
+
[key : string] : any;
|
|
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
|
+
[key : string] : any;
|
|
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};
|
|
@@ -675,7 +675,7 @@ declare module 'chargebee' {
|
|
|
675
675
|
|
|
676
676
|
override_relationship?:{is?:'true' | 'false'};
|
|
677
677
|
|
|
678
|
-
sort_by?:
|
|
678
|
+
sort_by?:{asc?:'created_at' | 'updated_at',desc?:'created_at' | 'updated_at'};
|
|
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.
|
|
@@ -737,7 +737,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
737
737
|
|
|
738
738
|
offset?:string;
|
|
739
739
|
|
|
740
|
-
sort_by?:
|
|
740
|
+
sort_by?:{asc?:'created_at',desc?:'created_at'};
|
|
741
741
|
}
|
|
742
742
|
export interface ListDiscountsResponse {
|
|
743
743
|
list:{discount:Discount}[];
|
|
@@ -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
|
+
[key : string] : any;
|
|
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
|
+
[key : string] : any;
|
|
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};
|
|
@@ -1208,8 +1208,8 @@ 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
|
-
|
|
1212
|
-
customer?:
|
|
1211
|
+
[key : string] : any;
|
|
1212
|
+
customer?:{allow_direct_debit?:boolean,auto_collection?:AutoCollection,company?:string,customer_type?:CustomerType,email?:string,entity_code?:EntityCode,exempt_number?:string,first_name?:string,id?:string,last_name?:string,locale?:string,net_term_days?:number,phone?:string,taxability?:Taxability,taxjar_exemption_category?:TaxjarExemptionCategory,vat_number?:string,vat_number_prefix?:string};
|
|
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};
|
|
1215
1215
|
|
|
@@ -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
|
+
[key : string] : any;
|
|
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};
|
|
@@ -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
|
+
[key : string] : any;
|
|
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};
|
|
@@ -308,7 +308,7 @@ declare module 'chargebee' {
|
|
|
308
308
|
|
|
309
309
|
updated_at?:{after?:string,before?:string,between?:string,on?:string};
|
|
310
310
|
|
|
311
|
-
sort_by?:
|
|
311
|
+
sort_by?:{asc?:'date' | 'updated_at',desc?:'date' | 'updated_at'};
|
|
312
312
|
}
|
|
313
313
|
export interface TransactionsForCustomerResponse {
|
|
314
314
|
list:{transaction:Transaction}[];
|
|
@@ -143,7 +143,7 @@ declare module 'chargebee' {
|
|
|
143
143
|
|
|
144
144
|
source?:{in?:string,is?:'admin_console' | 'api' | 'bulk_operation',is_not?:'admin_console' | 'api' | 'bulk_operation',not_in?:string};
|
|
145
145
|
|
|
146
|
-
sort_by?:
|
|
146
|
+
sort_by?:{asc?:'usage_date' | 'updated_at',desc?:'usage_date' | 'updated_at'};
|
|
147
147
|
}
|
|
148
148
|
export interface PdfResponse {
|
|
149
149
|
download:Download;
|