chargebee 2.40.0 → 3.0.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (118) hide show
  1. package/CHANGELOG.md +10 -1
  2. package/LICENSE +1 -1
  3. package/README.md +90 -172
  4. package/cjs/RequestWrapper.js +81 -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 +77 -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 +91 -54
  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 +36 -0
  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 +233 -724
  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 -4335
  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 +278 -900
  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 -2912
  117. package/types/resources/NonSubscription.d.ts +0 -30
  118. package/types/resources/Session.d.ts +0 -41
@@ -1,947 +1,1466 @@
1
1
  ///<reference path='./../core.d.ts'/>
2
2
  ///<reference path='./../index.d.ts'/>
3
-
3
+ ///<reference path='./filter.d.ts'/>
4
4
  declare module 'chargebee' {
5
5
  export interface Quote {
6
-
7
- id:string;
8
-
9
- name?:string;
10
-
11
- po_number?:string;
12
-
13
- customer_id:string;
14
-
15
- subscription_id?:string;
16
-
17
- invoice_id?:string;
18
-
19
- status:'open' | 'accepted' | 'declined' | 'invoiced' | 'closed';
20
-
21
- operation_type:'create_subscription_for_customer' | 'change_subscription' | 'onetime_invoice';
22
-
23
- vat_number?:string;
24
-
25
- price_type:PriceType;
26
-
27
- valid_till:number;
28
-
29
- date:number;
30
-
31
- total_payable?:number;
32
-
33
- charge_on_acceptance?:number;
34
-
35
- sub_total:number;
36
-
37
- total?:number;
38
-
39
- credits_applied?:number;
40
-
41
- amount_paid?:number;
42
-
43
- amount_due?:number;
44
-
45
- version?:number;
46
-
47
- resource_version?:number;
48
-
49
- updated_at?:number;
50
-
51
- vat_number_prefix?:string;
52
-
53
- line_items?:Quote.LineItem[];
54
-
55
- discounts?:Quote.Discount[];
56
-
57
- line_item_discounts?:Quote.LineItemDiscount[];
58
-
59
- taxes?:Quote.Tax[];
60
-
61
- line_item_taxes?:Quote.LineItemTax[];
62
-
63
- line_item_tiers?:Quote.LineItemTier[];
64
-
65
- tax_category?:string;
66
-
67
- currency_code:string;
68
-
69
- notes?:any[];
70
-
71
- shipping_address?:Quote.ShippingAddress;
72
-
73
- billing_address?:Quote.BillingAddress;
74
-
75
- contract_term_start?:number;
76
-
77
- contract_term_end?:number;
78
-
79
- contract_term_termination_fee?:number;
80
-
81
- business_entity_id?:string;
6
+ id: string;
7
+ name?: string;
8
+ po_number?: string;
9
+ customer_id: string;
10
+ subscription_id?: string;
11
+ invoice_id?: string;
12
+ status: 'open' | 'accepted' | 'declined' | 'invoiced' | 'closed';
13
+ operation_type:
14
+ | 'create_subscription_for_customer'
15
+ | 'change_subscription'
16
+ | 'onetime_invoice';
17
+ vat_number?: string;
18
+ price_type: PriceType;
19
+ valid_till: number;
20
+ date: number;
21
+ total_payable?: number;
22
+ charge_on_acceptance?: number;
23
+ sub_total: number;
24
+ total?: number;
25
+ credits_applied?: number;
26
+ amount_paid?: number;
27
+ amount_due?: number;
28
+ version?: number;
29
+ resource_version?: number;
30
+ updated_at?: number;
31
+ vat_number_prefix?: string;
32
+ line_items?: Quote.LineItem[];
33
+ discounts?: Quote.Discount[];
34
+ line_item_discounts?: Quote.LineItemDiscount[];
35
+ taxes?: Quote.Tax[];
36
+ line_item_taxes?: Quote.LineItemTax[];
37
+ line_item_tiers?: Quote.LineItemTier[];
38
+ tax_category?: string;
39
+ currency_code: string;
40
+ notes?: any;
41
+ shipping_address?: Quote.ShippingAddress;
42
+ billing_address?: Quote.BillingAddress;
43
+ contract_term_start?: number;
44
+ contract_term_end?: number;
45
+ contract_term_termination_fee?: number;
46
+ business_entity_id?: string;
82
47
  }
48
+
83
49
  export namespace Quote {
84
- export class QuoteResource {
85
- retrieve(quote_id:string):ChargebeeRequest<RetrieveResponse>;
86
-
87
- create_sub_for_customer_quote(customer_id:string, input:CreateSubForCustomerQuoteInputParam):ChargebeeRequest<CreateSubForCustomerQuoteResponse>;
88
-
89
- edit_create_sub_for_customer_quote(quote_id:string, input:EditCreateSubForCustomerQuoteInputParam):ChargebeeRequest<EditCreateSubForCustomerQuoteResponse>;
90
-
91
- update_subscription_quote(input:UpdateSubscriptionQuoteInputParam):ChargebeeRequest<UpdateSubscriptionQuoteResponse>;
92
-
93
- edit_update_subscription_quote(quote_id:string, input?:EditUpdateSubscriptionQuoteInputParam):ChargebeeRequest<EditUpdateSubscriptionQuoteResponse>;
94
-
95
- create_for_onetime_charges(input:CreateForOnetimeChargesInputParam):ChargebeeRequest<CreateForOnetimeChargesResponse>;
96
-
97
- edit_one_time_quote(quote_id:string, input?:EditOneTimeQuoteInputParam):ChargebeeRequest<EditOneTimeQuoteResponse>;
98
-
99
- create_sub_items_for_customer_quote(customer_id:string, input:CreateSubItemsForCustomerQuoteInputParam):ChargebeeRequest<CreateSubItemsForCustomerQuoteResponse>;
100
-
101
- edit_create_sub_customer_quote_for_items(quote_id:string, input:EditCreateSubCustomerQuoteForItemsInputParam):ChargebeeRequest<EditCreateSubCustomerQuoteForItemsResponse>;
102
-
103
- update_subscription_quote_for_items(input:UpdateSubscriptionQuoteForItemsInputParam):ChargebeeRequest<UpdateSubscriptionQuoteForItemsResponse>;
104
-
105
- edit_update_subscription_quote_for_items(quote_id:string, input:EditUpdateSubscriptionQuoteForItemsInputParam):ChargebeeRequest<EditUpdateSubscriptionQuoteForItemsResponse>;
106
-
107
- create_for_charge_items_and_charges(input:CreateForChargeItemsAndChargesInputParam):ChargebeeRequest<CreateForChargeItemsAndChargesResponse>;
108
-
109
- edit_for_charge_items_and_charges(quote_id:string, input:EditForChargeItemsAndChargesInputParam):ChargebeeRequest<EditForChargeItemsAndChargesResponse>;
110
-
111
- list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
112
-
113
- quote_line_groups_for_quote(quote_id:string, input?:QuoteLineGroupsForQuoteInputParam):ChargebeeRequest<QuoteLineGroupsForQuoteResponse>;
114
-
115
- convert(quote_id:string, input?:ConvertInputParam):ChargebeeRequest<ConvertResponse>;
116
-
117
- update_status(quote_id:string, input:UpdateStatusInputParam):ChargebeeRequest<UpdateStatusResponse>;
118
-
119
- extend_expiry_date(quote_id:string, input:ExtendExpiryDateInputParam):ChargebeeRequest<ExtendExpiryDateResponse>;
120
-
121
- delete(quote_id:string, input?:DeleteInputParam):ChargebeeRequest<DeleteResponse>;
122
-
123
- pdf(quote_id:string, input?:PdfInputParam):ChargebeeRequest<PdfResponse>;
124
- }
125
- export interface RetrieveResponse {
126
- quote:Quote;
127
-
128
- quoted_subscription?:QuotedSubscription;
129
-
130
- quoted_charge?:QuotedCharge;
131
- }
132
-
133
- export interface CreateSubForCustomerQuoteResponse {
134
- quote:Quote;
135
-
136
- quoted_subscription?:QuotedSubscription;
50
+ export class QuoteResource {
51
+ retrieve(
52
+ quote_id: string,
53
+ headers?: ChargebeeRequestHeader,
54
+ ): Promise<ChargebeeResponse<RetrieveResponse>>;
55
+
56
+ createSubForCustomerQuote(
57
+ customer_id: string,
58
+ input: CreateSubForCustomerQuoteInputParam,
59
+ headers?: ChargebeeRequestHeader,
60
+ ): Promise<ChargebeeResponse<CreateSubForCustomerQuoteResponse>>;
61
+
62
+ editCreateSubForCustomerQuote(
63
+ quote_id: string,
64
+ input: EditCreateSubForCustomerQuoteInputParam,
65
+ headers?: ChargebeeRequestHeader,
66
+ ): Promise<ChargebeeResponse<EditCreateSubForCustomerQuoteResponse>>;
67
+
68
+ updateSubscriptionQuote(
69
+ input: UpdateSubscriptionQuoteInputParam,
70
+ headers?: ChargebeeRequestHeader,
71
+ ): Promise<ChargebeeResponse<UpdateSubscriptionQuoteResponse>>;
72
+
73
+ editUpdateSubscriptionQuote(
74
+ quote_id: string,
75
+ input?: EditUpdateSubscriptionQuoteInputParam,
76
+ headers?: ChargebeeRequestHeader,
77
+ ): Promise<ChargebeeResponse<EditUpdateSubscriptionQuoteResponse>>;
78
+
79
+ createForOnetimeCharges(
80
+ input: CreateForOnetimeChargesInputParam,
81
+ headers?: ChargebeeRequestHeader,
82
+ ): Promise<ChargebeeResponse<CreateForOnetimeChargesResponse>>;
83
+
84
+ editOneTimeQuote(
85
+ quote_id: string,
86
+ input?: EditOneTimeQuoteInputParam,
87
+ headers?: ChargebeeRequestHeader,
88
+ ): Promise<ChargebeeResponse<EditOneTimeQuoteResponse>>;
89
+
90
+ createSubItemsForCustomerQuote(
91
+ customer_id: string,
92
+ input: CreateSubItemsForCustomerQuoteInputParam,
93
+ headers?: ChargebeeRequestHeader,
94
+ ): Promise<ChargebeeResponse<CreateSubItemsForCustomerQuoteResponse>>;
95
+
96
+ editCreateSubCustomerQuoteForItems(
97
+ quote_id: string,
98
+ input: EditCreateSubCustomerQuoteForItemsInputParam,
99
+ headers?: ChargebeeRequestHeader,
100
+ ): Promise<ChargebeeResponse<EditCreateSubCustomerQuoteForItemsResponse>>;
101
+
102
+ updateSubscriptionQuoteForItems(
103
+ input: UpdateSubscriptionQuoteForItemsInputParam,
104
+ headers?: ChargebeeRequestHeader,
105
+ ): Promise<ChargebeeResponse<UpdateSubscriptionQuoteForItemsResponse>>;
106
+
107
+ editUpdateSubscriptionQuoteForItems(
108
+ quote_id: string,
109
+ input: EditUpdateSubscriptionQuoteForItemsInputParam,
110
+ headers?: ChargebeeRequestHeader,
111
+ ): Promise<
112
+ ChargebeeResponse<EditUpdateSubscriptionQuoteForItemsResponse>
113
+ >;
114
+
115
+ createForChargeItemsAndCharges(
116
+ input: CreateForChargeItemsAndChargesInputParam,
117
+ headers?: ChargebeeRequestHeader,
118
+ ): Promise<ChargebeeResponse<CreateForChargeItemsAndChargesResponse>>;
119
+
120
+ editForChargeItemsAndCharges(
121
+ quote_id: string,
122
+ input: EditForChargeItemsAndChargesInputParam,
123
+ headers?: ChargebeeRequestHeader,
124
+ ): Promise<ChargebeeResponse<EditForChargeItemsAndChargesResponse>>;
125
+
126
+ list(
127
+ input?: ListInputParam,
128
+ headers?: ChargebeeRequestHeader,
129
+ ): Promise<ChargebeeResponse<ListResponse>>;
130
+
131
+ quoteLineGroupsForQuote(
132
+ quote_id: string,
133
+ input?: QuoteLineGroupsForQuoteInputParam,
134
+ headers?: ChargebeeRequestHeader,
135
+ ): Promise<ChargebeeResponse<QuoteLineGroupsForQuoteResponse>>;
136
+
137
+ convert(
138
+ quote_id: string,
139
+ input?: ConvertInputParam,
140
+ headers?: ChargebeeRequestHeader,
141
+ ): Promise<ChargebeeResponse<ConvertResponse>>;
142
+
143
+ updateStatus(
144
+ quote_id: string,
145
+ input: UpdateStatusInputParam,
146
+ headers?: ChargebeeRequestHeader,
147
+ ): Promise<ChargebeeResponse<UpdateStatusResponse>>;
148
+
149
+ extendExpiryDate(
150
+ quote_id: string,
151
+ input: ExtendExpiryDateInputParam,
152
+ headers?: ChargebeeRequestHeader,
153
+ ): Promise<ChargebeeResponse<ExtendExpiryDateResponse>>;
154
+
155
+ delete(
156
+ quote_id: string,
157
+ input?: DeleteInputParam,
158
+ headers?: ChargebeeRequestHeader,
159
+ ): Promise<ChargebeeResponse<DeleteResponse>>;
160
+
161
+ pdf(
162
+ quote_id: string,
163
+ input?: PdfInputParam,
164
+ headers?: ChargebeeRequestHeader,
165
+ ): Promise<ChargebeeResponse<PdfResponse>>;
166
+ }
167
+
168
+ export interface RetrieveResponse {
169
+ quote: Quote;
170
+ quoted_subscription?: QuotedSubscription;
171
+ quoted_charge?: QuotedCharge;
172
+ }
173
+
174
+ export interface CreateSubForCustomerQuoteResponse {
175
+ quote: Quote;
176
+ quoted_subscription?: QuotedSubscription;
177
+ }
178
+
179
+ export interface EditCreateSubForCustomerQuoteResponse {
180
+ quote: Quote;
181
+ quoted_subscription?: QuotedSubscription;
182
+ }
183
+
184
+ export interface UpdateSubscriptionQuoteResponse {
185
+ quote: Quote;
186
+ quoted_subscription?: QuotedSubscription;
187
+ }
188
+
189
+ export interface EditUpdateSubscriptionQuoteResponse {
190
+ quote: Quote;
191
+ quoted_subscription?: QuotedSubscription;
192
+ }
193
+
194
+ export interface CreateForOnetimeChargesResponse {
195
+ quote: Quote;
196
+ quoted_charge?: QuotedCharge;
197
+ }
198
+
199
+ export interface EditOneTimeQuoteResponse {
200
+ quote: Quote;
201
+ quoted_charge?: QuotedCharge;
202
+ }
203
+
204
+ export interface CreateSubItemsForCustomerQuoteResponse {
205
+ quote: Quote;
206
+ quoted_subscription?: QuotedSubscription;
207
+ }
208
+
209
+ export interface EditCreateSubCustomerQuoteForItemsResponse {
210
+ quote: Quote;
211
+ quoted_subscription?: QuotedSubscription;
212
+ }
213
+
214
+ export interface UpdateSubscriptionQuoteForItemsResponse {
215
+ quote: Quote;
216
+ quoted_subscription?: QuotedSubscription;
137
217
  }
218
+
219
+ export interface EditUpdateSubscriptionQuoteForItemsResponse {
220
+ quote: Quote;
221
+ quoted_subscription?: QuotedSubscription;
222
+ }
223
+
224
+ export interface CreateForChargeItemsAndChargesResponse {
225
+ quote: Quote;
226
+ quoted_charge?: QuotedCharge;
227
+ }
228
+
229
+ export interface EditForChargeItemsAndChargesResponse {
230
+ quote: Quote;
231
+ quoted_charge?: QuotedCharge;
232
+ }
233
+
234
+ export interface ListResponse {
235
+ list: { quote: Quote; quoted_subscription?: QuotedSubscription }[];
236
+ next_offset?: string;
237
+ }
238
+
239
+ export interface QuoteLineGroupsForQuoteResponse {
240
+ list: { quote_line_group: QuoteLineGroup }[];
241
+ next_offset?: string;
242
+ }
243
+
244
+ export interface ConvertResponse {
245
+ quote: Quote;
246
+ quoted_subscription?: QuotedSubscription;
247
+ quoted_charge?: QuotedCharge;
248
+ customer: Customer;
249
+ subscription?: Subscription;
250
+ invoice?: Invoice;
251
+ credit_note?: CreditNote;
252
+ unbilled_charges?: UnbilledCharge[];
253
+ }
254
+
255
+ export interface UpdateStatusResponse {
256
+ quote: Quote;
257
+ quoted_subscription?: QuotedSubscription;
258
+ quoted_charge?: QuotedCharge;
259
+ }
260
+
261
+ export interface ExtendExpiryDateResponse {
262
+ quote: Quote;
263
+ quoted_subscription?: QuotedSubscription;
264
+ quoted_charge?: QuotedCharge;
265
+ }
266
+
267
+ export interface DeleteResponse {
268
+ quote: Quote;
269
+ quoted_subscription?: QuotedSubscription;
270
+ quoted_charge?: QuotedCharge;
271
+ }
272
+
273
+ export interface PdfResponse {
274
+ download: Download;
275
+ }
276
+
277
+ export interface LineItem {
278
+ id?: string;
279
+ subscription_id?: string;
280
+ date_from: number;
281
+ date_to: number;
282
+ unit_amount: number;
283
+ quantity?: number;
284
+ amount?: number;
285
+ pricing_model?:
286
+ | 'flat_fee'
287
+ | 'per_unit'
288
+ | 'tiered'
289
+ | 'volume'
290
+ | 'stairstep';
291
+ is_taxed: boolean;
292
+ tax_amount?: number;
293
+ tax_rate?: number;
294
+ unit_amount_in_decimal?: string;
295
+ quantity_in_decimal?: string;
296
+ amount_in_decimal?: string;
297
+ discount_amount?: number;
298
+ item_level_discount_amount?: number;
299
+ usage_percentage?: string;
300
+ reference_line_item_id?: string;
301
+ description: string;
302
+ entity_description?: string;
303
+ entity_type:
304
+ | 'adhoc'
305
+ | 'plan_item_price'
306
+ | 'addon_item_price'
307
+ | 'charge_item_price'
308
+ | 'plan_setup'
309
+ | 'plan'
310
+ | 'addon';
311
+ tax_exempt_reason?:
312
+ | 'tax_not_configured'
313
+ | 'region_non_taxable'
314
+ | 'export'
315
+ | 'customer_exempt'
316
+ | 'product_exempt'
317
+ | 'zero_rated'
318
+ | 'reverse_charge'
319
+ | 'high_value_physical_goods'
320
+ | 'zero_value_item'
321
+ | 'tax_not_configured_external_provider';
322
+ entity_id?: string;
323
+ customer_id?: string;
324
+ }
325
+ export interface Discount {
326
+ amount: number;
327
+ description?: string;
328
+ entity_type:
329
+ | 'item_level_coupon'
330
+ | 'document_level_coupon'
331
+ | 'promotional_credits'
332
+ | 'prorated_credits'
333
+ | 'item_level_discount'
334
+ | 'document_level_discount';
335
+ entity_id?: string;
336
+ coupon_set_code?: string;
337
+ }
338
+ export interface LineItemDiscount {
339
+ line_item_id: string;
340
+ discount_type:
341
+ | 'item_level_coupon'
342
+ | 'document_level_coupon'
343
+ | 'promotional_credits'
344
+ | 'prorated_credits'
345
+ | 'item_level_discount'
346
+ | 'document_level_discount';
347
+ coupon_id?: string;
348
+ entity_id?: string;
349
+ discount_amount: number;
350
+ }
351
+ export interface Tax {
352
+ name: string;
353
+ amount: number;
354
+ description?: string;
355
+ }
356
+ export interface LineItemTax {
357
+ line_item_id?: string;
358
+ tax_name: string;
359
+ tax_rate: number;
360
+ date_to?: number;
361
+ date_from?: number;
362
+ prorated_taxable_amount?: number;
363
+ is_partial_tax_applied?: boolean;
364
+ is_non_compliance_tax?: boolean;
365
+ taxable_amount: number;
366
+ tax_amount: number;
367
+ tax_juris_type?:
368
+ | 'country'
369
+ | 'federal'
370
+ | 'state'
371
+ | 'county'
372
+ | 'city'
373
+ | 'special'
374
+ | 'unincorporated'
375
+ | 'other';
376
+ tax_juris_name?: string;
377
+ tax_juris_code?: string;
378
+ tax_amount_in_local_currency?: number;
379
+ local_currency_code?: string;
380
+ }
381
+ export interface LineItemTier {
382
+ line_item_id?: string;
383
+ starting_unit: number;
384
+ ending_unit?: number;
385
+ quantity_used: number;
386
+ unit_amount: number;
387
+ starting_unit_in_decimal?: string;
388
+ ending_unit_in_decimal?: string;
389
+ quantity_used_in_decimal?: string;
390
+ unit_amount_in_decimal?: string;
391
+ }
392
+ export interface ShippingAddress {
393
+ first_name?: string;
394
+ last_name?: string;
395
+ email?: string;
396
+ company?: string;
397
+ phone?: string;
398
+ line1?: string;
399
+ line2?: string;
400
+ line3?: string;
401
+ city?: string;
402
+ state_code?: string;
403
+ state?: string;
404
+ country?: string;
405
+ zip?: string;
406
+ validation_status?: ValidationStatus;
407
+ index: number;
408
+ }
409
+ export interface BillingAddress {
410
+ first_name?: string;
411
+ last_name?: string;
412
+ email?: string;
413
+ company?: string;
414
+ phone?: string;
415
+ line1?: string;
416
+ line2?: string;
417
+ line3?: string;
418
+ city?: string;
419
+ state_code?: string;
420
+ state?: string;
421
+ country?: string;
422
+ zip?: string;
423
+ validation_status?: ValidationStatus;
424
+ }
425
+ // REQUEST PARAMS
426
+ //---------------
427
+
138
428
  export interface CreateSubForCustomerQuoteInputParam {
139
-
140
- subscription:{contract_term_billing_cycle_on_renewal?:number,id?:string,offline_payment_method?:OfflinePaymentMethod,plan_id:string,plan_quantity?:number,plan_quantity_in_decimal?:string,plan_unit_price?:number,plan_unit_price_in_decimal?:string,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
141
-
142
- shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
143
-
144
- contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
145
-
146
- addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
147
-
148
- event_based_addons?:{charge_on?:ChargeOn,charge_once?:boolean,id?:string,on_event?:OnEvent,quantity?:number,quantity_in_decimal?:string,service_period_in_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
149
-
150
- name?:string;
151
-
152
- notes?:string;
153
-
154
- expires_at?:number;
155
-
156
- billing_cycles?:number;
157
-
158
- mandatory_addons_to_remove?:string[];
159
-
160
- terms_to_charge?:number;
161
-
162
- billing_alignment_mode?:BillingAlignmentMode;
163
-
164
- coupon_ids?:string[];
165
- }
166
- export interface EditCreateSubForCustomerQuoteResponse {
167
- quote:Quote;
168
-
169
- quoted_subscription?:QuotedSubscription;
429
+ name?: string;
430
+ notes?: string;
431
+ expires_at?: number;
432
+ billing_cycles?: number;
433
+ mandatory_addons_to_remove?: string[];
434
+ terms_to_charge?: number;
435
+ billing_alignment_mode?: BillingAlignmentMode;
436
+ coupon_ids?: string[];
437
+ subscription?: SubscriptionCreateSubForCustomerQuoteInputParam;
438
+ shipping_address?: ShippingAddressCreateSubForCustomerQuoteInputParam;
439
+ contract_term?: ContractTermCreateSubForCustomerQuoteInputParam;
440
+ addons?: AddonsCreateSubForCustomerQuoteInputParam[];
441
+ event_based_addons?: EventBasedAddonsCreateSubForCustomerQuoteInputParam[];
170
442
  }
171
443
  export interface EditCreateSubForCustomerQuoteInputParam {
172
-
173
- subscription:{contract_term_billing_cycle_on_renewal?:number,id?:string,offline_payment_method?:OfflinePaymentMethod,plan_id:string,plan_quantity?:number,plan_quantity_in_decimal?:string,plan_unit_price?:number,plan_unit_price_in_decimal?:string,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
174
-
175
- shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
176
-
177
- contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
178
-
179
- addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
180
-
181
- event_based_addons?:{charge_on?:ChargeOn,charge_once?:boolean,id?:string,on_event?:OnEvent,quantity?:number,quantity_in_decimal?:string,service_period_in_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
182
-
183
- notes?:string;
184
-
185
- expires_at?:number;
186
-
187
- billing_cycles?:number;
188
-
189
- mandatory_addons_to_remove?:string[];
190
-
191
- terms_to_charge?:number;
192
-
193
- billing_alignment_mode?:BillingAlignmentMode;
194
-
195
- coupon_ids?:string[];
196
- }
197
- export interface UpdateSubscriptionQuoteResponse {
198
- quote:Quote;
199
-
200
- quoted_subscription?:QuotedSubscription;
444
+ notes?: string;
445
+ expires_at?: number;
446
+ billing_cycles?: number;
447
+ mandatory_addons_to_remove?: string[];
448
+ terms_to_charge?: number;
449
+ billing_alignment_mode?: BillingAlignmentMode;
450
+ coupon_ids?: string[];
451
+ subscription?: SubscriptionEditCreateSubForCustomerQuoteInputParam;
452
+ shipping_address?: ShippingAddressEditCreateSubForCustomerQuoteInputParam;
453
+ contract_term?: ContractTermEditCreateSubForCustomerQuoteInputParam;
454
+ addons?: AddonsEditCreateSubForCustomerQuoteInputParam[];
455
+ event_based_addons?: EventBasedAddonsEditCreateSubForCustomerQuoteInputParam[];
201
456
  }
202
457
  export interface UpdateSubscriptionQuoteInputParam {
203
-
204
- subscription:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,id:string,offline_payment_method?:OfflinePaymentMethod,plan_id?:string,plan_quantity?:number,plan_quantity_in_decimal?:string,plan_unit_price?:number,plan_unit_price_in_decimal?:string,setup_fee?:number,start_date?:number,trial_end?:number};
205
-
206
- billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
207
-
208
- shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
209
-
210
- customer?:{registered_for_gst?:boolean,vat_number?:string,vat_number_prefix?:string};
211
-
212
- contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',cancellation_cutoff_period?:number};
213
-
214
- addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
215
-
216
- name?:string;
217
-
218
- notes?:string;
219
-
220
- expires_at?:number;
221
-
222
- event_based_addons?:{charge_on?:ChargeOn,charge_once?:boolean,id?:string,on_event?:OnEvent,quantity?:number,quantity_in_decimal?:string,service_period_in_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
223
-
224
- replace_addon_list?:boolean;
225
-
226
- mandatory_addons_to_remove?:string[];
227
-
228
- billing_cycles?:number;
229
-
230
- terms_to_charge?:number;
231
-
232
- reactivate_from?:number;
233
-
234
- billing_alignment_mode?:BillingAlignmentMode;
235
-
236
- coupon_ids?:string[];
237
-
238
- replace_coupon_list?:boolean;
239
-
240
- change_option?:ChangeOption;
241
-
242
- changes_scheduled_at?:number;
243
-
244
- force_term_reset?:boolean;
245
-
246
- reactivate?:boolean;
247
- }
248
- export interface EditUpdateSubscriptionQuoteResponse {
249
- quote:Quote;
250
-
251
- quoted_subscription?:QuotedSubscription;
458
+ name?: string;
459
+ notes?: string;
460
+ expires_at?: number;
461
+ replace_addon_list?: boolean;
462
+ mandatory_addons_to_remove?: string[];
463
+ billing_cycles?: number;
464
+ terms_to_charge?: number;
465
+ reactivate_from?: number;
466
+ billing_alignment_mode?: BillingAlignmentMode;
467
+ coupon_ids?: string[];
468
+ replace_coupon_list?: boolean;
469
+ change_option?: ChangeOption;
470
+ changes_scheduled_at?: number;
471
+ force_term_reset?: boolean;
472
+ reactivate?: boolean;
473
+ subscription?: SubscriptionUpdateSubscriptionQuoteInputParam;
474
+ billing_address?: BillingAddressUpdateSubscriptionQuoteInputParam;
475
+ shipping_address?: ShippingAddressUpdateSubscriptionQuoteInputParam;
476
+ customer?: CustomerUpdateSubscriptionQuoteInputParam;
477
+ contract_term?: ContractTermUpdateSubscriptionQuoteInputParam;
478
+ addons?: AddonsUpdateSubscriptionQuoteInputParam[];
479
+ event_based_addons?: EventBasedAddonsUpdateSubscriptionQuoteInputParam[];
252
480
  }
253
481
  export interface EditUpdateSubscriptionQuoteInputParam {
254
-
255
- subscription?:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,offline_payment_method?:OfflinePaymentMethod,plan_id?:string,plan_quantity?:number,plan_quantity_in_decimal?:string,plan_unit_price?:number,plan_unit_price_in_decimal?:string,setup_fee?:number,start_date?:number,trial_end?:number};
256
-
257
- billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
258
-
259
- shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
260
-
261
- customer?:{registered_for_gst?:boolean,vat_number?:string,vat_number_prefix?:string};
262
-
263
- contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',cancellation_cutoff_period?:number};
264
-
265
- addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
266
-
267
- notes?:string;
268
-
269
- expires_at?:number;
270
-
271
- event_based_addons?:{charge_on?:ChargeOn,charge_once?:boolean,id?:string,on_event?:OnEvent,quantity?:number,quantity_in_decimal?:string,service_period_in_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
272
-
273
- replace_addon_list?:boolean;
274
-
275
- mandatory_addons_to_remove?:string[];
276
-
277
- billing_cycles?:number;
278
-
279
- terms_to_charge?:number;
280
-
281
- reactivate_from?:number;
282
-
283
- billing_alignment_mode?:BillingAlignmentMode;
284
-
285
- coupon_ids?:string[];
286
-
287
- replace_coupon_list?:boolean;
288
-
289
- change_option?:ChangeOption;
290
-
291
- changes_scheduled_at?:number;
292
-
293
- force_term_reset?:boolean;
294
-
295
- reactivate?:boolean;
296
- }
297
- export interface CreateForOnetimeChargesResponse {
298
- quote:Quote;
299
-
300
- quoted_charge?:QuotedCharge;
482
+ notes?: string;
483
+ expires_at?: number;
484
+ replace_addon_list?: boolean;
485
+ mandatory_addons_to_remove?: string[];
486
+ billing_cycles?: number;
487
+ terms_to_charge?: number;
488
+ reactivate_from?: number;
489
+ billing_alignment_mode?: BillingAlignmentMode;
490
+ coupon_ids?: string[];
491
+ replace_coupon_list?: boolean;
492
+ change_option?: ChangeOption;
493
+ changes_scheduled_at?: number;
494
+ force_term_reset?: boolean;
495
+ reactivate?: boolean;
496
+ subscription?: SubscriptionEditUpdateSubscriptionQuoteInputParam;
497
+ billing_address?: BillingAddressEditUpdateSubscriptionQuoteInputParam;
498
+ shipping_address?: ShippingAddressEditUpdateSubscriptionQuoteInputParam;
499
+ customer?: CustomerEditUpdateSubscriptionQuoteInputParam;
500
+ contract_term?: ContractTermEditUpdateSubscriptionQuoteInputParam;
501
+ addons?: AddonsEditUpdateSubscriptionQuoteInputParam[];
502
+ event_based_addons?: EventBasedAddonsEditUpdateSubscriptionQuoteInputParam[];
301
503
  }
302
504
  export interface CreateForOnetimeChargesInputParam {
303
-
304
- shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
305
-
306
- addons?:{id?:string,quantity?:number,quantity_in_decimal?:string,service_period?:number,unit_price?:number,unit_price_in_decimal?:string}[];
307
-
308
- charges?:{amount?:number,amount_in_decimal?:string,avalara_sale_type?:AvalaraSaleType,avalara_service_type?:number,avalara_transaction_type?:number,description?:string,service_period?:number}[];
309
-
310
- tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
311
-
312
- name?:string;
313
-
314
- customer_id:string;
315
-
316
- po_number?:string;
317
-
318
- notes?:string;
319
-
320
- expires_at?:number;
321
-
322
- currency_code?:string;
323
-
324
- coupon?:string;
325
-
326
- coupon_ids?:string[];
327
- }
328
- export interface EditOneTimeQuoteResponse {
329
- quote:Quote;
330
-
331
- quoted_charge?:QuotedCharge;
505
+ name?: string;
506
+ customer_id: string;
507
+ po_number?: string;
508
+ notes?: string;
509
+ expires_at?: number;
510
+ currency_code?: string;
511
+ coupon?: string;
512
+ coupon_ids?: string[];
513
+ shipping_address?: ShippingAddressCreateForOnetimeChargesInputParam;
514
+ addons?: AddonsCreateForOnetimeChargesInputParam[];
515
+ charges?: ChargesCreateForOnetimeChargesInputParam[];
516
+ tax_providers_fields?: TaxProvidersFieldsCreateForOnetimeChargesInputParam[];
332
517
  }
333
518
  export interface EditOneTimeQuoteInputParam {
334
-
335
- shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
336
-
337
- addons?:{id?:string,quantity?:number,quantity_in_decimal?:string,service_period?:number,unit_price?:number,unit_price_in_decimal?:string}[];
338
-
339
- charges?:{amount?:number,amount_in_decimal?:string,avalara_sale_type?:AvalaraSaleType,avalara_service_type?:number,avalara_transaction_type?:number,description?:string,service_period?:number}[];
340
-
341
- tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
342
-
343
- po_number?:string;
344
-
345
- notes?:string;
346
-
347
- expires_at?:number;
348
-
349
- currency_code?:string;
350
-
351
- coupon?:string;
352
-
353
- coupon_ids?:string[];
354
- }
355
- export interface CreateSubItemsForCustomerQuoteResponse {
356
- quote:Quote;
357
-
358
- quoted_subscription?:QuotedSubscription;
519
+ po_number?: string;
520
+ notes?: string;
521
+ expires_at?: number;
522
+ currency_code?: string;
523
+ coupon?: string;
524
+ coupon_ids?: string[];
525
+ shipping_address?: ShippingAddressEditOneTimeQuoteInputParam;
526
+ addons?: AddonsEditOneTimeQuoteInputParam[];
527
+ charges?: ChargesEditOneTimeQuoteInputParam[];
528
+ tax_providers_fields?: TaxProvidersFieldsEditOneTimeQuoteInputParam[];
359
529
  }
360
530
  export interface CreateSubItemsForCustomerQuoteInputParam {
361
-
362
- subscription?:{contract_term_billing_cycle_on_renewal?:number,id?:string,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
363
-
364
- shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
365
-
366
- contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
367
-
368
- subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
369
-
370
- discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
371
-
372
- item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
373
-
374
- name?:string;
375
-
376
- notes?:string;
377
-
378
- expires_at?:number;
379
-
380
- billing_cycles?:number;
381
-
382
- mandatory_items_to_remove?:string[];
383
-
384
- terms_to_charge?:number;
385
-
386
- billing_alignment_mode?:BillingAlignmentMode;
387
-
388
- coupon_ids?:string[];
389
- }
390
- export interface EditCreateSubCustomerQuoteForItemsResponse {
391
- quote:Quote;
392
-
393
- quoted_subscription?:QuotedSubscription;
531
+ name?: string;
532
+ notes?: string;
533
+ expires_at?: number;
534
+ billing_cycles?: number;
535
+ mandatory_items_to_remove?: string[];
536
+ terms_to_charge?: number;
537
+ billing_alignment_mode?: BillingAlignmentMode;
538
+ coupon_ids?: string[];
539
+ subscription?: SubscriptionCreateSubItemsForCustomerQuoteInputParam;
540
+ shipping_address?: ShippingAddressCreateSubItemsForCustomerQuoteInputParam;
541
+ contract_term?: ContractTermCreateSubItemsForCustomerQuoteInputParam;
542
+ subscription_items?: SubscriptionItemsCreateSubItemsForCustomerQuoteInputParam[];
543
+ discounts?: DiscountsCreateSubItemsForCustomerQuoteInputParam[];
544
+ item_tiers?: ItemTiersCreateSubItemsForCustomerQuoteInputParam[];
394
545
  }
395
546
  export interface EditCreateSubCustomerQuoteForItemsInputParam {
396
-
397
- subscription?:{contract_term_billing_cycle_on_renewal?:number,id?:string,po_number?:string,setup_fee?:number,start_date?:number,trial_end?:number};
398
-
399
- shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
400
-
401
- contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
402
-
403
- subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
404
-
405
- discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
406
-
407
- item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
408
-
409
- notes?:string;
410
-
411
- expires_at?:number;
412
-
413
- billing_cycles?:number;
414
-
415
- mandatory_items_to_remove?:string[];
416
-
417
- terms_to_charge?:number;
418
-
419
- billing_alignment_mode?:BillingAlignmentMode;
420
-
421
- coupon_ids?:string[];
422
- }
423
- export interface UpdateSubscriptionQuoteForItemsResponse {
424
- quote:Quote;
425
-
426
- quoted_subscription?:QuotedSubscription;
547
+ notes?: string;
548
+ expires_at?: number;
549
+ billing_cycles?: number;
550
+ mandatory_items_to_remove?: string[];
551
+ terms_to_charge?: number;
552
+ billing_alignment_mode?: BillingAlignmentMode;
553
+ coupon_ids?: string[];
554
+ subscription?: SubscriptionEditCreateSubCustomerQuoteForItemsInputParam;
555
+ shipping_address?: ShippingAddressEditCreateSubCustomerQuoteForItemsInputParam;
556
+ contract_term?: ContractTermEditCreateSubCustomerQuoteForItemsInputParam;
557
+ subscription_items?: SubscriptionItemsEditCreateSubCustomerQuoteForItemsInputParam[];
558
+ discounts?: DiscountsEditCreateSubCustomerQuoteForItemsInputParam[];
559
+ item_tiers?: ItemTiersEditCreateSubCustomerQuoteForItemsInputParam[];
427
560
  }
428
561
  export interface UpdateSubscriptionQuoteForItemsInputParam {
429
-
430
- subscription:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,id:string,offline_payment_method?:OfflinePaymentMethod,setup_fee?:number,start_date?:number,trial_end?:number};
431
-
432
- billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
433
-
434
- shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
435
-
436
- customer?:{registered_for_gst?:boolean,vat_number?:string,vat_number_prefix?:string};
437
-
438
- contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',cancellation_cutoff_period?:number};
439
-
440
- subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
441
-
442
- discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
443
-
444
- item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
445
-
446
- name?:string;
447
-
448
- notes?:string;
449
-
450
- expires_at?:number;
451
-
452
- mandatory_items_to_remove?:string[];
453
-
454
- replace_items_list?:boolean;
455
-
456
- billing_cycles?:number;
457
-
458
- terms_to_charge?:number;
459
-
460
- reactivate_from?:number;
461
-
462
- billing_alignment_mode?:BillingAlignmentMode;
463
-
464
- coupon_ids?:string[];
465
-
466
- replace_coupon_list?:boolean;
467
-
468
- change_option?:ChangeOption;
469
-
470
- changes_scheduled_at?:number;
471
-
472
- force_term_reset?:boolean;
473
-
474
- reactivate?:boolean;
475
- }
476
- export interface EditUpdateSubscriptionQuoteForItemsResponse {
477
- quote:Quote;
478
-
479
- quoted_subscription?:QuotedSubscription;
562
+ name?: string;
563
+ notes?: string;
564
+ expires_at?: number;
565
+ mandatory_items_to_remove?: string[];
566
+ replace_items_list?: boolean;
567
+ billing_cycles?: number;
568
+ terms_to_charge?: number;
569
+ reactivate_from?: number;
570
+ billing_alignment_mode?: BillingAlignmentMode;
571
+ coupon_ids?: string[];
572
+ replace_coupon_list?: boolean;
573
+ change_option?: ChangeOption;
574
+ changes_scheduled_at?: number;
575
+ force_term_reset?: boolean;
576
+ reactivate?: boolean;
577
+ subscription?: SubscriptionUpdateSubscriptionQuoteForItemsInputParam;
578
+ billing_address?: BillingAddressUpdateSubscriptionQuoteForItemsInputParam;
579
+ shipping_address?: ShippingAddressUpdateSubscriptionQuoteForItemsInputParam;
580
+ customer?: CustomerUpdateSubscriptionQuoteForItemsInputParam;
581
+ contract_term?: ContractTermUpdateSubscriptionQuoteForItemsInputParam;
582
+ subscription_items?: SubscriptionItemsUpdateSubscriptionQuoteForItemsInputParam[];
583
+ discounts?: DiscountsUpdateSubscriptionQuoteForItemsInputParam[];
584
+ item_tiers?: ItemTiersUpdateSubscriptionQuoteForItemsInputParam[];
480
585
  }
481
586
  export interface EditUpdateSubscriptionQuoteForItemsInputParam {
482
-
483
- subscription?:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,coupon?:string,offline_payment_method?:OfflinePaymentMethod,setup_fee?:number,start_date?:number,trial_end?:number};
484
-
485
- billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
486
-
487
- shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
488
-
489
- customer?:{registered_for_gst?:boolean,vat_number?:string,vat_number_prefix?:string};
490
-
491
- contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',cancellation_cutoff_period?:number};
492
-
493
- subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
494
-
495
- discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
496
-
497
- item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
498
-
499
- notes?:string;
500
-
501
- expires_at?:number;
502
-
503
- mandatory_items_to_remove?:string[];
504
-
505
- replace_items_list?:boolean;
506
-
507
- billing_cycles?:number;
508
-
509
- terms_to_charge?:number;
510
-
511
- reactivate_from?:number;
512
-
513
- billing_alignment_mode?:BillingAlignmentMode;
514
-
515
- coupon_ids?:string[];
516
-
517
- replace_coupon_list?:boolean;
518
-
519
- change_option?:ChangeOption;
520
-
521
- changes_scheduled_at?:number;
522
-
523
- force_term_reset?:boolean;
524
-
525
- reactivate?:boolean;
526
- }
527
- export interface CreateForChargeItemsAndChargesResponse {
528
- quote:Quote;
529
-
530
- quoted_charge?:QuotedCharge;
587
+ notes?: string;
588
+ expires_at?: number;
589
+ mandatory_items_to_remove?: string[];
590
+ replace_items_list?: boolean;
591
+ billing_cycles?: number;
592
+ terms_to_charge?: number;
593
+ reactivate_from?: number;
594
+ billing_alignment_mode?: BillingAlignmentMode;
595
+ coupon_ids?: string[];
596
+ replace_coupon_list?: boolean;
597
+ change_option?: ChangeOption;
598
+ changes_scheduled_at?: number;
599
+ force_term_reset?: boolean;
600
+ reactivate?: boolean;
601
+ subscription?: SubscriptionEditUpdateSubscriptionQuoteForItemsInputParam;
602
+ billing_address?: BillingAddressEditUpdateSubscriptionQuoteForItemsInputParam;
603
+ shipping_address?: ShippingAddressEditUpdateSubscriptionQuoteForItemsInputParam;
604
+ customer?: CustomerEditUpdateSubscriptionQuoteForItemsInputParam;
605
+ contract_term?: ContractTermEditUpdateSubscriptionQuoteForItemsInputParam;
606
+ subscription_items?: SubscriptionItemsEditUpdateSubscriptionQuoteForItemsInputParam[];
607
+ discounts?: DiscountsEditUpdateSubscriptionQuoteForItemsInputParam[];
608
+ item_tiers?: ItemTiersEditUpdateSubscriptionQuoteForItemsInputParam[];
531
609
  }
532
610
  export interface CreateForChargeItemsAndChargesInputParam {
533
-
534
- shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
535
-
536
- item_prices?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
537
-
538
- item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
539
-
540
- charges?:{amount?:number,amount_in_decimal?:string,avalara_sale_type?:AvalaraSaleType,avalara_service_type?:number,avalara_transaction_type?:number,description?:string,service_period?:number}[];
541
-
542
- discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
543
-
544
- tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
545
-
546
- name?:string;
547
-
548
- customer_id:string;
549
-
550
- po_number?:string;
551
-
552
- notes?:string;
553
-
554
- expires_at?:number;
555
-
556
- currency_code?:string;
557
-
558
- coupon?:string;
559
-
560
- coupon_ids?:string[];
561
- }
562
- export interface EditForChargeItemsAndChargesResponse {
563
- quote:Quote;
564
-
565
- quoted_charge?:QuotedCharge;
611
+ name?: string;
612
+ customer_id: string;
613
+ po_number?: string;
614
+ notes?: string;
615
+ expires_at?: number;
616
+ currency_code?: string;
617
+ coupon?: string;
618
+ coupon_ids?: string[];
619
+ shipping_address?: ShippingAddressCreateForChargeItemsAndChargesInputParam;
620
+ item_prices?: ItemPricesCreateForChargeItemsAndChargesInputParam[];
621
+ item_tiers?: ItemTiersCreateForChargeItemsAndChargesInputParam[];
622
+ charges?: ChargesCreateForChargeItemsAndChargesInputParam[];
623
+ discounts?: DiscountsCreateForChargeItemsAndChargesInputParam[];
624
+ tax_providers_fields?: TaxProvidersFieldsCreateForChargeItemsAndChargesInputParam[];
566
625
  }
567
626
  export interface EditForChargeItemsAndChargesInputParam {
568
-
569
- shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
570
-
571
- item_prices?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
572
-
573
- item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
574
-
575
- charges?:{amount?:number,amount_in_decimal?:string,avalara_sale_type?:AvalaraSaleType,avalara_service_type?:number,avalara_transaction_type?:number,description?:string,service_period?:number}[];
576
-
577
- discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
578
-
579
- tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
580
-
581
- po_number?:string;
582
-
583
- notes?:string;
584
-
585
- expires_at?:number;
586
-
587
- currency_code?:string;
588
-
589
- coupon?:string;
590
-
591
- coupon_ids?:string[];
592
- }
593
- export interface ListResponse {
594
- list:{quote:Quote,quoted_subscription?:QuotedSubscription}[];
595
-
596
- next_offset?:string;
627
+ po_number?: string;
628
+ notes?: string;
629
+ expires_at?: number;
630
+ currency_code?: string;
631
+ coupon?: string;
632
+ coupon_ids?: string[];
633
+ shipping_address?: ShippingAddressEditForChargeItemsAndChargesInputParam;
634
+ item_prices?: ItemPricesEditForChargeItemsAndChargesInputParam[];
635
+ item_tiers?: ItemTiersEditForChargeItemsAndChargesInputParam[];
636
+ charges?: ChargesEditForChargeItemsAndChargesInputParam[];
637
+ discounts?: DiscountsEditForChargeItemsAndChargesInputParam[];
638
+ tax_providers_fields?: TaxProvidersFieldsEditForChargeItemsAndChargesInputParam[];
597
639
  }
598
640
  export interface ListInputParam {
599
- [key : string]: any;
600
- /**
601
- * @description The number of resources to be returned.
641
+ limit?: number;
642
+ offset?: string;
643
+ include_deleted?: boolean;
644
+ id?: filter.String;
645
+ customer_id?: filter.String;
646
+ subscription_id?: filter.String;
647
+ status?: filter.Enum;
648
+ date?: filter.Timestamp;
649
+ updated_at?: filter.Timestamp;
650
+ 'sort_by[asc]'?: string;
651
+ 'sort_by[desc]'?: string;
652
+ }
653
+ export interface QuoteLineGroupsForQuoteInputParam {
654
+ limit?: number;
655
+ offset?: string;
656
+ }
657
+ export interface ConvertInputParam {
658
+ invoice_date?: number;
659
+ create_pending_invoices?: boolean;
660
+ first_invoice_pending?: boolean;
661
+ subscription?: SubscriptionConvertInputParam;
662
+ }
663
+ export interface UpdateStatusInputParam {
664
+ status: 'accepted' | 'declined' | 'closed';
665
+ comment?: string;
666
+ }
667
+ export interface ExtendExpiryDateInputParam {
668
+ valid_till: number;
669
+ }
670
+ export interface DeleteInputParam {
671
+ comment?: string;
672
+ }
673
+ export interface PdfInputParam {
674
+ consolidated_view?: boolean;
675
+ disposition_type?: DispositionType;
676
+ }
677
+ export interface ShippingAddressCreateSubForCustomerQuoteInputParam {
678
+ first_name?: string;
679
+ last_name?: string;
680
+ email?: string;
681
+ company?: string;
682
+ phone?: string;
683
+ line1?: string;
684
+ line2?: string;
685
+ line3?: string;
686
+ city?: string;
687
+ state_code?: string;
688
+ state?: string;
689
+ zip?: string;
690
+ country?: string;
691
+ validation_status?: ValidationStatus;
692
+ }
693
+ export interface ContractTermCreateSubForCustomerQuoteInputParam {
694
+ action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
695
+ cancellation_cutoff_period?: number;
696
+ }
697
+ export interface SubscriptionCreateSubForCustomerQuoteInputParam {
698
+ id?: string;
699
+ po_number?: string;
700
+ plan_id: string;
701
+ plan_quantity?: number;
702
+ plan_quantity_in_decimal?: string;
703
+ plan_unit_price?: number;
704
+ plan_unit_price_in_decimal?: string;
705
+ setup_fee?: number;
706
+ trial_end?: number;
707
+ start_date?: number;
708
+ offline_payment_method?: OfflinePaymentMethod;
709
+ contract_term_billing_cycle_on_renewal?: number;
710
+ }
602
711
 
603
- */
604
-
605
- limit?:number;
606
-
607
- /**
608
- * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
712
+ export interface EventBasedAddonsCreateSubForCustomerQuoteInputParam {
713
+ id?: string;
714
+ quantity?: number;
715
+ unit_price?: number;
716
+ quantity_in_decimal?: string;
717
+ unit_price_in_decimal?: string;
718
+ service_period_in_days?: number;
719
+ on_event?: OnEvent;
720
+ charge_once?: boolean;
721
+ charge_on?: ChargeOn;
722
+ }
723
+ export interface AddonsCreateSubForCustomerQuoteInputParam {
724
+ id?: string;
725
+ quantity?: number;
726
+ quantity_in_decimal?: string;
727
+ unit_price?: number;
728
+ unit_price_in_decimal?: string;
729
+ billing_cycles?: number;
730
+ trial_end?: number;
731
+ }
732
+ export interface ShippingAddressEditCreateSubForCustomerQuoteInputParam {
733
+ first_name?: string;
734
+ last_name?: string;
735
+ email?: string;
736
+ company?: string;
737
+ phone?: string;
738
+ line1?: string;
739
+ line2?: string;
740
+ line3?: string;
741
+ city?: string;
742
+ state_code?: string;
743
+ state?: string;
744
+ zip?: string;
745
+ country?: string;
746
+ validation_status?: ValidationStatus;
747
+ }
748
+ export interface ContractTermEditCreateSubForCustomerQuoteInputParam {
749
+ action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
750
+ cancellation_cutoff_period?: number;
751
+ }
752
+ export interface SubscriptionEditCreateSubForCustomerQuoteInputParam {
753
+ id?: string;
754
+ po_number?: string;
755
+ plan_id: string;
756
+ plan_quantity?: number;
757
+ plan_quantity_in_decimal?: string;
758
+ plan_unit_price?: number;
759
+ plan_unit_price_in_decimal?: string;
760
+ setup_fee?: number;
761
+ trial_end?: number;
762
+ start_date?: number;
763
+ offline_payment_method?: OfflinePaymentMethod;
764
+ contract_term_billing_cycle_on_renewal?: number;
765
+ }
609
766
 
610
- */
611
-
612
- offset?:string;
613
-
767
+ export interface EventBasedAddonsEditCreateSubForCustomerQuoteInputParam {
768
+ id?: string;
769
+ quantity?: number;
770
+ unit_price?: number;
771
+ quantity_in_decimal?: string;
772
+ unit_price_in_decimal?: string;
773
+ service_period_in_days?: number;
774
+ on_event?: OnEvent;
775
+ charge_once?: boolean;
776
+ charge_on?: ChargeOn;
777
+ }
778
+ export interface AddonsEditCreateSubForCustomerQuoteInputParam {
779
+ id?: string;
780
+ quantity?: number;
781
+ quantity_in_decimal?: string;
782
+ unit_price?: number;
783
+ unit_price_in_decimal?: string;
784
+ billing_cycles?: number;
785
+ trial_end?: number;
786
+ }
787
+ export interface BillingAddressUpdateSubscriptionQuoteInputParam {
788
+ first_name?: string;
789
+ last_name?: string;
790
+ email?: string;
791
+ company?: string;
792
+ phone?: string;
793
+ line1?: string;
794
+ line2?: string;
795
+ line3?: string;
796
+ city?: string;
797
+ state_code?: string;
798
+ state?: string;
799
+ zip?: string;
800
+ country?: string;
801
+ validation_status?: ValidationStatus;
802
+ }
803
+ export interface CustomerUpdateSubscriptionQuoteInputParam {
804
+ vat_number?: string;
805
+ vat_number_prefix?: string;
806
+ registered_for_gst?: boolean;
807
+ }
808
+ export interface ShippingAddressUpdateSubscriptionQuoteInputParam {
809
+ first_name?: string;
810
+ last_name?: string;
811
+ email?: string;
812
+ company?: string;
813
+ phone?: string;
814
+ line1?: string;
815
+ line2?: string;
816
+ line3?: string;
817
+ city?: string;
818
+ state_code?: string;
819
+ state?: string;
820
+ zip?: string;
821
+ country?: string;
822
+ validation_status?: ValidationStatus;
823
+ }
824
+ export interface ContractTermUpdateSubscriptionQuoteInputParam {
825
+ action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
826
+ cancellation_cutoff_period?: number;
827
+ }
828
+ export interface SubscriptionUpdateSubscriptionQuoteInputParam {
829
+ id: string;
830
+ plan_id?: string;
831
+ plan_quantity?: number;
832
+ plan_unit_price?: number;
833
+ setup_fee?: number;
834
+ plan_quantity_in_decimal?: string;
835
+ plan_unit_price_in_decimal?: string;
836
+ start_date?: number;
837
+ trial_end?: number;
614
838
  /**
615
- * @description Indicates whether to include deleted objects in the list. The deleted objects have the attribute \&#x60;deleted\&#x60; as \&#x60;true\&#x60;.
839
+ * @deprecated Please refer API docs to use other attributes
840
+ */
841
+ coupon?: string;
842
+ auto_collection?: AutoCollection;
843
+ offline_payment_method?: OfflinePaymentMethod;
844
+ contract_term_billing_cycle_on_renewal?: number;
845
+ }
616
846
 
617
- */
618
-
619
- include_deleted?:boolean;
620
-
847
+ export interface EventBasedAddonsUpdateSubscriptionQuoteInputParam {
848
+ id?: string;
849
+ quantity?: number;
850
+ unit_price?: number;
851
+ service_period_in_days?: number;
852
+ charge_on?: ChargeOn;
853
+ on_event?: OnEvent;
854
+ charge_once?: boolean;
855
+ quantity_in_decimal?: string;
856
+ unit_price_in_decimal?: string;
857
+ }
858
+ export interface AddonsUpdateSubscriptionQuoteInputParam {
859
+ id?: string;
860
+ quantity?: number;
861
+ unit_price?: number;
862
+ billing_cycles?: number;
863
+ quantity_in_decimal?: string;
864
+ unit_price_in_decimal?: string;
865
+ trial_end?: number;
866
+ }
867
+ export interface BillingAddressEditUpdateSubscriptionQuoteInputParam {
868
+ first_name?: string;
869
+ last_name?: string;
870
+ email?: string;
871
+ company?: string;
872
+ phone?: string;
873
+ line1?: string;
874
+ line2?: string;
875
+ line3?: string;
876
+ city?: string;
877
+ state_code?: string;
878
+ state?: string;
879
+ zip?: string;
880
+ country?: string;
881
+ validation_status?: ValidationStatus;
882
+ }
883
+ export interface CustomerEditUpdateSubscriptionQuoteInputParam {
884
+ vat_number?: string;
885
+ vat_number_prefix?: string;
886
+ registered_for_gst?: boolean;
887
+ }
888
+ export interface ShippingAddressEditUpdateSubscriptionQuoteInputParam {
889
+ first_name?: string;
890
+ last_name?: string;
891
+ email?: string;
892
+ company?: string;
893
+ phone?: string;
894
+ line1?: string;
895
+ line2?: string;
896
+ line3?: string;
897
+ city?: string;
898
+ state_code?: string;
899
+ state?: string;
900
+ zip?: string;
901
+ country?: string;
902
+ validation_status?: ValidationStatus;
903
+ }
904
+ export interface ContractTermEditUpdateSubscriptionQuoteInputParam {
905
+ action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
906
+ cancellation_cutoff_period?: number;
907
+ }
908
+ export interface SubscriptionEditUpdateSubscriptionQuoteInputParam {
909
+ plan_id?: string;
910
+ plan_quantity?: number;
911
+ plan_unit_price?: number;
912
+ setup_fee?: number;
913
+ plan_quantity_in_decimal?: string;
914
+ plan_unit_price_in_decimal?: string;
915
+ start_date?: number;
916
+ trial_end?: number;
621
917
  /**
622
- * @description The quote number. Acts as a identifier for quote and typically generated sequentially.
918
+ * @deprecated Please refer API docs to use other attributes
919
+ */
920
+ coupon?: string;
921
+ auto_collection?: AutoCollection;
922
+ offline_payment_method?: OfflinePaymentMethod;
923
+ contract_term_billing_cycle_on_renewal?: number;
924
+ }
623
925
 
624
- */
625
-
626
- id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
627
-
628
- /**
629
- * @description The identifier of the customer this quote belongs to.
926
+ export interface EventBasedAddonsEditUpdateSubscriptionQuoteInputParam {
927
+ id?: string;
928
+ quantity?: number;
929
+ unit_price?: number;
930
+ service_period_in_days?: number;
931
+ charge_on?: ChargeOn;
932
+ on_event?: OnEvent;
933
+ charge_once?: boolean;
934
+ quantity_in_decimal?: string;
935
+ unit_price_in_decimal?: string;
936
+ }
937
+ export interface AddonsEditUpdateSubscriptionQuoteInputParam {
938
+ id?: string;
939
+ quantity?: number;
940
+ unit_price?: number;
941
+ billing_cycles?: number;
942
+ quantity_in_decimal?: string;
943
+ unit_price_in_decimal?: string;
944
+ trial_end?: number;
945
+ }
946
+ export interface ShippingAddressCreateForOnetimeChargesInputParam {
947
+ first_name?: string;
948
+ last_name?: string;
949
+ email?: string;
950
+ company?: string;
951
+ phone?: string;
952
+ line1?: string;
953
+ line2?: string;
954
+ line3?: string;
955
+ city?: string;
956
+ state_code?: string;
957
+ state?: string;
958
+ zip?: string;
959
+ country?: string;
960
+ validation_status?: ValidationStatus;
961
+ }
630
962
 
631
- */
632
-
633
- customer_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
634
-
635
- /**
636
- * @description To filter based on subscription_id.
637
- NOTE: Not to be used if *consolidated invoicing* feature is enabled.
963
+ export interface ChargesCreateForOnetimeChargesInputParam {
964
+ amount?: number;
965
+ amount_in_decimal?: string;
966
+ description?: string;
967
+ avalara_sale_type?: AvalaraSaleType;
968
+ avalara_transaction_type?: number;
969
+ avalara_service_type?: number;
970
+ service_period?: number;
971
+ }
972
+ export interface AddonsCreateForOnetimeChargesInputParam {
973
+ id?: string;
974
+ quantity?: number;
975
+ quantity_in_decimal?: string;
976
+ unit_price?: number;
977
+ unit_price_in_decimal?: string;
978
+ service_period?: number;
979
+ }
980
+ export interface TaxProvidersFieldsCreateForOnetimeChargesInputParam {
981
+ provider_name?: string;
982
+ field_id?: string;
983
+ field_value?: string;
984
+ }
985
+ export interface ShippingAddressEditOneTimeQuoteInputParam {
986
+ first_name?: string;
987
+ last_name?: string;
988
+ email?: string;
989
+ company?: string;
990
+ phone?: string;
991
+ line1?: string;
992
+ line2?: string;
993
+ line3?: string;
994
+ city?: string;
995
+ state_code?: string;
996
+ state?: string;
997
+ zip?: string;
998
+ country?: string;
999
+ validation_status?: ValidationStatus;
1000
+ }
638
1001
 
639
- */
640
-
641
- subscription_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string};
642
-
1002
+ export interface ChargesEditOneTimeQuoteInputParam {
1003
+ amount?: number;
1004
+ amount_in_decimal?: string;
1005
+ description?: string;
1006
+ avalara_sale_type?: AvalaraSaleType;
1007
+ avalara_transaction_type?: number;
1008
+ avalara_service_type?: number;
1009
+ service_period?: number;
1010
+ }
1011
+ export interface AddonsEditOneTimeQuoteInputParam {
1012
+ id?: string;
1013
+ quantity?: number;
1014
+ quantity_in_decimal?: string;
1015
+ unit_price?: number;
1016
+ unit_price_in_decimal?: string;
1017
+ service_period?: number;
1018
+ }
1019
+ export interface TaxProvidersFieldsEditOneTimeQuoteInputParam {
1020
+ provider_name?: string;
1021
+ field_id?: string;
1022
+ field_value?: string;
1023
+ }
1024
+ export interface ShippingAddressCreateSubItemsForCustomerQuoteInputParam {
1025
+ first_name?: string;
1026
+ last_name?: string;
1027
+ email?: string;
1028
+ company?: string;
1029
+ phone?: string;
1030
+ line1?: string;
1031
+ line2?: string;
1032
+ line3?: string;
1033
+ city?: string;
1034
+ state_code?: string;
1035
+ state?: string;
1036
+ zip?: string;
1037
+ country?: string;
1038
+ validation_status?: ValidationStatus;
1039
+ }
1040
+ export interface ContractTermCreateSubItemsForCustomerQuoteInputParam {
1041
+ action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
1042
+ cancellation_cutoff_period?: number;
1043
+ }
1044
+ export interface SubscriptionCreateSubItemsForCustomerQuoteInputParam {
1045
+ id?: string;
1046
+ po_number?: string;
1047
+ trial_end?: number;
643
1048
  /**
644
- * @description Current status of this quote.
1049
+ * @deprecated Please refer API docs to use other attributes
1050
+ */
1051
+ setup_fee?: number;
1052
+ start_date?: number;
1053
+ contract_term_billing_cycle_on_renewal?: number;
1054
+ }
645
1055
 
646
- */
647
-
648
- status?:{in?:string,is?:'open' | 'accepted' | 'declined' | 'invoiced' | 'closed',is_not?:'open' | 'accepted' | 'declined' | 'invoiced' | 'closed',not_in?:string};
649
-
1056
+ export interface SubscriptionItemsCreateSubItemsForCustomerQuoteInputParam {
1057
+ item_price_id: string;
1058
+ quantity?: number;
1059
+ quantity_in_decimal?: string;
1060
+ unit_price?: number;
1061
+ unit_price_in_decimal?: string;
1062
+ billing_cycles?: number;
1063
+ trial_end?: number;
1064
+ service_period_days?: number;
1065
+ charge_on_event?: ChargeOnEvent;
1066
+ charge_once?: boolean;
650
1067
  /**
651
- * @description Creation date of the quote. Typically this is the date on which quote is generated.
1068
+ * @deprecated Please refer API docs to use other attributes
1069
+ */
1070
+ item_type?: ItemType;
1071
+ charge_on_option?: ChargeOnOption;
1072
+ }
1073
+ export interface DiscountsCreateSubItemsForCustomerQuoteInputParam {
1074
+ apply_on: ApplyOn;
1075
+ duration_type: DurationType;
1076
+ percentage?: number;
1077
+ amount?: number;
1078
+ period?: number;
1079
+ period_unit?: PeriodUnit;
1080
+ included_in_mrr?: boolean;
1081
+ item_price_id?: string;
1082
+ }
1083
+ export interface ItemTiersCreateSubItemsForCustomerQuoteInputParam {
1084
+ item_price_id?: string;
1085
+ starting_unit?: number;
1086
+ ending_unit?: number;
1087
+ price?: number;
1088
+ starting_unit_in_decimal?: string;
1089
+ ending_unit_in_decimal?: string;
1090
+ price_in_decimal?: string;
1091
+ }
1092
+ export interface ShippingAddressEditCreateSubCustomerQuoteForItemsInputParam {
1093
+ first_name?: string;
1094
+ last_name?: string;
1095
+ email?: string;
1096
+ company?: string;
1097
+ phone?: string;
1098
+ line1?: string;
1099
+ line2?: string;
1100
+ line3?: string;
1101
+ city?: string;
1102
+ state_code?: string;
1103
+ state?: string;
1104
+ zip?: string;
1105
+ country?: string;
1106
+ validation_status?: ValidationStatus;
1107
+ }
1108
+ export interface ContractTermEditCreateSubCustomerQuoteForItemsInputParam {
1109
+ action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
1110
+ cancellation_cutoff_period?: number;
1111
+ }
1112
+ export interface SubscriptionEditCreateSubCustomerQuoteForItemsInputParam {
1113
+ id?: string;
1114
+ po_number?: string;
1115
+ trial_end?: number;
1116
+ /**
1117
+ * @deprecated Please refer API docs to use other attributes
1118
+ */
1119
+ setup_fee?: number;
1120
+ start_date?: number;
1121
+ contract_term_billing_cycle_on_renewal?: number;
1122
+ }
652
1123
 
653
- */
654
-
655
- date?:{after?:string,before?:string,between?:string,on?:string};
656
-
1124
+ export interface SubscriptionItemsEditCreateSubCustomerQuoteForItemsInputParam {
1125
+ item_price_id: string;
1126
+ quantity?: number;
1127
+ quantity_in_decimal?: string;
1128
+ unit_price?: number;
1129
+ unit_price_in_decimal?: string;
1130
+ billing_cycles?: number;
1131
+ trial_end?: number;
1132
+ service_period_days?: number;
1133
+ charge_on_event?: ChargeOnEvent;
1134
+ charge_once?: boolean;
657
1135
  /**
658
- * @description To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-09-28.
1136
+ * @deprecated Please refer API docs to use other attributes
1137
+ */
1138
+ item_type?: ItemType;
1139
+ charge_on_option?: ChargeOnOption;
1140
+ }
1141
+ export interface DiscountsEditCreateSubCustomerQuoteForItemsInputParam {
1142
+ apply_on: ApplyOn;
1143
+ duration_type: DurationType;
1144
+ percentage?: number;
1145
+ amount?: number;
1146
+ period?: number;
1147
+ period_unit?: PeriodUnit;
1148
+ included_in_mrr?: boolean;
1149
+ item_price_id?: string;
1150
+ }
1151
+ export interface ItemTiersEditCreateSubCustomerQuoteForItemsInputParam {
1152
+ item_price_id?: string;
1153
+ starting_unit?: number;
1154
+ ending_unit?: number;
1155
+ price?: number;
1156
+ starting_unit_in_decimal?: string;
1157
+ ending_unit_in_decimal?: string;
1158
+ price_in_decimal?: string;
1159
+ }
1160
+ export interface BillingAddressUpdateSubscriptionQuoteForItemsInputParam {
1161
+ first_name?: string;
1162
+ last_name?: string;
1163
+ email?: string;
1164
+ company?: string;
1165
+ phone?: string;
1166
+ line1?: string;
1167
+ line2?: string;
1168
+ line3?: string;
1169
+ city?: string;
1170
+ state_code?: string;
1171
+ state?: string;
1172
+ zip?: string;
1173
+ country?: string;
1174
+ validation_status?: ValidationStatus;
1175
+ }
1176
+ export interface CustomerUpdateSubscriptionQuoteForItemsInputParam {
1177
+ vat_number?: string;
1178
+ vat_number_prefix?: string;
1179
+ registered_for_gst?: boolean;
1180
+ }
1181
+ export interface ShippingAddressUpdateSubscriptionQuoteForItemsInputParam {
1182
+ first_name?: string;
1183
+ last_name?: string;
1184
+ email?: string;
1185
+ company?: string;
1186
+ phone?: string;
1187
+ line1?: string;
1188
+ line2?: string;
1189
+ line3?: string;
1190
+ city?: string;
1191
+ state_code?: string;
1192
+ state?: string;
1193
+ zip?: string;
1194
+ country?: string;
1195
+ validation_status?: ValidationStatus;
1196
+ }
1197
+ export interface ContractTermUpdateSubscriptionQuoteForItemsInputParam {
1198
+ action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
1199
+ cancellation_cutoff_period?: number;
1200
+ }
1201
+ export interface SubscriptionUpdateSubscriptionQuoteForItemsInputParam {
1202
+ id: string;
1203
+ /**
1204
+ * @deprecated Please refer API docs to use other attributes
1205
+ */
1206
+ setup_fee?: number;
1207
+ start_date?: number;
1208
+ trial_end?: number;
1209
+ /**
1210
+ * @deprecated Please refer API docs to use other attributes
1211
+ */
1212
+ coupon?: string;
1213
+ auto_collection?: AutoCollection;
1214
+ offline_payment_method?: OfflinePaymentMethod;
1215
+ contract_term_billing_cycle_on_renewal?: number;
1216
+ }
659
1217
 
660
- */
661
-
662
- updated_at?:{after?:string,before?:string,between?:string,on?:string};
663
-
664
- sort_by?:{asc?:'date',desc?:'date'};
1218
+ export interface SubscriptionItemsUpdateSubscriptionQuoteForItemsInputParam {
1219
+ item_price_id: string;
1220
+ quantity?: number;
1221
+ quantity_in_decimal?: string;
1222
+ unit_price?: number;
1223
+ unit_price_in_decimal?: string;
1224
+ billing_cycles?: number;
1225
+ trial_end?: number;
1226
+ service_period_days?: number;
1227
+ charge_on_event?: ChargeOnEvent;
1228
+ charge_once?: boolean;
1229
+ charge_on_option?: ChargeOnOption;
1230
+ /**
1231
+ * @deprecated Please refer API docs to use other attributes
1232
+ */
1233
+ item_type?: ItemType;
665
1234
  }
666
- export interface QuoteLineGroupsForQuoteResponse {
667
- list:{quote_line_group:QuoteLineGroup}[];
668
-
669
- next_offset?:string;
1235
+ export interface DiscountsUpdateSubscriptionQuoteForItemsInputParam {
1236
+ apply_on: ApplyOn;
1237
+ duration_type: DurationType;
1238
+ percentage?: number;
1239
+ amount?: number;
1240
+ period?: number;
1241
+ period_unit?: PeriodUnit;
1242
+ included_in_mrr?: boolean;
1243
+ item_price_id?: string;
1244
+ operation_type: OperationType;
1245
+ id?: string;
670
1246
  }
671
- export interface QuoteLineGroupsForQuoteInputParam {
672
- [key : string]: any;
1247
+ export interface ItemTiersUpdateSubscriptionQuoteForItemsInputParam {
1248
+ item_price_id?: string;
1249
+ starting_unit?: number;
1250
+ ending_unit?: number;
1251
+ price?: number;
1252
+ starting_unit_in_decimal?: string;
1253
+ ending_unit_in_decimal?: string;
1254
+ price_in_decimal?: string;
1255
+ }
1256
+ export interface BillingAddressEditUpdateSubscriptionQuoteForItemsInputParam {
1257
+ first_name?: string;
1258
+ last_name?: string;
1259
+ email?: string;
1260
+ company?: string;
1261
+ phone?: string;
1262
+ line1?: string;
1263
+ line2?: string;
1264
+ line3?: string;
1265
+ city?: string;
1266
+ state_code?: string;
1267
+ state?: string;
1268
+ zip?: string;
1269
+ country?: string;
1270
+ validation_status?: ValidationStatus;
1271
+ }
1272
+ export interface CustomerEditUpdateSubscriptionQuoteForItemsInputParam {
1273
+ vat_number?: string;
1274
+ vat_number_prefix?: string;
1275
+ registered_for_gst?: boolean;
1276
+ }
1277
+ export interface ShippingAddressEditUpdateSubscriptionQuoteForItemsInputParam {
1278
+ first_name?: string;
1279
+ last_name?: string;
1280
+ email?: string;
1281
+ company?: string;
1282
+ phone?: string;
1283
+ line1?: string;
1284
+ line2?: string;
1285
+ line3?: string;
1286
+ city?: string;
1287
+ state_code?: string;
1288
+ state?: string;
1289
+ zip?: string;
1290
+ country?: string;
1291
+ validation_status?: ValidationStatus;
1292
+ }
1293
+ export interface ContractTermEditUpdateSubscriptionQuoteForItemsInputParam {
1294
+ action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
1295
+ cancellation_cutoff_period?: number;
1296
+ }
1297
+ export interface SubscriptionEditUpdateSubscriptionQuoteForItemsInputParam {
673
1298
  /**
674
- * @description The number of resources to be returned.
1299
+ * @deprecated Please refer API docs to use other attributes
1300
+ */
1301
+ setup_fee?: number;
1302
+ start_date?: number;
1303
+ trial_end?: number;
1304
+ /**
1305
+ * @deprecated Please refer API docs to use other attributes
1306
+ */
1307
+ coupon?: string;
1308
+ auto_collection?: AutoCollection;
1309
+ offline_payment_method?: OfflinePaymentMethod;
1310
+ contract_term_billing_cycle_on_renewal?: number;
1311
+ }
675
1312
 
676
- */
677
-
678
- limit?:number;
679
-
1313
+ export interface SubscriptionItemsEditUpdateSubscriptionQuoteForItemsInputParam {
1314
+ item_price_id: string;
1315
+ quantity?: number;
1316
+ quantity_in_decimal?: string;
1317
+ unit_price?: number;
1318
+ unit_price_in_decimal?: string;
1319
+ billing_cycles?: number;
1320
+ trial_end?: number;
1321
+ service_period_days?: number;
1322
+ charge_on_event?: ChargeOnEvent;
1323
+ charge_once?: boolean;
1324
+ charge_on_option?: ChargeOnOption;
680
1325
  /**
681
- * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
682
-
683
- */
684
-
685
- offset?:string;
686
- }
687
- export interface ConvertResponse {
688
- quote:Quote;
689
-
690
- quoted_subscription?:QuotedSubscription;
691
-
692
- quoted_charge?:QuotedCharge;
693
-
694
- customer:Customer;
695
-
696
- subscription?:Subscription;
697
-
698
- invoice?:Invoice;
699
-
700
- credit_note?:CreditNote;
701
-
702
- unbilled_charges?:UnbilledCharge[];
1326
+ * @deprecated Please refer API docs to use other attributes
1327
+ */
1328
+ item_type?: ItemType;
703
1329
  }
704
- export interface ConvertInputParam {
705
-
706
- subscription?:{auto_close_invoices?:boolean,auto_collection?:AutoCollection,id?:string,po_number?:string};
707
-
708
- invoice_date?:number;
709
-
710
- create_pending_invoices?:boolean;
711
-
712
- first_invoice_pending?:boolean;
713
- }
714
- export interface UpdateStatusResponse {
715
- quote:Quote;
716
-
717
- quoted_subscription?:QuotedSubscription;
718
-
719
- quoted_charge?:QuotedCharge;
1330
+ export interface DiscountsEditUpdateSubscriptionQuoteForItemsInputParam {
1331
+ apply_on: ApplyOn;
1332
+ duration_type: DurationType;
1333
+ percentage?: number;
1334
+ amount?: number;
1335
+ period?: number;
1336
+ period_unit?: PeriodUnit;
1337
+ included_in_mrr?: boolean;
1338
+ item_price_id?: string;
1339
+ operation_type: OperationType;
1340
+ id?: string;
720
1341
  }
721
- export interface UpdateStatusInputParam {
722
-
723
- status:'accepted' | 'declined' | 'closed';
724
-
725
- comment?:string;
726
- }
727
- export interface ExtendExpiryDateResponse {
728
- quote:Quote;
729
-
730
- quoted_subscription?:QuotedSubscription;
731
-
732
- quoted_charge?:QuotedCharge;
1342
+ export interface ItemTiersEditUpdateSubscriptionQuoteForItemsInputParam {
1343
+ item_price_id?: string;
1344
+ starting_unit?: number;
1345
+ ending_unit?: number;
1346
+ price?: number;
1347
+ starting_unit_in_decimal?: string;
1348
+ ending_unit_in_decimal?: string;
1349
+ price_in_decimal?: string;
733
1350
  }
734
- export interface ExtendExpiryDateInputParam {
735
-
736
- valid_till:number;
1351
+ export interface ShippingAddressCreateForChargeItemsAndChargesInputParam {
1352
+ first_name?: string;
1353
+ last_name?: string;
1354
+ email?: string;
1355
+ company?: string;
1356
+ phone?: string;
1357
+ line1?: string;
1358
+ line2?: string;
1359
+ line3?: string;
1360
+ city?: string;
1361
+ state_code?: string;
1362
+ state?: string;
1363
+ zip?: string;
1364
+ country?: string;
1365
+ validation_status?: ValidationStatus;
737
1366
  }
738
- export interface DeleteResponse {
739
- quote:Quote;
740
-
741
- quoted_subscription?:QuotedSubscription;
742
-
743
- quoted_charge?:QuotedCharge;
1367
+
1368
+ export interface ChargesCreateForChargeItemsAndChargesInputParam {
1369
+ amount?: number;
1370
+ amount_in_decimal?: string;
1371
+ description?: string;
1372
+ avalara_sale_type?: AvalaraSaleType;
1373
+ avalara_transaction_type?: number;
1374
+ avalara_service_type?: number;
1375
+ service_period?: number;
744
1376
  }
745
- export interface DeleteInputParam {
746
-
747
- comment?:string;
1377
+ export interface DiscountsCreateForChargeItemsAndChargesInputParam {
1378
+ percentage?: number;
1379
+ amount?: number;
1380
+ apply_on: ApplyOn;
1381
+ item_price_id?: string;
748
1382
  }
749
- export interface PdfResponse {
750
- download:Download;
1383
+ export interface ItemTiersCreateForChargeItemsAndChargesInputParam {
1384
+ item_price_id?: string;
1385
+ starting_unit?: number;
1386
+ ending_unit?: number;
1387
+ price?: number;
1388
+ starting_unit_in_decimal?: string;
1389
+ ending_unit_in_decimal?: string;
1390
+ price_in_decimal?: string;
751
1391
  }
752
- export interface PdfInputParam {
753
-
754
- consolidated_view?:boolean;
755
-
756
- disposition_type?:DispositionType;
757
- }
758
- export interface LineItem {
759
- id?:string;
760
-
761
- subscription_id?:string;
762
-
763
- date_from:number;
764
-
765
- date_to:number;
766
-
767
- unit_amount:number;
768
-
769
- quantity?:number;
770
-
771
- amount?:number;
772
-
773
- pricing_model?:'flat_fee' | 'per_unit' | 'tiered' | 'volume' | 'stairstep';
774
-
775
- is_taxed:boolean;
776
-
777
- tax_amount?:number;
778
-
779
- tax_rate?:number;
780
-
781
- unit_amount_in_decimal?:string;
782
-
783
- quantity_in_decimal?:string;
784
-
785
- amount_in_decimal?:string;
786
-
787
- discount_amount?:number;
788
-
789
- item_level_discount_amount?:number;
790
-
791
- usage_percentage?:string;
792
-
793
- reference_line_item_id?:string;
794
-
795
- description:string;
796
-
797
- entity_description?:string;
798
-
799
- entity_type:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'plan_setup' | 'plan' | 'addon';
800
-
801
- tax_exempt_reason?:'tax_not_configured' | 'region_non_taxable' | 'export' | 'customer_exempt' | 'product_exempt' | 'zero_rated' | 'reverse_charge' | 'high_value_physical_goods' | 'zero_value_item' | 'tax_not_configured_external_provider';
802
-
803
- entity_id?:string;
804
-
805
- customer_id?:string;
806
- }
807
- export interface Discount {
808
- amount:number;
809
-
810
- description?:string;
811
-
812
- entity_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
813
-
814
- entity_id?:string;
815
-
816
- coupon_set_code?:string;
817
- }
818
- export interface LineItemDiscount {
819
- line_item_id:string;
820
-
821
- discount_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
822
-
823
- coupon_id?:string;
824
-
825
- entity_id?:string;
826
-
827
- discount_amount:number;
828
- }
829
- export interface Tax {
830
- name:string;
831
-
832
- amount:number;
833
-
834
- description?:string;
835
- }
836
- export interface LineItemTax {
837
- line_item_id?:string;
838
-
839
- tax_name:string;
840
-
841
- tax_rate:number;
842
-
843
- date_to?:number;
844
-
845
- date_from?:number;
846
-
847
- prorated_taxable_amount?:number;
848
-
849
- is_partial_tax_applied?:boolean;
850
-
851
- is_non_compliance_tax?:boolean;
852
-
853
- taxable_amount:number;
854
-
855
- tax_amount:number;
856
-
857
- tax_juris_type?:'country' | 'federal' | 'state' | 'county' | 'city' | 'special' | 'unincorporated' | 'other';
858
-
859
- tax_juris_name?:string;
860
-
861
- tax_juris_code?:string;
862
-
863
- tax_amount_in_local_currency?:number;
864
-
865
- local_currency_code?:string;
866
- }
867
- export interface LineItemTier {
868
- line_item_id?:string;
869
-
870
- starting_unit:number;
871
-
872
- ending_unit?:number;
873
-
874
- quantity_used:number;
875
-
876
- unit_amount:number;
877
-
878
- starting_unit_in_decimal?:string;
879
-
880
- ending_unit_in_decimal?:string;
881
-
882
- quantity_used_in_decimal?:string;
883
-
884
- unit_amount_in_decimal?:string;
885
- }
886
- export interface ShippingAddress {
887
- first_name?:string;
888
-
889
- last_name?:string;
890
-
891
- email?:string;
892
-
893
- company?:string;
894
-
895
- phone?:string;
896
-
897
- line1?:string;
898
-
899
- line2?:string;
900
-
901
- line3?:string;
902
-
903
- city?:string;
904
-
905
- state_code?:string;
906
-
907
- state?:string;
908
-
909
- country?:string;
910
-
911
- zip?:string;
912
-
913
- validation_status?:ValidationStatus;
914
-
915
- index:number;
916
- }
917
- export interface BillingAddress {
918
- first_name?:string;
919
-
920
- last_name?:string;
921
-
922
- email?:string;
923
-
924
- company?:string;
925
-
926
- phone?:string;
927
-
928
- line1?:string;
929
-
930
- line2?:string;
931
-
932
- line3?:string;
933
-
934
- city?:string;
935
-
936
- state_code?:string;
937
-
938
- state?:string;
939
-
940
- country?:string;
941
-
942
- zip?:string;
943
-
944
- validation_status?:ValidationStatus;
1392
+ export interface ItemPricesCreateForChargeItemsAndChargesInputParam {
1393
+ item_price_id?: string;
1394
+ quantity?: number;
1395
+ quantity_in_decimal?: string;
1396
+ unit_price?: number;
1397
+ unit_price_in_decimal?: string;
1398
+ service_period_days?: number;
1399
+ }
1400
+ export interface TaxProvidersFieldsCreateForChargeItemsAndChargesInputParam {
1401
+ provider_name?: string;
1402
+ field_id?: string;
1403
+ field_value?: string;
1404
+ }
1405
+ export interface ShippingAddressEditForChargeItemsAndChargesInputParam {
1406
+ first_name?: string;
1407
+ last_name?: string;
1408
+ email?: string;
1409
+ company?: string;
1410
+ phone?: string;
1411
+ line1?: string;
1412
+ line2?: string;
1413
+ line3?: string;
1414
+ city?: string;
1415
+ state_code?: string;
1416
+ state?: string;
1417
+ zip?: string;
1418
+ country?: string;
1419
+ validation_status?: ValidationStatus;
1420
+ }
1421
+
1422
+ export interface ChargesEditForChargeItemsAndChargesInputParam {
1423
+ amount?: number;
1424
+ amount_in_decimal?: string;
1425
+ description?: string;
1426
+ avalara_sale_type?: AvalaraSaleType;
1427
+ avalara_transaction_type?: number;
1428
+ avalara_service_type?: number;
1429
+ service_period?: number;
1430
+ }
1431
+ export interface DiscountsEditForChargeItemsAndChargesInputParam {
1432
+ percentage?: number;
1433
+ amount?: number;
1434
+ apply_on: ApplyOn;
1435
+ item_price_id?: string;
1436
+ }
1437
+ export interface ItemTiersEditForChargeItemsAndChargesInputParam {
1438
+ item_price_id?: string;
1439
+ starting_unit?: number;
1440
+ ending_unit?: number;
1441
+ price?: number;
1442
+ starting_unit_in_decimal?: string;
1443
+ ending_unit_in_decimal?: string;
1444
+ price_in_decimal?: string;
1445
+ }
1446
+ export interface ItemPricesEditForChargeItemsAndChargesInputParam {
1447
+ item_price_id?: string;
1448
+ quantity?: number;
1449
+ quantity_in_decimal?: string;
1450
+ unit_price?: number;
1451
+ unit_price_in_decimal?: string;
1452
+ service_period_days?: number;
1453
+ }
1454
+ export interface TaxProvidersFieldsEditForChargeItemsAndChargesInputParam {
1455
+ provider_name?: string;
1456
+ field_id?: string;
1457
+ field_value?: string;
1458
+ }
1459
+ export interface SubscriptionConvertInputParam {
1460
+ id?: string;
1461
+ auto_collection?: AutoCollection;
1462
+ po_number?: string;
1463
+ auto_close_invoices?: boolean;
945
1464
  }
946
1465
  }
947
- }
1466
+ }