PaymentMethodListSchema

object

@odata.nextLinkstringOptional

@odata.nextLink URL if the page length and number of items match.

supplementalobject ListResponseSupplementalSchema Required

Supplemental info

Show 5 propertiesHide 5 properties

countintegerRequired

Number of items returned

kindstringRequired

Type of items in the list

operationstringRequired

Operation type. Should always say 'list'

paginationobject PaginationInfoSchema Required

Pagination info

Show 4 propertiesHide 4 properties

endintegerRequired

Position of the last item in the list

recordsintegerRequired

Total number of items returned in the list

startintegerRequired

Position of the first item in the list

totalintegerRequired

Total number of items in the project

subscriptionobject ProjectInfoSchema Optional

Project info

Show 2 propertiesHide 2 properties

idstringRequired

Project ID

namestringRequired

Project name

valuelist of objects PaymentMethodSummarySchema Required

Method list.

Show 4 propertiesHide 4 properties

metadataobject PaymentMethodMetadata Optional

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.

relatedobject PaymentMethodRelated Optional

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:

azureobject PaymentMethodAzureSpec

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

endDatestring or nullRequiredformat: date

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.

notesstringOptional<=256 characters

Note to the customer.

productPublicationNamestringRequired

The name of the product publication that details the pricing for this payment method.

startDatestring or nullRequiredformat: date

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.

typestringRequired

Payment method type. Defaults to direct if not specified.

awsobject PaymentMethodAWSSpec

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

endDatestring or nullRequiredformat: date

notesstringOptional<=256 characters

Note to the customer.

productPublicationNamestringRequired

The name of the product publication that details the pricing for this payment method.

startDatestring or nullRequiredformat: date

typestringRequired

Payment method type. Defaults to direct if not specified.

directobject PaymentMethodDirectSpec

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

endDatestring or nullRequiredformat: date

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

startDatestring or nullRequiredformat: date

statusstringOptional

The status of the purchase order in MediaKind's systems.

typestringRequired

Payment method type. Defaults to direct if not specified.

statusobject PaymentMethodStatus Optional

Status.

Show 2 propertiesHide 2 properties

isActivebooleanRequired

Is payment method active

termsAndConditionsAcceptedbooleanRequired

Whether the Terms & Conditions of this payment method have been accepted.