chargebee 3.4.0 → 3.6.0

package/types/resources/Plan.d.ts

@@ -0,0 +1,401 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface Plan {
+    [key: string]: unknown;
+    id: string;
+    name: string;
+    invoice_name?: string;
+    description?: string;
+    price?: number;
+    currency_code: string;
+    period: number;
+    period_unit: 'day' | 'week' | 'month' | 'year';
+    trial_period?: number;
+    trial_period_unit?: 'day' | 'month';
+    trial_end_action?:
+      | 'site_default'
+      | 'activate_subscription'
+      | 'cancel_subscription';
+    pricing_model: PricingModelEnum;
+    charge_model: 'flat_fee' | 'per_unit' | 'tiered' | 'volume' | 'stairstep';
+    free_quantity: number;
+    setup_cost?: number;
+    downgrade_penalty?: number;
+    status: 'active' | 'archived' | 'deleted';
+    archived_at?: number;
+    billing_cycles?: number;
+    redirect_url?: string;
+    enabled_in_hosted_pages: boolean;
+    enabled_in_portal: boolean;
+    addon_applicability: 'all' | 'restricted';
+    tax_code?: string;
+    hsn_code?: string;
+    taxjar_product_code?: string;
+    avalara_sale_type?: AvalaraSaleTypeEnum;
+    avalara_transaction_type?: number;
+    avalara_service_type?: number;
+    sku?: string;
+    accounting_code?: string;
+    accounting_category1?: string;
+    accounting_category2?: string;
+    accounting_category3?: string;
+    accounting_category4?: string;
+    is_shippable?: boolean;
+    shipping_frequency_period?: number;
+    shipping_frequency_period_unit?: 'year' | 'month' | 'week' | 'day';
+    resource_version?: number;
+    updated_at?: number;
+    giftable: boolean;
+    claim_url?: string;
+    free_quantity_in_decimal?: string;
+    price_in_decimal?: string;
+    channel?: ChannelEnum;
+    invoice_notes?: string;
+    taxable?: boolean;
+    tax_profile_id?: string;
+    meta_data?: any;
+    tiers?: Plan.Tier[];
+    tax_providers_fields?: Plan.TaxProvidersField[];
+    applicable_addons?: Plan.ApplicableAddon[];
+    attached_addons?: Plan.AttachedAddon[];
+    event_based_addons?: Plan.EventBasedAddon[];
+    show_description_in_invoices?: boolean;
+    show_description_in_quotes?: boolean;
+  }
+
+  export namespace Plan {
+    export class PlanResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      update(
+        plan_id: string,
+        input: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      retrieve(
+        plan_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      delete(
+        plan_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      copy(
+        input: CopyInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CopyResponse>>;
+
+      unarchive(
+        plan_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UnarchiveResponse>>;
+    }
+
+    export interface CreateResponse {
+      plan: Plan;
+    }
+
+    export interface UpdateResponse {
+      plan: Plan;
+    }
+
+    export interface ListResponse {
+      list: { plan: Plan }[];
+      next_offset?: string;
+    }
+
+    export interface RetrieveResponse {
+      plan: Plan;
+    }
+
+    export interface DeleteResponse {
+      plan: Plan;
+    }
+
+    export interface CopyResponse {
+      plan: Plan;
+    }
+
+    export interface UnarchiveResponse {
+      plan: Plan;
+    }
+
+    export interface Tier {
+      starting_unit: number;
+      ending_unit?: number;
+      price: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      price_in_decimal?: string;
+      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
+      package_size?: number;
+    }
+    export interface TaxProvidersField {
+      provider_name: string;
+      field_id: string;
+      field_value: string;
+    }
+    export interface ApplicableAddon {
+      id: string;
+    }
+    export interface AttachedAddon {
+      id: string;
+      quantity: number;
+      billing_cycles?: number;
+      type: 'recommended' | 'mandatory';
+      quantity_in_decimal?: string;
+    }
+    export interface EventBasedAddon {
+      id: string;
+      quantity: number;
+      on_event:
+        | 'subscription_creation'
+        | 'subscription_trial_start'
+        | 'plan_activation'
+        | 'subscription_activation'
+        | 'contract_termination';
+      charge_once: boolean;
+      quantity_in_decimal?: string;
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      id: string;
+      name: string;
+      invoice_name?: string;
+      description?: string;
+      trial_period?: number;
+      trial_period_unit?: 'day' | 'month';
+      trial_end_action?:
+        | 'site_default'
+        | 'activate_subscription'
+        | 'cancel_subscription';
+      period?: number;
+      period_unit?: 'day' | 'week' | 'month' | 'year';
+      setup_cost?: number;
+      price?: number;
+      price_in_decimal?: string;
+      currency_code?: string;
+      billing_cycles?: number;
+      pricing_model?: PricingModelEnum /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
+
+      charge_model?:
+        | 'flat_fee'
+        | 'per_unit'
+        | 'tiered'
+        | 'volume'
+        | 'stairstep';
+      free_quantity?: number;
+      free_quantity_in_decimal?: string;
+      addon_applicability?: 'all' | 'restricted' /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
+
+      downgrade_penalty?: number;
+      redirect_url?: string;
+      enabled_in_hosted_pages?: boolean;
+      enabled_in_portal?: boolean;
+      taxable?: boolean;
+      tax_profile_id?: string;
+      tax_code?: string;
+      hsn_code?: string;
+      taxjar_product_code?: string;
+      avalara_sale_type?: AvalaraSaleTypeEnum;
+      avalara_transaction_type?: number;
+      avalara_service_type?: number;
+      sku?: string;
+      accounting_code?: string;
+      accounting_category1?: string;
+      accounting_category2?: string;
+      accounting_category3?: string;
+      accounting_category4?: string;
+      is_shippable?: boolean;
+      shipping_frequency_period?: number;
+      shipping_frequency_period_unit?: 'year' | 'month' | 'week' | 'day';
+      invoice_notes?: string;
+      meta_data?: any;
+      show_description_in_invoices?: boolean;
+      show_description_in_quotes?: boolean;
+      giftable?: boolean;
+      status?: 'active' | 'archived';
+      claim_url?: string;
+      tiers?: TiersCreateInputParam[];
+      tax_providers_fields?: TaxProvidersFieldsCreateInputParam[];
+      applicable_addons?: ApplicableAddonsCreateInputParam[];
+      event_based_addons?: EventBasedAddonsCreateInputParam[];
+      attached_addons?: AttachedAddonsCreateInputParam[];
+      [key: `cf_${string}`]: unknown;
+    }
+    export interface UpdateInputParam {
+      name?: string;
+      invoice_name?: string;
+      description?: string;
+      trial_period?: number;
+      trial_period_unit?: 'day' | 'month';
+      trial_end_action?:
+        | 'site_default'
+        | 'activate_subscription'
+        | 'cancel_subscription';
+      period?: number;
+      period_unit?: 'day' | 'week' | 'month' | 'year';
+      setup_cost?: number;
+      price?: number;
+      price_in_decimal?: string;
+      currency_code?: string;
+      billing_cycles?: number;
+      pricing_model?: PricingModelEnum /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
+
+      charge_model?:
+        | 'flat_fee'
+        | 'per_unit'
+        | 'tiered'
+        | 'volume'
+        | 'stairstep';
+      free_quantity?: number;
+      free_quantity_in_decimal?: string;
+      addon_applicability?: 'all' | 'restricted' /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
+
+      downgrade_penalty?: number;
+      redirect_url?: string;
+      enabled_in_hosted_pages?: boolean;
+      enabled_in_portal?: boolean;
+      taxable?: boolean;
+      tax_profile_id?: string;
+      tax_code?: string;
+      hsn_code?: string;
+      taxjar_product_code?: string;
+      avalara_sale_type?: AvalaraSaleTypeEnum;
+      avalara_transaction_type?: number;
+      avalara_service_type?: number;
+      sku?: string;
+      accounting_code?: string;
+      accounting_category1?: string;
+      accounting_category2?: string;
+      accounting_category3?: string;
+      accounting_category4?: string;
+      is_shippable?: boolean;
+      shipping_frequency_period?: number;
+      shipping_frequency_period_unit?: 'year' | 'month' | 'week' | 'day';
+      invoice_notes?: string;
+      meta_data?: any;
+      show_description_in_invoices?: boolean;
+      show_description_in_quotes?: boolean;
+      tiers?: TiersUpdateInputParam[];
+      tax_providers_fields?: TaxProvidersFieldsUpdateInputParam[];
+      applicable_addons?: ApplicableAddonsUpdateInputParam[];
+      attached_addons?: AttachedAddonsUpdateInputParam[];
+      event_based_addons?: EventBasedAddonsUpdateInputParam[];
+      [key: `cf_${string}`]: unknown;
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      id?: filter.String;
+      name?: filter.String;
+      price?: filter.Number;
+      period?: filter.Number;
+      period_unit?: filter.Enum;
+      trial_period?: filter.Number;
+      trial_period_unit?: filter.Enum;
+      addon_applicability?: filter.Enum;
+      giftable?: filter.Boolean /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
+
+      charge_model?: filter.Enum;
+      pricing_model?: filter.Enum;
+      status?: filter.Enum;
+      updated_at?: filter.Timestamp;
+      currency_code?: filter.String;
+      channel?: filter.Enum;
+      include_deleted?: boolean;
+      [key: `cf_${string}`]: unknown;
+    }
+    export interface CopyInputParam {
+      from_site: string;
+      id_at_from_site: string;
+      id?: string;
+      for_site_merging?: boolean;
+    }
+    export interface TiersCreateInputParam {
+      starting_unit?: number;
+      ending_unit?: number;
+      price?: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      price_in_decimal?: string;
+    }
+    export interface EventBasedAddonsCreateInputParam {
+      id?: string;
+      quantity?: number;
+      quantity_in_decimal?: string;
+      on_event?: OnEventEnum;
+      charge_once?: boolean;
+    }
+    export interface AttachedAddonsCreateInputParam {
+      id?: string;
+      quantity?: number;
+      quantity_in_decimal?: string;
+      billing_cycles?: number;
+      type?: 'recommended' | 'mandatory';
+    }
+    export interface ApplicableAddonsCreateInputParam {
+      id?: string;
+    }
+    export interface TaxProvidersFieldsCreateInputParam {
+      provider_name: string;
+      field_id: string;
+      field_value: string;
+    }
+    export interface TiersUpdateInputParam {
+      starting_unit?: number;
+      ending_unit?: number;
+      price?: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      price_in_decimal?: string;
+    }
+    export interface EventBasedAddonsUpdateInputParam {
+      id?: string;
+      quantity?: number;
+      quantity_in_decimal?: string;
+      on_event?: OnEventEnum;
+      charge_once?: boolean;
+    }
+    export interface AttachedAddonsUpdateInputParam {
+      id?: string;
+      quantity?: number;
+      quantity_in_decimal?: string;
+      billing_cycles?: number;
+      type?: 'recommended' | 'mandatory';
+    }
+    export interface ApplicableAddonsUpdateInputParam {
+      id?: string;
+    }
+    export interface TaxProvidersFieldsUpdateInputParam {
+      provider_name: string;
+      field_id: string;
+      field_value: string;
+    }
+  }
+}

package/types/resources/Purchase.d.ts

@@ -41,6 +41,7 @@ declare module 'chargebee' {
       invoice_info?: InvoiceInfoCreateInputParam;
       payment_schedule?: PaymentScheduleCreateInputParam;
       statement_descriptor?: StatementDescriptorCreateInputParam;
+      payment_intent?: PaymentIntentCreateInputParam;
       purchase_items?: PurchaseItemsCreateInputParam[];
       item_tiers?: ItemTiersCreateInputParam[];
       shipping_addresses?: ShippingAddressesCreateInputParam[];
@@ -71,6 +72,38 @@ declare module 'chargebee' {
       po_number?: string;
       notes?: string;
     }
+    export interface PaymentIntentCreateInputParam {
+      id?: string;
+      gateway_account_id?: string;
+      gw_token?: string;
+      payment_method_type?:
+        | 'card'
+        | 'ideal'
+        | 'sofort'
+        | 'bancontact'
+        | 'google_pay'
+        | 'dotpay'
+        | 'giropay'
+        | 'apple_pay'
+        | 'upi'
+        | 'netbanking_emandates'
+        | 'paypal_express_checkout'
+        | 'direct_debit'
+        | 'boleto'
+        | 'venmo'
+        | 'amazon_payments'
+        | 'pay_to'
+        | 'faster_payments'
+        | 'sepa_instant_transfer'
+        | 'klarna_pay_now'
+        | 'online_banking_poland';
+      reference_id?: string;
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+      gw_payment_method_id?: string;
+      additional_information?: any;
+    }
 
     export interface SubscriptionInfoCreateInputParam {
       index: number;

package/types/resources/Quote.d.ts

@@ -3,6 +3,7 @@
 ///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface Quote {
+    [key: string]: unknown;
     id: string;
     name?: string;
     po_number?: string;
@@ -297,7 +298,8 @@ declare module 'chargebee' {
       amount_in_decimal?: string;
       discount_amount?: number;
       item_level_discount_amount?: number;
-      usage_percentage?: string;
+      metered?: boolean;
+      percentage?: string;
       reference_line_item_id?: string;
       description: string;
       entity_description?: string;
@@ -390,6 +392,8 @@ declare module 'chargebee' {
       ending_unit_in_decimal?: string;
       quantity_used_in_decimal?: string;
       unit_amount_in_decimal?: string;
+      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
+      package_size?: number;
     }
     export interface ShippingAddress {
       first_name?: string;
@@ -544,6 +548,7 @@ declare module 'chargebee' {
       subscription_items?: SubscriptionItemsCreateSubItemsForCustomerQuoteInputParam[];
       discounts?: DiscountsCreateSubItemsForCustomerQuoteInputParam[];
       item_tiers?: ItemTiersCreateSubItemsForCustomerQuoteInputParam[];
+      [key: `cf_${string}`]: unknown;
     }
     export interface EditCreateSubCustomerQuoteForItemsInputParam {
       notes?: string;
@@ -559,6 +564,7 @@ declare module 'chargebee' {
       subscription_items?: SubscriptionItemsEditCreateSubCustomerQuoteForItemsInputParam[];
       discounts?: DiscountsEditCreateSubCustomerQuoteForItemsInputParam[];
       item_tiers?: ItemTiersEditCreateSubCustomerQuoteForItemsInputParam[];
+      [key: `cf_${string}`]: unknown;
     }
     export interface UpdateSubscriptionQuoteForItemsInputParam {
       name?: string;
@@ -584,6 +590,7 @@ declare module 'chargebee' {
       subscription_items?: SubscriptionItemsUpdateSubscriptionQuoteForItemsInputParam[];
       discounts?: DiscountsUpdateSubscriptionQuoteForItemsInputParam[];
       item_tiers?: ItemTiersUpdateSubscriptionQuoteForItemsInputParam[];
+      [key: `cf_${string}`]: unknown;
     }
     export interface EditUpdateSubscriptionQuoteForItemsInputParam {
       notes?: string;
@@ -608,6 +615,7 @@ declare module 'chargebee' {
       subscription_items?: SubscriptionItemsEditUpdateSubscriptionQuoteForItemsInputParam[];
       discounts?: DiscountsEditUpdateSubscriptionQuoteForItemsInputParam[];
       item_tiers?: ItemTiersEditUpdateSubscriptionQuoteForItemsInputParam[];
+      [key: `cf_${string}`]: unknown;
     }
     export interface CreateForChargeItemsAndChargesInputParam {
       name?: string;
@@ -651,6 +659,7 @@ declare module 'chargebee' {
       updated_at?: filter.Timestamp;
       'sort_by[asc]'?: string;
       'sort_by[desc]'?: string;
+      [key: `cf_${string}`]: unknown;
     }
     export interface QuoteLineGroupsForQuoteInputParam {
       limit?: number;
@@ -1091,6 +1100,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface ShippingAddressEditCreateSubCustomerQuoteForItemsInputParam {
       first_name?: string;
@@ -1159,6 +1170,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface BillingAddressUpdateSubscriptionQuoteForItemsInputParam {
       first_name?: string;
@@ -1255,6 +1268,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface BillingAddressEditUpdateSubscriptionQuoteForItemsInputParam {
       first_name?: string;
@@ -1350,6 +1365,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface ShippingAddressCreateForChargeItemsAndChargesInputParam {
       first_name?: string;
@@ -1391,6 +1408,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface ItemPricesCreateForChargeItemsAndChargesInputParam {
       item_price_id?: string;
@@ -1445,6 +1464,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface ItemPricesEditForChargeItemsAndChargesInputParam {
       item_price_id?: string;

package/types/resources/QuoteLineGroup.d.ts

@@ -48,7 +48,8 @@ declare module 'chargebee' {
       amount_in_decimal?: string;
       discount_amount?: number;
       item_level_discount_amount?: number;
-      usage_percentage?: string;
+      metered?: boolean;
+      percentage?: string;
       reference_line_item_id?: string;
       description: string;
       entity_description?: string;

package/types/resources/QuotedCharge.d.ts

@@ -45,6 +45,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
+      package_size?: number;
       index: number;
     }
     export interface Coupon {

package/types/resources/QuotedSubscription.d.ts

@@ -101,6 +101,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
+      package_size?: number;
       index: number;
     }
     export interface QuotedContractTerm {

package/types/resources/Ramp.d.ts

@@ -130,6 +130,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
+      package_size?: number;
       index: number;
     }
     export interface StatusTransitionReason {
@@ -195,6 +197,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface ItemsToUpdateCreateForSubscriptionInputParam {
       item_price_id: string;
@@ -236,6 +240,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface ItemsToUpdateUpdateInputParam {
       item_price_id: string;

package/types/resources/RecordedPurchase.d.ts

@@ -6,7 +6,7 @@ declare module 'chargebee' {
     id: string;
     customer_id: string;
     app_id: string;
-    source: 'apple_app_store';
+    source: 'apple_app_store' | 'google_play_store';
     status: 'in_process' | 'completed' | 'failed' | 'ignored';
     omnichannel_transaction_id?: string;
     created_at: number;
@@ -50,12 +50,18 @@ declare module 'chargebee' {
       app_id: string;
       customer?: CustomerCreateInputParam;
       apple_app_store?: AppleAppStoreCreateInputParam;
+      google_play_store?: GooglePlayStoreCreateInputParam;
     }
     export interface CustomerCreateInputParam {
       id: string;
     }
+    export interface GooglePlayStoreCreateInputParam {
+      purchase_token?: string;
+    }
     export interface AppleAppStoreCreateInputParam {
       transaction_id?: string;
+      receipt?: string;
+      product_id?: string;
     }
   }
 }

package/types/resources/Subscription.d.ts

@@ -590,6 +590,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
+      package_size?: number;
       index: number;
     }
     export interface ChargedItem {
@@ -1669,6 +1671,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface BillingAddressUpdateInputParam {
       first_name?: string;
@@ -2006,6 +2010,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface StatementDescriptorReactivateInputParam {
       descriptor?: string;
@@ -2410,6 +2416,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface ChargedItemsImportForItemsInputParam {
       item_price_id?: string;