Patch Payment Method

PATCH

https://app.mk.io/api/v1/organization/paymentMethods/:paymentmethod_id

PATCH

/api/v1/organization/paymentMethods/:paymentmethod_id

curl -X PATCH https://app.mk.io/api/v1/organization/paymentMethods/paymentmethod_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json-patch+json" \
     -d '[
  {
    "op": "replace",
    "path": "/metadata/displayName",
    "value": ""
  }
]'

{
  "spec": {
    "allowedOrganizations": [
      "string"
    ],
    "autoPurchaseBeamLicenses": true,
    "azureOfferId": "string",
    "azurePlanName": "string",
    "azurePrivateOfferId": "string",
    "azureSaasSubscriptionAutoRenew": true,
    "azureSaasSubscriptionEnd": "string",
    "azureSaasSubscriptionId": "string",
    "azureSaasSubscriptionName": "string",
    "azureSaasSubscriptionStart": "string",
    "azureSaasSubscriptionStatus": "string",
    "endDate": "2099-01-01",
    "notes": "string",
    "productPublicationName": "string",
    "startDate": "2026-01-01",
    "type": "string"
  },
  "metadata": {
    "id": "string",
    "organizationId": "string",
    "created": "2024-01-15T09:30:00Z",
    "createdBy": "string",
    "createdByEmail": "string",
    "displayName": "string"
  },
  "related": {
    "projects": [
      "string"
    ]
  },
  "status": {
    "isActive": true,
    "termsAndConditionsAccepted": true
  }
}

Partially update a payment method using JSON Patch (RFC 6902). Requires Content-Type: application/json-patch+json.

The following field can be updated via replace operations:

/metadata/displayName — a human-friendly display name (max 256 characters, or "" to clear).

RBAC Capability Required: core.subscription.update

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

paymentmethod_idstringRequiredformat: "uuid"

Request

This endpoint expects a list of objects.

openumRequired

Operation

Allowed values:

pathstringRequired

Path

searchstringOptional

Search string for 'stringReplace' and 'numberReplace' operations.
'numberReplace' replaces with JSON number type but only when the search string matches the entire value. I.e "audio_pid" would be replaced with 50, not "50".

valueanyOptional

Value

Response

The updated payment method.

specobject

Specification.

metadataobjectOptional

Metadata.

statusobjectOptional

Status.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error