---
title: "Deactivate a payment method"
method: POST
path: "/v1/projects/{project}/payment-methods/{method}/deactivate"
tags: ["Payment Methods"]
---

# Deactivate a payment method

`POST /v1/projects/{project}/payment-methods/{method}/deactivate`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/projects/{project}/payment-methods/{method}/deactivate`
- Auth: HTTP bearer

```bash
curl -X POST https://api.subscriby.net/v1/projects/$PROJECT_ID/payment-methods/$METHOD_ID/deactivate \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"
```

The creator's switch. A deactivated method is no longer offered at checkout; the subscriptions already sold through it keep renewing with their gateway. Re-queues the plan sync like activating does. Answers `200` with the method; idempotent, and `project.payment_method.updated` fires once with `changes.active` when the switch flips.

## Path parameters

- `project` string, uuid, required
- `method` string, uuid, required

## Headers

- `Idempotency-Key` string, uuid, required

## Response `200`

The method, switched off.

- object
  - `data` PaymentMethodResource, required: A payment method configured on a project: which provider, in which mode, and whether it is linked and on offer. Credentials never appear.
    - `id` string, required: The payment method's id.
    - `project_id` string, required: The project the method is configured on.
    - `provider` string, nullable, required: The stored provider key: a gateway slug (`stripe`, `paypal`, `razorpay`, `paystack`, `ceypay`, `skrill`, `coinpayments`, `accesscode`) or a `connector:provider` key for a currency a connector brings, as the connector directory lists it. A project carries one method per provider key and mode.
    - `connector` string, required: The connector behind a native payment method: the key before the colon of its `connector:provider` row; null for every gateway and for access codes.
    - `mode` string, required: `test` or `live`. Drives which set of provider credentials is used.
    - `linked` boolean, required: True once the provider handshake (OAuth callback, API-key verify, Connect onboarding) has completed successfully.
    - `active` boolean, required: The creator's switch. A linked-but-inactive method is not offered at checkout and cannot be used to charge subscribers.
    - `created_at` string, nullable, required: When the method was configured, ISO 8601.
    - `updated_at` string, nullable, required: When the method last changed, ISO 8601.

## Other responses

- `400`: `IDEMPOTENCY_KEY_MISSING`: every write needs an `Idempotency-Key` header. Send a fresh UUID per distinct operation.
- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description.
- `404`: `RESOURCE_NOT_FOUND`: an id in the path names nothing the token can see. `TENANT_MISMATCH`: the project sits outside the token's `scope:project:` allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
- `409`: `IDEMPOTENCY_KEY_REUSED`: the key was already used in the last 24 hours with a different request body.
- `425`: `IDEMPOTENCY_REPLAY_IN_PROGRESS`: the first request with this key is still running; retry in a few seconds and the original response is replayed.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)