chargebee 3.34.0 → 3.36.0

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

@@ -329,6 +329,7 @@ declare module 'chargebee' {
       redirect_url?: string;
       cancel_url?: string;
       pass_thru_content?: string;
+      show_billing_frequency_selector?: boolean;
       allow_offline_payment_methods?: boolean;
       subscription?: SubscriptionCheckoutNewForItemsInputParam;
       customer?: CustomerCheckoutNewForItemsInputParam;
@@ -340,6 +341,7 @@ declare module 'chargebee' {
       discounts?: DiscountsCheckoutNewForItemsInputParam[];
       item_tiers?: ItemTiersCheckoutNewForItemsInputParam[];
       entity_identifiers?: EntityIdentifiersCheckoutNewForItemsInputParam[];
+      allowed_billing_frequencies?: AllowedBillingFrequenciesCheckoutNewForItemsInputParam[];
     }
     export interface CheckoutExistingInputParam {
       replace_addon_list?: boolean;
@@ -386,6 +388,7 @@ declare module 'chargebee' {
       redirect_url?: string;
       cancel_url?: string;
       pass_thru_content?: string;
+      show_billing_frequency_selector?: boolean;
       allow_offline_payment_methods?: boolean;
       subscription?: SubscriptionCheckoutExistingForItemsInputParam;
       customer?: CustomerCheckoutExistingForItemsInputParam;
@@ -395,6 +398,7 @@ declare module 'chargebee' {
       discounts?: DiscountsCheckoutExistingForItemsInputParam[];
       item_tiers?: ItemTiersCheckoutExistingForItemsInputParam[];
       entity_identifiers?: EntityIdentifiersCheckoutExistingForItemsInputParam[];
+      allowed_billing_frequencies?: AllowedBillingFrequenciesCheckoutExistingForItemsInputParam[];
     }
     export interface UpdateCardInputParam {
       redirect_url?: string;
@@ -454,9 +458,11 @@ declare module 'chargebee' {
       brand_id?: string;
       redirect_url?: string;
       coupon_ids?: string[];
+      show_billing_frequency_selector?: boolean;
       gifter?: GifterCheckoutGiftForItemsInputParam;
       subscription_items?: SubscriptionItemsCheckoutGiftForItemsInputParam[];
       item_tiers?: ItemTiersCheckoutGiftForItemsInputParam[];
+      allowed_billing_frequencies?: AllowedBillingFrequenciesCheckoutGiftForItemsInputParam[];
     }
     export interface ClaimGiftInputParam {
       brand_id?: string;
@@ -869,6 +875,10 @@ declare module 'chargebee' {
       item_type?: ItemTypeEnum;
       charge_on_option?: ChargeOnOptionEnum;
     }
+    export interface AllowedBillingFrequenciesCheckoutNewForItemsInputParam {
+      period?: number;
+      period_unit?: PeriodUnitEnum;
+    }
     export interface DiscountsCheckoutNewForItemsInputParam {
       apply_on?: ApplyOnEnum;
       duration_type: DurationTypeEnum;
@@ -1005,6 +1015,10 @@ declare module 'chargebee' {
        */
       item_type?: ItemTypeEnum;
     }
+    export interface AllowedBillingFrequenciesCheckoutExistingForItemsInputParam {
+      period?: number;
+      period_unit?: PeriodUnitEnum;
+    }
     export interface DiscountsCheckoutExistingForItemsInputParam {
       apply_on?: ApplyOnEnum;
       duration_type: DurationTypeEnum;
@@ -1133,6 +1147,10 @@ declare module 'chargebee' {
       unit_price?: number;
       unit_price_in_decimal?: string;
     }
+    export interface AllowedBillingFrequenciesCheckoutGiftForItemsInputParam {
+      period?: number;
+      period_unit?: PeriodUnitEnum;
+    }
     export interface ItemTiersCheckoutGiftForItemsInputParam {
       item_price_id?: string;
       starting_unit?: number;

package/types/resources/Invoice.d.ts

@@ -47,6 +47,7 @@ declare module 'chargebee' {
     first_invoice?: boolean;
     new_sales_amount?: number;
     has_advance_charges?: boolean;
+    offline_payment_method?: OfflinePaymentMethodEnum;
     term_finalized: boolean;
     is_gifted: boolean;
     generated_at?: number;
@@ -64,6 +65,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[];
@@ -321,6 +323,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,
@@ -509,6 +517,10 @@ declare module 'chargebee' {
       invoice: Invoice;
     }
 
+    export interface RemovePaymentScheduleSchemeResponse {
+      invoice: Invoice;
+    }
+
     export interface PaymentSchedulesResponse {
       payment_schedules: PaymentSchedule[];
     }
@@ -945,6 +957,7 @@ declare module 'chargebee' {
       payment_source_id?: string;
       auto_collection?: AutoCollectionEnum;
       net_term_days?: number;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       invoice_date?: number;
       create_pending_invoice?: boolean;
       token_id?: string;
@@ -1237,6 +1250,9 @@ declare module 'chargebee' {
       scheme_id: string;
       amount?: number;
     }
+    export interface RemovePaymentScheduleSchemeInputParam {
+      comment?: string;
+    }
     export interface StatementDescriptorCreateInputParam {
       descriptor?: string;
     }
@@ -1828,6 +1844,7 @@ declare module 'chargebee' {
       tax10_amount?: number;
       is_partial_tax_applied?: boolean;
       taxable_amount?: number;
+      tax_exempt_reason?: TaxExemptReasonEnum;
       proration_mode?:
         | 'reset'
         | 'delta'
@@ -1844,6 +1861,8 @@ declare module 'chargebee' {
     }
     export interface CreditNotesApplyCreditsInputParam {
       id?: string;
+      amount?: number;
+      applied_at?: number;
     }
     export interface EinvoiceInvoiceListInputParam {
       status?: filter.Enum;

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/Meter.d.ts

@@ -13,6 +13,7 @@ declare module 'chargebee' {
     updated_at?: number;
     column_definitions?: ColumnDefinition[];
     features?: Feature[];
+    group_by?: string[];
   }
 
   export namespace Meter {

package/types/resources/MeteredFeature.d.ts

@@ -10,6 +10,7 @@ declare module 'chargebee' {
     status?: StatusEnum;
     query?: string;
     column_definitions?: ColumnDefinition[];
+    group_by?: string[];
     features?: Feature[];
   }
 

package/types/resources/OmnichannelOneTimeOrder.d.ts

@@ -8,7 +8,11 @@ declare module 'chargebee' {
     customer_id?: string;
     id_at_source: string;
     origin?: string;
-    source: 'apple_app_store' | 'google_play_store';
+    source:
+      | 'apple_app_store'
+      | 'google_play_store'
+      | 'roku'
+      | 'amazon_app_store';
     created_at: number;
     resource_version?: number;
     omnichannel_one_time_order_items: OmnichannelOneTimeOrderItem[];

package/types/resources/OmnichannelSubscription.d.ts

@@ -6,8 +6,13 @@ declare module 'chargebee' {
     id: string;
     id_at_source: string;
     app_id: string;
-    source: 'apple_app_store' | 'google_play_store';
+    source:
+      | 'apple_app_store'
+      | 'google_play_store'
+      | 'roku'
+      | 'amazon_app_store';
     customer_id?: string;
+    origin?: string;
     created_at: number;
     purchased_at?: number;
     updated_at: number;

package/types/resources/OmnichannelSubscriptionItem.d.ts

@@ -22,13 +22,16 @@ declare module 'chargebee' {
       | 'product_not_available'
       | 'other'
       | 'subscription_not_found_in_source';
+    expiration_reason_at_source?: string;
     cancelled_at?: number;
     cancellation_reason?:
       | 'customer_cancelled'
       | 'customer_did_not_consent_to_price_increase'
       | 'refunded_due_to_app_issue'
       | 'refunded_for_other_reason'
-      | 'merchant_revoked';
+      | 'merchant_revoked'
+      | 'other';
+    cancellation_reason_at_source?: string;
     grace_period_expires_at?: number;
     resumes_at?: number;
     has_scheduled_changes: boolean;

package/types/resources/OrganizationDetail.d.ts

@@ -0,0 +1,84 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface OrganizationDetail {
+    id: string;
+    organization_name?: string;
+    email?: string;
+    address_line1?: string;
+    address_line2?: string;
+    address_line3?: string;
+    city?: string;
+    state_code?: string;
+    state?: string;
+    country_code?: string;
+    zip?: string;
+    phone?: string;
+    fax?: string;
+    website?: string;
+    is_vat_number_present?: boolean;
+    vat_number?: string;
+    resource_version?: number;
+    updated_at?: number;
+    business_entity_id?: string;
+  }
+
+  export namespace OrganizationDetail {
+    export class OrganizationDetailResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      retrieve(
+        organization_detail_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+    }
+
+    export interface CreateResponse {
+      organization_detail: OrganizationDetail;
+    }
+
+    export interface RetrieveResponse {
+      organization_detail: OrganizationDetail;
+    }
+
+    export interface ListResponse {
+      list: { organization_detail: OrganizationDetail }[];
+      next_offset?: string;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      organization_name: string;
+      email?: string;
+      address_line1: string;
+      address_line2?: string;
+      address_line3?: string;
+      city: string;
+      state_code?: string;
+      state: string;
+      zip: string;
+      country_code?: string;
+      phone: string;
+      fax?: string;
+      website?: string;
+      is_vat_number_present?: boolean;
+      vat_number?: string;
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      business_entity_id?: filter.String;
+    }
+  }
+}

package/types/resources/PaymentSchedule.d.ts

@@ -34,7 +34,7 @@ declare module 'chargebee' {
       date: number;
       amount: number;
       scheduled_amount: number;
-      status: 'posted' | 'payment_due' | 'paid';
+      status: 'posted' | 'payment_due' | 'paid' | 'voided';
     }
     export interface ReferenceTransaction {
       schedule_entry_id: string;

package/types/resources/PaymentScheduleEstimate.d.ts

@@ -18,7 +18,7 @@ declare module 'chargebee' {
       date: number;
       amount: number;
       scheduled_amount: number;
-      status: 'posted' | 'payment_due' | 'paid';
+      status: 'posted' | 'payment_due' | 'paid' | 'voided';
     }
     // REQUEST PARAMS
     //---------------

package/types/resources/PaymentSource.d.ts

@@ -318,6 +318,7 @@ declare module 'chargebee' {
     }
     export interface NetworkTransactionReference {
       original_network_transaction_id?: string;
+      transaction_link_id?: string;
     }
     // REQUEST PARAMS
     //---------------
@@ -347,6 +348,7 @@ declare module 'chargebee' {
       skip_retrieval?: boolean;
       additional_information?: any;
       card?: CardCreateUsingPermanentTokenInputParam;
+      bank_account?: BankAccountCreateUsingPermanentTokenInputParam;
       billing_address?: BillingAddressCreateUsingPermanentTokenInputParam;
     }
     export interface CreateUsingTokenInputParam {
@@ -429,6 +431,23 @@ declare module 'chargebee' {
       zip?: string;
       country?: string;
     }
+    export interface BankAccountCreateUsingPermanentTokenInputParam {
+      account_type?: AccountTypeEnum;
+      account_holder_type?: AccountHolderTypeEnum;
+      first_name?: string;
+      last_name?: string;
+      company?: string;
+      scheme?:
+        | 'ach'
+        | 'bacs'
+        | 'sepa_core'
+        | 'autogiro'
+        | 'becs'
+        | 'becs_nz'
+        | 'pad';
+      last4?: string;
+      echeck_type?: EcheckTypeEnum;
+    }
     export interface CardCreateUsingPermanentTokenInputParam {
       last4?: string;
       iin?: string;

package/types/resources/PreferenceVariant.d.ts

@@ -0,0 +1,10 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface PreferenceVariant {
+    value: string;
+    allow_override_in_interface?: boolean;
+    allow_override_in_api?: boolean;
+  }
+}

package/types/resources/PriceRamp.d.ts

@@ -0,0 +1,113 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface PriceRamp {
+    id: string;
+    item_price_id: string;
+    status: 'active' | 'archived' | 'deleted';
+    created_at: number;
+    resource_version?: number;
+    updated_at?: number;
+    archived_at?: number;
+    ramp_intervals?: PriceRamp.RampInterval[];
+    business_entity_id?: string;
+  }
+
+  export namespace PriceRamp {
+    export class PriceRampResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      retrieve(
+        price_ramp_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      update(
+        price_ramp_id: string,
+        input: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      delete(
+        price_ramp_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+    }
+
+    export interface CreateResponse {
+      price_ramp: PriceRamp;
+    }
+
+    export interface RetrieveResponse {
+      price_ramp: PriceRamp;
+    }
+
+    export interface UpdateResponse {
+      price_ramp: PriceRamp;
+    }
+
+    export interface DeleteResponse {
+      price_ramp: PriceRamp;
+    }
+
+    export interface ListResponse {
+      list: { price_ramp: PriceRamp }[];
+      next_offset?: string;
+    }
+
+    export interface RampInterval {
+      starting_billing_cycle: number;
+      ending_billing_cycle?: number;
+      apply_catalog_price?: boolean;
+      price?: number;
+      price_in_decimal?: string;
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      item_price_id: string;
+      business_entity_id?: string;
+      ramp_intervals?: RampIntervalsCreateInputParam[];
+    }
+    export interface UpdateInputParam {
+      status?: 'active' | 'archived';
+      ramp_intervals?: RampIntervalsUpdateInputParam[];
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      id?: filter.String;
+      item_price_id?: filter.String;
+      status?: filter.Enum;
+      updated_at?: filter.Timestamp;
+      business_entity_id?: filter.String;
+      include_site_level_resources?: filter.Boolean;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
+    }
+    export interface RampIntervalsCreateInputParam {
+      starting_billing_cycle: number;
+      ending_billing_cycle?: number;
+      apply_catalog_price?: boolean;
+      price?: number;
+      price_in_decimal?: string;
+    }
+    export interface RampIntervalsUpdateInputParam {
+      starting_billing_cycle: number;
+      ending_billing_cycle?: number;
+      apply_catalog_price?: boolean;
+      price?: number;
+      price_in_decimal?: string;
+    }
+  }
+}

package/types/resources/PrivateNote.d.ts

@@ -0,0 +1,18 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface PrivateNote {
+    id: string;
+    email_conversation_id: string;
+    author_type?: 'site_user' | 'agent' | 'other';
+    author_id?: string;
+    author_name?: string;
+    content_html: string;
+    content_text?: string;
+    meta_data?: string;
+    created_at: number;
+    resource_version?: number;
+    updated_at: number;
+  }
+}

package/types/resources/Purchase.d.ts

@@ -156,6 +156,8 @@ declare module 'chargebee' {
       subscription_id?: string;
       billing_cycles?: number;
       contract_term_billing_cycle_on_renewal?: number;
+      trial_end?: number;
+      start_date?: number;
       meta_data?: any;
     }
     export interface PurchaseItemsCreateInputParam {
@@ -165,6 +167,7 @@ declare module 'chargebee' {
       unit_amount?: number;
       unit_amount_in_decimal?: string;
       quantity_in_decimal?: string;
+      trial_end?: number;
     }
     export interface DiscountsCreateInputParam {
       index?: number;
@@ -231,6 +234,8 @@ declare module 'chargebee' {
       subscription_id?: string;
       billing_cycles?: number;
       contract_term_billing_cycle_on_renewal?: number;
+      trial_end?: number;
+      start_date?: number;
     }
     export interface PurchaseItemsEstimateInputParam {
       index: number;
@@ -239,6 +244,7 @@ declare module 'chargebee' {
       unit_amount?: number;
       unit_amount_in_decimal?: string;
       quantity_in_decimal?: string;
+      trial_end?: number;
     }
     export interface DiscountsEstimateInputParam {
       index?: number;

package/types/resources/Ramp.d.ts

@@ -92,6 +92,7 @@ declare module 'chargebee' {
       metered_quantity?: string;
       charge_once?: boolean;
       charge_on_option?: 'immediately' | 'on_event';
+      description?: string;
       charge_on_event?:
         | 'subscription_trial_start'
         | 'plan_activation'
@@ -114,6 +115,7 @@ declare module 'chargebee' {
       metered_quantity?: string;
       charge_once?: boolean;
       charge_on_option?: 'immediately' | 'on_event';
+      description?: string;
       charge_on_event?:
         | 'subscription_trial_start'
         | 'plan_activation'
@@ -225,6 +227,7 @@ declare module 'chargebee' {
       charge_on_event?: ChargeOnEventEnum;
       charge_once?: boolean;
       charge_on_option?: ChargeOnOptionEnum;
+      description?: string;
     }
     export interface CouponsToAddCreateForSubscriptionInputParam {
       coupon_id?: string;
@@ -252,6 +255,7 @@ declare module 'chargebee' {
       charge_on_event?: ChargeOnEventEnum;
       charge_once?: boolean;
       charge_on_option?: ChargeOnOptionEnum;
+      description?: string;
     }
     export interface DiscountsToAddCreateForSubscriptionInputParam {
       apply_on: ApplyOnEnum;
@@ -284,6 +288,7 @@ declare module 'chargebee' {
       charge_on_event?: ChargeOnEventEnum;
       charge_once?: boolean;
       charge_on_option?: ChargeOnOptionEnum;
+      description?: string;
     }
     export interface CouponsToAddUpdateInputParam {
       coupon_id?: string;
@@ -311,6 +316,7 @@ declare module 'chargebee' {
       charge_on_event?: ChargeOnEventEnum;
       charge_once?: boolean;
       charge_on_option?: ChargeOnOptionEnum;
+      description?: string;
     }
     export interface DiscountsToAddUpdateInputParam {
       apply_on: ApplyOnEnum;

package/types/resources/RampInterval.d.ts

@@ -0,0 +1,12 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface RampInterval {
+    starting_billing_cycle: number;
+    ending_billing_cycle?: number;
+    apply_catalog_price?: boolean;
+    price?: number;
+    price_in_decimal?: string;
+  }
+}

package/types/resources/RecordedPurchase.d.ts

@@ -6,7 +6,11 @@ declare module 'chargebee' {
     id: string;
     customer_id: string;
     app_id: string;
-    source: 'apple_app_store' | 'google_play_store';
+    source:
+      | 'apple_app_store'
+      | 'google_play_store'
+      | 'roku'
+      | 'amazon_app_store';
     status: 'in_process' | 'completed' | 'failed' | 'ignored';
     omnichannel_transaction_id?: string;
     created_at: number;