chargebee 2.41.0 → 3.0.0-beta.2

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.
Files changed (118) hide show
  1. package/CHANGELOG.md +11 -15
  2. package/LICENSE +1 -1
  3. package/README.md +90 -170
  4. package/cjs/RequestWrapper.js +84 -0
  5. package/cjs/asyncApiSupport.js +39 -0
  6. package/cjs/chargebee.cjs.js +13 -0
  7. package/cjs/chargebee.cjs.worker.js +9 -0
  8. package/cjs/chargebeeError.js +17 -0
  9. package/cjs/coreCommon.js +72 -0
  10. package/cjs/createChargebee.js +92 -0
  11. package/cjs/environment.js +18 -0
  12. package/cjs/filter.js +1 -0
  13. package/cjs/net/ClientInterface.js +40 -0
  14. package/cjs/net/FetchClient.js +86 -0
  15. package/cjs/net/NodeClient.js +61 -0
  16. package/cjs/package.json +1 -0
  17. package/cjs/resources/api_endpoints.js +1086 -0
  18. package/cjs/util.js +218 -0
  19. package/esm/RequestWrapper.js +80 -0
  20. package/esm/asyncApiSupport.js +35 -0
  21. package/esm/chargebee.esm.js +9 -0
  22. package/esm/chargebee.esm.worker.js +5 -0
  23. package/esm/chargebeeError.js +13 -0
  24. package/esm/coreCommon.js +67 -0
  25. package/esm/createChargebee.js +88 -0
  26. package/esm/environment.js +15 -0
  27. package/esm/filter.js +1 -0
  28. package/esm/net/ClientInterface.js +35 -0
  29. package/esm/net/FetchClient.js +81 -0
  30. package/esm/net/NodeClient.js +56 -0
  31. package/esm/package.json +1 -0
  32. package/esm/resources/api_endpoints.js +1083 -0
  33. package/esm/util.js +202 -0
  34. package/package.json +69 -38
  35. package/types/core.d.ts +558 -89
  36. package/types/index.d.ts +90 -55
  37. package/types/resources/Address.d.ts +57 -272
  38. package/types/resources/AdvanceInvoiceSchedule.d.ts +21 -94
  39. package/types/resources/AttachedItem.d.ts +91 -329
  40. package/types/resources/Attribute.d.ts +5 -5
  41. package/types/resources/BusinessEntity.d.ts +49 -69
  42. package/types/resources/BusinessEntityTransfer.d.ts +11 -17
  43. package/types/resources/Card.d.ts +146 -424
  44. package/types/resources/Comment.d.ts +72 -189
  45. package/types/resources/Contact.d.ts +12 -64
  46. package/types/resources/ContractTerm.d.ts +15 -96
  47. package/types/resources/Coupon.d.ts +282 -758
  48. package/types/resources/CouponCode.d.ts +56 -52
  49. package/types/resources/CouponSet.d.ts +92 -234
  50. package/types/resources/CreditNote.d.ts +588 -1758
  51. package/types/resources/CreditNoteEstimate.d.ts +131 -157
  52. package/types/resources/Currency.d.ts +75 -62
  53. package/types/resources/Customer.d.ts +892 -835
  54. package/types/resources/CustomerEntitlement.d.ts +24 -35
  55. package/types/resources/DifferentialPrice.d.ts +116 -314
  56. package/types/resources/Discount.d.ts +20 -125
  57. package/types/resources/Download.d.ts +6 -22
  58. package/types/resources/Entitlement.d.ts +51 -160
  59. package/types/resources/EntitlementOverride.d.ts +58 -139
  60. package/types/resources/Estimate.d.ts +1178 -527
  61. package/types/resources/Event.d.ts +67 -178
  62. package/types/resources/Export.d.ts +563 -723
  63. package/types/resources/Feature.d.ts +117 -433
  64. package/types/resources/GatewayErrorDetail.d.ts +16 -72
  65. package/types/resources/Gift.d.ts +265 -432
  66. package/types/resources/Hierarchy.d.ts +8 -36
  67. package/types/resources/HostedPage.d.ts +1017 -1153
  68. package/types/resources/ImpactedItem.d.ts +13 -50
  69. package/types/resources/ImpactedItemPrice.d.ts +13 -15
  70. package/types/resources/ImpactedSubscription.d.ts +13 -45
  71. package/types/resources/InAppSubscription.d.ts +93 -389
  72. package/types/resources/Installment.d.ts +35 -110
  73. package/types/resources/InstallmentConfig.d.ts +54 -155
  74. package/types/resources/InstallmentDetail.d.ts +19 -27
  75. package/types/resources/Invoice.d.ts +1574 -3157
  76. package/types/resources/InvoiceEstimate.d.ts +131 -161
  77. package/types/resources/Item.d.ts +133 -611
  78. package/types/resources/ItemEntitlement.d.ts +78 -215
  79. package/types/resources/ItemFamily.d.ts +69 -178
  80. package/types/resources/ItemPrice.d.ts +291 -1203
  81. package/types/resources/Metadata.d.ts +3 -5
  82. package/types/resources/Order.d.ts +538 -1471
  83. package/types/resources/PaymentIntent.d.ts +163 -347
  84. package/types/resources/PaymentReferenceNumber.d.ts +7 -29
  85. package/types/resources/PaymentSource.d.ts +476 -1272
  86. package/types/resources/PaymentVoucher.d.ts +87 -306
  87. package/types/resources/PortalSession.d.ts +71 -207
  88. package/types/resources/PriceVariant.d.ts +91 -279
  89. package/types/resources/PricingPageSession.d.ts +92 -41
  90. package/types/resources/PromotionalCredit.d.ts +90 -346
  91. package/types/resources/Purchase.d.ts +185 -315
  92. package/types/resources/Quote.d.ts +1406 -887
  93. package/types/resources/QuoteLineGroup.d.ts +125 -452
  94. package/types/resources/QuotedCharge.d.ts +45 -274
  95. package/types/resources/QuotedSubscription.d.ts +100 -488
  96. package/types/resources/Ramp.d.ts +230 -747
  97. package/types/resources/ResourceMigration.d.ts +25 -80
  98. package/types/resources/SiteMigrationDetail.d.ts +34 -112
  99. package/types/resources/Subscription.d.ts +2390 -4336
  100. package/types/resources/SubscriptionEntitlement.d.ts +59 -160
  101. package/types/resources/SubscriptionEstimate.d.ts +51 -75
  102. package/types/resources/TaxWithheld.d.ts +15 -40
  103. package/types/resources/ThirdPartyPaymentMethod.d.ts +7 -29
  104. package/types/resources/TimeMachine.d.ts +43 -97
  105. package/types/resources/Token.d.ts +15 -85
  106. package/types/resources/Transaction.d.ts +276 -911
  107. package/types/resources/UnbilledCharge.d.ts +189 -164
  108. package/types/resources/Usage.d.ts +89 -279
  109. package/types/resources/VirtualBankAccount.d.ts +103 -255
  110. package/types/resources/filter.d.ts +52 -0
  111. package/.github/ISSUE_TEMPLATE/bug_report.yml +0 -81
  112. package/.github/ISSUE_TEMPLATE/config.yml +0 -6
  113. package/.github/ISSUE_TEMPLATE/feature_request.yml +0 -34
  114. package/.github/PULL_REQUEST_TEMPLATE.md +0 -8
  115. package/lib/chargebee.js +0 -512
  116. package/lib/resources/api_endpoints.js +0 -2935
  117. package/types/resources/NonSubscription.d.ts +0 -30
  118. package/types/resources/Session.d.ts +0 -41
