Payment Method Summary Schema

Metadata

• created: string (Optional, format: date-time) - The time when the resource was created
• createdBy: string (Optional, format: uuid) - 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
• id: string (Required, format: uuid) - The ID of the resource
• organizationId: string or null (Required, format: uuid) - The ID of the organization this Payment Method belongs to.

Related Data

• projects: list of strings (Required) - List of project names which are billed using this payment method.

Specification

• type: string (Required) - Payment method type. Defaults to direct if not specified.

Variants:

• Azure

  • allowedOrganizations: list of strings or null (Optional) - If set, only these organization IDs are allowed to use this payment method.
  • autoPurchaseBeamLicenses: boolean (Required) - Specifies whether Beam usage should be billed through monthly charges (true) or by the minute (false).
  • azureOfferId: string or null (Optional) - The Azure offer ID.
  • azurePlanName: string or null (Optional) - The Azure plan name.
  • azurePrivateOfferId: string (Optional, format: uuid) - The Partner Center private offer UUID. Present only for azure_private_offer payment methods.
  • azureSaasSubscriptionAutoRenew: boolean or null (Optional)
  • endDate: string (Required, format: date) - The date this payment method expires, in yyyy-mm-dd format. It is not valid on this day.
  • notes: string (Optional, <=256 characters) - Note to the customer.
  • productPublicationName: string (Required) - The name of the product publication that details the pricing for this payment method.
  • startDate: string or null (Required, format: date) - The date this payment method becomes eligible to be active, in yyyy-mm-dd format.

• AWS

  • allowedOrganizations: list of strings or null (Optional)
  • autoPurchaseBeamLicenses: boolean (Required)
  • awsAccountId: string (Optional)
  • awsCustomerId: string or null (Optional)
  • awsOfferId: string (Optional)
  • awsProductCode: string (Optional)
  • awsStatus: string or null (Optional)
  • endDate: string (Required, format: date)
  • notes: string (Optional, <=256 characters)
  • productPublicationName: string (Required)
  • startDate: string or null (Required, format: date)

• Direct

  • allowedOrganizations: list of strings or null (Optional)
  • autoPurchaseBeamLicenses: boolean (Required)
  • endDate: string (Required, format: date)
  • notes: string (Optional, <=256 characters)
  • productPublicationName: string (Required)
  • redeemedBy: string or null (Optional)
  • salesOrderNumber: string (Optional)
  • startDate: string (Required, format: date)
  • status: string (Optional)

Status

• isActive: boolean (Required) - Is payment method active
• termsAndConditionsAccepted: boolean (Required) - Whether the Terms & Conditions of this payment method have been accepted.