[Ubiquiti UISP] Authorize a device that is waiting to be adopted, bringing it under UISP management. Provide deviceId from uisp_list_devices (pending devices appear there with an unauthorized status). This is a real state change on the device — UISP takes over its management connection and may apply configuration — so it is not something to run speculatively. Removing it again is uisp_delete_device.

[Ubiquiti UISP] DESTRUCTIVE: remove a device from UISP management, discarding its configuration backups, statistics history and site placement. Provide deviceId from uisp_list_devices. The hardware keeps running with its current configuration — this removes UISP's record of it, not the device itself — but everything UISP knew about it is gone and re-adopting it starts from nothing. Check what is behind it first with uisp_list_devices using this id as parentId: those devices lose their place in the topology too.

[Ubiquiti UISP] Get one device's full status and detail — model, firmware version and whether an upgrade is available, management connection state, IP addressing, uptime, signal and the site it belongs to. Provide deviceId from uisp_list_devices. Unpaginated single object.

[Ubiquiti UISP] Get one device's performance statistics over time — throughput, signal levels, CPU and memory, ping and errors. Provide deviceId from uisp_list_devices. Use this to investigate a link that customers report as slow before deciding whether to reboot anything.

[Ubiquiti UISP] List every MAC address UISP knows about, mapped to its device. Use this to identify a device from a MAC seen elsewhere — in a DHCP lease, a switch table or a support ticket — without scanning the whole device list. Unpaginated, whole-network.

[Ubiquiti UISP] List the wireless configurations across every managed device — the SSIDs in use and which device broadcasts each. Useful for auditing naming consistency or finding which radio serves a given SSID. Unpaginated, whole-network.

[Ubiquiti UISP] List the network devices UISP manages, with their status, model, firmware, IP, uptime and parent/site placement. This is the DISCOVERY TOOL for device ids — the id returned here is the deviceId every other uisp_ device tool takes. UNPAGINATED: UISP returns the entire collection in one response, which on a large ISP can be thousands of devices and may be truncated. Narrow it with siteId (from uisp_list_sites) or parentId (the id of an uplink device, to get everything behind it) rather than fetching everything and filtering afterwards.

[Ubiquiti UISP] Start flashing a device's locate LED so a technician can identify it physically on a tower or in a rack. Provide deviceId from uisp_list_devices. Affects only the LED — no traffic, configuration or service is touched. Reverse it with uisp_stop_locate_device.

[Ubiquiti UISP] Force UISP to re-read one device's state immediately instead of waiting for the next poll. Provide deviceId from uisp_list_devices. Use this when a device's reported status looks stale after a change was made on the device itself. It changes nothing on the device — it only refreshes what UISP has recorded.

[Ubiquiti UISP] DESTRUCTIVE: erase one device's accumulated statistics counters. Provide deviceId from uisp_list_devices. The history is discarded permanently — there is no undo and no export — so read anything you need with uisp_get_device_statistics first. Traffic and configuration are unaffected; only the recorded measurements are lost.

[Ubiquiti UISP] DESTRUCTIVE: reboot a live device. Provide deviceId from uisp_list_devices. Every customer behind this device loses their connection for the length of the reboot — on a tower radio or an uplink router that can be an entire neighbourhood, not one subscriber. Check what sits behind it first with uisp_list_devices using this device's id as parentId. The reboot cannot be cancelled once started.

[Ubiquiti UISP] Stop a device's locate LED flashing, reversing uisp_locate_device. Provide deviceId from uisp_list_devices. Affects only the LED.

[Ubiquiti UISP] Get an airCube access point's device-specific detail. Provide deviceId from uisp_list_devices; it must be an airCube.

[Ubiquiti UISP] Get an airCube's network configuration — addressing, VLANs and bridging. Provide deviceId from uisp_list_devices. Read-only: the matching write endpoint exists in UISP but is not exposed, because replacing an access point's network configuration remotely can strand it.

[Ubiquiti UISP] Get an airCube's system configuration — hostname, timezone and administrative settings. Provide deviceId from uisp_list_devices.

[Ubiquiti UISP] Get an airMAX radio's radio-specific detail — the wireless link data that uisp_get_device does not carry. Provide deviceId from uisp_list_devices; it must be an airMAX device.

[Ubiquiti UISP] Get one interface's full configuration and counters. Provide deviceId from uisp_list_devices and interfaceName from uisp_list_device_interfaces (for example eth0, eth0.100 or switch0 — pass it exactly as listed, dots and all).

[Ubiquiti UISP] Get which services are enabled on a device — SSH, SNMP, web management, discovery and similar. Provide deviceId from uisp_list_devices. Useful for auditing whether management services are exposed consistently across the fleet.

[Ubiquiti UISP] Get a device's system configuration — hostname, timezone, administrative settings and the like. Provide deviceId from uisp_list_devices. Read-only: UISP can also write these, but StackJack does not expose that.

[Ubiquiti UISP] Get how one device is configured to talk back to UISP — the management connection settings on the device itself. Provide deviceId from uisp_list_devices. Useful when a device shows as disconnected but is otherwise reachable: this shows what it has been told to connect to.

[Ubiquiti UISP] Get an EdgeRouter's router-specific detail, beyond what uisp_get_device returns for any device. Provide deviceId from uisp_list_devices — it must be an EdgeRouter; other device types are not served by this endpoint.

[Ubiquiti UISP] Get one DHCP server's full configuration on an EdgeRouter. Provide deviceId from uisp_list_devices and serverName from uisp_list_erouter_dhcp_servers.

[Ubiquiti UISP] Get an EdgeRouter's OSPF routing configuration. Provide deviceId from uisp_list_devices. Read-only for the same reason as the routes above.

[Ubiquiti UISP] List the frequency lists available to an airCube — the channels it may use. Provide deviceId from uisp_list_devices. Useful when planning around interference.

[Ubiquiti UISP] List the wireless clients currently associated with an airCube, with their signal levels. Provide deviceId from uisp_list_devices. Use this to check whether a subscriber's equipment is actually connected before investigating further upstream.

[Ubiquiti UISP] List the access point profiles defined in UISP — the reusable wireless configurations applied to APs. Unpaginated, whole-instance. Use this to see which standard configurations exist before comparing a device against them.

[Ubiquiti UISP] List a device's network interfaces with their addressing, VLAN and link state. This is the DISCOVERY TOOL for interface names — the name returned here is the interfaceName that uisp_get_device_interface takes. Provide deviceId from uisp_list_devices.

[Ubiquiti UISP] List the DHCP leases an EdgeRouter has issued — which MAC holds which address, and until when. Provide deviceId from uisp_list_devices. This is the fastest way to tie a customer complaint to a specific address, and pairs with uisp_list_device_macs to identify the hardware.

[Ubiquiti UISP] List the DHCP servers (scopes) configured on an EdgeRouter, with their subnets and ranges. This is the DISCOVERY TOOL for DHCP server names — the name returned here is the serverName that uisp_get_erouter_dhcp_server takes. Provide deviceId from uisp_list_devices.

