connacto
Back to Subscriptions

Subscriptions tools

Every tool in this module, with its full description, parameters, and return value. All of them require the module to be active first. See the Subscriptions overview for how to turn it on.

CRUD

Core tools

Create, read, update, and delete entries. Every module has exactly these four.

subscriptions_add_entry

Add an entry to the user's Subscriptions module. Requires the module to be active — see create_database.

Parameters

NameTypeRequiredNotes
servicestringYes
costnumberYes
catalog_idstringNoExact subscription_service_catalog.id from subscriptions_search_catalog, if already known. Skips automatic matching.
billing_cyclemonthly | annualNo
renewal_datestringNoISO date, e.g. 2026-08-20
categorystringNo
last_usedstringNoISO date, e.g. 2026-08-20

Returns

The created entry as JSON, including its id.

subscriptions_list_entries

List entries in the user's active Subscriptions module.

Parameters

NameTypeRequiredNotes
limitnumberNoMax entries to return (default 100, max 500).

Returns

Every entry in the active database, as a JSON array.

subscriptions_update_entry

Update fields on an existing Subscriptions entry.

Parameters

NameTypeRequiredNotes
entryIdstringYes
servicestringNo
catalog_idstringNoExact subscription_service_catalog.id from subscriptions_search_catalog. Skips automatic matching.
costnumberNo
billing_cyclemonthly | annualNo
renewal_datestringNo
categorystringNo
last_usedstringNo

Returns

The updated or deleted entry as JSON. Returns an error if entryId does not belong to an entry in the active database.

subscriptions_delete_entry

Delete an entry from the user's active Subscriptions module.

Parameters

NameTypeRequiredNotes
entryIdstringYes

Returns

The updated or deleted entry as JSON. Returns an error if entryId does not belong to an entry in the active database.

Specialized

Purpose-built tools

Shortcuts and queries shaped around how Subscriptions is actually used, so your agent doesn't have to fetch every entry and filter them itself.

subscriptions_attach_photo

Attach a photo to an existing Subscriptions entry (replacing any photo already on it). If you have the image's raw bytes, pass photo_base64. If the user attached the image in a chat client (e.g. claude.ai), you cannot read its bytes: call this WITHOUT photo_base64 to get a one-time upload link, and give that link to the user so they can upload the photo themselves. The link expires in 30 minutes. Photos are stored privately; the returned viewPath is only viewable signed into the connacto web app as this user.

Parameters

NameTypeRequiredNotes
entryIdstringYesID of the Subscriptions entry to attach the photo to.
photo_base64stringNoThe photo, base64-encoded (no data: URI prefix). Omit when you cannot read the image bytes — the tool then returns an upload link for the user instead.
photo_content_typeimage/jpeg | image/png | image/webp | image/heicNoMIME type of the photo, if photo_base64 is set. Defaults to image/jpeg.

Returns

JSON with a private viewPath when photo_base64 was given, or an uploadUrl to hand the user when it was not.

subscriptions_monthly_spend

Compute the total monthly-equivalent spend across all entries in the active Subscriptions module, normalizing annual subscriptions to a monthly cost (cost / 12), along with a per-entry breakdown.

Parameters

None. Call it with an empty object.

Returns

The total monthly spend plus a per-entry breakdown of monthly cost, as JSON.

subscriptions_upcoming_renewals

List entries in the active Subscriptions module whose renewal_date falls within the given number of days from today (default 30).

Parameters

NameTypeRequiredNotes
withinDaysnumberNoNumber of days from today to look ahead. Defaults to 30.

Returns

Matching entries as a JSON array.

subscriptions_search_catalog

Look up candidate services by name or alias when the exact match for an entry is unclear. Use the returned id as catalog_id in subscriptions_add_entry or subscriptions_update_entry.

Parameters

NameTypeRequiredNotes
querystringYesFree-text service name to search for, e.g. 'max' or 'spotify'.
categorystreaming | software | fitness | news | cloud-storage | gaming | otherNoRestrict results to this category.
limitnumberNoMax candidates to return (default 5, max 20).

Returns

Candidate services with their category, typical billing cycle, and match score, as a JSON array.

subscriptions_spend_by_category

Sum spend across the active Subscriptions module's entries, grouped by category. Uses the service catalog's category when an entry resolved to one, falling back to the entry's own free-text category field, then 'uncategorized'. Normalizes each entry's cost to a monthly or annualized figure per the period param.

Parameters

NameTypeRequiredNotes
periodmonthly | annualNoNormalize costs to this period (default monthly).

Returns

Per-category totals plus a grand total, as JSON.