@@ -1,767 +1,607 @@
1
1
  ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
3
+
2
4
  declare module 'chargebee' {
3
5
  export interface Export {
4
-
5
- /**
6
- * @description A unique identifier to identify the export
7
-
8
- */
9
-
10
- id:string;
11
-
12
- /**
13
- * @description Describes the type of export
14
-
15
- */
16
-
17
- operation_type:string;
18
-
19
- /**
20
- * @description Describes the mime type of download file \* pdf - PDF \* zip - ZIP
21
-
22
- */
23
-
24
- mime_type:'zip' | 'pdf';
25
-
26
- /**
27
- * @description Current status of the export operation \* completed - Completed \* failed - Failed \* in_process - In Process
28
-
29
- */
30
-
31
- status:'in_process' | 'completed' | 'failed';
32
-
33
- /**
34
- * @description Export created time
35
-
36
- */
37
-
38
- created_at:number;
39
-
40
- /**
41
- * @description Returns the download_url for the export. The download URL is valid upto a specific date.
42
-
43
- */
44
-
45
- download?:Export.Download;
6
+ id: string;
7
+ operation_type: string;
8
+ mime_type: 'pdf' | 'zip';
9
+ status: 'in_process' | 'completed' | 'failed';
10
+ created_at: number;
11
+ download?: Export.Download;
46
12
  }
13
+
47
14
  export namespace Export {
48
- export class ExportResource {
49
- /**
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&#x27;s shared.
51
-
52
- **Note:** In case the export is in Failed or In-process state, then the downloads resource will not be available.
53
-
54
- */
55
-
56
- retrieve(export_id:string):ChargebeeRequest<RetrieveResponse>;
57
-
58
- /**
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.
62
-
63
- */
64
-
65
- revenue_recognition(input:RevenueRecognitionInputParam):ChargebeeRequest<RevenueRecognitionResponse>;
66
-
67
- /**
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.
71
-
72
- */
73
-
74
- deferred_revenue(input:DeferredRevenueInputParam):ChargebeeRequest<DeferredRevenueResponse>;
75
-
76
- /**
77
- * @description This API triggers export of coupon data. The exported zip file contains CSV files with coupon-related data.
78
-
79
- */
80
-
81
- coupons(input?:CouponsInputParam):ChargebeeRequest<CouponsResponse>;
82
-
83
- /**
84
- * @description This API triggers export of customer data. The exported zip file contains CSV files with customer-related data.
85
-
86
- */
87
-
88
- customers(input?:CustomersInputParam):ChargebeeRequest<CustomersResponse>;
89
-
90
- /**
91
- * @description This API triggers export of subscription data. The exported zip file contains CSV files with subscription-related data.
92
-
93
- */
94
-
95
- subscriptions(input?:SubscriptionsInputParam):ChargebeeRequest<SubscriptionsResponse>;
96
-
97
- /**
98
- * @description This API triggers export of invoice data. The exported zip file contains CSV files with invoice-related data.
99
-
100
- */
101
-
102
- invoices(input?:InvoicesInputParam):ChargebeeRequest<InvoicesResponse>;
103
-
104
- /**
105
- * @description This API triggers export of credit note data. The exported zip file contains CSV files with credit note-related data.
106
-
107
- */
108
-
109
- credit_notes(input?:CreditNotesInputParam):ChargebeeRequest<CreditNotesResponse>;
110
-
111
- /**
112
- * @description This API triggers export of transaction data. The exported zip file contains CSV files with transaction-related data.
113
-
114
- */
115
-
116
- transactions(input?:TransactionsInputParam):ChargebeeRequest<TransactionsResponse>;
117
-
118
- /**
119
- * @description This API triggers export of order data. The exported zip file contains CSV files with order-related data.
120
-
121
- */
122
-
123
- orders(input?:OrdersInputParam):ChargebeeRequest<OrdersResponse>;
124
-
125
- /**
126
- * @description This API triggers export of item family data. The exported zip file contains CSV files with item family-related data.
127
-
128
- */
129
-
130
- item_families(input?:ItemFamiliesInputParam):ChargebeeRequest<ItemFamiliesResponse>;
131
-
132
- /**
133
- * @description This API triggers export of item data. The exported zip file contains CSV files with item-related data.
134
-
135
- */
136
-
137
- items(input?:ItemsInputParam):ChargebeeRequest<ItemsResponse>;
138
-
139
- /**
140
- * @description This API triggers export of item price data. The exported zip file contains CSV files with item price-related data.
141
-
142
- */
143
-
144
- item_prices(input?:ItemPricesInputParam):ChargebeeRequest<ItemPricesResponse>;
145
-
146
- /**
147
- * @description This API triggers export of attached item data. The exported zip file contains CSV files with attached item-related data.
148
-
149
- */
150
-
151
- attached_items(input?:AttachedItemsInputParam):ChargebeeRequest<AttachedItemsResponse>;
152
-
153
- /**
154
- * @description This API triggers export of differential price data. The exported zip file contains CSV files with differential price-related data.
155
-
156
- */
157
-
158
- differential_prices(input?:DifferentialPricesInputParam):ChargebeeRequest<DifferentialPricesResponse>;
159
-
160
- price_variants(input?:PriceVariantsInputParam):ChargebeeRequest<PriceVariantsResponse>;
161
- }
162
- export interface RetrieveResponse {
163
- export:Export;
164
- }
165
-
166
- export interface RevenueRecognitionResponse {
167
- export:Export;
168
- }
169
- export interface RevenueRecognitionInputParam {
170
-
171
- /**
172
- * @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
173
-
174
- */
175
-
176
- report_by:ReportBy;
177
-
178
- /**
179
- * @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.
180
-
181
- */
182
-
183
- currency_code?:string;
184
-
185
- /**
186
- * @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.
187
-
188
- */
189
-
190
- report_from_month:number;
191
-
192
- /**
193
- * @description Obtains report data from the specified year, combined with the value specified for report_from_month.
194
-
195
- */
196
-
197
- report_from_year:number;
198
-
199
- /**
200
- * @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.
201
-
202
- */
203
-
204
- report_to_month:number;
205
-
206
- /**
207
- * @description Obtains report data until the specified year, combined with the value specified for report_to_month.
208
-
209
- */
210
-
211
- report_to_year:number;
212
-
213
- /**
214
- * @description Returns amount with discount in the report. If value specified is false, it returns amount without discount.
215
-
216
- */
217
-
218
- include_discounts?:boolean;
219
-
220
- /**
221
- * @description optional, string filter
222
- Payment owner of an invoice.
223
- **Supported operators :** is, is_not, starts_with, in, not_in
224
-
225
- **Example →** *payment_owner\[is\] &#x3D; &quot;payment_customer&quot;*
226
-
227
- */
228
-
229
- payment_owner?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
230
-
231
- /**
232
- * @description optional, string filter
233
- The plan item code.
234
- **Supported operators :** is, is_not, starts_with, in, not_in
235
-
236
- **Example →** *item_id\[is\] &#x3D; &quot;silver&quot;*
237
-
238
- */
239
-
240
- item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
241
-
242
- /**
243
- * @description optional, string filter
244
- The plan item price code.
245
- **Supported operators :** is, is_not, starts_with, in, not_in
246
-
247
- **Example →** *item_price_id\[is\] &#x3D; &quot;silver-USD-monthly&quot;*
248
-
249
- */
250
-
251
- item_price_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
252
-
253
- /**
254
- * @description optional, string filter
255
- Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in **Settings \&gt; Configure Chargebee \&gt; Reason Codes \&gt; Subscriptions \&gt; Subscription Cancellation** . Must be passed if set as mandatory in the app. The codes are case-sensitive.
256
- **Supported operators :** is, is_not, starts_with, in, not_in
257
-
258
- **Example →** *cancel_reason_code\[is\] &#x3D; &quot;Not Paid&quot;*
259
-
260
- */
261
-
262
- cancel_reason_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
263
-
264
- /**
265
- * @description optional, string filter
266
- The unique ID of the [business entity](/docs/api?prod_cat_ver&#x3D;2#mbe) of this subscription. This is always the same as the [business entity](/docs/api/subscriptions?prod_cat_ver&#x3D;2#subscription_customer_id) of the customer.
267
- **Supported operators :** is, is_not, starts_with
268
-
269
- **Example →** *business_entity_id\[is_not\] &#x3D; &quot;business_entity_id&quot;*
270
-
271
- */
272
-
273
- business_entity_id?:{is?:string,is_not?:string,starts_with?:string};
274
-
275
- /**
276
- * @description Parameters for invoice
277
-
278
- */
279
-
280
- 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}};
281
-
282
- /**
283
- * @description Parameters for subscription
284
-
285
- */
286
-
287
- 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?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit' | 'cash',is_not?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | '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' | 'transferred' | 'future' | 'active' | 'cancelled' | 'non_renewing',is_not?:'in_trial' | 'paused' | 'transferred' | 'future' | 'active' | 'cancelled' | 'non_renewing',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
288
-
289
- /**
290
- * @description Parameters for customer
291
-
292
- */
293
-
294
- 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?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit' | 'cash',is_not?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | '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}};
295
-
296
- /**
297
- * @description Parameters for relationship
298
-
299
- */
300
-
301
- 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}};
302
- }
303
- export interface DeferredRevenueResponse {
304
- export:Export;
15
+ export class ExportResource {
16
+ retrieve(
17
+ export_id: string,
18
+ headers?: ChargebeeRequestHeader,
19
+ ): Promise<ChargebeeResponse<RetrieveResponse>>;
20
+
21
+ revenueRecognition(
22
+ input: RevenueRecognitionInputParam,
23
+ headers?: ChargebeeRequestHeader,
24
+ ): Promise<ChargebeeResponse<RevenueRecognitionResponse>>;
25
+
26
+ deferredRevenue(
27
+ input: DeferredRevenueInputParam,
28
+ headers?: ChargebeeRequestHeader,
29
+ ): Promise<ChargebeeResponse<DeferredRevenueResponse>>;
30
+
31
+ plans(
32
+ input?: PlansInputParam,
33
+ headers?: ChargebeeRequestHeader,
34
+ ): Promise<ChargebeeResponse<PlansResponse>>;
35
+
36
+ addons(
37
+ input?: AddonsInputParam,
38
+ headers?: ChargebeeRequestHeader,
39
+ ): Promise<ChargebeeResponse<AddonsResponse>>;
40
+
41
+ coupons(
42
+ input?: CouponsInputParam,
43
+ headers?: ChargebeeRequestHeader,
44
+ ): Promise<ChargebeeResponse<CouponsResponse>>;
45
+
46
+ customers(
47
+ input?: CustomersInputParam,
48
+ headers?: ChargebeeRequestHeader,
49
+ ): Promise<ChargebeeResponse<CustomersResponse>>;
50
+
51
+ subscriptions(
52
+ input?: SubscriptionsInputParam,
53
+ headers?: ChargebeeRequestHeader,
54
+ ): Promise<ChargebeeResponse<SubscriptionsResponse>>;
55
+
56
+ invoices(
57
+ input?: InvoicesInputParam,
58
+ headers?: ChargebeeRequestHeader,
59
+ ): Promise<ChargebeeResponse<InvoicesResponse>>;
60
+
61
+ creditNotes(
62
+ input?: CreditNotesInputParam,
63
+ headers?: ChargebeeRequestHeader,
64
+ ): Promise<ChargebeeResponse<CreditNotesResponse>>;
65
+
66
+ transactions(
67
+ input?: TransactionsInputParam,
68
+ headers?: ChargebeeRequestHeader,
69
+ ): Promise<ChargebeeResponse<TransactionsResponse>>;
70
+
71
+ orders(
72
+ input?: OrdersInputParam,
73
+ headers?: ChargebeeRequestHeader,
74
+ ): Promise<ChargebeeResponse<OrdersResponse>>;
75
+
76
+ itemFamilies(
77
+ input?: ItemFamiliesInputParam,
78
+ headers?: ChargebeeRequestHeader,
79
+ ): Promise<ChargebeeResponse<ItemFamiliesResponse>>;
80
+
81
+ items(
82
+ input?: ItemsInputParam,
83
+ headers?: ChargebeeRequestHeader,
84
+ ): Promise<ChargebeeResponse<ItemsResponse>>;
85
+
86
+ itemPrices(
87
+ input?: ItemPricesInputParam,
88
+ headers?: ChargebeeRequestHeader,
89
+ ): Promise<ChargebeeResponse<ItemPricesResponse>>;
90
+
91
+ attachedItems(
92
+ input?: AttachedItemsInputParam,
93
+ headers?: ChargebeeRequestHeader,
94
+ ): Promise<ChargebeeResponse<AttachedItemsResponse>>;
95
+
96
+ differentialPrices(
97
+ input?: DifferentialPricesInputParam,
98
+ headers?: ChargebeeRequestHeader,
99
+ ): Promise<ChargebeeResponse<DifferentialPricesResponse>>;
100
+
101
+ priceVariants(
102
+ input?: PriceVariantsInputParam,
103
+ headers?: ChargebeeRequestHeader,
104
+ ): Promise<ChargebeeResponse<PriceVariantsResponse>>;
305
105
  }
306
- export interface DeferredRevenueInputParam {
307
-
308
- /**
309
- * @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
310
-
311
- */
312
-
313
- report_by:ReportBy;
314
-
315
- /**
316
- * @description Value must be in ISO 4217 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.
317
-
318
- */
319
-
320
- currency_code?:string;
321
-
322
- /**
323
- * @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.
324
-
325
- */
326
-
327
- report_from_month:number;
328
-
329
- /**
330
- * @description Obtains report data from the specified year, combined with the value specified for report_from_month.
331
-
332
- */
333
-
334
- report_from_year:number;
335
-
336
- /**
337
- * @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.
338
-
339
- */
340
-
341
- report_to_month:number;
342
-
343
- /**
344
- * @description Obtains report data until the specified year, combined with the value specified for report_to_month.
345
-
346
- */
347
-
348
- report_to_year:number;
349
-
350
- /**
351
- * @description Returns amount with discount in the report. If value specified is false, it returns amount without discount.
352
-
353
- */
354
-
355
- include_discounts?:boolean;
356
-
357
- /**
358
- * @description optional, string filter
359
- Payment owner of an invoice.
360
- **Supported operators :** is, is_not, starts_with, in, not_in
361
-
362
- **Example →** *payment_owner\[is\] &#x3D; &quot;payment_customer&quot;*
363
-
364
- */
365
-
366
- payment_owner?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
367
-
368
- /**
369
- * @description optional, string filter
370
- The plan item code.
371
- **Supported operators :** is, is_not, starts_with, in, not_in
372
-
373
- **Example →** *item_id\[is\] &#x3D; &quot;silver&quot;*
374
-
375
- */
376
-
377
- item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
378
-
379
- /**
380
- * @description optional, string filter
381
- The plan item price code.
382
- **Supported operators :** is, is_not, starts_with, in, not_in
383
-
384
- **Example →** *item_price_id\[is\] &#x3D; &quot;silver-USD-monthly&quot;*
385
-
386
- */
387
-
388
- item_price_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
389
-
390
- /**
391
- * @description optional, string filter
392
- Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in **Settings \&gt; Configure Chargebee \&gt; Reason Codes \&gt; Subscriptions \&gt; Subscription Cancellation** . Must be passed if set as mandatory in the app. The codes are case-sensitive.
393
- **Supported operators :** is, is_not, starts_with, in, not_in
394
-
395
- **Example →** *cancel_reason_code\[is\] &#x3D; &quot;Not Paid&quot;*
396
-
397
- */
398
-
399
- cancel_reason_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
400
-
401
- /**
402
- * @description optional, string filter
403
- The unique ID of the [business entity](/docs/api?prod_cat_ver&#x3D;2#mbe) of this subscription. This is always the same as the [business entity](/docs/api/subscriptions?prod_cat_ver&#x3D;2#subscription_customer_id) of the customer.
404
- **Supported operators :** is, is_not, starts_with
405
-
406
- **Example →** *business_entity_id\[is_not\] &#x3D; &quot;business_entity_id&quot;*
407
-
408
- */
409
-
410
- business_entity_id?:{is?:string,is_not?:string,starts_with?:string};
411
-
412
- /**
413
- * @description Parameters for invoice
414
-
415
- */
416
-
417
- 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}};
418
-
419
- /**
420
- * @description Parameters for subscription
421
-
422
- */
423
-
424
- 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?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit' | 'cash',is_not?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | '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' | 'transferred' | 'future' | 'active' | 'cancelled' | 'non_renewing',is_not?:'in_trial' | 'paused' | 'transferred' | 'future' | 'active' | 'cancelled' | 'non_renewing',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
425
-
426
- /**
427
- * @description Parameters for customer
428
-
429
- */
430
-
431
- 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?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit' | 'cash',is_not?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | '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}};
432
-
433
- /**
434
- * @description Parameters for relationship
435
-
436
- */
437
-
438
- 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}};
439
- }
440
- export interface CouponsResponse {
441
- export:Export;
106
+
107
+ export interface RetrieveResponse {
108
+ export: Export;
442
109
  }
443
- export interface CouponsInputParam {
444
-
445
- /**
446
- * @description optional, string filter
447
- The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)) of the coupon. Applicable for *fixed_amount* coupons alone.
448
- **Supported operators :** is, is_not, starts_with, in, not_in
449
110
 
450
- **Example →** *currency_code\[is\] &#x3D; &quot;USD&quot;*
111
+ export interface RevenueRecognitionResponse {
112
+ export: Export;
113
+ }
451
114
 
452
- */
453
-
454
- currency_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
455
-
456
- /**
457
- * @description Parameters for coupon
115
+ export interface DeferredRevenueResponse {
116
+ export: Export;
117
+ }
458
118
 
459
- */
460
-
461
- 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}};
119
+ export interface PlansResponse {
120
+ export: Export;
462
121
  }
