chargebee 3.30.0 → 3.31.0

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 (72) hide show
  1. package/CHANGELOG.md +74 -0
  2. package/cjs/environment.js +1 -1
  3. package/cjs/resources/api_endpoints.js +84 -2
  4. package/cjs/resources/webhook/eventType.js +4 -0
  5. package/cjs/schema/coupon.schema.js +1 -1
  6. package/cjs/schema/credit_note.schema.js +7 -2
  7. package/cjs/schema/credit_unit.schema.js +2 -2
  8. package/cjs/schema/entitlement.schema.js +4 -4
  9. package/cjs/schema/entitlement_override.schema.js +1 -1
  10. package/cjs/schema/estimate.schema.js +2 -2
  11. package/cjs/schema/event.schema.js +16 -0
  12. package/cjs/schema/export.schema.js +35 -3
  13. package/cjs/schema/hosted_page.schema.js +1 -0
  14. package/cjs/schema/index.js +1 -0
  15. package/cjs/schema/invoice.schema.js +11 -4
  16. package/cjs/schema/ledger_operation.schema.js +2 -2
  17. package/cjs/schema/meter.schema.js +1 -1
  18. package/cjs/schema/omnichannel_subscription.schema.js +6 -2
  19. package/cjs/schema/payment_intent.schema.js +4 -0
  20. package/cjs/schema/payment_source.schema.js +9 -2
  21. package/cjs/schema/pricing_page_session.schema.js +1 -1
  22. package/cjs/schema/quote.schema.js +60 -0
  23. package/cjs/schema/quote_entitlement.schema.js +25 -0
  24. package/cjs/schema/ramp.schema.js +2 -2
  25. package/cjs/schema/subscription.schema.js +2 -2
  26. package/cjs/schema/webhook_endpoint.schema.js +8 -0
  27. package/cjs/util.js +12 -2
  28. package/esm/environment.js +1 -1
  29. package/esm/resources/api_endpoints.js +84 -2
  30. package/esm/resources/webhook/eventType.js +4 -0
  31. package/esm/schema/coupon.schema.js +1 -1
  32. package/esm/schema/credit_note.schema.js +6 -1
  33. package/esm/schema/credit_unit.schema.js +2 -2
  34. package/esm/schema/entitlement.schema.js +4 -4
  35. package/esm/schema/entitlement_override.schema.js +1 -1
  36. package/esm/schema/estimate.schema.js +2 -2
  37. package/esm/schema/event.schema.js +16 -0
  38. package/esm/schema/export.schema.js +34 -2
  39. package/esm/schema/hosted_page.schema.js +1 -0
  40. package/esm/schema/index.js +1 -0
  41. package/esm/schema/invoice.schema.js +10 -3
  42. package/esm/schema/ledger_operation.schema.js +2 -2
  43. package/esm/schema/meter.schema.js +1 -1
  44. package/esm/schema/omnichannel_subscription.schema.js +6 -2
  45. package/esm/schema/payment_intent.schema.js +4 -0
  46. package/esm/schema/payment_source.schema.js +8 -1
  47. package/esm/schema/pricing_page_session.schema.js +1 -1
  48. package/esm/schema/quote.schema.js +60 -0
  49. package/esm/schema/quote_entitlement.schema.js +22 -0
  50. package/esm/schema/ramp.schema.js +2 -2
  51. package/esm/schema/subscription.schema.js +2 -2
  52. package/esm/schema/webhook_endpoint.schema.js +8 -0
  53. package/esm/util.js +12 -2
  54. package/package.json +2 -2
  55. package/types/core.d.ts +78 -3
  56. package/types/index.d.ts +6 -0
  57. package/types/resources/Content.d.ts +4 -0
  58. package/types/resources/CreditNote.d.ts +14 -0
  59. package/types/resources/Event.d.ts +4 -0
  60. package/types/resources/Export.d.ts +20 -0
  61. package/types/resources/GatewayPaymentMethodToken.d.ts +15 -0
  62. package/types/resources/HostedPage.d.ts +1 -0
  63. package/types/resources/Invoice.d.ts +17 -1
  64. package/types/resources/OmnichannelSubscriptionItemMetric.d.ts +18 -0
  65. package/types/resources/PaymentIntent.d.ts +14 -11
  66. package/types/resources/PaymentSource.d.ts +17 -0
  67. package/types/resources/PricingPageSession.d.ts +1 -1
  68. package/types/resources/Quote.d.ts +45 -0
  69. package/types/resources/QuoteEntitlement.d.ts +49 -0
  70. package/types/resources/QuotedRamp.d.ts +1 -0
  71. package/types/resources/VaultedPaymentMethod.d.ts +28 -0
  72. package/types/resources/WebhookEvent.d.ts +24 -0
