StatusSupportGet API keyDashboard
BillingChange the monthly plan

Billing

Change the monthly plan

Use with AI

PATCH /v1/billing/subscription

Upgrades or downgrades the account's monthly plan. An upgrade starts now: the new plan's full price is charged to the saved card, a new month starts today, the plan's credits are added and the monthly credits left stay until the next renewal. A downgrade starts at the next renewal, with nothing charged now. It works in every state of the plan, and answers what the person should know in notice, or where to pay in payment_url; only an account with no card is refused, until it adds one. The dashboard session only, with no fresh sign-in: changing plan has to be as easy as subscribing was. Free.

Auth: the dashboard session cookie.

Example

cURL
curl -X PATCH 'https://socialtap.dev/v1/billing/subscription' \
  -H "x-api-key: $SOCIALTAP_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "plan": "string"
}'

Authorizations

The dashboard's session cookie, not an API key.

Body

application/json

JSON. Fields marked nullable may be null; optional ones may be left out.

planstring

Change to this monthly plan (catalog plans). A dearer one starts now: its full price is charged to the saved card, a new month starts today, and the monthly credits left stay until the next renewal. A cheaper one starts at the next renewal, with nothing charged now.

Response

application/json

200

Change the monthly plan

dataobject
ShowHide 12 child fields
cancel_at_period_endboolean

Whether it ends at current_period_end instead of renewing. Monthly credits end with it; pack and top-up credits stay.

current_period_endstring date-timenullable

When this month's credits end and the plan renews, or ends: RFC 3339 UTC; null without a monthly plan.

idstringnullable

Subscription ID (sub_…); null without a monthly plan.

monthly_creditsinteger

Credits the plan adds at each renewal; 0 without a monthly plan.

monthly_credits_remaininginteger

How 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_planstringnullable

The plan it changes to at the next renewal, after a downgrade; null when it stays on plan.

noticestringnullable

What 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.

objectstring

Always subscription.

One ofsubscription

payment_urlstringnullable

Set 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.

planstring

The plan paid for now (catalog plan ID); payg without a monthly plan.

statusstring

none (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_packstringnullable

The 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.

metaobject

The shared route meta (see the API reference introduction).

400

400 Bad Request.

invalid_inputNo retry

A 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 retry

The 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 retry

The 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.

429

429 Too Many Requests.

rate_limitedYes, later

The 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, later

The platform failed, or answered with something we could not read.

Retry with backoff. Failed requests are free.

operationId billing.subscription.update