Dashboard
Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdFlakeIdRequired
Query parameters
querystringOptional
search_hintsobjectOptional
search_result_typeenumOptional
limitintegerOptional
The maximum number of items to return in a single request.
afterFlakeIdOptional
Returns items after the specified ID.
Used for forward pagination through results.
beforeFlakeIdOptional
Returns items before the specified ID.
Used for backward pagination through results.
ascbooleanOptional
Determines the sort order of returned items.
When true, items are returned in ascending order.
When false, items are returned in descending order.
Response
200OKSearchDashboardResponseDto
Show fieldsHide fields
affiliate_linksAffiliateLinkResult[]Required
idFlakeIdRequired
affiliate_linkAffiliateLinkDtoOptionalRepresents a detailed view of an affiliate link, including configuration and audit information.
apply_for_subscriptionsbooleanRequired
Whether the affiliate earns commission on subscription renewals.
Must be enabled for 'commission_amount_steps' past the first cycle to apply - when disabled, only the initial purchase earns commission.
codestringRequired
The unique code associated with the affiliate link.
commission_amountintegerRequired
The commission amount, in tenths of a percent (e.g., 125 = 12.5%) for percentage commissions.
commission_amount_stepsAffiliateLinkCommissionAmountStepDto[]Required
Per-cycle commission overrides. Requires 'apply_for_subscriptions' to be enabled for billing cycles past 1.
When empty, the base commission amount applies to every renewal. When steps are defined, each renewal cycle pays its matching steps amount.
Cycles without a matching step earn no commission, except cycles past the last step when 'last_commission_amount_step_repeats' is true.
→ AffiliateLinkCommissionAmountStepDtocommission_typeenumRequired
Specifies the type of commission an affiliate earns from referred purchases.
Possible enum values
noneNo commission is earned.
fixedA fixed amount commission (e.g., $5 per purchase). Not yet supported by the affiliate service.
percentageA percentage-based commission (e.g., 10% of the purchase).
created_atstringRequired
The date and time when the affiliate link was created.
created_byActorDtoRequired
→ ActorDtodiscount_amountintegerRequired
The discount amount, in the smallest currency unit (e.g., cents) for fixed discounts, or tenths of a percent (e.g., 125 = 12.5%) for percentage discounts.
discount_typeenumRequired
Specifies the type of discount offered to customers referred through an affiliate link.
Possible enum values
noneNo discount is offered.
fixedA fixed amount discount (e.g., $5 off).
percentageA percentage-based discount (e.g., 10% off).
enabledbooleanRequired
Indicates whether the affiliate link is enabled.
idFlakeIdRequired
last_commission_amount_step_repeatsbooleanRequired
Whether the last commission amount steps rate continues to apply to all billing cycles past the last step.
When false, cycles past the last step earn no commission.
referer_typeenumRequired
Specifies which affiliate link is credited when a customer follows multiple links before purchasing.
Possible enum values
invalidNo referer type specified. This value is typically used as a default or uninitialized state.
first_refererThe first affiliate link the customer followed is credited.
last_refererThe most recent affiliate link the customer followed is credited.
store_idFlakeIdRequired
tracking_length_daysintegerRequired
The number of days a customer's referral is tracked after following the affiliate link.
wallet_idstringRequired
The identifier of the wallet that receives the affiliate commission payouts.
updated_atstringOptional
The date and time when the affiliate link was last updated.
updated_byActorDtoOptional
→ ActorDtostore_idFlakeIdOptional
bansBanResult[]Required
idFlakeIdRequired
banBanDtoOptional
created_atstringRequired
created_byActorDtoRequired
→ ActorDtoenabledbooleanRequired
idFlakeIdRequired
identitiesBanIdentityDto[]Required
→ BanIdentityDtoreasonstringRequired
store_idFlakeIdRequired
expires_atstringOptional
updated_atstringOptional
updated_byActorDtoOptional
→ ActorDtostore_idFlakeIdOptional
couponsCouponResult[]Required
idFlakeIdRequired
couponCouponDtoOptionalRepresents a detailed view of a coupon, including configuration and audit information.
codestringRequired
The unique code associated with the coupon.
created_atstringRequired
The date and time when the coupon was created.
discount_amountintegerRequired
The discount amount in the smallest currency unit (e.g., cents).
discount_apply_before_salesbooleanRequired
Indicates whether the discount is applied before existing sales.
discount_apply_individuallybooleanRequired
Indicates whether the discount should be applied individually to required tags or products.
discount_typeenumRequired
Specifies the type of discount applied by a coupon.
Possible enum values
unspecifiedNo discount type specified. This value is typically used as a default or uninitialized state.
percentA percentage-based discount (e.g., 10% off).
amountA fixed amount discount (e.g., $5 off).
durationenumRequired
Defines the duration for which a coupon remains valid.
Possible enum values
onceThe coupon can be used only once.
foreverThe coupon remains valid indefinitely (no expiration).
repeatingThe coupon is valid for a repeating period, typically specified in months.
enabledbooleanRequired
Indicates whether the coupon is enabled.
idFlakeIdRequired
minimum_order_valueintegerRequired
The minimum order value required to use the coupon.
redeem_limit_customer_amountintegerRequired
The maximum number of times the coupon can be redeemed per customer.
redeem_limit_customer_enabledbooleanRequired
Indicates whether a per-customer redemption limit is enabled.
redeem_limit_store_amountintegerRequired
The maximum number of times the coupon can be redeemed across the store.
redeem_limit_store_enabledbooleanRequired
Indicates whether a global redemption limit is enabled.
store_idFlakeIdRequired
usable_on_one_time_purchasebooleanRequired
Indicates whether the coupon can be used for one-time purchases.
usable_on_subscriptionbooleanRequired
Indicates whether the coupon can be used for subscriptions.
version_idFlakeIdRequired
apply_to_productsFlakeId[]Optional
A list of product IDs the coupon applies to.
apply_to_tagsFlakeId[]Optional
A list of tag IDs the coupon applies to.
created_byActorDtoOptional
→ ActorDtoduration_in_intervalsintegerOptional
The number of subscription renewals the coupon is valid for, used if the duration is repeating.
duration_in_monthsintegerOptional
The number of months the coupon is valid for, used if the duration is repeating.
expires_atstringOptional
The date and time when the coupon expires.
notestringOptional
A note or internal description of the coupon.
updated_atstringOptional
The date and time when the coupon was last updated.
updated_byActorDtoOptional
→ ActorDtousable_atstringOptional
The date and time when the coupon becomes valid.
usable_by_customer_idFlakeIdOptional
store_idFlakeIdOptional
customersCustomerResult[]Required
customerCustomerDtoRequiredRepresents a customer in the PayNow system with their associated profiles and metadata.
created_atstringRequired
The date and time when the customer was created in the system.
idFlakeIdRequired
metadataobjectRequired
Additional custom data associated with the customer.
store_idFlakeIdRequired
minecraftCustomerMinecraftProfileDtoOptional
→ CustomerMinecraftProfileDtominecraft_platformenumOptional
Possible enum values
unknownjavabedrock
minecraft_uuidstringOptional
The customer's Minecraft UUID, if they have linked their Minecraft account.
Not set for offline Minecraft stores. If the platform type is Minecraft - Geyser,
and the profile is a bedrock account, this will be a UUID generated from the Xbox XUID.
namestringOptional
The display name for the customer.
profileCustomerGenericProfileDtoOptional
→ CustomerGenericProfileDtosteamCustomerSteamProfileDtoOptional
→ CustomerSteamProfileDtosteam_idSteamIdOptional
A 64-bit Steam account identifier. Accepts string or numeric format.
updated_atstringOptional
The date and time when the customer was last updated, if applicable.
xbox_xuidstringOptional
The customer's Xbox XUID, if available.
idFlakeIdRequired
store_idFlakeIdOptional
facetsobjectRequired
affiliate_linksintegerOptional
api_keysintegerOptional
bansintegerOptional
couponsintegerOptional
customersintegerOptional
gameserversintegerOptional
giftcardsintegerOptional
ordersintegerOptional
productsintegerOptional
salesintegerOptional
storesintegerOptional
subscriptionsintegerOptional
tagsintegerOptional
ticketsintegerOptional
trialsintegerOptional
unknownintegerOptional
usersintegerOptional
gameserversGameserverResult[]Required
idFlakeIdRequired
gameserverGameServerDtoOptionalRepresents a game server in the PayNow system with authentication tokens and linking information.
created_atstringRequired
The date and time when the game server was created in the system.
created_byActorDtoRequired
→ ActorDtoenabledbooleanRequired
Indicates whether the game server is currently enabled.
idFlakeIdRequired
linked_toGameServerLinkDtoRequired
→ GameServerLinkDtonamestringRequired
The display name of the game server.
store_idFlakeIdRequired
updated_byActorDtoRequired
→ ActorDtotokenstringOptional
The authentication token used by the game server to access the PayNow API.
token_reset_atstringOptional
The date and time when the authentication token was last reset, if applicable.
updated_atstringOptional
The date and time when the game server was last updated, if applicable.
store_idFlakeIdOptional
giftcardsGiftcardResult[]Required
idFlakeIdRequired
giftcardGiftCardDtoOptionalRepresents a gift card in the PayNow system.
balanceintegerRequired
The current balance remaining on the gift card in cents.
codestringRequired
The unique code that customers use to redeem the gift card.
enabledbooleanRequired
Indicates whether the gift card is currently enabled and can be used.
idFlakeIdRequired
starting_balanceintegerRequired
The original balance when the gift card was first created in cents.
store_idFlakeIdRequired
usable_atstringRequired
The date and time when the gift card becomes usable.
canceled_atstringOptional
The date and time when the gift card was canceled, if applicable.
canceled_byActorDtoOptional
→ ActorDtocreated_atstringOptional
The date and time when the gift card was created.
created_byActorDtoOptional
→ ActorDtoexpires_atstringOptional
The date and time when the gift card expires, if applicable.
notestringOptional
Optional note or description associated with the gift card.
updated_atstringOptional
The date and time when the gift card was last updated, if applicable.
updated_byActorDtoOptional
→ ActorDtostore_idFlakeIdOptional
ordersOrderResult[]Required
idFlakeIdRequired
orderOrderDtoOptionalRepresents a customer order
applied_giftcardsOrderGiftCardUsageDto[]Required
Applied gift cards to this order
→ OrderGiftCardUsageDtobilling_countrystringRequired
The billing country for this order
billing_cycle_sequenceintegerRequired
The billing cycle sequence (current renewal count) if this is a subscription order
billing_emailstringRequired
The billing email for this order
billing_namestringRequired
The billing name for this order
currencystringRequired
The currency code used for this order
customerCustomerDtoRequired
→ CustomerDtocustomer_idFlakeIdRequired
customer_ipstringRequired
The IP address (IPv4 or IPv6) of the customer at time of order
discount_amountintegerRequired
The total discount amount applied to this order in smallest currency unit
discount_amount_strstringRequired
The discount amount formatted as a string
giftcard_usage_amountintegerRequired
The amount of gift card value used for this order in smallest currency unit
giftcard_usage_amount_strstringRequired
The gift card usage amount formatted as a string
idFlakeIdRequired
is_subscriptionbooleanRequired
Signifies if the order is a subscription order
presentment_currencystringRequired
The presentment currency code used for this order (currency shown to customer)
presentment_discount_amountintegerRequired
The presentment discount amount in smallest currency unit
presentment_discount_amount_strstringRequired
The presentment discount amount formatted as a string
presentment_giftcard_usage_amountintegerRequired
The presentment gift card usage amount in smallest currency unit
presentment_giftcard_usage_amount_strstringRequired
The presentment gift card usage amount formatted as a string
presentment_subtotal_amountintegerRequired
The presentment subtotal amount in smallest currency unit
presentment_subtotal_amount_strstringRequired
The presentment subtotal amount formatted as a string
presentment_tax_amountintegerRequired
The presentment tax amount in smallest currency unit
presentment_tax_amount_strstringRequired
The presentment tax amount formatted as a string
presentment_total_amountintegerRequired
The presentment total amount in smallest currency unit
presentment_total_amount_strstringRequired
The presentment total amount formatted as a string
pretty_idstringRequired
The PayNow order ID identifier starting with pn-.
statusenumRequired
Possible enum values
createdcompletedcanceledrefundedchargeback
store_idFlakeIdRequired
subtotal_amountintegerRequired
The subtotal amount for this order in smallest currency unit
subtotal_amount_strstringRequired
The subtotal amount formatted as a string
tax_amountintegerRequired
The tax amount for this order in smallest currency unit
tax_amount_strstringRequired
The tax amount formatted as a string
tax_jurisdictionsSalesTaxJurisdictionDto[]Required
A list of all tax jurisdictions that were involved in the taxation of this order.
→ SalesTaxJurisdictionDtototal_amountintegerRequired
The total amount for this order in smallest currency unit
total_amount_strstringRequired
The total amount formatted as a string
typeenumRequired
Defines the type of items contained in an order
Possible enum values
one_timeOrder contains only one-time purchase items
subscription_initialOrder is the initial charge for a subscription
subscription_renewalOrder is a recurring renewal charge for a subscription
subscription_prorationOrder is a proration charge for a subscription
mixedOrder contains both one-time purchase and subscription items
affiliate_idFlakeIdOptional
billing_tax_idstringOptional
The tax identification number used for this order (for B2B transactions)
checkout_idFlakeIdOptional
checkout_tokenstringOptional
The checkout token for this order
completed_atstringOptional
The date and time when this order was completed, if applicable
coupon_idFlakeIdOptional
created_atstringOptional
The date and time when this order was created
giftcard_idFlakeIdOptional
last_payment_errorLastPaymentErrorDtoOptional
→ LastPaymentErrorDtosubscription_idFlakeIdOptional
store_idFlakeIdOptional
productsProductResult[]Required
idFlakeIdRequired
totalintegerRequired
productProductDtoOptional
allow_one_time_purchasebooleanRequired
Indicates whether one-time purchases are allowed.
allow_subscriptionbooleanRequired
Indicates whether subscription purchases are allowed.
commandsProductCommandDto[]Required
The commands to be executed at different stages.
→ ProductCommandDtocustom_variable_idsFlakeId[]Required
The IDs of associated custom variables.
customer_stock_limitProductStockLimitDtoRequired
→ ProductStockLimitDtodescriptionstringRequired
The detailed description of the product.
gameserversProductGameServerDto[]Required
The game servers associated with the product.
→ ProductGameServerDtoidFlakeIdRequired
namestringRequired
The display name of the product.
payout_splitsProductPayoutSplitDto[]Required
The payout splits for revenue distribution.
→ ProductPayoutSplitDtopriceintegerRequired
The price of the product, in the lowest denominator (e.g. cents).
remove_after_enabledbooleanRequired
Indicates whether automatic removal is enabled.
remove_after_time_scaleenumRequired
Possible enum values
invaliddayweekmonth
remove_after_time_valueintegerRequired
The time value for automatic removal.
required_product_idsFlakeId[]Required
The IDs of products required for purchasing this product.
single_game_server_onlybooleanRequired
Indicates whether the product is limited to a single game server.
slugstringRequired
The unique slug for the product.
sort_orderintegerRequired
The sort order for displaying the product.
stock_availableProductStockAvailableDtoRequired
→ ProductStockAvailableDtostore_idFlakeIdRequired
store_stock_limitProductStockLimitDtoRequired
→ ProductStockLimitDtosubscription_interval_scaleenumRequired
Possible enum values
invaliddayweekmonthyear
subscription_interval_valueintegerRequired
The subscription interval value.
trialProductTrialConfigurationDtoRequired
→ ProductTrialConfigurationDtoupsellingProductUpsellConfigurationDtoRequired
→ ProductUpsellConfigurationDtoversion_idFlakeIdRequired
allow_concurrent_active_itemsbooleanOptional
Indicates whether concurrent active items are allowed.
created_atstringOptional
The date and time when the product was created.
created_byActorDtoOptional
→ ActorDtodeliverable_actionsProductDeliverableActionsDtoOptional
→ ProductDeliverableActionsDtoenabled_atstringOptional
The date and time when the product becomes enabled.
enabled_untilstringOptional
The date and time until which the product remains enabled.
image_urlstringOptional
The URL to the product image.
is_affiliate_links_disabledbooleanOptional
Indicates if applying affiliate links should be disabled on the product.
is_coupons_disabledbooleanOptional
Indicates if applying coupons should be disabled on the product.
is_gift_cards_disabledbooleanOptional
Indicates if applying gift cards should be disabled on the product.
is_gifting_disabledbooleanOptional
Indicates whether gifting is disabled.
is_hiddenbooleanOptional
Indicates whether the product is hidden.
labelstringOptional
The display label for the product.
metadataobjectOptional
Additional metadata for the product.
required_product_allbooleanOptional
Indicates whether all required products are needed.
stock_limit_do_not_include_removedbooleanOptional
Indicates whether removed items should be excluded from stock limits.
tax_codeenumOptional
Determines the category of the product for taxation purposes.
Contact support for help with setting the correct tax code.
Possible enum values
unknownUnknown tax code.
digital_goods_subscriptionYou provide customers access to photographs, audiovisual works, audio works, and books, delivered electronically to a customer for non-permanent access, with right of use conditioned on continued payment to the seller.
digital_goods_permanentYou provide customers access to photographs, audiovisual works, audio works, and books, delivered electronically to a customer.
saasSaaS: Pre-written software, delivered electronically. You provide customers access to a hosted software application, described as computer programs designed to permit the user to perform a group of coordinated functions, tasks, or activities. You are typically responsible for all aspects of making the software service available.
downloaded_softwarePre-written, non-custom computer software that is delivered electronically for download onto customers' devices/servers. No tangible personal property (e.g. CD-ROM, etc.) is delivered or used in conjunction with the download.
digital_goods_subscription_gamingCloud based or downloaded access to digital gaming services (used by default for game servers).
digital_goods_permanent_gamingPermanent digital goods for gaming (not recommended).
iaasInfrastructure as a Service: Providing users remote access to data center equipment and computing power.
paasPlatform as a Service: A cloud computing service bundle that includes both the infrastructure (servers, storage, and networking) and the middleware (development tools, business intelligence services, database management systems) that provides the customer a complete development and deployment environment in the cloud.
saas_securityCloud-based SaaS, designed to secure customer data. Pre-written software, delivered electronically, designed specifically to provide protection of computer systems, software, or data against unauthorized access or intrusion. This includes separately charged maintenance and updates delivered electronically, whether included in the cost of the software or charged as a separate line item.
saas_storageCloud-based SaaS, designed to backup customer data. Pre-written software, delivered electronically, designed purely as storage for a customer's data. You provide customers access to a software product solely to facilitate the storage of digital products, digital codes, computer software or master copies of software. This includes separately charged maintenance and updates delivered electronically, whether included in the cost of the software or charged as a separate line item.
tier_group_idFlakeIdOptional
updated_atstringOptional
The date and time when the product was last updated.
updated_byActorDtoOptional
→ ActorDtostore_idFlakeIdOptional
salesSaleResult[]Required
idFlakeIdRequired
saleSaleDtoOptionalRepresents a detailed view of a Sale, including configuration and audit information.
apply_to_product_idsFlakeId[]Required
A list of product IDs the sale applies to.
apply_to_tag_idsFlakeId[]Required
A list of tag IDs the sale applies to.
begins_atstringRequired
The date and time when the sale begins.
created_atstringRequired
The date and time when the sale was created.
created_byActorDtoRequired
→ ActorDtodiscount_amountintegerRequired
The discount value. For percent discounts, this represents the percentage
multiplied by 10 (e.g., 250 = 25%). For amount discounts, this represents
the value in the smallest currency unit (e.g., cents).
discount_typeenumRequired
Possible enum values
percentamount
durationenumRequired
Possible enum values
unspecifiedonceforeverrepeating
duration_in_intervalsintegerRequired
The number of subscription intervals the coupon is valid for, used if the duration is repeating.
enabledbooleanRequired
Indicates whether the sale is enabled.
idFlakeIdRequired
minimum_order_valueintegerRequired
The minimum order value required to apply the sale, in the smallest currency unit (e.g., cents).
namestringRequired
The name of the sale.
store_idFlakeIdRequired
version_idFlakeIdRequired
ends_atstringOptional
The date and time when the sale ends.
updated_atstringOptional
The date and time when the sale was last updated.
updated_byActorDtoOptional
→ ActorDtostore_idFlakeIdOptional
storesStoreResult[]Required
idFlakeIdRequired
storeStoreDtoRequiredRepresents a PayNow store and its associated configuration.
currencystringRequired
The ISO 4217 currency code used by this store for pricing (e.g. "usd", "eur")
descriptionstringRequired
A human-readable description of the store shown to customers and PayNow.
gamestringRequired
Alias for 'platform'. Returns the platform identifier as a game name.
idFlakeIdRequired
live_modebooleanRequired
When set to true, the store is processing real transactions in live mode.
namestringRequired
The display name of the store.
owner_idFlakeIdRequired
platformstringRequired
The platform this store is associated with (e.g. "rust", "minecraft").
slugstringRequired
The URL-safe slug used to identify the store (e.g. "my-rust-server").
contact_emailstringOptional
General contact email address for the store.
created_atstringOptional
The UTC timestamp when the store was created.
integration_typestringOptional
The integration type used by the store.
logo_square_urlstringOptional
URL of the store's square/icon logo image.
logo_urlstringOptional
URL of the store's full-size logo image.
minecraft_bedrock_username_prefixstringOptional
Username prefix used to identify Minecraft Bedrock players (e.g. ".").
onboarding_completed_atstringOptional
The UTC timestamp when the store completed onboarding.
platform_store_type_associationPlatformStoreTypeAssociationDetailsDtoOptional
→ PlatformStoreTypeAssociationDetailsDtosupport_emailstringOptional
Dedicated support email address for customer inquiries.
support_urlstringOptional
URL to the store's support portal or help page.
updated_atstringOptional
The UTC timestamp when the store was last updated.
website_urlstringOptional
The store's public website URL.
store_idFlakeIdOptional
subscriptionsSubscriptionResult[]Required
idFlakeIdRequired
store_idFlakeIdOptional
subscriptionSubscriptionDtoOptionalData transfer object representing a store subscription.
cancel_at_period_endbooleanRequired
Whether the subscription will be canceled at the end of the billing period.
coupon_idsFlakeId[]Required
Identifiers of coupons applied to this subscription.
created_atstringRequired
Date and time when the subscription was created.
currencystringRequired
Currency code used for billing this subscription.
customerCustomerDtoRequired
→ CustomerDtodiscount_amountintegerRequired
Amount of discount applied in smallest currency units.
discount_amount_strstringRequired
Formatted string representation of the discount amount.
giftbooleanRequired
Indicates whether this subscription is a gift.
idFlakeIdRequired
initial_discount_amountintegerRequired
Initial discount amount in smallest currency units for the first billing cycle.
initial_discount_amount_strstringRequired
Formatted string representation of the initial discount amount.
initial_giftcard_usage_amountintegerRequired
Initial gift card usage amount in smallest currency units.
initial_giftcard_usage_amount_strstringRequired
Formatted string representation of the initial gift card usage amount.
initial_subtotal_amountintegerRequired
Initial subtotal amount in smallest currency units for the first billing cycle.
initial_subtotal_amount_strstringRequired
Formatted string representation of the initial subtotal amount.
initial_tax_amountintegerRequired
Initial tax amount in smallest currency units for the first billing cycle.
initial_tax_amount_strstringRequired
Formatted string representation of the initial tax amount.
initial_total_amountintegerRequired
Initial total amount in smallest currency units for the first billing cycle.
initial_total_amount_strstringRequired
Formatted string representation of the initial total amount.
interval_scaleenumRequired
Possible enum values
invaliddayweekmonthyear
interval_valueintegerRequired
Numeric value of the billing interval.
linesSubscriptionLineDto[]Required
Line items associated with this subscription.
→ SubscriptionLineDtonext_billing_amountSubscriptionBillingAmountDtoRequired
→ SubscriptionBillingAmountDtonext_billing_presentment_amountSubscriptionBillingAmountDtoRequired
→ SubscriptionBillingAmountDtopast_duebooleanRequired
Whether the subscription is past due, and is in a dunning (retrying) state.
pretty_idstringRequired
Human-readable identifier for the subscription.
priceintegerRequired
Base price of the subscription in smallest currency units (e.g., cents).
statusenumRequired
Represents the current state of a subscription.
Possible enum values
invalidcreatedThe subscription has been created but is not yet active.
activeThe subscription is currently active and will renew.
canceledThe subscription has been canceled and will no longer renew.
store_idFlakeIdRequired
subtotal_amountintegerRequired
Subtotal amount in smallest currency units.
subtotal_amount_strstringRequired
Formatted string representation of the subtotal amount.
tax_amountintegerRequired
Tax amount in smallest currency units.
tax_amount_strstringRequired
Formatted string representation of the tax amount.
tax_inclusivebooleanRequired
Indicates whether tax is included in the base price itself.
tax_jurisdictionsSalesTaxJurisdictionDto[]Required
List of tax jurisdictions applicable to this subscription.
→ SalesTaxJurisdictionDtototal_amountintegerRequired
Total amount in smallest currency units.
total_amount_strstringRequired
Formatted string representation of the total amount.
active_atstringOptional
Date and time when the subscription became active.
affiliate_idFlakeIdOptional
attempt_countintegerOptional
Number of payment attempts made for the current billing cycle.
billing_countrystringOptional
Country code used for billing purposes.
billing_cycle_sequenceintegerOptional
Sequence number of the current billing cycle.
billing_emailstringOptional
Email used for billing purposes.
billing_namestringOptional
Name used for billing purposes.
billing_tax_idstringOptional
The tax identification number used for this order (for B2B transactions)
cancel_reasonstringOptional
Reason provided for cancellation.
canceled_atstringOptional
Date and time when the subscription was canceled.
cancellation_requested_atstringOptional
Date and time when a subscription cancellation (cancel_at_period_end) was requested.
checkout_idFlakeIdOptional
checkout_line_idFlakeIdOptional
coupon_idFlakeIdOptional
coupon_repeating_ends_atstringOptional
Date when a repeating coupon ends for this subscription.
current_period_endstringOptional
End date of the current billing period.
current_period_startstringOptional
Start date of the current billing period.
customer_ipstringOptional
IP address of the customer at the time of subscription.
fx_ratestringOptional
The foreign exchange rate applied (if presentment currency differs from settlement currency).
gift_to_customerCustomerDtoOptional
→ CustomerDtogift_to_customer_idFlakeIdOptional
initial_presentment_discount_amountintegerOptional
Initial presentment discount amount in smallest currency units for the first billing cycle.
initial_presentment_discount_amount_strstringOptional
Formatted string representation of the initial presentment discount amount.
initial_presentment_giftcard_usage_amountintegerOptional
Initial presentment gift card usage amount in smallest currency units.
initial_presentment_giftcard_usage_amount_strstringOptional
Formatted string representation of the initial presentment gift card usage amount.
initial_presentment_subtotal_amountintegerOptional
Initial presentment subtotal amount in smallest currency units for the first billing cycle.
initial_presentment_subtotal_amount_strstringOptional
Formatted string representation of the initial presentment subtotal amount.
initial_presentment_tax_amountintegerOptional
Initial presentment tax amount in smallest currency units for the first billing cycle.
initial_presentment_tax_amount_strstringOptional
Formatted string representation of the initial presentment tax amount.
initial_presentment_total_amountintegerOptional
Initial presentment total amount in smallest currency units for the first billing cycle.
initial_presentment_total_amount_strstringOptional
Formatted string representation of the initial presentment total amount.
next_attempt_atstringOptional
Date and time when the next payment attempt will occur.
payment_methodPaymentMethodDtoOptional
→ PaymentMethodDtopayment_method_idFlakeIdOptional
pending_changeSubscriptionChangeDtoOptional
→ SubscriptionChangeDtopresentment_currencystringOptional
Presentment currency code (currency shown to customer).
presentment_discount_amountintegerOptional
Presentment discount amount in smallest currency units.
presentment_discount_amount_strstringOptional
Formatted string representation of the presentment discount amount.
presentment_subtotal_amountintegerOptional
Presentment subtotal amount in smallest currency units.
presentment_subtotal_amount_strstringOptional
Formatted string representation of the presentment subtotal amount.
presentment_tax_amountintegerOptional
Presentment tax amount in smallest currency units.
presentment_tax_amount_strstringOptional
Formatted string representation of the presentment tax amount.
presentment_total_amountintegerOptional
Presentment total amount in smallest currency units.
presentment_total_amount_strstringOptional
Formatted string representation of the presentment total amount.
price_strstringOptional
Formatted string representation of the price.
pricing_region_idstringOptional
Identifier for the pricing region associated with this subscription.
product_idFlakeIdOptional
product_image_urlstringOptional
URL for the product image.
product_namestringOptional
Name of the product associated with this subscription.
product_version_idFlakeIdOptional
updated_atstringOptional
Date and time when the subscription was last updated.
tagsTagsResult[]Required
idFlakeIdRequired
store_idFlakeIdOptional
tagTagDtoOptional
created_atstringRequired
When the tag was created
created_byActorDtoRequired
→ ActorDtoenabledbooleanRequired
Indicates whether this tag is enabled.
idFlakeIdRequired
namestringRequired
The unique name for the tag.
slugstringRequired
The unique slug for the tag.
store_idFlakeIdRequired
descriptionstringOptional
The description of the tag.
image_urlstringOptional
The Image URL associated with the tag.
updated_atstringOptional
When the tag was last updated.
updated_byActorDtoOptional
→ ActorDtotrialsTrialResult[]Required
idFlakeIdRequired
store_idFlakeIdOptional
trialTrialDtoOptional
created_atstringRequired
The date and time when the trial was created.
customerCustomerDtoRequired
→ CustomerDtocustomer_idFlakeIdRequired
idFlakeIdRequired
period_scalestringRequired
The timescale unit for the trial period (e.g., "days", "weeks", "months").
period_valueintegerRequired
The duration value of the trial period.
pretty_idstringRequired
The human-readable formatted version of the trial identifier.
product_idFlakeIdRequired
product_namestringRequired
The name of the product being trialed.
product_version_idFlakeIdRequired
statusenumRequired
Possible enum values
createdThe trial has been created but is not yet active.
activeThe trial is currently active.
canceledThe trial has been canceled.
completedThe trial has been completed.
store_idFlakeIdRequired
canceled_atstringOptional
The date and time when the trial was canceled, if applicable.
canceled_byActorDtoOptional
→ ActorDtocheckout_idFlakeIdOptional
checkout_line_idFlakeIdOptional
ends_atstringOptional
The date and time when the trial period ends, if applicable.
product_image_urlstringOptional
The URL of the product image, if available.
starts_atstringOptional
The date and time when the trial period starts, if applicable.
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/dashboard/search" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.dashboard.searchDashboard();import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/dashboard/search", headers=headers)Response200
{
"affiliate_links": [
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"affiliate_link": {
"apply_for_subscriptions": true,
"code": "string",
"commission_amount": 0,
"commission_amount_steps": [
{
"billing_cycle_sequence": 0,
"commission_amount": 0
}
],
"commission_type": "none",
"created_at": "2024-01-01T00:00:00Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"discount_amount": 0,
"discount_type": "none",
"enabled": true,
"id": "411486491630370816",
"last_commission_amount_step_repeats": true,
"referer_type": "invalid",
"store_id": "411486491630370816",
"tracking_length_days": 0,
"wallet_id": "string",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2024-01-01T00:00:00Z"
}
}
],
"bans": [
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"ban": {
"created_at": "2024-01-01T00:00:00Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"enabled": true,
"id": "411486491630370816",
"identities": [
{
"ban_type": "unknown",
"ban_type_value": "string"
}
],
"reason": "string",
"store_id": "411486491630370816",
"updated_at": "2024-01-01T00:00:00Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"expires_at": "2024-01-01T00:00:00Z"
}
}
],
"coupons": [
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"coupon": {
"code": "string",
"created_at": "2024-01-01T00:00:00Z",
"discount_amount": 0,
"discount_apply_before_sales": true,
"discount_apply_individually": true,
"discount_type": "unspecified",
"duration": "once",
"enabled": true,
"id": "411486491630370816",
"minimum_order_value": 0,
"redeem_limit_customer_amount": 0,
"redeem_limit_customer_enabled": true,
"redeem_limit_store_amount": 0,
"redeem_limit_store_enabled": true,
"store_id": "411486491630370816",
"usable_on_one_time_purchase": true,
"usable_on_subscription": true,
"version_id": "411486491630370816",
"note": "string",
"duration_in_months": 0,
"duration_in_intervals": 0,
"apply_to_products": [
"411486491630370816"
],
"apply_to_tags": [
"411486491630370816"
],
"usable_by_customer_id": "411486491630370816",
"usable_at": "2024-01-01T00:00:00Z",
"expires_at": "2024-01-01T00:00:00Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2024-01-01T00:00:00Z"
}
}
],
"customers": [
{
"customer": {
"created_at": "2024-01-01T00:00:00Z",
"id": "411486491630370816",
"metadata": {},
"store_id": "411486491630370816",
"profile": {
"id": "string",
"name": "string",
"platform": "steam",
"avatar_url": "string"
},
"steam_id": "76561197960287930",
"steam": {
"avatar_url": "string",
"id": "76561197960287930",
"name": "string"
},
"minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"minecraft": {
"avatar_url": "string",
"id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"name": "notch"
},
"xbox_xuid": "string",
"minecraft_platform": "unknown",
"name": "m0uka",
"updated_at": "2024-01-01T00:00:00Z"
},
"id": "411486491630370816",
"store_id": "411486491630370816"
}
],
"facets": {
"unknown": 0,
"orders": 0,
"trials": 0,
"subscriptions": 0,
"customers": 0,
"coupons": 0,
"gameservers": 0,
"products": 0,
"sales": 0,
"api_keys": 0,
"bans": 0,
"affiliate_links": 0,
"tags": 0,
"giftcards": 0,
"stores": 0,
"users": 0,
"tickets": 0
},
"gameservers": [
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"gameserver": {
"created_at": "2024-01-01T00:00:00Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"enabled": true,
"id": "411486491630370816",
"linked_to": {
"hostname": "string",
"ip": "string",
"platform": "string",
"saved_at": "2024-01-01T00:00:00Z",
"version": "string",
"last_fetched_commands_at": "2024-01-01T00:00:00Z",
"last_fetched_commands_from_ip": "string"
},
"name": "string",
"store_id": "411486491630370816",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"token": "string",
"token_reset_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
}
],
"giftcards": [
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"giftcard": {
"balance": 2500,
"code": "GIFT-2024-ABCD1234",
"enabled": true,
"id": "411486491630370816",
"starting_balance": 5000,
"store_id": "411486491630370816",
"usable_at": "2024-01-01T00:00:00Z",
"note": "string",
"expires_at": "2024-01-01T00:00:00Z",
"created_at": "2024-01-01T00:00:00Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2024-01-01T00:00:00Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"canceled_at": "2024-01-01T00:00:00Z",
"canceled_by": {
"type": "anonymous",
"id": "411486491630370816"
}
}
}
],
"orders": [
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"order": {
"applied_coupons": [
{
"coupon_id": "411486491630370816",
"coupon_version_id": "411486491630370816",
"usage_amount": 0
}
],
"applied_giftcards": [
{
"giftcard_id": "411486491630370816",
"usage_amount": 0
}
],
"billing_country": "US",
"billing_cycle_sequence": 0,
"billing_email": "john.doe@example.com",
"billing_name": "John Doe",
"currency": "usd",
"customer": {
"created_at": "2024-01-01T00:00:00Z",
"id": "411486491630370816",
"metadata": {},
"store_id": "411486491630370816",
"profile": {
"id": "string",
"name": "string",
"platform": "steam",
"avatar_url": "string"
},
"steam_id": "76561197960287930",
"steam": {
"avatar_url": "string",
"id": "76561197960287930",
"name": "string"
},
"minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"minecraft": {
"avatar_url": "string",
"id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"name": "notch"
},
"xbox_xuid": "string",
"minecraft_platform": "unknown",
"name": "m0uka",
"updated_at": "2024-01-01T00:00:00Z"
},
"customer_id": "411486491630370816",
"customer_ip": "192.168.1.1",
"discount_amount": 500,
"discount_amount_str": "$5.00",
"giftcard_usage_amount": 0,
"giftcard_usage_amount_str": "$0.00",
"id": "411486491630370816",
"is_subscription": true,
"lines": [
{
"discount_amount": 0,
"discount_amount_str": "$0.00",
"gift": false,
"giftcard_usage_amount": 0,
"giftcard_usage_amount_str": "$0.00",
"id": "411486491630370816",
"presentment_discount_amount": 0,
"presentment_discount_amount_str": "€0.00",
"presentment_giftcard_usage_amount": 0,
"presentment_giftcard_usage_amount_str": "€0.00",
"presentment_subtotal_amount": 1999,
"presentment_subtotal_amount_str": "€19.99",
"presentment_tax_amount": 200,
"presentment_tax_amount_str": "€2.00",
"presentment_total_amount": 2199,
"presentment_total_amount_str": "€21.99",
"price": 1999,
"price_str": "$19.99",
"product_id": "411486491630370816",
"product_name": "Premium Game Pass",
"product_version_id": "411486491630370816",
"quantity": 1,
"subtotal_amount": 1999,
"subtotal_amount_str": "$19.99",
"tax_amount": 200,
"tax_amount_str": "$2.00",
"tax_inclusive": false,
"total_amount": 2199,
"total_amount_str": "$21.99",
"checkout_line_id": "411486491630370816",
"product_image_url": "https://cdn.example.com/images/premium-game-pass.jpg",
"description": "string",
"created_giftcard_id": "string",
"subscription_id": "411486491630370816",
"subscription_line_id": "411486491630370816",
"subscription_change_line_id": "411486491630370816",
"trial_id": "411486491630370816",
"subscription_interval_value": 1,
"subscription_interval_scale": "invalid",
"gift_to_customer_id": "411486491630370816",
"gift_to_customer": {
"created_at": "2024-01-01T00:00:00Z",
"id": "411486491630370816",
"metadata": {},
"store_id": "411486491630370816",
"profile": {
"id": "string",
"name": "string",
"platform": "steam",
"avatar_url": "string"
},
"steam_id": "76561197960287930",
"steam": {
"avatar_url": "string",
"id": "76561197960287930",
"name": "string"
},
"minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"minecraft": {
"avatar_url": "string",
"id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"name": "notch"
},
"xbox_xuid": "string",
"minecraft_platform": "unknown",
"name": "m0uka",
"updated_at": "2024-01-01T00:00:00Z"
},
"sale_id": "411486491630370816",
"sale_version_id": "411486491630370816",
"selected_gameserver_id": "411486491630370816",
"payout_splits": [
{
"platform_fee": 0,
"user_id": "411486491630370816",
"percentage": 0
}
],
"pricing_region_id": "eu",
"custom_variables": {}
}
],
"presentment_currency": "eur",
"presentment_discount_amount": 500,
"presentment_discount_amount_str": "€5.00",
"presentment_giftcard_usage_amount": 0,
"presentment_giftcard_usage_amount_str": "€0.00",
"presentment_subtotal_amount": 9995,
"presentment_subtotal_amount_str": "€99.95",
"presentment_tax_amount": 999,
"presentment_tax_amount_str": "€9.99",
"presentment_total_amount": 10494,
"presentment_total_amount_str": "€104.94",
"pretty_id": "pn-355eevennsow",
"status": "created",
"store_id": "411486491630370816",
"subtotal_amount": 9995,
"subtotal_amount_str": "$99.95",
"tax_amount": 999,
"tax_amount_str": "$9.99",
"tax_jurisdictions": [
{
"name": "EU OSS",
"taxes": [
{
"tax_amount": "string",
"tax_name": "string",
"tax_rate": "string",
"taxable_amount": "string"
}
],
"not_taxed_reason": "string"
}
],
"total_amount": 10494,
"total_amount_str": "$104.94",
"type": "one_time",
"checkout_id": "411486491630370816",
"checkout_token": "c4qqilpphugeqf2gndnkk5ad8fdq",
"subscription_id": "411486491630370816",
"coupon_id": "411486491630370816",
"giftcard_id": "411486491630370816",
"affiliate_id": "411486491630370816",
"billing_tax_id": "string",
"created_at": "2025-04-01T15:30:45Z",
"completed_at": "2025-04-01T15:35:22Z",
"last_payment_error": {
"decline_code": "unknown",
"message": "string"
}
}
}
],
"products": [
{
"id": "411486491630370816",
"total": 0,
"store_id": "411486491630370816",
"product": {
"allow_one_time_purchase": true,
"allow_subscription": true,
"commands": [
{
"content": "string",
"online_only": true,
"stage": "invalid",
"override_execute_on_gameserver_ids": [
"411486491630370816"
]
}
],
"custom_variable_ids": [
"411486491630370816"
],
"customer_stock_limit": {
"enabled": true,
"include_trials": true,
"time_scale": "invalid",
"quantity": 0,
"time_value": 0
},
"description": "string",
"gameservers": [
{
"enabled": true,
"id": "411486491630370816",
"name": "US 2x TRIO"
}
],
"id": "411486491630370816",
"name": "string",
"payout_splits": [
{
"platform_fee": 0,
"user_id": "411486491630370816",
"percentage": 0
}
],
"price": 0,
"remove_after_enabled": true,
"remove_after_time_scale": "invalid",
"remove_after_time_value": 0,
"required_product_ids": [
"411486491630370816"
],
"single_game_server_only": true,
"slug": "string",
"sort_order": 0,
"stock_available": {
"customer_available": 0,
"store_available": 0
},
"store_id": "411486491630370816",
"store_stock_limit": {
"enabled": true,
"include_trials": true,
"time_scale": "invalid",
"quantity": 0,
"time_value": 0
},
"subscription_interval_scale": "invalid",
"subscription_interval_value": 0,
"tags": [
{
"id": "411486491630370816",
"name": "Packages",
"slug": "packages"
}
],
"trial": {
"allow_repeat_trials": true,
"enabled": true,
"new_customer_order_lookback_scale": "invalid",
"new_customer_order_lookback_value": 0,
"new_customers_only": true,
"period_scale": "invalid",
"period_value": 0,
"repeat_trial_cooldown_scale": "invalid",
"repeat_trial_cooldown_value": 0,
"revoke_immediately_when_canceled": true
},
"upselling": {
"enabled": true,
"recommendations": [
{
"discount_amount": 0,
"discount_type": "unknown",
"prefer_as_subscription": true,
"recommended_product_id": "411486491630370816",
"type": "unknown",
"minimum_base_product_quantity": 0,
"minimum_recommended_product_quantity": 0,
"quantity_to_add": 0
}
]
},
"version_id": "411486491630370816",
"image_url": "string",
"label": "string",
"stock_limit_do_not_include_removed": true,
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"created_at": "2024-01-01T00:00:00Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2024-01-01T00:00:00Z",
"deliverable_actions": {
"grant_giftcard": true
},
"metadata": {},
"tax_code": "unknown",
"allow_concurrent_active_items": true,
"is_hidden": true,
"is_gifting_disabled": true,
"enabled_at": "2024-01-01T00:00:00Z",
"enabled_until": "2024-01-01T00:00:00Z",
"required_product_all": true,
"is_gift_cards_disabled": true,
"is_coupons_disabled": true,
"is_affiliate_links_disabled": true,
"tier_group_id": "411486491630370816"
}
}
],
"sales": [
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"sale": {
"apply_to_product_ids": [
"411486491630370816"
],
"apply_to_tag_ids": [
"411486491630370816"
],
"begins_at": "2024-01-01T00:00:00Z",
"created_at": "2024-01-01T00:00:00Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"discount_amount": 0,
"discount_type": "percent",
"duration": "unspecified",
"duration_in_intervals": 0,
"enabled": true,
"id": "411486491630370816",
"minimum_order_value": 0,
"name": "string",
"store_id": "411486491630370816",
"version_id": "411486491630370816",
"ends_at": "2024-01-01T00:00:00Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2024-01-01T00:00:00Z"
}
}
],
"stores": [
{
"id": "411486491630370816",
"store": {
"currency": "string",
"description": "string",
"game": "string",
"id": "411486491630370816",
"live_mode": true,
"name": "string",
"owner_id": "411486491630370816",
"platform": "string",
"slug": "string",
"website_url": "string",
"contact_email": "string",
"support_email": "string",
"support_url": "string",
"integration_type": "string",
"logo_url": "string",
"logo_square_url": "string",
"minecraft_bedrock_username_prefix": "string",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z",
"onboarding_completed_at": "2024-01-01T00:00:00Z",
"platform_store_type_association": {
"disable_billing_plans": true,
"display_disclaimers": true,
"full_external_management": true,
"platform_id": "411486491630370816",
"store_platform": "string",
"associated_platform": {
"accent_color": "string",
"business_name": "string",
"capabilities": [
"invalid"
],
"country_code": "string",
"created_at": "2024-01-01T00:00:00Z",
"description": "string",
"id": "411486491630370816",
"logo_url": "string",
"name": "string",
"slug": "string",
"type": "invalid",
"website_url": "string",
"updated_at": "2024-01-01T00:00:00Z",
"disabled_at": "2024-01-01T00:00:00Z"
},
"paynow_platform_fee_percentage_override": 0,
"connected_platform_fee_percentage": 0,
"connected_platform_wallet_id": "411486491630370816"
}
},
"store_id": "411486491630370816"
}
],
"subscriptions": [
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"subscription": {
"cancel_at_period_end": true,
"coupon_ids": [
"411486491630370816"
],
"created_at": "2024-01-01T00:00:00Z",
"currency": "string",
"customer": {
"created_at": "2024-01-01T00:00:00Z",
"id": "411486491630370816",
"metadata": {},
"store_id": "411486491630370816",
"profile": {
"id": "string",
"name": "string",
"platform": "steam",
"avatar_url": "string"
},
"steam_id": "76561197960287930",
"steam": {
"avatar_url": "string",
"id": "76561197960287930",
"name": "string"
},
"minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"minecraft": {
"avatar_url": "string",
"id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"name": "notch"
},
"xbox_xuid": "string",
"minecraft_platform": "unknown",
"name": "m0uka",
"updated_at": "2024-01-01T00:00:00Z"
},
"discount_amount": 0,
"discount_amount_str": "string",
"gift": true,
"id": "411486491630370816",
"initial_discount_amount": 0,
"initial_discount_amount_str": "string",
"initial_giftcard_usage_amount": 0,
"initial_giftcard_usage_amount_str": "string",
"initial_subtotal_amount": 0,
"initial_subtotal_amount_str": "string",
"initial_tax_amount": 0,
"initial_tax_amount_str": "string",
"initial_total_amount": 0,
"initial_total_amount_str": "string",
"interval_scale": "invalid",
"interval_value": 0,
"lines": [
{
"currency": "string",
"discount_amount": 0,
"discount_amount_str": "string",
"id": "411486491630370816",
"initial_discount_amount": 0,
"initial_discount_amount_str": "string",
"initial_giftcard_usage_amount": 0,
"initial_giftcard_usage_amount_str": "string",
"initial_subtotal_amount": 0,
"initial_subtotal_amount_str": "string",
"initial_tax_amount": 0,
"initial_tax_amount_str": "string",
"initial_total_amount": 0,
"initial_total_amount_str": "string",
"price": 0,
"product_id": "411486491630370816",
"product_name": "string",
"product_version_id": "411486491630370816",
"store_id": "411486491630370816",
"subscription_id": "411486491630370816",
"subtotal_amount": 0,
"subtotal_amount_str": "string",
"tax_amount": 0,
"tax_amount_str": "string",
"tax_inclusive": true,
"total_amount": 0,
"total_amount_str": "string",
"checkout_line_id": "411486491630370816",
"initial_order_line_id": "411486491630370816",
"pricing_region_id": "string",
"gift_to_customer_id": "411486491630370816",
"selected_gameserver_id": "411486491630370816",
"sale_id": "411486491630370816",
"sale_version_id": "411486491630370816",
"trial_id": "411486491630370816",
"product_image_url": "string",
"presentment_currency": "string",
"presentment_subtotal_amount": 0,
"presentment_subtotal_amount_str": "string",
"presentment_discount_amount": 0,
"presentment_discount_amount_str": "string",
"presentment_tax_amount": 0,
"presentment_tax_amount_str": "string",
"presentment_total_amount": 0,
"presentment_total_amount_str": "string",
"initial_presentment_discount_amount": 0,
"initial_presentment_discount_amount_str": "string",
"initial_presentment_subtotal_amount": 0,
"initial_presentment_subtotal_amount_str": "string",
"initial_presentment_giftcard_usage_amount": 0,
"initial_presentment_giftcard_usage_amount_str": "string",
"initial_presentment_tax_amount": 0,
"initial_presentment_tax_amount_str": "string",
"initial_presentment_total_amount": 0,
"initial_presentment_total_amount_str": "string"
}
],
"next_billing_amount": {
"currency": "string",
"discount": 0,
"subtotal": 0,
"tax": 0,
"total": 0
},
"next_billing_presentment_amount": {
"currency": "string",
"discount": 0,
"subtotal": 0,
"tax": 0,
"total": 0
},
"past_due": true,
"pretty_id": "string",
"price": 0,
"status": "invalid",
"store_id": "411486491630370816",
"subtotal_amount": 0,
"subtotal_amount_str": "string",
"tax_amount": 0,
"tax_amount_str": "string",
"tax_inclusive": true,
"tax_jurisdictions": [
{
"name": "EU OSS",
"taxes": [
{
"tax_amount": "string",
"tax_name": "string",
"tax_rate": "string",
"taxable_amount": "string"
}
],
"not_taxed_reason": "string"
}
],
"total_amount": 0,
"total_amount_str": "string",
"payment_method_id": "411486491630370816",
"payment_method": {
"created_at": "2025-03-15T10:20:30Z",
"customer_id": "411486491630370816",
"gateway": "string",
"gateway_customer_id": "string",
"gateway_entity_identifier": "string",
"gateway_id": "string",
"gateway_type": "card",
"id": "411486491630370816",
"method_details": {
"card": {
"brand": "visa",
"country": "US",
"exp_month": 12,
"exp_year": 2028,
"fingerprint": "abc123def456",
"funding": "credit",
"last4": "4242",
"bin": 424242,
"issuer": "Chase Bank",
"description": "Visa Signature",
"brand_product": "F",
"wallet": {
"type": "apple_pay"
}
},
"cashapp": {
"buyer_id": "buyer_abc123",
"cashtag": "$johndoe"
},
"paypal": {
"country": "US",
"payer_email": "john.doe@example.com",
"payer_id": "PAYERID123",
"payer_name": "John Doe",
"vault": true,
"pending_vault_approval": false,
"standalone_setup": false
},
"link": {
"email": "john.doe@example.com"
},
"crypto": {
"confirmations": 6,
"crypto_amount": "0.00150000",
"crypto_currency": "BTC",
"total_paid": "0.00150000",
"transaction_hashes": [
"string"
]
},
"steamskins": {
"items": [
{
"app_id": 730,
"id": "string",
"name": "AK-47 | Redline",
"price": 2500
}
]
},
"ideal": {
"bank": "abn_amro",
"bic": "ABNANL2A",
"iban_last4": 1234,
"payer_name": "John Doe"
},
"p24": {
"bank": "ing",
"payer_name": "Jan Kowalski"
},
"bancontact": {
"bank": "bnp_paribas",
"bank_name": "BNP Paribas",
"bic": "GEBABEBB",
"iban_last4": 3456,
"payer_name": "Jean Dupont"
},
"klarna": {
"country": "SE",
"method_category": "pay_later"
},
"alipay": {
"buyer_id": "buyer_abc123",
"fingerprint": "fingerprint_xyz789"
},
"pay_by_bank": {
"bank_name": "Chase Bank",
"bic": "CHASUS33",
"country": "US",
"payer_name": "John Smith"
},
"pix": {
"bank_name": "Banco do Brasil",
"bank_account_number": "12345-6",
"payer_name": "João Silva"
},
"paysafecard": {
"first_name": "string",
"last_name": "string",
"psc_id": "string",
"association_id": "string"
}
},
"method_type": "card",
"updated_at": "2025-03-20T14:30:00Z"
},
"pending_change": {
"created_at": "2024-01-01T00:00:00Z",
"id": "411486491630370816",
"lines": [
{
"amount": {
"currency": "string",
"discount": 0,
"subtotal": 0,
"tax": 0,
"total": 0
},
"id": "411486491630370816",
"is_deleted": true,
"presentment_amount": {
"currency": "string",
"discount": 0,
"subtotal": 0,
"tax": 0,
"total": 0
},
"price": 0,
"product": {
"custom_variables": {},
"id": "411486491630370816",
"name": "string",
"version_id": "411486491630370816",
"image_url": "string",
"selected_gameserver_id": "411486491630370816",
"pricing_region_id": "string"
},
"prorated_amount": 0,
"prorated_presentment_amount": 0,
"remaining_minutes": 0,
"tax_inclusive": true,
"total_minutes": 0,
"subscription_line_id": "411486491630370816"
}
],
"next_billing_amount": {
"currency": "string",
"discount": 0,
"subtotal": 0,
"tax": 0,
"total": 0
},
"next_billing_presentment_amount": {
"currency": "string",
"discount": 0,
"subtotal": 0,
"tax": 0,
"total": 0
},
"off_session": true,
"prorated_amount": {
"currency": "string",
"presentment_currency": "string",
"presentment_prorated_amount": 0,
"prorated_amount": 0
},
"proration_behavior": "invalid",
"status": "invalid",
"subscription_id": "411486491630370816",
"prorated_order_id": "411486491630370816",
"applied_at": "2024-01-01T00:00:00Z"
},
"coupon_id": "411486491630370816",
"coupon_repeating_ends_at": "2024-01-01T00:00:00Z",
"affiliate_id": "411486491630370816",
"checkout_id": "411486491630370816",
"checkout_line_id": "411486491630370816",
"billing_name": "string",
"billing_email": "string",
"billing_country": "string",
"billing_tax_id": "string",
"customer_ip": "string",
"gift_to_customer_id": "411486491630370816",
"gift_to_customer": {
"created_at": "2024-01-01T00:00:00Z",
"id": "411486491630370816",
"metadata": {},
"store_id": "411486491630370816",
"profile": {
"id": "string",
"name": "string",
"platform": "steam",
"avatar_url": "string"
},
"steam_id": "76561197960287930",
"steam": {
"avatar_url": "string",
"id": "76561197960287930",
"name": "string"
},
"minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"minecraft": {
"avatar_url": "string",
"id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"name": "notch"
},
"xbox_xuid": "string",
"minecraft_platform": "unknown",
"name": "m0uka",
"updated_at": "2024-01-01T00:00:00Z"
},
"product_id": "411486491630370816",
"product_version_id": "411486491630370816",
"product_name": "string",
"product_image_url": "string",
"price_str": "string",
"presentment_currency": "string",
"presentment_subtotal_amount": 0,
"presentment_subtotal_amount_str": "string",
"presentment_discount_amount": 0,
"presentment_discount_amount_str": "string",
"presentment_tax_amount": 0,
"presentment_tax_amount_str": "string",
"presentment_total_amount": 0,
"presentment_total_amount_str": "string",
"initial_presentment_discount_amount": 0,
"initial_presentment_discount_amount_str": "string",
"initial_presentment_subtotal_amount": 0,
"initial_presentment_subtotal_amount_str": "string",
"initial_presentment_giftcard_usage_amount": 0,
"initial_presentment_giftcard_usage_amount_str": "string",
"initial_presentment_tax_amount": 0,
"initial_presentment_tax_amount_str": "string",
"initial_presentment_total_amount": 0,
"initial_presentment_total_amount_str": "string",
"fx_rate": "string",
"pricing_region_id": "string",
"current_period_start": "2024-01-01T00:00:00Z",
"current_period_end": "2024-01-01T00:00:00Z",
"billing_cycle_sequence": 0,
"next_attempt_at": "2024-01-01T00:00:00Z",
"attempt_count": 0,
"updated_at": "2024-01-01T00:00:00Z",
"active_at": "2024-01-01T00:00:00Z",
"canceled_at": "2024-01-01T00:00:00Z",
"cancel_reason": "string",
"cancellation_requested_at": "2024-01-01T00:00:00Z"
}
}
],
"tags": [
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"tag": {
"created_at": "2024-01-01T00:00:00Z",
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"enabled": true,
"id": "411486491630370816",
"name": "string",
"slug": "string",
"store_id": "411486491630370816",
"description": "string",
"image_url": "string",
"updated_at": "2024-01-01T00:00:00Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
}
}
}
],
"trials": [
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"trial": {
"created_at": "2024-01-01T00:00:00Z",
"customer": {
"created_at": "2024-01-01T00:00:00Z",
"id": "411486491630370816",
"metadata": {},
"store_id": "411486491630370816",
"profile": {
"id": "string",
"name": "string",
"platform": "steam",
"avatar_url": "string"
},
"steam_id": "76561197960287930",
"steam": {
"avatar_url": "string",
"id": "76561197960287930",
"name": "string"
},
"minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"minecraft": {
"avatar_url": "string",
"id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"name": "notch"
},
"xbox_xuid": "string",
"minecraft_platform": "unknown",
"name": "m0uka",
"updated_at": "2024-01-01T00:00:00Z"
},
"customer_id": "411486491630370816",
"id": "411486491630370816",
"period_scale": "string",
"period_value": 0,
"pretty_id": "string",
"product_id": "411486491630370816",
"product_name": "string",
"product_version_id": "411486491630370816",
"status": "created",
"store_id": "411486491630370816",
"checkout_id": "411486491630370816",
"checkout_line_id": "411486491630370816",
"product_image_url": "string",
"starts_at": "2024-01-01T00:00:00Z",
"ends_at": "2024-01-01T00:00:00Z",
"canceled_at": "2024-01-01T00:00:00Z",
"canceled_by": {
"type": "anonymous",
"id": "411486491630370816"
}
}
}
]
}Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as
Authorization: APIKey TOKEN.Path parameters
storeIdstringRequired
Response
200OKDashboardSearchHintDto[]
Show fieldsHide fields
descriptionstringRequired
examplestringRequired
prefixstringRequired
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/dashboard/search-hints" \
-H "Authorization: APIKey TOKEN"import { createManagementClient } from "@paynow-gg/typescript-sdk";
const paynow = createManagementClient({
apiKey: "API_KEY",
storeId: "STORE_ID",
});
const result = await paynow.dashboard.getDashboardSearchHints();import requests
headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/dashboard/search-hints", headers=headers)Response200
[
{
"description": "string",
"example": "string",
"prefix": "string"
}
]