chargebee 2.28.0 → 2.30.0

package/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,81 @@
+name: Bug Report
+description: Report a bug for this repository.
+labels:
+  - Bug
+
+body:
+  
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: Description of the Bug
+      description: Please provide a clear and concise description of the bug.
+      placeholder: Describe what you're experiencing.
+    validations:
+      required: true
+
+  - type: textarea
+    id: repro-steps
+    attributes:
+      label: Steps to reproduce
+      description: Clear and concise instructions to reproduce the bug are essential for quick resolution.
+      placeholder: |
+        1. Fetch '...'
+        2. Update the '....'
+        3. Encounter the error
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected Behavior
+      description: Describe what you expected to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: code-snippets
+    attributes:
+      label: Code Snippets (if applicable)
+      description: If relevant, provide code snippets to clarify the issue.
+      render: node
+    validations:
+      required: false
+
+  - type: input
+    id: os
+    attributes:
+      label: Operating System
+      placeholder: macOS
+    validations:
+      required: true
+
+  - type: input
+    id: language-version
+    attributes:
+      label: Language version
+      placeholder: Node 18.18.1
+    validations:
+      required: true
+
+  - type: input
+    id: lib-version
+    attributes:
+      label: Library version
+      placeholder: 2.28.0
+    validations:
+      required: true   
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Provide any other relevant information about the problem.
+    validations:
+      required: false
+
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to submit this bug report!

package/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,6 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Chargebee support
+    url: https://support.chargebee.com/
+    about: |
+      Github issues are not an official support channel for Chargebee. If you have an urgent request we suggest you contact us through an official channel: support@chargebee.com or  https://support.chargebee.com/

package/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,34 @@
+name: Feature Request
+description: Request a New Feature for the project.
+labels:
+  - Feature Request
+
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: What problem does your feature request address?
+      description: Please provide a clear and concise description of the problem you'd like to solve. For example, "I'm frequently frustrated when..."
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the desired solution
+      description: Please provide a clear and concise description of the solution you would like to see implemented.
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives considered
+      description: Describe any alternative solutions or features you may have thought about in relation to this problem.
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Feel free to include any other relevant information or context regarding your feature request.
+      
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to submit your feature request!

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,8 @@
+### Description
+Please provide a brief overview of the changes introduced by this pull request.
+
+### Related Issues
+Closes #IssueNumber
+
+### Additional Information
+Include any additional information that might be helpful in reviewing the changes introduced by this pull request.

package/.github/workflows/greeting.yml

@@ -0,0 +1,47 @@
+name: Greet New Contributors
+
+on: 
+  issues:
+    types: [opened]
+  pull_request:
+    types: [opened]
+
+permissions:
+  issues: write
+  pull-requests: write
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:   
+    - name: Greet for issue
+      if: github.event_name == 'issues' && github.event.action == 'opened'
+      uses: actions/github-script@v6
+      with:
+        script: |
+          const issueComment = `
+            Hello @${context.payload.sender.login}, thank you for raising the issue. Your contribution is greatly appreciated and we look forward to addressing it.
+          `
+          github.rest.issues.createComment({
+            issue_number: context.payload.issue.number,
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            body: issueComment,
+          })
+          
+    - name: Greet for pull request
+      if: github.event_name == 'pull_request' && github.event.action == 'opened'
+      uses: actions/github-script@v6
+      with:
+        script: |
+          const prComment = `
+            Thank you, @${context.payload.sender.login}, for the pull request. We will take a look at it and get back to you shortly.
+          `
+          github.rest.issues.createComment({
+            issue_number: context.payload.pull_request.number,
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            body: prComment,
+          })

package/CHANGELOG.md

