chargebee 3.0.0 → 3.0.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 (82) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/README.md +5 -5
  3. package/cjs/environment.js +1 -1
  4. package/esm/environment.js +1 -1
  5. package/package.json +1 -1
  6. package/types/core.d.ts +574 -0
  7. package/types/index.d.ts +167 -0
  8. package/types/resources/Address.d.ts +71 -0
  9. package/types/resources/AdvanceInvoiceSchedule.d.ts +29 -0
  10. package/types/resources/AttachedItem.d.ts +114 -0
  11. package/types/resources/Attribute.d.ts +9 -0
  12. package/types/resources/BusinessEntity.d.ts +64 -0
  13. package/types/resources/BusinessEntityTransfer.d.ts +15 -0
  14. package/types/resources/Card.d.ts +171 -0
  15. package/types/resources/Comment.d.ts +89 -0
  16. package/types/resources/Contact.d.ts +16 -0
  17. package/types/resources/ContractTerm.d.ts +19 -0
  18. package/types/resources/Coupon.d.ts +314 -0
  19. package/types/resources/CouponCode.d.ts +70 -0
  20. package/types/resources/CouponSet.d.ts +111 -0
  21. package/types/resources/CreditNote.d.ts +628 -0
  22. package/types/resources/CreditNoteEstimate.d.ts +143 -0
  23. package/types/resources/Currency.d.ts +91 -0
  24. package/types/resources/Customer.d.ts +962 -0
  25. package/types/resources/CustomerEntitlement.d.ts +36 -0
  26. package/types/resources/DifferentialPrice.d.ts +142 -0
  27. package/types/resources/Discount.d.ts +24 -0
  28. package/types/resources/Download.d.ts +10 -0
  29. package/types/resources/Entitlement.d.ts +66 -0
  30. package/types/resources/EntitlementOverride.d.ts +76 -0
  31. package/types/resources/Estimate.d.ts +1237 -0
  32. package/types/resources/Event.d.ts +81 -0
  33. package/types/resources/Export.d.ts +607 -0
  34. package/types/resources/Feature.d.ts +142 -0
  35. package/types/resources/GatewayErrorDetail.d.ts +20 -0
  36. package/types/resources/Gift.d.ts +296 -0
  37. package/types/resources/Hierarchy.d.ts +12 -0
  38. package/types/resources/HostedPage.d.ts +1112 -0
  39. package/types/resources/ImpactedItem.d.ts +20 -0
  40. package/types/resources/ImpactedItemPrice.d.ts +20 -0
  41. package/types/resources/ImpactedSubscription.d.ts +20 -0
  42. package/types/resources/InAppSubscription.d.ts +116 -0
  43. package/types/resources/Invoice.d.ts +1691 -0
  44. package/types/resources/InvoiceEstimate.d.ts +143 -0
  45. package/types/resources/Item.d.ts +204 -0
  46. package/types/resources/ItemEntitlement.d.ts +103 -0
  47. package/types/resources/ItemFamily.d.ts +89 -0
  48. package/types/resources/ItemPrice.d.ts +328 -0
  49. package/types/resources/Metadata.d.ts +8 -0
  50. package/types/resources/NonSubscription.d.ts +48 -0
  51. package/types/resources/Order.d.ts +586 -0
  52. package/types/resources/PaymentIntent.d.ts +178 -0
  53. package/types/resources/PaymentReferenceNumber.d.ts +11 -0
  54. package/types/resources/PaymentSchedule.d.ts +28 -0
  55. package/types/resources/PaymentScheduleEstimate.d.ts +25 -0
  56. package/types/resources/PaymentScheduleScheme.d.ts +62 -0
  57. package/types/resources/PaymentSource.d.ts +529 -0
  58. package/types/resources/PaymentVoucher.d.ts +107 -0
  59. package/types/resources/PortalSession.d.ts +88 -0
  60. package/types/resources/PriceVariant.d.ts +112 -0
  61. package/types/resources/PricingPageSession.d.ts +130 -0
  62. package/types/resources/PromotionalCredit.d.ts +111 -0
  63. package/types/resources/Purchase.d.ts +202 -0
  64. package/types/resources/Quote.d.ts +1467 -0
  65. package/types/resources/QuoteLineGroup.d.ts +136 -0
  66. package/types/resources/QuotedCharge.d.ts +56 -0
  67. package/types/resources/QuotedSubscription.d.ts +114 -0
  68. package/types/resources/Ramp.d.ts +260 -0
  69. package/types/resources/ResourceMigration.d.ts +36 -0
  70. package/types/resources/SiteMigrationDetail.d.ts +46 -0
  71. package/types/resources/Subscription.d.ts +2443 -0
  72. package/types/resources/SubscriptionEntitlement.d.ts +79 -0
  73. package/types/resources/SubscriptionEstimate.d.ts +59 -0
  74. package/types/resources/TaxWithheld.d.ts +19 -0
  75. package/types/resources/ThirdPartyPaymentMethod.d.ts +11 -0
  76. package/types/resources/TimeMachine.d.ts +57 -0
  77. package/types/resources/Token.d.ts +19 -0
  78. package/types/resources/Transaction.d.ts +313 -0
  79. package/types/resources/UnbilledCharge.d.ts +209 -0
  80. package/types/resources/Usage.d.ts +113 -0
  81. package/types/resources/VirtualBankAccount.d.ts +125 -0
  82. package/types/resources/filter.d.ts +52 -0
