Patch Payment Method

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

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

Authentication

Authorization Bearer

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

Path parameters

paymentmethod_id string Required format: uuid

Request

This endpoint expects a list of objects.

list of objects

Response

200 The updated payment method.
metadataobjectPaymentMethodMetadataOptional
Metadata.
Show 6 propertiesHide 6 properties
createdstringOptionalformat: date-time
The time when the resource was created
createdBystringOptionalformat: uuid
ID of the user who created the resource
createdByEmailstringOptional
Email of the user who created the resource
displayNamestringOptional
The display name of the resource
idstringRequiredformat: uuid
The ID of the resource
organizationIdstring or nullRequiredformat: uuid
The ID of the organization this Payment Method belongs to.
relatedobjectPaymentMethodRelatedOptional
Related data.
Show 1 propertyHide 1 property
projectslist of stringsRequired
List of project names which are billed using this payment method.
specobjectRequired
Specification.
Show 3 variantsHide 3 variants

Discriminated by type. Select one variant:

azureobjectPaymentMethodAzureSpec
allowedOrganizationslist of strings or nullOptional
If set, only these organization IDs are allowed to use this payment method.
autoPurchaseBeamLicensesbooleanRequired
Specifies whether Beam usage should be billed through monthly charges (true) or by the minute (false).
azureOfferIdstring or nullOptional
The Azure offer ID.
azurePlanNamestring or nullOptional
The Azure plan name.
azurePrivateOfferIdstringOptionalformat: uuid
The Partner Center private offer UUID. Present only for azure_private_offer payment methods.
azureSaasSubscriptionAutoRenewboolean or nullOptional
azureSaasSubscriptionEndstring or nullOptional
azureSaasSubscriptionIdstring or nullOptional
azureSaasSubscriptionNamestring or nullOptional
azureSaasSubscriptionStartstring or nullOptional
azureSaasSubscriptionStatusstring or nullOptional
notesstringOptional<=256 characters
Note to the customer.
productPublicationNamestringRequired
The name of the product publication that details the pricing for this payment method.
typestringRequired
Payment method type. Defaults to direct if not specified.
awsobjectPaymentMethodAWSSpec
allowedOrganizationslist of strings or nullOptional
If set, only these organization IDs are allowed to use this payment method.
autoPurchaseBeamLicensesbooleanRequired
Specifies whether Beam usage should be billed through monthly charges (true) or by the minute (false).
awsAccountIdstringOptional
The AWS account ID.
awsCustomerIdstring or nullOptional
Unique AWS account identifier specific to AWS SaaS Marketplace.
awsOfferIdstringOptional
Unique AWS private offer identifier.
awsProductCodestringOptional
The MK.IO product code in the AWS SaaS Marketplace.
awsStatusstring or nullOptional
notesstringOptional<=256 characters
Note to the customer.
productPublicationNamestringRequired
The name of the product publication that details the pricing for this payment method.
typestringRequired
Payment method type. Defaults to direct if not specified.
directobjectPaymentMethodDirectSpec
allowedOrganizationslist of strings or nullOptional
If set, only these organization IDs are allowed to use this payment method.
autoPurchaseBeamLicensesbooleanRequired
Specifies whether Beam usage should be billed through monthly charges (true) or by the minute (false).
notesstringOptional<=256 characters
Note to the customer.
productPublicationNamestringRequired
The name of the product publication that details the pricing for this payment method.
redeemedBystring or nullOptional
The email of the user who redeemed this sales order.
salesOrderNumberstringOptional
The document number from NetSuite, SOxxx
statusstringOptional
The status of the purchase order in MediaKind's systems.
typestringRequired
Payment method type. Defaults to direct if not specified.
statusobjectPaymentMethodStatusOptional
Status.
Show 2 propertiesHide 2 properties
isActivebooleanRequired
Is payment method active
termsAndConditionsAcceptedbooleanRequired
Whether the Terms & Conditions of this payment method have been accepted.

Errors

400 Bad Request
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
401 Unauthorized
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
403 Forbidden
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
404 Not Found
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
429 Too Many Requests
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
500 Internal Server Error
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code