deactivate_payment_method
Stop offering a payment method to new buyers. Subscriptions already sold through it keep renewing.
The creator's off-switch for a gateway, and the safe way to retire one: new buyers stop seeing it at
checkout, while every subscription already sold through it keeps renewing with its gateway. The plan
sync for the gateway is re-queued. Idempotent: a method that is already off is a no-op and emits
nothing; when the switch flips,
project.payment_method.updated emits once with
changes.active.
Deactivate before you delete
Deactivating keeps the row and its history and can be undone with
activate_payment_method.
delete_payment_method removes the
gateway from the project. Prefer this one unless the creator asks for removal.
Requires ability
The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.
Runs the same action as
The REST endpoint and this tool share one action, so validation, permissions and events are identical.
Fires one event
Delivered to every endpoint subscribed to it once the change is made.
Annotations
A client that honours annotations asks a person before running it. Sending the same arguments twice changes nothing the second time.
Arguments
project_id*stringUUID of the project the method belongs to.
payment_method_id*stringUUID of the payment method to switch off.
What it returns
{ "data": { "id": "a15d70c8-3e46-4b92-b70f-58c9d2140e63", "provider": "paypal", "mode": "live", "active": false, "created_at": "2026-05-18T10:05:00+00:00" }}How it fails
VALIDATION_FAILEDthe switch was refused for the method's current state.
RESOURCE_NOT_FOUNDunknown project_id or payment_method_id, a method of another project, or a project outside the token's scope.
AUTHENTICATION_REQUIREDno authenticated user on the request.
TOKEN_MISSING_ABILITYtoken lacks project-payment-method:update.
How is this guide?
Last updated on
activate_payment_method
Offer a configured payment method to buyers again and re-queue its plan sync. Refuses a Stripe method whose Connect onboarding never finished.
delete_payment_method
Remove a payment method from a project. Destructive — buyers lose that way to pay at once; the row is soft-deleted so history survives.