> This page is for mk.io.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://mediakind.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server.

# Patch Payment Method

PATCH https://app.mk.io/api/v1/organization/paymentMethods/{paymentmethod_id}
Content-Type: application/json-patch+json

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`

Reference: https://mediakind.ferndocs.com/mkio/api/management/payment/patch-payment-method

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `paymentmethod_id` (string, required)

### Body (application/json-patch+json)

This endpoint expects a list of PaymentMethodPatchEntry.

- `list of PaymentMethodPatchEntry`

## Response

### 200

The updated payment method.

- `spec` (PaymentMethodSummarySchemaSpec, required) — Specification.
- `metadata` (PaymentMethodMetadata, optional) — Metadata.
- `related` (PaymentMethodRelated, optional) — Related data.
- `status` (PaymentMethodStatus, optional) — Status.

## Errors

### 400 Bad Request Error

Bad Request

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 401 Unauthorized Error

Unauthorized

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 403 Forbidden Error

Forbidden

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 404 Not Found Error

Not Found

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 429 Too Many Requests Error

Too Many Requests

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 500 Internal Server Error

Internal Server Error

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

## Types

### PaymentMethodPatchEntry

- `op` (enum, required) — Operation
  - Allowed values: `add`, `remove`, `replace`, `stringReplace`, `numberReplace`
- `path` (string, required) — Path
- `search` (string, optional) — 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".
- `value` (any, optional) — Value

### PaymentMethodSummarySchemaSpec

Specification.

- `type`: `aws` (PaymentMethodAWSSpec)
  - `autoPurchaseBeamLicenses` (boolean, required) — Specifies whether Beam usage should be billed through monthly charges (true) or by the minute (false).
  - `endDate` (date, required, nullable) — The date this payment method expires, in yyyy-mm-dd format. It is not valid on this day. If not set, this payment method never expires. If startDate is also set, endDate must be after startDate.
  - `productPublicationName` (string, required) — The name of the product publication that details the pricing for this payment method.
  - `startDate` (date, required, nullable) — The date this payment method becomes eligible to be active, in yyyy-mm-dd format. It is valid on this day. If not set, there is no lower bound. If both startDate and endDate are set, endDate must be after startDate.
  - `allowedOrganizations` (list of string, optional, nullable) — If set, only these organization IDs are allowed to use this payment method.
  - `awsAccountId` (string, optional) — The AWS account ID.
  - `awsCustomerId` (string, optional, nullable) — Unique AWS account identifier specific to AWS SaaS Marketplace.
  - `awsOfferId` (string, optional) — Unique AWS private offer identifier.
  - `awsProductCode` (string, optional) — The MK.IO product code in the AWS SaaS Marketplace.
  - `awsStatus` (string, optional, nullable)
  - `notes` (string, optional) — Note to the customer.
- `type`: `azure` (PaymentMethodAzureSpec)
  - `autoPurchaseBeamLicenses` (boolean, required) — Specifies whether Beam usage should be billed through monthly charges (true) or by the minute (false).
  - `endDate` (date, required, nullable) — The date this payment method expires, in yyyy-mm-dd format. It is not valid on this day. If not set, this payment method never expires. If startDate is also set, endDate must be after startDate.
  - `productPublicationName` (string, required) — The name of the product publication that details the pricing for this payment method.
  - `startDate` (date, required, nullable) — The date this payment method becomes eligible to be active, in yyyy-mm-dd format. It is valid on this day. If not set, there is no lower bound. If both startDate and endDate are set, endDate must be after startDate.
  - `allowedOrganizations` (list of string, optional, nullable) — If set, only these organization IDs are allowed to use this payment method.
  - `azureOfferId` (string, optional, nullable) — The Azure offer ID.
  - `azurePlanName` (string, optional, nullable) — The Azure plan name.
  - `azurePrivateOfferId` (string, optional) — The Partner Center private offer UUID. Present only for azure_private_offer payment methods.
  - `azureSaasSubscriptionAutoRenew` (boolean, optional, nullable)
  - `azureSaasSubscriptionEnd` (string, optional, nullable)
  - `azureSaasSubscriptionId` (string, optional, nullable)
  - `azureSaasSubscriptionName` (string, optional, nullable)
  - `azureSaasSubscriptionStart` (string, optional, nullable)
  - `azureSaasSubscriptionStatus` (string, optional, nullable)
  - `notes` (string, optional) — Note to the customer.
- `type`: `direct` (PaymentMethodDirectSpec)
  - `autoPurchaseBeamLicenses` (boolean, required) — Specifies whether Beam usage should be billed through monthly charges (true) or by the minute (false).
  - `endDate` (date, required, nullable) — The date this payment method expires, in yyyy-mm-dd format. It is not valid on this day. If not set, this payment method never expires. If startDate is also set, endDate must be after startDate.
  - `productPublicationName` (string, required) — The name of the product publication that details the pricing for this payment method.
  - `startDate` (date, required, nullable) — The date this payment method becomes eligible to be active, in yyyy-mm-dd format. It is valid on this day. If not set, there is no lower bound. If both startDate and endDate are set, endDate must be after startDate.
  - `allowedOrganizations` (list of string, optional, nullable) — If set, only these organization IDs are allowed to use this payment method.
  - `notes` (string, optional) — Note to the customer.
  - `redeemedBy` (string, optional, nullable) — The email of the user who redeemed this sales order.
  - `salesOrderNumber` (string, optional) — The document number from NetSuite, SOxxx
  - `status` (string, optional) — The status of the purchase order in MediaKind's systems.

### PaymentMethodMetadata

- `id` (string, required) — The ID of the resource
- `organizationId` (string, required, nullable) — The ID of the organization this Payment Method belongs to.
- `created` (datetime, optional) — The time when the resource was created
- `createdBy` (string, optional) — ID of the user who created the resource
- `createdByEmail` (string, optional) — Email of the user who created the resource
- `displayName` (string, optional) — The display name of the resource

### PaymentMethodRelated

- `projects` (list of string, required) — List of project names which are billed using this payment method.

### PaymentMethodStatus

- `isActive` (boolean, required) — Is payment method active
- `termsAndConditionsAccepted` (boolean, required) — Whether the Terms & Conditions of this payment method have been accepted.

### ErrorDetail

- `code` (string, required) — The error code.
- `detail` (string, required) — The error message.
- `extraDetail` (map from string to any, optional) — Extra information regarding this error.

## Examples

### Remove the display name from the payment method.

**Request**

```json
[
  {
    "op": "replace",
    "path": "/metadata/displayName",
    "value": ""
  }
]
```

**Response**

```json
{
  "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
  }
}
```

**SDK Code**

```python Remove the display name from the payment method.
import requests

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