[Ubiquiti UISP] List an EdgeRouter's OSPF areas and their settings. Provide deviceId from uisp_list_devices.

[Ubiquiti UISP] List an EdgeRouter's configured static routes. Provide deviceId from uisp_list_devices. Read-only — StackJack does not expose the endpoints that add, change or delete a route, because a wrong route disconnects everything behind the router.

[Ubiquiti UISP] DESTRUCTIVE: push a saved configuration back onto a live device, replacing whatever it is running now. Provide deviceId from uisp_list_devices and backupId from uisp_list_device_backups. Everything configured since that backup was taken is lost, the device typically restarts, and customers behind it drop while it does. If the backup predates a change to the device's own addressing or management settings, the device can come back unreachable. Confirm the backup's date with uisp_get_device_backup first, and take a fresh backup with uisp_create_device_backup so the current state is recoverable.

[Ubiquiti UISP] Take a fresh configuration backup of one device. Provide deviceId from uisp_list_devices. Additive and safe: it records the device's current configuration and changes nothing on the device. Worth running before any configuration work so there is a known-good snapshot to return to.

[Ubiquiti UISP] Take configuration backups of several devices in one call. Provide a JSON object body naming the devices to back up (device ids come from uisp_list_devices). Additive and safe: nothing on any device is changed. On a large fleet prefer a specific list over everything at once — each device is contacted individually.

[Ubiquiti UISP] DESTRUCTIVE: delete one saved configuration backup. Provide deviceId from uisp_list_devices and backupId from uisp_list_device_backups. The snapshot is gone permanently — if it was the last known-good configuration for that device, there is nothing to restore from afterwards. The device itself is untouched.

[Ubiquiti UISP] Get one configuration backup's metadata. Provide deviceId from uisp_list_devices and backupId from uisp_list_device_backups. Use this to confirm you have the backup you think you have — its date in particular — before running uisp_apply_device_backup.

[Ubiquiti UISP] List the configuration backups UISP holds for one device, with when each was taken. This is the DISCOVERY TOOL for backup ids — the id returned here is the backupId that uisp_get_device_backup, uisp_delete_device_backup and uisp_apply_device_backup take. Provide deviceId from uisp_list_devices.

[Ubiquiti UISP] DESTRUCTIVE: block an ONU, cutting that subscriber's internet connection immediately. Provide onuId from uisp_list_onus. This is a real service interruption for a paying customer — confirm you have the right ONU with uisp_get_onu first, since ONU ids are not human-readable. Reverse it with uisp_unblock_onu. If the intent is a billing suspension, use uisp_suspend_service instead so the CRM side stays consistent with the network side.

[Ubiquiti UISP] Create a new profile on an OLT. Provide oltId from uisp_list_olts and a JSON object body describing the profile — read an existing one with uisp_list_olt_profiles first to see the expected shape. Additive: a new profile affects nobody until an ONU is assigned to it.

[Ubiquiti UISP] DESTRUCTIVE: remove an OLT from UISP management, discarding its profiles, statistics and topology. Provide oltId from uisp_list_olts. This is the largest-blast-radius delete in the connector: an OLT carries every ONU on it, so check with uisp_list_onus using this id as parentId before running it. The hardware keeps running — this removes UISP's record — but the fibre network's structure in UISP is lost.

[Ubiquiti UISP] DESTRUCTIVE: delete a profile from an OLT. Provide oltId from uisp_list_olts and profile from uisp_list_olt_profiles. Check what is using it first — deleting a profile that ONUs are assigned to affects those subscribers' service.

[Ubiquiti UISP] DESTRUCTIVE: remove an ONU from UISP management, discarding its statistics and its place in the network. Provide onuId from uisp_list_onus. Use this when a unit has genuinely been decommissioned — for a subscriber who is merely leaving, end their billing service with uisp_end_service instead, which keeps the network record intact.

[Ubiquiti UISP] Get one OLT's status and detail, including its PON ports. Provide oltId from uisp_list_olts. When many ONUs on the same OLT report problems at once, start here rather than with the individual units.

[Ubiquiti UISP] Get one ONU's status and detail — optical signal levels, firmware, uptime and its OLT port. Provide onuId from uisp_list_onus. Optical receive power is the first thing to check on a fibre fault report.

[Ubiquiti UISP] List one OLT's profiles — the reusable bandwidth and service definitions applied to the ONUs on it. This is the DISCOVERY TOOL for profile names, which uisp_update_olt_profile and uisp_delete_olt_profile take. Provide oltId from uisp_list_olts.

[Ubiquiti UISP] List the UFiber OLTs — the operator-end fibre terminals every ONU connects through. This is the DISCOVERY TOOL for OLT ids, and an OLT's id is also the parentId that narrows uisp_list_onus to that OLT's subscribers. Unpaginated, whole-network.

[Ubiquiti UISP] List the client devices seen behind one ONU — what is connected inside the subscriber's premises. Provide onuId from uisp_list_onus. Use this to tell an empty connection apart from a busy one when a subscriber reports an outage.

[Ubiquiti UISP] List the UFiber ONUs (the units in subscribers' premises) with their status, signal and the OLT they are connected to. This is the DISCOVERY TOOL for ONU ids. UNPAGINATED — narrow it with siteId (from uisp_list_sites) or parentId (an OLT's device id, to list only the ONUs on that OLT) rather than pulling the whole network.

[Ubiquiti UISP] DESTRUCTIVE: erase one ONU's accumulated statistics counters. Provide onuId from uisp_list_onus. The history is discarded permanently with no undo — read anything you need first. The connection itself is unaffected; only the recorded measurements are lost, which matters when the counters are the evidence for an intermittent fault.

[Ubiquiti UISP] Restore service to a blocked ONU, reversing uisp_block_onu. Provide onuId from uisp_list_onus. This gives a subscriber their connection back — it is the recovery action, not a disruptive one. Note that if the subscriber was blocked because their UISP billing service is suspended, the CRM side may block them again; clear the suspension with uisp_cancel_service_suspension instead.

[Ubiquiti UISP] DESTRUCTIVE: replace an OLT profile's settings. Provide oltId from uisp_list_olts, profile from uisp_list_olt_profiles, and a JSON object body. Two reasons this is not a light edit: the body REPLACES the profile wholesale, so any setting you omit is cleared rather than left alone — send the complete profile, reading the current one from uisp_list_olt_profiles first; and the change applies to EVERY ONU already using this profile, so a wrong bandwidth value re-rates every subscriber on it at once.

[Ubiquiti UISP] DESTRUCTIVE: push a firmware upgrade to an ONU. Provide onuId from uisp_list_onus. The subscriber loses their connection while it installs and reboots, and a failed flash can leave the unit needing a physical visit. Firmware cannot be rolled back from here. Check the current version with uisp_get_onu first, and prefer a maintenance window.

