EmailmoversMyDataHub docs
Browse the docs

Reference / MCP tool reference

Reference

Plans and prices

get_plans: Returns the plans of MyDataHub by Emailmovers, the UK B2B count engine: credit packs, credit rules, licence terms, the bounce warranty and the free trial, in GBP excluding VAT.

Generated from the contractsView as Markdown

Returns the plans of MyDataHub by Emailmovers, the UK B2B count engine: credit packs, credit rules, licence terms, the bounce warranty and the free trial, in GBP excluding VAT. Use it when the user asks what a list costs or which plan fits; it is free and needs no account. One credit buys one complete UK record at the same price in the app, the API and here. Call get_account for the caller's own balance, or count_audience to size a list. Lawful basis is UK GDPR Article 6(1)(f) legitimate interests; email audiences include corporate subscribers only by default (PECR), so sole traders and ordinary partnerships are left out unless the toggle is changed.

PropertyValue
Tool nameget_plans
Position in tools/list1 of 22
CostFree
ScopeNone. Works without an account.
AnnotationsreadOnlyHint true, destructiveHint false, idempotentHint true, openWorldHint false
KindRead only; idempotent, not destructive, closed world
REST equivalentGET /v1/plans

Input

This tool takes no arguments. The schema sets additionalProperties to false, so any member is refused.

Example call

The params of a tools/call request:

{
  "name": "get_plans",
  "arguments": {}
}

Output

The result carries structuredContent that matches this schema, and one line of text that leads with the number.

MemberTypeAlways presentDescription
versionstringyes
valid_fromstring (date)yes
currencyGBPyes
vat_treatmentstringyes
credit_definitionstringyes
price_scalePriceScaleyesThe per-contact scale: 1 credit buys 1 record at the rate of the band the purchase falls in. A quote's purchase options compare it with the credit pack and lead with the cheapest.
price_scale.idper_contact_scaleyes
price_scale.namestringyes
price_scale.statusenum: confirmed, proposed, to_confirmyesconfirmed is in force; proposed awaits a decision; to_confirm is a figure still being checked.
price_scale.available_toenum: everyone, new_customers, existing_customersyeseveryone; new_customers only (the subscription); existing_customers only, who keep their prices (pay as you go and the 12-month plan).
price_scale.minimum_order_recordsinteger (0 or more)yes
price_scale.rulestringyesHow a purchase is priced, in words.
price_scale.bandsarray of PriceBandyes
plansarray of Planyes
plans[].idstringyesSuch as free, pay_as_you_go or plan_12_month.
plans[].namestringyes
plans[].kindenum: free, subscription, packyes
plans[].statusenum: confirmed, proposed, to_confirmyesconfirmed is in force; proposed awaits a decision; to_confirm is a figure still being checked.
plans[].available_toenum: everyone, new_customers, existing_customersyeseveryone; new_customers only (the subscription); existing_customers only, who keep their prices (pay as you go and the 12-month plan).
plans[].price_gbp_ex_vatnumber (0 or more)yesPounds sterling excluding VAT, to two decimal places.
plans[].billing_periodenum: once, month, yearyes
plans[].contract_monthsinteger (0 or more) or nullnoThe contract's length in months, such as 12; absent when there is none.
plans[].annual_price_gbp_ex_vatnumber (0 or more) or nullno
plans[].creditsinteger (0 or more)yesCredits per billing period, or once.
plans[].per_record_gbpnumber (0 or more) or nullyesPrice per record at full use of the allowance; null for the free plan.
plans[].rollover_cap_creditsinteger (0 or more) or nullnoSubscription credits roll over while subscribed, up to this many; 0 when each period's credits are used or lost.
plans[].credits_expirebooleanyes
plans[].for_whomstringyes
plans[].notesstringno
credit_packsarray of CreditPackyes
credit_packs[].idstringyesSuch as free, pay_as_you_go or plan_12_month.
credit_packs[].namestringyes
credit_packs[].kindpackyes
credit_packs[].statusenum: confirmed, proposed, to_confirmyesconfirmed is in force; proposed awaits a decision; to_confirm is a figure still being checked.
credit_packs[].available_toenum: everyone, new_customers, existing_customersyeseveryone; new_customers only (the subscription); existing_customers only, who keep their prices (pay as you go and the 12-month plan).
credit_packs[].price_gbp_ex_vatnumber (0 or more)yesPounds sterling excluding VAT, to two decimal places.
credit_packs[].billing_periodonceyes
credit_packs[].contract_monthsinteger (0 or more) or nullnoThe contract's length in months, such as 12; absent when there is none.
credit_packs[].annual_price_gbp_ex_vatnumber (0 or more) or nullno
credit_packs[].creditsinteger (0 or more)yesCredits per billing period, or once.
credit_packs[].per_record_gbpnumber (0 or more) or nullyesPrice per record at full use of the allowance; null for the free plan.
credit_packs[].rollover_cap_creditsinteger (0 or more) or nullnoSubscription credits roll over while subscribed, up to this many; 0 when each period's credits are used or lost.
credit_packs[].credits_expirebooleanyes
credit_packs[].for_whomstringyes
credit_packs[].notesstringno
credit_rulesarray of CreditRuleyes
credit_rules[].actionstringyes
credit_rules[].labelstringyes
credit_rules[].creditsnumber (0 or more)yesCredits, to one decimal place: whole at 1 credit a record, fractional only where a rule is (0.1 company-only, 1.8 outright, both proposed).
credit_rules[].unitenum: call, record, matchyes
credit_rules[].statusenum: confirmed, proposed, to_confirmyesconfirmed is in force; proposed awaits a decision; to_confirm is a figure still being checked.
credit_rules[].notestringno
licencearray of LicenceTermsyes
licence[].licence_typeenum: multi_use_12m, outrightyesmulti_use_12m (12 month multi-use, every plan) or outright (1.8 credits a record, proposed).
licence[].statusenum: confirmed, proposedyes
licence[].credits_per_recordnumberyes
licence[].permitted_channelsarray of enum: email, telephone, postyes
licence[].reuse_monthsinteger or nullyes12 for multi_use_12m; null for outright.
licence[].resale_prohibitedbooleanyes
licence[].warranty_urlstring (uri)yes
licence[].terms_versionstringyes
guaranteeobjectyes
guarantee.currentWarrantyyesThe bounce warranty that covers delivered records, with the threshold it was issued under.
guarantee.proposedWarranty or nullyes
guarantee.refundsarray of stringyes
trialobjectyes
trial.creditsinteger (0 or more)yes
trial.card_requiredbooleanyes
trial.expiresbooleanyes
promisesarray of PricingPromiseyes
promises[].keystringyes
promises[].statementstringyes
promises[].in_practicestringyes
metersarray of MeteryesWhat agents and code are metered on, in credits, the same on every surface.
meters[].actionstringyesWhat is metered, such as record or enrich_contact.
meters[].unitenum: record, match, callyes
meters[].creditsnumber (0 or more)yesCredits per unit.
meters[].statusenum: confirmed, proposed, to_confirmyesconfirmed is in force; proposed awaits a decision; to_confirm is a figure still being checked.
action_patharray of ActionPathStepyesHow to buy: quote_order for a machine quote, create_order with a confirmation, and the top-up page when the balance is short.
action_path[].stepinteger (1 or more)yes

Showing the first 80 of 83 members. The OpenAPI document and the MCP tool list hold the full schema.

Errors

A failed call returns isError true. The text content leads with the sentence a person acts on, then the whole problem as JSON, with code, detail, next_step and did_you_mean. A 401 and a step-up 403 are answered at HTTP level so the client can start authorisation. See Errors.