Reference

Cancel the plan

POST /v1/account/cancel. End a rolling plan at the end of its period, in one call, with no reason required; any notice terms in your agreement still apply.

Generated from the contractsView as Markdown

POST /v1/account/cancel

End a rolling plan at the end of its period, in one call, with no reason required; any notice terms in your agreement still apply. Credit pack credits never expire and survive cancellation, and delivered records stay licensed to the end of their term.

Property	Value
Endpoint	`POST https://mydatahub.emailmovers.com/v1/account/cancel`
Operation id	`cancelAccount`
Cost	Free (0 credits)
Access	An API key or an OAuth 2.1 token with the scope `admin`.
Tag	Account

Request

Parameters

Name	In	Type	Required	Description
`MyDataHub-Version`	header	string	no	The dated API version, pinned per key when left out. Non-breaking changes ship as new dates; the path major changes only for breaking changes, with a 12 month deprecation window.

Body

Member	Type	Required	Description
`reason`	string	no	Optional; never required.

Example request

curl -X POST "https://mydatahub.emailmovers.com/v1/account/cancel" \
  -H "Authorization: Bearer $MYDATAHUB_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "reason": "Campaign finished."
}'

Responses

200: When the plan ends and what is kept.

Headers: RateLimit, RateLimit-Policy.

Member	Type	Always present	Description
`plan`	string	yes
`cancel_at_period_end`	`true`	yes
`ends_at`	string (date)	yes
`pack_credits_kept`	number	yes	Credit pack credits never expire and survive cancellation.
`subscription_credits_usable_until`	string (date)	yes
`licences_unaffected`	`true`	yes	Delivered records stay licensed to the end of their term.

Example response

{
  "plan": "pay_as_you_go",
  "cancel_at_period_end": true,
  "ends_at": "2026-10-26",
  "pack_credits_kept": 5000,
  "subscription_credits_usable_until": "2026-10-26",
  "licences_unaffected": true
}

Errors

Every error is a problem object with a code and a next_step. Every response carries the RateLimit and RateLimit-Policy headers; see Rate limits.

Status	Problem codes	When
400	`invalid-request`, `idempotency-key-required`, `unsupported-version`	The request could not be read, or an Idempotency-Key is missing.
401	`authentication-required`, `account-required`	Sign in (OAuth) or send an API key (authentication-required), or create a free account for what the anonymous tier does not cover (account-required).
403	`insufficient-scope`, `confirmation-required`, `business-details-required`, `licence-acceptance-required`, `dpa-acceptance-required`, `agent-budget-exceeded`	The token lacks a scope (insufficient-scope, with required_scope and a WWW-Authenticate step-up challenge); no person confirmed the spend and no agent key covers it (confirmation-required, with an approval_url); an agent key's per-order cap or monthly budget does not cover it (agent-budget-exceeded); an account made by self-serve sign-up has not yet confirmed its business name and that it is a UK business, which its first order needs (business-details-required); the order needs the Data Licence and Sharing Agreement accepted at the version in force (licence-acceptance-required); or a suppression upload comes before the organisation has accepted the Article 28 data processing agreement in force (dpa-acceptance-required). Nothing is charged.
422	`validation-failed`, `quote-required`, `dataset-unavailable`	The request is not valid. errors lists every problem with a JSON pointer and did_you_mean.
429	`rate-limited`	Too many requests. Wait for Retry-After.
Any other failure	`internal-error`, `service-unavailable`, `tps-screen-expired`	Something failed on our side (500 internal-error) or the service is briefly unavailable (503 service-unavailable, with Retry-After). Nothing was charged; retry with the same Idempotency-Key. A count, sample, quote or order with telephone in play is also refused with 503 tps-screen-expired, with no Retry-After, while the dataset version's TPS and CTPS screen is more than 28 days old.