[Ubiquiti UISP] Create a new site. Provide a JSON object body with the site's details — name, address and coordinates at minimum; read an existing site with uisp_get_site to see the full shape. Additive: a new site is an empty location record that affects nothing until devices are placed at it.

[Ubiquiti UISP] DESTRUCTIVE: delete a site. Provide siteId from uisp_list_sites. Check what is at the site first with uisp_list_devices using this id as siteId: deleting a site with devices at it removes their location, their attached photographs and any survey record, and the billing side may reference the site through a bound subscriber service. There is no undo.

[Ubiquiti UISP] Get one site's full detail — address, coordinates, contact information, elevation and status. Provide siteId from uisp_list_sites.

[Ubiquiti UISP] List the metadata for the photographs attached to a site — names, descriptions and ordering, as recorded during installs and surveys. Provide siteId from uisp_list_sites. This returns the records only, not the image data.

[Ubiquiti UISP] List the sites in UISP — towers, points of presence and subscriber locations — with their addresses, coordinates and status. This is the DISCOVERY TOOL for site ids, and a site id is the siteId filter that keeps the unpaginated uisp_list_devices and uisp_list_onus responses to a workable size. Start here when working on a network you do not already know.

[Ubiquiti UISP] DESTRUCTIVE: replace a site's details. Provide siteId from uisp_list_sites and a JSON object body. This REPLACES the site record rather than patching it — any field you omit is cleared, not left alone — so read the current site with uisp_get_site and send it back with your changes applied. Losing a site's coordinates or address is not merely cosmetic: installation and field-job routing depend on them.

[Ubiquiti UISP] Get the UISP instance's own settings — how it is configured to run. Read-only: StackJack does not expose the matching write, because changing a live UISP server's settings from a chat tool is server administration rather than network operations.

[Ubiquiti UISP] Get network-wide statistics over a time interval. The interval is REQUIRED and must be exactly one of hour, day or month — UISP rejects the call without it, so there is no default. Use hour for a live incident, day for recent trends and month for capacity planning.

[Ubiquiti UISP] Get the whole-network summary — device and site counts, how many devices are online, disconnected or unauthorized, and outstanding firmware updates. This is the cheapest overall health check and the right first call when asked how the network is doing.

[Ubiquiti UISP] Get the UISP server's own software version and whether an update is available. This is about UISP itself, not device firmware — for that use uisp_list_firmwares. Read-only: triggering the update is not exposed.

[Ubiquiti UISP] List devices UISP has discovered on the network but that are not yet managed. Use this to find newly installed equipment waiting to be adopted; adopt one with uisp_authorize_device.

[Ubiquiti UISP] List the device firmware images UISP holds, by platform and version. Use this to see which versions are available before upgrading anything, and to spot devices running something no longer in the inventory. This is device firmware — the UISP server's own version is uisp_get_nms_update_status.

[Ubiquiti UISP] List UISP's system log entries — device connections and disconnections, configuration changes, alerts and administrative actions. Narrow it with siteId (from uisp_list_sites) or deviceId (from uisp_list_devices); unfiltered, a busy network produces a very large response.

[Ubiquiti UISP] List recorded network outages — when devices went down, for how long, and whether they have recovered. Narrow it with siteId (from uisp_list_sites) or deviceId (from uisp_list_devices). This is the tool for questions about reliability history and for telling a one-off from a recurring fault.

[Ubiquiti UISP] DESTRUCTIVE: cancel a running task. Provide taskId from uisp_list_tasks. Cancelling a mass firmware upgrade part-way leaves the fleet on MIXED versions — devices already upgraded stay upgraded, the rest do not — and a device mid-flash at the moment of cancellation may be left needing attention. Check what has already completed with uisp_get_task first. There is no resume; the remainder has to be started again from UISP.

[Ubiquiti UISP] Get the per-device detail inside one task — for a mass upgrade, which devices succeeded, which failed and which are still pending. Provide taskId from uisp_list_tasks. Paginated with mandatory count and page (defaults 100 and 1), because a mass upgrade can cover the whole fleet.

[Ubiquiti UISP] List UISP's background tasks — mass firmware upgrades and similar long-running jobs — with their status and progress. This is the DISCOVERY TOOL for task ids. Unlike the rest of the UISP network surface this endpoint IS paginated, and its paging is mandatory: count and page are always sent (defaults 100 and 1). Optionally filter by status to see only what is still running.

[Ubiquiti UISP] Create a staff account with access to UISP. Provide a JSON object body with the user's details and role — read an existing user from uisp_list_operator_users to see the shape. This GRANTS access to the ISP's management system, so it is treated as a privileged action rather than an ordinary create: the new account can reach the network the role allows, and UISP typically emails the person an invitation. Check the role carefully before running it.

[Ubiquiti UISP] DESTRUCTIVE: delete a staff account, revoking its access to UISP immediately. Provide userId from uisp_list_operator_users. There is no undo — the account has to be created again and the person re-invited — and deleting the last administrator can lock the organisation out of its own UISP instance. Confirm the account with uisp_list_operator_users first.

[Ubiquiti UISP] List the staff accounts that can sign in to UISP, with their roles and status. These are the ISP's own operators, NOT its subscribers — for customers use uisp_list_clients. This is the DISCOVERY TOOL for operator user ids, and the right tool for an access review.

[Ubiquiti UISP] Resend the UISP invitation email to a staff account that has not finished signing up. Provide userId from uisp_list_operator_users. This SENDS REAL EMAIL to a real person and cannot be recalled once delivered, so check you have the right user — and that they have not already activated — before running it.

[Ubiquiti UISP] DESTRUCTIVE: replace a staff account's details and role. Provide userId from uisp_list_operator_users and a JSON object body. Two reasons for care: the body REPLACES the record, so any field you omit is cleared rather than left alone — read the current user first and send it back with your changes applied; and the record includes the ROLE, so a careless update can widen or remove someone's access to the whole management system.

[Ubiquiti UISP] Attach a tag to a subscriber. Provide clientId from uisp_list_clients and tagId from uisp_list_client_tags. A reversible label with no billing or service effect; remove it again with uisp_remove_client_tag.

[Ubiquiti UISP] DESTRUCTIVE: archive a subscriber, removing them from the active customer list. Provide clientId from uisp_list_clients. Archiving is how a former customer is retired — their billing history is kept — but it changes how the account behaves everywhere in UISP and is not an ordinary edit. End their subscription first with uisp_end_service; archiving is not itself a way to stop billing.

[Ubiquiti UISP] Create a new subscriber record. Provide a JSON object body with their details — read an existing subscriber with uisp_get_client to see the shape, including which organization the account belongs to. Additive: the new record bills nobody and affects no service until a subscription is added with uisp_create_service. It does not email the subscriber; that is uisp_send_client_invitation.

[Ubiquiti UISP] Add a note to a subscriber's activity log. Provide a JSON object body including the subscriber id (from uisp_list_clients) and the note. Additive: it records what happened and changes nothing about the account. Use it to leave an audit trail when acting on an account.

