Models
427 schemas used by the PayNow Management API. Filter by name or jump to a letter.
A
AbandonedCheckoutStoreConfigurationCommandDtoRepresents a command associated with the store-level abandoned checkout configuration.AbandonedCheckoutStoreConfigurationDtoRepresents the store-level configuration for abandoned checkout settings.AbandonedCheckoutStoreConfigurationUpdateCommandDtoRepresents a command associated with the store-level abandoned checkout configuration.AbandonedCheckoutStoreConfigurationUpdateDtoUsed for updating the store-level configuration for abandoned checkout settings.ActorDtoRepresents the actor that performed an action, such as the user, API key or game server that
created or changed a record.AddressDtoRepresents a physical or billing addressAffiliateLinkCommissionAmountStepDtoRepresents the commission for a specific subscription renewal billing cycle.AffiliateLinkCommissionTypeDtoSpecifies the type of commission an affiliate earns from referred purchases.AffiliateLinkDiscountTypeDtoSpecifies the type of discount offered to customers referred through an affiliate link.AffiliateLinkDtoRepresents a detailed view of an affiliate link, including configuration and audit information.AffiliateLinkRefererTypeDtoSpecifies which affiliate link is credited when a customer follows multiple links before purchasing.AffiliateLinkResultAlipayDetailsDtoAlipay payment method detailsAvailablePermissionDto
B
C
CancelSubscriptionRequestDtoCardDetailsDtoCard payment method detailsCardWalletDtoDigital wallet details for a cardCashAppDetailsDtoCash App payment method detailsChangeSubscriptionPlanDtoRepresents a request to move a store onto a different plan.ChargebackCoverageTypeDtoDefines the type of chargeback coverage provided.CheckForBanIDByIdentitiesRequestDtoCheckForBanIDByIdentitiesResponseDtoCheckoutCustomerDetailsDtoThe billing details of the customer the checkout belongs to.CheckoutPaymentInfoDtoPayment outcome information returned after a subscription change triggers an immediate charge.CheckoutSessionDtoRepresents the outcome of a subscription change that may require the store owner to pay.CheckoutStyleDtoRepresents the styling applied to the store's hosted checkout.CommandAttemptDtoCouponDiscountTypeDtoSpecifies the type of discount applied by a coupon.CouponDtoRepresents a detailed view of a coupon, including configuration and audit information.CouponDurationDtoDefines the duration for which a coupon remains valid.CouponFilterStatusDtoWill filter by coupon status.CouponFilterTypeDtoWill filter by coupon creation type.CouponResultCreateAffiliateLinkDtoCreateCheckoutSessionLineDtoRepresents a line item in a checkout session requestCreateCheckoutSessionLineManagementDtoRepresents a line item in a checkout session request.CreateCheckoutSessionLineManagementPayoutSplitDtoCreateCheckoutSessionManagementDtoRequest to create a new checkout session from your back-end server using the management API.CreateCheckoutSessionResponseDtoResponse after creating a checkout sessionCreateCheckoutStyleDtoCreateCouponDtoCreateCustomerPortalSessionRequestDtoRequest to create a new customer portal session from your back-end server using the management APICreateDownloadableFileDownloadUrlResponseDtoCreateEmailBrandingDtoCreateEmailTemplateDtoCreateGameServerConsoleDtoCreateGameServerDtoCreateGiftCardDtoCreateInviteDtoCreateNavLinkDtoCreateProductDependentMigrationRequestDtoCreateRefundRequestDtoCreateRoleDtoCreateSaleDtoCreateStoreDtoCreateStorePaymentSettingsDtoCreateStoreUpsellSettingsDtoCreateTierGroupRequestDtoCreateTrialEligibilityOverrideDtoCreateWebhookDtoCreateWebstoreModuleDtoCreateWebstoreTemplateDtoCreateWebstoreTemplateFileDtoCreateWebstoreTemplateVariableDtoCryptoDetailsDtoCryptocurrency payment method detailsCustomerDtoRepresents a customer in the PayNow system with their associated profiles and metadata.CustomerGenericProfileDtoRepresents a generic platform profile for a customer.CustomerMinecraftPlatformCustomerMinecraftProfileDtoRepresents a Minecraft profile for a customer.CustomerPlatformAccountDtoRepresents a customer platform association, used for giftingCustomerPortalSessionDtoRepresents a customer portal sessionCustomerPortalSessionFlowDtoThe flow a customer portal session is scoped to.CustomerProfilePlatformCustomerResultCustomerSortFieldDto_V2CustomerSpendTimeRangeDtoCustomerStatsDtoCustomerStatsDto_V2CustomerStatsForRangeDto_V2CustomerSteamProfileDtoRepresents a Steam profile for a customer.CustomerTokenResponseDtoCustomVariableDtoCustomVariableLineItemDtoCustomVariableOptionDtoCustomVariableOptionPriceTypeDefines how option pricing should be applied to the base product price.CustomVariableOptionRequestDtoRequest model for defining custom variable options.CustomVariableTypeDefines the type of input method for a custom variable.
D
DashboardSearchHintDtoDashboardSearchResultTypeDtoDashboardStatsDtoDataMigrationTaskDtoDayOfWeekDtoDayOrderStatsDtoDeactivateEmailTemplateRequestDtoDeliveryItemAssignmentBulkDtoDeliveryItemAssignmentDtoDeliveryItemDtoRepresents a delivery item assigned to a customerDeliveryItemProductDtoRepresents the product information for a delivery itemDeliveryItemStateDtoDimensionStatsEntryDto_V2DiscordActionDtoDiscordActionExecutionStageDiscordActionRevocationStageDiscordActionTypeDiscordProfileDtoDiscordServerChannelDtoDiscordServerLinkDtoDiscordServerRoleDtoDistributionEntryDto_V2DistributionTotalsDto_V2DocsSearchHitDtoRepresents one matching section of a documentation page.
E
F
FinishCheckoutStyleBackgroundImageUploadRequestDtoFinishEmailBrandingImageUploadRequestDtoFinishProductImageUploadRequestDtoFinishStoreLogoUploadRequestDtoFinishTagImageUploadUrlRequestDtoFinishWebstoreTemplateUploadResponseDtoRepresents the result of importing an uploaded template archive into a template.FlakeId
G
GameServerConsoleConnectionStatusDtoSpecifies the state of PayNow's connection to a game server's console.GameServerConsoleDtoRepresents the remote console connection PayNow keeps open to a game server, used to run
delivery commands in game and to read the server's console output.GameServerConsoleMessageDtoGameServerConsoleMessageTypeDtoGameServerConsoleTypeDtoSpecifies the console protocol a game server speaks.GameServerDtoRepresents a game server in the PayNow system with authentication tokens and linking information.GameServerLinkDtoGameserverResultGetCheckoutStyleBackgroundImageUploadUrlResponseDtoGetDimensionStatsResponseDto_V2GetDistributionResponseDto_V2GetEmailBrandingImageUploadUrlResponseDtoGetProductImageUploadUrlResponseDtoGetStoreLogoUploadUrlResponseDtoGetTagImageUploadUrlResponseDtoGetWebstoreTemplateArchiveResponseDtoRepresents a link to download a template's files as an archive.GetWebstoreTemplatePreviewUrlResponseDtoRepresents a short-lived link that renders a template preview without caching.GetWebstoreTemplateUploadUrlResponseDtoRepresents a pre-signed URL for uploading a template archive.GiftCardDtoRepresents a gift card in the PayNow system.GiftcardResultGlobalCommandDtoRepresents a global command in the system.
I
IdealDetailsDtoiDEAL payment method detailsInlineProductCreateDtoOptional inline product definition for dynamic products.InstallMarketplaceTemplateResponseDtoRepresents the result of installing a marketplace template into a store's webstore.IntervalGameServerStatsDtoIntervalProductStatsDtoIntervalTagStatsDtoInviteDtoInvoiceDownloadUrlResponseDtoInvoiceDtoInvoiceStatusDtoInvoiceTypeDto
K
L
M
N
O
OrderCountryDistributionDataDtoOrderCountryDistributionDtoOrderCouponUsageDtoOrderDtoRepresents a customer orderOrderGiftCardUsageDtoOrderLineDtoRepresents an order line item in a customer's orderOrderLinePayoutSplitDtoRepresents an order line-level payout split.OrderResultOrdersSummaryDto_V2OrdersSummaryForRangeDto_V2OrderStatusOrderTypeDefines the type of items contained in an order
P
P24DetailsDtoPrzelewy24 payment method detailsPayByBankDetailsDtoPay by Bank payment method detailsPaymentAcceptanceDistributionDataDtoPaymentAcceptanceDistributionDtoPaymentChargebackStatusDtoRepresents chargeback status of a paymentPaymentDeclineCodeA payment decline reason code.PaymentDtoRepresents a payment transactionPaymentGatewayDtoPaymentMethodChargebackRateDto_V2PaymentMethodDetailsDtoContains detailed information about a payment method.PaymentMethodDistributionDataDtoPaymentMethodDistributionDtoPaymentMethodDtoRepresents a stored payment methodPaymentMethodTypeApprovalStatusDtoPaymentMethodTypeCountryCurrencyMappingDtoPaymentMethodTypeDtoPaymentMethodTypeFeeOverrideDtoPaymentMethodUpdateSessionDtoA customer portal session scoped to updating the payment method of the store's
active subscription.PaymentPayoutSplitResultDtoRepresents payout split results for multi-party paymentsPaymentPayoutSplitRuleDtoRepresents payout split rules for a payment linePaymentPayoutSplitRuleSplitDtoRepresents a single split configuration within a payout split rulePaymentPopularTimesOfDayDtoPaymentStatusDtoRepresents payment statusPayNowActorTypePayNowErrorRepresents a PayNow errorPayPalDetailsDtoPayPal payment method detailsPaysafeCardDetailsDtoPaysafecard payment method detailsPeriodISO 8601 duration formatPixDetailsDtoPix payment method detailsPlanDtoPlanPreviewDtoRepresents a publicly listed plan a store can subscribe to.PlanPricingDtoPlatformCapabilityPlatformStoreTypeAssociationDetailsDtoPlatformTypePopularTimeOfDayDto_V2PrepaidCardsBlockingTypeDtoDefines when prepaid cards should be blocked from use.ProductCommandDtoProductCommandExecutionRuleDtoProductCommandStageDefines the stages at which product commands can be executed.ProductDeliverableActionsDtoProductDependentMigrationDtoProductDependentMigrationEstimateTargetCountDtoProductDependentMigrationEstimateVersionDtoProductDependentMigrationStatusDtoProductDependentMigrationTargetDtoProductDependentMigrationTargetTypeDtoProductDependentMigrationTargetVersionDtoProductDownloadableFileDtoProductDtoProductGameServerDtoProductPayoutSplitDtoProductPricingRegionDtoProductPricingRegionGroupDtoProductPricingRegionOverrideDtoProductRemoveAfterIntervalScaleProductResultProductStockAvailableDtoProductStockLimitDtoProductStockTimeScaleProductSubscriptionIntervalScaleProductTagDtoProductTaxCodeDetermines the category of the product for taxation purposes.ProductTrialConfigurationDtoRepresents the configuration for trials of a productProductUpsellConfigurationDtoProductUpsellRecommendationDtoProrationBehaviorDtoDescribes how proration is handled when a subscription change is applied.PublicPlatformDtoPurchaseFollowUpStoreConfigurationCommandDtoRepresents a command associated with the store-level purchase follow uo configuration.PurchaseFollowUpStoreConfigurationDtoRepresents the store-level configuration for abandoned checkout settings.PurchaseFollowUpStoreConfigurationUpdateCommandDtoRepresents a command associated with the store-level purchase follow uo configuration.PurchaseFollowUpStoreConfigurationUpdateDtoUsed for updating the store-level configuration for abandoned checkout settings.
Q
R
S
SaleDiscountTypeDtoSaleDtoRepresents a detailed view of a Sale, including configuration and audit information.SaleDurationDtoSaleResultSalesTaxJurisdictionDtoObject representing a sales tax jurisdiction and its associated taxes.SalesTaxJurisdictionTaxDtoObject representing a specific tax within a sales tax jurisdiction.SearchDashboardResponseDtoSetDiscordActionDtoSetWebstoreCustomDomainRequestDtoRepresents a request to attach a custom domain to a webstore.SetWebstoreDefaultTemplateRequestDtoRepresents a request to set the template a webstore renders.SetWebstoreSlugRequestDtoRepresents a request to change the slug a webstore is served from.StartDataMigrationFromTebexRequestDtoStartDownloadableFileUploadRequestDtoStatsDimensionTypeDto_V2StatsDistributionTypeDto_V2SteamIdA 64-bit Steam account identifier.SteamSkinsDetailsDtoSteam Skins payment method detailsSteamSkinsInventoryItemDetailsDtoStoreAlertDtoStoreAlertStatusStoreAlertTypeStoreBillingDetailsDtoRepresents the billing address and tax details a store is invoiced under.StoreBillingStatusDtoStoreDtoRepresents a PayNow store and its associated configuration.StorefrontCustomerDtoA storefront representation of a customer in the PayNow system with their associated profiles and metadata.StorefrontCustomerMinecraftProfileDtoA storefront representation of a customers Minecraft profile.StorefrontCustomerSteamProfileDtoA storefront representation of a customers Steam profile.StorefrontOrderDtoData transfer object representing a store order.StorefrontOrderLineDtoRepresents a line item within an order.StorefrontStoreDtoRepresents a store entity within the storefront system.StoreMemberDtoRepresents a member of a PayNow store.StoreMemberUserDtoRepresents identity and profile information for a store member.StorePaymentSettingsDtoStore payment configuration settings.StorePricingRegionOverrideDtoStorePromoCodeStackingBehaviorDtoDefines the behavior of promo code stacking.StoreRequirementActionPartyDetermines the party that needs to perform or requests a verificationStoreRequirementCategoryRepresents categories of requirements that must be fulfilled for store setup and compliance in the PayNow platform.StoreRequirementStatusStoreRestrictionFlagDtoStoreResultStoreSubscriptionDtoStoreSubscriptionRenewalPeriodStoreSubscriptionStatusStoreTrustDtoStoreTrustEventDtoStoreTrustEventTypeDtoStoreTrustOnboardingStepsDtoStoreTrustStatusDtoStoreUpsellCheckoutStyleDtoStoreUpsellRecommendationDtoStoreUpsellSettingsDtoSubscriptionBillingAmountDtoRepresents a billing amount breakdown for a subscription.SubscriptionCancelFlowDtoPortal flow for cancelling a specific subscriptionSubscriptionChangeAmountDtoPricing breakdown for a subscription change, in the smallest units of the given currency (e.g.SubscriptionChangeDtoA pending or applied change to a subscription.SubscriptionChangeLineAmountDtoPricing breakdown for a single subscription change line, in the smallest units of the given currency (e.g.SubscriptionChangeLineDtoA single line item within a subscription change.SubscriptionChangeLineProductDtoThe product associated with a subscription change line.SubscriptionChangeProratedAmountDtoThe total prorated charge for a subscription change, expressed in both settlement and presentment currencies.SubscriptionChangeStatusDtoRepresents the status of a subscription change.SubscriptionDtoData transfer object representing a store subscription.SubscriptionLineDtoRepresents a line item within a subscription.SubscriptionPaymentMethodUpdateFlowDtoPortal flow for updating the payment method of a specific subscriptionSubscriptionRenewalPeriodDtoSpecifies how often a subscription renews.SubscriptionResultSubscriptionsSummaryDto_V2SubscriptionsSummaryForRangeDto_V2SubscriptionStatusDtoRepresents the current state of a subscription.
T
TagDtoTagsResultTierGroupDtoTimeSeriesChartDtoTimeSeriesChartDto_V2TimeSeriesChartMetricTypeDto_V2TimeSeriesChartSeriesDtoTimeSeriesChartSeriesDto_V2TimeSeriesChartSeriesEntryDtoTimeSeriesChartSeriesEntryDto_V2TimeSeriesUnitDtoTimeSeriesUnitDto_V2ToggleStorePaymentMethodTypeRequestDtoTrialDtoTrialEligibilityOverrideDtoTrialResultTrialsSummaryDto_V2TrialsSummaryForRangeDto_V2TrialStatusDtoTrustStoreRequirementDtoTrustStoreRequirementSubmissionDto
U
UnqueueCommandsRequestDtoUnqueueCommandsResponseDtoUpdateAffiliateLinkDtoUpdateCheckoutStyleDtoUpdateCouponDtoUpdateEmailBrandingDtoUpdateEmailTemplateDtoUpdateGameServerConsoleDtoUpdateGameServerDtoUpdateGiftCardDtoUpdateInviteDtoUpdateNavLinkDtoUpdateNavLinkOrderChangeDtoUpdateProductSortOrderRequestDtoUpdateRoleDtoUpdateSaleDtoUpdateStoreDtoUpdateStoreMemberDtoUpdateStorePaymentSettingsDtoUpdateStoreUpsellSettingsDtoUpdateSubscriptionLineRequestDtoUpdateSubscriptionRequestDtoUpdateSubscriptionResponseDtoResponse returned after a subscription change is initiated.UpdateTierGroupRequestDtoUpdateTrialEligibilityOverrideDtoUpdateWebhookDtoUpdateWebstoreModuleDtoUpdateWebstoreTemplateDtoUpdateWebstoreTemplateFileDtoUpdateWebstoreTemplateFileRequestDtoRepresents a request to replace the content of a template file.UpdateWebstoreTemplateVariableDtoUpsellDiscountTypeDtoUpsellTypeDtoUpsertBanRequestDtoUpsertCustomerRequestDtoUpsertCustomVariableRequestDtoUnified request model for creating or updating custom variables.UpsertGlobalCommandDtoData transfer object used for creating new global commands or updating existing ones.UpsertProductRequestDtoUpsertProductTrialConfigurationDtoRepresents the configuration for trials of a productUpsertProductUpsellConfigurationDtoUpsertProductUpsellRecommendationDtoUpsertTagRequestDto
V
W
WebhookDiscordFormatDtoSpecifies how a Discord webhook renders its message.WebhookEventTypeWebhookHistoryDtoWebhookStateWebhookSubscriptionDtoRepresents a webhook subscription: an endpoint that receives a request whenever one of the
subscribed events happens in the store.WebhookTypeWebhookVariablesDtoWebstoreCustomDomainDtoRepresents a custom domain attached to a webstore, together with the state of its ownership and
SSL verification.WebstoreCustomDomainOwnershipVerificationDtoRepresents the DNS record that has to be published to prove ownership of a webstore's custom domain.WebstoreCustomDomainOwnershipVerificationHttpDtoRepresents the token file that has to be served over HTTP to prove ownership of a webstore's
custom domain.WebstoreCustomDomainSslDtoRepresents the SSL certificate issued for a webstore's custom domain.WebstoreCustomDomainSslValidationRecordDtoRepresents one record that has to be published to validate a custom domain's SSL certificate.WebstoreCustomDomainVerificationTypeDtoSpecifies how ownership of a webstore's custom domain is proven.WebstoreDtoRepresents a store's webstore, the hosted storefront customers browse and buy from.WebstoreModuleDtoRepresents a module on a webstore: a self-contained block of content or functionality the
template renders.WebstoreTemplateCompatibilityModeDtoSpecifies the dialect a webstore template is written in.WebstoreTemplateCompiledFileDtoRepresents one file of a template after compilation.WebstoreTemplateDtoRepresents a template a webstore can render: a named set of pages, styles, scripts and assets
served to customers while it is the webstore's current template.WebstoreTemplateFileDtoRepresents one file within a webstore template, such as a page, stylesheet, script or image.WebstoreTemplateLatestVersionDtoRepresents the newest version available for a template installed from the marketplace.WebstoreTemplatePreviewDtoRepresents a template compiled and ready to render.WebstoreTemplatePreviewResponseDtoRepresents the data the editor uses to preview a template.WebstoreTemplatePreviewVariablesDtoRepresents the variable values a template preview renders with.WebstoreTemplateSchemaDtoRepresents a template's schema, declared by its author: who maintains it, how it receives updates
and the settings a store can configure without editing the template's files.WebstoreTemplateSchemaOptionDtoRepresents one configurable setting in a template's schema.WebstoreTemplateSchemaSectionDtoRepresents a group of related settings in a template's schema.WebstoreTemplateSchemaUpdatesDtoRepresents how a template receives updates from its author.WebstoreTemplateVariableDtoRepresents a value a template's files can reference, letting a store customise a template without
editing its files.WebstoreTemplateVariableTypeDtoSpecifies how a template variable's 'value' is interpreted when the template renders.