Ends the account's monthly plan at the end of the month it is paid for, with no more charges and no refund for that month; monthly credits last until then, and pack and top-up credits stay. Until then, it can be undone. The dashboard session only, with no fresh sign-in: canceling only stops charges. Free.
Auth: the dashboard session cookie.
Send an idempotency-key header to retry safely: the same key and body within 1 day never repeat the work.
Example
curl -X POST 'https://socialtap.dev/v1/billing/subscription/cancel' \
-H "x-api-key: $SOCIALTAP_API_KEY" \
-H "content-type: application/json" \
-d '{
"cancel_at_period_end": true
}'On any POST: your unique key for the request (1–255 printable ASCII characters; a UUID is ideal), kept 24 hours. Retrying with the same key and body never repeats the work: the answer is the first request's result, in its current state.
Body
JSON. Fields marked nullable may be null; optional ones may be left out.
cancel_at_period_endbooleantrue ends the plan at current_period_end, with no more charges; monthly credits last until then. false keeps it renewing.
Response
200
Cancel the monthly plan, or undo it
dataobjectShowHide 12 child fields
cancel_at_period_endbooleanWhether it ends at current_period_end instead of renewing. Monthly credits end with it; pack and top-up credits stay.
current_period_endstring date-timenullableWhen this month's credits end and the plan renews, or ends: RFC 3339 UTC; null without a monthly plan.
idstringnullableSubscription ID (sub_…); null without a monthly plan.
monthly_creditsintegerCredits the plan adds at each renewal; 0 without a monthly plan.
monthly_credits_remainingintegerHow much of the balance is monthly credits: requests spend these first, and what is left of them ends at the next renewal. The rest of the balance never expires.
next_planstringnullableThe plan it changes to at the next renewal, after a downgrade; null when it stays on plan.
noticestringnullableWhat a person should know about the plan change just made, in a sentence to show them: its renewal is also being charged, say, or auto top-up's monthly cap is now below the top-up's price. Null otherwise, and on every read.
objectstringAlways subscription.
One ofsubscription
payment_urlstringnullableSet when a plan change could not be paid yet (the card was declined, or the bank asks the cardholder to confirm): pay here within a day and the change applies. Null otherwise.
planstringThe plan paid for now (catalog plan ID); payg without a monthly plan.
statusstringnone (pay as you go), incomplete (the first payment is not through yet), active, past_due (the last renewal failed: Stripe retries it, and no new credits arrive until it is paid) or unpaid (the retries ended without payment).
One ofnoneincompleteactivepast_dueunpaid
top_up_packstringnullableThe credit pack this plan's subscribers can top up with when they run out (catalog pack ID, also for auto top-up); null without a monthly plan.
metaobjectThe shared route meta (see the API reference introduction).
400
400 Bad Request.
invalid_inputNo retryA parameter is missing or malformed, or the link is not one this endpoint takes.
Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one.
401
401 Unauthorized.
unauthorizedNo retryThe x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired.
Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url.
403
403 Forbidden.
forbiddenNo retryThe API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code.
Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP.
409
409 Conflict.
idempotency_key_in_progressYes, laterA request with this Idempotency-Key is still running.
Retry after the seconds in the retry-after header to get that request's result.
422
422 Unprocessable.
idempotency_key_reusedNo retryThis Idempotency-Key was already used for a different request (another route or body). Or it was used for this same request, which ran and returned a secret we no longer keep (details.reason answer_expired): running it again would create another.
Use a new Idempotency-Key for a different request, and reuse a key only to retry the identical request. With reason answer_expired, check what the first request created (GET /v1/api_keys, GET /v1/webhook_endpoints) before sending it again under a new key.
429
429 Too Many Requests.
rate_limitedYes, laterThe account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it.
Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask support to raise the ceiling; without an API key, send one.
502
502 Bad Gateway.
upstream_errorYes, laterThe platform failed, or answered with something we could not read.
Retry with backoff. Failed requests are free.
operationId billing.subscription.cancel