billing

DELETE /v1/payment-methods/{paymentMethodId}

Revoke a stored payment method.

All billing endpoints

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X DELETE https://api.zinndigital.com/v1/payment-methods/{paymentMethodId} \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Revokes the mandate and clears its default flag. Emits `payment_method.removed` carrying whether this was the organization's **last** mandate, so the customer can be warned rather than discovering it at the next renewal (ADR 0011 §2).

Parameters

NameTypeRequiredWhat it is
paymentMethodId (path)stringYesThe stored payment method's id.

Errors this endpoint can return

401 · 403 · 404 · 409