Skip to content

Cancel the scheduled change of the authenticated user's subscription

POST
/supporter/subscription/cancel_scheduled_change
curl --request POST \
--url https://example.com/api/v1/supporter/subscription/cancel_scheduled_change \
--header 'Authorization: Bearer <token>'

Cancels the change to a lower plan or to the monthly price that waits for the end of the period; the subscription renews at its current plan and interval. A 409 /api/v1/problems/supporter-subscription-state without a scheduled change.

Idempotency-Key
string
>= 1 characters <= 256 characters

A key the client chooses per request, which makes the request safe to send again. Within 24 hours, a request with a key that the same sign-in of the user in the same client (an anonymous client: the same address) already sent to the operation gets the first answer again instead of being carried out again. The same key with another request (another path, query, or body) is a 422 /api/v1/problems/idempotency-key-reused, and a repeat while the first request is still being carried out is a 409 /api/v1/problems/idempotency-key-in-use with a Retry-After of a second. Only an answer below 400 is kept: after a 4xx or 5xx the key is free, so a request sent again with it is carried out. A key longer than 256 characters, or one that is not UTF-8 without U+0000, is a 422.

The subscription without the scheduled change.

Media typeapplication/json

The authenticated user’s subscription to a supporter plan. price is what it renews at, which may be lower than the plan’s current price (a price change does not apply to the subscriptions that go on). The plan’s name is written by the administrators in any language; render it with dir="auto".

object
id
required

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
state
required

The state of a subscription. pending: started, not paid yet. active: paid. canceling: canceled at the end of the period. past_due: a payment failed less than 7 days ago. lapsed: a payment failed more than 7 days ago, or the subscription is paused. expired: ended. revoked: a full refund or a chargeback. abandoned: ended before its first payment. The role is held while active, canceling, or past_due.

string
Allowed values: pending active canceling past_due lapsed expired revoked abandoned
plan_id
required

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
plan_name
required
string
plan_rank
required

The plan’s rank, given also for a hidden plan, which the plan list leaves out: a change to a plan of a higher rank applies at once, to a lower one at the end of the period.

integer
interval
required

How often a subscription renews.

string
Allowed values: month year
price
required

Schema: Money

object
period_ends_at

The end of the current period: when it renews, or, while canceling, when it ends; omitted for pending.

string format: date-time
grace_ends_at

When a past_due subscription loses the plan’s role unless a payment succeeds.

string format: date-time
end_reason

Why a lapsed, expired, or revoked subscription lost the plan’s role; omitted in the other states. lapsed: no payment succeeded within 7 days after a payment failed, or the subscription is paused. reversed: a payment was refunded in full or charged back. plan_retired: the administrators retired the plan. account_suspended: the account was suspended. account_closed: the account was deleted. staff: an administrator canceled it. canceled: it was canceled, or it ended at the payment provider.

string
Allowed values: lapsed reversed plan_retired account_suspended account_closed staff canceled
scheduled_change
started_at
required
string format: date-time

Example

{
"id": "01890a5d-ac96-774b-bcce-b302099a8057",
"state": "pending",
"plan_id": "01890a5d-ac96-774b-bcce-b302099a8057",
"interval": "month",
"end_reason": "lapsed"
}
Cache-Control
string

The caching policy. Anonymous public GETs are cacheable by shared caches.

An error, as an RFC 9457 problem document.

Media typeapplication/problem+json

