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,2443 +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 Subscription {
6
- [key: string]: unknown;
7
- id: string;
8
- currency_code: string;
9
- plan_id: string;
10
- plan_quantity: number;
11
- plan_unit_price?: number;
12
- setup_fee?: number;
13
- billing_period?: number;
14
- billing_period_unit?: 'day' | 'week' | 'month' | 'year';
15
- start_date?: number;
16
- trial_end?: number;
17
- remaining_billing_cycles?: number;
18
- po_number?: string;
19
- auto_collection?: AutoCollectionEnum;
20
- plan_quantity_in_decimal?: string;
21
- plan_unit_price_in_decimal?: string;
22
- customer_id: string;
23
- plan_amount?: number;
24
- plan_free_quantity?: number;
25
- status:
26
- | 'future'
27
- | 'in_trial'
28
- | 'active'
29
- | 'non_renewing'
30
- | 'paused'
31
- | 'cancelled'
32
- | 'transferred';
33
- trial_start?: number;
34
- trial_end_action?: TrialEndActionEnum;
35
- current_term_start?: number;
36
- current_term_end?: number;
37
- next_billing_at?: number;
38
- created_at?: number;
39
- started_at?: number;
40
- activated_at?: number;
41
- gift_id?: string;
42
- contract_term_billing_cycle_on_renewal?: number;
43
- override_relationship?: boolean;
44
- pause_date?: number;
45
- resume_date?: number;
46
- cancelled_at?: number;
47
- cancel_reason?:
48
- | 'not_paid'
49
- | 'no_card'
50
- | 'fraud_review_failed'
51
- | 'non_compliant_eu_customer'
52
- | 'tax_calculation_failed'
53
- | 'currency_incompatible_with_gateway'
54
- | 'non_compliant_customer';
55
- affiliate_token?: string;
56
- created_from_ip?: string;
57
- resource_version?: number;
58
- updated_at?: number;
59
- has_scheduled_advance_invoices: boolean;
60
- has_scheduled_changes: boolean;
61
- payment_source_id?: string;
62
- plan_free_quantity_in_decimal?: string;
63
- plan_amount_in_decimal?: string;
64
- cancel_schedule_created_at?: number;
65
- offline_payment_method?: OfflinePaymentMethodEnum;
66
- channel?: ChannelEnum;
67
- net_term_days?: number;
68
- active_id?: string;
69
- subscription_items?: Subscription.SubscriptionItem[];
70
- item_tiers?: Subscription.ItemTier[];
71
- charged_items?: Subscription.ChargedItem[];
72
- due_invoices_count?: number;
73
- due_since?: number;
74
- total_dues?: number;
75
- mrr?: number;
76
- arr?: number;
77
- exchange_rate?: number;
78
- base_currency_code?: string;
79
- addons?: Subscription.Addon[];
80
- event_based_addons?: Subscription.EventBasedAddon[];
81
- charged_event_based_addons?: Subscription.ChargedEventBasedAddon[];
82
- coupon?: string;
83
- coupons?: Subscription.Coupon[];
84
- shipping_address?: Subscription.ShippingAddress;
85
- referral_info?: Subscription.ReferralInfo;
86
- invoice_notes?: string;
87
- meta_data?: any;
88
- metadata?: any;
89
- deleted: boolean;
90
- changes_scheduled_at?: number;
91
- contract_term?: Subscription.ContractTerm;
92
- cancel_reason_code?: string;
93
- free_period?: number;
94
- free_period_unit?: FreePeriodUnitEnum;
95
- create_pending_invoices?: boolean;
96
- auto_close_invoices?: boolean;
97
- discounts?: Subscription.Discount[];
98
- business_entity_id?: string;
99
- }
100
-
101
- export namespace Subscription {
102
- export class SubscriptionResource {
103
- create(
104
- input: CreateInputParam,
105
- headers?: ChargebeeRequestHeader,
106
- ): Promise<ChargebeeResponse<CreateResponse>>;
107
-
108
- createForCustomer(
109
- customer_id: string,
110
- input: CreateForCustomerInputParam,
111
- headers?: ChargebeeRequestHeader,
112
- ): Promise<ChargebeeResponse<CreateForCustomerResponse>>;
113
-
114
- createWithItems(
115
- customer_id: string,
116
- input: CreateWithItemsInputParam,
117
- headers?: ChargebeeRequestHeader,
118
- ): Promise<ChargebeeResponse<CreateWithItemsResponse>>;
119
-
120
- list(
121
- input?: ListInputParam,
122
- headers?: ChargebeeRequestHeader,
123
- ): Promise<ChargebeeResponse<ListResponse>>;
124
-
125
- subscriptionsForCustomer(
126
- customer_id: string,
127
- input?: SubscriptionsForCustomerInputParam,
128
- headers?: ChargebeeRequestHeader,
129
- ): Promise<ChargebeeResponse<SubscriptionsForCustomerResponse>>;
130
-
131
- contractTermsForSubscription(
132
- subscription_id: string,
133
- input?: ContractTermsForSubscriptionInputParam,
134
- headers?: ChargebeeRequestHeader,
135
- ): Promise<ChargebeeResponse<ContractTermsForSubscriptionResponse>>;
136
-
137
- listDiscounts(
138
- subscription_id: string,
139
- input?: ListDiscountsInputParam,
140
- headers?: ChargebeeRequestHeader,
141
- ): Promise<ChargebeeResponse<ListDiscountsResponse>>;
142
-
143
- retrieve(
144
- subscription_id: string,
145
- headers?: ChargebeeRequestHeader,
146
- ): Promise<ChargebeeResponse<RetrieveResponse>>;
147
-
148
- retrieveWithScheduledChanges(
149
- subscription_id: string,
150
- headers?: ChargebeeRequestHeader,
151
- ): Promise<ChargebeeResponse<RetrieveWithScheduledChangesResponse>>;
152
-
153
- removeScheduledChanges(
154
- subscription_id: string,
155
- headers?: ChargebeeRequestHeader,
156
- ): Promise<ChargebeeResponse<RemoveScheduledChangesResponse>>;
157
-
158
- removeScheduledCancellation(
159
- subscription_id: string,
160
- input?: RemoveScheduledCancellationInputParam,
161
- headers?: ChargebeeRequestHeader,
162
- ): Promise<ChargebeeResponse<RemoveScheduledCancellationResponse>>;
163
-
164
- removeCoupons(
165
- subscription_id: string,
166
- input?: RemoveCouponsInputParam,
167
- headers?: ChargebeeRequestHeader,
168
- ): Promise<ChargebeeResponse<RemoveCouponsResponse>>;
169
-
170
- update(
171
- subscription_id: string,
172
- input?: UpdateInputParam,
173
- headers?: ChargebeeRequestHeader,
174
- ): Promise<ChargebeeResponse<UpdateResponse>>;
175
-
176
- updateForItems(
177
- subscription_id: string,
178
- input: UpdateForItemsInputParam,
179
- headers?: ChargebeeRequestHeader,
180
- ): Promise<ChargebeeResponse<UpdateForItemsResponse>>;
181
-
182
- changeTermEnd(
183
- subscription_id: string,
184
- input: ChangeTermEndInputParam,
185
- headers?: ChargebeeRequestHeader,
186
- ): Promise<ChargebeeResponse<ChangeTermEndResponse>>;
187
-
188
- reactivate(
189
- subscription_id: string,
190
- input?: ReactivateInputParam,
191
- headers?: ChargebeeRequestHeader,
192
- ): Promise<ChargebeeResponse<ReactivateResponse>>;
193
-
194
- addChargeAtTermEnd(
195
- subscription_id: string,
196
- input: AddChargeAtTermEndInputParam,
197
- headers?: ChargebeeRequestHeader,
198
- ): Promise<ChargebeeResponse<AddChargeAtTermEndResponse>>;
199
-
200
- chargeAddonAtTermEnd(
201
- subscription_id: string,
202
- input: ChargeAddonAtTermEndInputParam,
203
- headers?: ChargebeeRequestHeader,
204
- ): Promise<ChargebeeResponse<ChargeAddonAtTermEndResponse>>;
205
-
206
- chargeFutureRenewals(
207
- subscription_id: string,
208
- input?: ChargeFutureRenewalsInputParam,
209
- headers?: ChargebeeRequestHeader,
210
- ): Promise<ChargebeeResponse<ChargeFutureRenewalsResponse>>;
211
-
212
- editAdvanceInvoiceSchedule(
213
- subscription_id: string,
214
- input?: EditAdvanceInvoiceScheduleInputParam,
215
- headers?: ChargebeeRequestHeader,
216
- ): Promise<ChargebeeResponse<EditAdvanceInvoiceScheduleResponse>>;
217
-
218
- retrieveAdvanceInvoiceSchedule(
219
- subscription_id: string,
220
- headers?: ChargebeeRequestHeader,
221
- ): Promise<ChargebeeResponse<RetrieveAdvanceInvoiceScheduleResponse>>;
222
-
223
- removeAdvanceInvoiceSchedule(
224
- subscription_id: string,
225
- input?: RemoveAdvanceInvoiceScheduleInputParam,
226
- headers?: ChargebeeRequestHeader,
227
- ): Promise<ChargebeeResponse<RemoveAdvanceInvoiceScheduleResponse>>;
228
-
229
- regenerateInvoice(
230
- subscription_id: string,
231
- input?: RegenerateInvoiceInputParam,
232
- headers?: ChargebeeRequestHeader,
233
- ): Promise<ChargebeeResponse<RegenerateInvoiceResponse>>;
234
-
235
- importSubscription(
236
- input: ImportSubscriptionInputParam,
237
- headers?: ChargebeeRequestHeader,
238
- ): Promise<ChargebeeResponse<ImportSubscriptionResponse>>;
239
-
240
- importForCustomer(
241
- customer_id: string,
242
- input: ImportForCustomerInputParam,
243
- headers?: ChargebeeRequestHeader,
244
- ): Promise<ChargebeeResponse<ImportForCustomerResponse>>;
245
-
246
- importContractTerm(
247
- subscription_id: string,
248
- input?: ImportContractTermInputParam,
249
- headers?: ChargebeeRequestHeader,
250
- ): Promise<ChargebeeResponse<ImportContractTermResponse>>;
251
-
252
- importUnbilledCharges(
253
- subscription_id: string,
254
- input: ImportUnbilledChargesInputParam,
255
- headers?: ChargebeeRequestHeader,
256
- ): Promise<ChargebeeResponse<ImportUnbilledChargesResponse>>;
257
-
258
- importForItems(
259
- customer_id: string,
260
- input: ImportForItemsInputParam,
261
- headers?: ChargebeeRequestHeader,
262
- ): Promise<ChargebeeResponse<ImportForItemsResponse>>;
263
-
264
- overrideBillingProfile(
265
- subscription_id: string,
266
- input?: OverrideBillingProfileInputParam,
267
- headers?: ChargebeeRequestHeader,
268
- ): Promise<ChargebeeResponse<OverrideBillingProfileResponse>>;
269
-
270
- delete(
271
- subscription_id: string,
272
- headers?: ChargebeeRequestHeader,
273
- ): Promise<ChargebeeResponse<DeleteResponse>>;
274
-
275
- pause(
276
- subscription_id: string,
277
- input?: PauseInputParam,
278
- headers?: ChargebeeRequestHeader,
279
- ): Promise<ChargebeeResponse<PauseResponse>>;
280
-
281
- cancel(
282
- subscription_id: string,
283
- input?: CancelInputParam,
284
- headers?: ChargebeeRequestHeader,
285
- ): Promise<ChargebeeResponse<CancelResponse>>;
286
-
287
- cancelForItems(
288
- subscription_id: string,
289
- input?: CancelForItemsInputParam,
290
- headers?: ChargebeeRequestHeader,
291
- ): Promise<ChargebeeResponse<CancelForItemsResponse>>;
292
-
293
- resume(
294
- subscription_id: string,
295
- input?: ResumeInputParam,
296
- headers?: ChargebeeRequestHeader,
297
- ): Promise<ChargebeeResponse<ResumeResponse>>;
298
-
299
- removeScheduledPause(
300
- subscription_id: string,
301
- headers?: ChargebeeRequestHeader,
302
- ): Promise<ChargebeeResponse<RemoveScheduledPauseResponse>>;
303
-
304
- removeScheduledResumption(
305
- subscription_id: string,
306
- headers?: ChargebeeRequestHeader,
307
- ): Promise<ChargebeeResponse<RemoveScheduledResumptionResponse>>;
308
-
309
- move(
310
- subscription_id: string,
311
- input: MoveInputParam,
312
- headers?: ChargebeeRequestHeader,
313
- ): Promise<ChargebeeResponse<MoveResponse>>;
314
- }
315
-
316
- export interface CreateResponse {
317
- subscription: Subscription;
318
- customer: Customer;
319
- card?: Card;
320
- invoice?: Invoice;
321
- unbilled_charges?: UnbilledCharge[];
322
- }
323
-
324
- export interface CreateForCustomerResponse {
325
- subscription: Subscription;
326
- customer: Customer;
327
- card?: Card;
328
- invoice?: Invoice;
329
- unbilled_charges?: UnbilledCharge[];
330
- }
331
-
332
- export interface CreateWithItemsResponse {
333
- subscription: Subscription;
334
- customer: Customer;
335
- card?: Card;
336
- invoice?: Invoice;
337
- unbilled_charges?: UnbilledCharge[];
338
- }
339
-
340
- export interface ListResponse {
341
- list: { subscription: Subscription; customer: Customer; card?: Card }[];
342
- next_offset?: string;
343
- }
344
-
345
- export interface SubscriptionsForCustomerResponse {
346
- list: { subscription: Subscription }[];
347
- next_offset?: string;
348
- }
349
-
350
- export interface ContractTermsForSubscriptionResponse {
351
- list: { contract_term: ContractTerm }[];
352
- next_offset?: string;
353
- }
354
-
355
- export interface ListDiscountsResponse {
356
- list: { discount: Discount }[];
357
- next_offset?: string;
358
- }
359
-
360
- export interface RetrieveResponse {
361
- subscription: Subscription;
362
- customer: Customer;
363
- card?: Card;
364
- }
365
-
366
- export interface RetrieveWithScheduledChangesResponse {
367
- subscription: Subscription;
368
- customer: Customer;
369
- card?: Card;
370
- }
371
-
372
- export interface RemoveScheduledChangesResponse {
373
- subscription: Subscription;
374
- customer: Customer;
375
- card?: Card;
376
- credit_notes?: CreditNote[];
377
- }
378
-
379
- export interface RemoveScheduledCancellationResponse {
380
- subscription: Subscription;
381
- customer: Customer;
382
- card?: Card;
383
- }
384
-
385
- export interface RemoveCouponsResponse {
386
- subscription: Subscription;
387
- customer: Customer;
388
- card?: Card;
389
- }
390
-
391
- export interface UpdateResponse {
392
- subscription: Subscription;
393
- customer: Customer;
394
- card?: Card;
395
- invoice?: Invoice;
396
- unbilled_charges?: UnbilledCharge[];
397
- credit_notes?: CreditNote[];
398
- }
399
-
400
- export interface UpdateForItemsResponse {
401
- subscription: Subscription;
402
- customer: Customer;
403
- card?: Card;
404
- invoice?: Invoice;
405
- unbilled_charges?: UnbilledCharge[];
406
- credit_notes?: CreditNote[];
407
- }
408
-
409
- export interface ChangeTermEndResponse {
410
- subscription: Subscription;
411
- customer: Customer;
412
- card?: Card;
413
- invoice?: Invoice;
414
- unbilled_charges?: UnbilledCharge[];
415
- credit_notes?: CreditNote[];
416
- }
417
-
418
- export interface ReactivateResponse {
419
- subscription: Subscription;
420
- customer: Customer;
421
- card?: Card;
422
- invoice?: Invoice;
423
- unbilled_charges?: UnbilledCharge[];
424
- }
425
-
426
- export interface AddChargeAtTermEndResponse {
427
- estimate: Estimate;
428
- }
429
-
430
- export interface ChargeAddonAtTermEndResponse {
431
- estimate: Estimate;
432
- }
433
-
434
- export interface ChargeFutureRenewalsResponse {
435
- subscription: Subscription;
436
- customer: Customer;
437
- card?: Card;
438
- invoice?: Invoice;
439
- advance_invoice_schedules?: AdvanceInvoiceSchedule[];
440
- }
441
-
442
- export interface EditAdvanceInvoiceScheduleResponse {
443
- advance_invoice_schedules: AdvanceInvoiceSchedule[];
444
- }
445
-
446
- export interface RetrieveAdvanceInvoiceScheduleResponse {
447
- advance_invoice_schedules: AdvanceInvoiceSchedule[];
448
- }
449
-
450
- export interface RemoveAdvanceInvoiceScheduleResponse {
451
- subscription: Subscription;
452
- advance_invoice_schedules?: AdvanceInvoiceSchedule[];
453
- }
454
-
455
- export interface RegenerateInvoiceResponse {
456
- invoice?: Invoice;
457
- unbilled_charges?: UnbilledCharge[];
458
- }
459
-
460
- export interface ImportSubscriptionResponse {
461
- subscription: Subscription;
462
- customer: Customer;
463
- card?: Card;
464
- invoice?: Invoice;
465
- }
466
-
467
- export interface ImportForCustomerResponse {
468
- subscription: Subscription;
469
- customer: Customer;
470
- card?: Card;
471
- invoice?: Invoice;
472
- }
473
-
474
- export interface ImportContractTermResponse {
475
- contract_term: ContractTerm;
476
- }
477
-
478
- export interface ImportUnbilledChargesResponse {
479
- unbilled_charges: UnbilledCharge[];
480
- }
481
-
482
- export interface ImportForItemsResponse {
483
- subscription: Subscription;
484
- customer: Customer;
485
- card?: Card;
486
- invoice?: Invoice;
487
- }
488
-
489
- export interface OverrideBillingProfileResponse {
490
- subscription: Subscription;
491
- payment_source?: PaymentSource;
492
- }
493
-
494
- export interface DeleteResponse {
495
- subscription: Subscription;
496
- customer: Customer;
497
- card?: Card;
498
- }
499
-
500
- export interface PauseResponse {
501
- subscription: Subscription;
502
- customer: Customer;
503
- card?: Card;
504
- invoice?: Invoice;
505
- unbilled_charges?: UnbilledCharge[];
506
- credit_notes?: CreditNote[];
507
- }
508
-
509
- export interface CancelResponse {
510
- subscription: Subscription;
511
- customer: Customer;
512
- card?: Card;
513
- invoice?: Invoice;
514
- unbilled_charges?: UnbilledCharge[];
515
- credit_notes?: CreditNote[];
516
- }
517
-
518
- export interface CancelForItemsResponse {
519
- subscription: Subscription;
520
- customer: Customer;
521
- card?: Card;
522
- invoice?: Invoice;
523
- unbilled_charges?: UnbilledCharge[];
524
- credit_notes?: CreditNote[];
525
- }
526
-
527
- export interface ResumeResponse {
528
- subscription: Subscription;
529
- customer: Customer;
530
- card?: Card;
531
- invoice?: Invoice;
532
- unbilled_charges?: UnbilledCharge[];
533
- }
534
-
535
- export interface RemoveScheduledPauseResponse {
536
- subscription: Subscription;
537
- customer: Customer;
538
- card?: Card;
539
- }
540
-
541
- export interface RemoveScheduledResumptionResponse {
542
- subscription: Subscription;
543
- customer: Customer;
544
- card?: Card;
545
- }
546
-
547
- export interface MoveResponse {
548
- subscription: Subscription;
549
- }
550
-
551
- export interface SubscriptionItem {
552
- item_price_id: string;
553
- item_type: 'plan' | 'addon' | 'charge';
554
- quantity?: number;
555
- quantity_in_decimal?: string;
556
- metered_quantity?: string;
557
- last_calculated_at?: number;
558
- unit_price?: number;
559
- unit_price_in_decimal?: string;
560
- amount?: number;
561
- amount_in_decimal?: string;
562
- billing_period?: number;
563
- billing_period_unit?: 'day' | 'week' | 'month' | 'year';
564
- free_quantity?: number;
565
- free_quantity_in_decimal?: string;
566
- trial_end?: number;
567
- billing_cycles?: number;
568
- service_period_days?: number;
569
- charge_on_event?:
570
- | 'subscription_creation'
571
- | 'subscription_trial_start'
572
- | 'plan_activation'
573
- | 'subscription_activation'
574
- | 'contract_termination';
575
- charge_once?: boolean;
576
- charge_on_option?: 'immediately' | 'on_event';
577
- proration_type?: 'full_term' | 'partial_term' | 'none';
578
- usage_accumulation_reset_frequency?:
579
- | 'never'
580
- | 'subscription_billing_frequency';
581
- }
582
- export interface ItemTier {
583
- item_price_id: string;
584
- starting_unit: number;
585
- ending_unit?: number;
586
- price: number;
587
- starting_unit_in_decimal?: string;
588
- ending_unit_in_decimal?: string;
589
- price_in_decimal?: string;
590
- index: number;
591
- }
592
- export interface ChargedItem {
593
- item_price_id: string;
594
- last_charged_at: number;
595
- }
596
- export interface Addon {
597
- id: string;
598
- quantity?: number;
599
- unit_price?: number;
600
- amount?: number;
601
- trial_end?: number;
602
- remaining_billing_cycles?: number;
603
- quantity_in_decimal?: string;
604
- unit_price_in_decimal?: string;
605
- amount_in_decimal?: string;
606
- proration_type?: 'full_term' | 'partial_term' | 'none';
607
- }
608
- export interface EventBasedAddon {
609
- id: string;
610
- quantity: number;
611
- unit_price: number;
612
- service_period_in_days?: number;
613
- on_event:
614
- | 'subscription_creation'
615
- | 'subscription_trial_start'
616
- | 'plan_activation'
617
- | 'subscription_activation'
618
- | 'contract_termination';
619
- charge_once: boolean;
620
- quantity_in_decimal?: string;
621
- unit_price_in_decimal?: string;
622
- }
623
- export interface ChargedEventBasedAddon {
624
- id: string;
625
- last_charged_at: number;
626
- }
627
- export interface Coupon {
628
- coupon_id: string;
629
- apply_till?: number;
630
- applied_count: number;
631
- coupon_code?: string;
632
- }
633
- export interface ShippingAddress {
634
- first_name?: string;
635
- last_name?: string;
636
- email?: string;
637
- company?: string;
638
- phone?: string;
639
- line1?: string;
640
- line2?: string;
641
- line3?: string;
642
- city?: string;
643
- state_code?: string;
644
- state?: string;
645
- country?: string;
646
- zip?: string;
647
- validation_status?: ValidationStatusEnum;
648
- index: number;
649
- }
650
- export interface ReferralInfo {
651
- referral_code?: string;
652
- coupon_code?: string;
653
- referrer_id?: string;
654
- external_reference_id?: string;
655
- reward_status?: 'pending' | 'paid' | 'invalid';
656
- referral_system?: ReferralSystemEnum;
657
- account_id: string;
658
- campaign_id: string;
659
- external_campaign_id?: string;
660
- friend_offer_type?: FriendOfferTypeEnum;
661
- referrer_reward_type?: ReferrerRewardTypeEnum;
662
- notify_referral_system?: NotifyReferralSystemEnum;
663
- destination_url?: string;
664
- post_purchase_widget_enabled: boolean;
665
- }
666
- export interface ContractTerm {
667
- id: string;
668
- status: 'active' | 'completed' | 'cancelled' | 'terminated';
669
- contract_start: number;
670
- contract_end: number;
671
- billing_cycle: number;
672
- action_at_term_end: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
673
- total_contract_value: number;
674
- total_contract_value_before_tax: number;
675
- cancellation_cutoff_period?: number;
676
- created_at: number;
677
- subscription_id: string;
678
- remaining_billing_cycles?: number;
679
- }
680
- export interface Discount {
681
- id: string;
682
- invoice_name?: string;
683
- type: 'fixed_amount' | 'percentage';
684
- percentage?: number;
685
- amount?: number;
686
- currency_code?: string;
687
- duration_type: 'one_time' | 'forever' | 'limited_period';
688
- period?: number;
689
- period_unit?: 'day' | 'week' | 'month' | 'year';
690
- included_in_mrr: boolean;
691
- apply_on: 'invoice_amount' | 'specific_item_price';
692
- item_price_id?: string;
693
- created_at: number;
694
- apply_till?: number;
695
- applied_count?: number;
696
- coupon_id: string;
697
- index: number;
698
- }
699
- // REQUEST PARAMS
700
- //---------------
701
-
702
- export interface CreateInputParam {
703
- id?: string;
704
- plan_id: string;
705
- plan_quantity?: number;
706
- plan_quantity_in_decimal?: string;
707
- plan_unit_price?: number;
708
- plan_unit_price_in_decimal?: string;
709
- setup_fee?: number;
710
- trial_end?: number;
711
- billing_cycles?: number;
712
- mandatory_addons_to_remove?: string[];
713
- start_date?: number /**
714
- * @deprecated Please refer API docs to use other attributes
715
- */;
716
-
717
- coupon?: string;
718
- auto_collection?: AutoCollectionEnum;
719
- terms_to_charge?: number;
720
- billing_alignment_mode?: BillingAlignmentModeEnum;
721
- offline_payment_method?: OfflinePaymentMethodEnum;
722
- po_number?: string;
723
- coupon_ids?: string[];
724
- token_id?: string;
725
- affiliate_token?: string /**
726
- * @deprecated Please refer API docs to use other attributes
727
- */;
728
-
729
- created_from_ip?: string;
730
- invoice_notes?: string;
731
- invoice_date?: number;
732
- meta_data?: any;
733
- invoice_immediately?: boolean;
734
- free_period?: number;
735
- free_period_unit?: FreePeriodUnitEnum;
736
- contract_term_billing_cycle_on_renewal?: number;
737
- trial_end_action?: TrialEndActionEnum;
738
- client_profile_id?: string;
739
- payment_initiator?: PaymentInitiatorEnum;
740
- customer?: CustomerCreateInputParam;
741
- card?: CardCreateInputParam;
742
- bank_account?: BankAccountCreateInputParam;
743
- payment_method?: PaymentMethodCreateInputParam;
744
- payment_intent?: PaymentIntentCreateInputParam;
745
- billing_address?: BillingAddressCreateInputParam;
746
- shipping_address?: ShippingAddressCreateInputParam;
747
- statement_descriptor?: StatementDescriptorCreateInputParam;
748
- contract_term?: ContractTermCreateInputParam;
749
- entity_identifiers?: EntityIdentifiersCreateInputParam[];
750
- tax_providers_fields?: TaxProvidersFieldsCreateInputParam[];
751
- addons?: AddonsCreateInputParam[];
752
- event_based_addons?: EventBasedAddonsCreateInputParam[];
753
- coupons?: CouponsCreateInputParam[];
754
- [key: `cf_${string}`]: unknown;
755
- }
756
- export interface CreateForCustomerInputParam {
757
- id?: string;
758
- plan_id: string;
759
- plan_quantity?: number;
760
- plan_quantity_in_decimal?: string;
761
- plan_unit_price?: number;
762
- plan_unit_price_in_decimal?: string;
763
- setup_fee?: number;
764
- trial_end?: number;
765
- billing_cycles?: number;
766
- mandatory_addons_to_remove?: string[];
767
- start_date?: number /**
768
- * @deprecated Please refer API docs to use other attributes
769
- */;
770
-
771
- coupon?: string;
772
- auto_collection?: AutoCollectionEnum;
773
- terms_to_charge?: number;
774
- billing_alignment_mode?: BillingAlignmentModeEnum;
775
- offline_payment_method?: OfflinePaymentMethodEnum;
776
- po_number?: string;
777
- coupon_ids?: string[];
778
- payment_source_id?: string;
779
- override_relationship?: boolean;
780
- invoice_notes?: string;
781
- invoice_date?: number;
782
- meta_data?: any;
783
- invoice_immediately?: boolean;
784
- replace_primary_payment_source?: boolean;
785
- free_period?: number;
786
- free_period_unit?: FreePeriodUnitEnum;
787
- contract_term_billing_cycle_on_renewal?: number;
788
- trial_end_action?: TrialEndActionEnum;
789
- payment_initiator?: PaymentInitiatorEnum;
790
- shipping_address?: ShippingAddressCreateForCustomerInputParam;
791
- statement_descriptor?: StatementDescriptorCreateForCustomerInputParam;
792
- payment_intent?: PaymentIntentCreateForCustomerInputParam;
793
- contract_term?: ContractTermCreateForCustomerInputParam;
794
- addons?: AddonsCreateForCustomerInputParam[];
795
- event_based_addons?: EventBasedAddonsCreateForCustomerInputParam[];
796
- coupons?: CouponsCreateForCustomerInputParam[];
797
- [key: `cf_${string}`]: unknown;
798
- }
799
- export interface CreateWithItemsInputParam {
800
- id?: string;
801
- business_entity_id?: string;
802
- trial_end?: number;
803
- billing_cycles?: number /**
804
- * @deprecated Please refer API docs to use other attributes
805
- */;
806
-
807
- setup_fee?: number;
808
- mandatory_items_to_remove?: string[];
809
- net_term_days?: number;
810
- start_date?: number /**
811
- * @deprecated Please refer API docs to use other attributes
812
- */;
813
-
814
- coupon?: string;
815
- auto_collection?: AutoCollectionEnum;
816
- terms_to_charge?: number;
817
- billing_alignment_mode?: BillingAlignmentModeEnum;
818
- po_number?: string;
819
- coupon_ids?: string[];
820
- payment_source_id?: string;
821
- override_relationship?: boolean;
822
- invoice_notes?: string;
823
- invoice_date?: number;
824
- meta_data?: any;
825
- invoice_immediately?: boolean;
826
- replace_primary_payment_source?: boolean;
827
- free_period?: number;
828
- free_period_unit?: FreePeriodUnitEnum;
829
- contract_term_billing_cycle_on_renewal?: number;
830
- create_pending_invoices?: boolean;
831
- auto_close_invoices?: boolean;
832
- first_invoice_pending?: boolean;
833
- trial_end_action?: TrialEndActionEnum;
834
- payment_initiator?: PaymentInitiatorEnum;
835
- shipping_address?: ShippingAddressCreateWithItemsInputParam;
836
- statement_descriptor?: StatementDescriptorCreateWithItemsInputParam;
837
- payment_intent?: PaymentIntentCreateWithItemsInputParam;
838
- contract_term?: ContractTermCreateWithItemsInputParam;
839
- subscription_items?: SubscriptionItemsCreateWithItemsInputParam[];
840
- discounts?: DiscountsCreateWithItemsInputParam[];
841
- item_tiers?: ItemTiersCreateWithItemsInputParam[];
842
- coupons?: CouponsCreateWithItemsInputParam[];
843
- [key: `cf_${string}`]: unknown;
844
- }
845
- export interface ListInputParam {
846
- limit?: number;
847
- offset?: string;
848
- include_deleted?: boolean;
849
- id?: filter.String;
850
- customer_id?: filter.String;
851
- plan_id?: filter.String;
852
- item_id?: filter.String;
853
- item_price_id?: filter.String;
854
- status?: filter.Enum;
855
- cancel_reason?: filter.Enum;
856
- cancel_reason_code?: filter.String;
857
- remaining_billing_cycles?: filter.Number;
858
- created_at?: filter.Timestamp;
859
- activated_at?: filter.Timestamp;
860
- next_billing_at?: filter.Timestamp;
861
- cancelled_at?: filter.Timestamp;
862
- has_scheduled_changes?: filter.Boolean;
863
- updated_at?: filter.Timestamp;
864
- offline_payment_method?: filter.Enum;
865
- auto_close_invoices?: filter.Boolean;
866
- override_relationship?: filter.Boolean;
867
- business_entity_id?: filter.String;
868
- channel?: filter.Enum;
869
- 'sort_by[asc]'?: string;
870
- 'sort_by[desc]'?: string;
871
- [key: `cf_${string}`]: unknown;
872
- }
873
- export interface SubscriptionsForCustomerInputParam {
874
- limit?: number;
875
- offset?: string;
876
- }
877
- export interface ContractTermsForSubscriptionInputParam {
878
- limit?: number;
879
- offset?: string;
880
- }
881
- export interface ListDiscountsInputParam {
882
- limit?: number;
883
- offset?: string;
884
- }
885
- export interface RemoveScheduledCancellationInputParam {
886
- billing_cycles?: number;
887
- }
888
- export interface RemoveCouponsInputParam {
889
- coupon_ids?: string[];
890
- }
891
- export interface UpdateInputParam {
892
- plan_id?: string;
893
- plan_quantity?: number;
894
- plan_unit_price?: number;
895
- setup_fee?: number;
896
- replace_addon_list?: boolean;
897
- mandatory_addons_to_remove?: string[];
898
- plan_quantity_in_decimal?: string;
899
- plan_unit_price_in_decimal?: string;
900
- invoice_date?: number;
901
- start_date?: number;
902
- trial_end?: number;
903
- billing_cycles?: number /**
904
- * @deprecated Please refer API docs to use other attributes
905
- */;
906
-
907
- coupon?: string;
908
- terms_to_charge?: number;
909
- reactivate_from?: number;
910
- billing_alignment_mode?: BillingAlignmentModeEnum;
911
- auto_collection?: AutoCollectionEnum;
912
- offline_payment_method?: OfflinePaymentMethodEnum;
913
- po_number?: string;
914
- coupon_ids?: string[];
915
- replace_coupon_list?: boolean;
916
- prorate?: boolean;
917
- end_of_term?: boolean;
918
- force_term_reset?: boolean;
919
- reactivate?: boolean;
920
- token_id?: string;
921
- invoice_notes?: string;
922
- meta_data?: any;
923
- invoice_immediately?: boolean;
924
- override_relationship?: boolean;
925
- changes_scheduled_at?: number;
926
- change_option?: ChangeOptionEnum;
927
- contract_term_billing_cycle_on_renewal?: number;
928
- free_period?: number;
929
- free_period_unit?: FreePeriodUnitEnum;
930
- trial_end_action?: TrialEndActionEnum;
931
- card?: CardUpdateInputParam;
932
- payment_method?: PaymentMethodUpdateInputParam;
933
- payment_intent?: PaymentIntentUpdateInputParam;
934
- billing_address?: BillingAddressUpdateInputParam;
935
- shipping_address?: ShippingAddressUpdateInputParam;
936
- statement_descriptor?: StatementDescriptorUpdateInputParam;
937
- customer?: CustomerUpdateInputParam;
938
- contract_term?: ContractTermUpdateInputParam;
939
- addons?: AddonsUpdateInputParam[];
940
- coupons?: CouponsUpdateInputParam[];
941
- event_based_addons?: EventBasedAddonsUpdateInputParam[];
942
- [key: `cf_${string}`]: unknown;
943
- }
944
- export interface UpdateForItemsInputParam {
945
- mandatory_items_to_remove?: string[];
946
- replace_items_list?: boolean /**
947
- * @deprecated Please refer API docs to use other attributes
948
- */;
949
-
950
- setup_fee?: number;
951
- net_term_days?: number;
952
- invoice_date?: number;
953
- start_date?: number;
954
- trial_end?: number;
955
- billing_cycles?: number /**
956
- * @deprecated Please refer API docs to use other attributes
957
- */;
958
-
959
- coupon?: string;
960
- terms_to_charge?: number;
961
- reactivate_from?: number;
962
- billing_alignment_mode?: BillingAlignmentModeEnum;
963
- auto_collection?: AutoCollectionEnum;
964
- offline_payment_method?: OfflinePaymentMethodEnum;
965
- po_number?: string;
966
- coupon_ids?: string[];
967
- replace_coupon_list?: boolean;
968
- prorate?: boolean;
969
- end_of_term?: boolean;
970
- force_term_reset?: boolean;
971
- reactivate?: boolean;
972
- token_id?: string;
973
- invoice_notes?: string;
974
- meta_data?: any;
975
- invoice_immediately?: boolean;
976
- override_relationship?: boolean;
977
- changes_scheduled_at?: number;
978
- change_option?: ChangeOptionEnum;
979
- contract_term_billing_cycle_on_renewal?: number;
980
- free_period?: number;
981
- free_period_unit?: FreePeriodUnitEnum;
982
- create_pending_invoices?: boolean;
983
- auto_close_invoices?: boolean;
984
- trial_end_action?: TrialEndActionEnum;
985
- payment_initiator?: PaymentInitiatorEnum;
986
- invoice_usages?: boolean;
987
- card?: CardUpdateForItemsInputParam;
988
- payment_method?: PaymentMethodUpdateForItemsInputParam;
989
- payment_intent?: PaymentIntentUpdateForItemsInputParam;
990
- billing_address?: BillingAddressUpdateForItemsInputParam;
991
- shipping_address?: ShippingAddressUpdateForItemsInputParam;
992
- statement_descriptor?: StatementDescriptorUpdateForItemsInputParam;
993
- customer?: CustomerUpdateForItemsInputParam;
994
- contract_term?: ContractTermUpdateForItemsInputParam;
995
- subscription_items?: SubscriptionItemsUpdateForItemsInputParam[];
996
- discounts?: DiscountsUpdateForItemsInputParam[];
997
- item_tiers?: ItemTiersUpdateForItemsInputParam[];
998
- coupons?: CouponsUpdateForItemsInputParam[];
999
- [key: `cf_${string}`]: unknown;
1000
- }
1001
- export interface ChangeTermEndInputParam {
1002
- term_ends_at: number;
1003
- prorate?: boolean;
1004
- invoice_immediately?: boolean;
1005
- }
1006
- export interface ReactivateInputParam {
1007
- trial_end?: number;
1008
- billing_cycles?: number /**
1009
- * @deprecated Please refer API docs to use other attributes
1010
- */;
1011
-
1012
- trial_period_days?: number;
1013
- reactivate_from?: number;
1014
- invoice_immediately?: boolean;
1015
- billing_alignment_mode?: BillingAlignmentModeEnum;
1016
- terms_to_charge?: number;
1017
- invoice_date?: number;
1018
- contract_term_billing_cycle_on_renewal?: number;
1019
- payment_initiator?: PaymentInitiatorEnum;
1020
- contract_term?: ContractTermReactivateInputParam;
1021
- statement_descriptor?: StatementDescriptorReactivateInputParam;
1022
- payment_intent?: PaymentIntentReactivateInputParam;
1023
- }
1024
- export interface AddChargeAtTermEndInputParam {
1025
- amount?: number;
1026
- description: string;
1027
- amount_in_decimal?: string;
1028
- avalara_sale_type?: AvalaraSaleTypeEnum;
1029
- avalara_transaction_type?: number;
1030
- avalara_service_type?: number;
1031
- date_from?: number;
1032
- date_to?: number;
1033
- }
1034
- export interface ChargeAddonAtTermEndInputParam {
1035
- addon_id: string;
1036
- addon_quantity?: number;
1037
- addon_unit_price?: number;
1038
- addon_quantity_in_decimal?: string;
1039
- addon_unit_price_in_decimal?: string;
1040
- date_from?: number;
1041
- date_to?: number;
1042
- }
1043
- export interface ChargeFutureRenewalsInputParam {
1044
- terms_to_charge?: number;
1045
- invoice_immediately?: boolean;
1046
- schedule_type?: ScheduleTypeEnum;
1047
- fixed_interval_schedule?: FixedIntervalScheduleChargeFutureRenewalsInputParam;
1048
- specific_dates_schedule?: SpecificDatesScheduleChargeFutureRenewalsInputParam[];
1049
- }
1050
- export interface EditAdvanceInvoiceScheduleInputParam {
1051
- terms_to_charge?: number;
1052
- schedule_type?: ScheduleTypeEnum;
1053
- fixed_interval_schedule?: FixedIntervalScheduleEditAdvanceInvoiceScheduleInputParam;
1054
- specific_dates_schedule?: SpecificDatesScheduleEditAdvanceInvoiceScheduleInputParam[];
1055
- }
1056
- export interface RemoveAdvanceInvoiceScheduleInputParam {
1057
- specific_dates_schedule?: SpecificDatesScheduleRemoveAdvanceInvoiceScheduleInputParam[];
1058
- }
1059
- export interface RegenerateInvoiceInputParam {
1060
- date_from?: number;
1061
- date_to?: number;
1062
- prorate?: boolean;
1063
- invoice_immediately?: boolean;
1064
- }
1065
- export interface ImportSubscriptionInputParam {
1066
- id?: string;
1067
- client_profile_id?: string;
1068
- plan_id: string;
1069
- plan_quantity?: number;
1070
- plan_quantity_in_decimal?: string;
1071
- plan_unit_price?: number;
1072
- plan_unit_price_in_decimal?: string;
1073
- setup_fee?: number;
1074
- trial_end?: number;
1075
- billing_cycles?: number;
1076
- start_date?: number;
1077
- auto_collection?: AutoCollectionEnum;
1078
- po_number?: string;
1079
- coupon_ids?: string[];
1080
- contract_term_billing_cycle_on_renewal?: number;
1081
- status:
1082
- | 'future'
1083
- | 'in_trial'
1084
- | 'active'
1085
- | 'non_renewing'
1086
- | 'paused'
1087
- | 'cancelled'
1088
- | 'transferred';
1089
- current_term_end?: number;
1090
- current_term_start?: number;
1091
- trial_start?: number;
1092
- cancelled_at?: number;
1093
- started_at?: number;
1094
- activated_at?: number;
1095
- pause_date?: number;
1096
- resume_date?: number;
1097
- create_current_term_invoice?: boolean;
1098
- affiliate_token?: string;
1099
- invoice_notes?: string;
1100
- meta_data?: any;
1101
- customer?: CustomerImportSubscriptionInputParam;
1102
- contract_term?: ContractTermImportSubscriptionInputParam;
1103
- card?: CardImportSubscriptionInputParam;
1104
- payment_method?: PaymentMethodImportSubscriptionInputParam;
1105
- billing_address?: BillingAddressImportSubscriptionInputParam;
1106
- shipping_address?: ShippingAddressImportSubscriptionInputParam;
1107
- transaction?: TransactionImportSubscriptionInputParam;
1108
- addons?: AddonsImportSubscriptionInputParam[];
1109
- event_based_addons?: EventBasedAddonsImportSubscriptionInputParam[];
1110
- charged_event_based_addons?: ChargedEventBasedAddonsImportSubscriptionInputParam[];
1111
- coupons?: CouponsImportSubscriptionInputParam[];
1112
- [key: `cf_${string}`]: unknown;
1113
- }
1114
- export interface ImportForCustomerInputParam {
1115
- id?: string;
1116
- plan_id: string;
1117
- plan_quantity?: number;
1118
- plan_quantity_in_decimal?: string;
1119
- plan_unit_price?: number;
1120
- plan_unit_price_in_decimal?: string;
1121
- setup_fee?: number;
1122
- trial_end?: number;
1123
- billing_cycles?: number;
1124
- start_date?: number;
1125
- auto_collection?: AutoCollectionEnum;
1126
- po_number?: string;
1127
- coupon_ids?: string[];
1128
- payment_source_id?: string;
1129
- status:
1130
- | 'future'
1131
- | 'in_trial'
1132
- | 'active'
1133
- | 'non_renewing'
1134
- | 'paused'
1135
- | 'cancelled'
1136
- | 'transferred';
1137
- current_term_end?: number;
1138
- current_term_start?: number;
1139
- trial_start?: number;
1140
- cancelled_at?: number;
1141
- started_at?: number;
1142
- activated_at?: number;
1143
- pause_date?: number;
1144
- resume_date?: number;
1145
- contract_term_billing_cycle_on_renewal?: number;
1146
- create_current_term_invoice?: boolean;
1147
- invoice_notes?: string;
1148
- meta_data?: any;
1149
- contract_term?: ContractTermImportForCustomerInputParam;
1150
- transaction?: TransactionImportForCustomerInputParam;
1151
- shipping_address?: ShippingAddressImportForCustomerInputParam;
1152
- addons?: AddonsImportForCustomerInputParam[];
1153
- event_based_addons?: EventBasedAddonsImportForCustomerInputParam[];
1154
- charged_event_based_addons?: ChargedEventBasedAddonsImportForCustomerInputParam[];
1155
- coupons?: CouponsImportForCustomerInputParam[];
1156
- [key: `cf_${string}`]: unknown;
1157
- }
1158
- export interface ImportContractTermInputParam {
1159
- contract_term_billing_cycle_on_renewal?: number;
1160
- contract_term?: ContractTermImportContractTermInputParam;
1161
- }
1162
- export interface ImportUnbilledChargesInputParam {
1163
- unbilled_charges?: UnbilledChargesImportUnbilledChargesInputParam[];
1164
- discounts?: DiscountsImportUnbilledChargesInputParam[];
1165
- tiers?: TiersImportUnbilledChargesInputParam[];
1166
- }
1167
- export interface ImportForItemsInputParam {
1168
- id?: string;
1169
- trial_end?: number;
1170
- billing_cycles?: number /**
1171
- * @deprecated Please refer API docs to use other attributes
1172
- */;
1173
-
1174
- setup_fee?: number;
1175
- net_term_days?: number;
1176
- start_date?: number;
1177
- auto_collection?: AutoCollectionEnum;
1178
- po_number?: string;
1179
- coupon_ids?: string[];
1180
- payment_source_id?: string;
1181
- status:
1182
- | 'future'
1183
- | 'in_trial'
1184
- | 'active'
1185
- | 'non_renewing'
1186
- | 'paused'
1187
- | 'cancelled'
1188
- | 'transferred';
1189
- current_term_end?: number;
1190
- current_term_start?: number;
1191
- trial_start?: number;
1192
- cancelled_at?: number;
1193
- started_at?: number;
1194
- activated_at?: number;
1195
- pause_date?: number;
1196
- resume_date?: number;
1197
- contract_term_billing_cycle_on_renewal?: number;
1198
- create_current_term_invoice?: boolean;
1199
- invoice_notes?: string;
1200
- meta_data?: any;
1201
- cancel_reason_code?: string;
1202
- create_pending_invoices?: boolean;
1203
- auto_close_invoices?: boolean;
1204
- contract_term?: ContractTermImportForItemsInputParam;
1205
- transaction?: TransactionImportForItemsInputParam;
1206
- shipping_address?: ShippingAddressImportForItemsInputParam;
1207
- subscription_items?: SubscriptionItemsImportForItemsInputParam[];
1208
- discounts?: DiscountsImportForItemsInputParam[];
1209
- charged_items?: ChargedItemsImportForItemsInputParam[];
1210
- item_tiers?: ItemTiersImportForItemsInputParam[];
1211
- coupons?: CouponsImportForItemsInputParam[];
1212
- [key: `cf_${string}`]: unknown;
1213
- }
1214
- export interface OverrideBillingProfileInputParam {
1215
- payment_source_id?: string;
1216
- auto_collection?: AutoCollectionEnum;
1217
- }
1218
- export interface PauseInputParam {
1219
- pause_option?: PauseOptionEnum;
1220
- pause_date?: number;
1221
- unbilled_charges_handling?: UnbilledChargesHandlingEnum;
1222
- invoice_dunning_handling?: InvoiceDunningHandlingEnum;
1223
- skip_billing_cycles?: number;
1224
- resume_date?: number;
1225
- }
1226
- export interface CancelInputParam {
1227
- cancel_option?: CancelOptionEnum;
1228
- end_of_term?: boolean;
1229
- cancel_at?: number;
1230
- credit_option_for_current_term_charges?: CreditOptionForCurrentTermChargesEnum;
1231
- unbilled_charges_option?: UnbilledChargesOptionEnum;
1232
- account_receivables_handling?: AccountReceivablesHandlingEnum;
1233
- refundable_credits_handling?: RefundableCreditsHandlingEnum;
1234
- contract_term_cancel_option?: ContractTermCancelOptionEnum;
1235
- invoice_date?: number;
1236
- cancel_reason_code?: string;
1237
- event_based_addons?: EventBasedAddonsCancelInputParam[];
1238
- }
1239
- export interface CancelForItemsInputParam {
1240
- cancel_option?: CancelOptionEnum;
1241
- end_of_term?: boolean;
1242
- cancel_at?: number;
1243
- credit_option_for_current_term_charges?: CreditOptionForCurrentTermChargesEnum;
1244
- unbilled_charges_option?: UnbilledChargesOptionEnum;
1245
- account_receivables_handling?: AccountReceivablesHandlingEnum;
1246
- refundable_credits_handling?: RefundableCreditsHandlingEnum;
1247
- contract_term_cancel_option?: ContractTermCancelOptionEnum;
1248
- invoice_date?: number;
1249
- cancel_reason_code?: string;
1250
- subscription_items?: SubscriptionItemsCancelForItemsInputParam[];
1251
- }
1252
- export interface ResumeInputParam {
1253
- resume_option?: ResumeOptionEnum;
1254
- resume_date?: number;
1255
- charges_handling?: ChargesHandlingEnum;
1256
- unpaid_invoices_handling?: UnpaidInvoicesHandlingEnum;
1257
- payment_initiator?: PaymentInitiatorEnum;
1258
- payment_intent?: PaymentIntentResumeInputParam;
1259
- }
1260
- export interface MoveInputParam {
1261
- to_customer_id: string;
1262
- copy_payment_source?: boolean;
1263
- }
1264
- export interface BillingAddressCreateInputParam {
1265
- first_name?: string;
1266
- last_name?: string;
1267
- email?: string;
1268
- company?: string;
1269
- phone?: string;
1270
- line1?: string;
1271
- line2?: string;
1272
- line3?: string;
1273
- city?: string;
1274
- state_code?: string;
1275
- state?: string;
1276
- zip?: string;
1277
- country?: string;
1278
- validation_status?: ValidationStatusEnum;
1279
- }
1280
- export interface StatementDescriptorCreateInputParam {
1281
- descriptor?: string;
1282
- }
1283
- export interface CustomerCreateInputParam {
1284
- id?: string;
1285
- email?: string;
1286
- first_name?: string;
1287
- last_name?: string;
1288
- company?: string;
1289
- phone?: string;
1290
- locale?: string;
1291
- taxability?: TaxabilityEnum;
1292
- entity_code?: EntityCodeEnum;
1293
- exempt_number?: string;
1294
- net_term_days?: number;
1295
- taxjar_exemption_category?: TaxjarExemptionCategoryEnum;
1296
- auto_collection?: AutoCollectionEnum;
1297
- offline_payment_method?: OfflinePaymentMethodEnum;
1298
- allow_direct_debit?: boolean;
1299
- consolidated_invoicing?: boolean;
1300
- vat_number?: string;
1301
- vat_number_prefix?: string;
1302
- entity_identifier_scheme?: string;
1303
- entity_identifier_standard?: string;
1304
- is_einvoice_enabled?: boolean;
1305
- einvoicing_method?: EinvoicingMethodEnum;
1306
- registered_for_gst?: boolean;
1307
- business_customer_without_vat_number?: boolean;
1308
- exemption_details?: any;
1309
- customer_type?: CustomerTypeEnum;
1310
- }
1311
- export interface ShippingAddressCreateInputParam {
1312
- first_name?: string;
1313
- last_name?: string;
1314
- email?: string;
1315
- company?: string;
1316
- phone?: string;
1317
- line1?: string;
1318
- line2?: string;
1319
- line3?: string;
1320
- city?: string;
1321
- state_code?: string;
1322
- state?: string;
1323
- zip?: string;
1324
- country?: string;
1325
- validation_status?: ValidationStatusEnum;
1326
- }
1327
- export interface PaymentMethodCreateInputParam {
1328
- type?: TypeEnum;
1329
- /**
1330
- * @deprecated Please refer API docs to use other attributes
1331
- */
1332
- gateway?: GatewayEnum;
1333
- gateway_account_id?: string;
1334
- reference_id?: string;
1335
- tmp_token?: string;
1336
- issuing_country?: string;
1337
- additional_information?: any;
1338
- }
1339
- export interface BankAccountCreateInputParam {
1340
- gateway_account_id?: string;
1341
- iban?: string;
1342
- first_name?: string;
1343
- last_name?: string;
1344
- company?: string;
1345
- email?: string;
1346
- phone?: string;
1347
- bank_name?: string;
1348
- account_number?: string;
1349
- routing_number?: string;
1350
- bank_code?: string;
1351
- account_type?: AccountTypeEnum;
1352
- account_holder_type?: AccountHolderTypeEnum;
1353
- echeck_type?: EcheckTypeEnum;
1354
- issuing_country?: string;
1355
- swedish_identity_number?: string;
1356
- billing_address?: any;
1357
- }
1358
- export interface ContractTermCreateInputParam {
1359
- action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
1360
- cancellation_cutoff_period?: number;
1361
- }
1362
- export interface PaymentIntentCreateInputParam {
1363
- id?: string;
1364
- gateway_account_id?: string;
1365
- gw_token?: string;
1366
- payment_method_type?:
1367
- | 'card'
1368
- | 'ideal'
1369
- | 'sofort'
1370
- | 'bancontact'
1371
- | 'google_pay'
1372
- | 'dotpay'
1373
- | 'giropay'
1374
- | 'apple_pay'
1375
- | 'upi'
1376
- | 'netbanking_emandates'
1377
- | 'paypal_express_checkout'
1378
- | 'direct_debit'
1379
- | 'boleto'
1380
- | 'venmo'
1381
- | 'amazon_payments'
1382
- | 'pay_to'
1383
- | 'faster_payments'
1384
- | 'sepa_instant_transfer'
1385
- | 'klarna_pay_now'
1386
- | 'online_banking_poland';
1387
- reference_id?: string;
1388
- /**
1389
- * @deprecated Please refer API docs to use other attributes
1390
- */
1391
- gw_payment_method_id?: string;
1392
- additional_information?: any;
1393
- }
1394
- export interface CardCreateInputParam {
1395
- /**
1396
- * @deprecated Please refer API docs to use other attributes
1397
- */
1398
- gateway?: GatewayEnum;
1399
- gateway_account_id?: string;
1400
- /**
1401
- * @deprecated Please refer API docs to use other attributes
1402
- */
1403
- tmp_token?: string;
1404
- first_name?: string;
1405
- last_name?: string;
1406
- number?: string;
1407
- expiry_month?: number;
1408
- expiry_year?: number;
1409
- cvv?: string;
1410
- billing_addr1?: string;
1411
- billing_addr2?: string;
1412
- billing_city?: string;
1413
- billing_state_code?: string;
1414
- billing_state?: string;
1415
- billing_zip?: string;
1416
- billing_country?: string;
1417
- /**
1418
- * @deprecated Please refer API docs to use other attributes
1419
- */
1420
- ip_address?: string;
1421
- additional_information?: any;
1422
- }
1423
-
1424
- export interface EventBasedAddonsCreateInputParam {
1425
- id?: string;
1426
- quantity?: number;
1427
- unit_price?: number;
1428
- quantity_in_decimal?: string;
1429
- unit_price_in_decimal?: string;
1430
- service_period_in_days?: number;
1431
- on_event?: OnEventEnum;
1432
- charge_once?: boolean;
1433
- charge_on?: ChargeOnEnum;
1434
- }
1435
- export interface CouponsCreateInputParam {
1436
- /**
1437
- * @deprecated Please refer API docs to use other attributes
1438
- */
1439
- coupon_id?: string;
1440
- /**
1441
- * @deprecated Please refer API docs to use other attributes
1442
- */
1443
- apply_till?: number;
1444
- }
1445
- export interface AddonsCreateInputParam {
1446
- id?: string;
1447
- quantity?: number;
1448
- quantity_in_decimal?: string;
1449
- unit_price?: number;
1450
- unit_price_in_decimal?: string;
1451
- billing_cycles?: number;
1452
- trial_end?: number;
1453
- }
1454
- export interface EntityIdentifiersCreateInputParam {
1455
- id?: string;
1456
- scheme?: string;
1457
- value?: string;
1458
- standard?: string;
1459
- }
1460
- export interface TaxProvidersFieldsCreateInputParam {
1461
- provider_name?: string;
1462
- field_id?: string;
1463
- field_value?: string;
1464
- }
1465
- export interface StatementDescriptorCreateForCustomerInputParam {
1466
- descriptor?: string;
1467
- }
1468
- export interface ShippingAddressCreateForCustomerInputParam {
1469
- first_name?: string;
1470
- last_name?: string;
1471
- email?: string;
1472
- company?: string;
1473
- phone?: string;
1474
- line1?: string;
1475
- line2?: string;
1476
- line3?: string;
1477
- city?: string;
1478
- state_code?: string;
1479
- state?: string;
1480
- zip?: string;
1481
- country?: string;
1482
- validation_status?: ValidationStatusEnum;
1483
- }
1484
- export interface ContractTermCreateForCustomerInputParam {
1485
- action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
1486
- cancellation_cutoff_period?: number;
1487
- }
1488
- export interface PaymentIntentCreateForCustomerInputParam {
1489
- id?: string;
1490
- gateway_account_id?: string;
1491
- gw_token?: string;
1492
- payment_method_type?:
1493
- | 'card'
1494
- | 'ideal'
1495
- | 'sofort'
1496
- | 'bancontact'
1497
- | 'google_pay'
1498
- | 'dotpay'
1499
- | 'giropay'
1500
- | 'apple_pay'
1501
- | 'upi'
1502
- | 'netbanking_emandates'
1503
- | 'paypal_express_checkout'
1504
- | 'direct_debit'
1505
- | 'boleto'
1506
- | 'venmo'
1507
- | 'amazon_payments'
1508
- | 'pay_to'
1509
- | 'faster_payments'
1510
- | 'sepa_instant_transfer'
1511
- | 'klarna_pay_now'
1512
- | 'online_banking_poland';
1513
- reference_id?: string;
1514
- /**
1515
- * @deprecated Please refer API docs to use other attributes
1516
- */
1517
- gw_payment_method_id?: string;
1518
- additional_information?: any;
1519
- }
1520
-
1521
- export interface EventBasedAddonsCreateForCustomerInputParam {
1522
- id?: string;
1523
- quantity?: number;
1524
- unit_price?: number;
1525
- quantity_in_decimal?: string;
1526
- unit_price_in_decimal?: string;
1527
- service_period_in_days?: number;
1528
- on_event?: OnEventEnum;
1529
- charge_once?: boolean;
1530
- charge_on?: ChargeOnEnum;
1531
- }
1532
- export interface CouponsCreateForCustomerInputParam {
1533
- /**
1534
- * @deprecated Please refer API docs to use other attributes
1535
- */
1536
- coupon_id?: string;
1537
- /**
1538
- * @deprecated Please refer API docs to use other attributes
1539
- */
1540
- apply_till?: number;
1541
- }
1542
- export interface AddonsCreateForCustomerInputParam {
1543
- id?: string;
1544
- quantity?: number;
1545
- quantity_in_decimal?: string;
1546
- unit_price?: number;
1547
- unit_price_in_decimal?: string;
1548
- billing_cycles?: number;
1549
- trial_end?: number;
1550
- }
1551
- export interface StatementDescriptorCreateWithItemsInputParam {
1552
- descriptor?: string;
1553
- }
1554
- export interface ShippingAddressCreateWithItemsInputParam {
1555
- first_name?: string;
1556
- last_name?: string;
1557
- email?: string;
1558
- company?: string;
1559
- phone?: string;
1560
- line1?: string;
1561
- line2?: string;
1562
- line3?: string;
1563
- city?: string;
1564
- state_code?: string;
1565
- state?: string;
1566
- zip?: string;
1567
- country?: string;
1568
- validation_status?: ValidationStatusEnum;
1569
- }
1570
- export interface ContractTermCreateWithItemsInputParam {
1571
- action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
1572
- /**
1573
- * @deprecated Please refer API docs to use other attributes
1574
- */
1575
- contract_start?: number;
1576
- cancellation_cutoff_period?: number;
1577
- }
1578
- export interface PaymentIntentCreateWithItemsInputParam {
1579
- id?: string;
1580
- gateway_account_id?: string;
1581
- gw_token?: string;
1582
- payment_method_type?:
1583
- | 'card'
1584
- | 'ideal'
1585
- | 'sofort'
1586
- | 'bancontact'
1587
- | 'google_pay'
1588
- | 'dotpay'
1589
- | 'giropay'
1590
- | 'apple_pay'
1591
- | 'upi'
1592
- | 'netbanking_emandates'
1593
- | 'paypal_express_checkout'
1594
- | 'direct_debit'
1595
- | 'boleto'
1596
- | 'venmo'
1597
- | 'amazon_payments'
1598
- | 'pay_to'
1599
- | 'faster_payments'
1600
- | 'sepa_instant_transfer'
1601
- | 'klarna_pay_now'
1602
- | 'online_banking_poland';
1603
- reference_id?: string;
1604
- /**
1605
- * @deprecated Please refer API docs to use other attributes
1606
- */
1607
- gw_payment_method_id?: string;
1608
- additional_information?: any;
1609
- }
1610
-
1611
- export interface SubscriptionItemsCreateWithItemsInputParam {
1612
- item_price_id: string;
1613
- quantity?: number;
1614
- quantity_in_decimal?: string;
1615
- unit_price?: number;
1616
- unit_price_in_decimal?: string;
1617
- billing_cycles?: number;
1618
- trial_end?: number;
1619
- service_period_days?: number;
1620
- charge_on_event?: ChargeOnEventEnum;
1621
- charge_once?: boolean;
1622
- /**
1623
- * @deprecated Please refer API docs to use other attributes
1624
- */
1625
- item_type?: ItemTypeEnum;
1626
- charge_on_option?: ChargeOnOptionEnum;
1627
- usage_accumulation_reset_frequency?: UsageAccumulationResetFrequencyEnum;
1628
- }
1629
- export interface DiscountsCreateWithItemsInputParam {
1630
- apply_on: ApplyOnEnum;
1631
- duration_type: DurationTypeEnum;
1632
- percentage?: number;
1633
- amount?: number;
1634
- period?: number;
1635
- period_unit?: PeriodUnitEnum;
1636
- included_in_mrr?: boolean;
1637
- item_price_id?: string;
1638
- }
1639
- export interface CouponsCreateWithItemsInputParam {
1640
- /**
1641
- * @deprecated Please refer API docs to use other attributes
1642
- */
1643
- coupon_id?: string;
1644
- /**
1645
- * @deprecated Please refer API docs to use other attributes
1646
- */
1647
- apply_till?: number;
1648
- }
1649
- export interface ItemTiersCreateWithItemsInputParam {
1650
- item_price_id?: string;
1651
- starting_unit?: number;
1652
- ending_unit?: number;
1653
- price?: number;
1654
- starting_unit_in_decimal?: string;
1655
- ending_unit_in_decimal?: string;
1656
- price_in_decimal?: string;
1657
- }
1658
- export interface BillingAddressUpdateInputParam {
1659
- first_name?: string;
1660
- last_name?: string;
1661
- email?: string;
1662
- company?: string;
1663
- phone?: string;
1664
- line1?: string;
1665
- line2?: string;
1666
- line3?: string;
1667
- city?: string;
1668
- state_code?: string;
1669
- state?: string;
1670
- zip?: string;
1671
- country?: string;
1672
- validation_status?: ValidationStatusEnum;
1673
- }
1674
- export interface CustomerUpdateInputParam {
1675
- vat_number?: string;
1676
- vat_number_prefix?: string;
1677
- entity_identifier_scheme?: string;
1678
- is_einvoice_enabled?: boolean;
1679
- einvoicing_method?: EinvoicingMethodEnum;
1680
- entity_identifier_standard?: string;
1681
- business_customer_without_vat_number?: boolean;
1682
- registered_for_gst?: boolean;
1683
- }
1684
- export interface StatementDescriptorUpdateInputParam {
1685
- descriptor?: string;
1686
- }
1687
- export interface ShippingAddressUpdateInputParam {
1688
- first_name?: string;
1689
- last_name?: string;
1690
- email?: string;
1691
- company?: string;
1692
- phone?: string;
1693
- line1?: string;
1694
- line2?: string;
1695
- line3?: string;
1696
- city?: string;
1697
- state_code?: string;
1698
- state?: string;
1699
- zip?: string;
1700
- country?: string;
1701
- validation_status?: ValidationStatusEnum;
1702
- }
1703
- export interface PaymentMethodUpdateInputParam {
1704
- type?: TypeEnum;
1705
- /**
1706
- * @deprecated Please refer API docs to use other attributes
1707
- */
1708
- gateway?: GatewayEnum;
1709
- gateway_account_id?: string;
1710
- reference_id?: string;
1711
- tmp_token?: string;
1712
- issuing_country?: string;
1713
- additional_information?: any;
1714
- }
1715
- export interface ContractTermUpdateInputParam {
1716
- action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
1717
- cancellation_cutoff_period?: number;
1718
- }
1719
- export interface PaymentIntentUpdateInputParam {
1720
- id?: string;
1721
- gateway_account_id?: string;
1722
- gw_token?: string;
1723
- payment_method_type?:
1724
- | 'card'
1725
- | 'ideal'
1726
- | 'sofort'
1727
- | 'bancontact'
1728
- | 'google_pay'
1729
- | 'dotpay'
1730
- | 'giropay'
1731
- | 'apple_pay'
1732
- | 'upi'
1733
- | 'netbanking_emandates'
1734
- | 'paypal_express_checkout'
1735
- | 'direct_debit'
1736
- | 'boleto'
1737
- | 'venmo'
1738
- | 'amazon_payments'
1739
- | 'pay_to'
1740
- | 'faster_payments'
1741
- | 'sepa_instant_transfer'
1742
- | 'klarna_pay_now'
1743
- | 'online_banking_poland';
1744
- reference_id?: string;
1745
- /**
1746
- * @deprecated Please refer API docs to use other attributes
1747
- */
1748
- gw_payment_method_id?: string;
1749
- additional_information?: any;
1750
- }
1751
- export interface CardUpdateInputParam {
1752
- /**
1753
- * @deprecated Please refer API docs to use other attributes
1754
- */
1755
- gateway?: GatewayEnum;
1756
- gateway_account_id?: string;
1757
- /**
1758
- * @deprecated Please refer API docs to use other attributes
1759
- */
1760
- tmp_token?: string;
1761
- first_name?: string;
1762
- last_name?: string;
1763
- number?: string;
1764
- expiry_month?: number;
1765
- expiry_year?: number;
1766
- cvv?: string;
1767
- billing_addr1?: string;
1768
- billing_addr2?: string;
1769
- billing_city?: string;
1770
- billing_state_code?: string;
1771
- billing_state?: string;
1772
- billing_zip?: string;
1773
- billing_country?: string;
1774
- /**
1775
- * @deprecated Please refer API docs to use other attributes
1776
- */
1777
- ip_address?: string;
1778
- additional_information?: any;
1779
- }
1780
-
1781
- export interface EventBasedAddonsUpdateInputParam {
1782
- id?: string;
1783
- quantity?: number;
1784
- unit_price?: number;
1785
- service_period_in_days?: number;
1786
- charge_on?: ChargeOnEnum;
1787
- on_event?: OnEventEnum;
1788
- charge_once?: boolean;
1789
- quantity_in_decimal?: string;
1790
- unit_price_in_decimal?: string;
1791
- }
1792
- export interface CouponsUpdateInputParam {
1793
- /**
1794
- * @deprecated Please refer API docs to use other attributes
1795
- */
1796
- coupon_id?: string;
1797
- /**
1798
- * @deprecated Please refer API docs to use other attributes
1799
- */
1800
- apply_till?: number;
1801
- }
1802
- export interface AddonsUpdateInputParam {
1803
- id?: string;
1804
- quantity?: number;
1805
- unit_price?: number;
1806
- billing_cycles?: number;
1807
- quantity_in_decimal?: string;
1808
- unit_price_in_decimal?: string;
1809
- trial_end?: number;
1810
- proration_type?: ProrationTypeEnum;
1811
- }
1812
- export interface BillingAddressUpdateForItemsInputParam {
1813
- first_name?: string;
1814
- last_name?: string;
1815
- email?: string;
1816
- company?: string;
1817
- phone?: string;
1818
- line1?: string;
1819
- line2?: string;
1820
- line3?: string;
1821
- city?: string;
1822
- state_code?: string;
1823
- state?: string;
1824
- zip?: string;
1825
- country?: string;
1826
- validation_status?: ValidationStatusEnum;
1827
- }
1828
- export interface CustomerUpdateForItemsInputParam {
1829
- vat_number?: string;
1830
- vat_number_prefix?: string;
1831
- entity_identifier_scheme?: string;
1832
- is_einvoice_enabled?: boolean;
1833
- einvoicing_method?: EinvoicingMethodEnum;
1834
- entity_identifier_standard?: string;
1835
- business_customer_without_vat_number?: boolean;
1836
- registered_for_gst?: boolean;
1837
- }
1838
- export interface StatementDescriptorUpdateForItemsInputParam {
1839
- descriptor?: string;
1840
- }
1841
- export interface ShippingAddressUpdateForItemsInputParam {
1842
- first_name?: string;
1843
- last_name?: string;
1844
- email?: string;
1845
- company?: string;
1846
- phone?: string;
1847
- line1?: string;
1848
- line2?: string;
1849
- line3?: string;
1850
- city?: string;
1851
- state_code?: string;
1852
- state?: string;
1853
- zip?: string;
1854
- country?: string;
1855
- validation_status?: ValidationStatusEnum;
1856
- }
1857
- export interface PaymentMethodUpdateForItemsInputParam {
1858
- type?: TypeEnum;
1859
- /**
1860
- * @deprecated Please refer API docs to use other attributes
1861
- */
1862
- gateway?: GatewayEnum;
1863
- gateway_account_id?: string;
1864
- reference_id?: string;
1865
- tmp_token?: string;
1866
- issuing_country?: string;
1867
- additional_information?: any;
1868
- }
1869
- export interface ContractTermUpdateForItemsInputParam {
1870
- action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
1871
- cancellation_cutoff_period?: number;
1872
- /**
1873
- * @deprecated Please refer API docs to use other attributes
1874
- */
1875
- contract_start?: number;
1876
- }
1877
- export interface PaymentIntentUpdateForItemsInputParam {
1878
- id?: string;
1879
- gateway_account_id?: string;
1880
- gw_token?: string;
1881
- payment_method_type?:
1882
- | 'card'
1883
- | 'ideal'
1884
- | 'sofort'
1885
- | 'bancontact'
1886
- | 'google_pay'
1887
- | 'dotpay'
1888
- | 'giropay'
1889
- | 'apple_pay'
1890
- | 'upi'
1891
- | 'netbanking_emandates'
1892
- | 'paypal_express_checkout'
1893
- | 'direct_debit'
1894
- | 'boleto'
1895
- | 'venmo'
1896
- | 'amazon_payments'
1897
- | 'pay_to'
1898
- | 'faster_payments'
1899
- | 'sepa_instant_transfer'
1900
- | 'klarna_pay_now'
1901
- | 'online_banking_poland';
1902
- reference_id?: string;
1903
- /**
1904
- * @deprecated Please refer API docs to use other attributes
1905
- */
1906
- gw_payment_method_id?: string;
1907
- additional_information?: any;
1908
- }
1909
- export interface CardUpdateForItemsInputParam {
1910
- /**
1911
- * @deprecated Please refer API docs to use other attributes
1912
- */
1913
- gateway?: GatewayEnum;
1914
- gateway_account_id?: string;
1915
- /**
1916
- * @deprecated Please refer API docs to use other attributes
1917
- */
1918
- tmp_token?: string;
1919
- first_name?: string;
1920
- last_name?: string;
1921
- number?: string;
1922
- expiry_month?: number;
1923
- expiry_year?: number;
1924
- cvv?: string;
1925
- billing_addr1?: string;
1926
- billing_addr2?: string;
1927
- billing_city?: string;
1928
- billing_state_code?: string;
1929
- billing_state?: string;
1930
- billing_zip?: string;
1931
- billing_country?: string;
1932
- /**
1933
- * @deprecated Please refer API docs to use other attributes
1934
- */
1935
- ip_address?: string;
1936
- additional_information?: any;
1937
- }
1938
-
1939
- export interface SubscriptionItemsUpdateForItemsInputParam {
1940
- item_price_id: string;
1941
- quantity?: number;
1942
- quantity_in_decimal?: string;
1943
- unit_price?: number;
1944
- unit_price_in_decimal?: string;
1945
- billing_cycles?: number;
1946
- trial_end?: number;
1947
- service_period_days?: number;
1948
- charge_on_event?: ChargeOnEventEnum;
1949
- charge_once?: boolean;
1950
- charge_on_option?: ChargeOnOptionEnum;
1951
- /**
1952
- * @deprecated Please refer API docs to use other attributes
1953
- */
1954
- item_type?: ItemTypeEnum;
1955
- proration_type?: ProrationTypeEnum;
1956
- usage_accumulation_reset_frequency?: UsageAccumulationResetFrequencyEnum;
1957
- }
1958
- export interface DiscountsUpdateForItemsInputParam {
1959
- apply_on: ApplyOnEnum;
1960
- duration_type: DurationTypeEnum;
1961
- percentage?: number;
1962
- amount?: number;
1963
- period?: number;
1964
- period_unit?: PeriodUnitEnum;
1965
- included_in_mrr?: boolean;
1966
- item_price_id?: string;
1967
- operation_type: OperationTypeEnum;
1968
- id?: string;
1969
- }
1970
- export interface CouponsUpdateForItemsInputParam {
1971
- /**
1972
- * @deprecated Please refer API docs to use other attributes
1973
- */
1974
- coupon_id?: string;
1975
- /**
1976
- * @deprecated Please refer API docs to use other attributes
1977
- */
1978
- apply_till?: number;
1979
- }
1980
- export interface ItemTiersUpdateForItemsInputParam {
1981
- item_price_id?: string;
1982
- starting_unit?: number;
1983
- ending_unit?: number;
1984
- price?: number;
1985
- starting_unit_in_decimal?: string;
1986
- ending_unit_in_decimal?: string;
1987
- price_in_decimal?: string;
1988
- }
1989
- export interface StatementDescriptorReactivateInputParam {
1990
- descriptor?: string;
1991
- }
1992
- export interface PaymentIntentReactivateInputParam {
1993
- id?: string;
1994
- gateway_account_id?: string;
1995
- gw_token?: string;
1996
- payment_method_type?:
1997
- | 'card'
1998
- | 'ideal'
1999
- | 'sofort'
2000
- | 'bancontact'
2001
- | 'google_pay'
2002
- | 'dotpay'
2003
- | 'giropay'
2004
- | 'apple_pay'
2005
- | 'upi'
2006
- | 'netbanking_emandates'
2007
- | 'paypal_express_checkout'
2008
- | 'direct_debit'
2009
- | 'boleto'
2010
- | 'venmo'
2011
- | 'amazon_payments'
2012
- | 'pay_to'
2013
- | 'faster_payments'
2014
- | 'sepa_instant_transfer'
2015
- | 'klarna_pay_now'
2016
- | 'online_banking_poland';
2017
- reference_id?: string;
2018
- /**
2019
- * @deprecated Please refer API docs to use other attributes
2020
- */
2021
- gw_payment_method_id?: string;
2022
- additional_information?: any;
2023
- }
2024
- export interface ContractTermReactivateInputParam {
2025
- action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
2026
- cancellation_cutoff_period?: number;
2027
- }
2028
-
2029
- export interface FixedIntervalScheduleChargeFutureRenewalsInputParam {
2030
- number_of_occurrences?: number;
2031
- days_before_renewal?: number;
2032
- end_schedule_on?: EndScheduleOnEnum;
2033
- end_date?: number;
2034
- }
2035
-
2036
- export interface SpecificDatesScheduleChargeFutureRenewalsInputParam {
2037
- terms_to_charge?: number;
2038
- date?: number;
2039
- }
2040
- export interface FixedIntervalScheduleEditAdvanceInvoiceScheduleInputParam {
2041
- number_of_occurrences?: number;
2042
- days_before_renewal?: number;
2043
- end_schedule_on?: EndScheduleOnEnum;
2044
- end_date?: number;
2045
- }
2046
-
2047
- export interface SpecificDatesScheduleEditAdvanceInvoiceScheduleInputParam {
2048
- id?: string;
2049
- terms_to_charge?: number;
2050
- date?: number;
2051
- }
2052
- export interface SpecificDatesScheduleRemoveAdvanceInvoiceScheduleInputParam {
2053
- id?: string;
2054
- }
2055
- export interface BillingAddressImportSubscriptionInputParam {
2056
- first_name?: string;
2057
- last_name?: string;
2058
- email?: string;
2059
- company?: string;
2060
- phone?: string;
2061
- line1?: string;
2062
- line2?: string;
2063
- line3?: string;
2064
- city?: string;
2065
- state_code?: string;
2066
- state?: string;
2067
- zip?: string;
2068
- country?: string;
2069
- validation_status?: ValidationStatusEnum;
2070
- }
2071
- export interface TransactionImportSubscriptionInputParam {
2072
- amount?: number;
2073
- payment_method?: PaymentMethodEnum;
2074
- reference_number?: string;
2075
- date?: number;
2076
- }
2077
- export interface CustomerImportSubscriptionInputParam {
2078
- id?: string;
2079
- email?: string;
2080
- first_name?: string;
2081
- last_name?: string;
2082
- company?: string;
2083
- phone?: string;
2084
- locale?: string;
2085
- taxability?: TaxabilityEnum;
2086
- entity_code?: EntityCodeEnum;
2087
- exempt_number?: string;
2088
- net_term_days?: number;
2089
- taxjar_exemption_category?: TaxjarExemptionCategoryEnum;
2090
- customer_type?: CustomerTypeEnum;
2091
- auto_collection?: AutoCollectionEnum;
2092
- allow_direct_debit?: boolean;
2093
- vat_number?: string;
2094
- vat_number_prefix?: string;
2095
- }
2096
- export interface ShippingAddressImportSubscriptionInputParam {
2097
- first_name?: string;
2098
- last_name?: string;
2099
- email?: string;
2100
- company?: string;
2101
- phone?: string;
2102
- line1?: string;
2103
- line2?: string;
2104
- line3?: string;
2105
- city?: string;
2106
- state_code?: string;
2107
- state?: string;
2108
- zip?: string;
2109
- country?: string;
2110
- validation_status?: ValidationStatusEnum;
2111
- }
2112
- export interface PaymentMethodImportSubscriptionInputParam {
2113
- type?: TypeEnum;
2114
- /**
2115
- * @deprecated Please refer API docs to use other attributes
2116
- */
2117
- gateway?: GatewayEnum;
2118
- gateway_account_id?: string;
2119
- reference_id?: string;
2120
- issuing_country?: string;
2121
- additional_information?: any;
2122
- }
2123
- export interface ContractTermImportSubscriptionInputParam {
2124
- id?: string;
2125
- created_at?: number;
2126
- contract_start?: number;
2127
- billing_cycle?: number;
2128
- total_amount_raised?: number;
2129
- total_amount_raised_before_tax?: number;
2130
- action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
2131
- cancellation_cutoff_period?: number;
2132
- }
2133
- export interface CardImportSubscriptionInputParam {
2134
- /**
2135
- * @deprecated Please refer API docs to use other attributes
2136
- */
2137
- gateway?: GatewayEnum;
2138
- gateway_account_id?: string;
2139
- /**
2140
- * @deprecated Please refer API docs to use other attributes
2141
- */
2142
- tmp_token?: string;
2143
- first_name?: string;
2144
- last_name?: string;
2145
- number?: string;
2146
- expiry_month?: number;
2147
- expiry_year?: number;
2148
- cvv?: string;
2149
- billing_addr1?: string;
2150
- billing_addr2?: string;
2151
- billing_city?: string;
2152
- billing_state_code?: string;
2153
- billing_state?: string;
2154
- billing_zip?: string;
2155
- billing_country?: string;
2156
- additional_information?: any;
2157
- }
2158
-
2159
- export interface ChargedEventBasedAddonsImportSubscriptionInputParam {
2160
- id?: string;
2161
- last_charged_at?: number;
2162
- }
2163
- export interface EventBasedAddonsImportSubscriptionInputParam {
2164
- id?: string;
2165
- quantity?: number;
2166
- unit_price?: number;
2167
- quantity_in_decimal?: string;
2168
- unit_price_in_decimal?: string;
2169
- service_period_in_days?: number;
2170
- on_event?: OnEventEnum;
2171
- charge_once?: boolean;
2172
- }
2173
- export interface CouponsImportSubscriptionInputParam {
2174
- /**
2175
- * @deprecated Please refer API docs to use other attributes
2176
- */
2177
- coupon_id?: string;
2178
- /**
2179
- * @deprecated Please refer API docs to use other attributes
2180
- */
2181
- apply_till?: number;
2182
- }
2183
- export interface AddonsImportSubscriptionInputParam {
2184
- id?: string;
2185
- quantity?: number;
2186
- quantity_in_decimal?: string;
2187
- unit_price?: number;
2188
- unit_price_in_decimal?: string;
2189
- billing_cycles?: number;
2190
- }
2191
- export interface TransactionImportForCustomerInputParam {
2192
- amount?: number;
2193
- payment_method?: PaymentMethodEnum;
2194
- reference_number?: string;
2195
- date?: number;
2196
- }
2197
- export interface ShippingAddressImportForCustomerInputParam {
2198
- first_name?: string;
2199
- last_name?: string;
2200
- email?: string;
2201
- company?: string;
2202
- phone?: string;
2203
- line1?: string;
2204
- line2?: string;
2205
- line3?: string;
2206
- city?: string;
2207
- state_code?: string;
2208
- state?: string;
2209
- zip?: string;
2210
- country?: string;
2211
- validation_status?: ValidationStatusEnum;
2212
- }
2213
- export interface ContractTermImportForCustomerInputParam {
2214
- id?: string;
2215
- created_at?: number;
2216
- contract_start?: number;
2217
- billing_cycle?: number;
2218
- total_amount_raised?: number;
2219
- total_amount_raised_before_tax?: number;
2220
- action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
2221
- cancellation_cutoff_period?: number;
2222
- }
2223
-
2224
- export interface ChargedEventBasedAddonsImportForCustomerInputParam {
2225
- id?: string;
2226
- last_charged_at?: number;
2227
- }
2228
- export interface EventBasedAddonsImportForCustomerInputParam {
2229
- id?: string;
2230
- quantity?: number;
2231
- unit_price?: number;
2232
- quantity_in_decimal?: string;
2233
- unit_price_in_decimal?: string;
2234
- service_period_in_days?: number;
2235
- on_event?: OnEventEnum;
2236
- charge_once?: boolean;
2237
- }
2238
- export interface CouponsImportForCustomerInputParam {
2239
- /**
2240
- * @deprecated Please refer API docs to use other attributes
2241
- */
2242
- coupon_id?: string;
2243
- /**
2244
- * @deprecated Please refer API docs to use other attributes
2245
- */
2246
- apply_till?: number;
2247
- }
2248
- export interface AddonsImportForCustomerInputParam {
2249
- id?: string;
2250
- quantity?: number;
2251
- quantity_in_decimal?: string;
2252
- unit_price?: number;
2253
- unit_price_in_decimal?: string;
2254
- billing_cycles?: number;
2255
- }
2256
- export interface ContractTermImportContractTermInputParam {
2257
- id?: string;
2258
- created_at?: number;
2259
- contract_start?: number;
2260
- contract_end?: number;
2261
- status?: 'active' | 'completed' | 'cancelled' | 'terminated';
2262
- total_amount_raised?: number;
2263
- total_amount_raised_before_tax?: number;
2264
- total_contract_value?: number;
2265
- total_contract_value_before_tax?: number;
2266
- billing_cycle?: number;
2267
- action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
2268
- cancellation_cutoff_period?: number;
2269
- }
2270
-
2271
- export interface TiersImportUnbilledChargesInputParam {
2272
- unbilled_charge_id: string;
2273
- starting_unit?: number;
2274
- ending_unit?: number;
2275
- quantity_used?: number;
2276
- unit_amount?: number;
2277
- starting_unit_in_decimal?: string;
2278
- ending_unit_in_decimal?: string;
2279
- quantity_used_in_decimal?: string;
2280
- unit_amount_in_decimal?: string;
2281
- }
2282
- export interface DiscountsImportUnbilledChargesInputParam {
2283
- unbilled_charge_id?: string;
2284
- entity_type?:
2285
- | 'item_level_coupon'
2286
- | 'document_level_coupon'
2287
- | 'item_level_discount'
2288
- | 'document_level_discount';
2289
- entity_id?: string;
2290
- description?: string;
2291
- amount: number;
2292
- }
2293
- export interface UnbilledChargesImportUnbilledChargesInputParam {
2294
- id?: string;
2295
- date_from: number;
2296
- date_to: number;
2297
- entity_type:
2298
- | 'adhoc'
2299
- | 'plan_item_price'
2300
- | 'addon_item_price'
2301
- | 'charge_item_price';
2302
- entity_id?: string;
2303
- description?: string;
2304
- unit_amount?: number;
2305
- quantity?: number;
2306
- amount?: number;
2307
- unit_amount_in_decimal?: string;
2308
- quantity_in_decimal?: string;
2309
- amount_in_decimal?: string;
2310
- discount_amount?: number;
2311
- use_for_proration?: boolean;
2312
- is_advance_charge?: boolean;
2313
- }
2314
- export interface TransactionImportForItemsInputParam {
2315
- amount?: number;
2316
- payment_method?: PaymentMethodEnum;
2317
- reference_number?: string;
2318
- date?: number;
2319
- }
2320
- export interface ShippingAddressImportForItemsInputParam {
2321
- first_name?: string;
2322
- last_name?: string;
2323
- email?: string;
2324
- company?: string;
2325
- phone?: string;
2326
- line1?: string;
2327
- line2?: string;
2328
- line3?: string;
2329
- city?: string;
2330
- state_code?: string;
2331
- state?: string;
2332
- zip?: string;
2333
- country?: string;
2334
- validation_status?: ValidationStatusEnum;
2335
- }
2336
- export interface ContractTermImportForItemsInputParam {
2337
- id?: string;
2338
- created_at?: number;
2339
- contract_start?: number;
2340
- billing_cycle?: number;
2341
- total_amount_raised?: number;
2342
- total_amount_raised_before_tax?: number;
2343
- action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
2344
- cancellation_cutoff_period?: number;
2345
- }
2346
-
2347
- export interface SubscriptionItemsImportForItemsInputParam {
2348
- item_price_id: string;
2349
- quantity?: number;
2350
- quantity_in_decimal?: string;
2351
- unit_price?: number;
2352
- unit_price_in_decimal?: string;
2353
- billing_cycles?: number;
2354
- trial_end?: number;
2355
- service_period_days?: number;
2356
- charge_on_event?: ChargeOnEventEnum;
2357
- charge_once?: boolean;
2358
- /**
2359
- * @deprecated Please refer API docs to use other attributes
2360
- */
2361
- item_type?: ItemTypeEnum;
2362
- }
2363
- export interface DiscountsImportForItemsInputParam {
2364
- apply_on: ApplyOnEnum;
2365
- duration_type: DurationTypeEnum;
2366
- percentage?: number;
2367
- amount?: number;
2368
- period?: number;
2369
- period_unit?: PeriodUnitEnum;
2370
- included_in_mrr?: boolean;
2371
- item_price_id?: string;
2372
- }
2373
- export interface CouponsImportForItemsInputParam {
2374
- /**
2375
- * @deprecated Please refer API docs to use other attributes
2376
- */
2377
- coupon_id?: string;
2378
- /**
2379
- * @deprecated Please refer API docs to use other attributes
2380
- */
2381
- apply_till?: number;
2382
- }
2383
- export interface ItemTiersImportForItemsInputParam {
2384
- item_price_id?: string;
2385
- starting_unit?: number;
2386
- ending_unit?: number;
2387
- price?: number;
2388
- starting_unit_in_decimal?: string;
2389
- ending_unit_in_decimal?: string;
2390
- price_in_decimal?: string;
2391
- }
2392
- export interface ChargedItemsImportForItemsInputParam {
2393
- item_price_id?: string;
2394
- last_charged_at?: number;
2395
- }
2396
- export interface EventBasedAddonsCancelInputParam {
2397
- id?: string;
2398
- quantity?: number;
2399
- unit_price?: number;
2400
- service_period_in_days?: number;
2401
- }
2402
- export interface SubscriptionItemsCancelForItemsInputParam {
2403
- item_price_id?: string;
2404
- quantity?: number;
2405
- quantity_in_decimal?: string;
2406
- unit_price?: number;
2407
- unit_price_in_decimal?: string;
2408
- service_period_days?: number;
2409
- }
2410
- export interface PaymentIntentResumeInputParam {
2411
- id?: string;
2412
- gateway_account_id?: string;
2413
- gw_token?: string;
2414
- payment_method_type?:
2415
- | 'card'
2416
- | 'ideal'
2417
- | 'sofort'
2418
- | 'bancontact'
2419
- | 'google_pay'
2420
- | 'dotpay'
2421
- | 'giropay'
2422
- | 'apple_pay'
2423
- | 'upi'
2424
- | 'netbanking_emandates'
2425
- | 'paypal_express_checkout'
2426
- | 'direct_debit'
2427
- | 'boleto'
2428
- | 'venmo'
2429
- | 'amazon_payments'
2430
- | 'pay_to'
2431
- | 'faster_payments'
2432
- | 'sepa_instant_transfer'
2433
- | 'klarna_pay_now'
2434
- | 'online_banking_poland';
2435
- reference_id?: string;
2436
- /**
2437
- * @deprecated Please refer API docs to use other attributes
2438
- */
2439
- gw_payment_method_id?: string;
2440
- additional_information?: any;
2441
- }
2442
- }
2443
- }