package/types/index.d.ts CHANGED
@@ -39,6 +39,7 @@
39
39
  ///<reference path='./resources/Feature.d.ts' />
40
40
  ///<reference path='./resources/FilterCondition.d.ts' />
41
41
  ///<reference path='./resources/GatewayErrorDetail.d.ts' />
42
+ ///<reference path='./resources/GatewayPaymentMethodToken.d.ts' />
42
43
  ///<reference path='./resources/Gift.d.ts' />
43
44
  ///<reference path='./resources/GrantBlock.d.ts' />
44
45
  ///<reference path='./resources/Hierarchy.d.ts' />
@@ -67,6 +68,7 @@
67
68
  ///<reference path='./resources/OmnichannelOneTimeOrderItem.d.ts' />
68
69
  ///<reference path='./resources/OmnichannelSubscription.d.ts' />
69
70
  ///<reference path='./resources/OmnichannelSubscriptionItem.d.ts' />
71
+ ///<reference path='./resources/OmnichannelSubscriptionItemMetric.d.ts' />
70
72
  ///<reference path='./resources/OmnichannelSubscriptionItemOffer.d.ts' />
71
73
  ///<reference path='./resources/OmnichannelSubscriptionItemScheduledChange.d.ts' />
72
74
  ///<reference path='./resources/OmnichannelTransaction.d.ts' />
@@ -87,6 +89,7 @@
87
89
  ///<reference path='./resources/PromotionalGrant.d.ts' />
88
90
  ///<reference path='./resources/Purchase.d.ts' />
89
91
  ///<reference path='./resources/Quote.d.ts' />
92
+ ///<reference path='./resources/QuoteEntitlement.d.ts' />
90
93
  ///<reference path='./resources/QuoteLineGroup.d.ts' />
91
94
  ///<reference path='./resources/QuotedCharge.d.ts' />
92
95
  ///<reference path='./resources/QuotedDeltaRamp.d.ts' />
@@ -113,6 +116,7 @@
113
116
  ///<reference path='./resources/UsageEvent.d.ts' />
114
117
  ///<reference path='./resources/UsageFile.d.ts' />
115
118
  ///<reference path='./resources/UsageSummary.d.ts' />
119
+ ///<reference path='./resources/VaultedPaymentMethod.d.ts' />
116
120
  ///<reference path='./resources/VirtualBankAccount.d.ts' />
117
121
  ///<reference path='./resources/WebhookEndpoint.d.ts' />
118
122
  ///<reference path='./resources/Content.d.ts' />