[Ubiquiti UISP] DESTRUCTIVE: delete a subscriber and everything hanging off them — services, invoices, payments and log history. Provide clientId from uisp_list_clients. This destroys billing records that an ISP normally has to retain, and it cannot be undone. For a customer who is simply leaving, use uisp_end_service and then uisp_archive_client instead, which keeps the financial history intact. Only delete a record created in error.

[Ubiquiti UISP] DESTRUCTIVE: delete a client log entry permanently. Provide logId from uisp_list_client_logs. There is no undo, and these entries are often the only record of what was agreed with a customer — on a disputed account, deleting one destroys the evidence.

[Ubiquiti UISP] Work out map coordinates for a subscriber from the address already on their record. Provide clientId from uisp_list_clients. This fills in derived data and changes nothing the operator entered; run it after correcting an address so the subscriber appears in the right place on the map.

[Ubiquiti UISP] Get one subscriber's full record — contact details, billing address, account balance, tags, custom attributes and status. Provide clientId from uisp_list_clients. Read this before any change to the account, and note the balance: it is what tells an overdue subscriber from a current one.

[Ubiquiti UISP] Get one client log entry in full. Provide logId from uisp_list_client_logs.

[Ubiquiti UISP] List the client activity log — the notes and recorded events staff have attached to subscriber accounts. Paginated with limit and offset (default 100, maximum 1000). Narrow to one subscriber with clientId from uisp_list_clients. This is where the history of a disputed account usually lives.

[Ubiquiti UISP] List the ISP's subscribers with their contact details, account balance and status. This is the DISCOVERY TOOL for client ids — the id returned here is the clientId that filters uisp_list_services, uisp_list_invoices, uisp_list_payments, uisp_list_quotes and uisp_list_credit_notes. Paginated with limit and offset (default 100 per page, maximum 1000). Optionally scope to one organization from uisp_list_organizations when the ISP bills under more than one legal entity.

[Ubiquiti UISP] Remove a tag from a subscriber, reversing uisp_add_client_tag. Provide clientId from uisp_list_clients and tagId from uisp_list_client_tags. This detaches the label only — the tag itself and the subscriber are untouched.

[Ubiquiti UISP] Email a subscriber an invitation to the UISP customer portal. Provide clientId from uisp_list_clients. This SENDS REAL EMAIL to a paying customer and cannot be recalled once delivered — check the address on their record with uisp_get_client first, and check they have not already signed up.

[Ubiquiti UISP] Update a subscriber's details. Provide clientId from uisp_list_clients and a JSON object body with ONLY the fields you want to change — this is a partial update, so anything you omit is left as it is. Contact and address edits only; it does not touch their services, invoices or balance.

[Ubiquiti UISP] Edit an existing client log entry. Provide logId from uisp_list_client_logs and a JSON object body with only the fields to change — this is a partial update, so omitted fields are left alone.

[Ubiquiti UISP] Store a bank account against a subscriber for direct-debit collection. Provide clientId from uisp_list_clients and a JSON object body with the account details. Additive: storing the account does not itself collect anything. Only enter details the customer has authorised you to hold.

[Ubiquiti UISP] Add a contact to a subscriber's account. Provide clientId from uisp_list_clients and a JSON object body with the contact's name, email and phone — model it on an entry from uisp_list_client_contacts. Additive, and it does not email anyone by itself; note that a contact marked to receive billing email will receive future invoices.

[Ubiquiti UISP] Create a new tag in the vocabulary. Provide a JSON object body with its name and colour. Additive: a new tag is attached to nobody until uisp_add_client_tag is used.

[Ubiquiti UISP] Define a new custom attribute for subscriber or service records. Provide a JSON object body with its name and type. Additive: a new attribute is empty on every existing record until someone fills it in.

[Ubiquiti UISP] DESTRUCTIVE: delete a stored bank account permanently. Provide bankAccountId from uisp_list_client_bank_accounts. Future direct debits from that account stop, so a subscriber on automatic collection starts accruing unpaid invoices instead — check whether it is their only payment route first. The details cannot be recovered; the customer has to supply them again.

[Ubiquiti UISP] DESTRUCTIVE: delete a contact from a subscriber's account permanently. Provide contactId from uisp_list_client_contacts. If that contact was the one receiving billing email, future invoices stop reaching them — check with uisp_get_client_contact first, and remember contact ids are global, so an id from the wrong list deletes a different subscriber's contact.

[Ubiquiti UISP] DESTRUCTIVE: delete a tag from the vocabulary. Provide tagId from uisp_list_client_tags. It is removed from EVERY subscriber currently carrying it, so any grouping or reporting that relied on it is lost across the whole customer base. To remove it from one subscriber only, use uisp_remove_client_tag instead.

[Ubiquiti UISP] DESTRUCTIVE: delete a custom attribute definition. Provide attributeId from uisp_list_custom_attributes. Every VALUE stored in that attribute across every subscriber and service record is discarded with it — if the ISP used it to hold something like an installation reference or a pole number, that data is gone from the whole customer base with no undo.

[Ubiquiti UISP] Get one stored bank account's details. Provide bankAccountId from uisp_list_client_bank_accounts. Sensitive financial data; bank-account ids are global rather than per-subscriber, so take the id from that client-scoped list.

[Ubiquiti UISP] Get one contact's details. Provide contactId from uisp_list_client_contacts. Contact ids are global rather than per-subscriber, so take the id from that client-scoped list rather than guessing.

[Ubiquiti UISP] Get one tag's definition. Provide tagId from uisp_list_client_tags.

[Ubiquiti UISP] Get one custom attribute definition. Provide attributeId from uisp_list_custom_attributes.

[Ubiquiti UISP] List the bank accounts stored against one subscriber for direct-debit collection. This is the DISCOVERY TOOL for bank-account ids. Provide clientId from uisp_list_clients. Treat the response as sensitive financial data.

[Ubiquiti UISP] List the additional contacts on one subscriber's account — the people beyond the primary contact who may be emailed or called. This is the DISCOVERY TOOL for contact ids. Provide clientId from uisp_list_clients.

[Ubiquiti UISP] List the tag vocabulary — the labels available to categorise subscribers. This is the DISCOVERY TOOL for tag ids, which uisp_add_client_tag and uisp_remove_client_tag take.

[Ubiquiti UISP] List the custom attribute definitions — the extra fields this ISP has added to subscriber and service records. Read this to understand any non-standard fields appearing in uisp_get_client output.

[Ubiquiti UISP] Update a stored bank account's details. Provide bankAccountId from uisp_list_client_bank_accounts and a JSON object body with only the fields to change. A partial update, but take care: this is the account direct debits are collected from, so a wrong number sends a real collection to the wrong place. Confirm with the customer before changing it.

[Ubiquiti UISP] Update a contact's details. Provide contactId from uisp_list_client_contacts and a JSON object body with only the fields to change — a partial update, so omitted fields are left alone.