@@ -1,3 +1,62 @@
+### v2.30.0 (2023-11-30)
+* * *
+
+#### New Enum values:
+* swiss_reference has been added to PaymentReferenceNumber#TypeEnum.
+
+#### New Input parameters:
+* subscription[po_number] has been added to Quote#EditCreateSubForCustomerQuoteRequest in Quote resource. 
+* subscription[po_number] has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest in Quote resource.
+
+* * * 
+
+### v2.29.0 (2023-10-31)
+* * *
+
+#### New attributes:
+* statement_descriptor has been added to invoice resource.
+* source has been added to the Hosted_Pages resource.
+
+#### New Enum values:
+* pay_com has been added to Gateway.
+* pay_to, faster_payments, sepa_instant_transfer has been added to Customer#TypeEnum.
+* pay_to, faster_payments, sepa_instant_transfer has been added to PaymentMethodEnum.
+* pay_to, faster_payments, sepa_instant_transfer has been added to PaymentMethodTypeEnum.
+* pay_to, faster_payments, sepa_instant_transfer has been added to TypeEnum.
+* pay_to, faster_payments, sepa_instant_transfer, amazon_payments has been added to PaymentIntent#PaymentMethodTypeEnum.
+
+#### New Input parameters:
+* source has been added to HostedPage#CheckoutOneTimeForItemsRequest.
+* source has been added to HostedPage#CheckoutNewForItemsRequest.
+* source has been added to HostedPage#CheckoutExistingForItemsRequest.
+* statement_descriptor_descriptor has been added to Invoice#CreateRequest.
+* statement_descriptor_descriptor has been added to Invoice#CreateForChargeItemsAndChargesRequest.
+* statement_descriptor_descriptor has been added to Invoice#UpdateDetailsRequest.
+* statement_descriptor_additional_info has been added to Invoice#CreateRequest.
+* statement_descriptor_additional_info has been added to Invoice#CreateForChargeItemsAndChargesRequest.
+* statement_descriptor_additional_info has been added to Invoice#UpdateDetailsRequest.
+* statement_descriptor_descriptor has been added to Subscription#CreateRequest.
+* statement_descriptor_descriptor has been added to Subscription#CreateForCustomerRequest.
+* statement_descriptor_descriptor has been added to Subscription#CreateWithItemsRequest.
+* statement_descriptor_descriptor has been added to Subscription#UpdateRequest.
+* statement_descriptor_descriptor has been added to Subscription#UpdateForItemsRequest.
+* statement_descriptor_descriptor has been added to Subscription#ReactivateRequest.
+* statement_descriptor_additional_info has been added to Subscription#CreateRequest.
+* statement_descriptor_additional_info has been added to Subscription#CreateForCustomerRequest.
+* statement_descriptor_additional_info has been added to Subscription#CreateWithItemsRequest.
+* statement_descriptor_additional_info has been added to Subscription#UpdateRequest.
+* statement_descriptor_additional_info has been added to Subscription#UpdateForItemsRequest.
+* statement_descriptor_additional_info has been added to Subscription#ReactivateRequest.
+
+#### Updates to old parameters:
+* duration_type, discount_type in coupons has been made optional.
+* proration_type in addons is now supported.
+* csv_tax_rule has been removed.
+* Tax1JurisTypeEnum has been removed.
+* Tax2JurisTypeEnum has been removed.
+* Tax3JurisTypeEnum has been removed.
+* Tax4JurisTypeEnum has been removed.
+
 ### v2.28.0 (2023-09-26)
 * * *
 

package/SECURITY.md

@@ -0,0 +1,8 @@
+# Security Policy
+
+At Chargebee, we take data integrity and security very seriously. Due to the nature of the product and service we provide, we are committed to working with individuals to stay updated on the latest security techniques and fix any security weakness in our application or infrastructure reported to us responsibly by external parties.
+
+https://www.chargebee.com/security/responsible-disclosure-policy/
+
+## Reporting a vulnerability
+Reach out to us at security@chargebee.com. Please do not open GitHub issues or pull requests as this makes the problem immediately visible to everyone, including malicious actors. Chargebee's security team will triage your report and respond according to its impact. 

package/lib/chargebee.js

@@ -11,7 +11,7 @@ ChargeBee._env = {
     hostSuffix: '.chargebee.com',
     apiPath: '/api/v2',
     timeout: 80000,
-    clientVersion: 'v2.28.0',
+    clientVersion: 'v2.30.0',
     port: 443,
     timemachineWaitInMillis: 3000,
     exportWaitInMillis: 3000

package/lib/resources/api_endpoints.js

@@ -2608,13 +2608,6 @@ var _endpoints = {
       true
     ]
   ],
