chargebee 3.12.0-beta.1 → 3.13.0

package/types/resources/CreditNote.d.ts

@@ -36,7 +36,6 @@ declare module 'chargebee' {
     resource_version?: number;
     updated_at?: number;
     channel?: ChannelEnum;
-    einvoice?: CreditNote.Einvoice;
     sub_total: number;
     sub_total_in_local_currency?: number;
     total_in_local_currency?: number;
@@ -44,11 +43,13 @@ declare module 'chargebee' {
     round_off_amount?: number;
     fractional_correction?: number;
     line_items?: CreditNote.LineItem[];
-    discounts?: CreditNote.Discount[];
-    line_item_discounts?: CreditNote.LineItemDiscount[];
     line_item_tiers?: CreditNote.LineItemTier[];
-    taxes?: CreditNote.Tax[];
+    line_item_discounts?: CreditNote.LineItemDiscount[];
     line_item_taxes?: CreditNote.LineItemTax[];
+    line_item_addresses?: CreditNote.LineItemAddress[];
+    discounts?: CreditNote.Discount[];
+    taxes?: CreditNote.Tax[];
+    tax_origin?: CreditNote.TaxOrigin;
     linked_refunds?: CreditNote.LinkedRefund[];
     allocations?: CreditNote.Allocation[];
     deleted: boolean;
@@ -59,9 +60,8 @@ declare module 'chargebee' {
     business_entity_id?: string;
     shipping_address?: CreditNote.ShippingAddress;
     billing_address?: CreditNote.BillingAddress;
+    einvoice?: CreditNote.Einvoice;
     site_details_at_creation?: CreditNote.SiteDetailsAtCreation;
-    tax_origin?: CreditNote.TaxOrigin;
-    line_item_addresses?: CreditNote.LineItemAddress[];
   }
 
   export namespace CreditNote {
@@ -206,18 +206,6 @@ declare module 'chargebee' {
       credit_note: CreditNote;
     }
 
-    export interface Einvoice {
-      id: string;
-      reference_number?: string;
-      status:
-        | 'scheduled'
-        | 'skipped'
-        | 'in_progress'
-        | 'success'
-        | 'failed'
-        | 'registered';
-      message?: string;
-    }
     export interface LineItem {
       id?: string;
       subscription_id?: string;
@@ -267,33 +255,6 @@ declare module 'chargebee' {
       entity_id?: string;
       customer_id?: string;
     }
-    export interface Discount {
-      amount: number;
-      description?: string;
-      entity_type:
-        | 'item_level_coupon'
-        | 'document_level_coupon'
-        | 'promotional_credits'
-        | 'prorated_credits'
-        | 'item_level_discount'
-        | 'document_level_discount';
-      discount_type?: 'fixed_amount' | 'percentage';
-      entity_id?: string;
-      coupon_set_code?: string;
-    }
-    export interface LineItemDiscount {
-      line_item_id: string;
-      discount_type:
-        | 'item_level_coupon'
-        | 'document_level_coupon'
-        | 'promotional_credits'
-        | 'prorated_credits'
-        | 'item_level_discount'
-        | 'document_level_discount';
-      coupon_id?: string;
-      entity_id?: string;
-      discount_amount: number;
-    }
     export interface LineItemTier {
       line_item_id?: string;
       starting_unit: number;
@@ -307,10 +268,18 @@ declare module 'chargebee' {
       pricing_type?: 'per_unit' | 'flat_fee' | 'package';
       package_size?: number;
     }
-    export interface Tax {
-      name: string;
-      amount: number;
-      description?: string;
+    export interface LineItemDiscount {
+      line_item_id: string;
+      discount_type:
+        | 'item_level_coupon'
+        | 'document_level_coupon'
+        | 'promotional_credits'
+        | 'prorated_credits'
+        | 'item_level_discount'
+        | 'document_level_discount';
+      coupon_id?: string;
+      entity_id?: string;
+      discount_amount: number;
     }
     export interface LineItemTax {
       line_item_id?: string;
@@ -337,6 +306,50 @@ declare module 'chargebee' {
       tax_amount_in_local_currency?: number;
       local_currency_code?: string;
     }
+    export interface LineItemAddress {
+      line_item_id?: string;
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      company?: string;
+      phone?: string;
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      state?: string;
+      country?: string;
+      zip?: string;
+      validation_status?:
+        | 'not_validated'
+        | 'valid'
+        | 'partially_valid'
+        | 'invalid';
+    }
+    export interface Discount {
+      amount: number;
+      description?: string;
+      entity_type:
+        | 'item_level_coupon'
+        | 'document_level_coupon'
+        | 'promotional_credits'
+        | 'prorated_credits'
+        | 'item_level_discount'
+        | 'document_level_discount';
+      discount_type?: 'fixed_amount' | 'percentage';
+      entity_id?: string;
+      coupon_set_code?: string;
+    }
+    export interface Tax {
+      name: string;
+      amount: number;
+      description?: string;
+    }
+    export interface TaxOrigin {
+      country?: string;
+      registration_number?: string;
+    }
     export interface LinkedRefund {
       txn_id: string;
       applied_amount: number;
@@ -400,35 +413,22 @@ declare module 'chargebee' {
       zip?: string;
       validation_status?: ValidationStatusEnum;
     }
+    export interface Einvoice {
+      id: string;
+      reference_number?: string;
+      status:
+        | 'scheduled'
+        | 'skipped'
+        | 'in_progress'
+        | 'success'
+        | 'failed'
+        | 'registered';
+      message?: string;
+    }
     export interface SiteDetailsAtCreation {
       timezone?: string;
       organization_address?: object;
     }
-    export interface TaxOrigin {
-      country?: string;
-      registration_number?: string;
-    }
-    export interface LineItemAddress {
-      line_item_id?: string;
-      first_name?: string;
-      last_name?: string;
-      email?: string;
-      company?: string;
-      phone?: string;
-      line1?: string;
-      line2?: string;
-      line3?: string;
-      city?: string;
-      state_code?: string;
-      state?: string;
-      country?: string;
-      zip?: string;
-      validation_status?:
-        | 'not_validated'
-        | 'valid'
-        | 'partially_valid'
-        | 'invalid';
-    }
     // REQUEST PARAMS
     //---------------
 
@@ -543,7 +543,9 @@ declare module 'chargebee' {
         | 'adhoc'
         | 'plan_item_price'
         | 'addon_item_price'
-        | 'charge_item_price';
+        | 'charge_item_price'
+        | 'plan'
+        | 'addon';
       entity_id?: string;
     }
     export interface LineItemRetrieveInputParam {
@@ -558,6 +560,7 @@ declare module 'chargebee' {
     }
 
     export interface TransactionRecordRefundInputParam {
+      id?: string;
       amount?: number;
       payment_method: PaymentMethodEnum;
       reference_number?: string;
@@ -590,6 +593,7 @@ declare module 'chargebee' {
       amount: number;
     }
     export interface LinkedRefundsImportCreditNoteInputParam {
+      id?: string;
       amount: number;
       payment_method: PaymentMethodEnum;
       date: number;
@@ -640,7 +644,10 @@ declare module 'chargebee' {
         | 'adhoc'
         | 'plan_item_price'
         | 'addon_item_price'
-        | 'charge_item_price';
+        | 'charge_item_price'
+        | 'plan_setup'
+        | 'plan'
+        | 'addon';
       entity_id?: string;
       item_level_discount1_entity_id?: string;
       item_level_discount1_amount?: number;

package/types/resources/Customer.d.ts

@@ -869,6 +869,7 @@ declare module 'chargebee' {
     }
 
     export interface TransactionRecordExcessPaymentInputParam {
+      id?: string;
       amount: number;
       currency_code?: string;
       date: number;

package/types/resources/CustomerEntitlement.d.ts

@@ -31,6 +31,7 @@ declare module 'chargebee' {
     export interface EntitlementsForCustomerInputParam {
       limit?: number;
       offset?: string;
+      consolidate_entitlements?: boolean;
     }
   }
 }

package/types/resources/Discount.d.ts

@@ -5,9 +5,10 @@ declare module 'chargebee' {
   export interface Discount {
     id: string;
     invoice_name?: string;
-    type: 'fixed_amount' | 'percentage';
+    type: 'fixed_amount' | 'percentage' | 'offer_quantity';
     percentage?: number;
     amount?: number;
+    quantity?: number;
     currency_code?: string;
     duration_type: DurationTypeEnum;
     period?: number;

package/types/resources/Estimate.d.ts

@@ -625,6 +625,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
     }
     export interface ItemTiersCreateSubItemEstimateInputParam {
       item_price_id?: string;
@@ -765,6 +766,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
     }
     export interface ItemTiersCreateSubItemForCustomerEstimateInputParam {
       item_price_id?: string;
@@ -927,6 +929,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
       operation_type: OperationTypeEnum;
       id?: string;
     }
@@ -1232,6 +1235,7 @@ declare module 'chargebee' {
     export interface DiscountsCreateInvoiceForItemsInputParam {
       percentage?: number;
       amount?: number;
+      quantity?: number;
       apply_on: ApplyOnEnum;
       item_price_id?: string;
     }

package/types/resources/Event.d.ts

@@ -20,7 +20,212 @@ declare module 'chargebee' {
     webhooks?: Event.Webhook[];
     event_type?: EventTypeEnum;
     api_version?: ApiVersionEnum;
-    content: any;
+    content: SubscriptionPauseScheduledContent &
+      CustomerBusinessEntityChangedContent &
+      SubscriptionAdvanceInvoiceScheduleAddedContent &
+      GiftExpiredContent &
+      TaxWithheldDeletedContent &
+      UnbilledChargesDeletedContent &
+      CouponUpdatedContent &
+      OmnichannelSubscriptionItemReactivatedContent &
+      OmnichannelSubscriptionItemRenewedContent &
+      UnbilledChargesCreatedContent &
+      SubscriptionResumedContent &
+      OmnichannelOneTimeOrderItemCancelledContent &
+      SubscriptionCancelledContent &
+      ItemEntitlementsRemovedContent &
+      BusinessEntityCreatedContent &
+      CouponSetUpdatedContent &
+      DifferentialPriceUpdatedContent &
+      OmnichannelSubscriptionItemPausedContent &
+      EntitlementOverridesRemovedContent &
+      SubscriptionActivatedWithBackdatingContent &
+      SubscriptionTrialEndReminderContent &
+      SubscriptionShippingAddressUpdatedContent &
+      VoucherCreateFailedContent &
+      GiftClaimedContent &
+      CustomerDeletedContent &
+      RefundInitiatedContent &
+      InvoiceGeneratedWithBackdatingContent &
+      AddUsagesReminderContent &
+      VoucherCreatedContent &
+      RuleUpdatedContent &
+      PaymentSchedulesCreatedContent &
+      FeatureActivatedContent &
+      PaymentSourceLocallyDeletedContent &
+      InvoiceGeneratedContent &
+      VoucherExpiredContent &
+      AuthorizationSucceededContent &
+      GiftScheduledContent &
+      SubscriptionChangesScheduledContent &
+      SubscriptionChangedWithBackdatingContent &
+      OmnichannelSubscriptionItemChangedContent &
+      GiftUnclaimedContent &
+      VirtualBankAccountAddedContent &
+      PaymentIntentCreatedContent &
+      CreditNoteCreatedWithBackdatingContent &
+      ContractTermTerminatedContent &
+      ItemFamilyUpdatedContent &
+      OrderCreatedContent &
+      PriceVariantDeletedContent &
+      SubscriptionMovementFailedContent &
+      CustomerMovedInContent &
+      SubscriptionAdvanceInvoiceScheduleUpdatedContent &
+      ItemDeletedContent &
+      SubscriptionRampDraftedContent &
+      ItemEntitlementsUpdatedContent &
+      TokenConsumedContent &
+      HierarchyDeletedContent &
+      SubscriptionCancellationScheduledContent &
+      SubscriptionRenewedContent &
+      FeatureUpdatedContent &
+      FeatureDeletedContent &
+      ItemFamilyCreatedContent &
+      OmnichannelSubscriptionItemScheduledChangeRemovedContent &
+      OmnichannelSubscriptionItemResumedContent &
+      PurchaseCreatedContent &
+      EntitlementOverridesUpdatedContent &
+      ItemFamilyDeletedContent &
+      SubscriptionResumptionScheduledContent &
+      FeatureReactivatedContent &
+      CouponCodesDeletedContent &
+      CardExpiredContent &
+      CreditNoteUpdatedContent &
+      OmnichannelSubscriptionItemDowngradedContent &
+      PriceVariantUpdatedContent &
+      PromotionalCreditsDeductedContent &
+      SubscriptionRampAppliedContent &
+      SubscriptionPausedContent &
+      OrderReadyToProcessContent &
+      FeatureCreatedContent &
+      TransactionDeletedContent &
+      CreditNoteCreatedContent &
+      OmnichannelSubscriptionItemResubscribedContent &
+      RecordPurchaseFailedContent &
+      ItemCreatedContent &
+      TransactionUpdatedContent &
+      MrrUpdatedContent &
+      UnbilledChargesInvoicedContent &
+      ItemPriceUpdatedContent &
+      CouponCodesUpdatedContent &
+      VirtualBankAccountUpdatedContent &
+      ContractTermCreatedContent &
+      SubscriptionChangedContent &
+      PaymentFailedContent &
+      CreditNoteDeletedContent &
+      TaxWithheldRefundedContent &
+      ContractTermCompletedContent &
+      PaymentSchedulesUpdatedContent &
+      OmnichannelSubscriptionItemExpiredContent &
+      CardUpdatedContent &
+      CustomerCreatedContent &
+      SubscriptionRenewalReminderContent &
+      OrderDeliveredContent &
+      OmnichannelSubscriptionItemCancellationScheduledContent &
+      OmnichannelSubscriptionItemGracePeriodExpiredContent &
+      CouponCodesAddedContent &
+      GiftCancelledContent &
+      OrderCancelledContent &
+      CouponDeletedContent &
+      SubscriptionScheduledChangesRemovedContent &
+      PendingInvoiceCreatedContent &
+      EntitlementOverridesAutoRemovedContent &
+      OmnichannelSubscriptionItemUpgradedContent &
+      SubscriptionBusinessEntityChangedContent &
+      OmnichannelOneTimeOrderCreatedContent &
+      PaymentSourceDeletedContent &
+      OmnichannelSubscriptionItemCancelledContent &
+      QuoteDeletedContent &
+      InvoiceUpdatedContent &
+      SubscriptionAdvanceInvoiceScheduleRemovedContent &
+      CardDeletedContent &
+      OrderReadyToShipContent &
+      SubscriptionMovedOutContent &
+      PaymentScheduleSchemeCreatedContent &
+      BusinessEntityUpdatedContent &
+      SubscriptionScheduledResumptionRemovedContent &
+      PaymentInitiatedContent &
+      FeatureArchivedContent &
+      SubscriptionReactivatedWithBackdatingContent &
+      OmnichannelSubscriptionImportedContent &
+      TokenExpiredContent &
+      CardAddedContent &
+      CouponCreatedContent &
+      RuleDeletedContent &
+      ItemPriceEntitlementsUpdatedContent &
+      ItemPriceDeletedContent &
+      VirtualBankAccountDeletedContent &
+      PaymentScheduleSchemeDeletedContent &
+      SubscriptionCreatedContent &
+      SubscriptionEntitlementsCreatedContent &
+      OrderReturnedContent &
+      SubscriptionDeletedContent &
+      PaymentSourceAddedContent &
+      SubscriptionMovedInContent &
+      ItemPriceCreatedContent &
+      SubscriptionScheduledCancellationRemovedContent &
+      PaymentRefundedContent &
+      UsageFileIngestedContent &
+      DifferentialPriceCreatedContent &
+      TransactionCreatedContent &
+      PaymentSucceededContent &
+      SubscriptionCanceledWithBackdatingContent &
+      UnbilledChargesVoidedContent &
+      QuoteCreatedContent &
+      CouponSetDeletedContent &
+      AttachedItemCreatedContent &
+      SalesOrderCreatedContent &
+      CustomerChangedContent &
+      SubscriptionStartedContent &
+      SubscriptionActivatedContent &
+      PaymentSourceExpiringContent &
+      SubscriptionReactivatedContent &
+      OrderUpdatedContent &
+      SubscriptionScheduledPauseRemovedContent &
+      SubscriptionCancellationReminderContent &
+      SubscriptionCreatedWithBackdatingContent &
+      SubscriptionRampCreatedContent &
+      OrderDeletedContent &
+      OmnichannelSubscriptionItemPauseScheduledContent &
+      GiftUpdatedContent &
+      SubscriptionTrialExtendedContent &
+      OmnichannelSubscriptionItemGracePeriodStartedContent &
+      CardExpiryReminderContent &
+      TokenCreatedContent &
+      PromotionalCreditsAddedContent &
+      SubscriptionRampUpdatedContent &
+      CustomerEntitlementsUpdatedContent &
+      PaymentSourceExpiredContent &
+      CustomerMovedOutContent &
+      SubscriptionEntitlementsUpdatedContent &
+      OmnichannelSubscriptionItemDunningExpiredContent &
+      HierarchyCreatedContent &
+      AttachedItemDeletedContent &
+      OmnichannelSubscriptionItemScheduledCancellationRemovedContent &
+      ItemUpdatedContent &
+      CouponSetCreatedContent &
+      PaymentIntentUpdatedContent &
+      OrderResentContent &
+      OmnichannelSubscriptionCreatedContent &
+      TaxWithheldRecordedContent &
+      PriceVariantCreatedContent &
+      DifferentialPriceDeletedContent &
+      SubscriptionItemsRenewedContent &
+      RuleCreatedContent &
+      ContractTermCancelledContent &
+      ContractTermRenewedContent &
+      InvoiceDeletedContent &
+      ItemPriceEntitlementsRemovedContent &
+      SalesOrderUpdatedContent &
+      OmnichannelSubscriptionItemDunningStartedContent &
+      OmnichannelSubscriptionItemChangeScheduledContent &
+      PendingInvoiceUpdatedContent &
+      QuoteUpdatedContent &
+      AttachedItemUpdatedContent &
+      PaymentSourceUpdatedContent &
+      BusinessEntityDeletedContent &
+      AuthorizationVoidedContent &
+      SubscriptionRampDeletedContent;
     origin_user?: string;
   }
 

package/types/resources/HostedPage.d.ts

@@ -28,7 +28,7 @@ declare module 'chargebee' {
     embed: boolean;
     created_at?: number;
     expires_at?: number;
-    content: any;
+    content: Content;
     updated_at?: number;
     resource_version?: number;
     checkout_info?: any;
@@ -720,6 +720,7 @@ declare module 'chargebee' {
     export interface DiscountsCheckoutOneTimeForItemsInputParam {
       percentage?: number;
       amount?: number;
+      quantity?: number;
       apply_on: ApplyOnEnum;
       item_price_id?: string;
     }
@@ -850,6 +851,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
     }
     export interface EntityIdentifiersCheckoutNewForItemsInputParam {
       id?: string;
@@ -985,6 +987,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
       operation_type: OperationTypeEnum;
       id?: string;
     }

package/types/resources/ImpactedCustomer.d.ts

@@ -0,0 +1,19 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface ImpactedCustomer {
+    action_type?: string;
+    download?: ImpactedCustomer.Download;
+  }
+
+  export namespace ImpactedCustomer {
+    export interface Download {
+      download_url: string;
+      valid_till: number;
+      mime_type?: string;
+    }
+    // REQUEST PARAMS
+    //---------------
+  }
+}