463
- export interface CustomersResponse {
464
- export:Export;
122
+
123
+ export interface AddonsResponse {
124
+ export: Export;
465
125
  }
466
- export interface CustomersInputParam {
467
-
468
- /**
469
- * @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).
470
-
471
- */
472
-
473
- export_type?:ExportType;
474
-
475
- /**
476
- * @description optional, string filter
477
- The unique ID of the [business entity](/docs/api?prod_cat_ver&#x3D;2#mbe) of this subscription. This is always the same as the [business entity](/docs/api/subscriptions?prod_cat_ver&#x3D;2#subscription_customer_id) of the customer.
478
- **Supported operators :** is, is_not, starts_with
479
-
480
- **Example →** *business_entity_id\[is\] &#x3D; &quot;business_entity_id&quot;*
481
-
482
- */
483
-
484
- business_entity_id?:{is?:string,is_not?:string,starts_with?:string};
485
-
486
- /**
487
- * @description Parameters for customer
488
-
489
- */
490
-
491
- 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?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit' | 'cash',is_not?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | '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}};
492
-
493
- /**
494
- * @description Parameters for relationship
495
-
496
- */
497
-
498
- 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}};
499
- }
500
- export interface SubscriptionsResponse {
501
- export:Export;
126
+
127
+ export interface CouponsResponse {
128
+ export: Export;
502
129
  }
503
- export interface SubscriptionsInputParam {
504
-
505
- /**
506
- * @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).
507
-
508
- */
509
-
510
- export_type?:ExportType;
511
-
512
- /**
513
- * @description optional, string filter
514
- The plan item code.
515
- **Supported operators :** is, is_not, starts_with, in, not_in
516
-
517
- **Example →** *item_id\[is\] &#x3D; &quot;silver&quot;*
518
-
519
- */
520
-
521
- item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
522
-
523
- /**
524
- * @description optional, string filter
525
- The plan item price code.
526
- **Supported operators :** is, is_not, starts_with, in, not_in
527
-
528
- **Example →** *item_price_id\[is\] &#x3D; &quot;silver-USD-monthly&quot;*
529
-
530
- */
531
-
532
- item_price_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
533
-
534
- /**
535
- * @description optional, string filter
536
- Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in **Settings \&gt; Configure Chargebee \&gt; Reason Codes \&gt; Subscriptions \&gt; Subscription Cancellation** . Must be passed if set as mandatory in the app. The codes are case-sensitive.
537
- **Supported operators :** is, is_not, starts_with, in, not_in
538
-
539
- **Example →** *cancel_reason_code\[is\] &#x3D; &quot;Not Paid&quot;*
540
-
541
- */
542
-
543
- cancel_reason_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
544
-
545
- /**
546
- * @description Parameters for subscription
547
-
548
- */
549
-
550
- 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?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit' | 'cash',is_not?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | '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' | 'transferred' | 'future' | 'active' | 'cancelled' | 'non_renewing',is_not?:'in_trial' | 'paused' | 'transferred' | 'future' | 'active' | 'cancelled' | 'non_renewing',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
551
- }
552
- export interface InvoicesResponse {
553
- export:Export;
130
+
131
+ export interface CustomersResponse {
132
+ export: Export;
554
133
  }
555
- export interface InvoicesInputParam {
556
-
557
- /**
558
- * @description optional, string filter
559
- Payment owner of an invoice.
560
- **Supported operators :** is, is_not, starts_with, in, not_in
561
134
 
562
- **Example →** *payment_owner\[is\] &#x3D; &quot;payment_customer&quot;*
135
+ export interface SubscriptionsResponse {
136
+ export: Export;
137
+ }
563
138
 
564
- */
565
-
566
- payment_owner?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
567
-
568
- /**
569
- * @description Parameters for invoice
139
+ export interface InvoicesResponse {
140
+ export: Export;
141
+ }
570
142
 
571
- */
572
-
573
- 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}};
143
+ export interface CreditNotesResponse {
144
+ export: Export;
574
145
  }
575
- export interface CreditNotesResponse {
576
- export:Export;
146
+
147
+ export interface TransactionsResponse {
148
+ export: Export;
577
149
  }
578
- export interface CreditNotesInputParam {
579
-
580
- /**
581
- * @description Parameters for credit_note
582
150
 
583
- */
584
-
585
- 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}};
151
+ export interface OrdersResponse {
152
+ export: Export;
586
153
  }
587
- export interface TransactionsResponse {
588
- export:Export;
154
+
155
+ export interface ItemFamiliesResponse {
156
+ export: Export;
589
157
  }
590
- export interface TransactionsInputParam {
591
-
592
- /**
593
- * @description Parameters for transaction
594
158
 
595
- */
596
-
597
- 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' | 'dlocal' | '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' | 'dlocal' | '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' | 'klarna_pay_now' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'automated_bank_transfer' | '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' | 'automated_bank_transfer' | '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}};
159
+ export interface ItemsResponse {
160
+ export: Export;
598
161
  }
599
- export interface OrdersResponse {
600
- export:Export;
162
+
163
+ export interface ItemPricesResponse {
164
+ export: Export;
601
165
  }
602
- export interface OrdersInputParam {
603
-
604
- /**
605
- * @description optional, in cents filter
606
- Total amount charged for the order.
607
- **Supported operators :** is, is_not, lt, lte, gt, gte, between
608
166
 
609
- **Example →** *total\[is\] &#x3D; &quot;1394532759&quot;*
167
+ export interface AttachedItemsResponse {
168
+ export: Export;
169
+ }
610
170
 
611
- */
612
-
613
- total?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
614
-
615
- /**
616
- * @description Parameters for order
171
+ export interface DifferentialPricesResponse {
172
+ export: Export;
173
+ }
617
174
 
618
- */
619
-
620
- 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}};
175
+ export interface PriceVariantsResponse {
176
+ export: Export;
621
177
  }
622
- export interface ItemFamiliesResponse {
623
- export:Export;
178
+
179
+ export interface Download {
180
+ download_url: string;
181
+ valid_till: number;
182
+ mime_type?: string;
624
183
  }
625
- export interface ItemFamiliesInputParam {
626
-
627
- /**
628
- * @description Parameters for item_family
184
+ // REQUEST PARAMS
185
+ //---------------
629
186
 
630
- */
631
-
632
- 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}};
187
+ export interface RevenueRecognitionInputParam {
188
+ report_by: ReportBy;
189
+ currency_code?: string;
190
+ report_from_month: number;
191
+ report_from_year: number;
192
+ report_to_month: number;
193
+ report_to_year: number;
194
+ include_discounts?: boolean;
195
+ payment_owner?: filter.String;
196
+ item_id?: filter.String;
197
+ item_price_id?: filter.String;
198
+ cancel_reason_code?: filter.String;
199
+ business_entity_id?: filter.String;
200
+ invoice?: InvoiceRevenueRecognitionInputParam;
201
+ subscription?: SubscriptionRevenueRecognitionInputParam;
202
+ customer?: CustomerRevenueRecognitionInputParam;
203
+ relationship?: RelationshipRevenueRecognitionInputParam;
204
+ }
205
+ export interface DeferredRevenueInputParam {
206
+ report_by: ReportBy;
207
+ currency_code?: string;
208
+ report_from_month: number;
209
+ report_from_year: number;
210
+ report_to_month: number;
211
+ report_to_year: number;
212
+ include_discounts?: boolean;
213
+ payment_owner?: filter.String;
214
+ item_id?: filter.String;
215
+ item_price_id?: filter.String;
216
+ cancel_reason_code?: filter.String;
217
+ business_entity_id?: filter.String;
218
+ invoice?: InvoiceDeferredRevenueInputParam;
219
+ subscription?: SubscriptionDeferredRevenueInputParam;
220
+ customer?: CustomerDeferredRevenueInputParam;
221
+ relationship?: RelationshipDeferredRevenueInputParam;
222
+ }
223
+ export interface PlansInputParam {
224
+ currency_code?: filter.String;
225
+ plan?: PlanPlansInputParam;
226
+ }
227
+ export interface AddonsInputParam {
228
+ currency_code?: filter.String;
229
+ addon?: AddonAddonsInputParam;
633
230
  }
634
- export interface ItemsResponse {
635
- export:Export;
231
+ export interface CouponsInputParam {
232
+ currency_code?: filter.String;
233
+ coupon?: CouponCouponsInputParam;
636
234
  }
637
- export interface ItemsInputParam {
638
-
639
- /**
640
- * @description Parameters for item
641
-
642
- */
643
-
644
- 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}};
235
+ export interface CustomersInputParam {
236
+ export_type?: ExportType;
237
+ business_entity_id?: filter.String;
238
+ customer?: CustomerCustomersInputParam;
239
+ relationship?: RelationshipCustomersInputParam;
645
240
  }
646
- export interface ItemPricesResponse {
647
- export:Export;
241
+ export interface SubscriptionsInputParam {
242
+ export_type?: ExportType;
243
+ item_id?: filter.String;
244
+ item_price_id?: filter.String;
245
+ cancel_reason_code?: filter.String;
246
+ subscription?: SubscriptionSubscriptionsInputParam;
247
+ }
248
+ export interface InvoicesInputParam {
249
+ payment_owner?: filter.String;
250
+ invoice?: InvoiceInvoicesInputParam;
251
+ }
252
+ export interface CreditNotesInputParam {
253
+ credit_note?: CreditNoteCreditNotesInputParam;
254
+ }
255
+ export interface TransactionsInputParam {
256
+ transaction?: TransactionTransactionsInputParam;
257
+ }
258
+ export interface OrdersInputParam {
259
+ total?: filter.Number;
260
+ order?: OrderOrdersInputParam;
261
+ }
262
+ export interface ItemFamiliesInputParam {
263
+ item_family?: ItemFamilyItemFamiliesInputParam;
264
+ }
265
+ export interface ItemsInputParam {
266
+ item?: ItemItemsInputParam;
648
267
  }
649
268
  export interface ItemPricesInputParam {
650
-
651
- /**
652
- * @description optional, string filter
653
- Filter item prices based on &#x60;item_family_id&#x60;.
654
- **Supported operators :** is, is_not, starts_with, in, not_in
655
-
656
- **Example →** *item_family_id\[is\] &#x3D; &quot;Acme&quot;*
657
-
658
- */
659
-
660
- item_family_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
661
-
662
- /**
663
- * @description optional, enumerated string filter
664
- Filter item prices based on &#x60;item_type&#x60;. Possible values are : plan, addon, charge.
665
- **Supported operators :** is, is_not, in, not_in
666
-
667
- **Example →** *item_type\[is_not\] &#x3D; &quot;plan&quot;*
668
-
669
- */
670
-
671
- item_type?:{in?:string,is?:'charge' | 'addon' | 'plan',is_not?:'charge' | 'addon' | 'plan',not_in?:string};
672
-
673
- /**
674
- * @description optional, string filter
675
- Filter item prices based on their &#x60;currency_code&#x60;.
676
- **Supported operators :** is, is_not, starts_with, in, not_in
677
-
678
- **Example →** *currency_code\[is\] &#x3D; &quot;USD&quot;*
679
-
680
- */
681
-
682
- currency_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
683
-
684
- /**
685
- * @description Parameters for item_price
686
-
687
- */
688
-
689
- 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}};
690
- }
691
- export interface AttachedItemsResponse {
692
- export:Export;
269
+ item_family_id?: filter.String;
270
+ item_type?: filter.Enum;
271
+ currency_code?: filter.String;
272
+ item_price?: ItemPriceItemPricesInputParam;
693
273
  }
