chargebee 3.0.0-beta.5 → 3.0.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 (82) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.md +9 -8
  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 +0 -574
  7. package/types/index.d.ts +0 -167
  8. package/types/resources/Address.d.ts +0 -71
  9. package/types/resources/AdvanceInvoiceSchedule.d.ts +0 -29
  10. package/types/resources/AttachedItem.d.ts +0 -114
  11. package/types/resources/Attribute.d.ts +0 -9
  12. package/types/resources/BusinessEntity.d.ts +0 -64
  13. package/types/resources/BusinessEntityTransfer.d.ts +0 -15
  14. package/types/resources/Card.d.ts +0 -171
  15. package/types/resources/Comment.d.ts +0 -89
  16. package/types/resources/Contact.d.ts +0 -16
  17. package/types/resources/ContractTerm.d.ts +0 -19
  18. package/types/resources/Coupon.d.ts +0 -314
  19. package/types/resources/CouponCode.d.ts +0 -70
  20. package/types/resources/CouponSet.d.ts +0 -111
  21. package/types/resources/CreditNote.d.ts +0 -628
  22. package/types/resources/CreditNoteEstimate.d.ts +0 -143
  23. package/types/resources/Currency.d.ts +0 -91
  24. package/types/resources/Customer.d.ts +0 -962
  25. package/types/resources/CustomerEntitlement.d.ts +0 -36
  26. package/types/resources/DifferentialPrice.d.ts +0 -142
  27. package/types/resources/Discount.d.ts +0 -24
  28. package/types/resources/Download.d.ts +0 -10
  29. package/types/resources/Entitlement.d.ts +0 -66
  30. package/types/resources/EntitlementOverride.d.ts +0 -76
  31. package/types/resources/Estimate.d.ts +0 -1237
  32. package/types/resources/Event.d.ts +0 -81
  33. package/types/resources/Export.d.ts +0 -607
  34. package/types/resources/Feature.d.ts +0 -142
  35. package/types/resources/GatewayErrorDetail.d.ts +0 -20
  36. package/types/resources/Gift.d.ts +0 -296
  37. package/types/resources/Hierarchy.d.ts +0 -12
  38. package/types/resources/HostedPage.d.ts +0 -1112
  39. package/types/resources/ImpactedItem.d.ts +0 -20
  40. package/types/resources/ImpactedItemPrice.d.ts +0 -20
  41. package/types/resources/ImpactedSubscription.d.ts +0 -20
  42. package/types/resources/InAppSubscription.d.ts +0 -116
  43. package/types/resources/Invoice.d.ts +0 -1691
  44. package/types/resources/InvoiceEstimate.d.ts +0 -143
  45. package/types/resources/Item.d.ts +0 -204
  46. package/types/resources/ItemEntitlement.d.ts +0 -103
  47. package/types/resources/ItemFamily.d.ts +0 -89
  48. package/types/resources/ItemPrice.d.ts +0 -328
  49. package/types/resources/Metadata.d.ts +0 -8
  50. package/types/resources/NonSubscription.d.ts +0 -48
  51. package/types/resources/Order.d.ts +0 -586
  52. package/types/resources/PaymentIntent.d.ts +0 -178
  53. package/types/resources/PaymentReferenceNumber.d.ts +0 -11
  54. package/types/resources/PaymentSchedule.d.ts +0 -28
  55. package/types/resources/PaymentScheduleEstimate.d.ts +0 -25
  56. package/types/resources/PaymentScheduleScheme.d.ts +0 -62
  57. package/types/resources/PaymentSource.d.ts +0 -529
  58. package/types/resources/PaymentVoucher.d.ts +0 -107
  59. package/types/resources/PortalSession.d.ts +0 -88
  60. package/types/resources/PriceVariant.d.ts +0 -112
  61. package/types/resources/PricingPageSession.d.ts +0 -130
  62. package/types/resources/PromotionalCredit.d.ts +0 -111
  63. package/types/resources/Purchase.d.ts +0 -202
  64. package/types/resources/Quote.d.ts +0 -1467
  65. package/types/resources/QuoteLineGroup.d.ts +0 -136
  66. package/types/resources/QuotedCharge.d.ts +0 -56
  67. package/types/resources/QuotedSubscription.d.ts +0 -114
  68. package/types/resources/Ramp.d.ts +0 -260
  69. package/types/resources/ResourceMigration.d.ts +0 -36
  70. package/types/resources/SiteMigrationDetail.d.ts +0 -46
  71. package/types/resources/Subscription.d.ts +0 -2443
  72. package/types/resources/SubscriptionEntitlement.d.ts +0 -79
  73. package/types/resources/SubscriptionEstimate.d.ts +0 -59
  74. package/types/resources/TaxWithheld.d.ts +0 -19
  75. package/types/resources/ThirdPartyPaymentMethod.d.ts +0 -11
  76. package/types/resources/TimeMachine.d.ts +0 -57
  77. package/types/resources/Token.d.ts +0 -19
  78. package/types/resources/Transaction.d.ts +0 -313
  79. package/types/resources/UnbilledCharge.d.ts +0 -209
  80. package/types/resources/Usage.d.ts +0 -113
  81. package/types/resources/VirtualBankAccount.d.ts +0 -125
  82. package/types/resources/filter.d.ts +0 -52
