chargebee 2.28.0 → 2.30.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/.github/ISSUE_TEMPLATE/bug_report.yml +81 -0
- package/.github/ISSUE_TEMPLATE/config.yml +6 -0
- package/.github/ISSUE_TEMPLATE/feature_request.yml +34 -0
- package/.github/PULL_REQUEST_TEMPLATE.md +8 -0
- package/.github/workflows/greeting.yml +47 -0
- package/CHANGELOG.md +59 -0
- package/SECURITY.md +8 -0
- package/lib/chargebee.js +1 -1
- package/lib/resources/api_endpoints.js +0 -14
- package/package.json +1 -1
- package/types/core.d.ts +4 -4
- package/types/resources/AttachedItem.d.ts +88 -88
- package/types/resources/Card.d.ts +68 -68
- package/types/resources/Comment.d.ts +50 -44
- package/types/resources/Coupon.d.ts +242 -207
- package/types/resources/CouponSet.d.ts +72 -68
- package/types/resources/CreditNote.d.ts +612 -236
- package/types/resources/Customer.d.ts +655 -513
- package/types/resources/DifferentialPrice.d.ts +99 -74
- package/types/resources/EntitlementOverride.d.ts +27 -12
- package/types/resources/Estimate.d.ts +450 -450
- package/types/resources/Event.d.ts +30 -12
- package/types/resources/Export.d.ts +200 -200
- package/types/resources/Feature.d.ts +66 -35
- package/types/resources/Gift.d.ts +54 -44
- package/types/resources/HostedPage.d.ts +381 -381
- package/types/resources/InAppSubscription.d.ts +94 -90
- package/types/resources/Invoice.d.ts +1242 -660
- package/types/resources/Item.d.ts +148 -142
- package/types/resources/ItemEntitlement.d.ts +36 -36
- package/types/resources/ItemFamily.d.ts +45 -45
- package/types/resources/ItemPrice.d.ts +317 -273
- package/types/resources/PaymentIntent.d.ts +60 -60
- package/types/resources/PaymentReferenceNumber.d.ts +1 -1
- package/types/resources/PaymentVoucher.d.ts +74 -59
- package/types/resources/PortalSession.d.ts +45 -20
- package/types/resources/PromotionalCredit.d.ts +68 -68
- package/types/resources/Purchase.d.ts +3 -3
- package/types/resources/Quote.d.ts +655 -366
- package/types/resources/QuoteLineGroup.d.ts +245 -0
- package/types/resources/QuotedCharge.d.ts +170 -0
- package/types/resources/QuotedSubscription.d.ts +219 -0
- package/types/resources/SiteMigrationDetail.d.ts +7 -7
- package/types/resources/Subscription.d.ts +1219 -932
- package/types/resources/SubscriptionEntitlement.d.ts +33 -12
- package/types/resources/ThirdPartyPaymentMethod.d.ts +1 -1
- package/types/resources/TimeMachine.d.ts +15 -15
- package/types/resources/Token.d.ts +0 -116
- package/types/resources/Transaction.d.ts +229 -112
- package/types/resources/UnbilledCharge.d.ts +112 -67
- package/types/resources/Usage.d.ts +46 -47
- package/types/resources/VirtualBankAccount.d.ts +66 -66
- package/types/resources/Media.d.ts +0 -33
- package/types/resources/NonSubscription.d.ts +0 -65
|
@@ -47,261 +47,256 @@ declare module 'chargebee' {
|
|
|
47
47
|
export namespace Export {
|
|
48
48
|
export class ExportResource {
|
|
49
49
|
/**
|
|
50
|
-
* @description This API
|
|
50
|
+
* @description This API gets the status of the export job initiated by the Exports API. If the export job is completed, the downloads resource will also be obtained in the API response. The returned URL in the downloads resource is secure and can be downloaded. The URL expires after 4 hours. Please note that this is a public URL, and can be downloaded by anyone with whom it's shared.
|
|
51
|
+
|
|
52
|
+
**Note:** In case the export is in Failed or In-process state, then the downloads resource will not be available.
|
|
51
53
|
|
|
52
54
|
*/
|
|
53
55
|
|
|
54
|
-
|
|
56
|
+
retrieve(export_id:string):ChargebeeRequest<RetrieveResponse>;
|
|
55
57
|
|
|
56
58
|
/**
|
|
57
|
-
* @description This API triggers export
|
|
59
|
+
* @description This API triggers export for the revenue recognition report.
|
|
60
|
+
|
|
61
|
+
**Note:** This API call is asynchronous. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. In case you are using any of the client libraries, use the **wait for export completion** function provided as an instance method in the library. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **WaitForExportCompletion** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes.
|
|
58
62
|
|
|
59
63
|
*/
|
|
60
64
|
|
|
61
|
-
|
|
65
|
+
revenue_recognition(input:RevenueRecognitionInputParam):ChargebeeRequest<RevenueRecognitionResponse>;
|
|
62
66
|
|
|
63
67
|
/**
|
|
64
|
-
* @description This API triggers export
|
|
68
|
+
* @description This API triggers export for the Deferred Revenue Report.
|
|
69
|
+
|
|
70
|
+
**Note:** This API call is asynchronous. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. In case you are using any of the client libraries, use the **wait for export completion** function provided as an instance method in the library. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **WaitForExportCompletion** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes.
|
|
65
71
|
|
|
66
72
|
*/
|
|
67
73
|
|
|
68
|
-
|
|
74
|
+
deferred_revenue(input:DeferredRevenueInputParam):ChargebeeRequest<DeferredRevenueResponse>;
|
|
69
75
|
|
|
70
76
|
/**
|
|
71
|
-
* @description This API triggers export of
|
|
77
|
+
* @description This API triggers export of coupon data. The exported zip file contains CSV files with coupon-related data.
|
|
72
78
|
|
|
73
79
|
*/
|
|
74
80
|
|
|
75
|
-
|
|
81
|
+
coupons(input?:CouponsInputParam):ChargebeeRequest<CouponsResponse>;
|
|
76
82
|
|
|
77
83
|
/**
|
|
78
|
-
* @description This API triggers export of
|
|
84
|
+
* @description This API triggers export of customer data. The exported zip file contains CSV files with customer-related data.
|
|
79
85
|
|
|
80
86
|
*/
|
|
81
87
|
|
|
82
|
-
|
|
88
|
+
customers(input?:CustomersInputParam):ChargebeeRequest<CustomersResponse>;
|
|
83
89
|
|
|
84
90
|
/**
|
|
85
|
-
* @description This API triggers export of
|
|
91
|
+
* @description This API triggers export of subscription data. The exported zip file contains CSV files with subscription-related data.
|
|
86
92
|
|
|
87
93
|
*/
|
|
88
94
|
|
|
89
|
-
|
|
95
|
+
subscriptions(input?:SubscriptionsInputParam):ChargebeeRequest<SubscriptionsResponse>;
|
|
90
96
|
|
|
91
97
|
/**
|
|
92
|
-
* @description This API
|
|
93
|
-
|
|
94
|
-
**Note:** In case the export is in Failed or In-process state, then the downloads resource will not be available.
|
|
98
|
+
* @description This API triggers export of invoice data. The exported zip file contains CSV files with invoice-related data.
|
|
95
99
|
|
|
96
100
|
*/
|
|
97
101
|
|
|
98
|
-
|
|
102
|
+
invoices(input?:InvoicesInputParam):ChargebeeRequest<InvoicesResponse>;
|
|
99
103
|
|
|
100
104
|
/**
|
|
101
|
-
* @description This API triggers export of
|
|
105
|
+
* @description This API triggers export of credit note data. The exported zip file contains CSV files with credit note-related data.
|
|
102
106
|
|
|
103
107
|
*/
|
|
104
108
|
|
|
105
|
-
|
|
109
|
+
credit_notes(input?:CreditNotesInputParam):ChargebeeRequest<CreditNotesResponse>;
|
|
106
110
|
|
|
107
111
|
/**
|
|
108
|
-
* @description This API triggers export
|
|
109
|
-
|
|
110
|
-
**Note:** This API call is asynchronous. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. In case you are using any of the client libraries, use the **wait for export completion** function provided as an instance method in the library. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **WaitForExportCompletion** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes.
|
|
112
|
+
* @description This API triggers export of transaction data. The exported zip file contains CSV files with transaction-related data.
|
|
111
113
|
|
|
112
114
|
*/
|
|
113
115
|
|
|
114
|
-
|
|
116
|
+
transactions(input?:TransactionsInputParam):ChargebeeRequest<TransactionsResponse>;
|
|
115
117
|
|
|
116
118
|
/**
|
|
117
|
-
* @description This API triggers export
|
|
118
|
-
|
|
119
|
-
**Note:** This API call is asynchronous. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. In case you are using any of the client libraries, use the **wait for export completion** function provided as an instance method in the library. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **WaitForExportCompletion** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes.
|
|
119
|
+
* @description This API triggers export of order data. The exported zip file contains CSV files with order-related data.
|
|
120
120
|
|
|
121
121
|
*/
|
|
122
122
|
|
|
123
|
-
|
|
123
|
+
orders(input?:OrdersInputParam):ChargebeeRequest<OrdersResponse>;
|
|
124
124
|
|
|
125
125
|
/**
|
|
126
|
-
* @description This API triggers export of
|
|
126
|
+
* @description This API triggers export of item family data. The exported zip file contains CSV files with item family-related data.
|
|
127
127
|
|
|
128
128
|
*/
|
|
129
129
|
|
|
130
|
-
|
|
130
|
+
item_families(input?:ItemFamiliesInputParam):ChargebeeRequest<ItemFamiliesResponse>;
|
|
131
131
|
|
|
132
132
|
/**
|
|
133
|
-
* @description This API triggers export of
|
|
133
|
+
* @description This API triggers export of item data. The exported zip file contains CSV files with item-related data.
|
|
134
134
|
|
|
135
135
|
*/
|
|
136
136
|
|
|
137
|
-
|
|
137
|
+
items(input?:ItemsInputParam):ChargebeeRequest<ItemsResponse>;
|
|
138
138
|
|
|
139
139
|
/**
|
|
140
|
-
* @description This API triggers export of
|
|
140
|
+
* @description This API triggers export of item price data. The exported zip file contains CSV files with item price-related data.
|
|
141
141
|
|
|
142
142
|
*/
|
|
143
143
|
|
|
144
|
-
|
|
144
|
+
item_prices(input?:ItemPricesInputParam):ChargebeeRequest<ItemPricesResponse>;
|
|
145
145
|
|
|
146
146
|
/**
|
|
147
|
-
* @description This API triggers export of item
|
|
147
|
+
* @description This API triggers export of attached item data. The exported zip file contains CSV files with attached item-related data.
|
|
148
148
|
|
|
149
149
|
*/
|
|
150
150
|
|
|
151
|
-
|
|
151
|
+
attached_items(input?:AttachedItemsInputParam):ChargebeeRequest<AttachedItemsResponse>;
|
|
152
152
|
|
|
153
153
|
/**
|
|
154
|
-
* @description This API triggers export of
|
|
154
|
+
* @description This API triggers export of differential price data. The exported zip file contains CSV files with differential price-related data.
|
|
155
155
|
|
|
156
156
|
*/
|
|
157
157
|
|
|
158
|
-
|
|
158
|
+
differential_prices(input?:DifferentialPricesInputParam):ChargebeeRequest<DifferentialPricesResponse>;
|
|
159
159
|
}
|
|
160
|
-
export interface
|
|
160
|
+
export interface RetrieveResponse {
|
|
161
161
|
export:Export;
|
|
162
162
|
}
|
|
163
|
-
|
|
163
|
+
|
|
164
|
+
export interface RevenueRecognitionResponse {
|
|
165
|
+
export:Export;
|
|
166
|
+
}
|
|
167
|
+
export interface RevenueRecognitionInputParam {
|
|
164
168
|
|
|
165
169
|
/**
|
|
166
|
-
* @description
|
|
170
|
+
* @description Determines the scope of the report. Returns the report based on the value specified. \* subscription - Subscription \* invoice - Invoice \* product - Product (Includes Plan, Addon and Adhoc) \* customer - Customer
|
|
167
171
|
|
|
168
172
|
*/
|
|
169
173
|
|
|
170
|
-
|
|
174
|
+
report_by:ReportBy;
|
|
171
175
|
|
|
172
176
|
/**
|
|
173
|
-
* @description
|
|
174
|
-
The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.
|
|
175
|
-
**Note**
|
|
176
|
-
|
|
177
|
-
[Multiple Business Entities](/docs/api?prod_cat_ver=2#mbe) is a feature available only on Product Catalog 2.0.
|
|
177
|
+
* @description Value must be in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. Generates the report based on the value specified. If no currency_code value is specified, then consolidated report based on base currency is returned.
|
|
178
178
|
|
|
179
179
|
*/
|
|
180
180
|
|
|
181
|
-
|
|
181
|
+
currency_code?:string;
|
|
182
182
|
|
|
183
183
|
/**
|
|
184
|
-
* @description
|
|
184
|
+
* @description Obtains report data from the specified month, combined with the value specified for report_from_year. Values must be between 1 and 12, where 1 is January and 12 is December.
|
|
185
185
|
|
|
186
186
|
*/
|
|
187
187
|
|
|
188
|
-
|
|
188
|
+
report_from_month:number;
|
|
189
189
|
|
|
190
190
|
/**
|
|
191
|
-
* @description
|
|
191
|
+
* @description Obtains report data from the specified year, combined with the value specified for report_from_month.
|
|
192
192
|
|
|
193
193
|
*/
|
|
194
194
|
|
|
195
|
-
|
|
196
|
-
}
|
|
197
|
-
export interface AttachedItemsResponse {
|
|
198
|
-
export:Export;
|
|
199
|
-
}
|
|
200
|
-
export interface AttachedItemsInputParam {
|
|
195
|
+
report_from_year:number;
|
|
201
196
|
|
|
202
197
|
/**
|
|
203
|
-
* @description
|
|
204
|
-
To filter based on the type of of the attached item. Possible values are : `addon`, `charge`. Possible values are : plan, addon, charge.
|
|
205
|
-
**Supported operators :** is, is_not, in, not_in
|
|
198
|
+
* @description Obtains report data from the specified month, combined with the value specified for report_to_year. Values must be between 1 and 12, where 1 is January and 12 is December.
|
|
206
199
|
|
|
207
|
-
|
|
200
|
+
*/
|
|
201
|
+
|
|
202
|
+
report_to_month:number;
|
|
203
|
+
|
|
204
|
+
/**
|
|
205
|
+
* @description Obtains report data until the specified year, combined with the value specified for report_to_month.
|
|
208
206
|
|
|
209
207
|
*/
|
|
210
208
|
|
|
211
|
-
|
|
209
|
+
report_to_year:number;
|
|
212
210
|
|
|
213
211
|
/**
|
|
214
|
-
* @description
|
|
212
|
+
* @description Returns amount with discount in the report. If value specified is false, it returns amount without discount.
|
|
215
213
|
|
|
216
214
|
*/
|
|
217
215
|
|
|
218
|
-
|
|
219
|
-
}
|
|
220
|
-
export interface TransactionsResponse {
|
|
221
|
-
export:Export;
|
|
222
|
-
}
|
|
223
|
-
export interface TransactionsInputParam {
|
|
216
|
+
include_discounts?:boolean;
|
|
224
217
|
|
|
225
218
|
/**
|
|
226
|
-
* @description
|
|
219
|
+
* @description optional, string filter
|
|
220
|
+
Payment owner of an invoice.
|
|
221
|
+
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
222
|
+
|
|
223
|
+
**Example →** *payment_owner\[is\] = "payment_customer"*
|
|
227
224
|
|
|
228
225
|
*/
|
|
229
226
|
|
|
230
|
-
|
|
231
|
-
}
|
|
232
|
-
export interface DifferentialPricesResponse {
|
|
233
|
-
export:Export;
|
|
234
|
-
}
|
|
235
|
-
export interface DifferentialPricesInputParam {
|
|
227
|
+
payment_owner?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
236
228
|
|
|
237
229
|
/**
|
|
238
230
|
* @description optional, string filter
|
|
239
|
-
|
|
231
|
+
The plan item code.
|
|
240
232
|
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
241
233
|
|
|
242
|
-
**Example →** *item_id\[is\] = "
|
|
234
|
+
**Example →** *item_id\[is\] = "silver"*
|
|
243
235
|
|
|
244
236
|
*/
|
|
245
237
|
|
|
246
238
|
item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
247
239
|
|
|
248
240
|
/**
|
|
249
|
-
* @description
|
|
241
|
+
* @description optional, string filter
|
|
242
|
+
The plan item price code.
|
|
243
|
+
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
244
|
+
|
|
245
|
+
**Example →** *item_price_id\[is\] = "silver-USD-monthly"*
|
|
250
246
|
|
|
251
247
|
*/
|
|
252
248
|
|
|
253
|
-
|
|
254
|
-
}
|
|
255
|
-
export interface ItemFamiliesResponse {
|
|
256
|
-
export:Export;
|
|
257
|
-
}
|
|
258
|
-
export interface ItemFamiliesInputParam {
|
|
249
|
+
item_price_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
259
250
|
|
|
260
251
|
/**
|
|
261
|
-
* @description
|
|
252
|
+
* @description optional, string filter
|
|
253
|
+
Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Subscriptions \> Subscription Cancellation** . Must be passed if set as mandatory in the app. The codes are case-sensitive.
|
|
254
|
+
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
255
|
+
|
|
256
|
+
**Example →** *cancel_reason_code\[is\] = "Not Paid"*
|
|
262
257
|
|
|
263
258
|
*/
|
|
264
259
|
|
|
265
|
-
|
|
266
|
-
}
|
|
267
|
-
export interface InvoicesResponse {
|
|
268
|
-
export:Export;
|
|
269
|
-
}
|
|
270
|
-
export interface InvoicesInputParam {
|
|
260
|
+
cancel_reason_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
271
261
|
|
|
272
262
|
/**
|
|
273
263
|
* @description optional, string filter
|
|
274
|
-
|
|
275
|
-
**Supported operators :** is, is_not, starts_with
|
|
264
|
+
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.
|
|
265
|
+
**Supported operators :** is, is_not, starts_with
|
|
276
266
|
|
|
277
|
-
**Example →** *
|
|
267
|
+
**Example →** *business_entity_id\[is_not\] = "business_entity_id"*
|
|
278
268
|
|
|
279
269
|
*/
|
|
280
270
|
|
|
281
|
-
|
|
271
|
+
business_entity_id?:{is?:string,is_not?:string,starts_with?:string};
|
|
282
272
|
|
|
283
273
|
/**
|
|
284
274
|
* @description Parameters for invoice
|
|
285
275
|
|
|
286
276
|
*/
|
|
287
277
|
|
|
288
|
-
invoice?:{amount_adjusted?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_due?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_paid?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},credits_applied?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},
|
|
289
|
-
}
|
|
290
|
-
export interface RetrieveResponse {
|
|
291
|
-
export:Export;
|
|
292
|
-
}
|
|
293
|
-
|
|
294
|
-
export interface ItemsResponse {
|
|
295
|
-
export:Export;
|
|
296
|
-
}
|
|
297
|
-
export interface ItemsInputParam {
|
|
278
|
+
invoice?:{amount_adjusted?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_due?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_paid?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},credits_applied?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},date?:{after?:string,before?:string,between?:string,on?:string},dunning_status?:{in?:string,is?:'in_progress' | 'stopped' | 'success' | 'exhausted',is_not?:'in_progress' | 'stopped' | 'success' | 'exhausted',is_present?:'true' | 'false',not_in?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},paid_at?:{after?:string,before?:string,between?:string,on?:string},price_type?:{in?:string,is?:'tax_exclusive' | 'tax_inclusive',is_not?:'tax_exclusive' | 'tax_inclusive',not_in?:string},recurring?:{is?:'true' | 'false'},status?:{in?:string,is?:'pending' | 'paid' | 'voided' | 'not_paid' | 'posted' | 'payment_due',is_not?:'pending' | 'paid' | 'voided' | 'not_paid' | 'posted' | 'payment_due',not_in?:string},total?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
298
279
|
|
|
299
280
|
/**
|
|
300
|
-
* @description Parameters for
|
|
281
|
+
* @description Parameters for subscription
|
|
301
282
|
|
|
302
283
|
*/
|
|
303
284
|
|
|
304
|
-
|
|
285
|
+
subscription?:{activated_at?:{after?:string,before?:string,between?:string,is_present?:'true' | 'false',on?:string},auto_close_invoices?:{is?:'true' | 'false'},cancel_reason?:{in?:string,is?:'tax_calculation_failed' | 'fraud_review_failed' | 'currency_incompatible_with_gateway' | 'non_compliant_eu_customer' | 'non_compliant_customer' | 'not_paid' | 'no_card',is_not?:'tax_calculation_failed' | 'fraud_review_failed' | 'currency_incompatible_with_gateway' | 'non_compliant_eu_customer' | 'non_compliant_customer' | 'not_paid' | 'no_card',is_present?:'true' | 'false',not_in?:string},cancelled_at?:{after?:string,before?:string,between?:string,on?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},created_at?:{after?:string,before?:string,between?:string,on?:string},customer_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},has_scheduled_changes?:{is?:'true' | 'false'},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},next_billing_at?:{after?:string,before?:string,between?:string,on?:string},offline_payment_method?:{in?:string,is?:'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash',is_not?:'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash',not_in?:string},remaining_billing_cycles?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,is_present?:'true' | 'false',lt?:string,lte?:string},status?:{in?:string,is?:'in_trial' | 'paused' | 'future' | 'active' | 'cancelled' | 'non_renewing',is_not?:'in_trial' | 'paused' | 'future' | 'active' | 'cancelled' | 'non_renewing',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
286
|
+
|
|
287
|
+
/**
|
|
288
|
+
* @description Parameters for customer
|
|
289
|
+
|
|
290
|
+
*/
|
|
291
|
+
|
|
292
|
+
customer?:{auto_close_invoices?:{is?:'true' | 'false'},auto_collection?:{in?:string,is?:'off' | 'on',is_not?:'off' | 'on',not_in?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},company?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},created_at?:{after?:string,before?:string,between?:string,on?:string},email?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},first_name?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},last_name?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},offline_payment_method?:{in?:string,is?:'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash',is_not?:'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash',not_in?:string},phone?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},taxability?:{in?:string,is?:'taxable' | 'exempt',is_not?:'taxable' | 'exempt',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
293
|
+
|
|
294
|
+
/**
|
|
295
|
+
* @description Parameters for relationship
|
|
296
|
+
|
|
297
|
+
*/
|
|
298
|
+
|
|
299
|
+
relationship?:{invoice_owner_id?:{is?:string,is_not?:string,starts_with?:string},parent_id?:{is?:string,is_not?:string,starts_with?:string},payment_owner_id?:{is?:string,is_not?:string,starts_with?:string}};
|
|
305
300
|
}
|
|
306
301
|
export interface DeferredRevenueResponse {
|
|
307
302
|
export:Export;
|
|
@@ -402,11 +397,11 @@ Reason code for canceling the subscription. Must be one from a list of reason co
|
|
|
402
397
|
cancel_reason_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
403
398
|
|
|
404
399
|
/**
|
|
405
|
-
* @description
|
|
406
|
-
The ID of the business entity
|
|
407
|
-
**
|
|
400
|
+
* @description optional, string filter
|
|
401
|
+
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.
|
|
402
|
+
**Supported operators :** is, is_not, starts_with
|
|
408
403
|
|
|
409
|
-
|
|
404
|
+
**Example →** *business_entity_id\[is_not\] = "business_entity_id"*
|
|
410
405
|
|
|
411
406
|
*/
|
|
412
407
|
|
|
@@ -440,70 +435,77 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
440
435
|
|
|
441
436
|
relationship?:{invoice_owner_id?:{is?:string,is_not?:string,starts_with?:string},parent_id?:{is?:string,is_not?:string,starts_with?:string},payment_owner_id?:{is?:string,is_not?:string,starts_with?:string}};
|
|
442
437
|
}
|
|
443
|
-
export interface
|
|
438
|
+
export interface CouponsResponse {
|
|
444
439
|
export:Export;
|
|
445
440
|
}
|
|
446
|
-
export interface
|
|
441
|
+
export interface CouponsInputParam {
|
|
447
442
|
|
|
448
443
|
/**
|
|
449
|
-
* @description
|
|
444
|
+
* @description optional, string filter
|
|
445
|
+
The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)) of the coupon. Applicable for *fixed_amount* coupons alone.
|
|
446
|
+
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
450
447
|
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
report_by:ReportBy;
|
|
454
|
-
|
|
455
|
-
/**
|
|
456
|
-
* @description Value must be in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. Generates the report based on the value specified. If no currency_code value is specified, then consolidated report based on base currency is returned.
|
|
448
|
+
**Example →** *currency_code\[is\] = "USD"*
|
|
457
449
|
|
|
458
450
|
*/
|
|
459
451
|
|
|
460
|
-
currency_code?:string;
|
|
452
|
+
currency_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
461
453
|
|
|
462
454
|
/**
|
|
463
|
-
* @description
|
|
455
|
+
* @description Parameters for coupon
|
|
464
456
|
|
|
465
457
|
*/
|
|
466
458
|
|
|
467
|
-
|
|
459
|
+
coupon?:{apply_on?:{in?:string,is?:'invoice_amount' | 'each_specified_item',is_not?:'invoice_amount' | 'each_specified_item',not_in?:string},created_at?:{after?:string,before?:string,between?:string,on?:string},discount_type?:{in?:string,is?:'fixed_amount' | 'percentage',is_not?:'fixed_amount' | 'percentage',not_in?:string},duration_type?:{in?:string,is?:'limited_period' | 'one_time' | 'forever',is_not?:'limited_period' | 'one_time' | 'forever',not_in?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},name?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},status?:{in?:string,is?:'archived' | 'expired' | 'deleted' | 'active',is_not?:'archived' | 'expired' | 'deleted' | 'active',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
460
|
+
}
|
|
461
|
+
export interface CustomersResponse {
|
|
462
|
+
export:Export;
|
|
463
|
+
}
|
|
464
|
+
export interface CustomersInputParam {
|
|
468
465
|
|
|
469
466
|
/**
|
|
470
|
-
* @description
|
|
467
|
+
* @description Determines the format of the data. Returns the export type based on the selected value. \* data - Download your current data in CSV. \* import_friendly_data - Download import friendly data in CSV. This CSV can be used to perform [bulk operations](https://www.chargebee.com/docs/bulk-operations.html).
|
|
471
468
|
|
|
472
469
|
*/
|
|
473
470
|
|
|
474
|
-
|
|
471
|
+
export_type?:ExportType;
|
|
475
472
|
|
|
476
473
|
/**
|
|
477
|
-
* @description
|
|
474
|
+
* @description optional, string filter
|
|
475
|
+
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.
|
|
476
|
+
**Supported operators :** is, is_not, starts_with
|
|
477
|
+
|
|
478
|
+
**Example →** *business_entity_id\[is\] = "business_entity_id"*
|
|
478
479
|
|
|
479
480
|
*/
|
|
480
481
|
|
|
481
|
-
|
|
482
|
+
business_entity_id?:{is?:string,is_not?:string,starts_with?:string};
|
|
482
483
|
|
|
483
484
|
/**
|
|
484
|
-
* @description
|
|
485
|
+
* @description Parameters for customer
|
|
485
486
|
|
|
486
487
|
*/
|
|
487
488
|
|
|
488
|
-
|
|
489
|
+
customer?:{auto_close_invoices?:{is?:'true' | 'false'},auto_collection?:{in?:string,is?:'off' | 'on',is_not?:'off' | 'on',not_in?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},company?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},created_at?:{after?:string,before?:string,between?:string,on?:string},email?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},first_name?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},last_name?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},offline_payment_method?:{in?:string,is?:'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash',is_not?:'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash',not_in?:string},phone?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},taxability?:{in?:string,is?:'taxable' | 'exempt',is_not?:'taxable' | 'exempt',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
489
490
|
|
|
490
491
|
/**
|
|
491
|
-
* @description
|
|
492
|
+
* @description Parameters for relationship
|
|
492
493
|
|
|
493
494
|
*/
|
|
494
495
|
|
|
495
|
-
|
|
496
|
+
relationship?:{invoice_owner_id?:{is?:string,is_not?:string,starts_with?:string},parent_id?:{is?:string,is_not?:string,starts_with?:string},payment_owner_id?:{is?:string,is_not?:string,starts_with?:string}};
|
|
497
|
+
}
|
|
498
|
+
export interface SubscriptionsResponse {
|
|
499
|
+
export:Export;
|
|
500
|
+
}
|
|
501
|
+
export interface SubscriptionsInputParam {
|
|
496
502
|
|
|
497
503
|
/**
|
|
498
|
-
* @description
|
|
499
|
-
Payment owner of an invoice.
|
|
500
|
-
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
501
|
-
|
|
502
|
-
**Example →** *payment_owner\[is\] = "payment_customer"*
|
|
504
|
+
* @description Determines the format of the data. Returns the export type based on the selected value. \* data - Download your current data in CSV. \* import_friendly_data - Download import friendly data in CSV. This CSV can be used to perform [bulk operations](https://www.chargebee.com/docs/bulk-operations.html).
|
|
503
505
|
|
|
504
506
|
*/
|
|
505
507
|
|
|
506
|
-
|
|
508
|
+
export_type?:ExportType;
|
|
507
509
|
|
|
508
510
|
/**
|
|
509
511
|
* @description optional, string filter
|
|
@@ -538,44 +540,35 @@ Reason code for canceling the subscription. Must be one from a list of reason co
|
|
|
538
540
|
|
|
539
541
|
cancel_reason_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
540
542
|
|
|
541
|
-
/**
|
|
542
|
-
* @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.
|
|
543
|
-
The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.
|
|
544
|
-
**Note**
|
|
545
|
-
|
|
546
|
-
[Multiple Business Entities](/docs/api?prod_cat_ver=2#mbe) is a feature available only on Product Catalog 2.0.
|
|
547
|
-
|
|
548
|
-
*/
|
|
549
|
-
|
|
550
|
-
business_entity_id?:{is?:string,is_not?:string,starts_with?:string};
|
|
551
|
-
|
|
552
|
-
/**
|
|
553
|
-
* @description Parameters for invoice
|
|
554
|
-
|
|
555
|
-
*/
|
|
556
|
-
|
|
557
|
-
invoice?:{amount_adjusted?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_due?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_paid?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},credits_applied?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},date?:{after?:string,before?:string,between?:string,on?:string},dunning_status?:{in?:string,is?:'in_progress' | 'stopped' | 'success' | 'exhausted',is_not?:'in_progress' | 'stopped' | 'success' | 'exhausted',is_present?:'true' | 'false',not_in?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},paid_at?:{after?:string,before?:string,between?:string,on?:string},price_type?:{in?:string,is?:'tax_exclusive' | 'tax_inclusive',is_not?:'tax_exclusive' | 'tax_inclusive',not_in?:string},recurring?:{is?:'true' | 'false'},status?:{in?:string,is?:'pending' | 'paid' | 'voided' | 'not_paid' | 'posted' | 'payment_due',is_not?:'pending' | 'paid' | 'voided' | 'not_paid' | 'posted' | 'payment_due',not_in?:string},total?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
558
|
-
|
|
559
543
|
/**
|
|
560
544
|
* @description Parameters for subscription
|
|
561
545
|
|
|
562
546
|
*/
|
|
563
547
|
|
|
564
548
|
subscription?:{activated_at?:{after?:string,before?:string,between?:string,is_present?:'true' | 'false',on?:string},auto_close_invoices?:{is?:'true' | 'false'},cancel_reason?:{in?:string,is?:'tax_calculation_failed' | 'fraud_review_failed' | 'currency_incompatible_with_gateway' | 'non_compliant_eu_customer' | 'non_compliant_customer' | 'not_paid' | 'no_card',is_not?:'tax_calculation_failed' | 'fraud_review_failed' | 'currency_incompatible_with_gateway' | 'non_compliant_eu_customer' | 'non_compliant_customer' | 'not_paid' | 'no_card',is_present?:'true' | 'false',not_in?:string},cancelled_at?:{after?:string,before?:string,between?:string,on?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},created_at?:{after?:string,before?:string,between?:string,on?:string},customer_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},has_scheduled_changes?:{is?:'true' | 'false'},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},next_billing_at?:{after?:string,before?:string,between?:string,on?:string},offline_payment_method?:{in?:string,is?:'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash',is_not?:'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash',not_in?:string},remaining_billing_cycles?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,is_present?:'true' | 'false',lt?:string,lte?:string},status?:{in?:string,is?:'in_trial' | 'paused' | 'future' | 'active' | 'cancelled' | 'non_renewing',is_not?:'in_trial' | 'paused' | 'future' | 'active' | 'cancelled' | 'non_renewing',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
549
|
+
}
|
|
550
|
+
export interface InvoicesResponse {
|
|
551
|
+
export:Export;
|
|
552
|
+
}
|
|
553
|
+
export interface InvoicesInputParam {
|
|
565
554
|
|
|
566
555
|
/**
|
|
567
|
-
* @description
|
|
556
|
+
* @description optional, string filter
|
|
557
|
+
Payment owner of an invoice.
|
|
558
|
+
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
559
|
+
|
|
560
|
+
**Example →** *payment_owner\[is\] = "payment_customer"*
|
|
568
561
|
|
|
569
562
|
*/
|
|
570
563
|
|
|
571
|
-
|
|
564
|
+
payment_owner?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
572
565
|
|
|
573
566
|
/**
|
|
574
|
-
* @description Parameters for
|
|
567
|
+
* @description Parameters for invoice
|
|
575
568
|
|
|
576
569
|
*/
|
|
577
570
|
|
|
578
|
-
|
|
571
|
+
invoice?:{amount_adjusted?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_due?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_paid?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},credits_applied?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},customer_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},date?:{after?:string,before?:string,between?:string,on?:string},dunning_status?:{in?:string,is?:'in_progress' | 'stopped' | 'success' | 'exhausted',is_not?:'in_progress' | 'stopped' | 'success' | 'exhausted',is_present?:'true' | 'false',not_in?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},paid_at?:{after?:string,before?:string,between?:string,on?:string},price_type?:{in?:string,is?:'tax_exclusive' | 'tax_inclusive',is_not?:'tax_exclusive' | 'tax_inclusive',not_in?:string},recurring?:{is?:'true' | 'false'},status?:{in?:string,is?:'pending' | 'paid' | 'voided' | 'not_paid' | 'posted' | 'payment_due',is_not?:'pending' | 'paid' | 'voided' | 'not_paid' | 'posted' | 'payment_due',not_in?:string},subscription_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},total?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
579
572
|
}
|
|
580
573
|
export interface CreditNotesResponse {
|
|
581
574
|
export:Export;
|
|
@@ -589,28 +582,17 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
|
|
|
589
582
|
|
|
590
583
|
credit_note?:{amount_allocated?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_available?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_refunded?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},create_reason_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},customer_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},date?:{after?:string,before?:string,between?:string,on?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},price_type?:{in?:string,is?:'tax_exclusive' | 'tax_inclusive',is_not?:'tax_exclusive' | 'tax_inclusive',not_in?:string},reason_code?:{in?:string,is?:'other' | 'product_unsatisfactory' | 'subscription_pause' | 'order_cancellation' | 'service_unsatisfactory' | 'subscription_cancellation' | 'chargeback' | 'order_change' | 'write_off' | 'waiver' | 'subscription_change' | 'fraudulent',is_not?:'other' | 'product_unsatisfactory' | 'subscription_pause' | 'order_cancellation' | 'service_unsatisfactory' | 'subscription_cancellation' | 'chargeback' | 'order_change' | 'write_off' | 'waiver' | 'subscription_change' | 'fraudulent',not_in?:string},reference_invoice_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},status?:{in?:string,is?:'refund_due' | 'adjusted' | 'refunded' | 'voided',is_not?:'refund_due' | 'adjusted' | 'refunded' | 'voided',not_in?:string},subscription_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},total?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},type?:{in?:string,is?:'adjustment' | 'refundable',is_not?:'adjustment' | 'refundable',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string},voided_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
591
584
|
}
|
|
592
|
-
export interface
|
|
585
|
+
export interface TransactionsResponse {
|
|
593
586
|
export:Export;
|
|
594
587
|
}
|
|
595
|
-
export interface
|
|
596
|
-
|
|
597
|
-
/**
|
|
598
|
-
* @description optional, string filter
|
|
599
|
-
The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)) of the coupon. Applicable for *fixed_amount* coupons alone.
|
|
600
|
-
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
601
|
-
|
|
602
|
-
**Example →** *currency_code\[is\] = "USD"*
|
|
603
|
-
|
|
604
|
-
*/
|
|
605
|
-
|
|
606
|
-
currency_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
588
|
+
export interface TransactionsInputParam {
|
|
607
589
|
|
|
608
590
|
/**
|
|
609
|
-
* @description Parameters for
|
|
591
|
+
* @description Parameters for transaction
|
|
610
592
|
|
|
611
593
|
*/
|
|
612
594
|
|
|
613
|
-
|
|
595
|
+
transaction?:{amount?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_capturable?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},customer_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},date?:{after?:string,before?:string,between?:string,on?:string},gateway?:{in?:string,is?:'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'ebanx' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay' | 'pay_com',is_not?:'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'ebanx' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay' | 'pay_com',not_in?:string},gateway_account_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},id_at_gateway?:{is?:string,is_not?:string,starts_with?:string},payment_method?:{in?:string,is?:'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'chargeback' | 'wechat_pay' | 'pay_to' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'faster_payments' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card',is_not?:'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'chargeback' | 'wechat_pay' | 'pay_to' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'faster_payments' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card',not_in?:string},payment_source_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},reference_number?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},status?:{in?:string,is?:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention',is_not?:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention',not_in?:string},subscription_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},type?:{in?:string,is?:'authorization' | 'payment_reversal' | 'payment' | 'refund',is_not?:'authorization' | 'payment_reversal' | 'payment' | 'refund',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
614
596
|
}
|
|
615
597
|
export interface OrdersResponse {
|
|
616
598
|
export:Export;
|
|
@@ -635,6 +617,30 @@ Total amount charged for the order.
|
|
|
635
617
|
|
|
636
618
|
order?:{amount_paid?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},cancelled_at?:{after?:string,before?:string,between?:string,on?:string},customer_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},delivered_at?:{after?:string,before?:string,between?:string,on?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},is_resent?:{is?:'true' | 'false'},order_date?:{after?:string,before?:string,between?:string,on?:string},original_order_id?:{is?:string,is_not?:string,starts_with?:string},price_type?:{in?:string,is?:'tax_exclusive' | 'tax_inclusive',is_not?:'tax_exclusive' | 'tax_inclusive',not_in?:string},refundable_credits?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},refundable_credits_issued?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},resent_status?:{in?:string,is?:'fully_resent' | 'partially_resent',is_not?:'fully_resent' | 'partially_resent',not_in?:string},shipped_at?:{after?:string,before?:string,between?:string,on?:string},shipping_date?:{after?:string,before?:string,between?:string,on?:string},status?:{in?:string,is?:'new' | 'partially_delivered' | 'queued' | 'delivered' | 'on_hold' | 'shipped' | 'processing' | 'cancelled' | 'voided' | 'complete' | 'awaiting_shipment' | 'returned',is_not?:'new' | 'partially_delivered' | 'queued' | 'delivered' | 'on_hold' | 'shipped' | 'processing' | 'cancelled' | 'voided' | 'complete' | 'awaiting_shipment' | 'returned',not_in?:string},subscription_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
637
619
|
}
|
|
620
|
+
export interface ItemFamiliesResponse {
|
|
621
|
+
export:Export;
|
|
622
|
+
}
|
|
623
|
+
export interface ItemFamiliesInputParam {
|
|
624
|
+
|
|
625
|
+
/**
|
|
626
|
+
* @description Parameters for item_family
|
|
627
|
+
|
|
628
|
+
*/
|
|
629
|
+
|
|
630
|
+
item_family?:{id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},name?:{is?:string,is_not?:string,starts_with?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
631
|
+
}
|
|
632
|
+
export interface ItemsResponse {
|
|
633
|
+
export:Export;
|
|
634
|
+
}
|
|
635
|
+
export interface ItemsInputParam {
|
|
636
|
+
|
|
637
|
+
/**
|
|
638
|
+
* @description Parameters for item
|
|
639
|
+
|
|
640
|
+
*/
|
|
641
|
+
|
|
642
|
+
item?:{channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},enabled_for_checkout?:{is?:'true' | 'false'},enabled_in_portal?:{is?:'true' | 'false'},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},is_giftable?:{is?:'true' | 'false'},item_applicability?:{in?:string,is?:'all' | 'restricted',is_not?:'all' | 'restricted',not_in?:string},item_family_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},metered?:{is?:'true' | 'false'},name?:{is?:string,is_not?:string,starts_with?:string},status?:{in?:string,is?:'archived' | 'deleted' | 'active',is_not?:'archived' | 'deleted' | 'active',not_in?:string},type?:{in?:string,is?:'charge' | 'addon' | 'plan',is_not?:'charge' | 'addon' | 'plan',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string},usage_calculation?:{in?:string,is?:'max_usage' | 'sum_of_usages' | 'last_usage',is_not?:'max_usage' | 'sum_of_usages' | 'last_usage',not_in?:string}};
|
|
643
|
+
}
|
|
638
644
|
export interface ItemPricesResponse {
|
|
639
645
|
export:Export;
|
|
640
646
|
}
|
|
@@ -680,57 +686,51 @@ Filter item prices based on their `currency_code`.
|
|
|
680
686
|
|
|
681
687
|
item_price?:{channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},name?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},period?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},period_unit?:{in?:string,is?:'week' | 'month' | 'year' | 'day',is_not?:'week' | 'month' | 'year' | 'day',not_in?:string},pricing_model?:{in?:string,is?:'volume' | 'per_unit' | 'tiered' | 'flat_fee' | 'stairstep',is_not?:'volume' | 'per_unit' | 'tiered' | 'flat_fee' | 'stairstep',not_in?:string},status?:{in?:string,is?:'archived' | 'deleted' | 'active',is_not?:'archived' | 'deleted' | 'active',not_in?:string},trial_period?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},trial_period_unit?:{in?:string,is?:'month' | 'day',is_not?:'month' | 'day',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
682
688
|
}
|
|
683
|
-
export interface
|
|
689
|
+
export interface AttachedItemsResponse {
|
|
684
690
|
export:Export;
|
|
685
691
|
}
|
|
686
|
-
export interface
|
|
687
|
-
|
|
688
|
-
/**
|
|
689
|
-
* @description null
|
|
690
|
-
|
|
691
|
-
*/
|
|
692
|
-
|
|
693
|
-
export_type?:ExportType;
|
|
692
|
+
export interface AttachedItemsInputParam {
|
|
694
693
|
|
|
695
694
|
/**
|
|
696
|
-
* @description optional, string filter
|
|
697
|
-
|
|
698
|
-
**Supported operators :** is, is_not,
|
|
695
|
+
* @description optional, enumerated string filter
|
|
696
|
+
To filter based on the type of of the attached item. Possible values are : `addon`, `charge`. Possible values are : plan, addon, charge.
|
|
697
|
+
**Supported operators :** is, is_not, in, not_in
|
|
699
698
|
|
|
700
|
-
**Example →** *
|
|
699
|
+
**Example →** *item_type\[is_not\] = "plan"*
|
|
701
700
|
|
|
702
701
|
*/
|
|
703
702
|
|
|
704
|
-
|
|
703
|
+
item_type?:{in?:string,is?:'charge' | 'addon' | 'plan',is_not?:'charge' | 'addon' | 'plan',not_in?:string};
|
|
705
704
|
|
|
706
705
|
/**
|
|
707
|
-
* @description
|
|
708
|
-
The plan item price code.
|
|
709
|
-
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
710
|
-
|
|
711
|
-
**Example →** *item_price_id\[is\] = "silver-USD-monthly"*
|
|
706
|
+
* @description Parameters for attached_item
|
|
712
707
|
|
|
713
708
|
*/
|
|
714
709
|
|
|
715
|
-
|
|
710
|
+
attached_item?:{charge_on_event?:{in?:string,is?:'subscription_creation' | 'subscription_activation' | 'subscription_trial_start' | 'contract_termination' | 'plan_activation' | 'on_demand',is_not?:'subscription_creation' | 'subscription_activation' | 'subscription_trial_start' | 'contract_termination' | 'plan_activation' | 'on_demand',not_in?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},parent_item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},type?:{in?:string,is?:'optional' | 'mandatory' | 'recommended',is_not?:'optional' | 'mandatory' | 'recommended',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
|
|
711
|
+
}
|
|
712
|
+
export interface DifferentialPricesResponse {
|
|
713
|
+
export:Export;
|
|
714
|
+
}
|
|
715
|
+
export interface DifferentialPricesInputParam {
|
|
716
716
|
|
|
717
717
|
/**
|
|
718
718
|
* @description optional, string filter
|
|
719
|
-
|
|
719
|
+
Item Id of Addon / Charge item price for which differential pricing is applied to.
|
|
720
720
|
**Supported operators :** is, is_not, starts_with, in, not_in
|
|
721
721
|
|
|
722
|
-
**Example →** *
|
|
722
|
+
**Example →** *item_id\[is\] = "day-pass"*
|
|
723
723
|
|
|
724
724
|
*/
|
|
725
725
|
|
|
726
|
-
|
|
726
|
+
item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
|
|
727
727
|
|
|
728
728
|
/**
|
|
729
|
-
* @description Parameters for
|
|
729
|
+
* @description Parameters for differential_price
|
|
730
730
|
|
|
731
731
|
*/
|
|
732
732
|
|
|
733
|
-
|
|
733
|
+
differential_price?:{id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},item_price_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},parent_item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string}};
|
|
734
734
|
}
|
|
735
735
|
export interface Download {
|
|
736
736
|
/**
|
|
@@ -738,14 +738,14 @@ Reason code for canceling the subscription. Must be one from a list of reason co
|
|
|
738
738
|
|
|
739
739
|
*/
|
|
740
740
|
|
|
741
|
-
download_url
|
|
741
|
+
download_url:string;
|
|
742
742
|
|
|
743
743
|
/**
|
|
744
744
|
* @description The time until which the `download_url` is valid.
|
|
745
745
|
|
|
746
746
|
*/
|
|
747
747
|
|
|
748
|
-
valid_till
|
|
748
|
+
valid_till:number;
|
|
749
749
|
|
|
750
750
|
/**
|
|
751
751
|
* @description The [media type](https://en.wikipedia.org/wiki/Media_type) of the file.
|