694
274
  export interface AttachedItemsInputParam {
695
-
696
- /**
697
- * @description optional, enumerated string filter
698
- To filter based on the type of of the attached item. Possible values are : &#x60;addon&#x60;, &#x60;charge&#x60;. Possible values are : plan, addon, charge.
699
- **Supported operators :** is, is_not, in, not_in
700
-
701
- **Example →** *item_type\[is_not\] &#x3D; &quot;plan&quot;*
702
-
703
- */
704
-
705
- item_type?:{in?:string,is?:'charge' | 'addon' | 'plan',is_not?:'charge' | 'addon' | 'plan',not_in?:string};
706
-
707
- /**
708
- * @description Parameters for attached_item
709
-
710
- */
711
-
712
- 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}};
713
- }
714
- export interface DifferentialPricesResponse {
715
- export:Export;
275
+ item_type?: filter.Enum;
276
+ attached_item?: AttachedItemAttachedItemsInputParam;
716
277
  }
717
278
  export interface DifferentialPricesInputParam {
718
-
719
- /**
720
- * @description optional, string filter
721
- Item Id of Addon / Charge item price for which differential pricing is applied to.
722
- **Supported operators :** is, is_not, starts_with, in, not_in
723
-
724
- **Example →** *item_id\[is\] &#x3D; &quot;day-pass&quot;*
725
-
726
- */
727
-
728
- item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
729
-
730
- /**
731
- * @description Parameters for differential_price
732
-
733
- */
734
-
735
- 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}};
736
- }
737
- export interface PriceVariantsResponse {
738
- export:Export;
279
+ differential_price?: DifferentialPriceDifferentialPricesInputParam;
280
+ item_id?: filter.String;
739
281
  }