@@ -1,1112 +0,0 @@
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 HostedPage {
6
- id?: string;
7
- type?:
8
- | 'checkout_new'
9
- | 'checkout_existing'
10
- | 'update_payment_method'
11
- | 'manage_payment_sources'
12
- | 'collect_now'
13
- | 'extend_subscription'
14
- | 'checkout_one_time'
15
- | 'pre_cancel'
16
- | 'view_voucher'
17
- | 'checkout_gift'
18
- | 'claim_gift';
19
- url?: string;
20
- state?:
21
- | 'created'
22
- | 'requested'
23
- | 'succeeded'
24
- | 'cancelled'
25
- | 'acknowledged';
26
- failure_reason?: 'card_error' | 'server_error';
27
- pass_thru_content?: string;
28
- embed: boolean;
29
- created_at?: number;
30
- expires_at?: number;
31
- updated_at?: number;
32
- resource_version?: number;
33
- checkout_info?: any;
34
- business_entity_id?: string;
35
- }
36
-
37
- export namespace HostedPage {
38
- export class HostedPageResource {
39
- checkoutNew(
40
- input: CheckoutNewInputParam,
41
- headers?: ChargebeeRequestHeader,
42
- ): Promise<ChargebeeResponse<CheckoutNewResponse>>;
43
-
44
- checkoutOneTime(
45
- input?: CheckoutOneTimeInputParam,
46
- headers?: ChargebeeRequestHeader,
47
- ): Promise<ChargebeeResponse<CheckoutOneTimeResponse>>;
48
-
49
- checkoutOneTimeForItems(
50
- input: CheckoutOneTimeForItemsInputParam,
51
- headers?: ChargebeeRequestHeader,
52
- ): Promise<ChargebeeResponse<CheckoutOneTimeForItemsResponse>>;
53
-
54
- checkoutNewForItems(
55
- input: CheckoutNewForItemsInputParam,
56
- headers?: ChargebeeRequestHeader,
57
- ): Promise<ChargebeeResponse<CheckoutNewForItemsResponse>>;
58
-
59
- checkoutExisting(
60
- input: CheckoutExistingInputParam,
61
- headers?: ChargebeeRequestHeader,
62
- ): Promise<ChargebeeResponse<CheckoutExistingResponse>>;
63
-
64
- checkoutExistingForItems(
65
- input: CheckoutExistingForItemsInputParam,
66
- headers?: ChargebeeRequestHeader,
67
- ): Promise<ChargebeeResponse<CheckoutExistingForItemsResponse>>;
68
-
69
- updateCard(
70
- input: UpdateCardInputParam,
71
- headers?: ChargebeeRequestHeader,
72
- ): Promise<ChargebeeResponse<UpdateCardResponse>>;
73
-
74
- updatePaymentMethod(
75
- input: UpdatePaymentMethodInputParam,
76
- headers?: ChargebeeRequestHeader,
77
- ): Promise<ChargebeeResponse<UpdatePaymentMethodResponse>>;
78
-
79
- managePaymentSources(
80
- input: ManagePaymentSourcesInputParam,
81
- headers?: ChargebeeRequestHeader,
82
- ): Promise<ChargebeeResponse<ManagePaymentSourcesResponse>>;
83
-
84
- collectNow(
85
- input: CollectNowInputParam,
86
- headers?: ChargebeeRequestHeader,
87
- ): Promise<ChargebeeResponse<CollectNowResponse>>;
88
-
89
- acceptQuote(
90
- input: AcceptQuoteInputParam,
91
- headers?: ChargebeeRequestHeader,
92
- ): Promise<ChargebeeResponse<AcceptQuoteResponse>>;
93
-
94
- extendSubscription(
95
- input: ExtendSubscriptionInputParam,
96
- headers?: ChargebeeRequestHeader,
97
- ): Promise<ChargebeeResponse<ExtendSubscriptionResponse>>;
98
-
99
- checkoutGift(
100
- input: CheckoutGiftInputParam,
101
- headers?: ChargebeeRequestHeader,
102
- ): Promise<ChargebeeResponse<CheckoutGiftResponse>>;
103
-
104
- checkoutGiftForItems(
105
- input?: CheckoutGiftForItemsInputParam,
106
- headers?: ChargebeeRequestHeader,
107
- ): Promise<ChargebeeResponse<CheckoutGiftForItemsResponse>>;
108
-
109
- claimGift(
110
- input: ClaimGiftInputParam,
111
- headers?: ChargebeeRequestHeader,
112
- ): Promise<ChargebeeResponse<ClaimGiftResponse>>;
113
-
114
- retrieveAgreementPdf(
115
- input: RetrieveAgreementPdfInputParam,
116
- headers?: ChargebeeRequestHeader,
117
- ): Promise<ChargebeeResponse<RetrieveAgreementPdfResponse>>;
118
-
119
- acknowledge(
120
- hosted_page_id: string,
121
- headers?: ChargebeeRequestHeader,
122
- ): Promise<ChargebeeResponse<AcknowledgeResponse>>;
123
-
124
- retrieve(
125
- hosted_page_id: string,
126
- headers?: ChargebeeRequestHeader,
127
- ): Promise<ChargebeeResponse<RetrieveResponse>>;
128
-
129
- list(
130
- input?: ListInputParam,
131
- headers?: ChargebeeRequestHeader,
132
- ): Promise<ChargebeeResponse<ListResponse>>;
133
-
134
- preCancel(
135
- input: PreCancelInputParam,
136
- headers?: ChargebeeRequestHeader,
137
- ): Promise<ChargebeeResponse<PreCancelResponse>>;
138
-
139
- events(
140
- input: EventsInputParam,
141
- headers?: ChargebeeRequestHeader,
142
- ): Promise<ChargebeeResponse<EventsResponse>>;
143
-
144
- viewVoucher(
145
- input: ViewVoucherInputParam,
146
- headers?: ChargebeeRequestHeader,
147
- ): Promise<ChargebeeResponse<ViewVoucherResponse>>;
148
- }
149
-
150
- export interface CheckoutNewResponse {
151
- hosted_page: HostedPage;
152
- }
153
-
154
- export interface CheckoutOneTimeResponse {
155
- hosted_page: HostedPage;
156
- }
157
-
158
- export interface CheckoutOneTimeForItemsResponse {
159
- hosted_page: HostedPage;
160
- }
161
-
162
- export interface CheckoutNewForItemsResponse {
163
- hosted_page: HostedPage;
164
- }
165
-
166
- export interface CheckoutExistingResponse {
167
- hosted_page: HostedPage;
168
- }
169
-
170
- export interface CheckoutExistingForItemsResponse {
171
- hosted_page: HostedPage;
172
- }
173
-
174
- export interface UpdateCardResponse {
175
- hosted_page: HostedPage;
176
- }
177
-
178
- export interface UpdatePaymentMethodResponse {
179
- hosted_page: HostedPage;
180
- }
181
-
182
- export interface ManagePaymentSourcesResponse {
183
- hosted_page: HostedPage;
184
- }
185
-
186
- export interface CollectNowResponse {
187
- hosted_page: HostedPage;
188
- }
189
-
190
- export interface AcceptQuoteResponse {
191
- hosted_page: HostedPage;
192
- }
193
-
194
- export interface ExtendSubscriptionResponse {
195
- hosted_page: HostedPage;
196
- }
197
-
198
- export interface CheckoutGiftResponse {
199
- hosted_page: HostedPage;
200
- }
201
-
202
- export interface CheckoutGiftForItemsResponse {
203
- hosted_page: HostedPage;
204
- }
205
-
206
- export interface ClaimGiftResponse {
207
- hosted_page: HostedPage;
208
- }
209
-
210
- export interface RetrieveAgreementPdfResponse {
211
- hosted_page: HostedPage;
212
- }
213
-
214
- export interface AcknowledgeResponse {
215
- hosted_page: HostedPage;
216
- }
217
-
218
- export interface RetrieveResponse {
219
- hosted_page: HostedPage;
220
- }
221
-
222
- export interface ListResponse {
223
- list: { hosted_page: HostedPage }[];
224
- next_offset?: string;
225
- }
226
-
227
- export interface PreCancelResponse {
228
- hosted_page: HostedPage;
229
- }
230
-
231
- export interface EventsResponse {
232
- success: boolean;
233
- }
234
-
235
- export interface ViewVoucherResponse {
236
- hosted_page: HostedPage;
237
- }
238
-
239
- // REQUEST PARAMS
240
- //---------------
241
-
242
- export interface CheckoutNewInputParam {
243
- billing_cycles?: number;
244
- mandatory_addons_to_remove?: string[];
245
- terms_to_charge?: number;
246
- billing_alignment_mode?: BillingAlignmentModeEnum;
247
- coupon_ids?: string[];
248
- redirect_url?: string;
249
- cancel_url?: string;
250
- pass_thru_content?: string;
251
- embed?: boolean;
252
- iframe_messaging?: boolean;
253
- allow_offline_payment_methods?: boolean;
254
- subscription?: SubscriptionCheckoutNewInputParam;
255
- customer?: CustomerCheckoutNewInputParam;
256
- card?: CardCheckoutNewInputParam;
257
- billing_address?: BillingAddressCheckoutNewInputParam;
258
- shipping_address?: ShippingAddressCheckoutNewInputParam;
259
- contract_term?: ContractTermCheckoutNewInputParam;
260
- addons?: AddonsCheckoutNewInputParam[];
261
- event_based_addons?: EventBasedAddonsCheckoutNewInputParam[];
262
- }
263
- export interface CheckoutOneTimeInputParam {
264
- currency_code?: string;
265
- invoice_note?: string /**
266
- * @deprecated Please refer API docs to use other attributes
267
- */;
268
-
269
- coupon?: string;
270
- coupon_ids?: string[];
271
- redirect_url?: string;
272
- cancel_url?: string;
273
- pass_thru_content?: string;
274
- embed?: boolean;
275
- iframe_messaging?: boolean;
276
- customer?: CustomerCheckoutOneTimeInputParam;
277
- invoice?: InvoiceCheckoutOneTimeInputParam;
278
- card?: CardCheckoutOneTimeInputParam;
279
- billing_address?: BillingAddressCheckoutOneTimeInputParam;
280
- shipping_address?: ShippingAddressCheckoutOneTimeInputParam;
281
- addons?: AddonsCheckoutOneTimeInputParam[];
282
- charges?: ChargesCheckoutOneTimeInputParam[];
283
- }
284
- export interface CheckoutOneTimeForItemsInputParam {
285
- business_entity_id?: string;
286
- layout?: LayoutEnum;
287
- invoice_note?: string /**
288
- * @deprecated Please refer API docs to use other attributes
289
- */;
290
-
291
- coupon?: string;
292
- coupon_ids?: string[];
293
- currency_code?: string;
294
- redirect_url?: string;
295
- cancel_url?: string;
296
- pass_thru_content?: string;
297
- customer?: CustomerCheckoutOneTimeForItemsInputParam;
298
- invoice?: InvoiceCheckoutOneTimeForItemsInputParam;
299
- card?: CardCheckoutOneTimeForItemsInputParam;
300
- billing_address?: BillingAddressCheckoutOneTimeForItemsInputParam;
301
- shipping_address?: ShippingAddressCheckoutOneTimeForItemsInputParam;
302
- item_prices?: ItemPricesCheckoutOneTimeForItemsInputParam[];
303
- item_tiers?: ItemTiersCheckoutOneTimeForItemsInputParam[];
304
- charges?: ChargesCheckoutOneTimeForItemsInputParam[];
305
- discounts?: DiscountsCheckoutOneTimeForItemsInputParam[];
306
- entity_identifiers?: EntityIdentifiersCheckoutOneTimeForItemsInputParam[];
307
- }
308
- export interface CheckoutNewForItemsInputParam {
309
- layout?: LayoutEnum;
310
- business_entity_id?: string;
311
- billing_cycles?: number;
312
- mandatory_items_to_remove?: string[];
313
- terms_to_charge?: number;
314
- billing_alignment_mode?: BillingAlignmentModeEnum;
315
- coupon_ids?: string[];
316
- redirect_url?: string;
317
- cancel_url?: string;
318
- pass_thru_content?: string;
319
- allow_offline_payment_methods?: boolean;
320
- subscription?: SubscriptionCheckoutNewForItemsInputParam;
321
- customer?: CustomerCheckoutNewForItemsInputParam;
322
- card?: CardCheckoutNewForItemsInputParam;
323
- billing_address?: BillingAddressCheckoutNewForItemsInputParam;
324
- shipping_address?: ShippingAddressCheckoutNewForItemsInputParam;
325
- contract_term?: ContractTermCheckoutNewForItemsInputParam;
326
- subscription_items?: SubscriptionItemsCheckoutNewForItemsInputParam[];
327
- discounts?: DiscountsCheckoutNewForItemsInputParam[];
328
- item_tiers?: ItemTiersCheckoutNewForItemsInputParam[];
329
- entity_identifiers?: EntityIdentifiersCheckoutNewForItemsInputParam[];
330
- }
331
- export interface CheckoutExistingInputParam {
332
- replace_addon_list?: boolean;
333
- mandatory_addons_to_remove?: string[];
334
- invoice_date?: number;
335
- billing_cycles?: number;
336
- terms_to_charge?: number;
337
- reactivate_from?: number;
338
- billing_alignment_mode?: BillingAlignmentModeEnum;
339
- coupon_ids?: string[];
340
- reactivate?: boolean;
341
- force_term_reset?: boolean;
342
- redirect_url?: string;
343
- cancel_url?: string;
344
- pass_thru_content?: string;
345
- embed?: boolean;
346
- iframe_messaging?: boolean;
347
- allow_offline_payment_methods?: boolean;
348
- subscription?: SubscriptionCheckoutExistingInputParam;
349
- customer?: CustomerCheckoutExistingInputParam;
350
- card?: CardCheckoutExistingInputParam;
351
- contract_term?: ContractTermCheckoutExistingInputParam;
352
- addons?: AddonsCheckoutExistingInputParam[];
353
- event_based_addons?: EventBasedAddonsCheckoutExistingInputParam[];
354
- }
355
- export interface CheckoutExistingForItemsInputParam {
356
- layout?: LayoutEnum;
357
- mandatory_items_to_remove?: string[];
358
- replace_items_list?: boolean;
359
- invoice_date?: number;
360
- billing_cycles?: number;
361
- terms_to_charge?: number;
362
- reactivate_from?: number;
363
- billing_alignment_mode?: BillingAlignmentModeEnum;
364
- coupon_ids?: string[];
365
- reactivate?: boolean;
366
- force_term_reset?: boolean;
367
- change_option?: ChangeOptionEnum;
368
- changes_scheduled_at?: number;
369
- redirect_url?: string;
370
- cancel_url?: string;
371
- pass_thru_content?: string;
372
- allow_offline_payment_methods?: boolean;
373
- subscription?: SubscriptionCheckoutExistingForItemsInputParam;
374
- customer?: CustomerCheckoutExistingForItemsInputParam;
375
- card?: CardCheckoutExistingForItemsInputParam;
376
- contract_term?: ContractTermCheckoutExistingForItemsInputParam;
377
- subscription_items?: SubscriptionItemsCheckoutExistingForItemsInputParam[];
378
- discounts?: DiscountsCheckoutExistingForItemsInputParam[];
379
- item_tiers?: ItemTiersCheckoutExistingForItemsInputParam[];
380
- entity_identifiers?: EntityIdentifiersCheckoutExistingForItemsInputParam[];
381
- }
382
- export interface UpdateCardInputParam {
383
- redirect_url?: string;
384
- cancel_url?: string;
385
- pass_thru_content?: string;
386
- embed?: boolean;
387
- iframe_messaging?: boolean;
388
- customer?: CustomerUpdateCardInputParam;
389
- card?: CardUpdateCardInputParam;
390
- }
391
- export interface UpdatePaymentMethodInputParam {
392
- redirect_url?: string;
393
- cancel_url?: string;
394
- pass_thru_content?: string;
395
- embed?: boolean;
396
- iframe_messaging?: boolean;
397
- customer?: CustomerUpdatePaymentMethodInputParam;
398
- card?: CardUpdatePaymentMethodInputParam;
399
- }
400
- export interface ManagePaymentSourcesInputParam {
401
- redirect_url?: string;
402
- customer?: CustomerManagePaymentSourcesInputParam;
403
- card?: CardManagePaymentSourcesInputParam;
404
- }
405
- export interface CollectNowInputParam {
406
- redirect_url?: string;
407
- currency_code?: string;
408
- customer?: CustomerCollectNowInputParam;
409
- card?: CardCollectNowInputParam;
410
- }
411
- export interface AcceptQuoteInputParam {
412
- redirect_url?: string;
413
- layout?: LayoutEnum;
414
- quote?: QuoteAcceptQuoteInputParam;
415
- }
416
- export interface ExtendSubscriptionInputParam {
417
- expiry?: number;
418
- billing_cycle?: number;
419
- subscription?: SubscriptionExtendSubscriptionInputParam;
420
- }
421
- export interface CheckoutGiftInputParam {
422
- redirect_url?: string;
423
- coupon_ids?: string[];
424
- gifter?: GifterCheckoutGiftInputParam;
425
- subscription?: SubscriptionCheckoutGiftInputParam;
426
- addons?: AddonsCheckoutGiftInputParam[];
427
- }
428
- export interface CheckoutGiftForItemsInputParam {
429
- business_entity_id?: string;
430
- redirect_url?: string;
431
- coupon_ids?: string[];
432
- gifter?: GifterCheckoutGiftForItemsInputParam;
433
- subscription_items?: SubscriptionItemsCheckoutGiftForItemsInputParam[];
434
- }
435
- export interface ClaimGiftInputParam {
436
- redirect_url?: string;
437
- gift?: GiftClaimGiftInputParam;
438
- customer?: CustomerClaimGiftInputParam;
439
- }
440
- export interface RetrieveAgreementPdfInputParam {
441
- payment_source_id: string;
442
- }
443
- export interface ListInputParam {
444
- limit?: number;
445
- offset?: string;
446
- id?: filter.String;
447
- type?: filter.Enum;
448
- state?: filter.Enum;
449
- updated_at?: filter.Timestamp;
450
- }
451
- export interface PreCancelInputParam {
452
- pass_thru_content?: string;
453
- cancel_url?: string;
454
- redirect_url?: string;
455
- subscription?: SubscriptionPreCancelInputParam;
456
- }
457
- export interface EventsInputParam {
458
- event_name: EventNameEnum;
459
- occurred_at?: number;
460
- event_data: any;
461
- }
462
- export interface ViewVoucherInputParam {
463
- payment_voucher?: PaymentVoucherViewVoucherInputParam;
464
- customer?: CustomerViewVoucherInputParam;
465
- }
466
- export interface BillingAddressCheckoutNewInputParam {
467
- first_name?: string;
468
- last_name?: string;
469
- email?: string;
470
- company?: string;
471
- phone?: string;
472
- line1?: string;
473
- line2?: string;
474
- line3?: string;
475
- city?: string;
476
- state_code?: string;
477
- state?: string;
478
- zip?: string;
479
- country?: string;
480
- validation_status?: ValidationStatusEnum;
481
- }
482
- export interface CustomerCheckoutNewInputParam {
483
- id?: string;
484
- email?: string;
485
- first_name?: string;
486
- last_name?: string;
487
- company?: string;
488
- phone?: string;
489
- locale?: string;
490
- taxability?: TaxabilityEnum;
491
- vat_number?: string;
492
- vat_number_prefix?: string;
493
- consolidated_invoicing?: boolean;
494
- }
495
- export interface ShippingAddressCheckoutNewInputParam {
496
- first_name?: string;
497
- last_name?: string;
498
- email?: string;
499
- company?: string;
500
- phone?: string;
501
- line1?: string;
502
- line2?: string;
503
- line3?: string;
504
- city?: string;
505
- state_code?: string;
506
- state?: string;
507
- zip?: string;
508
- country?: string;
509
- validation_status?: ValidationStatusEnum;
510
- }
511
- export interface ContractTermCheckoutNewInputParam {
512
- action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
513
- cancellation_cutoff_period?: number;
514
- }
515
- export interface SubscriptionCheckoutNewInputParam {
516
- id?: string;
517
- plan_id: string;
518
- plan_quantity?: number;
519
- plan_quantity_in_decimal?: string;
520
- plan_unit_price?: number;
521
- plan_unit_price_in_decimal?: string;
522
- setup_fee?: number;
523
- trial_end?: number;
524
- start_date?: number;
525
- /**
526
- * @deprecated Please refer API docs to use other attributes
527
- */
528
- coupon?: string;
529
- auto_collection?: AutoCollectionEnum;
530
- offline_payment_method?: OfflinePaymentMethodEnum;
531
- invoice_notes?: string;
532
- affiliate_token?: string;
533
- contract_term_billing_cycle_on_renewal?: number;
534
- }
535
- export interface CardCheckoutNewInputParam {
536
- /**
537
- * @deprecated Please refer API docs to use other attributes
538
- */
539
- gateway?: GatewayEnum;
540
- gateway_account_id?: string;
541
- }
542
-
543
- export interface EventBasedAddonsCheckoutNewInputParam {
544
- id?: string;
545
- quantity?: number;
546
- unit_price?: number;
547
- quantity_in_decimal?: string;
548
- unit_price_in_decimal?: string;
549
- service_period_in_days?: number;
550
- on_event?: OnEventEnum;
551
- charge_once?: boolean;
552
- charge_on?: ChargeOnEnum;
553
- }
554
- export interface AddonsCheckoutNewInputParam {
555
- id?: string;
556
- quantity?: number;
557
- quantity_in_decimal?: string;
558
- unit_price?: number;
559
- unit_price_in_decimal?: string;
560
- billing_cycles?: number;
561
- }
562
- export interface BillingAddressCheckoutOneTimeInputParam {
563
- first_name?: string;
564
- last_name?: string;
565
- email?: string;
566
- company?: string;
567
- phone?: string;
568
- line1?: string;
569
- line2?: string;
570
- line3?: string;
571
- city?: string;
572
- state_code?: string;
573
- state?: string;
574
- zip?: string;
575
- country?: string;
576
- validation_status?: ValidationStatusEnum;
577
- }
578
- export interface InvoiceCheckoutOneTimeInputParam {
579
- po_number?: string;
580
- }
581
- export interface CustomerCheckoutOneTimeInputParam {
582
- id?: string;
583
- email?: string;
584
- first_name?: string;
585
- last_name?: string;
586
- company?: string;
587
- phone?: string;
588
- locale?: string;
589
- taxability?: TaxabilityEnum;
590
- vat_number?: string;
591
- vat_number_prefix?: string;
592
- consolidated_invoicing?: boolean;
593
- }
594
- export interface ShippingAddressCheckoutOneTimeInputParam {
595
- first_name?: string;
596
- last_name?: string;
597
- email?: string;
598
- company?: string;
599
- phone?: string;
600
- line1?: string;
601
- line2?: string;
602
- line3?: string;
603
- city?: string;
604
- state_code?: string;
605
- state?: string;
606
- zip?: string;
607
- country?: string;
608
- validation_status?: ValidationStatusEnum;
609
- }
610
- export interface CardCheckoutOneTimeInputParam {
611
- /**
612
- * @deprecated Please refer API docs to use other attributes
613
- */
614
- gateway?: GatewayEnum;
615
- gateway_account_id?: string;
616
- }
617
-
618
- export interface ChargesCheckoutOneTimeInputParam {
619
- amount?: number;
620
- amount_in_decimal?: string;
621
- description?: string;
622
- taxable?: boolean;
623
- tax_profile_id?: string;
624
- avalara_tax_code?: string;
625
- hsn_code?: string;
626
- taxjar_product_code?: string;
627
- avalara_sale_type?: AvalaraSaleTypeEnum;
628
- avalara_transaction_type?: number;
629
- avalara_service_type?: number;
630
- date_from?: number;
631
- date_to?: number;
632
- }
633
- export interface AddonsCheckoutOneTimeInputParam {
634
- id?: string;
635
- quantity?: number;
636
- unit_price?: number;
637
- quantity_in_decimal?: string;
638
- unit_price_in_decimal?: string;
639
- date_from?: number;
640
- date_to?: number;
641
- }
642
- export interface BillingAddressCheckoutOneTimeForItemsInputParam {
643
- first_name?: string;
644
- last_name?: string;
645
- email?: string;
646
- company?: string;
647
- phone?: string;
648
- line1?: string;
649
- line2?: string;
650
- line3?: string;
651
- city?: string;
652
- state_code?: string;
653
- state?: string;
654
- zip?: string;
655
- country?: string;
656
- validation_status?: ValidationStatusEnum;
657
- }
658
- export interface InvoiceCheckoutOneTimeForItemsInputParam {
659
- po_number?: string;
660
- }
661
- export interface CustomerCheckoutOneTimeForItemsInputParam {
662
- id?: string;
663
- email?: string;
664
- first_name?: string;
665
- last_name?: string;
666
- company?: string;
667
- phone?: string;
668
- locale?: string;
669
- taxability?: TaxabilityEnum;
670
- vat_number?: string;
671
- vat_number_prefix?: string;
672
- einvoicing_method?: EinvoicingMethodEnum;
673
- is_einvoice_enabled?: boolean;
674
- entity_identifier_scheme?: string;
675
- entity_identifier_standard?: string;
676
- consolidated_invoicing?: boolean;
677
- }
678
- export interface ShippingAddressCheckoutOneTimeForItemsInputParam {
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 CardCheckoutOneTimeForItemsInputParam {
695
- /**
696
- * @deprecated Please refer API docs to use other attributes
697
- */
698
- gateway?: GatewayEnum;
699
- gateway_account_id?: string;
700
- }
701
-
702
- export interface ChargesCheckoutOneTimeForItemsInputParam {
703
- amount?: number;
704
- amount_in_decimal?: string;
705
- description?: string;
706
- taxable?: boolean;
707
- tax_profile_id?: string;
708
- avalara_tax_code?: string;
709
- hsn_code?: string;
710
- taxjar_product_code?: string;
711
- avalara_sale_type?: AvalaraSaleTypeEnum;
712
- avalara_transaction_type?: number;
713
- avalara_service_type?: number;
714
- date_from?: number;
715
- date_to?: number;
716
- }
717
- export interface DiscountsCheckoutOneTimeForItemsInputParam {
718
- percentage?: number;
719
- amount?: number;
720
- apply_on: ApplyOnEnum;
721
- item_price_id?: string;
722
- }
723
- export interface EntityIdentifiersCheckoutOneTimeForItemsInputParam {
724
- id?: string;
725
- scheme?: string;
726
- value?: string;
727
- operation?: OperationEnum;
728
- standard?: string;
729
- }
730
- export interface ItemTiersCheckoutOneTimeForItemsInputParam {
731
- item_price_id?: string;
732
- starting_unit?: number;
733
- ending_unit?: number;
734
- price?: number;
735
- starting_unit_in_decimal?: string;
736
- ending_unit_in_decimal?: string;
737
- price_in_decimal?: string;
738
- }
739
- export interface ItemPricesCheckoutOneTimeForItemsInputParam {
740
- item_price_id?: string;
741
- quantity?: number;
742
- quantity_in_decimal?: string;
743
- unit_price?: number;
744
- unit_price_in_decimal?: string;
745
- date_from?: number;
746
- date_to?: number;
747
- }
748
- export interface BillingAddressCheckoutNewForItemsInputParam {
749
- first_name?: string;
750
- last_name?: string;
751
- email?: string;
752
- company?: string;
753
- phone?: string;
754
- line1?: string;
755
- line2?: string;
756
- line3?: string;
757
- city?: string;
758
- state_code?: string;
759
- state?: string;
760
- zip?: string;
761
- country?: string;
762
- validation_status?: ValidationStatusEnum;
763
- }
764
- export interface CustomerCheckoutNewForItemsInputParam {
765
- id?: string;
766
- email?: string;
767
- first_name?: string;
768
- last_name?: string;
769
- company?: string;
770
- phone?: string;
771
- locale?: string;
772
- taxability?: TaxabilityEnum;
773
- vat_number?: string;
774
- vat_number_prefix?: string;
775
- is_einvoice_enabled?: boolean;
776
- entity_identifier_scheme?: string;
777
- entity_identifier_standard?: string;
778
- einvoicing_method?: EinvoicingMethodEnum;
779
- }
780
- export interface ShippingAddressCheckoutNewForItemsInputParam {
781
- first_name?: string;
782
- last_name?: string;
783
- email?: string;
784
- company?: string;
785
- phone?: string;
786
- line1?: string;
787
- line2?: string;
788
- line3?: string;
789
- city?: string;
790
- state_code?: string;
791
- state?: string;
792
- zip?: string;
793
- country?: string;
794
- validation_status?: ValidationStatusEnum;
795
- }
796
- export interface ContractTermCheckoutNewForItemsInputParam {
797
- action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
798
- cancellation_cutoff_period?: number;
799
- }
800
- export interface SubscriptionCheckoutNewForItemsInputParam {
801
- id?: string;
802
- trial_end?: number;
803
- /**
804
- * @deprecated Please refer API docs to use other attributes
805
- */
806
- setup_fee?: number;
807
- start_date?: number;
808
- coupon?: string;
809
- auto_collection?: AutoCollectionEnum;
810
- invoice_notes?: string;
811
- contract_term_billing_cycle_on_renewal?: number;
812
- }
813
- export interface CardCheckoutNewForItemsInputParam {
814
- /**
815
- * @deprecated Please refer API docs to use other attributes
816
- */
817
- gateway?: GatewayEnum;
818
- gateway_account_id?: string;
819
- }
820
-
821
- export interface SubscriptionItemsCheckoutNewForItemsInputParam {
822
- item_price_id: string;
823
- quantity?: number;
824
- quantity_in_decimal?: string;
825
- unit_price?: number;
826
- unit_price_in_decimal?: string;
827
- billing_cycles?: number;
828
- trial_end?: number;
829
- service_period_days?: number;
830
- charge_on_event?: ChargeOnEventEnum;
831
- charge_once?: boolean;
832
- /**
833
- * @deprecated Please refer API docs to use other attributes
834
- */
835
- item_type?: ItemTypeEnum;
836
- charge_on_option?: ChargeOnOptionEnum;
837
- }
838
- export interface DiscountsCheckoutNewForItemsInputParam {
839
- apply_on: ApplyOnEnum;
840
- duration_type: DurationTypeEnum;
841
- percentage?: number;
842
- amount?: number;
843
- period?: number;
844
- period_unit?: PeriodUnitEnum;
845
- included_in_mrr?: boolean;
846
- item_price_id?: string;
847
- }
848
- export interface EntityIdentifiersCheckoutNewForItemsInputParam {
849
- id?: string;
850
- scheme?: string;
851
- value?: string;
852
- operation?: OperationEnum;
853
- standard?: string;
854
- }
855
- export interface ItemTiersCheckoutNewForItemsInputParam {
856
- item_price_id?: string;
857
- starting_unit?: number;
858
- ending_unit?: number;
859
- price?: number;
860
- starting_unit_in_decimal?: string;
861
- ending_unit_in_decimal?: string;
862
- price_in_decimal?: string;
863
- }
864
- export interface CustomerCheckoutExistingInputParam {
865
- vat_number?: string;
866
- vat_number_prefix?: string;
867
- }
868
- export interface ContractTermCheckoutExistingInputParam {
869
- action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
870
- cancellation_cutoff_period?: number;
871
- }
872
- export interface SubscriptionCheckoutExistingInputParam {
873
- id: string;
874
- plan_id?: string;
875
- plan_quantity?: number;
876
- plan_unit_price?: number;
877
- setup_fee?: number;
878
- plan_quantity_in_decimal?: string;
879
- plan_unit_price_in_decimal?: string;
880
- start_date?: number;
881
- trial_end?: number;
882
- /**
883
- * @deprecated Please refer API docs to use other attributes
884
- */
885
- coupon?: string;
886
- auto_collection?: AutoCollectionEnum;
887
- offline_payment_method?: OfflinePaymentMethodEnum;
888
- invoice_notes?: string;
889
- contract_term_billing_cycle_on_renewal?: number;
890
- }
891
- export interface CardCheckoutExistingInputParam {
892
- /**
893
- * @deprecated Please refer API docs to use other attributes
894
- */
895
- gateway?: GatewayEnum;
896
- gateway_account_id?: string;
897
- }
898
-
899
- export interface EventBasedAddonsCheckoutExistingInputParam {
900
- id?: string;
901
- quantity?: number;
902
- unit_price?: number;
903
- service_period_in_days?: number;
904
- charge_on?: ChargeOnEnum;
905
- on_event?: OnEventEnum;
906
- charge_once?: boolean;
907
- quantity_in_decimal?: string;
908
- unit_price_in_decimal?: string;
909
- }
910
- export interface AddonsCheckoutExistingInputParam {
911
- id?: string;
912
- quantity?: number;
913
- unit_price?: number;
914
- billing_cycles?: number;
915
- quantity_in_decimal?: string;
916
- unit_price_in_decimal?: string;
917
- }
918
- export interface CustomerCheckoutExistingForItemsInputParam {
919
- vat_number?: string;
920
- vat_number_prefix?: string;
921
- is_einvoice_enabled?: boolean;
922
- entity_identifier_scheme?: string;
923
- entity_identifier_standard?: string;
924
- }
925
- export interface ContractTermCheckoutExistingForItemsInputParam {
926
- action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
927
- cancellation_cutoff_period?: number;
928
- }
929
- export interface SubscriptionCheckoutExistingForItemsInputParam {
930
- id: string;
931
- /**
932
- * @deprecated Please refer API docs to use other attributes
933
- */
934
- setup_fee?: number;
935
- start_date?: number;
936
- trial_end?: number;
937
- /**
938
- * @deprecated Please refer API docs to use other attributes
939
- */
940
- coupon?: string;
941
- auto_collection?: AutoCollectionEnum;
942
- offline_payment_method?: OfflinePaymentMethodEnum;
943
- invoice_notes?: string;
944
- contract_term_billing_cycle_on_renewal?: number;
945
- }
946
- export interface CardCheckoutExistingForItemsInputParam {
947
- /**
948
- * @deprecated Please refer API docs to use other attributes
949
- */
950
- gateway?: GatewayEnum;
951
- gateway_account_id?: string;
952
- }
953
-
954
- export interface SubscriptionItemsCheckoutExistingForItemsInputParam {
955
- item_price_id: string;
956
- quantity?: number;
957
- quantity_in_decimal?: string;
958
- unit_price?: number;
959
- unit_price_in_decimal?: string;
960
- billing_cycles?: number;
961
- trial_end?: number;
962
- service_period_days?: number;
963
- charge_on_event?: ChargeOnEventEnum;
964
- charge_once?: boolean;
965
- charge_on_option?: ChargeOnOptionEnum;
966
- /**
967
- * @deprecated Please refer API docs to use other attributes
968
- */
969
- item_type?: ItemTypeEnum;
970
- }
971
- export interface DiscountsCheckoutExistingForItemsInputParam {
972
- apply_on: ApplyOnEnum;
973
- duration_type: DurationTypeEnum;
974
- percentage?: number;
975
- amount?: number;
976
- period?: number;
977
- period_unit?: PeriodUnitEnum;
978
- included_in_mrr?: boolean;
979
- item_price_id?: string;
980
- operation_type: OperationTypeEnum;
981
- id?: string;
982
- }
983
- export interface EntityIdentifiersCheckoutExistingForItemsInputParam {
984
- id?: string;
985
- scheme?: string;
986
- value?: string;
987
- operation?: OperationEnum;
988
- standard?: string;
989
- }
990
- export interface ItemTiersCheckoutExistingForItemsInputParam {
991
- item_price_id?: string;
992
- starting_unit?: number;
993
- ending_unit?: number;
994
- price?: number;
995
- starting_unit_in_decimal?: string;
996
- ending_unit_in_decimal?: string;
997
- price_in_decimal?: string;
998
- }
999
- export interface CustomerUpdateCardInputParam {
1000
- id: string;
1001
- /**
1002
- * @deprecated Please refer API docs to use other attributes
1003
- */
1004
- vat_number?: string;
1005
- /**
1006
- * @deprecated Please refer API docs to use other attributes
1007
- */
1008
- vat_number_prefix?: string;
1009
- }
1010
- export interface CardUpdateCardInputParam {
1011
- /**
1012
- * @deprecated Please refer API docs to use other attributes
1013
- */
1014
- gateway?: GatewayEnum;
1015
- gateway_account_id?: string;
1016
- }
1017
-
1018
- export interface CustomerUpdatePaymentMethodInputParam {
1019
- id: string;
1020
- /**
1021
- * @deprecated Please refer API docs to use other attributes
1022
- */
1023
- vat_number?: string;
1024
- /**
1025
- * @deprecated Please refer API docs to use other attributes
1026
- */
1027
- vat_number_prefix?: string;
1028
- }
1029
- export interface CardUpdatePaymentMethodInputParam {
1030
- /**
1031
- * @deprecated Please refer API docs to use other attributes
1032
- */
1033
- gateway?: GatewayEnum;
1034
- gateway_account_id?: string;
1035
- }
1036
-
1037
- export interface CustomerManagePaymentSourcesInputParam {
1038
- id: string;
1039
- }
1040
- export interface CardManagePaymentSourcesInputParam {
1041
- /**
1042
- * @deprecated Please refer API docs to use other attributes
1043
- */
1044
- gateway?: GatewayEnum;
1045
- gateway_account_id?: string;
1046
- }
1047
-
1048
- export interface CustomerCollectNowInputParam {
1049
- id: string;
1050
- }
1051
- export interface CardCollectNowInputParam {
1052
- /**
1053
- * @deprecated Please refer API docs to use other attributes
1054
- */
1055
- gateway?: GatewayEnum;
1056
- gateway_account_id?: string;
1057
- }
1058
-
1059
- export interface QuoteAcceptQuoteInputParam {
1060
- id: string;
1061
- }
1062
-
1063
- export interface SubscriptionExtendSubscriptionInputParam {
1064
- id: string;
1065
- }
1066
-
1067
- export interface GifterCheckoutGiftInputParam {
1068
- customer_id?: string;
1069
- }
1070
- export interface SubscriptionCheckoutGiftInputParam {
1071
- plan_id: string;
1072
- plan_quantity?: number;
1073
- plan_quantity_in_decimal?: string;
1074
- /**
1075
- * @deprecated Please refer API docs to use other attributes
1076
- */
1077
- coupon?: string;
1078
- }
1079
-
1080
- export interface AddonsCheckoutGiftInputParam {
1081
- id?: string;
1082
- quantity?: number;
1083
- quantity_in_decimal?: string;
1084
- }
1085
- export interface GifterCheckoutGiftForItemsInputParam {
1086
- customer_id?: string;
1087
- }
1088
-
1089
- export interface SubscriptionItemsCheckoutGiftForItemsInputParam {
1090
- item_price_id?: string;
1091
- quantity?: number;
1092
- quantity_in_decimal?: string;
1093
- }
1094
- export interface GiftClaimGiftInputParam {
1095
- id: string;
1096
- }
1097
- export interface CustomerClaimGiftInputParam {
1098
- locale?: string;
1099
- }
1100
-
1101
- export interface SubscriptionPreCancelInputParam {
1102
- id: string;
1103
- }
1104
-
1105
- export interface CustomerViewVoucherInputParam {
1106
- locale?: string;
1107
- }
1108
- export interface PaymentVoucherViewVoucherInputParam {
1109
- id: string;
1110
- }
1111
- }
1112
- }