chargebee 3.0.0-beta.3 → 3.0.0-beta.5

package/types/resources/Quote.d.ts

@@ -15,7 +15,7 @@ declare module 'chargebee' {
       | 'change_subscription'
       | 'onetime_invoice';
     vat_number?: string;
-    price_type: PriceType;
+    price_type: PriceTypeEnum;
     valid_till: number;
     date: number;
     total_payable?: number;
@@ -403,7 +403,7 @@ declare module 'chargebee' {
       state?: string;
       country?: string;
       zip?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
       index: number;
     }
     export interface BillingAddress {
@@ -420,7 +420,7 @@ declare module 'chargebee' {
       state?: string;
       country?: string;
       zip?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     // REQUEST PARAMS
     //---------------
@@ -432,7 +432,7 @@ declare module 'chargebee' {
       billing_cycles?: number;
       mandatory_addons_to_remove?: string[];
       terms_to_charge?: number;
-      billing_alignment_mode?: BillingAlignmentMode;
+      billing_alignment_mode?: BillingAlignmentModeEnum;
       coupon_ids?: string[];
       subscription?: SubscriptionCreateSubForCustomerQuoteInputParam;
       shipping_address?: ShippingAddressCreateSubForCustomerQuoteInputParam;
@@ -446,7 +446,7 @@ declare module 'chargebee' {
       billing_cycles?: number;
       mandatory_addons_to_remove?: string[];
       terms_to_charge?: number;
-      billing_alignment_mode?: BillingAlignmentMode;
+      billing_alignment_mode?: BillingAlignmentModeEnum;
       coupon_ids?: string[];
       subscription?: SubscriptionEditCreateSubForCustomerQuoteInputParam;
       shipping_address?: ShippingAddressEditCreateSubForCustomerQuoteInputParam;
@@ -463,10 +463,10 @@ declare module 'chargebee' {
       billing_cycles?: number;
       terms_to_charge?: number;
       reactivate_from?: number;
-      billing_alignment_mode?: BillingAlignmentMode;
+      billing_alignment_mode?: BillingAlignmentModeEnum;
       coupon_ids?: string[];
       replace_coupon_list?: boolean;
-      change_option?: ChangeOption;
+      change_option?: ChangeOptionEnum;
       changes_scheduled_at?: number;
       force_term_reset?: boolean;
       reactivate?: boolean;
@@ -486,10 +486,10 @@ declare module 'chargebee' {
       billing_cycles?: number;
       terms_to_charge?: number;
       reactivate_from?: number;
-      billing_alignment_mode?: BillingAlignmentMode;
+      billing_alignment_mode?: BillingAlignmentModeEnum;
       coupon_ids?: string[];
       replace_coupon_list?: boolean;
-      change_option?: ChangeOption;
+      change_option?: ChangeOptionEnum;
       changes_scheduled_at?: number;
       force_term_reset?: boolean;
       reactivate?: boolean;
@@ -534,7 +534,7 @@ declare module 'chargebee' {
       billing_cycles?: number;
       mandatory_items_to_remove?: string[];
       terms_to_charge?: number;
-      billing_alignment_mode?: BillingAlignmentMode;
+      billing_alignment_mode?: BillingAlignmentModeEnum;
       coupon_ids?: string[];
       subscription?: SubscriptionCreateSubItemsForCustomerQuoteInputParam;
       shipping_address?: ShippingAddressCreateSubItemsForCustomerQuoteInputParam;
@@ -549,7 +549,7 @@ declare module 'chargebee' {
       billing_cycles?: number;
       mandatory_items_to_remove?: string[];
       terms_to_charge?: number;
-      billing_alignment_mode?: BillingAlignmentMode;
+      billing_alignment_mode?: BillingAlignmentModeEnum;
       coupon_ids?: string[];
       subscription?: SubscriptionEditCreateSubCustomerQuoteForItemsInputParam;
       shipping_address?: ShippingAddressEditCreateSubCustomerQuoteForItemsInputParam;
@@ -567,10 +567,10 @@ declare module 'chargebee' {
       billing_cycles?: number;
       terms_to_charge?: number;
       reactivate_from?: number;
-      billing_alignment_mode?: BillingAlignmentMode;
+      billing_alignment_mode?: BillingAlignmentModeEnum;
       coupon_ids?: string[];
       replace_coupon_list?: boolean;
-      change_option?: ChangeOption;
+      change_option?: ChangeOptionEnum;
       changes_scheduled_at?: number;
       force_term_reset?: boolean;
       reactivate?: boolean;
@@ -591,10 +591,10 @@ declare module 'chargebee' {
       billing_cycles?: number;
       terms_to_charge?: number;
       reactivate_from?: number;
-      billing_alignment_mode?: BillingAlignmentMode;
+      billing_alignment_mode?: BillingAlignmentModeEnum;
       coupon_ids?: string[];
       replace_coupon_list?: boolean;
-      change_option?: ChangeOption;
+      change_option?: ChangeOptionEnum;
       changes_scheduled_at?: number;
       force_term_reset?: boolean;
       reactivate?: boolean;
@@ -656,6 +656,7 @@ declare module 'chargebee' {
     }
     export interface ConvertInputParam {
       invoice_date?: number;
+      invoice_immediately?: boolean;
       create_pending_invoices?: boolean;
       first_invoice_pending?: boolean;
       subscription?: SubscriptionConvertInputParam;
@@ -672,7 +673,7 @@ declare module 'chargebee' {
     }
     export interface PdfInputParam {
       consolidated_view?: boolean;
-      disposition_type?: DispositionType;
+      disposition_type?: DispositionTypeEnum;
     }
     export interface ShippingAddressCreateSubForCustomerQuoteInputParam {
       first_name?: string;
@@ -688,7 +689,7 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface ContractTermCreateSubForCustomerQuoteInputParam {
       action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
@@ -705,7 +706,7 @@ declare module 'chargebee' {
       setup_fee?: number;
       trial_end?: number;
       start_date?: number;
-      offline_payment_method?: OfflinePaymentMethod;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       contract_term_billing_cycle_on_renewal?: number;
     }
 
@@ -716,9 +717,9 @@ declare module 'chargebee' {
       quantity_in_decimal?: string;
       unit_price_in_decimal?: string;
       service_period_in_days?: number;
-      on_event?: OnEvent;
+      on_event?: OnEventEnum;
       charge_once?: boolean;
-      charge_on?: ChargeOn;
+      charge_on?: ChargeOnEnum;
     }
     export interface AddonsCreateSubForCustomerQuoteInputParam {
       id?: string;
@@ -743,7 +744,7 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface ContractTermEditCreateSubForCustomerQuoteInputParam {
       action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
@@ -760,7 +761,7 @@ declare module 'chargebee' {
       setup_fee?: number;
       trial_end?: number;
       start_date?: number;
-      offline_payment_method?: OfflinePaymentMethod;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       contract_term_billing_cycle_on_renewal?: number;
     }
 
@@ -771,9 +772,9 @@ declare module 'chargebee' {
       quantity_in_decimal?: string;
       unit_price_in_decimal?: string;
       service_period_in_days?: number;
-      on_event?: OnEvent;
+      on_event?: OnEventEnum;
       charge_once?: boolean;
-      charge_on?: ChargeOn;
+      charge_on?: ChargeOnEnum;
     }
     export interface AddonsEditCreateSubForCustomerQuoteInputParam {
       id?: string;
@@ -798,7 +799,7 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface CustomerUpdateSubscriptionQuoteInputParam {
       vat_number?: string;
@@ -819,7 +820,7 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface ContractTermUpdateSubscriptionQuoteInputParam {
       action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
@@ -839,8 +840,8 @@ declare module 'chargebee' {
        * @deprecated Please refer API docs to use other attributes
        */
       coupon?: string;
-      auto_collection?: AutoCollection;
-      offline_payment_method?: OfflinePaymentMethod;
+      auto_collection?: AutoCollectionEnum;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       contract_term_billing_cycle_on_renewal?: number;
     }
 
@@ -849,8 +850,8 @@ declare module 'chargebee' {
       quantity?: number;
       unit_price?: number;
       service_period_in_days?: number;
-      charge_on?: ChargeOn;
-      on_event?: OnEvent;
+      charge_on?: ChargeOnEnum;
+      on_event?: OnEventEnum;
       charge_once?: boolean;
       quantity_in_decimal?: string;
       unit_price_in_decimal?: string;
@@ -878,7 +879,7 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface CustomerEditUpdateSubscriptionQuoteInputParam {
       vat_number?: string;
@@ -899,7 +900,7 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface ContractTermEditUpdateSubscriptionQuoteInputParam {
       action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
@@ -918,8 +919,8 @@ declare module 'chargebee' {
        * @deprecated Please refer API docs to use other attributes
        */
       coupon?: string;
-      auto_collection?: AutoCollection;
-      offline_payment_method?: OfflinePaymentMethod;
+      auto_collection?: AutoCollectionEnum;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       contract_term_billing_cycle_on_renewal?: number;
     }
 
@@ -928,8 +929,8 @@ declare module 'chargebee' {
       quantity?: number;
       unit_price?: number;
       service_period_in_days?: number;
-      charge_on?: ChargeOn;
-      on_event?: OnEvent;
+      charge_on?: ChargeOnEnum;
+      on_event?: OnEventEnum;
       charge_once?: boolean;
       quantity_in_decimal?: string;
       unit_price_in_decimal?: string;
@@ -957,14 +958,14 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
 
     export interface ChargesCreateForOnetimeChargesInputParam {
       amount?: number;
       amount_in_decimal?: string;
       description?: string;
-      avalara_sale_type?: AvalaraSaleType;
+      avalara_sale_type?: AvalaraSaleTypeEnum;
       avalara_transaction_type?: number;
       avalara_service_type?: number;
       service_period?: number;
@@ -996,14 +997,14 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
 
     export interface ChargesEditOneTimeQuoteInputParam {
       amount?: number;
       amount_in_decimal?: string;
       description?: string;
-      avalara_sale_type?: AvalaraSaleType;
+      avalara_sale_type?: AvalaraSaleTypeEnum;
       avalara_transaction_type?: number;
       avalara_service_type?: number;
       service_period?: number;
@@ -1035,7 +1036,7 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface ContractTermCreateSubItemsForCustomerQuoteInputParam {
       action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
@@ -1062,21 +1063,21 @@ declare module 'chargebee' {
       billing_cycles?: number;
       trial_end?: number;
       service_period_days?: number;
-      charge_on_event?: ChargeOnEvent;
+      charge_on_event?: ChargeOnEventEnum;
       charge_once?: boolean;
       /**
        * @deprecated Please refer API docs to use other attributes
        */
-      item_type?: ItemType;
-      charge_on_option?: ChargeOnOption;
+      item_type?: ItemTypeEnum;
+      charge_on_option?: ChargeOnOptionEnum;
     }
     export interface DiscountsCreateSubItemsForCustomerQuoteInputParam {
-      apply_on: ApplyOn;
-      duration_type: DurationType;
+      apply_on: ApplyOnEnum;
+      duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;
       period?: number;
-      period_unit?: PeriodUnit;
+      period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
     }
@@ -1103,7 +1104,7 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface ContractTermEditCreateSubCustomerQuoteForItemsInputParam {
       action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
@@ -1130,21 +1131,21 @@ declare module 'chargebee' {
       billing_cycles?: number;
       trial_end?: number;
       service_period_days?: number;
-      charge_on_event?: ChargeOnEvent;
+      charge_on_event?: ChargeOnEventEnum;
       charge_once?: boolean;
       /**
        * @deprecated Please refer API docs to use other attributes
        */
-      item_type?: ItemType;
-      charge_on_option?: ChargeOnOption;
+      item_type?: ItemTypeEnum;
+      charge_on_option?: ChargeOnOptionEnum;
     }
     export interface DiscountsEditCreateSubCustomerQuoteForItemsInputParam {
-      apply_on: ApplyOn;
-      duration_type: DurationType;
+      apply_on: ApplyOnEnum;
+      duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;
       period?: number;
-      period_unit?: PeriodUnit;
+      period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
     }
@@ -1171,7 +1172,7 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface CustomerUpdateSubscriptionQuoteForItemsInputParam {
       vat_number?: string;
@@ -1192,7 +1193,7 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface ContractTermUpdateSubscriptionQuoteForItemsInputParam {
       action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
@@ -1210,8 +1211,8 @@ declare module 'chargebee' {
        * @deprecated Please refer API docs to use other attributes
        */
       coupon?: string;
-      auto_collection?: AutoCollection;
-      offline_payment_method?: OfflinePaymentMethod;
+      auto_collection?: AutoCollectionEnum;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       contract_term_billing_cycle_on_renewal?: number;
     }
 
@@ -1224,24 +1225,24 @@ declare module 'chargebee' {
       billing_cycles?: number;
       trial_end?: number;
       service_period_days?: number;
-      charge_on_event?: ChargeOnEvent;
+      charge_on_event?: ChargeOnEventEnum;
       charge_once?: boolean;
-      charge_on_option?: ChargeOnOption;
+      charge_on_option?: ChargeOnOptionEnum;
       /**
        * @deprecated Please refer API docs to use other attributes
        */
-      item_type?: ItemType;
+      item_type?: ItemTypeEnum;
     }
     export interface DiscountsUpdateSubscriptionQuoteForItemsInputParam {
-      apply_on: ApplyOn;
-      duration_type: DurationType;
+      apply_on: ApplyOnEnum;
+      duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;
       period?: number;
-      period_unit?: PeriodUnit;
+      period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
-      operation_type: OperationType;
+      operation_type: OperationTypeEnum;
       id?: string;
     }
     export interface ItemTiersUpdateSubscriptionQuoteForItemsInputParam {
@@ -1267,7 +1268,7 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface CustomerEditUpdateSubscriptionQuoteForItemsInputParam {
       vat_number?: string;
@@ -1288,7 +1289,7 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
     export interface ContractTermEditUpdateSubscriptionQuoteForItemsInputParam {
       action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
@@ -1305,8 +1306,8 @@ declare module 'chargebee' {
        * @deprecated Please refer API docs to use other attributes
        */
       coupon?: string;
-      auto_collection?: AutoCollection;
-      offline_payment_method?: OfflinePaymentMethod;
+      auto_collection?: AutoCollectionEnum;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       contract_term_billing_cycle_on_renewal?: number;
     }
 
@@ -1319,24 +1320,24 @@ declare module 'chargebee' {
       billing_cycles?: number;
       trial_end?: number;
       service_period_days?: number;
-      charge_on_event?: ChargeOnEvent;
+      charge_on_event?: ChargeOnEventEnum;
       charge_once?: boolean;
-      charge_on_option?: ChargeOnOption;
+      charge_on_option?: ChargeOnOptionEnum;
       /**
        * @deprecated Please refer API docs to use other attributes
        */
-      item_type?: ItemType;
+      item_type?: ItemTypeEnum;
     }
     export interface DiscountsEditUpdateSubscriptionQuoteForItemsInputParam {
-      apply_on: ApplyOn;
-      duration_type: DurationType;
+      apply_on: ApplyOnEnum;
+      duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;
       period?: number;
-      period_unit?: PeriodUnit;
+      period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
-      operation_type: OperationType;
+      operation_type: OperationTypeEnum;
       id?: string;
     }
     export interface ItemTiersEditUpdateSubscriptionQuoteForItemsInputParam {
@@ -1362,14 +1363,14 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
 
     export interface ChargesCreateForChargeItemsAndChargesInputParam {
       amount?: number;
       amount_in_decimal?: string;
       description?: string;
-      avalara_sale_type?: AvalaraSaleType;
+      avalara_sale_type?: AvalaraSaleTypeEnum;
       avalara_transaction_type?: number;
       avalara_service_type?: number;
       service_period?: number;
@@ -1377,7 +1378,7 @@ declare module 'chargebee' {
     export interface DiscountsCreateForChargeItemsAndChargesInputParam {
       percentage?: number;
       amount?: number;
-      apply_on: ApplyOn;
+      apply_on: ApplyOnEnum;
       item_price_id?: string;
     }
     export interface ItemTiersCreateForChargeItemsAndChargesInputParam {
@@ -1416,14 +1417,14 @@ declare module 'chargebee' {
       state?: string;
       zip?: string;
       country?: string;
-      validation_status?: ValidationStatus;
+      validation_status?: ValidationStatusEnum;
     }
 
     export interface ChargesEditForChargeItemsAndChargesInputParam {
       amount?: number;
       amount_in_decimal?: string;
       description?: string;
-      avalara_sale_type?: AvalaraSaleType;
+      avalara_sale_type?: AvalaraSaleTypeEnum;
       avalara_transaction_type?: number;
       avalara_service_type?: number;
       service_period?: number;
@@ -1431,7 +1432,7 @@ declare module 'chargebee' {
     export interface DiscountsEditForChargeItemsAndChargesInputParam {
       percentage?: number;
       amount?: number;
-      apply_on: ApplyOn;
+      apply_on: ApplyOnEnum;
       item_price_id?: string;
     }
     export interface ItemTiersEditForChargeItemsAndChargesInputParam {
@@ -1458,7 +1459,7 @@ declare module 'chargebee' {
     }
     export interface SubscriptionConvertInputParam {
       id?: string;
-      auto_collection?: AutoCollection;
+      auto_collection?: AutoCollectionEnum;
       po_number?: string;
       auto_close_invoices?: boolean;
     }

package/types/resources/QuotedSubscription.d.ts

@@ -14,7 +14,7 @@ declare module 'chargebee' {
     trial_end?: number;
     remaining_billing_cycles?: number;
     po_number?: string;
-    auto_collection?: AutoCollection;
+    auto_collection?: AutoCollectionEnum;
     plan_quantity_in_decimal?: string;
     plan_unit_price_in_decimal?: string;
     changes_scheduled_at?: number;
@@ -86,6 +86,9 @@ declare module 'chargebee' {
       charge_once?: boolean;
       charge_on_option?: 'immediately' | 'on_event';
       proration_type?: 'full_term' | 'partial_term' | 'none';
+      usage_accumulation_reset_frequency?:
+        | 'never'
+        | 'subscription_billing_frequency';
     }
     export interface ItemTier {
       item_price_id: string;

package/types/resources/Ramp.d.ts

@@ -206,12 +206,12 @@ declare module 'chargebee' {
       service_period_days?: number;
     }
     export interface DiscountsToAddCreateForSubscriptionInputParam {
-      apply_on: ApplyOn;
-      duration_type: DurationType;
+      apply_on: ApplyOnEnum;
+      duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;
       period?: number;
-      period_unit?: PeriodUnit;
+      period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
     }
@@ -247,12 +247,12 @@ declare module 'chargebee' {
       service_period_days?: number;
     }
     export interface DiscountsToAddUpdateInputParam {
-      apply_on: ApplyOn;
-      duration_type: DurationType;
+      apply_on: ApplyOnEnum;
+      duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;
       period?: number;
-      period_unit?: PeriodUnit;
+      period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
     }