MCP tools

Quote ad account funds

Prices adding funds to an ad account from an ad account request exactly as add-ad-account-funds would charge, without creating anything: the budget that lands on the ad account, Koast's fee, the platform location fee and the total the user pays.

Tool name: quote-ad-account-funds.

Prices adding funds to an ad account from an ad account request exactly as add-ad-account-funds would charge, without creating anything: the budget that lands on the ad account, Koast's fee, the platform location fee and the total the user pays.

When to use

Use before add-ad-account-funds to tell the user what a budget costs with a payment method, or to compare card, bank transfer and crypto. It refuses exactly what adding the funds would refuse.

Access

PropertyValue
Required scoperead
PublishesNo
Read-onlyYes
DestructiveNo
IdempotentYes
Open worldYes

Input

FieldTypeRequiredDescription
requestIdstringYesThe ad account request id, or its Koast reference (KST-…). At most 40 characters.
adAccountIdstringYesThe ad account to fund, act_…: one of the request's accounts. At most 40 characters.
budgetCentsintegerYesThe budget to land on the ad account, in cents of the request's currency. Koast's fee and the platform location fee are added on top of it.
paymentMethodstringYesHow the customer pays: card, bank_transfer (a US bank transfer, USD accounts only) or crypto (USDC, USD accounts only, when Koast offers it). Koast's fee depends on it. One of card, bank_transfer, crypto.

Output

FieldTypeRequiredDescription
adAccountIdstringYes
paymentMethodstringYesHow the customer pays: card, bank_transfer (a US bank transfer, USD accounts only) or crypto (USDC, USD accounts only, when Koast offers it). Koast's fee depends on it. One of card, bank_transfer, crypto.
currencystringYes
budgetCentsintegerYesWhat lands on the ad account.
commissionRatenumberYesKoast's fee rate for this payment method: 0.04 is 4%.
commissionCentsintegerYesKoast's fee.
locationFeeRatenumberYesThe platform location fee rate: 0.025 is 2.5%.
locationFeeCentsintegerYesThe platform location fee.
netCentsintegerYesWhat Koast sends to the ad account: the budget plus the location fee, which the platform withholds.
amountCentsintegerYesThe total the customer pays.

REST equivalent

GET /v1/ad-account-requests/{requestId}/top-ups/quote, Quote ad account funds. CLI: koast quote-ad-account-funds.

On this page