[Ubiquiti UISP] Rename or recolour a tag. Provide tagId from uisp_list_client_tags and a JSON object body with only the fields to change. The subscribers already carrying the tag keep it — only the label's own definition changes.

[Ubiquiti UISP] Update a custom attribute's definition. Provide attributeId from uisp_list_custom_attributes and a JSON object body with only the fields to change. Renaming is safe; changing the TYPE of an attribute that already holds values on live records is not, so check what uses it first.

[Ubiquiti UISP] Accept a service change request, applying it to the live subscription. Provide requestId from uisp_list_service_change_requests. This is the agreed outcome of something the customer asked for, which is why it does not prompt — but it does re-rate their subscription and change their speed, so read the request with uisp_get_service_change_request first to confirm it says what you expect.

[Ubiquiti UISP] Turn a quoted service into a live subscription. Provide serviceId from uisp_list_services (the service will be in a quoted state). This is the step that begins service and billing on something the customer has already agreed to, so it takes nothing away — but it does start charging them, so confirm the quote is accepted first.

[Ubiquiti UISP] DESTRUCTIVE: link a billing subscription to a network site. Provide serviceId from uisp_list_services and a JSON object body naming the site (from uisp_list_sites). This is the ONE place UISP's two halves meet: the binding is what lets a billing suspension actually cut the connection, and what ties usage on the network to the right invoice. Binding to the WRONG site therefore points enforcement at the wrong customer — check both ids first. Re-binding replaces any existing link.

[Ubiquiti UISP] Lift a suspension and restore a customer's internet, reversing uisp_suspend_service. Provide serviceId from uisp_list_services. This is the recovery action — it gives a paying customer their connection back — which is why it does not prompt for approval. Billing resumes as normal.

[Ubiquiti UISP] DESTRUCTIVE: remove a subscription's speed override, returning it to the plan's own limits. Provide serviceId from uisp_list_services. This is not always a restoration: the override may be a deliberate arrangement the customer is paying for, and clearing it changes what they receive. Check the current override with uisp_get_service before removing it. The previous values are not kept and have to be re-entered by hand.

[Ubiquiti UISP] Record a block of prepaid service. Provide a JSON object body naming the service (from uisp_list_services) and the period covered. Additive: it credits the customer with service they have paid for.

[Ubiquiti UISP] Add a subscription to a customer. Provide clientId from uisp_list_clients and a JSON object body naming the service plan (from uisp_list_service_plans) and the start date — model it on an existing service from uisp_get_service. Additive: it takes nothing away from the customer. It DOES start billing them on the plan's schedule, so check the plan and price are the ones intended.

[Ubiquiti UISP] Raise a service change request. Provide a JSON object body naming the service (from uisp_list_services) and the plan to move to (from uisp_list_service_plans). Additive and inert: a request changes nothing until it is accepted with uisp_accept_service_change_request.

[Ubiquiti UISP] Add a recurring surcharge to a subscription. Provide serviceId from uisp_list_services and a JSON object body naming the surcharge (from uisp_list_surcharges) and its amount. Additive and removable — but it does INCREASE what a real customer pays every billing period, so confirm it was agreed.

[Ubiquiti UISP] Define a new suspension reason. Provide a JSON object body with its name. Additive: it suspends nobody and only becomes a category available when a service is suspended.

[Ubiquiti UISP] DESTRUCTIVE: delete a prepaid service period. Provide periodId from uisp_list_prepaid_service_periods. This removes the record of service the customer has ALREADY PAID FOR — they can then be billed again for a period they have settled, and the evidence that they paid is gone. Read it with uisp_get_prepaid_service_period first.

[Ubiquiti UISP] DESTRUCTIVE: delete a subscription outright, discarding its billing history along with it. Provide serviceId from uisp_list_services. This is not how a customer leaves — for that use uisp_end_service, which closes the subscription and KEEPS the financial record an ISP normally has to retain. Delete only a service created in error. There is no undo.

[Ubiquiti UISP] DESTRUCTIVE: discard a pending service change request. Provide requestId from uisp_list_service_change_requests. The customer's request is dropped without being applied and without them being told — from their side it simply never happens. Read it with uisp_get_service_change_request first, and consider telling the customer.

[Ubiquiti UISP] DESTRUCTIVE: remove a recurring surcharge from a subscription. Provide surchargeId from uisp_list_service_surcharges. The customer stops being charged it from the next period — which is revenue the ISP no longer collects, and if the surcharge covered rented equipment they still hold, it stops being billed for. There is no undo other than adding it again.

[Ubiquiti UISP] DESTRUCTIVE: delete a suspension reason from the vocabulary. Provide reasonId from uisp_list_suspension_reasons. Services currently suspended under it lose their recorded reason, which is what an audit or a customer dispute relies on. Check what is using it first.

[Ubiquiti UISP] DESTRUCTIVE: end a subscription — terminate the customer's service and stop billing it. Provide serviceId from uisp_list_services. This is the permanent version of a suspension: it closes the subscription rather than pausing it, and re-instating the customer means creating a new service and possibly a new installation. Confirm with uisp_get_service that this is the right customer, and prefer uisp_suspend_service when the situation might be resolved.

[Ubiquiti UISP] Work out map coordinates for a service from the address already on it. Provide serviceId from uisp_list_services. Fills in derived data only; useful so the subscription appears in the right place for field-job routing.

[Ubiquiti UISP] Get one prepaid service period's detail. Provide periodId from uisp_list_prepaid_service_periods.

[Ubiquiti UISP] Get one subscription's full detail — plan, price, billing period, status, suspension state and the network site it is bound to. Provide serviceId from uisp_list_services. Service ids are bare numbers with nothing human-readable in them, so this read is the only way to confirm which customer a suspend, end or re-rate will touch.

[Ubiquiti UISP] Get one change request in full — which service, which plan is being moved from and to, and when. Provide requestId from uisp_list_service_change_requests. Read this before accepting: accepting applies the change to a live subscription.

[Ubiquiti UISP] Get a subscription's data usage as at a given point in time. Provide serviceId from uisp_list_services and datetime as the timestamp to report against. Use this to check a customer against a data allowance before acting on an over-usage alert.

[Ubiquiti UISP] Get one service surcharge's detail. Provide surchargeId from uisp_list_service_surcharges.

[Ubiquiti UISP] Get one suspension reason's definition. Provide reasonId from uisp_list_suspension_reasons.

[Ubiquiti UISP] List prepaid service periods — the blocks of service customers have paid for in advance. This is the DISCOVERY TOOL for prepaid period ids. Paginated with limit and offset (default 100, maximum 1000).

[Ubiquiti UISP] List pending service change requests — plan changes customers have asked for through the portal, waiting for the ISP to accept. This is the DISCOVERY TOOL for change request ids. Paginated with limit and offset (default 100, maximum 1000).

[Ubiquiti UISP] List the recurring surcharges on one subscription — equipment rental, static IP fees and similar extras added to the plan price. This is the DISCOVERY TOOL for service-surcharge ids. Provide serviceId from uisp_list_services. Read this when a customer queries why their bill is higher than the advertised plan.

