Removing Plugins

This guide shows how to remove plugins from Core Assets and Collections. Removing a plugin deletes its data and functionality.

Summary

Remove plugins using removePlugin() for Assets or removeCollectionPlugin() for Collections. Only the plugin authority can remove a plugin.

• Specify the plugin type to remove
• Plugin data is deleted
• Rent is recovered
• Permanent plugins cannot be removed

Out of Scope

Permanent plugin removal (not possible), plugin updates (see Updating Plugins), and authority changes (see Delegating Plugins).

Quick Start

Jump to: Remove from Asset · Remove from Collection

1. Identify the plugin type to remove
2. Call removePlugin() with the Asset and plugin type
3. Plugin is removed immediately Plugins can also be removed from MPL Core Assets and MPL Core Collections.

Removing a Plugin from a MPL Core Asset

import { publicKey } from '@metaplex-foundation/umi'
import { removePlugin } from '@metaplex-foundation/mpl-core'
const asset = publicKey('11111111111111111111111111111111')
await removePlugin(umi, {
  asset: asset.publicKey,
  plugin: { type: 'Attributes' },
}).sendAndConfirm(umi)

Removing a Plugin from a Collection

import { publicKey } from '@metaplex-foundation/umi'
import {
  removeCollectionPluginV1,
  PluginType,
} from '@metaplex-foundation/mpl-core'
const collectionAddress = publicKey('11111111111111111111111111111111')
await removeCollectionPlugin(umi, {
  collection: collectionAddress,
  pluginType: { type: 'Royalties' },
}).sendAndConfirm(umi)

Common Errors

Authority mismatch

You don't have permission to remove this plugin. Check who has authority over the plugin.

Plugin not found

The Asset/Collection doesn't have this plugin type attached.

Cannot remove permanent plugin

Permanent plugins cannot be removed after creation. They are permanently attached.

Notes

• Removing a plugin deletes all its data
• Rent from the removed plugin is recovered
• Only the plugin authority can remove a plugin
• Permanent plugins can never be removed

Quick Reference

Removal Authority Requirements

FAQ

Can I recover the data after removing a plugin?

No. Removing a plugin permanently deletes all its data. Make sure to back up any important data before removal.

What happens to the rent when I remove a plugin?

The rent that was used to store the plugin data is recovered and returned to the payer.

Can I remove a plugin someone else delegated to me?

Yes, if you're the delegated authority for that plugin, you can remove it.

Why can't I remove a Permanent plugin?

Permanent plugins cannot be removed after creation, though their settings can still be adjusted. This is by design for use cases that require guaranteed plugin presence.

Can I remove a plugin from a Collection and its Assets at once?

No. Collection plugins and Asset plugins are managed separately. However, removing a Collection plugin can affect Assets that inherit from it (e.g., Assets without their own Royalties plugin will no longer have royalties enforced).

Related Operations

• Adding Plugins - Add plugins to Assets/Collections
• Delegating Plugins - Change plugin authorities
• Updating Plugins - Modify plugin data
• Plugins Overview - Full list of available plugins

Glossary