payload = "[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/metadata/displayName\",\n    \"value\": \"\"\n  }\n]"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json-patch+json"
}

response = requests.patch(url, data=payload, headers=headers)

print(response.json())
```

```javascript Remove the display name from the payment method.
const url = 'https://app.mk.io/api/v1/organization/paymentMethods/paymentmethod_id';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: '[\n  {\n    "op": "replace",\n    "path": "/metadata/displayName",\n    "value": ""\n  }\n]'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Remove the display name from the payment method.
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/metadata/displayName\",\n    \"value\": \"\"\n  }\n]")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Remove the display name from the payment method.
require 'uri'
require 'net/http'

url = URI("https://app.mk.io/api/v1/organization/paymentMethods/paymentmethod_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/metadata/displayName\",\n    \"value\": \"\"\n  }\n]"

response = http.request(request)
puts response.read_body
```

```java Remove the display name from the payment method.
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://app.mk.io/api/v1/organization/paymentMethods/paymentmethod_id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/metadata/displayName\",\n    \"value\": \"\"\n  }\n]")
  .asString();
```

```php Remove the display name from the payment method.
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://app.mk.io/api/v1/organization/paymentMethods/paymentmethod_id', [
  'body' => '[
  {
    "op": "replace",
    "path": "/metadata/displayName",
    "value": ""
  }
]',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json-patch+json',
  ],
]);

echo $response->getBody();
```

```csharp Remove the display name from the payment method.
using RestSharp;

var client = new RestClient("https://app.mk.io/api/v1/organization/paymentMethods/paymentmethod_id");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json-patch+json");
request.AddParameter("application/json-patch+json", "[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/metadata/displayName\",\n    \"value\": \"\"\n  }\n]", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Remove the display name from the payment method.
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json-patch+json"
]

let postData = NSData(data: "[
  {
    "op": "replace",
    "path": "/metadata/displayName",
    "value": ""
  }
]".data(using: String.Encoding.utf8)!)

let request = NSMutableURLRequest(url: NSURL(string: "https://app.mk.io/api/v1/organization/paymentMethods/paymentmethod_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Set a human-friendly display name on the payment method.

**Request**

```json
[
  {
    "op": "replace",
    "path": "/metadata/displayName",
    "value": "My Payment Method"
  }
]
```

**Response**

```json
{
  "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
  }
}
```

**SDK Code**

```python Set a human-friendly display name on the payment method.
import requests

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

payload = "[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/metadata/displayName\",\n    \"value\": \"My Payment Method\"\n  }\n]"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json-patch+json"
}

response = requests.patch(url, data=payload, headers=headers)

print(response.json())
```

```javascript Set a human-friendly display name on the payment method.
const url = 'https://app.mk.io/api/v1/organization/paymentMethods/paymentmethod_id';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: '[\n  {\n    "op": "replace",\n    "path": "/metadata/displayName",\n    "value": "My Payment Method"\n  }\n]'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Set a human-friendly display name on the payment method.
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/metadata/displayName\",\n    \"value\": \"My Payment Method\"\n  }\n]")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Set a human-friendly display name on the payment method.
require 'uri'
require 'net/http'

url = URI("https://app.mk.io/api/v1/organization/paymentMethods/paymentmethod_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/metadata/displayName\",\n    \"value\": \"My Payment Method\"\n  }\n]"

response = http.request(request)
puts response.read_body
```

```java Set a human-friendly display name on the payment method.
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://app.mk.io/api/v1/organization/paymentMethods/paymentmethod_id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/metadata/displayName\",\n    \"value\": \"My Payment Method\"\n  }\n]")
  .asString();
```

```php Set a human-friendly display name on the payment method.
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://app.mk.io/api/v1/organization/paymentMethods/paymentmethod_id', [
  'body' => '[
  {
    "op": "replace",
    "path": "/metadata/displayName",
    "value": "My Payment Method"
  }
]',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json-patch+json',
  ],
]);

echo $response->getBody();
```

```csharp Set a human-friendly display name on the payment method.
using RestSharp;

var client = new RestClient("https://app.mk.io/api/v1/organization/paymentMethods/paymentmethod_id");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json-patch+json");
request.AddParameter("application/json-patch+json", "[\n  {\n    \"op\": \"replace\",\n    \"path\": \"/metadata/displayName\",\n    \"value\": \"My Payment Method\"\n  }\n]", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Set a human-friendly display name on the payment method.
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json-patch+json"
]

let postData = NSData(data: "[
  {
    "op": "replace",
    "path": "/metadata/displayName",
    "value": "My Payment Method"
  }
]".data(using: String.Encoding.utf8)!)

let request = NSMutableURLRequest(url: NSURL(string: "https://app.mk.io/api/v1/organization/paymentMethods/paymentmethod_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```