[Ubiquiti UISP] List subscriber services — each one a customer's internet subscription, with its plan, price, status and active dates. This is the DISCOVERY TOOL for service ids, which nearly every other billing tool takes. Paginated with limit and offset (default 100, maximum 1000). Narrow to one customer with clientId from uisp_list_clients.

[Ubiquiti UISP] List the suspension reasons this ISP has defined — the categories attached to a suspended service, such as non-payment or customer request. This is the DISCOVERY TOOL for suspension reason ids.

[Ubiquiti UISP] DESTRUCTIVE: override a subscription's speed limits, ignoring what its plan allows. Provide serviceId from uisp_list_services and a JSON object body with the upload and download limits. This directly changes what a paying customer receives — set too low it is a throttle they will notice immediately, set too high it gives away bandwidth they are not paying for. Remove the override again with uisp_clear_service_traffic_shaping, which returns them to their plan's speeds.

[Ubiquiti UISP] DESTRUCTIVE: suspend a subscription, cutting that customer's internet. Provide serviceId from uisp_list_services. The interruption is real and usually immediate — UISP enforces it at the network layer — and for a household it may take out their phone and alarm as well. Confirm the customer and their balance with uisp_get_service and uisp_get_client first; a suspension raised on a misread balance is the single most damaging mistake available in this connector. Reverse it with uisp_cancel_service_suspension.

[Ubiquiti UISP] DESTRUCTIVE: sever the link between a billing subscription and its network site. Provide serviceId from uisp_list_services. Afterwards a billing suspension on this service no longer cuts the connection and network usage no longer maps to the invoice — the customer keeps their internet whatever their account does. That silent decoupling is the danger: nothing else reports it. Check the current binding with uisp_get_service first.

[Ubiquiti UISP] DESTRUCTIVE: change a live subscription. Provide serviceId from uisp_list_services and a JSON object body with only the fields to change. This is a partial update, but what it updates is what a paying customer is CHARGED and what speed they receive: changing the plan or price re-rates them from the next invoice, and changing the billing period shifts when they are billed. Read the current state with uisp_get_service first and confirm the customer agreed to the change.

[Ubiquiti UISP] DESTRUCTIVE: change a surcharge on a live subscription. Provide surchargeId from uisp_list_service_surcharges and a JSON object body with only the fields to change. This alters what a paying customer is charged every period, from their next invoice onwards — read the current value with uisp_get_service_surcharge and confirm the change was agreed.

[Ubiquiti UISP] Rename a suspension reason. Provide reasonId from uisp_list_suspension_reasons and a JSON object body with only the fields to change. Services already suspended under it keep their suspension.

[Ubiquiti UISP] Put a service plan into a group. Provide planId from uisp_list_service_plans and groupId from uisp_list_service_plan_groups. Organisational only — it changes no price, speed or subscriber — and uisp_remove_service_plan_from_group undoes it.

[Ubiquiti UISP] Create a one-off product — hardware, an installation fee or similar. Provide a JSON object body with its name, price and tax treatment. Additive: it charges nobody until it is added to an invoice.

[Ubiquiti UISP] Create a new service plan. Provide a JSON object body with its name, speeds, price and billing period — model it on an existing plan from uisp_get_service_plan. Additive: a new plan bills nobody until a subscription is placed on it with uisp_create_service.

[Ubiquiti UISP] Create a service plan group. Provide a JSON object body with its name. Additive and organisational: an empty group contains no plans and affects no subscriber.

[Ubiquiti UISP] DESTRUCTIVE: delete a one-off product from the catalogue. Provide productId from uisp_list_products. Invoices that already include it keep their line items, but the product can no longer be added to new ones and has to be recreated by hand if it is needed again.

[Ubiquiti UISP] DESTRUCTIVE: delete a service plan. Provide planId from uisp_list_service_plans. Check its subscriber count with uisp_get_service_plan_statistics first: deleting a plan that subscriptions are on affects every one of them, and the tariff cannot be recreated identically afterwards. To retire a plan gracefully, stop selling it and leave existing subscribers on it instead.

[Ubiquiti UISP] DESTRUCTIVE: delete a service plan group. Provide groupId from uisp_list_service_plan_groups. The plans themselves survive — this deletes the grouping, not the tariffs — but any organisation or customer-portal presentation that relied on it is lost.

[Ubiquiti UISP] Get one product's definition — price, tax treatment and description. Provide productId from uisp_list_products.

[Ubiquiti UISP] Get one service plan's full definition — speeds, price, billing period, tax treatment and data allowance. Provide planId from uisp_list_service_plans.

[Ubiquiti UISP] Get one service plan group's definition. Provide groupId from uisp_list_service_plan_groups.

[Ubiquiti UISP] Get subscriber counts and totals per service plan. Use this to see which tariffs the customer base actually sits on — and, before changing or deleting a plan, exactly how many subscribers that change would reach.

[Ubiquiti UISP] List one-off products — hardware, installation fees and other items that can be added to an invoice, as distinct from recurring plans. This is the DISCOVERY TOOL for product ids. Paginated with limit and offset (default 100, maximum 1000).

[Ubiquiti UISP] List the service plan groups — how the ISP organises its tariffs, for example residential against business. This is the DISCOVERY TOOL for group ids.

[Ubiquiti UISP] List the ISP's service plans — the tariffs with their speeds, prices and billing periods. This is the DISCOVERY TOOL for service plan ids, which uisp_create_service and the change-request tools take. Paginated with limit and offset (default 100, maximum 1000).

[Ubiquiti UISP] List the service plans that use one billing period. Provide periodId as returned on plan records. Useful when checking which tariffs share a billing cycle before changing that cycle.

[Ubiquiti UISP] Take a service plan out of a group, reversing uisp_add_service_plan_to_group. Provide planId from uisp_list_service_plans and groupId from uisp_list_service_plan_groups. Organisational only — the plan itself and every subscriber on it are untouched.

[Ubiquiti UISP] Update a one-off product. Provide productId from uisp_list_products and a JSON object body with only the fields to change. A price change applies to invoices raised from now on; invoices already issued keep the price they were issued at.

[Ubiquiti UISP] DESTRUCTIVE: change a service plan. Provide planId from uisp_list_service_plans and a JSON object body with only the fields to change. A plan is SHARED: changing its price re-rates every subscriber on it from their next invoice, and changing its speeds changes what all of them receive. Check how many that is with uisp_get_service_plan_statistics before running it — this is the widest-reaching billing change in the connector, and it does not ask each customer individually.

[Ubiquiti UISP] Rename a service plan group. Provide groupId from uisp_list_service_plan_groups and a JSON object body with only the fields to change. Organisational only.

