Read the payment setup of a site

get_site_payment_status

Reads whether a site takes payments, its payment accounts and their status, and whether a checkout from the site would be accepted now.

POST /v1/get_site_payment_statusScopeconfig:readRead only

Payments are open on a few sites while we test them. On any other site this tool is refused with Payments are not available on this site yet!. To ask for access, use the support chat.

enabled says whether payments are on for the site, switchOn whether the site may take payments at all, and paidPlan whether the workspace is on a paid plan, which payments need. account is the payment account the site takes payments with, and accounts lists every account of the workspace with its country, business type, Live or Test mode and status: pending while Stripe sets it up, action_needed when the owner has details to give, ready when it takes payments, restricted or closed. Each account also carries DetailsDue, how many details Stripe still needs from the owner, and DetailsDueBy, the date Stripe needs them by. A ready account can owe details too, and it keeps taking payments until that date. accountsOpen counts the accounts that are not closed, out of accountsLimit. countries lists the countries an account can be opened in, each with its code and name. ready is true when a checkout from the site would be accepted now: payments are on, the plan is paid and the account in use is ready. canManage says whether the caller is the workspace owner, the only one who can change payments. The tool only reads. The Payments tab turns payments on or off, connects an account, sends the owner to Stripe for the details it needs and chooses the account. list_site_payments lists the payments and get_site_payment_analytics totals them.

Request

Call it with a POST to https://api.modulify.ai/v1/get_site_payment_status, sending the inputs below as a JSON object. The token needs the config:read scope.

It only reads and changes nothing, so retrying it is safe.

curl -X POST https://api.modulify.ai/v1/get_site_payment_status \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"projectId":"PROJECT_ID"}'

Over MCP, the same method is the get_site_payment_status tool.

Inputs

Input Type Required Description
projectId string Yes The site id.

Response

Every call answers with the JSON envelope of success, message, data, code and version. data holds the result described above, and on a method that returns a total, count carries it. The response headers carry the call's X-Request-Id and what is left of your per-minute budget in X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Errors explains every status code a call can answer with.