740
282
  export interface PriceVariantsInputParam {
741
-
742
- price_variant?:{created_at?:{after?:string,before?:string,between?:string,on?: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?:'active' | 'archived',is_not?:'active' | 'archived',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
743
- }
744
- export interface Download {
745
- /**
746
- * @description The URL at which the file is available for download.
747
-
748
- */
749
-
750
- download_url:string;
751
-
752
- /**
753
- * @description The time until which the &#x60;download_url&#x60; is valid.
754
-
755
- */
756
-
757
- valid_till:number;
758
-
759
- /**
760
- * @description The [media type](https://en.wikipedia.org/wiki/Media_type) of the file.
761
-
762
- */
763
-
764
- mime_type?:string;
283
+ price_variant?: PriceVariantPriceVariantsInputParam;
284
+ }
285
+ export interface InvoiceRevenueRecognitionInputParam {
286
+ id?: filter.String;
287
+ recurring?: filter.Boolean;
288
+ status?: filter.Enum;
289
+ price_type?: filter.Enum;
290
+ date?: filter.Timestamp;
291
+ paid_at?: filter.Timestamp;
292
+ total?: filter.Number;
293
+ amount_paid?: filter.Number;
294
+ amount_adjusted?: filter.Number;
295
+ credits_applied?: filter.Number;
296
+ amount_due?: filter.Number;
297
+ dunning_status?: filter.Enum;
298
+ updated_at?: filter.Timestamp;
299
+ channel?: filter.Enum;
300
+ }
301
+ export interface CustomerRevenueRecognitionInputParam {
302
+ id?: filter.String;
303
+ first_name?: filter.String;
304
+ last_name?: filter.String;
305
+ email?: filter.String;
306
+ company?: filter.String;
307
+ phone?: filter.String;
308
+ auto_collection?: filter.Enum;
309
+ taxability?: filter.Enum;
310
+ created_at?: filter.Timestamp;
311
+ updated_at?: filter.Timestamp;
312
+ offline_payment_method?: filter.Enum;
313
+ auto_close_invoices?: filter.Boolean;
314
+ channel?: filter.Enum;
315
+ }
316
+ export interface RelationshipRevenueRecognitionInputParam {
317
+ parent_id?: filter.String;
318
+ payment_owner_id?: filter.String;
319
+ invoice_owner_id?: filter.String;
320
+ }
321
+ export interface SubscriptionRevenueRecognitionInputParam {
322
+ id?: filter.String;
323
+ customer_id?: filter.String;
324
+ status?: filter.Enum;
325
+ cancel_reason?: filter.Enum;
326
+ remaining_billing_cycles?: filter.Number;
327
+ created_at?: filter.Timestamp;
328
+ activated_at?: filter.Timestamp;
329
+ next_billing_at?: filter.Timestamp;
330
+ cancelled_at?: filter.Timestamp;
331
+ has_scheduled_changes?: filter.Boolean;
332
+ updated_at?: filter.Timestamp;
333
+ offline_payment_method?: filter.Enum;
334
+ auto_close_invoices?: filter.Boolean;
335
+ channel?: filter.Enum;
336
+ plan_id?: filter.String;
337
+ }
338
+
339
+ export interface InvoiceDeferredRevenueInputParam {
340
+ id?: filter.String;
341
+ recurring?: filter.Boolean;
342
+ status?: filter.Enum;
343
+ price_type?: filter.Enum;
344
+ date?: filter.Timestamp;
345
+ paid_at?: filter.Timestamp;
346
+ total?: filter.Number;
347
+ amount_paid?: filter.Number;
348
+ amount_adjusted?: filter.Number;
349
+ credits_applied?: filter.Number;
350
+ amount_due?: filter.Number;
351
+ dunning_status?: filter.Enum;
352
+ updated_at?: filter.Timestamp;
353
+ channel?: filter.Enum;
354
+ }
355
+ export interface CustomerDeferredRevenueInputParam {
356
+ id?: filter.String;
357
+ first_name?: filter.String;
358
+ last_name?: filter.String;
359
+ email?: filter.String;
360
+ company?: filter.String;
361
+ phone?: filter.String;
362
+ auto_collection?: filter.Enum;
363
+ taxability?: filter.Enum;
364
+ created_at?: filter.Timestamp;
365
+ updated_at?: filter.Timestamp;
366
+ offline_payment_method?: filter.Enum;
367
+ auto_close_invoices?: filter.Boolean;
368
+ channel?: filter.Enum;
369
+ }
370
+ export interface RelationshipDeferredRevenueInputParam {
371
+ parent_id?: filter.String;
372
+ payment_owner_id?: filter.String;
373
+ invoice_owner_id?: filter.String;
374
+ }
375
+ export interface SubscriptionDeferredRevenueInputParam {
376
+ id?: filter.String;
377
+ customer_id?: filter.String;
378
+ status?: filter.Enum;
379
+ cancel_reason?: filter.Enum;
380
+ remaining_billing_cycles?: filter.Number;
381
+ created_at?: filter.Timestamp;
382
+ activated_at?: filter.Timestamp;
383
+ next_billing_at?: filter.Timestamp;
384
+ cancelled_at?: filter.Timestamp;
385
+ has_scheduled_changes?: filter.Boolean;
386
+ updated_at?: filter.Timestamp;
387
+ offline_payment_method?: filter.Enum;
388
+ auto_close_invoices?: filter.Boolean;
389
+ channel?: filter.Enum;
390
+ plan_id?: filter.String;
391
+ }
392
+
393
+ export interface PlanPlansInputParam {
394
+ id?: filter.String;
395
+ name?: filter.String;
396
+ price?: filter.Number;
397
+ period?: filter.Number;
398
+ period_unit?: filter.Enum;
399
+ trial_period?: filter.Number;
400
+ trial_period_unit?: filter.Enum;
401
+ addon_applicability?: filter.Enum;
402
+ giftable?: filter.Boolean;
403
+ status?: filter.Enum;
404
+ updated_at?: filter.Timestamp;
405
+ channel?: filter.Enum;
406
+ }
407
+
408
+ export interface AddonAddonsInputParam {
409
+ id?: filter.String;
410
+ name?: filter.String;
411
+ charge_type?: filter.Enum;
412
+ price?: filter.Number;
413
+ period?: filter.Number;
414
+ period_unit?: filter.Enum;
415
+ status?: filter.Enum;
416
+ updated_at?: filter.Timestamp;
417
+ channel?: filter.Enum;
418
+ }
419
+
420
+ export interface CouponCouponsInputParam {
421
+ id?: filter.String;
422
+ name?: filter.String;
423
+ discount_type?: filter.Enum;
424
+ duration_type?: filter.Enum;
425
+ status?: filter.Enum;
426
+ apply_on?: filter.Enum;
427
+ created_at?: filter.Timestamp;
428
+ updated_at?: filter.Timestamp;
429
+ }
430
+
431
+ export interface CustomerCustomersInputParam {
432
+ id?: filter.String;
433
+ first_name?: filter.String;
434
+ last_name?: filter.String;
435
+ email?: filter.String;
436
+ company?: filter.String;
437
+ phone?: filter.String;
438
+ auto_collection?: filter.Enum;
439
+ taxability?: filter.Enum;
440
+ created_at?: filter.Timestamp;
441
+ updated_at?: filter.Timestamp;
442
+ offline_payment_method?: filter.Enum;
443
+ auto_close_invoices?: filter.Boolean;
444
+ channel?: filter.Enum;
445
+ }
446
+ export interface RelationshipCustomersInputParam {
447
+ parent_id?: filter.String;
448
+ payment_owner_id?: filter.String;
449
+ invoice_owner_id?: filter.String;
450
+ }
451
+
452
+ export interface SubscriptionSubscriptionsInputParam {
453
+ id?: filter.String;
454
+ customer_id?: filter.String;
455
+ status?: filter.Enum;
456
+ cancel_reason?: filter.Enum;
457
+ remaining_billing_cycles?: filter.Number;
458
+ created_at?: filter.Timestamp;
459
+ activated_at?: filter.Timestamp;
460
+ next_billing_at?: filter.Timestamp;
461
+ cancelled_at?: filter.Timestamp;
462
+ has_scheduled_changes?: filter.Boolean;
463
+ updated_at?: filter.Timestamp;
464
+ offline_payment_method?: filter.Enum;
465
+ auto_close_invoices?: filter.Boolean;
466
+ channel?: filter.Enum;
467
+ plan_id?: filter.String;
468
+ }
469
+
470
+ export interface InvoiceInvoicesInputParam {
471
+ id?: filter.String;
472
+ subscription_id?: filter.String;
473
+ customer_id?: filter.String;
474
+ recurring?: filter.Boolean;
475
+ status?: filter.Enum;
476
+ price_type?: filter.Enum;
477
+ date?: filter.Timestamp;
478
+ paid_at?: filter.Timestamp;
479
+ total?: filter.Number;
480
+ amount_paid?: filter.Number;
481
+ amount_adjusted?: filter.Number;
482
+ credits_applied?: filter.Number;
483
+ amount_due?: filter.Number;
484
+ dunning_status?: filter.Enum;
485
+ updated_at?: filter.Timestamp;
486
+ channel?: filter.Enum;
487
+ }
488
+
489
+ export interface CreditNoteCreditNotesInputParam {
490
+ id?: filter.String;
491
+ customer_id?: filter.String;
492
+ subscription_id?: filter.String;
493
+ reference_invoice_id?: filter.String;
494
+ type?: filter.Enum;
495
+ reason_code?: filter.Enum;
496
+ create_reason_code?: filter.String;
497
+ status?: filter.Enum;
498
+ date?: filter.Timestamp;
499
+ total?: filter.Number;
500
+ price_type?: filter.Enum;
501
+ amount_allocated?: filter.Number;
502
+ amount_refunded?: filter.Number;
503
+ amount_available?: filter.Number;
504
+ voided_at?: filter.Timestamp;
505
+ updated_at?: filter.Timestamp;
506
+ channel?: filter.Enum;
507
+ }
508
+
509
+ export interface TransactionTransactionsInputParam {
510
+ id?: filter.String;
511
+ customer_id?: filter.String;
512
+ subscription_id?: filter.String;
513
+ payment_source_id?: filter.String;
514
+ payment_method?: filter.Enum;
515
+ gateway?: filter.Enum;
516
+ gateway_account_id?: filter.String;
517
+ id_at_gateway?: filter.String;
518
+ reference_number?: filter.String;
519
+ type?: filter.Enum;
520
+ date?: filter.Timestamp;
521
+ amount?: filter.Number;
522
+ amount_capturable?: filter.Number;
523
+ status?: filter.Enum;
524
+ updated_at?: filter.Timestamp;
525
+ }
526
+
527
+ export interface OrderOrdersInputParam {
528
+ id?: filter.String;
529
+ subscription_id?: filter.String;
530
+ customer_id?: filter.String;
531
+ status?: filter.Enum;
532
+ price_type?: filter.Enum;
533
+ order_date?: filter.Timestamp;
534
+ shipping_date?: filter.Timestamp;
535
+ shipped_at?: filter.Timestamp;
536
+ delivered_at?: filter.Timestamp;
537
+ cancelled_at?: filter.Timestamp;
538
+ amount_paid?: filter.Number;
539
+ refundable_credits?: filter.Number;
540
+ refundable_credits_issued?: filter.Number;
541
+ updated_at?: filter.Timestamp;
542
+ resent_status?: filter.Enum;
543
+ is_resent?: filter.Boolean;
544
+ original_order_id?: filter.String;
545
+ }
546
+
547
+ export interface ItemFamilyItemFamiliesInputParam {
548
+ id?: filter.String;
549
+ name?: filter.String;
550
+ updated_at?: filter.Timestamp;
551
+ }
552
+
553
+ export interface ItemItemsInputParam {
554
+ id?: filter.String;
555
+ item_family_id?: filter.String;
556
+ type?: filter.Enum;
557
+ name?: filter.String;
558
+ item_applicability?: filter.Enum;
559
+ status?: filter.Enum;
560
+ is_giftable?: filter.Boolean;
561
+ updated_at?: filter.Timestamp;
562
+ enabled_for_checkout?: filter.Boolean;
563
+ enabled_in_portal?: filter.Boolean;
564
+ metered?: filter.Boolean;
565
+ usage_calculation?: filter.Enum;
566
+ channel?: filter.Enum;
567
+ }
568
+
569
+ export interface ItemPriceItemPricesInputParam {
570
+ id?: filter.String;
571
+ name?: filter.String;
572
+ pricing_model?: filter.Enum;
573
+ item_id?: filter.String;
574
+ price_variant_id?: filter.String;
575
+ trial_period?: filter.Number;
576
+ trial_period_unit?: filter.Enum;
577
+ status?: filter.Enum;
578
+ updated_at?: filter.Timestamp;
579
+ period_unit?: filter.Enum;
580
+ period?: filter.Number;
581
+ channel?: filter.Enum;
582
+ }
583
+
584
+ export interface AttachedItemAttachedItemsInputParam {
585
+ id?: filter.String;
586
+ item_id?: filter.String;
587
+ type?: filter.Enum;
588
+ charge_on_event?: filter.Enum;
589
+ updated_at?: filter.Timestamp;
590
+ parent_item_id?: filter.String;
591
+ }
592
+
593
+ export interface DifferentialPriceDifferentialPricesInputParam {
594
+ item_price_id?: filter.String;
595
+ id?: filter.String;
596
+ parent_item_id?: filter.String;
597
+ }
598
+
599
+ export interface PriceVariantPriceVariantsInputParam {
600
+ id?: filter.String;
601
+ name?: filter.String;
602
+ status?: filter.Enum;
603
+ updated_at?: filter.Timestamp;
604
+ created_at?: filter.Timestamp;
765
605
  }
766
606
  }
767
- }
607
+ }