Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 21, 11:00 UTC
docs: note that `premium_usage` objects re-enable a disabled Session (#4606)
This PR: - follows up on https://github.com/ComposioHQ/composio/pull/4604 (the Instant Tools guide) with fixes from the review of https://github.com/ComposioHQ/composio/pull/4599 - updates the `return_premium_charge` table row: on update, any `premium_usage` object, including one that only sets `return_premium_charge`, re-enables premium usage on a Session set to `false` - says the same in the patch paragraph - names the TypeScript result field, `premiumCharge`
Alberto Schiabel committed
Sep 24, 2026 at 10:44 UTC
5c392188ab561f4151373ea13aa864d4dd87ed84
1 file changed
+3
-3
docs/content/docs/instant-tools.mdx
+3
-3
@@ -104,7 +104,7 @@ Check the current [tool input schema](/reference/api-reference/tools/getToolsByT
104
105
The toolkit filter and per-tool filter intersect. A `tools.exa` rule alone does not disable premium usage for other eligible toolkits. Use `premium_usage.toolkits` when you need a toolkit allowlist. Each filter accepts either `enable` or `disable`, not both.
106
107
-The examples below use Python and REST field names. In TypeScript, use `premiumUsage` and `returnPremiumCharge`.
107
+The examples below use Python and REST field names. In TypeScript, use `premiumUsage` and `returnPremiumCharge`, and read the charge from `premiumCharge` on the tool result.
108
109
| Session value | Effect |
110
|---|---|
@@ -112,7 +112,7 @@ The examples below use Python and REST field names. In TypeScript, use `premiumU
112
| `false` | Disables premium usage for that Session. Your own connected-account routes remain available. |
113
| `{ "toolkits": { "enable": ["exa"] } }` | Permits premium usage only for listed toolkits. Use `disable` instead to exclude selected toolkits. |
114
| `{ "tools": { "exa": { "enable": ["EXA_SEARCH"] } } }` | Narrows premium usage to selected tools within a toolkit. |
115
-| `{ "return_premium_charge": true }` | Requests the actual `premium_charge` in an eligible Session tool response. This changes charge visibility, not permission to spend. |
115
+| `{ "return_premium_charge": true }` | Requests the actual `premium_charge` in an eligible Session tool response. On create, this changes charge visibility, not permission to spend. On update, it also re-enables premium usage on a Session set to `false`, like any other object. |
116
117
For example, keep Exa and Firecrawl available, but permit premium usage only for `EXA_SEARCH`:
118
@@ -159,7 +159,7 @@ await session.update({ premiumUsage: false });
159
</Tab>
160
</Tabs>
161
162
-On patch, omitted `premium_usage` fields keep their existing values. Supplying an object after `false` enables this Session policy again, provided the project allows it.
162
+On patch, omitted `premium_usage` fields keep their existing values. Supplying any object after `false`, even one that only sets `return_premium_charge`, enables this Session policy again, provided the project allows it.
163
164
## Know which account runs the tool
165