@@ -324,6 +328,7 @@ declare module 'chargebee' {
324
328
  promotionalGrant: PromotionalGrant.PromotionalGrantResource;
325
329
  purchase: Purchase.PurchaseResource;
326
330
  quote: Quote.QuoteResource;
331
+ quoteEntitlement: QuoteEntitlement.QuoteEntitlementResource;
327
332
  ramp: Ramp.RampResource;
328
333
  recordedPurchase: RecordedPurchase.RecordedPurchaseResource;
329
334
  resourceMigration: ResourceMigration.ResourceMigrationResource;
@@ -339,6 +344,7 @@ declare module 'chargebee' {
339
344
  usageEvent: UsageEvent.UsageEventResource;
340
345
  usageFile: UsageFile.UsageFileResource;
341
346
  usageSummary: UsageSummary.UsageSummaryResource;
347
+ vaultedPaymentMethod: VaultedPaymentMethod.VaultedPaymentMethodResource;
342
348
  virtualBankAccount: VirtualBankAccount.VirtualBankAccountResource;
343
349
  webhookEndpoint: WebhookEndpoint.WebhookEndpointResource;
344
350
 
@@ -44,6 +44,7 @@ declare module 'chargebee' {
44
44
  feature: Feature;
45
45
  filter_condition: FilterCondition;
46
46
  gateway_error_detail: GatewayErrorDetail;
47
+ gateway_payment_method_token: GatewayPaymentMethodToken;
47
48
  gift: Gift;
48
49
  grant_block: GrantBlock;
49
50
  hierarchy: Hierarchy;
@@ -72,6 +73,7 @@ declare module 'chargebee' {
72
73
  omnichannel_one_time_order_item: OmnichannelOneTimeOrderItem;
73
74
  omnichannel_subscription: OmnichannelSubscription;
74
75
  omnichannel_subscription_item: OmnichannelSubscriptionItem;
76
+ omnichannel_subscription_item_metric: OmnichannelSubscriptionItemMetric;
75
77
  omnichannel_subscription_item_offer: OmnichannelSubscriptionItemOffer;
76
78
  omnichannel_subscription_item_scheduled_change: OmnichannelSubscriptionItemScheduledChange;
77
79
  omnichannel_transaction: OmnichannelTransaction;
@@ -92,6 +94,7 @@ declare module 'chargebee' {
92
94
  promotional_grant: PromotionalGrant;
93
95
  purchase: Purchase;
94
96
  quote: Quote;
97
+ quote_entitlement: QuoteEntitlement;
95
98
  quote_line_group: QuoteLineGroup;
96
99
  quoted_charge: QuotedCharge;
97
100
  quoted_delta_ramp: QuotedDeltaRamp;
@@ -118,6 +121,7 @@ declare module 'chargebee' {
118
121
  usage_event: UsageEvent;
119
122
  usage_file: UsageFile;
120
123
  usage_summary: UsageSummary;
124
+ vaulted_payment_method: VaultedPaymentMethod;
121
125
  virtual_bank_account: VirtualBankAccount;
122
126
  webhook_endpoint: WebhookEndpoint;
123
127
  }
@@ -131,6 +131,12 @@ declare module 'chargebee' {
131
131
  headers?: ChargebeeRequestHeader,
132
132
  ): Promise<ChargebeeResponse<DeleteResponse>>;
133
133
 
134
+ update(
135
+ credit_note_id: string,
136
+ input?: UpdateInputParam,
137
+ headers?: ChargebeeRequestHeader,
138
+ ): Promise<ChargebeeResponse<UpdateResponse>>;
139
+
134
140
  removeTaxWithheldRefund(
135
141
  credit_note_id: string,
136
142
  input: RemoveTaxWithheldRefundInputParam,
@@ -198,6 +204,10 @@ declare module 'chargebee' {
198
204
  credit_note: CreditNote;
199
205
  }
200
206
 
207
+ export interface UpdateResponse {
208
+ credit_note: CreditNote;
209
+ }
210
+
201
211
  export interface RemoveTaxWithheldRefundResponse {
202
212
  credit_note: CreditNote;
203
213
  }
@@ -531,6 +541,10 @@ declare module 'chargebee' {
531
541
  export interface DeleteInputParam {
532
542
  comment?: string;
533
543
  }
544
+ export interface UpdateInputParam {
545
+ comment?: string;
546
+ [key: `cf_${string}`]: unknown;
547
+ }
534
548
  export interface RemoveTaxWithheldRefundInputParam {
535
549
  tax_withheld?: TaxWithheldRemoveTaxWithheldRefundInputParam;
536
550
  }
@@ -78,11 +78,13 @@ declare module 'chargebee' {
78
78
  SubscriptionAdvanceInvoiceScheduleUpdatedContent &
79
79
  ItemDeletedContent &
80
80
  SubscriptionRampDraftedContent &
81
+ VaultTokenUpdatedContent &
81
82
  DunningUpdatedContent &
82
83
  OmnichannelSubscriptionItemRecoveredContent &
83
84
  ItemEntitlementsUpdatedContent &
84
85
  TokenConsumedContent &
85
86
  HierarchyDeletedContent &
87
+ VaultTokenDeletedContent &
86
88
  SubscriptionCancellationScheduledContent &
87
89
  SubscriptionRenewedContent &
88
90
  FeatureUpdatedContent &
@@ -127,6 +129,7 @@ declare module 'chargebee' {
127
129
  CardUpdatedContent &
128
130
  CustomerCreatedContent &
129
131
  SubscriptionRenewalReminderContent &
132
+ OmnichannelSubscriptionItemMrrUpdatedContent &
130
133
  PaymentDueReminderContent &
131
134
  OrderDeliveredContent &
132
135
  OmnichannelSubscriptionItemCancellationScheduledContent &
@@ -206,6 +209,7 @@ declare module 'chargebee' {
206
209
  PromotionalCreditsAddedContent &
207
210
  SubscriptionRampUpdatedContent &
208
211
  LedgerAccountBalanceUpdatedContent &
212
+ VaultTokenCreatedContent &
209
213
  CustomerEntitlementsUpdatedContent &
210
214
  PaymentSourceExpiredContent &
211
215
  CustomerMovedOutContent &
@@ -102,6 +102,11 @@ declare module 'chargebee' {
102
102
  input?: PriceVariantsInputParam,
103
103
  headers?: ChargebeeRequestHeader,
104
104
  ): Promise<ChargebeeResponse<PriceVariantsResponse>>;
105
+
106
+ ramps(
107
+ input?: RampsInputParam,
108
+ headers?: ChargebeeRequestHeader,
109
+ ): Promise<ChargebeeResponse<RampsResponse>>;
105
110
  }
106
111
 
107
112
  export interface RetrieveResponse {
@@ -176,6 +181,10 @@ declare module 'chargebee' {
176
181
  export: Export;
177
182
  }
178
183
 
184
+ export interface RampsResponse {
185
+ export: Export;
186
+ }
187
+
179
188
  export interface Download {
180
189
  download_url: string;
181
190
  valid_till: number;
@@ -291,6 +300,10 @@ declare module 'chargebee' {
291
300
  include_site_level_resources?: filter.Boolean;
292
301
  price_variant?: PriceVariantPriceVariantsInputParam;
293
302
  }
303
+ export interface RampsInputParam {
304
+ export_type?: ExportTypeEnum;
305
+ ramp?: RampRampsInputParam;
306
+ }
294
307
  export interface InvoiceRevenueRecognitionInputParam {
295
308
  id?: filter.String;
296
309
  recurring?: filter.Boolean;
@@ -613,5 +626,12 @@ declare module 'chargebee' {
613
626
  updated_at?: filter.Timestamp;
614
627
  created_at?: filter.Timestamp;
615
628
  }
629
+
630
+ export interface RampRampsInputParam {
631
+ status?: filter.Enum;
632
+ subscription_id?: filter.String;
633
+ effective_from?: filter.Timestamp;
634
+ updated_at?: filter.Timestamp;
635
+ }
616
636
  }
617
637
  }
@@ -0,0 +1,15 @@
1
+ ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
3
+
4
+ declare module 'chargebee' {
5
+ export interface GatewayPaymentMethodToken {
6
+ id: string;
7
+ gateway_account_id: string;
8
+ gateway_name: GatewayNameEnum;
9
+ gateway_customer_id?: string;
10
+ gateway_token: string;
11
+ status: 'active' | 'inactive' | 'pending_verification';
12
+ created_at: number;
13
+ updated_at?: number;
14
+ }
15
+ }
@@ -469,6 +469,7 @@ declare module 'chargebee' {
469
469
  pass_thru_content?: string;
470
470
  cancel_url?: string;
471
471
  redirect_url?: string;
472
+ locale?: string;
472
473
  subscription?: SubscriptionPreCancelInputParam;
473
474
  }
474
475
  export interface EventsInputParam {
@@ -291,6 +291,12 @@ declare module 'chargebee' {
291
291
  headers?: ChargebeeRequestHeader,
292
292
  ): Promise<ChargebeeResponse<WriteOffResponse>>;
293
293
 
294
+ voidBeforeCapture(
295
+ invoice_id: string,
296
+ input?: VoidBeforeCaptureInputParam,
297
+ headers?: ChargebeeRequestHeader,
298
+ ): Promise<ChargebeeResponse<VoidBeforeCaptureResponse>>;
299
+
294
300
  delete(
295
301
  invoice_id: string,
296
302
  input?: DeleteInputParam,
@@ -476,6 +482,11 @@ declare module 'chargebee' {
476
482
  credit_note: CreditNote;
477
483
  }
478
484
 
485
+ export interface VoidBeforeCaptureResponse {
486
+ invoice: Invoice;
487
+ credit_note?: CreditNote;
488
+ }
489
+
479
490
  export interface DeleteResponse {
480
491
  invoice: Invoice;
481
492
  }
@@ -689,7 +700,7 @@ declare module 'chargebee' {
689
700
  txn_date?: number;
690
701
  txn_amount?: number;
691
702
  txn_type: 'authorization' | 'payment' | 'refund' | 'payment_reversal';
692
- amount_capturable: number;
703
+ amount_capturable?: number;
693
704
  authorization_reason?:
694
705
  | 'verification'
695
706
  | 'blocking_funds'
@@ -1194,6 +1205,11 @@ declare module 'chargebee' {
1194
1205
  export interface WriteOffInputParam {
1195
1206
  comment?: string;
1196
1207
  }
1208
+ export interface VoidBeforeCaptureInputParam {
1209
+ comment?: string;
1210
+ void_reason_code?: string;
1211
+ invoice_action?: InvoiceActionEnum;
1212
+ }
1197
1213
  export interface DeleteInputParam {
1198
1214
  comment?: string;
1199
1215
  }
@@ -0,0 +1,18 @@
1
+ ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
3
+
4
+ declare module 'chargebee' {
5
+ export interface OmnichannelSubscriptionItemMetric {
6
+ customer_id?: string;
7
+ omnichannel_subscription_id?: string;
8
+ omnichannel_subscription_item_id?: string;
9
+ item_id_at_source: string;
10
+ mrr_currency?: string;
11
+ mrr_units?: number;
12
+ mrr_nanos?: number;
13
+ effective_from: number;
14
+ calculated_at?: number;
15
+ created_at: number;
16
+ resource_version?: number;
17
+ }
18
+ }
@@ -69,7 +69,8 @@ declare module 'chargebee' {
69
69
  modified_at: number;
70
70
  resource_version?: number;
71
71
  updated_at?: number;
72
- customer_id: string;
72
+ payment_method_options?: any;
73
+ customer_id?: string;
73
74
  gateway?: string;
74
75
  active_payment_attempt?: PaymentIntent.PaymentAttempt;
75
76
  payment_attempts?: PaymentIntent.PaymentAttempt[];
@@ -178,6 +179,8 @@ declare module 'chargebee' {
178
179
  created_at: number;
179
180
  modified_at: number;
180
181
  error_detail?: GatewayErrorDetail;
182
+ routing_rule_id?: string;
183
+ payment_method_display_rule_id?: string;
181
184
  }
182
185
  export interface PaymentAttempt {
183
186
  id?: string;
@@ -249,19 +252,17 @@ declare module 'chargebee' {
249
252
  created_at: number;
250
253
  modified_at: number;
251
254
  error_detail?: GatewayErrorDetail;
255
+ routing_rule_id?: string;
256
+ payment_method_display_rule_id?: string;
252
257
  }
253
258
  export interface PaymentIntentMetadata {
254
259
  source:
255
- | 'cb_js'
256
- | 'components_fields'
257
- | 'checkout_v3'
258
- | 'paynow_v3'
259
- | 'portal_v3'
260
- | 'gift_v3'
261
- | 'checkout_v4'
262
- | 'payment_component'
263
- | 'pc_inapp_v4'
264
- | 'pc_fpc_v4';
260
+ | 'payment_method_helper'
261
+ | 'card_components'
262
+ | 'checkout'
263
+ | 'collect_now'
264
+ | 'portal'
265
+ | 'payment_components';
265
266
  client_ip_address?: string;
266
267
  user_agent?: string;
267
268
  created_at?: number;
@@ -332,6 +333,7 @@ declare module 'chargebee' {
332
333
  | 'qpay';
333
334
  success_url?: string;
334
335
  failure_url?: string;
336
+ payment_method_options?: any;
335
337
  }
336
338
  export interface UpdateInputParam {
337
339
  amount?: number;
@@ -392,6 +394,7 @@ declare module 'chargebee' {
392
394
  | 'qpay';
393
395
  success_url?: string;
394
396
  failure_url?: string;
397
+ payment_method_options?: any;
395
398
  }
396
399
  }
397
400
  }
@@ -30,6 +30,7 @@ declare module 'chargebee' {
30
30
  venmo?: PaymentSource.Venmo;
31
31
  klarna_pay_now?: PaymentSource.KlarnaPayNow;
32
32
  mandates?: PaymentSource.Mandate[];
33
+ vault_token?: any;
33
34
  deleted: boolean;
34
35
  business_entity_id?: string;
35
36
  }
@@ -89,6 +90,12 @@ declare module 'chargebee' {
89
90
  headers?: ChargebeeRequestHeader,
90
91
  ): Promise<ChargebeeResponse<VerifyBankAccountResponse>>;
91
92
 
93
+ listGatewayTokensForPaymentSource(
94
+ cust_payment_source_id: string,
95
+ input?: ListGatewayTokensForPaymentSourceInputParam,
96
+ headers?: ChargebeeRequestHeader,
97
+ ): Promise<ChargebeeResponse<ListGatewayTokensForPaymentSourceResponse>>;
98
+
92
99
  retrieve(
93
100
  cust_payment_source_id: string,
94
101
  headers?: ChargebeeRequestHeader,
@@ -171,6 +178,11 @@ declare module 'chargebee' {
171
178
  payment_source: PaymentSource;
172
179
  }
173
180
 
181
+ export interface ListGatewayTokensForPaymentSourceResponse {
182
+ list: { gateway_payment_method_token: GatewayPaymentMethodToken }[];
183
+ next_offset?: string;
184
+ }
185
+
174
186
  export interface RetrieveResponse {
175
187
  payment_source: PaymentSource;
176
188
  }
@@ -367,6 +379,11 @@ declare module 'chargebee' {
367
379
  amount1: number;
368
380
  amount2: number;
369
381
  }
382
+ export interface ListGatewayTokensForPaymentSourceInputParam {
383
+ limit?: number;
384
+ offset?: string;
385
+ include_deleted?: boolean;
386
+ }
370
387
  export interface ListInputParam {
371
388
  limit?: number;
372
389
  offset?: string;
@@ -71,7 +71,7 @@ declare module 'chargebee' {
71
71
  validation_status?: ValidationStatusEnum;
72
72
  }
73
73
  export interface PricingPageCreateForNewSubscriptionInputParam {
74
- id: string;
74
+ id?: string;
75
75
  }
76
76
  export interface CustomerCreateForNewSubscriptionInputParam {
77
77
  id?: string;
@@ -59,6 +59,7 @@ declare module 'chargebee' {
59
59
  deleted: boolean;
60
60
  total_contract_value?: number;
61
61
  total_discount?: number;
62
+ has_entitlements?: boolean;
62
63
  }
63
64
 
64
65
  export namespace Quote {
@@ -662,6 +663,7 @@ declare module 'chargebee' {
662
663
  discounts?: DiscountsCreateSubItemsForCustomerQuoteInputParam[];
663
664
  item_tiers?: ItemTiersCreateSubItemsForCustomerQuoteInputParam[];
664
665
  coupons?: CouponsCreateSubItemsForCustomerQuoteInputParam[];
666
+ entitlement_overrides?: EntitlementOverridesCreateSubItemsForCustomerQuoteInputParam[];
665
667
  [key: `cf_${string}`]: unknown;
666
668
  }
667
669
  export interface EditCreateSubCustomerQuoteForItemsInputParam {
@@ -682,6 +684,7 @@ declare module 'chargebee' {
682
684
  discounts?: DiscountsEditCreateSubCustomerQuoteForItemsInputParam[];
683
685
  item_tiers?: ItemTiersEditCreateSubCustomerQuoteForItemsInputParam[];
684
686
  coupons?: CouponsEditCreateSubCustomerQuoteForItemsInputParam[];
687
+ entitlement_overrides?: EntitlementOverridesEditCreateSubCustomerQuoteForItemsInputParam[];
685
688
  [key: `cf_${string}`]: unknown;
686
689
  }
687
690
  export interface UpdateSubscriptionQuoteForItemsInputParam {
@@ -710,6 +713,7 @@ declare module 'chargebee' {
710
713
  discounts?: DiscountsUpdateSubscriptionQuoteForItemsInputParam[];
711
714
  item_tiers?: ItemTiersUpdateSubscriptionQuoteForItemsInputParam[];
712
715
  coupons?: CouponsUpdateSubscriptionQuoteForItemsInputParam[];
716
+ entitlement_overrides?: EntitlementOverridesUpdateSubscriptionQuoteForItemsInputParam[];
713
717
  [key: `cf_${string}`]: unknown;
714
718
  }
715
719
  export interface EditUpdateSubscriptionQuoteForItemsInputParam {
@@ -737,6 +741,7 @@ declare module 'chargebee' {
737
741
  discounts?: DiscountsEditUpdateSubscriptionQuoteForItemsInputParam[];
738
742
  item_tiers?: ItemTiersEditUpdateSubscriptionQuoteForItemsInputParam[];
739
743
  coupons?: CouponsEditUpdateSubscriptionQuoteForItemsInputParam[];
744
+ entitlement_overrides?: EntitlementOverridesEditUpdateSubscriptionQuoteForItemsInputParam[];
740
745
  [key: `cf_${string}`]: unknown;
741
746
  }
742
747
  export interface CreateForChargeItemsAndChargesInputParam {
@@ -1231,6 +1236,7 @@ declare module 'chargebee' {
1231
1236
  charge_on_option?: ChargeOnOptionEnum;
1232
1237
  start_date?: number;
1233
1238
  end_date?: number;
1239
+ description?: string;
1234
1240
  ramp_tier_id?: string;
1235
1241
  }
1236
1242
  export interface DiscountsCreateSubItemsForCustomerQuoteInputParam {
@@ -1251,6 +1257,15 @@ declare module 'chargebee' {
1251
1257
  start_date?: number;
1252
1258
  end_date?: number;
1253
1259
  }
1260
+ export interface EntitlementOverridesCreateSubItemsForCustomerQuoteInputParam {
1261
+ feature_id?: string;
1262
+ entity_id?: string;
1263
+ entity_type?: EntityTypeEnum;
1264
+ value?: string;
1265
+ is_enabled?: boolean;
1266
+ start_date?: number;
1267
+ end_date?: number;
1268
+ }
1254
1269
  export interface ItemTiersCreateSubItemsForCustomerQuoteInputParam {
1255
1270
  item_price_id?: string;
1256
1271
  starting_unit?: number;
@@ -1332,6 +1347,7 @@ declare module 'chargebee' {
1332
1347
  charge_on_option?: ChargeOnOptionEnum;
1333
1348
  start_date?: number;
1334
1349
  end_date?: number;
1350
+ description?: string;
1335
1351
  ramp_tier_id?: string;
1336
1352
  }
1337
1353
  export interface DiscountsEditCreateSubCustomerQuoteForItemsInputParam {
@@ -1352,6 +1368,15 @@ declare module 'chargebee' {
1352
1368
  start_date?: number;
1353
1369
  end_date?: number;
1354
1370
  }
1371
+ export interface EntitlementOverridesEditCreateSubCustomerQuoteForItemsInputParam {
1372
+ feature_id?: string;
1373
+ entity_id?: string;
1374
+ entity_type?: EntityTypeEnum;
1375
+ value?: string;
1376
+ is_enabled?: boolean;
1377
+ start_date?: number;
1378
+ end_date?: number;
1379
+ }
1355
1380
  export interface ItemTiersEditCreateSubCustomerQuoteForItemsInputParam {
1356
1381
  item_price_id?: string;
1357
1382
  starting_unit?: number;
@@ -1440,6 +1465,7 @@ declare module 'chargebee' {
1440
1465
  item_type?: ItemTypeEnum;
1441
1466
  start_date?: number;
1442
1467
  end_date?: number;
1468
+ description?: string;
1443
1469
  ramp_tier_id?: string;
1444
1470
  }
1445
1471
  export interface DiscountsUpdateSubscriptionQuoteForItemsInputParam {
@@ -1462,6 +1488,15 @@ declare module 'chargebee' {
1462
1488
  start_date?: number;
1463
1489
  end_date?: number;
1464
1490
  }
1491
+ export interface EntitlementOverridesUpdateSubscriptionQuoteForItemsInputParam {
1492
+ feature_id?: string;
1493
+ entity_id?: string;
1494
+ entity_type?: EntityTypeEnum;
1495
+ value?: string;
1496
+ is_enabled?: boolean;
1497
+ start_date?: number;
1498
+ end_date?: number;
1499
+ }
1465
1500
  export interface ItemTiersUpdateSubscriptionQuoteForItemsInputParam {
1466
1501
  item_price_id?: string;
1467
1502
  starting_unit?: number;
@@ -1549,6 +1584,7 @@ declare module 'chargebee' {
1549
1584
  item_type?: ItemTypeEnum;
1550
1585
  start_date?: number;
1551
1586
  end_date?: number;
1587
+ description?: string;
1552
1588
  ramp_tier_id?: string;
1553
1589
  }
1554
1590
  export interface DiscountsEditUpdateSubscriptionQuoteForItemsInputParam {
@@ -1571,6 +1607,15 @@ declare module 'chargebee' {
1571
1607
  start_date?: number;
1572
1608
  end_date?: number;
1573
1609
  }
1610
+ export interface EntitlementOverridesEditUpdateSubscriptionQuoteForItemsInputParam {
1611
+ feature_id?: string;
1612
+ entity_id?: string;
1613
+ entity_type?: EntityTypeEnum;
1614
+ value?: string;
1615
+ is_enabled?: boolean;
1616
+ start_date?: number;
1617
+ end_date?: number;
1618
+ }
1574
1619
  export interface ItemTiersEditUpdateSubscriptionQuoteForItemsInputParam {
1575
1620
  item_price_id?: string;
1576
1621
  starting_unit?: number;
@@ -0,0 +1,49 @@
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 QuoteEntitlement {
6
+ entity_id: string;
7
+ entity_type: 'plan_price' | 'addon_price' | 'charge_price';
8
+ action_type: 'upsert' | 'remove';
9
+ feature_id: string;
10
+ value?: string;
11
+ is_enabled: boolean;
12
+ start_date?: number;
13
+ end_date?: number;
14
+ created_at: number;
15
+ modified_at: number;
16
+ is_overridden?: boolean;
17
+ feature_name?: string;
18
+ feature_unit?: string;
19
+ feature_type?: string;
20
+ name?: string;
21
+ metered?: boolean;
22
+ }
23
+
24
+ export namespace QuoteEntitlement {
25
+ export class QuoteEntitlementResource {
26
+ listQuoteEntitlements(
27
+ quote_id: string,
28
+ input?: ListQuoteEntitlementsInputParam,
29
+ headers?: ChargebeeRequestHeader,
30
+ ): Promise<ChargebeeResponse<ListQuoteEntitlementsResponse>>;
31
+ }
32
+
33
+ export interface ListQuoteEntitlementsResponse {
34
+ list: { quote_entitlement: QuoteEntitlement }[];
35
+ next_offset?: string;
36
+ }
37
+
38
+ // REQUEST PARAMS
39
+ //---------------
40
+
41
+ export interface ListQuoteEntitlementsInputParam {
42
+ limit?: number;
43
+ offset?: string;
44
+ entity_id?: filter.String;
45
+ start_date?: filter.Timestamp;
46
+ end_date?: filter.Timestamp;
47
+ }
48
+ }
49
+ }
@@ -46,6 +46,7 @@ declare module 'chargebee' {
46
46
  amount_per_billing_cycle_in_decimal?: string;
47
47
  net_amount_per_billing_cycle?: number;
48
48
  net_amount_per_billing_cycle_in_decimal?: string;
49
+ description?: string;
49
50
  }
50
51
  export interface Discount {
51
52
  id: string;
@@ -0,0 +1,28 @@
1
+ ///<reference path='./../core.d.ts'/>
2
+ ///<reference path='./../index.d.ts'/>
3
+
4
+ declare module 'chargebee' {
5
+ export interface VaultedPaymentMethod {
6
+ id: string;
7
+ customer_id: string;
8
+ credit_card_id: string;
9
+ created_at: number;
10
+ modified_at: number;
11
+ }
12
+
13
+ export namespace VaultedPaymentMethod {
14
+ export class VaultedPaymentMethodResource {
15
+ retrieve(
16
+ vaulted_payment_method_id: string,
17
+ headers?: ChargebeeRequestHeader,
18
+ ): Promise<ChargebeeResponse<RetrieveResponse>>;
19
+ }
20
+
21
+ export interface RetrieveResponse {
22
+ vaulted_payment_method: VaultedPaymentMethod;
23
+ }
24
+
25
+ // REQUEST PARAMS
26
+ //---------------
27
+ }
28
+ }