chargebee 3.33.0 → 3.35.0

package/types/resources/Purchase.d.ts

@@ -129,7 +129,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
@@ -143,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 {
@@ -152,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;
@@ -218,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;
@@ -226,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/QuotedSubscription.d.ts

@@ -94,6 +94,7 @@ declare module 'chargebee' {
       usage_accumulation_reset_frequency?:
         | 'never'
         | 'subscription_billing_frequency';
+      description?: string;
     }
     export interface ItemTier {
       item_price_id: string;

package/types/resources/Ramp.d.ts

@@ -20,6 +20,7 @@ declare module 'chargebee' {
     coupons_to_remove?: string[];
     discounts_to_remove?: string[];
     contract_term?: Ramp.ContractTerm;
+    billing_configuration?: Ramp.BillingConfiguration;
     deleted: boolean;
     status_transition_reason?: Ramp.StatusTransitionReason;
   }
@@ -91,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'
@@ -113,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'
@@ -155,6 +158,9 @@ declare module 'chargebee' {
       renewal_billing_cycles?: number;
       action_at_term_end: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
     }
+    export interface BillingConfiguration {
+      po_number?: string;
+    }
     export interface StatusTransitionReason {
       code?: string;
       message?: string;
@@ -168,6 +174,7 @@ declare module 'chargebee' {
       coupons_to_remove?: string[];
       discounts_to_remove?: string[];
       items_to_remove?: string[];
+      billing_configuration?: BillingConfigurationCreateForSubscriptionInputParam;
       contract_term?: ContractTermCreateForSubscriptionInputParam;
       items_to_add?: ItemsToAddCreateForSubscriptionInputParam[];
       items_to_update?: ItemsToUpdateCreateForSubscriptionInputParam[];
@@ -181,6 +188,7 @@ declare module 'chargebee' {
       coupons_to_remove?: string[];
       discounts_to_remove?: string[];
       items_to_remove?: string[];
+      billing_configuration?: BillingConfigurationUpdateInputParam;
       contract_term?: ContractTermUpdateInputParam;
       items_to_add?: ItemsToAddUpdateInputParam[];
       items_to_update?: ItemsToUpdateUpdateInputParam[];
@@ -199,6 +207,9 @@ declare module 'chargebee' {
       'sort_by[asc]'?: string;
       'sort_by[desc]'?: string;
     }
+    export interface BillingConfigurationCreateForSubscriptionInputParam {
+      po_number?: string;
+    }
     export interface ContractTermCreateForSubscriptionInputParam {
       action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
       cancellation_cutoff_period?: number;
@@ -216,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;
@@ -243,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;
@@ -255,6 +268,9 @@ declare module 'chargebee' {
       included_in_mrr?: boolean;
       item_price_id?: string;
     }
+    export interface BillingConfigurationUpdateInputParam {
+      po_number?: string;
+    }
     export interface ContractTermUpdateInputParam {
       action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
       cancellation_cutoff_period?: number;
@@ -272,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;
@@ -299,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;

package/types/resources/RetrySegment.d.ts

@@ -0,0 +1,36 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface RetrySegment {
+    id: string;
+    name?: string;
+    invoice_id?: string;
+    enabled: boolean;
+    priority?: number;
+    condition_logic?: 'and' | 'or';
+    criteria?: any;
+    retry_settings?: any;
+  }
+
+  export namespace RetrySegment {
+    export class RetrySegmentResource {
+      retrieve(
+        retry_segment_id: string,
+        input?: RetrieveInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+    }
+
+    export interface RetrieveResponse {
+      retry_segment: RetrySegment;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface RetrieveInputParam {
+      invoice_id?: string;
+    }
+  }
+}

package/types/resources/Subscription.d.ts

@@ -97,6 +97,7 @@ declare module 'chargebee' {
     discounts?: Subscription.Discount[];
     business_entity_id?: string;
     decommissioned: boolean;
+    brand_id?: string;
   }
 
   export namespace Subscription {
@@ -586,6 +587,7 @@ declare module 'chargebee' {
       usage_accumulation_reset_frequency?:
         | 'never'
         | 'subscription_billing_frequency';
+      description?: string;
     }
     export interface ItemTier {
       item_price_id: string;
@@ -715,6 +717,7 @@ declare module 'chargebee' {
 
     export interface CreateInputParam {
       id?: string;
+      brand_id?: string;
       plan_id?: string;
       plan_quantity?: number;
       plan_quantity_in_decimal?: string;
@@ -769,6 +772,7 @@ declare module 'chargebee' {
     }
     export interface CreateForCustomerInputParam {
       id?: string;
+      brand_id?: string;
       plan_id?: string;
       plan_quantity?: number;
       plan_quantity_in_decimal?: string;
@@ -813,6 +817,7 @@ declare module 'chargebee' {
     export interface CreateWithItemsInputParam {
       id?: string;
       business_entity_id?: string;
+      brand_id?: string;
       trial_end?: number;
       billing_cycles?: number /**
        * @deprecated Please refer API docs to use other attributes
@@ -1440,7 +1445,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
@@ -1464,7 +1482,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;
@@ -1599,7 +1617,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
@@ -1725,7 +1756,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
@@ -1749,6 +1793,7 @@ declare module 'chargebee' {
        * @deprecated Please refer API docs to use other attributes
        */
       item_type?: ItemTypeEnum;
+      description?: string;
       charge_on_option?: ChargeOnOptionEnum;
       usage_accumulation_reset_frequency?: UsageAccumulationResetFrequencyEnum;
     }
@@ -1906,7 +1951,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
@@ -1930,7 +1988,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;
@@ -2101,7 +2159,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
@@ -2125,7 +2196,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;
@@ -2156,6 +2227,7 @@ declare module 'chargebee' {
        * @deprecated Please refer API docs to use other attributes
        */
       item_type?: ItemTypeEnum;
+      description?: string;
       proration_type?: ProrationTypeEnum;
       usage_accumulation_reset_frequency?: UsageAccumulationResetFrequencyEnum;
     }
@@ -2252,7 +2324,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
@@ -2385,7 +2470,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;
@@ -2602,6 +2687,7 @@ declare module 'chargebee' {
        * @deprecated Please refer API docs to use other attributes
        */
       item_type?: ItemTypeEnum;
+      description?: string;
     }
     export interface DiscountsImportForItemsInputParam {
       apply_on?: ApplyOnEnum;
@@ -2709,7 +2795,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/ThirdPartyPaymentMethod.d.ts

@@ -7,5 +7,6 @@ declare module 'chargebee' {
     gateway: GatewayEnum;
     gateway_account_id?: string;
     reference_id: string;
+    network_transaction_reference?: any;
   }
 }

package/types/resources/Transaction.d.ts

@@ -57,8 +57,10 @@ declare module 'chargebee' {
     merchant_reference_id?: string;
     business_entity_id?: string;
     payment_method_details?: string;
+    gateway_metadata?: Transaction.GatewayMetadata;
     error_detail?: Transaction.GatewayErrorDetail;
     custom_payment_method_name?: string;
+    network_transaction_details?: Transaction.NetworkTransactionDetail;
   }
 
   export namespace Transaction {
@@ -245,6 +247,9 @@ declare module 'chargebee' {
       amount?: number;
       date?: number;
     }
+    export interface GatewayMetadata {
+      acquirer_reference_id?: string;
+    }
     export interface GatewayErrorDetail {
       request_id?: string;
       error_category?: string;
@@ -262,6 +267,10 @@ declare module 'chargebee' {
       error_cause_id?: string;
       processor_advice_code?: string;
     }
+    export interface NetworkTransactionDetail {
+      network_transaction_id?: string;
+      original_network_transaction_id?: string;
+    }
     // REQUEST PARAMS
     //---------------
 

package/types/resources/Usage.d.ts

@@ -105,9 +105,15 @@ declare module 'chargebee' {
     export interface PdfInputParam {
       disposition_type?: DispositionTypeEnum;
       invoice?: InvoicePdfInputParam;
+      group_by?: GroupByPdfInputParam[];
     }
     export interface InvoicePdfInputParam {
       id: string;
     }
+
+    export interface GroupByPdfInputParam {
+      feature_id?: string;
+      attributes?: any;
+    }
   }
 }

package/types/resources/UsageSummary.d.ts

@@ -8,6 +8,7 @@ declare module 'chargebee' {
     aggregated_value: string;
     aggregated_from: number;
     aggregated_to: number;
+    attributes?: any;
   }
 
   export namespace UsageSummary {
@@ -36,6 +37,7 @@ declare module 'chargebee' {
       window_size?: 'month' | 'week' | 'day' | 'hour' | 'minute';
       timeframe_start?: number;
       timeframe_end?: number;
+      group_by?: string[];
     }
   }
 }