@@ -0,0 +1,1467 @@
1
+ ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
3
+ ///<reference path='./filter.d.ts'/>
4
+ declare module 'chargebee' {
5
+ export interface Quote {
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: PriceTypeEnum;
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;
47
+ }
48
+
49
+ export namespace Quote {
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;
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?: ValidationStatusEnum;
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?: ValidationStatusEnum;
424
+ }
425
+ // REQUEST PARAMS
426
+ //---------------
427
+
428
+ export interface CreateSubForCustomerQuoteInputParam {
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?: BillingAlignmentModeEnum;
436
+ coupon_ids?: string[];
437
+ subscription?: SubscriptionCreateSubForCustomerQuoteInputParam;
438
+ shipping_address?: ShippingAddressCreateSubForCustomerQuoteInputParam;
439
+ contract_term?: ContractTermCreateSubForCustomerQuoteInputParam;
440
+ addons?: AddonsCreateSubForCustomerQuoteInputParam[];
441
+ event_based_addons?: EventBasedAddonsCreateSubForCustomerQuoteInputParam[];
442
+ }
443
+ export interface EditCreateSubForCustomerQuoteInputParam {
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?: BillingAlignmentModeEnum;
450
+ coupon_ids?: string[];
451
+ subscription?: SubscriptionEditCreateSubForCustomerQuoteInputParam;
452
+ shipping_address?: ShippingAddressEditCreateSubForCustomerQuoteInputParam;
453
+ contract_term?: ContractTermEditCreateSubForCustomerQuoteInputParam;
454
+ addons?: AddonsEditCreateSubForCustomerQuoteInputParam[];
455
+ event_based_addons?: EventBasedAddonsEditCreateSubForCustomerQuoteInputParam[];
456
+ }
457
+ export interface UpdateSubscriptionQuoteInputParam {
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?: BillingAlignmentModeEnum;
467
+ coupon_ids?: string[];
468
+ replace_coupon_list?: boolean;
469
+ change_option?: ChangeOptionEnum;
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[];
480
+ }
481
+ export interface EditUpdateSubscriptionQuoteInputParam {
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?: BillingAlignmentModeEnum;
490
+ coupon_ids?: string[];
491
+ replace_coupon_list?: boolean;
492
+ change_option?: ChangeOptionEnum;
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[];
503
+ }
504
+ export interface CreateForOnetimeChargesInputParam {
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[];
517
+ }
518
+ export interface EditOneTimeQuoteInputParam {
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[];
529
+ }
530
+ export interface CreateSubItemsForCustomerQuoteInputParam {
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?: BillingAlignmentModeEnum;
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[];
545
+ }
546
+ export interface EditCreateSubCustomerQuoteForItemsInputParam {
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?: BillingAlignmentModeEnum;
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[];
560
+ }
561
+ export interface UpdateSubscriptionQuoteForItemsInputParam {
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?: BillingAlignmentModeEnum;
571
+ coupon_ids?: string[];
572
+ replace_coupon_list?: boolean;
573
+ change_option?: ChangeOptionEnum;
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[];
585
+ }
586
+ export interface EditUpdateSubscriptionQuoteForItemsInputParam {
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?: BillingAlignmentModeEnum;
595
+ coupon_ids?: string[];
596
+ replace_coupon_list?: boolean;
597
+ change_option?: ChangeOptionEnum;
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[];
609
+ }
610
+ export interface CreateForChargeItemsAndChargesInputParam {
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[];
625
+ }
626
+ export interface EditForChargeItemsAndChargesInputParam {
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[];
639
+ }
640
+ export interface ListInputParam {
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
+ invoice_immediately?: boolean;
660
+ create_pending_invoices?: boolean;
661
+ first_invoice_pending?: boolean;
662
+ subscription?: SubscriptionConvertInputParam;
663
+ }
664
+ export interface UpdateStatusInputParam {
665
+ status: 'accepted' | 'declined' | 'closed';
666
+ comment?: string;
667
+ }
668
+ export interface ExtendExpiryDateInputParam {
669
+ valid_till: number;
670
+ }
671
+ export interface DeleteInputParam {
672
+ comment?: string;
673
+ }
674
+ export interface PdfInputParam {
675
+ consolidated_view?: boolean;
676
+ disposition_type?: DispositionTypeEnum;
677
+ }
678
+ export interface ShippingAddressCreateSubForCustomerQuoteInputParam {
679
+ first_name?: string;
680
+ last_name?: string;
681
+ email?: string;
682
+ company?: string;
683
+ phone?: string;
684
+ line1?: string;
685
+ line2?: string;
686
+ line3?: string;
687
+ city?: string;
688
+ state_code?: string;
689
+ state?: string;
690
+ zip?: string;
691
+ country?: string;
692
+ validation_status?: ValidationStatusEnum;
693
+ }
694
+ export interface ContractTermCreateSubForCustomerQuoteInputParam {
695
+ action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
696
+ cancellation_cutoff_period?: number;
697
+ }
698
+ export interface SubscriptionCreateSubForCustomerQuoteInputParam {
699
+ id?: string;
700
+ po_number?: string;
701
+ plan_id: string;
702
+ plan_quantity?: number;
703
+ plan_quantity_in_decimal?: string;
704
+ plan_unit_price?: number;
705
+ plan_unit_price_in_decimal?: string;
706
+ setup_fee?: number;
707
+ trial_end?: number;
708
+ start_date?: number;
709
+ offline_payment_method?: OfflinePaymentMethodEnum;
710
+ contract_term_billing_cycle_on_renewal?: number;
711
+ }
712
+
713
+ export interface EventBasedAddonsCreateSubForCustomerQuoteInputParam {
714
+ id?: string;
715
+ quantity?: number;
716
+ unit_price?: number;
717
+ quantity_in_decimal?: string;
718
+ unit_price_in_decimal?: string;
719
+ service_period_in_days?: number;
720
+ on_event?: OnEventEnum;
721
+ charge_once?: boolean;
722
+ charge_on?: ChargeOnEnum;
723
+ }
724
+ export interface AddonsCreateSubForCustomerQuoteInputParam {
725
+ id?: string;
726
+ quantity?: number;
727
+ quantity_in_decimal?: string;
728
+ unit_price?: number;
729
+ unit_price_in_decimal?: string;
730
+ billing_cycles?: number;
731
+ trial_end?: number;
732
+ }
733
+ export interface ShippingAddressEditCreateSubForCustomerQuoteInputParam {
734
+ first_name?: string;
735
+ last_name?: string;
736
+ email?: string;
737
+ company?: string;
738
+ phone?: string;
739
+ line1?: string;
740
+ line2?: string;
741
+ line3?: string;
742
+ city?: string;
743
+ state_code?: string;
744
+ state?: string;
745
+ zip?: string;
746
+ country?: string;
747
+ validation_status?: ValidationStatusEnum;
748
+ }
749
+ export interface ContractTermEditCreateSubForCustomerQuoteInputParam {
750
+ action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
751
+ cancellation_cutoff_period?: number;
752
+ }
753
+ export interface SubscriptionEditCreateSubForCustomerQuoteInputParam {
754
+ id?: string;
755
+ po_number?: string;
756
+ plan_id: string;
757
+ plan_quantity?: number;
758
+ plan_quantity_in_decimal?: string;
759
+ plan_unit_price?: number;
760
+ plan_unit_price_in_decimal?: string;
761
+ setup_fee?: number;
762
+ trial_end?: number;
763
+ start_date?: number;
764
+ offline_payment_method?: OfflinePaymentMethodEnum;
765
+ contract_term_billing_cycle_on_renewal?: number;
766
+ }
767
+
768
+ export interface EventBasedAddonsEditCreateSubForCustomerQuoteInputParam {
769
+ id?: string;
770
+ quantity?: number;
771
+ unit_price?: number;
772
+ quantity_in_decimal?: string;
773
+ unit_price_in_decimal?: string;
774
+ service_period_in_days?: number;
775
+ on_event?: OnEventEnum;
776
+ charge_once?: boolean;
777
+ charge_on?: ChargeOnEnum;
778
+ }
779
+ export interface AddonsEditCreateSubForCustomerQuoteInputParam {
780
+ id?: string;
781
+ quantity?: number;
782
+ quantity_in_decimal?: string;
783
+ unit_price?: number;
784
+ unit_price_in_decimal?: string;
785
+ billing_cycles?: number;
786
+ trial_end?: number;
787
+ }
788
+ export interface BillingAddressUpdateSubscriptionQuoteInputParam {
789
+ first_name?: string;
790
+ last_name?: string;
791
+ email?: string;
792
+ company?: string;
793
+ phone?: string;
794
+ line1?: string;
795
+ line2?: string;
796
+ line3?: string;
797
+ city?: string;
798
+ state_code?: string;
799
+ state?: string;
800
+ zip?: string;
801
+ country?: string;
802
+ validation_status?: ValidationStatusEnum;
803
+ }
804
+ export interface CustomerUpdateSubscriptionQuoteInputParam {
805
+ vat_number?: string;
806
+ vat_number_prefix?: string;
807
+ registered_for_gst?: boolean;
808
+ }
809
+ export interface ShippingAddressUpdateSubscriptionQuoteInputParam {
810
+ first_name?: string;
811
+ last_name?: string;
812
+ email?: string;
813
+ company?: string;
814
+ phone?: string;
815
+ line1?: string;
816
+ line2?: string;
817
+ line3?: string;
818
+ city?: string;
819
+ state_code?: string;
820
+ state?: string;
821
+ zip?: string;
822
+ country?: string;
823
+ validation_status?: ValidationStatusEnum;
824
+ }
825
+ export interface ContractTermUpdateSubscriptionQuoteInputParam {
826
+ action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
827
+ cancellation_cutoff_period?: number;
828
+ }
829
+ export interface SubscriptionUpdateSubscriptionQuoteInputParam {
830
+ id: string;
831
+ plan_id?: string;
832
+ plan_quantity?: number;
833
+ plan_unit_price?: number;
834
+ setup_fee?: number;
835
+ plan_quantity_in_decimal?: string;
836
+ plan_unit_price_in_decimal?: string;
837
+ start_date?: number;
838
+ trial_end?: number;
839
+ /**
840
+ * @deprecated Please refer API docs to use other attributes
841
+ */
842
+ coupon?: string;
843
+ auto_collection?: AutoCollectionEnum;
844
+ offline_payment_method?: OfflinePaymentMethodEnum;
845
+ contract_term_billing_cycle_on_renewal?: number;
846
+ }
847
+
848
+ export interface EventBasedAddonsUpdateSubscriptionQuoteInputParam {
849
+ id?: string;
850
+ quantity?: number;
851
+ unit_price?: number;
852
+ service_period_in_days?: number;
853
+ charge_on?: ChargeOnEnum;
854
+ on_event?: OnEventEnum;
855
+ charge_once?: boolean;
856
+ quantity_in_decimal?: string;
857
+ unit_price_in_decimal?: string;
858
+ }
859
+ export interface AddonsUpdateSubscriptionQuoteInputParam {
860
+ id?: string;
861
+ quantity?: number;
862
+ unit_price?: number;
863
+ billing_cycles?: number;
864
+ quantity_in_decimal?: string;
865
+ unit_price_in_decimal?: string;
866
+ trial_end?: number;
867
+ }
868
+ export interface BillingAddressEditUpdateSubscriptionQuoteInputParam {
869
+ first_name?: string;
870
+ last_name?: string;
871
+ email?: string;
872
+ company?: string;
873
+ phone?: string;
874
+ line1?: string;
875
+ line2?: string;
876
+ line3?: string;
877
+ city?: string;
878
+ state_code?: string;
879
+ state?: string;
880
+ zip?: string;
881
+ country?: string;
882
+ validation_status?: ValidationStatusEnum;
883
+ }
884
+ export interface CustomerEditUpdateSubscriptionQuoteInputParam {
885
+ vat_number?: string;
886
+ vat_number_prefix?: string;
887
+ registered_for_gst?: boolean;
888
+ }
889
+ export interface ShippingAddressEditUpdateSubscriptionQuoteInputParam {
890
+ first_name?: string;
891
+ last_name?: string;
892
+ email?: string;
893
+ company?: string;
894
+ phone?: string;
895
+ line1?: string;
896
+ line2?: string;
897
+ line3?: string;
898
+ city?: string;
899
+ state_code?: string;
900
+ state?: string;
901
+ zip?: string;
902
+ country?: string;
903
+ validation_status?: ValidationStatusEnum;
904
+ }
905
+ export interface ContractTermEditUpdateSubscriptionQuoteInputParam {
906
+ action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
907
+ cancellation_cutoff_period?: number;
908
+ }
909
+ export interface SubscriptionEditUpdateSubscriptionQuoteInputParam {
910
+ plan_id?: string;
911
+ plan_quantity?: number;
912
+ plan_unit_price?: number;
913
+ setup_fee?: number;
914
+ plan_quantity_in_decimal?: string;
915
+ plan_unit_price_in_decimal?: string;
916
+ start_date?: number;
917
+ trial_end?: number;
918
+ /**
919
+ * @deprecated Please refer API docs to use other attributes
920
+ */
921
+ coupon?: string;
922
+ auto_collection?: AutoCollectionEnum;
923
+ offline_payment_method?: OfflinePaymentMethodEnum;
924
+ contract_term_billing_cycle_on_renewal?: number;
925
+ }
926
+
927
+ export interface EventBasedAddonsEditUpdateSubscriptionQuoteInputParam {
928
+ id?: string;
929
+ quantity?: number;
930
+ unit_price?: number;
931
+ service_period_in_days?: number;
932
+ charge_on?: ChargeOnEnum;
933
+ on_event?: OnEventEnum;
934
+ charge_once?: boolean;
935
+ quantity_in_decimal?: string;
936
+ unit_price_in_decimal?: string;
937
+ }
938
+ export interface AddonsEditUpdateSubscriptionQuoteInputParam {
939
+ id?: string;
940
+ quantity?: number;
941
+ unit_price?: number;
942
+ billing_cycles?: number;
943
+ quantity_in_decimal?: string;
944
+ unit_price_in_decimal?: string;
945
+ trial_end?: number;
946
+ }
947
+ export interface ShippingAddressCreateForOnetimeChargesInputParam {
948
+ first_name?: string;
949
+ last_name?: string;
950
+ email?: string;
951
+ company?: string;
952
+ phone?: string;
953
+ line1?: string;
954
+ line2?: string;
955
+ line3?: string;
956
+ city?: string;
957
+ state_code?: string;
958
+ state?: string;
959
+ zip?: string;
960
+ country?: string;
961
+ validation_status?: ValidationStatusEnum;
962
+ }
963
+
964
+ export interface ChargesCreateForOnetimeChargesInputParam {
965
+ amount?: number;
966
+ amount_in_decimal?: string;
967
+ description?: string;
968
+ avalara_sale_type?: AvalaraSaleTypeEnum;
969
+ avalara_transaction_type?: number;
970
+ avalara_service_type?: number;
971
+ service_period?: number;
972
+ }
973
+ export interface AddonsCreateForOnetimeChargesInputParam {
974
+ id?: string;
975
+ quantity?: number;
976
+ quantity_in_decimal?: string;
977
+ unit_price?: number;
978
+ unit_price_in_decimal?: string;
979
+ service_period?: number;
980
+ }
981
+ export interface TaxProvidersFieldsCreateForOnetimeChargesInputParam {
982
+ provider_name?: string;
983
+ field_id?: string;
984
+ field_value?: string;
985
+ }
986
+ export interface ShippingAddressEditOneTimeQuoteInputParam {
987
+ first_name?: string;
988
+ last_name?: string;
989
+ email?: string;
990
+ company?: string;
991
+ phone?: string;
992
+ line1?: string;
993
+ line2?: string;
994
+ line3?: string;
995
+ city?: string;
996
+ state_code?: string;
997
+ state?: string;
998
+ zip?: string;
999
+ country?: string;
1000
+ validation_status?: ValidationStatusEnum;
1001
+ }
1002
+
1003
+ export interface ChargesEditOneTimeQuoteInputParam {
1004
+ amount?: number;
1005
+ amount_in_decimal?: string;
1006
+ description?: string;
1007
+ avalara_sale_type?: AvalaraSaleTypeEnum;
1008
+ avalara_transaction_type?: number;
1009
+ avalara_service_type?: number;
1010
+ service_period?: number;
1011
+ }
1012
+ export interface AddonsEditOneTimeQuoteInputParam {
1013
+ id?: string;
1014
+ quantity?: number;
1015
+ quantity_in_decimal?: string;
1016
+ unit_price?: number;
1017
+ unit_price_in_decimal?: string;
1018
+ service_period?: number;
1019
+ }
1020
+ export interface TaxProvidersFieldsEditOneTimeQuoteInputParam {
1021
+ provider_name?: string;
1022
+ field_id?: string;
1023
+ field_value?: string;
1024
+ }
1025
+ export interface ShippingAddressCreateSubItemsForCustomerQuoteInputParam {
1026
+ first_name?: string;
1027
+ last_name?: string;
1028
+ email?: string;
1029
+ company?: string;
1030
+ phone?: string;
1031
+ line1?: string;
1032
+ line2?: string;
1033
+ line3?: string;
1034
+ city?: string;
1035
+ state_code?: string;
1036
+ state?: string;
1037
+ zip?: string;
1038
+ country?: string;
1039
+ validation_status?: ValidationStatusEnum;
1040
+ }
1041
+ export interface ContractTermCreateSubItemsForCustomerQuoteInputParam {
1042
+ action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
1043
+ cancellation_cutoff_period?: number;
1044
+ }
1045
+ export interface SubscriptionCreateSubItemsForCustomerQuoteInputParam {
1046
+ id?: string;
1047
+ po_number?: string;
1048
+ trial_end?: number;
1049
+ /**
1050
+ * @deprecated Please refer API docs to use other attributes
1051
+ */
1052
+ setup_fee?: number;
1053
+ start_date?: number;
1054
+ contract_term_billing_cycle_on_renewal?: number;
1055
+ }
1056
+
1057
+ export interface SubscriptionItemsCreateSubItemsForCustomerQuoteInputParam {
1058
+ item_price_id: string;
1059
+ quantity?: number;
1060
+ quantity_in_decimal?: string;
1061
+ unit_price?: number;
1062
+ unit_price_in_decimal?: string;
1063
+ billing_cycles?: number;
1064
+ trial_end?: number;
1065
+ service_period_days?: number;
1066
+ charge_on_event?: ChargeOnEventEnum;
1067
+ charge_once?: boolean;
1068
+ /**
1069
+ * @deprecated Please refer API docs to use other attributes
1070
+ */
1071
+ item_type?: ItemTypeEnum;
1072
+ charge_on_option?: ChargeOnOptionEnum;
1073
+ }
1074
+ export interface DiscountsCreateSubItemsForCustomerQuoteInputParam {
1075
+ apply_on: ApplyOnEnum;
1076
+ duration_type: DurationTypeEnum;
1077
+ percentage?: number;
1078
+ amount?: number;
1079
+ period?: number;
1080
+ period_unit?: PeriodUnitEnum;
1081
+ included_in_mrr?: boolean;
1082
+ item_price_id?: string;
1083
+ }
1084
+ export interface ItemTiersCreateSubItemsForCustomerQuoteInputParam {
1085
+ item_price_id?: string;
1086
+ starting_unit?: number;
1087
+ ending_unit?: number;
1088
+ price?: number;
1089
+ starting_unit_in_decimal?: string;
1090
+ ending_unit_in_decimal?: string;
1091
+ price_in_decimal?: string;
1092
+ }
1093
+ export interface ShippingAddressEditCreateSubCustomerQuoteForItemsInputParam {
1094
+ first_name?: string;
1095
+ last_name?: string;
1096
+ email?: string;
1097
+ company?: string;
1098
+ phone?: string;
1099
+ line1?: string;
1100
+ line2?: string;
1101
+ line3?: string;
1102
+ city?: string;
1103
+ state_code?: string;
1104
+ state?: string;
1105
+ zip?: string;
1106
+ country?: string;
1107
+ validation_status?: ValidationStatusEnum;
1108
+ }
1109
+ export interface ContractTermEditCreateSubCustomerQuoteForItemsInputParam {
1110
+ action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
1111
+ cancellation_cutoff_period?: number;
1112
+ }
1113
+ export interface SubscriptionEditCreateSubCustomerQuoteForItemsInputParam {
1114
+ id?: string;
1115
+ po_number?: string;
1116
+ trial_end?: number;
1117
+ /**
1118
+ * @deprecated Please refer API docs to use other attributes
1119
+ */
1120
+ setup_fee?: number;
1121
+ start_date?: number;
1122
+ contract_term_billing_cycle_on_renewal?: number;
1123
+ }
1124
+
1125
+ export interface SubscriptionItemsEditCreateSubCustomerQuoteForItemsInputParam {
1126
+ item_price_id: string;
1127
+ quantity?: number;
1128
+ quantity_in_decimal?: string;
1129
+ unit_price?: number;
1130
+ unit_price_in_decimal?: string;
1131
+ billing_cycles?: number;
1132
+ trial_end?: number;
1133
+ service_period_days?: number;
1134
+ charge_on_event?: ChargeOnEventEnum;
1135
+ charge_once?: boolean;
1136
+ /**
1137
+ * @deprecated Please refer API docs to use other attributes
1138
+ */
1139
+ item_type?: ItemTypeEnum;
1140
+ charge_on_option?: ChargeOnOptionEnum;
1141
+ }
1142
+ export interface DiscountsEditCreateSubCustomerQuoteForItemsInputParam {
1143
+ apply_on: ApplyOnEnum;
1144
+ duration_type: DurationTypeEnum;
1145
+ percentage?: number;
1146
+ amount?: number;
1147
+ period?: number;
1148
+ period_unit?: PeriodUnitEnum;
1149
+ included_in_mrr?: boolean;
1150
+ item_price_id?: string;
1151
+ }
1152
+ export interface ItemTiersEditCreateSubCustomerQuoteForItemsInputParam {
1153
+ item_price_id?: string;
1154
+ starting_unit?: number;
1155
+ ending_unit?: number;
1156
+ price?: number;
1157
+ starting_unit_in_decimal?: string;
1158
+ ending_unit_in_decimal?: string;
1159
+ price_in_decimal?: string;
1160
+ }
1161
+ export interface BillingAddressUpdateSubscriptionQuoteForItemsInputParam {
1162
+ first_name?: string;
1163
+ last_name?: string;
1164
+ email?: string;
1165
+ company?: string;
1166
+ phone?: string;
1167
+ line1?: string;
1168
+ line2?: string;
1169
+ line3?: string;
1170
+ city?: string;
1171
+ state_code?: string;
1172
+ state?: string;
1173
+ zip?: string;
1174
+ country?: string;
1175
+ validation_status?: ValidationStatusEnum;
1176
+ }
1177
+ export interface CustomerUpdateSubscriptionQuoteForItemsInputParam {
1178
+ vat_number?: string;
1179
+ vat_number_prefix?: string;
1180
+ registered_for_gst?: boolean;
1181
+ }
1182
+ export interface ShippingAddressUpdateSubscriptionQuoteForItemsInputParam {
1183
+ first_name?: string;
1184
+ last_name?: string;
1185
+ email?: string;
1186
+ company?: string;
1187
+ phone?: string;
1188
+ line1?: string;
1189
+ line2?: string;
1190
+ line3?: string;
1191
+ city?: string;
1192
+ state_code?: string;
1193
+ state?: string;
1194
+ zip?: string;
1195
+ country?: string;
1196
+ validation_status?: ValidationStatusEnum;
1197
+ }
1198
+ export interface ContractTermUpdateSubscriptionQuoteForItemsInputParam {
1199
+ action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
1200
+ cancellation_cutoff_period?: number;
1201
+ }
1202
+ export interface SubscriptionUpdateSubscriptionQuoteForItemsInputParam {
1203
+ id: string;
1204
+ /**
1205
+ * @deprecated Please refer API docs to use other attributes
1206
+ */
1207
+ setup_fee?: number;
1208
+ start_date?: number;
1209
+ trial_end?: number;
1210
+ /**
1211
+ * @deprecated Please refer API docs to use other attributes
1212
+ */
1213
+ coupon?: string;
1214
+ auto_collection?: AutoCollectionEnum;
1215
+ offline_payment_method?: OfflinePaymentMethodEnum;
1216
+ contract_term_billing_cycle_on_renewal?: number;
1217
+ }
1218
+
1219
+ export interface SubscriptionItemsUpdateSubscriptionQuoteForItemsInputParam {
1220
+ item_price_id: string;
1221
+ quantity?: number;
1222
+ quantity_in_decimal?: string;
1223
+ unit_price?: number;
1224
+ unit_price_in_decimal?: string;
1225
+ billing_cycles?: number;
1226
+ trial_end?: number;
1227
+ service_period_days?: number;
1228
+ charge_on_event?: ChargeOnEventEnum;
1229
+ charge_once?: boolean;
1230
+ charge_on_option?: ChargeOnOptionEnum;
1231
+ /**
1232
+ * @deprecated Please refer API docs to use other attributes
1233
+ */
1234
+ item_type?: ItemTypeEnum;
1235
+ }
1236
+ export interface DiscountsUpdateSubscriptionQuoteForItemsInputParam {
1237
+ apply_on: ApplyOnEnum;
1238
+ duration_type: DurationTypeEnum;
1239
+ percentage?: number;
1240
+ amount?: number;
1241
+ period?: number;
1242
+ period_unit?: PeriodUnitEnum;
1243
+ included_in_mrr?: boolean;
1244
+ item_price_id?: string;
1245
+ operation_type: OperationTypeEnum;
1246
+ id?: string;
1247
+ }
1248
+ export interface ItemTiersUpdateSubscriptionQuoteForItemsInputParam {
1249
+ item_price_id?: string;
1250
+ starting_unit?: number;
1251
+ ending_unit?: number;
1252
+ price?: number;
1253
+ starting_unit_in_decimal?: string;
1254
+ ending_unit_in_decimal?: string;
1255
+ price_in_decimal?: string;
1256
+ }
1257
+ export interface BillingAddressEditUpdateSubscriptionQuoteForItemsInputParam {
1258
+ first_name?: string;
1259
+ last_name?: string;
1260
+ email?: string;
1261
+ company?: string;
1262
+ phone?: string;
1263
+ line1?: string;
1264
+ line2?: string;
1265
+ line3?: string;
1266
+ city?: string;
1267
+ state_code?: string;
1268
+ state?: string;
1269
+ zip?: string;
1270
+ country?: string;
1271
+ validation_status?: ValidationStatusEnum;
1272
+ }
1273
+ export interface CustomerEditUpdateSubscriptionQuoteForItemsInputParam {
1274
+ vat_number?: string;
1275
+ vat_number_prefix?: string;
1276
+ registered_for_gst?: boolean;
1277
+ }
1278
+ export interface ShippingAddressEditUpdateSubscriptionQuoteForItemsInputParam {
1279
+ first_name?: string;
1280
+ last_name?: string;
1281
+ email?: string;
1282
+ company?: string;
1283
+ phone?: string;
1284
+ line1?: string;
1285
+ line2?: string;
1286
+ line3?: string;
1287
+ city?: string;
1288
+ state_code?: string;
1289
+ state?: string;
1290
+ zip?: string;
1291
+ country?: string;
1292
+ validation_status?: ValidationStatusEnum;
1293
+ }
1294
+ export interface ContractTermEditUpdateSubscriptionQuoteForItemsInputParam {
1295
+ action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
1296
+ cancellation_cutoff_period?: number;
1297
+ }
1298
+ export interface SubscriptionEditUpdateSubscriptionQuoteForItemsInputParam {
1299
+ /**
1300
+ * @deprecated Please refer API docs to use other attributes
1301
+ */
1302
+ setup_fee?: number;
1303
+ start_date?: number;
1304
+ trial_end?: number;
1305
+ /**
1306
+ * @deprecated Please refer API docs to use other attributes
1307
+ */
1308
+ coupon?: string;
1309
+ auto_collection?: AutoCollectionEnum;
1310
+ offline_payment_method?: OfflinePaymentMethodEnum;
1311
+ contract_term_billing_cycle_on_renewal?: number;
1312
+ }
1313
+
1314
+ export interface SubscriptionItemsEditUpdateSubscriptionQuoteForItemsInputParam {
1315
+ item_price_id: string;
1316
+ quantity?: number;
1317
+ quantity_in_decimal?: string;
1318
+ unit_price?: number;
1319
+ unit_price_in_decimal?: string;
1320
+ billing_cycles?: number;
1321
+ trial_end?: number;
1322
+ service_period_days?: number;
1323
+ charge_on_event?: ChargeOnEventEnum;
1324
+ charge_once?: boolean;
1325
+ charge_on_option?: ChargeOnOptionEnum;
1326
+ /**
1327
+ * @deprecated Please refer API docs to use other attributes
1328
+ */
1329
+ item_type?: ItemTypeEnum;
1330
+ }
1331
+ export interface DiscountsEditUpdateSubscriptionQuoteForItemsInputParam {
1332
+ apply_on: ApplyOnEnum;
1333
+ duration_type: DurationTypeEnum;
1334
+ percentage?: number;
1335
+ amount?: number;
1336
+ period?: number;
1337
+ period_unit?: PeriodUnitEnum;
1338
+ included_in_mrr?: boolean;
1339
+ item_price_id?: string;
1340
+ operation_type: OperationTypeEnum;
1341
+ id?: string;
1342
+ }
1343
+ export interface ItemTiersEditUpdateSubscriptionQuoteForItemsInputParam {
1344
+ item_price_id?: string;
1345
+ starting_unit?: number;
1346
+ ending_unit?: number;
1347
+ price?: number;
1348
+ starting_unit_in_decimal?: string;
1349
+ ending_unit_in_decimal?: string;
1350
+ price_in_decimal?: string;
1351
+ }
1352
+ export interface ShippingAddressCreateForChargeItemsAndChargesInputParam {
1353
+ first_name?: string;
1354
+ last_name?: string;
1355
+ email?: string;
1356
+ company?: string;
1357
+ phone?: string;
1358
+ line1?: string;
1359
+ line2?: string;
1360
+ line3?: string;
1361
+ city?: string;
1362
+ state_code?: string;
1363
+ state?: string;
1364
+ zip?: string;
1365
+ country?: string;
1366
+ validation_status?: ValidationStatusEnum;
1367
+ }
1368
+
1369
+ export interface ChargesCreateForChargeItemsAndChargesInputParam {
1370
+ amount?: number;
1371
+ amount_in_decimal?: string;
1372
+ description?: string;
1373
+ avalara_sale_type?: AvalaraSaleTypeEnum;
1374
+ avalara_transaction_type?: number;
1375
+ avalara_service_type?: number;
1376
+ service_period?: number;
1377
+ }
1378
+ export interface DiscountsCreateForChargeItemsAndChargesInputParam {
1379
+ percentage?: number;
1380
+ amount?: number;
1381
+ apply_on: ApplyOnEnum;
1382
+ item_price_id?: string;
1383
+ }
1384
+ export interface ItemTiersCreateForChargeItemsAndChargesInputParam {
1385
+ item_price_id?: string;
1386
+ starting_unit?: number;
1387
+ ending_unit?: number;
1388
+ price?: number;
1389
+ starting_unit_in_decimal?: string;
1390
+ ending_unit_in_decimal?: string;
1391
+ price_in_decimal?: string;
1392
+ }
1393
+ export interface ItemPricesCreateForChargeItemsAndChargesInputParam {
1394
+ item_price_id?: string;
1395
+ quantity?: number;
1396
+ quantity_in_decimal?: string;
1397
+ unit_price?: number;
1398
+ unit_price_in_decimal?: string;
1399
+ service_period_days?: number;
1400
+ }
1401
+ export interface TaxProvidersFieldsCreateForChargeItemsAndChargesInputParam {
1402
+ provider_name?: string;
1403
+ field_id?: string;
1404
+ field_value?: string;
1405
+ }
1406
+ export interface ShippingAddressEditForChargeItemsAndChargesInputParam {
1407
+ first_name?: string;
1408
+ last_name?: string;
1409
+ email?: string;
1410
+ company?: string;
1411
+ phone?: string;
1412
+ line1?: string;
1413
+ line2?: string;
1414
+ line3?: string;
1415
+ city?: string;
1416
+ state_code?: string;
1417
+ state?: string;
1418
+ zip?: string;
1419
+ country?: string;
1420
+ validation_status?: ValidationStatusEnum;
1421
+ }
1422
+
1423
+ export interface ChargesEditForChargeItemsAndChargesInputParam {
1424
+ amount?: number;
1425
+ amount_in_decimal?: string;
1426
+ description?: string;
1427
+ avalara_sale_type?: AvalaraSaleTypeEnum;
1428
+ avalara_transaction_type?: number;
1429
+ avalara_service_type?: number;
1430
+ service_period?: number;
1431
+ }
1432
+ export interface DiscountsEditForChargeItemsAndChargesInputParam {
1433
+ percentage?: number;
1434
+ amount?: number;
1435
+ apply_on: ApplyOnEnum;
1436
+ item_price_id?: string;
1437
+ }
1438
+ export interface ItemTiersEditForChargeItemsAndChargesInputParam {
1439
+ item_price_id?: string;
1440
+ starting_unit?: number;
1441
+ ending_unit?: number;
1442
+ price?: number;
1443
+ starting_unit_in_decimal?: string;
1444
+ ending_unit_in_decimal?: string;
1445
+ price_in_decimal?: string;
1446
+ }
1447
+ export interface ItemPricesEditForChargeItemsAndChargesInputParam {
1448
+ item_price_id?: string;
1449
+ quantity?: number;
1450
+ quantity_in_decimal?: string;
1451
+ unit_price?: number;
1452
+ unit_price_in_decimal?: string;
1453
+ service_period_days?: number;
1454
+ }
1455
+ export interface TaxProvidersFieldsEditForChargeItemsAndChargesInputParam {
1456
+ provider_name?: string;
1457
+ field_id?: string;
1458
+ field_value?: string;
1459
+ }
1460
+ export interface SubscriptionConvertInputParam {
1461
+ id?: string;
1462
+ auto_collection?: AutoCollectionEnum;
1463
+ po_number?: string;
1464
+ auto_close_invoices?: boolean;
1465
+ }
1466
+ }
1467
+ }