--- page_title: List Add ons product: Juspay Billing page_source: https://juspay.io/in/docs/juspay-billing/docs/billing/list-add-ons openapi: https://juspay.io/in/docs/api/swagger?document=https%3A%2F%2Fjuspay.io%2Fin%2Fdocs%2Fjuspay-billing%2Fdocs%2Fbilling%2Flist-add-ons llms_txt: https://juspay.io/in/docs/llms.txt product_llms_txt: https://juspay.io/in/docs/juspay-billing/llms.txt --- ## API Version: default # List add ons / Remove add on ## Multiple APIs are available to help merchants fetch Add-on details. * These APIs allow retrieval of: * **Attached Add-ons** for a given **Plan ID** * **Available Add-ons** for a given **Plan ID** or **Billing Execution ID** * This enables merchants to validate and view applicable Add-ons before or after billing execution. * This will also help to delete an existing attached Add on against a beid## Endpoints: - Sandbox: https://sandbox.juspay.in/billing - Production: https://api.juspay.in/billing ## Request Type: POST ## Content-Type: application/json ## Authorization: #### Basic Auth: - Value: Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg== - Tags: Base64 Encoded Username:Password, Required ## Headers: #### Content-Type: - Value: application/x-www-form-urlencoded - Tags: String ## Sample Code Snippets: ### Sample Request: #### List possible add ons against a beid Request Code Snippet: ```list possible add ons against a beid request curl --location 'https://sandbox.juspay.in/billing' \ --header 'Authorization: Basic <> \ --header 'Content-Type: application/json' \ --data '{     "command": "list_possible_add_ons",     "billing_execution_info_id": "test07" }' ``` #### List possible add ons against a planId Request Code Snippet: ```list possible add ons against a planid request curl --location 'https://sandbox.juspay.in/billing' \ --header 'Authorization: Basic <> \ --header 'Content-Type: application/json' \ --data '{     "command": "list_possible_add_ons",     "plan_id": "planidTest" }' ``` #### List attached add ons against a beid Request Code Snippet: ```list attached add ons against a beid request curl --location 'https://sandbox.juspay.in/billing' \ --header 'Authorization: Basic <> \ --header 'Content-Type: application/json' \ --data '{     "command": "list_attached_add_ons",     "billing_execution_info_id": "test07" }' ``` #### Remove attached add on against a beid Request Code Snippet: ```remove attached add on against a beid request curl --location 'https://sandbox.juspay.in/billing' \ --header 'Authorization: Basic <> \ --header 'Content-Type: application/json' \ --data '{     "command": "remove_attached_add_on",     "billing_execution_info_id": "test07",     "metric_id" :3 }' ``` ### Sample Response: #### List possible add ons against a beid Response: ```plaintext { "list": [ { "status": "INACTIVE", "pricing_tier": { "unit_amount": 0, "up_to": "INFINITY", "flat_fee": 1 }, "name": "addOn1", "metric_id": 1, "description": "sample add on metric" }, { "status": "ACTIVE", "pricing_tier": { "unit_amount": 0, "up_to": "INFINITY", "flat_fee": 7 }, "name": "addOn2", "metric_id": 2, "description": "sample add on metric" }, { "status": "ACTIVE", "pricing_tier": { "unit_amount": 0, "up_to": "INFINITY", "flat_fee": 14 }, "name": "addOn3", "metric_id": 3, "description": "sample add on metric" }, { "status": "ACTIVE", "pricing_tier": { "unit_amount": 0, "up_to": "INFINITY", "flat_fee": 4 }, "name": "addOn4", "metric_id": 4, "description": "sample add on metric" } ], "total": 4, "object": "list" } ``` #### List possible add ons against a planId Response: ```plaintext { "list": [ { "status": "INACTIVE", "pricing_tier": { "unit_amount": 0, "up_to": "INFINITY", "flat_fee": 1 }, "name": "addOn1", "metric_id": 1, "description": "sample add on metric" }, { "status": "ACTIVE", "pricing_tier": { "unit_amount": 0, "up_to": "INFINITY", "flat_fee": 7 }, "name": "addOn2", "metric_id": 2, "description": "sample add on metric" }, { "status": "ACTIVE", "pricing_tier": { "unit_amount": 0, "up_to": "INFINITY", "flat_fee": 14 }, "name": "addOn3", "metric_id": 3, "description": "sample add on metric" }, { "status": "ACTIVE", "pricing_tier": { "unit_amount": 0, "up_to": "INFINITY", "flat_fee": 4 }, "name": "addOn4", "metric_id": 4, "description": "sample add on metric" } ], "total": 4, "object": "list" } ``` #### List attached add ons against a beid Response: ```plaintext { "list": [ { "status": "ACTIVE", "pricing_tier": { "unit_amount": 0, "up_to": "INFINITY", "flat_fee": 4 }, "name": "addOn4", "metric_id": 4, "metric_start": "2026-04-09 07:01:08", "description": "sample add on metric", "quantity": 2 } ], "total": 1, "object": "list" } ``` #### Remove attached add on against a beid Response: ```plaintext { "status": "SUCCESS", "message": "Removed the metric window for the giving metric id successfully", "command": "remove_attached_add_on", "mandate": { "gateway": "BILLDESK", "mandate_id": "9BExam13rQwi8fFcTnQBJ9", "status": "ACTIVE", "frequency": "ASPRESENTED", "last_updated": "2026-04-09T06:58:14Z", "start_date": "1775717830", "max_amount": 100, "block_fund": false, "currency": "INR", "payment_info": { "payment_method": "UPI_COLLECT", "upi": { "payer_vpa": "\"billdesk@upi\"" }, "payment_method_type": "UPI" }, "last_activated_at": "2026-04-09T06:58:14Z", "rule_value": 1, "amount_rule": "VARIABLE", "rule_type": "AFTER", "gateway_reference_id": "dfe", "revokable_by_customer": true, "order_id": "1775717809", "end_date": "1901948230", "billing_execution_info": { "source_object_id": "933", "status": "ACTIVE", "plan_info": { "plan_rule_value": 4, "plan_type": "PRE_DEBIT", "plan_model": "ADD_ON", "is_rule_value_variable": true, "is_rule_type_variable": true, "is_plan_amount_variable": false, "max_amount": 100, "plan_status": "ACTIVE", "plan_amount": 7, "plan_created_at": "2026-02-06 12:06:45", "plan_currency": "INR", "plan_interval": "WEEKLY", "attached_add_ons": [ { "status": "ACTIVE", "pricing_tier": { "unit_amount": 0, "up_to": "INFINITY", "flat_fee": 4 }, "name": "addOn4", "metric_id": 4, "metric_start": "2026-04-09 07:01:08", "description": "sample add on metric", "quantity": 3 } ], "plan_rule_type": "AFTER", "plan_name": "test plan for local testing", "plan_description": "Add on plan model + fixed amt", "plan_updated_at": "2026-02-06 12:06:45", "plan_id": "test07", "plan_action_on_failure": "REVOKE" }, "billing_execution_info_id": "12b7ffb1173446c0bdb1d91b42513298", "source_object": "MANDATE", "amount": 1 }, "mandate_debit_token": "tkn_e3ea3f79415a488bbc0d7301a948c405", "next_execution_info": { "next_execution_date": "2026-04-16T06:58:14.446279Z", "next_execution_order_id": "kmHnZx1EBE7ZmnZc" }, "customer_id": "cth_rPj21roNSjEbumSy", "activated_at": "2026-04-09T06:58:14Z", "mandate_token": "74333fb0bd7f471e973d3c1ad586ef82", "mandate_type": "EMANDATE" } } ``` ## Body Parameters: ### Basic Parameters: #### command: - Value: update_attached_add_ons - Tags: String #### billing_execution_info_id: - Value: unique billing execution info identifier - Tags: String #### plan_id: - Description: Need to send either Beid or Plan_id - Value: plan_id - Tags: String ## API Responses: ### 200: #### payment: - Value: - **Authentication**: - Value: - **Method**: - Value: GET - Tags: String - **Url**: - Value: https://sandbox.juspay.in/v2/pay/start/eulerqa_sandbox/mozFS1mNCmY96k3aHHp?cardIssuerBankName%3DUPI_COLLECT%26cardType%3DUPI%26paymentMethod%3DUPI_COLLECT%26paymentMethodType%3DUPI - Tags: String - Tags: Object - Tags: Object #### status: - Value: PENDING_VBV - Tags: String #### txn_uuid: - Value: mozFS1mNCmY96k3aHHp - Tags: String #### offer_details: - Value: - **Offers**: - Tags: Array - Tags: Object #### order_id: - Value: Ord_1765191076 - Tags: String #### txn_id: - Value: suc-Ord_1765191076-1 - Tags: String --- ## See Also - [Attach Add On](https://juspay.io/in/docs/juspay-billing/docs/billing/attach-add-on) - [Update Scheduling Time](https://juspay.io/in/docs/juspay-billing/docs/billing/update-scheduling-time)