-  "non_subscription": [[
-    "process_receipt",
-    "POST",
-    "/non_subscriptions",
-    "/one_time_purchase",
-    true
-  ]],
   "entitlement_override": [
     [
       "add_entitlement_override_for_subscription",
@@ -2677,12 +2670,5 @@ var _endpoints = {
       true
     ]
   ],
-  "csv_tax_rule": [[
-    "create",
-    "POST",
-    "/csv_tax_rules",
-    null,
-    false
-  ]]
 };
 module.exports = _endpoints;

package/package.json

@@ -1,6 +1,6 @@
 {
    "name":"chargebee",
-   "version":"2.28.0",
+   "version":"2.30.0",
    "description":"A library for integrating with ChargeBee.",
    "keywords":[
       "payments",

package/types/core.d.ts

@@ -46,7 +46,7 @@ declare module 'chargebee' {
   type ExportType = 'data' | 'import_friendly_data'
   type FreePeriodUnit = 'week' | 'month' | 'year' | 'day'
   type FriendOfferType = 'coupon_code' | 'coupon' | 'none'
-  type Gateway = 'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay'
+  type Gateway = 'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'ebanx' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay' | 'pay_com'
   type HierarchyOperationType = 'complete_hierarchy' | 'subordinates' | 'path_to_root'
   type InvoiceDunningHandling = 'stop' | 'continue'
   type ItemType = 'charge' | 'addon' | 'plan'
@@ -58,8 +58,8 @@ declare module 'chargebee' {
   type OperationType = 'add' | 'remove'
   type PauseOption = 'end_of_term' | 'billing_cycles' | 'immediately' | 'specific_date'
   type PaymentInitiator = 'merchant' | 'customer'
-  type PaymentMethod = 'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'chargeback' | 'wechat_pay' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'sofort' | 'amazon_payments' | 'upi' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card'
-  type PaymentMethodType = 'giropay' | 'alipay' | 'ideal' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'unionpay' | 'direct_debit' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'wechat_pay' | 'card'
+  type PaymentMethod = 'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'chargeback' | 'wechat_pay' | 'pay_to' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'faster_payments' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card'
+  type PaymentMethodType = 'giropay' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'unionpay' | 'direct_debit' | 'faster_payments' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'wechat_pay' | 'pay_to' | 'card'
   type PaymentVoucherType = 'boleto'
   type PeriodUnit = 'week' | 'month' | 'year' | 'day'
   type PriceType = 'tax_exclusive' | 'tax_inclusive'
@@ -78,7 +78,7 @@ declare module 'chargebee' {
   type Taxability = 'taxable' | 'exempt'
   type TaxjarExemptionCategory = 'other' | 'wholesale' | 'government'
   type TrialEndAction = 'activate_subscription' | 'plan_default' | 'cancel_subscription' | 'site_default'
-  type Type = 'giropay' | 'alipay' | 'ideal' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'unionpay' | 'direct_debit' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'wechat_pay' | 'card'
+  type Type = 'giropay' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'unionpay' | 'direct_debit' | 'faster_payments' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'wechat_pay' | 'pay_to' | 'card'
   type UnbilledChargesHandling = 'invoice' | 'no_action'
   type UnbilledChargesOption = 'invoice' | 'delete'
   type UnpaidInvoicesHandling = 'schedule_payment_collection' | 'no_action'

package/types/resources/AttachedItem.d.ts

@@ -104,11 +104,11 @@ The value set explicitly for `billing_cycles` while [applying the addo
   export namespace AttachedItem {
     export class AttachedItemResource {  
       /**
-        * @description Retrieves details of an attached addon or a charge item.
+        * @description Creates an attached addon or a charge item for a plan.
 
         */
       
-      retrieve(attached_item_id:string, input:RetrieveInputParam):ChargebeeRequest<RetrieveResponse>;
+      create(item_id:string, input:CreateInputParam):ChargebeeRequest<CreateResponse>;
        
       /**
         * @description Updates an attached addon or a charge item for a plan.
@@ -118,18 +118,11 @@ The value set explicitly for &#x60;billing_cycles&#x60; while [applying the addo
       update(attached_item_id:string, input:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
        
       /**
-        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
-
-        */
-      
-      list(item_id:string, input?:ListInputParam):ChargebeeRequest<ListResponse>;
-       
-      /**
-        * @description Creates an attached addon or a charge item for a plan.
+        * @description Retrieves details of an attached addon or a charge item.
 
         */
       
-      create(item_id:string, input:CreateInputParam):ChargebeeRequest<CreateResponse>;
+      retrieve(attached_item_id:string, input:RetrieveInputParam):ChargebeeRequest<RetrieveResponse>;
        
       /**
         * @description Deletes an attached addon or a charge item.
@@ -137,30 +130,25 @@ The value set explicitly for &#x60;billing_cycles&#x60; while [applying the addo
         */
       
       delete(attached_item_id:string, input:DeleteInputParam):ChargebeeRequest<DeleteResponse>;
-    }
-    export interface RetrieveResponse {  
-       attached_item:AttachedItem;
-    }
-    export interface RetrieveInputParam {
        
       /**
-        * @description Retrieves details of an attached addon or a charge item.
+        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
 
         */
-        
-      parent_item_id:string;
+      
+      list(item_id:string, input?:ListInputParam):ChargebeeRequest<ListResponse>;
     }
-    export interface UpdateResponse {  
+    export interface CreateResponse {  
        attached_item:AttachedItem;
     }
-    export interface UpdateInputParam {
+    export interface CreateInputParam {
        
       /**
-        * @description The id of the parent item in the attachment relationship.
+        * @description The id of the addon or charge that is being attached to the plan-item.
 
         */
        
-      parent_item_id:string;
+      item_id:string;
        
       /**
         * @description The type of attachment for the addon. Only applicable for addon-items and is a required parameter as well for addon-items. \* recommended - The addon is recommended to go with the plan-item when using [Checkout](https://www.chargebee.com/docs/2.0/configure-inapp.html#fundamental-settings_recommending-addons-in-checkout) or [Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription). \* optional - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a &#x60;quantity&#x60; and &#x60;billing_cycles&#x60; for the addon, for when it is applied to subscriptions with the plan. \* mandatory - The addon is attached automatically to the subscription for the plan-item unless [explicitly removed](./subscriptions?prod_cat_ver&#x3D;2) via API.
@@ -206,146 +194,158 @@ The value set explicitly for &#x60;billing_cycles&#x60; while [applying the addo
        
       charge_once?:boolean;
     }
-    export interface ListResponse {  
+    export interface UpdateResponse {  
+       attached_item:AttachedItem;
+    }
+    export interface UpdateInputParam {
+       
       /**
-        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
+        * @description The id of the parent item in the attachment relationship.
 
         */
        
-       list:{attached_item:AttachedItem}[];
+      parent_item_id:string;
        
       /**
-        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
+        * @description The type of attachment for the addon. Only applicable for addon-items and is a required parameter as well for addon-items. \* recommended - The addon is recommended to go with the plan-item when using [Checkout](https://www.chargebee.com/docs/2.0/configure-inapp.html#fundamental-settings_recommending-addons-in-checkout) or [Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription). \* optional - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a &#x60;quantity&#x60; and &#x60;billing_cycles&#x60; for the addon, for when it is applied to subscriptions with the plan. \* mandatory - The addon is attached automatically to the subscription for the plan-item unless [explicitly removed](./subscriptions?prod_cat_ver&#x3D;2) via API.
 
         */
        
-       next_offset?:string;
-    }
-    export interface ListInputParam {
-      [key : string]: any;  
-      /**
-        * @description The number of resources to be returned.
-
-        */
-        
-      limit?:number;
+      type?:'optional' | 'mandatory' | 'recommended';
        
       /**
-        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
+        * @description The number of subscription billing cycles for which this item is attached when applied to a subscription. Applicable only for items of type addon. Requires [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html) to be enabled for the site.  
 
-        */
-        
-      offset?:string;
-       
-      /**
-        * @description Filter attached items based on their id.
+The value set explicitly for &#x60;billing_cycles&#x60; while [applying the addon to a subscription](./subscriptions?prod_cat_ver&#x3D;2#subscription_subscription_items) takes precedence over this parameter. This parameter, in turn, has a higher precedence than [the value set for the addon-item price](./item_prices?prod_cat_ver&#x3D;2).
 
         */
-        
-      id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      billing_cycles?:number;
        
       /**
-        * @description Filter attached items based on the &#x60;item_id&#x60; of the item being attached.
+        * @description The default quantity of the addon to be attached when the quantity is not specified while [creating](subscriptions?prod_cat_ver&#x3D;2#create_subscription_for_items)/[updating](subscriptions?prod_cat_ver&#x3D;2#update_subscription_for_items) the subscription.
 
         */
-        
-      item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      quantity?:number;
        
       /**
-        * @description Filter attached items based on the &#x60;type&#x60; of attached item. Possible values are : &#x60;recommended&#x60;, &#x60;mandatory&#x60;, &#x60;optional&#x60;.
+        * @description The decimal representation of the quantity of the addon. Returned for quantity-based addons when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
 
         */
-        
-      type?:{in?:string,is?:'optional' | 'mandatory' | 'recommended',is_not?:'optional' | 'mandatory' | 'recommended',not_in?:string};
+       
+      quantity_in_decimal?:string;
        
       /**
-        * @description To filter based on the type of of the attached item. Possible values are : &#x60;addon&#x60;, &#x60;charge&#x60;.
+        * @description Indicates when the item is charged. This parameter only applies to charge-items. \* contract_termination - when a contract term is [terminated](./subscriptions?prod_cat_ver&#x3D;2#cancel_subscription_for_items_contract_term_cancel_option). \* subscription_creation - the time of creation of the subscription. \* subscription_trial_start - the time when the trial period of the subscription begins. \* on_demand - Item can be charged on demand \* plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed. \* subscription_activation - the moment a subscription enters an &#x60;active&#x60; or &#x60;non-renewing&#x60; state. Also includes reactivations of canceled subscriptions.
 
         */
-        
-      item_type?:{in?:string,is?:'charge' | 'addon' | 'plan',is_not?:'charge' | 'addon' | 'plan',not_in?:string};
+       
+      charge_on_event?:ChargeOnEvent;
        
       /**
-        * @description Indicates when the item is charged. This attribute only applies to charge-items.
+        * @description Indicates if the charge-item is to be charged only once or each time the &#x60;charge_on_event&#x60; occurs. This parameter only applies to charge-items.
 
         */
-        
-      charge_on_event?:{in?:string,is?:'subscription_creation' | 'subscription_activation' | 'subscription_trial_start' | 'contract_termination' | 'plan_activation' | 'on_demand',is_not?:'subscription_creation' | 'subscription_activation' | 'subscription_trial_start' | 'contract_termination' | 'plan_activation' | 'on_demand',not_in?:string};
+       
+      charge_once?:boolean;
+    }
+    export interface RetrieveResponse {  
+       attached_item:AttachedItem;
+    }
+    export interface RetrieveInputParam {
        
       /**
-        * @description Filter attached items based on when the attached items were last updated.
+        * @description Retrieves details of an attached addon or a charge item.
 
         */
         
-      updated_at?:{after?:string,before?:string,between?:string,on?:string};
+      parent_item_id:string;
     }
-    export interface CreateResponse {  
+    export interface DeleteResponse {  
        attached_item:AttachedItem;
     }
-    export interface CreateInputParam {
+    export interface DeleteInputParam {
        
       /**
         * @description The id of the addon or charge that is being attached to the plan-item.
 
         */
        
-      item_id:string;
-       
+      parent_item_id:string;
+    }
+    export interface ListResponse {  
       /**
-        * @description The type of attachment for the addon. Only applicable for addon-items and is a required parameter as well for addon-items. \* recommended - The addon is recommended to go with the plan-item when using [Checkout](https://www.chargebee.com/docs/2.0/configure-inapp.html#fundamental-settings_recommending-addons-in-checkout) or [Portal](https://www.chargebee.com/docs/2.0/inapp-self-serve-portal.html#allow-change-subscription). \* optional - The addon is neither mandatory, nor recommended. This allows you to attach an addon so you can specify a &#x60;quantity&#x60; and &#x60;billing_cycles&#x60; for the addon, for when it is applied to subscriptions with the plan. \* mandatory - The addon is attached automatically to the subscription for the plan-item unless [explicitly removed](./subscriptions?prod_cat_ver&#x3D;2) via API.
+        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
 
         */
        
-      type?:'optional' | 'mandatory' | 'recommended';
+       list:{attached_item:AttachedItem}[];
        
       /**
-        * @description The number of subscription billing cycles for which this item is attached when applied to a subscription. Applicable only for items of type addon. Requires [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html) to be enabled for the site.  
-
-The value set explicitly for &#x60;billing_cycles&#x60; while [applying the addon to a subscription](./subscriptions?prod_cat_ver&#x3D;2#subscription_subscription_items) takes precedence over this parameter. This parameter, in turn, has a higher precedence than [the value set for the addon-item price](./item_prices?prod_cat_ver&#x3D;2).
+        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
 
         */
        
-      billing_cycles?:number;
-       
+       next_offset?:string;
+    }
+    export interface ListInputParam {
+      [key : string]: any;  
       /**
-        * @description The default quantity of the addon to be attached when the quantity is not specified while [creating](subscriptions?prod_cat_ver&#x3D;2#create_subscription_for_items)/[updating](subscriptions?prod_cat_ver&#x3D;2#update_subscription_for_items) the subscription.
+        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
 
         */
-       
-      quantity?:number;
+        
+      limit?:number;
        
       /**
-        * @description The decimal representation of the quantity of the addon. Returned for quantity-based addons when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
+        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
 
         */
-       
-      quantity_in_decimal?:string;
+        
+      offset?:string;
        
       /**
-        * @description Indicates when the item is charged. This parameter only applies to charge-items. \* contract_termination - when a contract term is [terminated](./subscriptions?prod_cat_ver&#x3D;2#cancel_subscription_for_items_contract_term_cancel_option). \* subscription_creation - the time of creation of the subscription. \* subscription_trial_start - the time when the trial period of the subscription begins. \* on_demand - Item can be charged on demand \* plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed. \* subscription_activation - the moment a subscription enters an &#x60;active&#x60; or &#x60;non-renewing&#x60; state. Also includes reactivations of canceled subscriptions.
+        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
 
         */
+        
+      id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
-      charge_on_event?:ChargeOnEvent;
+      /**
+        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
+
+        */
+        
+      item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description Indicates if the charge-item is to be charged only once or each time the &#x60;charge_on_event&#x60; occurs. This parameter only applies to charge-items.
+        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
 
         */
+        
+      type?:{in?:string,is?:'optional' | 'mandatory' | 'recommended',is_not?:'optional' | 'mandatory' | 'recommended',not_in?:string};
        
-      charge_once?:boolean;
-    }
-    export interface DeleteResponse {  
-       attached_item:AttachedItem;
-    }
-    export interface DeleteInputParam {
+      /**
+        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
+
+        */
+        
+      item_type?:{in?:string,is?:'charge' | 'addon' | 'plan',is_not?:'charge' | 'addon' | 'plan',not_in?:string};
        
       /**
-        * @description The id of the addon or charge that is being attached to the plan-item.
+        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
 
         */
+        
+      charge_on_event?:{in?:string,is?:'subscription_creation' | 'subscription_activation' | 'subscription_trial_start' | 'contract_termination' | 'plan_activation' | 'on_demand',is_not?:'subscription_creation' | 'subscription_activation' | 'subscription_trial_start' | 'contract_termination' | 'plan_activation' | 'on_demand',not_in?:string};
        
-      parent_item_id:string;
+      /**
+        * @description Returns a list of attached items satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
+
+        */
+        
+      updated_at?:{after?:string,before?:string,between?:string,on?:string};
     }
     
   }