chargebee 3.33.0 → 3.35.0

package/types/resources/Event.d.ts

@@ -20,6 +20,7 @@ declare module 'chargebee' {
     webhook_failure_reason?: string;
     webhooks?: Event.Webhook[];
     event_type?: EventTypeEnum;
+    site_id?: string;
     api_version?: ApiVersionEnum;
     content: SubscriptionPauseScheduledContent &
       CustomerBusinessEntityChangedContent &
@@ -29,12 +30,15 @@ declare module 'chargebee' {
       UnbilledChargesDeletedContent &
       CouponUpdatedContent &
       GrantBlocksCreatedContent &
+      ChargebackLostContent &
+      PriceRampUpdatedContent &
       OmnichannelSubscriptionItemReactivatedContent &
       OmnichannelSubscriptionItemRenewedContent &
       UnbilledChargesCreatedContent &
       SubscriptionResumedContent &
       OmnichannelOneTimeOrderItemCancelledContent &
       SubscriptionCancelledContent &
+      BusinessRuleDeletedContent &
       ItemEntitlementsRemovedContent &
       BusinessEntityCreatedContent &
       CouponSetUpdatedContent &
@@ -71,15 +75,20 @@ declare module 'chargebee' {
       ContractTermTerminatedContent &
       ItemFamilyUpdatedContent &
       OrderCreatedContent &
+      RefundFailedContent &
       PriceVariantDeletedContent &
       AlertStatusChangedContent &
       SubscriptionMovementFailedContent &
+      BusinessRulesetUpdatedContent &
       CustomerMovedInContent &
       SubscriptionAdvanceInvoiceScheduleUpdatedContent &
       ItemDeletedContent &
       SubscriptionRampDraftedContent &
+      ChargebackInitiatedContent &
+      BusinessRuleCreatedContent &
       VaultTokenUpdatedContent &
       DunningUpdatedContent &
+      EinvoiceCreatedContent &
       OmnichannelSubscriptionItemRecoveredContent &
       ItemEntitlementsUpdatedContent &
       TokenConsumedContent &
@@ -88,10 +97,12 @@ declare module 'chargebee' {
       SubscriptionCancellationScheduledContent &
       SubscriptionRenewedContent &
       FeatureUpdatedContent &
+      CollectionsPaymentPromiseFulfilledContent &
       FeatureDeletedContent &
       ItemFamilyCreatedContent &
       OmnichannelSubscriptionItemScheduledChangeRemovedContent &
       OmnichannelSubscriptionItemResumedContent &
+      CollectionsDisputeResolvedContent &
       PurchaseCreatedContent &
       EntitlementOverridesUpdatedContent &
       ItemFamilyDeletedContent &
@@ -101,9 +112,12 @@ declare module 'chargebee' {
       CardExpiredContent &
       CreditNoteUpdatedContent &
       OmnichannelSubscriptionItemDowngradedContent &
+      BusinessRulesetDeactivatedContent &
       PriceVariantUpdatedContent &
+      CollectionsDisputeUpdatedContent &
       PromotionalCreditsDeductedContent &
       SubscriptionRampAppliedContent &
+      BusinessRulesetDeletedContent &
       SubscriptionPausedContent &
       OrderReadyToProcessContent &
       FeatureCreatedContent &
@@ -112,9 +126,12 @@ declare module 'chargebee' {
       OmnichannelSubscriptionItemResubscribedContent &
       RecordPurchaseFailedContent &
       ItemCreatedContent &
+      BusinessRulesetCreatedContent &
       TransactionUpdatedContent &
+      CollectionsPaymentPromiseUpdatedContent &
       MrrUpdatedContent &
       UnbilledChargesInvoicedContent &
+      ChargebackWonContent &
       ItemPriceUpdatedContent &
       CouponCodesUpdatedContent &
       VirtualBankAccountUpdatedContent &
@@ -127,6 +144,8 @@ declare module 'chargebee' {
       PaymentSchedulesUpdatedContent &
       OmnichannelSubscriptionItemExpiredContent &
       CardUpdatedContent &
+      PriceRampCreatedContent &
+      CollectionsReminderSequenceCreatedContent &
       CustomerCreatedContent &
       SubscriptionRenewalReminderContent &
       OmnichannelSubscriptionItemMrrUpdatedContent &
@@ -135,19 +154,25 @@ declare module 'chargebee' {
       OmnichannelSubscriptionItemCancellationScheduledContent &
       OmnichannelSubscriptionItemGracePeriodExpiredContent &
       CouponCodesAddedContent &
+      EmailMessageReceivedContent &
       GiftCancelledContent &
       OrderCancelledContent &
       CouponDeletedContent &
       SubscriptionScheduledChangesRemovedContent &
       PendingInvoiceCreatedContent &
+      CollectionsPaymentPromiseBrokenContent &
       EntitlementOverridesAutoRemovedContent &
+      PriceRampDeletedContent &
+      BusinessRulesetActivatedContent &
       OmnichannelSubscriptionItemUpgradedContent &
       SubscriptionBusinessEntityChangedContent &
       OmnichannelOneTimeOrderCreatedContent &
+      CollectionsPaymentPromiseCreatedContent &
       PaymentSourceDeletedContent &
       OmnichannelSubscriptionItemCancelledContent &
       QuoteDeletedContent &
       InvoiceUpdatedContent &
+      PrivateNoteAddedContent &
       SubscriptionAdvanceInvoiceScheduleRemovedContent &
       CardDeletedContent &
       OrderReadyToShipContent &
@@ -163,6 +188,7 @@ declare module 'chargebee' {
       CardAddedContent &
       CouponCreatedContent &
       RuleDeletedContent &
+      CollectionsDisputeCreatedContent &
       ItemPriceEntitlementsUpdatedContent &
       ItemPriceDeletedContent &
       VirtualBankAccountDeletedContent &
@@ -174,6 +200,7 @@ declare module 'chargebee' {
       PaymentSourceAddedContent &
       SubscriptionMovedInContent &
       LedgerUpdatedContent &
+      CollectionsPaymentPromiseCancelledContent &
       ItemPriceCreatedContent &
       SubscriptionScheduledCancellationRemovedContent &
       PaymentRefundedContent &
@@ -194,6 +221,7 @@ declare module 'chargebee' {
       PaymentSourceExpiringContent &
       SubscriptionReactivatedContent &
       OrderUpdatedContent &
+      CollectionsDisputeWithdrawnContent &
       SubscriptionScheduledPauseRemovedContent &
       SubscriptionCancellationReminderContent &
       SubscriptionCreatedWithBackdatingContent &
@@ -205,20 +233,25 @@ declare module 'chargebee' {
       OmnichannelSubscriptionItemGracePeriodStartedContent &
       CardExpiryReminderContent &
       TokenCreatedContent &
+      CollectionsReminderSequencePausedContent &
       PaymentSourceBusinessEntityChangedContent &
       PromotionalCreditsAddedContent &
       SubscriptionRampUpdatedContent &
+      BusinessRuleDeactivatedContent &
       LedgerAccountBalanceUpdatedContent &
       VaultTokenCreatedContent &
+      EinvoiceUpdatedContent &
       CustomerEntitlementsUpdatedContent &
       PaymentSourceExpiredContent &
       CustomerMovedOutContent &
+      BusinessRuleReleasedContent &
       SubscriptionEntitlementsUpdatedContent &
       OmnichannelSubscriptionItemDunningExpiredContent &
       HierarchyCreatedContent &
       AttachedItemDeletedContent &
       OmnichannelSubscriptionItemScheduledCancellationRemovedContent &
       ItemUpdatedContent &
+      CollectionsReminderSequenceResumedContent &
       CouponSetCreatedContent &
       PaymentIntentUpdatedContent &
       OrderResentContent &
@@ -226,11 +259,14 @@ declare module 'chargebee' {
       TaxWithheldRecordedContent &
       PriceVariantCreatedContent &
       DifferentialPriceDeletedContent &
+      BusinessRuleActivatedContent &
       SubscriptionItemsRenewedContent &
+      PaymentSchedulesCancelledContent &
       RuleCreatedContent &
       ContractTermCancelledContent &
       ContractTermRenewedContent &
       InvoiceDeletedContent &
+      BusinessRuleUpdatedContent &
       ItemPriceEntitlementsRemovedContent &
       SalesOrderUpdatedContent &
       OmnichannelSubscriptionItemDunningStartedContent &
@@ -242,6 +278,7 @@ declare module 'chargebee' {
       BusinessEntityDeletedContent &
       GrantBlocksUpdatedContent &
       AuthorizationVoidedContent &
+      CollectionsReminderSequenceCompletedContent &
       SubscriptionRampDeletedContent &
       PlanDeletedContent &
       AddonDeletedContent &

package/types/resources/Execution.d.ts

@@ -0,0 +1,12 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface Execution {
+    status: 'success' | 'failed';
+    created_at: number;
+    result?: any;
+    error_detail?: any;
+    revision_version?: number;
+  }
+}

package/types/resources/GatewayPaymentMethodToken.d.ts

@@ -5,10 +5,10 @@ declare module 'chargebee' {
   export interface GatewayPaymentMethodToken {
     id: string;
     gateway_account_id: string;
-    gateway_name: GatewayNameEnum;
+    gateway: GatewayEnum;
     gateway_customer_id?: string;
     gateway_token: string;
-    status: 'active' | 'inactive' | 'pending_verification';
+    status: 'valid' | 'invalid' | 'pending_verification';
     created_at: number;
     updated_at?: number;
   }

package/types/resources/Gift.d.ts

@@ -235,7 +235,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -338,7 +351,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/GrantBlock.d.ts

@@ -4,19 +4,19 @@
 declare module 'chargebee' {
   export interface GrantBlock {
     id: string;
-    subscription_id?: string;
-    account_type?: 'provisioned' | 'overdraft';
-    unit_id?: string;
-    unit_type?: 'credit_unit';
+    subscription_id: string;
+    unit_id: string;
+    unit_type: 'credit_unit';
+    account_type: 'provisioned' | 'overdraft';
     granted_amount: string;
     effective_from: number;
     expires_at: number;
     balance: string;
     hold_amount: string;
     used_amount: string;
-    expired_amount: string;
-    rolled_over_amount: string;
-    voided_amount: string;
+    expired_amount?: string;
+    rolled_over_amount?: string;
+    voided_amount?: string;
     origin_grant_block_id?: string;
     status: StatusEnum;
     grant_source:
@@ -30,6 +30,8 @@ declare module 'chargebee' {
     created_at: number;
     modified_at: number;
     resource_version?: number;
+    provisioned_block_balance?: GrantBlock.ProvisionedBlockBalance;
+    overdraft_block_balance?: GrantBlock.OverdraftBlockBalance;
     metadata?: any;
   }
 
@@ -46,6 +48,23 @@ declare module 'chargebee' {
       next_offset?: string;
     }
 
+    export interface ProvisionedBlockBalance {
+      granted_amount?: string;
+      total_balance?: string;
+      usable_balance?: string;
+      hold_amount?: string;
+      used_amount?: string;
+      expired_amount?: string;
+      rolled_over_amount?: string;
+      voided_amount?: string;
+    }
+    export interface OverdraftBlockBalance {
+      is_unlimited: boolean;
+      limit?: string;
+      total_balance?: string;
+      usable_balance?: string;
+      used_amount?: string;
+    }
     // REQUEST PARAMS
     //---------------
 

package/types/resources/GroupByAttribute.d.ts

@@ -0,0 +1,15 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface GroupByAttribute {
+    attribute_name: string;
+    rank: number;
+    coverage_percent: number;
+    cardinality: number;
+    remaining_value_count: number;
+    warning: boolean;
+    sample_values?: string[];
+    warning_reasons?: WarningReasonEnum[];
+  }
+}

package/types/resources/GroupByRecommendation.d.ts

@@ -0,0 +1,10 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface GroupByRecommendation {
+    attribute_name: string;
+    rank: number;
+    reason: string;
+  }
+}

package/types/resources/HostedPage.d.ts

@@ -34,6 +34,7 @@ declare module 'chargebee' {
     resource_version?: number;
     checkout_info?: any;
     business_entity_id?: string;
+    brand_id?: string;
   }
 
   export namespace HostedPage {
@@ -293,6 +294,7 @@ declare module 'chargebee' {
     }
     export interface CheckoutOneTimeForItemsInputParam {
       business_entity_id?: string;
+      brand_id?: string;
       layout?: LayoutEnum;
       invoice_note?: string /**
        * @deprecated Please refer API docs to use other attributes
@@ -318,6 +320,7 @@ declare module 'chargebee' {
     export interface CheckoutNewForItemsInputParam {
       layout?: LayoutEnum;
       business_entity_id?: string;
+      brand_id?: string;
       billing_cycles?: number;
       mandatory_items_to_remove?: string[];
       terms_to_charge?: number;
@@ -365,6 +368,7 @@ declare module 'chargebee' {
     }
     export interface CheckoutExistingForItemsInputParam {
       layout?: LayoutEnum;
+      brand_id?: string;
       mandatory_items_to_remove?: string[];
       replace_items_list?: boolean;
       invoice_date?: number;
@@ -412,11 +416,13 @@ declare module 'chargebee' {
     }
     export interface ManagePaymentSourcesInputParam {
       business_entity_id?: string;
+      brand_id?: string;
       redirect_url?: string;
       customer?: CustomerManagePaymentSourcesInputParam;
       card?: CardManagePaymentSourcesInputParam;
     }
     export interface CollectNowInputParam {
+      brand_id?: string;
       redirect_url?: string;
       currency_code?: string;
       payment_method_save_policy?: PaymentMethodSavePolicyEnum;
@@ -424,11 +430,13 @@ declare module 'chargebee' {
       card?: CardCollectNowInputParam;
     }
     export interface AcceptQuoteInputParam {
+      brand_id?: string;
       redirect_url?: string;
       layout?: LayoutEnum;
       quote?: QuoteAcceptQuoteInputParam;
     }
     export interface ExtendSubscriptionInputParam {
+      brand_id?: string;
       expiry?: number;
       billing_cycle?: number;
       subscription?: SubscriptionExtendSubscriptionInputParam;
@@ -443,6 +451,7 @@ declare module 'chargebee' {
     export interface CheckoutGiftForItemsInputParam {
       layout?: LayoutEnum;
       business_entity_id?: string;
+      brand_id?: string;
       redirect_url?: string;
       coupon_ids?: string[];
       gifter?: GifterCheckoutGiftForItemsInputParam;
@@ -450,6 +459,7 @@ declare module 'chargebee' {
       item_tiers?: ItemTiersCheckoutGiftForItemsInputParam[];
     }
     export interface ClaimGiftInputParam {
+      brand_id?: string;
       redirect_url?: string;
       gift?: GiftClaimGiftInputParam;
       customer?: CustomerClaimGiftInputParam;
@@ -466,6 +476,7 @@ declare module 'chargebee' {
       updated_at?: filter.Timestamp;
     }
     export interface PreCancelInputParam {
+      brand_id?: string;
       pass_thru_content?: string;
       cancel_url?: string;
       redirect_url?: string;

package/types/resources/Invoice.d.ts

@@ -64,6 +64,7 @@ declare module 'chargebee' {
     tax_origin?: Invoice.TaxOrigin;
     linked_payments?: Invoice.LinkedPayment[];
     reference_transactions?: Invoice.ReferenceTransaction[];
+    retry_segment_id?: string;
     dunning_attempts?: Invoice.DunningAttempt[];
     applied_credits?: Invoice.AppliedCredit[];
     adjustment_credit_notes?: Invoice.AdjustmentCreditNote[];
@@ -80,6 +81,7 @@ declare module 'chargebee' {
     vat_number_prefix?: string;
     channel?: ChannelEnum;
     business_entity_id?: string;
+    brand_id?: string;
     site_details_at_creation?: Invoice.SiteDetailsAtCreation;
   }
 
@@ -297,6 +299,11 @@ declare module 'chargebee' {
         headers?: ChargebeeRequestHeader,
       ): Promise<ChargebeeResponse<VoidBeforeCaptureResponse>>;
 
+      sendEmail(
+        invoice_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<SendEmailResponse>>;
+
       delete(
         invoice_id: string,
         input?: DeleteInputParam,
@@ -315,6 +322,12 @@ declare module 'chargebee' {
         headers?: ChargebeeRequestHeader,
       ): Promise<ChargebeeResponse<ApplyPaymentScheduleSchemeResponse>>;
 
+      removePaymentScheduleScheme(
+        invoice_id: string,
+        input?: RemovePaymentScheduleSchemeInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RemovePaymentScheduleSchemeResponse>>;
+
       paymentSchedules(
         invoice_id: string,
         headers?: ChargebeeRequestHeader,
@@ -487,6 +500,10 @@ declare module 'chargebee' {
       credit_note?: CreditNote;
     }
 
+    export interface SendEmailResponse {
+      email_logs: EmailLog[];
+    }
+
     export interface DeleteResponse {
       invoice: Invoice;
     }
@@ -499,6 +516,10 @@ declare module 'chargebee' {
       invoice: Invoice;
     }
 
+    export interface RemovePaymentScheduleSchemeResponse {
+      invoice: Invoice;
+    }
+
     export interface PaymentSchedulesResponse {
       payment_schedules: PaymentSchedule[];
     }
@@ -1227,6 +1248,9 @@ declare module 'chargebee' {
       scheme_id: string;
       amount?: number;
     }
+    export interface RemovePaymentScheduleSchemeInputParam {
+      comment?: string;
+    }
     export interface StatementDescriptorCreateInputParam {
       descriptor?: string;
     }
@@ -1333,7 +1357,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1357,7 +1394,7 @@ declare module 'chargebee' {
       expiry_month?: number;
       expiry_year?: number;
       cvv?: string;
-      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa';
+      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa' | 'dankort';
       billing_addr1?: string;
       billing_addr2?: string;
       billing_city?: string;
@@ -1511,7 +1548,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1535,7 +1585,7 @@ declare module 'chargebee' {
       expiry_month?: number;
       expiry_year?: number;
       cvv?: string;
-      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa';
+      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa' | 'dankort';
       billing_addr1?: string;
       billing_addr2?: string;
       billing_city?: string;
@@ -1790,6 +1840,9 @@ declare module 'chargebee' {
       tax9_amount?: number;
       tax10_name?: string;
       tax10_amount?: number;
+      is_partial_tax_applied?: boolean;
+      taxable_amount?: number;
+      tax_exempt_reason?: TaxExemptReasonEnum;
       proration_mode?:
         | 'reset'
         | 'delta'

package/types/resources/ItemPrice.d.ts

@@ -12,6 +12,7 @@ declare module 'chargebee' {
     status?: 'active' | 'archived' | 'deleted';
     external_name?: string;
     price_variant_id?: string;
+    price_ramp_id?: string;
     proration_type?: 'site_default' | 'partial_term' | 'full_term';
     pricing_model: PricingModelEnum;
     price?: number;

package/types/resources/LedgerAccountBalance.d.ts

@@ -19,6 +19,11 @@ declare module 'chargebee' {
         input: ListLedgerAccountBalancesInputParam,
         headers?: ChargebeeRequestHeader,
       ): Promise<ChargebeeResponse<ListLedgerAccountBalancesResponse>>;
+
+      updateOverdraftLimit(
+        input: UpdateOverdraftLimitInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateOverdraftLimitResponse>>;
     }
 
     export interface ListLedgerAccountBalancesResponse {
@@ -26,6 +31,13 @@ declare module 'chargebee' {
       next_offset?: string;
     }
 
+    export interface UpdateOverdraftLimitResponse {
+      subscription_id: string;
+      unit_id: string;
+      change_reason?: string;
+      overdraft_balance: object;
+    }
+
     export interface ProvisionedBalance {
       total_balance: string;
       usable_balance: string;
@@ -48,5 +60,12 @@ declare module 'chargebee' {
       subscription_id: filter.String;
       unit_id?: filter.String;
     }
+    export interface UpdateOverdraftLimitInputParam {
+      subscription_id: string;
+      unit_id: string;
+      is_unlimited: boolean;
+      limit?: string;
+      change_reason?: string;
+    }
   }
 }

package/types/resources/LedgerEntry.d.ts

@@ -4,10 +4,10 @@
 declare module 'chargebee' {
   export interface LedgerEntry {
     id: string;
-    subscription_id?: string;
-    account_type?: 'provisioned' | 'overdraft';
-    unit_id?: string;
-    unit_type?: 'credit_unit';
+    subscription_id: string;
+    unit_id: string;
+    unit_type: 'credit_unit';
+    account_type: 'provisioned' | 'overdraft';
     amount: string;
     grant_block_start_balance: string;
     grant_block_end_balance: string;