[Ubiquiti UISP] DESTRUCTIVE: approve a draft invoice, turning it into an issued one. Provide invoiceId from uisp_list_invoices. This is a ONE-WAY DOOR: an approved invoice takes its permanent number, becomes a live financial document and is added to what the customer owes. It cannot be returned to draft — the only reversal is uisp_void_invoice, which is itself a permanent accounting entry. Check every figure with uisp_get_invoice and uisp_list_invoice_items first.

[Ubiquiti UISP] Create an invoice for a subscriber. Provide clientId from uisp_list_clients and a JSON object body with the line items. The invoice is created as a DRAFT — nothing is issued to the customer and nothing is sent — so this is safe to do and review. Making it real takes two further, deliberate steps: uisp_approve_invoice then uisp_send_invoice. Preview the figures without creating anything using uisp_preview_invoice.

[Ubiquiti UISP] DESTRUCTIVE: delete an invoice outright. Provide invoiceId from uisp_list_invoices. This ERASES a financial record an ISP is normally required to retain, leaving a gap in the invoice sequence that an audit will find. For an invoice that should not stand, use uisp_void_invoice instead — it cancels the amount while keeping the record. Delete only a draft raised in error, and confirm the status with uisp_get_invoice first.

[Ubiquiti UISP] DESTRUCTIVE: delete a line item from an invoice, reducing its total. Provide itemId from uisp_list_invoice_items. On an issued invoice the customer's copy no longer matches yours, and the charge is silently dropped. Read the item with uisp_get_invoice_item first.

[Ubiquiti UISP] Get one invoice in full — customer, dates, line items, tax, total, amount paid and status. Provide invoiceId from uisp_list_invoices. Read this before approving, sending, voiding or editing: the status is what tells a draft from an already-issued document, and the two are not equally safe to change.

[Ubiquiti UISP] Get one invoice line item in full. Provide itemId from uisp_list_invoice_items.

[Ubiquiti UISP] List one invoice's line items — what each charge is for, its quantity, unit price and tax. This is the DISCOVERY TOOL for invoice item ids. Provide invoiceId from uisp_list_invoices. This is where a customer's question about a specific charge is answered.

[Ubiquiti UISP] List subscriber invoices with their number, date, total, amount outstanding and status (draft, issued, paid, void, overdue). This is the DISCOVERY TOOL for invoice ids. Paginated with limit and offset (default 100, maximum 1000). Narrow to one customer with clientId from uisp_list_clients — the usual first step on any billing query.

[Ubiquiti UISP] Calculate what an invoice WOULD look like without creating it. Provide clientId from uisp_list_clients and a JSON object body with the proposed line items. Nothing is stored and no record is created — this endpoint explicitly does not persist. Use it to check totals and tax before committing to uisp_create_invoice.

[Ubiquiti UISP] Re-render an invoice's PDF from its current data. Provide invoiceId from uisp_list_invoices. Changes no figures and sends nothing — useful after an organisation's logo or address has changed. It does not email the customer; that is uisp_send_invoice.

[Ubiquiti UISP] Email an invoice to the subscriber. Provide invoiceId from uisp_list_invoices. This SENDS A REAL BILL to a real customer and cannot be recalled once delivered — a wrong invoice sent is a support call and, if the figure is wrong, a credibility problem. Verify the customer, the total and the line items with uisp_get_invoice and uisp_list_invoice_items first.

[Ubiquiti UISP] DESTRUCTIVE: change an invoice. Provide invoiceId from uisp_list_invoices and a JSON object body with only the fields to change. On a draft this is ordinary editing; on an ISSUED invoice it silently alters a financial document the customer may already hold a PDF of, so their copy and yours no longer agree. Check the status with uisp_get_invoice first — for an issued invoice, voiding it and issuing a correct one is usually the right answer.

[Ubiquiti UISP] DESTRUCTIVE: change one line item on an invoice, which changes the invoice total. Provide itemId from uisp_list_invoice_items and a JSON object body with only the fields to change. On an issued invoice this diverges from the copy the customer holds. Read the item with uisp_get_invoice_item first.

[Ubiquiti UISP] DESTRUCTIVE: void an issued invoice, cancelling the amount owed. Provide invoiceId from uisp_list_invoices. Voiding is a permanent accounting entry, not an undo: the invoice stays in the ledger marked void, its number is not reused, and the customer's balance changes. If the customer has already paid it, void is the wrong tool — issue a credit note with uisp_create_credit_note instead. Confirm the status with uisp_get_invoice first.

[Ubiquiti UISP] Issue a credit note to a customer, reducing what they owe. Provide clientId from uisp_list_clients and a JSON object body with the amounts and the invoice being credited. This is the CORRECT remedy for an invoice that overcharged someone — including one they have already paid, where voiding is the wrong tool. It works in the customer's favour, which is why it does not prompt; check the amount, because crediting too much gives money away.

[Ubiquiti UISP] Create a quote for a customer. Provide clientId from uisp_list_clients and a JSON object body with the proposed line items. Additive and non-binding: a quote charges nobody and commits nothing until the customer accepts it and a service is created. It is not emailed by this call.

[Ubiquiti UISP] DESTRUCTIVE: delete a credit note. Provide creditNoteId from uisp_list_credit_notes. The credit is withdrawn — the customer owes that money again — and the record of the correction is erased from the ledger, which is exactly the gap an audit looks for. If the customer has already been sent the credit note, they will hold a document that no longer exists. There is no undo.

[Ubiquiti UISP] Get one credit note in full — customer, the invoice it relates to, line items and total. Provide creditNoteId from uisp_list_credit_notes.

[Ubiquiti UISP] Get one quote in full — customer, line items, totals and status. Provide quoteId from uisp_list_quotes.

[Ubiquiti UISP] List credit notes — the documents that reverse or reduce what a customer was invoiced. This is the DISCOVERY TOOL for credit note ids. Paginated with limit and offset (default 100, maximum 1000). Narrow to one customer with clientId from uisp_list_clients.

[Ubiquiti UISP] List quotes — proposals issued to customers and prospects, with their number, date, total and status. This is the DISCOVERY TOOL for quote ids. Paginated with limit and offset (default 100, maximum 1000). Narrow to one customer with clientId from uisp_list_clients.

[Ubiquiti UISP] Re-render a credit note's PDF from its current data. Provide creditNoteId from uisp_list_credit_notes. Changes no figures and sends nothing.

[Ubiquiti UISP] Email a credit note to the customer. Provide creditNoteId from uisp_list_credit_notes. This SENDS A REAL DOCUMENT to a real customer and cannot be recalled — one sent in error tells them they are owed money they are not. Verify it with uisp_get_credit_note first.

[Ubiquiti UISP] DESTRUCTIVE: change a credit note. Provide creditNoteId from uisp_list_credit_notes and a JSON object body with only the fields to change. A credit note is a financial document that has already altered what the customer owes, so changing its amount alters their balance again — and if it was sent, their copy no longer matches yours. Read it with uisp_get_credit_note first.