An RFC 9457 problem document. Besides about:blank, type is one of

  • /api/v1/problems/unauthenticated (401): the operation needs an access token and the request has none.
  • /api/v1/problems/invalid-token (401): the access token is malformed, unknown, expired, or revoked. Refresh it or sign in again.
  • /api/v1/problems/insufficient-scope (403): the access token lacks the scope that WWW-Authenticate names.
  • /api/v1/problems/first-party-only (403): the operation (password, two-factor authentication, passkeys, deleting the account) takes only the token of one of the server’s own clients, whatever its scopes.
  • /api/v1/problems/account-unavailable (403): the token is valid, but its user cannot use the app (registration pending or rejected, email unverified, the account deactivated or deleted, or a moderation action that disables its login). The user can still sign in to the server’s sign-in page, which says why.
  • /api/v1/problems/idempotency-key-reused (422): the Idempotency-Key was sent to the operation with another request in the last 24 hours. Choose a new key for a new request.
  • /api/v1/problems/idempotency-key-in-use (409): the request with this Idempotency-Key is still being carried out. Send it again after Retry-After for its answer.
  • /api/v1/problems/blocking (409): the viewer blocks the account, which keeps them from following it. Unblock it first.
  • /api/v1/problems/federation-restricted (403): the instance’s federation mode (Instance.federation.mode) does not let the operation through: following a remote account or resolving one (off, outbound), or quoting a remote status (off, inbound).
  • /api/v1/problems/media-too-large (413): the uploaded file is larger than the instance accepts.
  • /api/v1/problems/unsupported-media-format (415): the uploaded file is not in an accepted format or codec (such as HEVC video), or its declared type does not match its content.
  • /api/v1/problems/media-dimensions (422): the image is too wide or tall, or has too many pixels or frames; or the video has too many pixels or frames per second.
  • /api/v1/problems/media-too-long (422): the video or audio file is longer than the instance accepts.
  • /api/v1/problems/media-corrupt (422): the uploaded file cannot be read as a file of its format.
  • /api/v1/problems/media-attached (409): the media file is attached to a post and can no longer be changed on its own.
  • /api/v1/problems/too-many-streams (429): the user already has as many streams (GET /streaming) open as the server allows. Close one first.
  • /api/v1/problems/missing-permission (403): the user’s roles lack the permission that an admin operation needs.
  • /api/v1/problems/already-appealed (422): the user already appealed the moderation action or the refusal of a post; each is appealed once.
  • /api/v1/problems/appeal-window-closed (422): the time to appeal the moderation action or the refusal of a post has passed.
  • /api/v1/problems/not-appealable (422): the moderation action is a ban whose account is deleted, so it can no longer be appealed or overturned; or the decision of the automated review is not a refusal of the user’s post that is in force.
  • /api/v1/problems/appeal-decided (409): the appeal was already decided the other way.
  • /api/v1/problems/wrong-password (422): the password given to confirm the operation is not the user’s current password.
  • /api/v1/problems/deactivation-refused (409): the user’s own account cannot be deactivated now; the detail says why.
  • /api/v1/problems/export-in-progress (409): another data export of the user is being built. Wait for it to end.
  • /api/v1/problems/export-not-ready (409): the data export has no archive to download: it is being built, failed, or expired.
  • /api/v1/problems/import-in-progress (409): another import of the user is being carried out. Wait for it to finish.
  • /api/v1/problems/invalid-two-factor-code (422): the two-factor code is wrong, was already used, or is not a code.
  • /api/v1/problems/totp-setup-expired (422): the TOTP setup is unknown or expired. Start a new one.
  • /api/v1/problems/two-factor-enabled (409): the user already has two-factor authentication.
  • /api/v1/problems/two-factor-not-enabled (409): the user, or the account of an admin operation, has no two-factor authentication.
  • /api/v1/problems/invalid-passkey (422): the browser’s response to a passkey registration or confirmation does not verify, the passkey is registered already, or the passkey that confirms an operation is not one of the user’s.
  • /api/v1/problems/passkey-registration-expired (422): the passkey registration is unknown or expired. Start a new one.
  • /api/v1/problems/passkey-confirmation-expired (422): the confirmation with a passkey is unknown, expired, or used. Start a new one.
  • /api/v1/problems/too-many-passkeys (409): the user already has the most passkeys allowed. Remove one first.
  • /api/v1/problems/last-sign-in-method (409): the operation would leave the user no way to sign in: the password, the last passkey, or the last linked account when nothing else signs the user in.
  • /api/v1/problems/login-providers-only (403): registration and sign-in are limited to the login providers, so a password cannot be set and a passkey cannot be added.
  • /api/v1/problems/external-confirmation-expired (422): the confirmation with a linked login provider is unknown, expired, used, or for another operation. Start a new one.
  • /api/v1/problems/login-provider-unavailable (422): the login provider is unknown or disabled, does not allow links, or the user links no account at it.
  • /api/v1/problems/login-provider-linked (409): the user links an account at the login provider already.
  • /api/v1/problems/too-many-oauth-apps (409): the user already has the most OAuth apps allowed (25). Delete one first.
  • /api/v1/problems/oauth-app-registration-disabled (403): the server does not let users register OAuth apps.
  • /api/v1/problems/public-oauth-app (409): the OAuth app is public and has no secret.
  • /api/v1/problems/oauth-app-disabled (409): an administrator disabled the OAuth app.
  • /api/v1/problems/invalid-custom-emoji (422): a custom emoji breaks a rule; reason says which.
  • /api/v1/problems/invalid-webhook (422): a webhook breaks a rule; reason says which.
  • /api/v1/problems/invalid-relay (422): a relay cannot be registered, joined, left, or deleted; reason says why.
  • /api/v1/problems/invalid-theme (422): the theme’s token set breaks a rule; the problem lists every reason in theme_errors (PUT /admin/theme/draft, POST /admin/theme/publish, POST /admin/theme/restore).
  • /api/v1/problems/invalid-brand (422): the brand image breaks a rule; brand_error says why (/admin/instance/brand/...).
  • /api/v1/problems/service-closure-state (409): the state of the service closure does not allow the operation: withdrawing an announcement when none is in effect, announcing the closure of a server that is closed already (/admin/closure/announcement), or closing a server whose closure is not announced or whose closes_at has not come (POST /admin/closure/close).
  • /api/v1/problems/service-closing (409): the closure of the service is announced, which stops new registrations and supporter subscriptions: approving a pending registration (/admin/registrations/{id}/approve) or starting a supporter checkout (POST /supporter/checkout).
  • /api/v1/problems/service-closed (403): the server is closed. A closed server serves only the operations with which the users take their data away: their own account and preferences (verify_credentials, /preferences, /accounts/password, /two_factor, /passkeys read), the exports (/exports, /csv_exports), their sessions (/sessions, /authorized_apps), GET /instance, GET /instance/health, GET /instance/documents, POST /client_errors, and the administrators’ operations that follow the closure (/admin/closure, /admin/queue, /admin/jobs). Every other operation, the streaming endpoint included, is refused with this problem; signing in and resetting a password stay available outside the client API.
  • /api/v1/problems/too-many-domain-mutes (422): the user already mutes the most domains allowed. Unmute one first.
  • /api/v1/problems/too-many-keyword-filters (422): the user already has the most keyword filters allowed. Delete one first.
  • /api/v1/problems/too-many-filter-keywords (422): the words would pass the most a keyword filter, or all the user’s filters together, may have. Remove some first.
  • /api/v1/problems/too-many-lists (422): the user already has the most lists allowed. Delete one first.
  • /api/v1/problems/too-many-list-members (422): the list already has the most members allowed. Remove one first.
  • /api/v1/problems/not-followed (422): only an account that the user follows (whose follow request was accepted) can be added to a list.
  • /api/v1/problems/follows-hidden (403): the account’s follows_visibility keeps its follows and followers lists from the viewer (/accounts/{id}/following, /accounts/{id}/followers). Its counts stay on the account.
  • /api/v1/problems/too-many-followed-tags (422): the user already follows the most hashtags allowed (100). Unfollow one first.
  • /api/v1/problems/too-many-featured-tags (422): the user asked to feature more hashtags than allowed (10).
  • /api/v1/problems/invalid-alias (422): the handle or URL of an alias leads to no account’s actor, or to the user itself.
  • /api/v1/problems/too-many-aliases (422): the user already has the most aliases allowed (5). Remove one first.
  • /api/v1/problems/role-managed-by-plan (409): the role is the role of a supporter plan: only its subscriptions grant and revoke it, and its permissions and position change from the plan (PATCH /admin/supporter_plans/{id}). Its badge changes as any role’s.
  • /api/v1/problems/breaks-supporter-roles (409): the change would put a staff role (one with a moderation or server permission) at or below the role of a supporter plan.
  • /api/v1/problems/supporters-unavailable (409): the supporter program needs a payment provider in the deployment’s configuration and a server that sends email.
  • /api/v1/problems/live-subscriptions (409): subscriptions to the supporter plans go on; retire the plans and wait for the subscriptions to end before disabling the program.
  • /api/v1/problems/invalid-supporter-plan (422): a supporter plan breaks a rule; reason says which.
  • /api/v1/problems/supporter-plan-retired (409): the supporter plan is retired and does not change any more.
  • /api/v1/problems/subscription-ended (409): the subscription has ended already.
  • /api/v1/problems/supporter-ineligible (422): the user may not subscribe to a supporter plan: not a local user, the primary email address is not verified, or the account is restricted.
  • /api/v1/problems/supporter-subscribed (409): the user has a subscription that goes on already; change its plan instead.
  • /api/v1/problems/supporter-plan-unavailable (422): the supporter plan takes no subscriptions: hidden, retired, not ready, or of another currency.
  • /api/v1/problems/supporter-subscription-state (409): the subscription’s state does not allow the operation.
  • /api/v1/problems/supporter-same-plan (422): the subscription has that plan and interval already.
  • /api/v1/problems/supporter-payment-failed (402): the payment of a change of plan failed, or the card needs an authentication that the change cannot ask for. The plan stays and nothing was charged; update the card and try again.
  • /api/v1/problems/supporter-payment-processing (409): the payment of a change of plan has not settled. The plan stays, and moves if the payment succeeds.
  • /api/v1/problems/supporter-tip-amount (422): the amount of the tip is not one of the amounts of GET /instance/tip_amounts.
  • /api/v1/problems/supporter-tip-pending (409): another start of a tip of the user’s runs at the same time; try again.
  • /api/v1/problems/tips-unavailable (409): the tips need the supporter program enabled on the configured payment provider, which takes one-time payments.
  • /api/v1/problems/invalid-tip-amounts (422): the amounts of the tips break a rule; reason says which.
  • /api/v1/problems/voice-not-eligible (403): the user may not host voice chat rooms.
  • /api/v1/problems/voice-not-host (403): only the host of the voice chat room may do this.
  • /api/v1/problems/voice-room-full (409): the voice chat room holds as many people as the server allows.
  • /api/v1/problems/voice-too-many-rooms (409): as many voice chat rooms are open as the server allows.
  • /api/v1/problems/voice-hosting-elsewhere (409): the user hosts another open voice chat room; leave it first, choosing the next host or ending it.
  • /api/v1/problems/voice-host-must-choose (409): the host leaves a room with other participants; choose the next host or end the room.
  • /api/v1/problems/voice-invalid-next-host (422): the next host is not a participant of the room who may host rooms.
  • /api/v1/problems/voice-conflict (409): the room changed meanwhile; try again.
  • /api/v1/problems/voice-unavailable (503): the server could not prepare the connection to the room.
  • /api/v1/problems/invites-not-allowed (403): the user may not create invites of their own now: the instance setting invite_creators and the user’s roles do not let them, the account is suspended or limited, its registration is not approved, or the registration is closed. Its reason says which.
  • /api/v1/problems/too-many-invites (409): the user already holds as many usable invites as the instance setting member_invite_max_active allows. Revoke one or wait for one to expire or be used up.
  • /api/v1/problems/registration-closed (409): the registration mode is closed, which takes no invite.
  • /api/v1/problems/target-outranks-actor (403): the admin operation on an account needs the user to rank above the account: the highest position among the user’s roles must be above that of every role of the account, so it refuses a higher or equal rank and the user’s own account.
  • /api/v1/problems/last-administrator (409): the operation would leave the instance without an administrator. Make another user an administrator first.
  • /api/v1/problems/account-moved (403): the user’s account moved to another account, so it cannot post, boost, react, follow, or vote. Cancel the move first (DELETE /accounts/move).
  • /api/v1/problems/posting-restricted (403): a moderation action keeps the user’s account from posting: a post, an article, a post on an event’s board, an edit, or a boost. The user appeals it from Account status in the settings (/settings/account/status of the web client).
  • /api/v1/problems/interaction-restricted (403): a moderation action keeps the user’s account from interacting: following, favouriting, boosting, reacting, replying, quoting, or voting in a poll. The user appeals it as a posting restriction.
  • /api/v1/problems/current-session (409): the browser that asks cannot sign itself out through DELETE /sessions/{id}; signing out ends it.
  • /api/v1/problems/account-not-moved (409): the user’s account has not moved, so there is no move to cancel.
  • /api/v1/problems/move-alias-missing (422): the account to move to does not list the user’s account among its aliases (alsoKnownAs). Add the alias on that account first.
  • /api/v1/problems/move-target-moved (422): the account to move to moved itself.
  • /api/v1/problems/move-target-unavailable (422): the account to move to is the user’s own, is not found, cannot be fetched from its server, or is suspended here.
  • /api/v1/problems/move-too-soon (422): the user’s account moved less than 30 days ago, also counting a canceled move; can_move_at says from when it can move again.
  • /api/v1/problems/move-repeated (422): the user’s account moved to that account before, and it moves to an account once.
  • /api/v1/problems/maintenance (503): the server is under maintenance and answers every operation with this problem and Retry-After. Keep the tokens, show the maintenance, and retry after Retry-After. Its members besides the standard ones, each present only when the operator set it: message, the administrators’ notice in plain text; until, when the maintenance is expected to end (RFC 3339); and status_page_url, the instance’s status page.
  • /api/v1/problems/custom-emoji-request-conflict (409): a request for a custom emoji is not in the state the operation needs, or was decided meanwhile.
  • /api/v1/problems/email-already-verified (409): the primary email address is already confirmed, so no confirmation mail is sent.
  • /api/v1/problems/hook-decision-not-overridable (409): the decision of a decision hook had no effect, or is a reject of local.status, which goes through its appeal.
  • /api/v1/problems/report-not-forwardable (409): the report cannot be forwarded to the target’s server: it came from another server, is about a local account or a voice chat room, or its target is gone.
  • /api/v1/problems/status-rejected (422): the server’s automated review refused the post and nothing was posted. The problem carries hook_decision_id and appeal_deadline; the user may appeal (POST /hook_decisions/{id}/appeal).
  • /api/v1/problems/profile-rejected (422): the server’s automated review refused the change of the profile, which stays as it was. It cannot be appealed; the user may change the profile and save it again.
  • /api/v1/problems/email-not-suppressed (409): the email address of the account is not suppressed, so there is nothing to lift.
  • /api/v1/problems/invalid-login-provider (422): a login provider breaks a rule; reason says which.
  • /api/v1/problems/invalid-role (422): a role change breaks a rule; reason says which.
  • /api/v1/problems/translation-failed (503): no translation provider returned a usable translation; asking again may work.
  • /api/v1/problems/translation-limit (429): a monthly limit on translated characters is reached, until the next month in UTC.
  • /api/v1/problems/translation-unavailable (422): no translation provider may receive the post.
  • /api/v1/problems/translation-unsupported-language (422): the translation providers do not translate the language.
  • /api/v1/problems/voice-already-invited (409): the account is already invited to the room.
  • /api/v1/problems/voice-cannot-speak (403): the participant may not speak in the room.
  • /api/v1/problems/voice-invalid-invitee (422): the account cannot be invited to the room.
  • /api/v1/problems/voice-invalid-participant (422): the account is not a participant that the operation can act on.
  • /api/v1/problems/voice-not-host-or-cohost (403): the operation is for the host and the co-hosts of the room.
  • /api/v1/problems/voice-too-many-cohosts (409): the room has as many co-hosts as it can.
  • /api/v1/problems/event-not-eligible (403): the user may not create events.
  • /api/v1/problems/event-not-organizer (403): the operation is for the organizer and the co-organizers of the event.
  • /api/v1/problems/event-organizer-only (403): the operation is for the organizer of the event.
  • /api/v1/problems/event-closed (409): the event was cancelled, or has started for an answer.
  • /api/v1/problems/event-full (409): the attendees who answer going reached the capacity.
  • /api/v1/problems/event-voice-unavailable (422): the event cannot be held in a voice chat room: the voice chat is off, or its organizer may not host rooms.
  • /api/v1/problems/event-already-invited (409): the account is already invited to the event.
  • /api/v1/problems/event-invalid-invitee (422): the account cannot be invited to the event.
  • /api/v1/problems/event-invalid-coorganizer (422): the account cannot co-organize the event.
  • /api/v1/problems/event-too-many-coorganizers (409): the event has as many co-organizers as it can.
  • /api/v1/problems/event-not-attending (422): the account does not answer going or maybe.
  • /api/v1/problems/event-attendee-organizes (422): the account organizes or co-organizes the event, so it always sees the places and is not approved or revoked.
  • /api/v1/problems/event-board-not-reader (403): the user sees the event but does not read its board: the user neither organizes it nor answers going or maybe.
  • /api/v1/problems/event-board-not-writer (403): the event’s board_writers do not let the user post on its board.
  • /api/v1/problems/event-board-closed (409): the board of the event is read-only: the event was cancelled, or 7 days have passed since its end (it is writable for the 7 days after the end).
  • /api/v1/problems/event-unscheduled (409): the event polls its date and has none yet.
  • /api/v1/problems/event-scheduled (409): the date of the event was confirmed, so its date poll takes no more candidates, answers, or confirmations.
  • /api/v1/problems/event-last-candidate (409): the last candidate of a date poll cannot be withdrawn.
  • /api/v1/problems/search-unavailable (404): the server has no search engine, so posts cannot be searched (Instance.full_text_search.available).
  • /api/v1/problems/search-failed (503): the search engine could not answer. Only the search of posts is affected; try again later.
  • /api/v1/problems/single-user-mode (404): the server is a one-person server (Instance.single_user), which does not offer the operation: the local and federated timelines, the suggestions of accounts, invites, the review of registrations, and the sign-up blocks. It works again when the server stops being one.
  • /api/v1/problems/single-user-requires-one-account (422): the instance setting single_user can be turned on only while the server has exactly one local account; detail says how many it has.
object
type
required

A URI that identifies the problem type, stable for clients to branch on. It is about:blank when the problem means no more than its HTTP status.

string format: uri-reference
title
required

A short summary of the problem type, localized from Accept-Language.

string
status
required

The HTTP status code.

integer
>= 400 <= 599
detail

An explanation of this occurrence, localized from Accept-Language.

string
request_id

The request ID (the X-Request-Id response header), for reporting the problem.

string
field

The member of the request that a 422 is about, by its name in the request: a property of the JSON body by its path (display_name, fields[].name, poll.options[1]), a form field, a query parameter, or a header (Idempotency-Key). detail then says what is wrong with its value without naming it, for the client to show beside that field. Absent when the problem is not about one member.

string

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"request_id": "example",
"field": "example"
}
Content-Language
string

The locale of title and detail.

Cache-Control
string

Always no-store; problems are never cached.

WWW-Authenticate
string

The Bearer challenge of a 401 or a 403 insufficient_scope (RFC 6750 §3), with error and, for insufficient_scope, the scope the operation needs.

Retry-After
integer
>= 1

The seconds to wait before retrying, on a 429 (for translation-limit, until the next month in UTC) and on a 503 of the streaming endpoint.

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site