> 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.

# List Payment Methods

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

## Listing, Sorting and Filtering Payment Methods

This endpoint returns the list of payment methods.

### Sorting

The results from this endpoint can be ordered using the `$orderby` query parameter. Specify a list of field names, separated by commas
where each one can optionally specify `asc` or `desc`.

Sorting is valid on the following fields: `aws/awsAccountId`, `azure/azureSaasSubscriptionId`, `azure/azureSaasSubscriptionName`, `created`, `createdBy`, `displayName`, `id`, `type`

### Filtering



The `$filter` query parameter allows for payment methods to be filtered on the basis of fields in the schema using OData query syntax.
See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used.

Filters are valid on the following fields: `aws/awsAccountId`, `azure/azureSaasSubscriptionId`, `azure/azureSaasSubscriptionName`, `created`, `createdBy`, `createdByEmail`, `createdByName`, `displayName`, `id`, `type`

### Examples:

`?$top=10` - Returns only the first 10 payment methods from the list.

`?$orderby=created desc` - Sorts payment methods by creation date in descending order.

`?$filter=created ge 2021-01-01T00:00:00Z` - Returns payment methods created after January 1, 2021.

RBAC Capability Required: `core.subscription.get`

Reference: https://mediakind.ferndocs.com/mkio/api/management/payment/list-payment-methods

## Authentication

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

## Request

### Query parameters

- `$orderby` (string, optional) — Specifies the key by which the result collection should be ordered.
- `$filter` (string, optional) — Restricts the set of items returned.
- `$top` (string, optional) — Specifies a non-negative integer `n` that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value `n`.
- `$skiptoken` (string, optional) — Specifies a start offset to support paginated results. Use `@odata.nextLink` in the result object to enumerate the collection - it will be present only if there's more than one page of entities.

## Response

### 200

A list of all payment methods

- `supplemental` (ListResponseSupplementalSchema, required) — Supplemental info
- `value` (list of PaymentMethodSummarySchema, required) — Method list.
- `@odata.nextLink` (string, optional) — @odata.nextLink URL if the page length and number of items match.

## 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

### ListResponseSupplementalSchema

- `count` (integer, required) — Number of items returned
- `kind` (string, required) — Type of items in the list
- `operation` (string, required) — Operation type. Should always say 'list'
- `pagination` (PaginationInfoSchema, required) — Pagination info
- `subscription` (ProjectInfoSchema, optional) — Project info

### PaymentMethodSummarySchema

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

### 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.

### PaginationInfoSchema

- `end` (integer, required) — Position of the last item in the list
- `records` (integer, required) — Total number of items returned in the list
- `start` (integer, required) — Position of the first item in the list
- `total` (integer, required) — Total number of items in the project

### ProjectInfoSchema

- `id` (string, required) — Project ID
- `name` (string, required) — Project name

### 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.

## Examples

**Response**

```json
{
  "supplemental": {
    "count": 1,
    "kind": "string",
    "operation": "string",
    "pagination": {
      "end": 1,
      "records": 1,
      "start": 1,
      "total": 1
    },
    "subscription": {
      "id": "string",
      "name": "string"
    }
  },
  "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
      }
    }
  ],
  "@odata.nextLink": "string"
}
```

**SDK Code**

```python
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.mk.io/api/v1/organization/paymentMethods';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

```go
package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

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

}
```

```ruby
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://app.mk.io/api/v1/organization/paymentMethods")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.mk.io/api/v1/organization/paymentMethods', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://app.mk.io/api/v1/organization/paymentMethods");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

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

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()
```