[Ubiquiti UISP] Update a quote. Provide quoteId from uisp_list_quotes and a JSON object body with only the fields to change. A quote binds nothing, so this is ordinary editing — but if the customer already has a copy, they will be looking at different figures until you send them the new one.

[Ubiquiti UISP] DESTRUCTIVE: allocate a received payment against one or more invoices. Provide paymentId from uisp_list_payments and a JSON object body naming the invoices (from uisp_list_invoices). No money moves, but the allocation is what decides which invoices count as SETTLED — attaching to the wrong one leaves a genuinely unpaid invoice looking paid and vice versa, which then drives dunning and suspension. Read the current allocation with uisp_get_payment first.

[Ubiquiti UISP] DESTRUCTIVE: cancel a recurring payment plan, ending the standing authority to collect from that customer. Provide planId from uisp_list_payment_plans. Automatic collection stops immediately — the customer's future invoices go unpaid until they set up payment again, which usually means asking them to re-authorise. It cannot be reinstated from here. Confirm the customer with uisp_get_payment_plan first.

[Ubiquiti UISP] DESTRUCTIVE: record a payment against a customer's account. Provide a JSON object body with the customer (from uisp_list_clients), the amount, the method (from uisp_list_payment_methods) and optionally the invoices it settles. This is REAL MONEY in the ledger: recording one marks invoices as paid and reduces what the customer owes, so a payment entered for the wrong customer or amount stops legitimate collection on one account and misstates another. Confirm the customer and their outstanding invoices with uisp_get_client and uisp_list_invoices first.

[Ubiquiti UISP] Add a payment method to the ISP's list of accepted options. Provide a JSON object body with its name. Configuration rather than money: it collects nothing and only becomes selectable when recording a payment.

[Ubiquiti UISP] DESTRUCTIVE: set up a recurring payment plan for a customer. Provide a JSON object body with the customer (from uisp_list_clients), the amount and the schedule. This creates a STANDING AUTHORITY to take money from them automatically, so the amount and interval must be exactly what they agreed — an error here collects the wrong sum repeatedly. Cancel it again with uisp_cancel_payment_plan.

[Ubiquiti UISP] DESTRUCTIVE: issue a refund to a customer. Provide a JSON object body with the customer (from uisp_list_clients), the amount and the payment being refunded. This gives REAL MONEY back and, depending on the ISP's payment processor, may move funds immediately and irreversibly. Check the original payment with uisp_get_payment first; refunding more than was taken, or refunding the wrong payment, is not something the API will stop you doing.

[Ubiquiti UISP] DESTRUCTIVE: remove a stored card from a customer's account. Provide cardId from uisp_list_credit_cards. Automatic collection from that card stops, so a customer on autopay starts accruing unpaid invoices — check whether it is their only payment route with uisp_list_payment_plans first. The card details cannot be recovered; the customer has to enter them again.

[Ubiquiti UISP] DESTRUCTIVE: delete a recorded payment. Provide paymentId from uisp_list_payments. Every invoice it was settling returns to OUTSTANDING and the customer's balance rises by the amount — so a customer who paid can be chased, dunned and in an automated setup suspended, on the strength of a record that no longer exists. The money itself is untouched. Read it with uisp_get_payment first, and only delete an entry recorded in error.

[Ubiquiti UISP] DESTRUCTIVE: remove a payment method from the ISP's accepted list. Provide methodId from uisp_list_payment_methods. Check what uses it first — historical payments recorded against it and any automation that names it are affected, and it cannot be restored with the same id.

[Ubiquiti UISP] DESTRUCTIVE: delete a refund record. Provide refundId from uisp_list_refunds. This removes the LEDGER ENTRY, not the money — if funds were actually returned to the customer, deleting the record hides that fact and the accounts will not reconcile. Read it with uisp_get_refund first, and only delete an entry recorded in error.

[Ubiquiti UISP] DESTRUCTIVE: remove a payment's allocation, leaving it unapplied. Provide paymentId from uisp_list_payments. The invoices it was settling go back to OUTSTANDING, so a customer who has genuinely paid can immediately look overdue — and depending on the ISP's automation that can lead to a dunning notice or a suspension. Read the current allocation with uisp_get_payment first and re-attach it promptly.

[Ubiquiti UISP] Get one stored card's detail. Provide cardId from uisp_list_credit_cards. Treat the response as sensitive.

[Ubiquiti UISP] Get one payment in full — amount, date, method, note and its allocation across invoices. Provide paymentId from uisp_list_payments. Read this before changing, deleting or re-allocating anything: the allocation is what decides which invoices count as settled.

[Ubiquiti UISP] Get one payment method's definition. Provide methodId from uisp_list_payment_methods.

[Ubiquiti UISP] Get one recurring payment plan's detail — the customer, the amount and the schedule. Provide planId from uisp_list_payment_plans.

[Ubiquiti UISP] Get one refund's detail. Provide refundId from uisp_list_refunds.

[Ubiquiti UISP] List the cards stored against customer accounts for automatic collection. This is the DISCOVERY TOOL for card ids. Paginated with limit and offset (default 100, maximum 1000). Treat the response as sensitive.

[Ubiquiti UISP] List the payment methods this ISP accepts — cash, bank transfer, card and so on. This is the DISCOVERY TOOL for payment method ids, which uisp_create_payment takes.

[Ubiquiti UISP] List recurring payment plans — the standing authorities that collect from customers automatically. This is the DISCOVERY TOOL for payment plan ids. Paginated with limit and offset (default 100, maximum 1000).

[Ubiquiti UISP] List recorded payments with their amount, date, method and which invoices they are allocated against. This is the DISCOVERY TOOL for payment ids. Paginated with limit and offset (default 100, maximum 1000). Narrow to one customer with clientId from uisp_list_clients — the first place to look when someone says they have already paid.

[Ubiquiti UISP] List refunds issued to customers, with amounts and dates. This is the DISCOVERY TOOL for refund ids. Paginated with limit and offset (default 100, maximum 1000).

[Ubiquiti UISP] Email a payment receipt to the customer. Provide paymentId from uisp_list_payments. This SENDS REAL EMAIL and cannot be recalled — a receipt sent for the wrong payment tells a customer their money arrived when it did not. Verify with uisp_get_payment first.

[Ubiquiti UISP] DESTRUCTIVE: change a stored card's settings, including whether it is used for automatic collection. Provide cardId from uisp_list_credit_cards and a JSON object body. Turning automatic collection on starts charging that card on schedule; turning it off means the customer's invoices stop being paid. Read the current settings with uisp_get_credit_card first.

[Ubiquiti UISP] DESTRUCTIVE: change a recorded payment. Provide paymentId from uisp_list_payments and a JSON object body with only the fields to change. Changing the amount changes what the customer is shown as having paid, which can move a settled invoice back into arrears and start chasing a customer who paid correctly. Read it with uisp_get_payment first.

[Ubiquiti UISP] Rename a payment method. Provide methodId from uisp_list_payment_methods and a JSON object body with only the fields to change. Payments already recorded against it keep their allocation.