# Cancel at the end of the paid month

`DELETE /v1/console/subscription` (operation id `cancelSubscription`)

Sets `cancel_at_period_end`. The plan and its weekly allowance stay until `current_period_end`; afterwards
requests are paid from the balance at the standard rate. Cancelling again answers 200 with the same state.
Without an active subscription: 409 `no_subscription`. When Stripe refuses (restricted key): 503 `maintenance`.

Authentication: Console session cookie (`__Host-dex_session`), or an app session token (`Authorization: Bearer dex_ses_...`). With the cookie, state-changing routes also need the `x-dex-csrf` header.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `x-dex-csrf` | header | string | no | The `csrf_token` returned by `createSession` (or handed over in the `completeGoogleSignIn` redirect). Required with the session cookie on every state-changing console route; not used with a bearer app session.  (32 to 64 characters) |

## Responses

### 200

The subscription, now ending at the period end.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | (always "subscription") |
| `plan` | string \| null | yes | The current plan; null when the account has no subscription. (one of "base", "hot", "fierce", null) |
| `status` | string | yes | `none`: never subscribed, or the last subscription ended and the account is back on pay as you go. `incomplete`: Checkout started, the first payment is not settled yet (delayed payment methods). `active`: paid up; the weekly allowance is available. `past_due`: a renewal payment failed, the allowance stays available during the grace period. `frozen`: the grace period passed, requests are paid from the balance until the subscription is paid or ends. `canceled`: ended; `plan` is null.  (one of "none", "incomplete", "active", "past_due", "frozen", "canceled") |
| `cancel_at_period_end` | boolean | yes | The subscription ends at `current_period_end` (cancelSubscription). |
| `scheduled_plan` | string \| null | yes | A cheaper plan that applies at `current_period_end` (updateSubscription to a cheaper plan); null otherwise. (one of "base", "hot", "fierce", null) |
| `current_period_start` | string \| null | yes | (format date-time) |
| `current_period_end` | string \| null | yes | When the paid month ends and Stripe bills the next one; a cancellation or downgrade applies then. (format date-time) |
| `week_started_at` | string \| null | yes | Start of the current 7-day allowance week (weeks run from the subscription start). (format date-time) |
| `week_resets_at` | string \| null | yes | When the allowance refills (week_started_at plus 7 days). (format date-time) |
| `week_allowance_tokens` | integer | yes | (format int64; at least 0) |
| `week_used_tokens` | integer | yes | (format int64; at least 0) |
| `reset_price_cents` | integer \| null | yes | Price excluding VAT of a reset for the current plan; null without a plan. |
| `resets_bought_this_week` | integer | yes | (at least 0) |
| `billing_portal` | boolean | yes | Whether `createBillingPortalSession` works (the Stripe Customer Portal is configured for Dex and the account has a Stripe customer). |
| `currency` | string \| null | yes | The currency the plan is billed in (Stripe's subscription currency, else the account's `billing_currency`); null without a plan or before it is known. `reset_price_cents` stays in euro cents: the reset in this currency is `Plan.prices[currency].reset_price_cents`. New currencies may appear within v1.  (one of "EUR", "USD", "GBP", "INR", null) |

### 401

Missing, unknown, revoked or expired credentials.

### 403

The credentials are valid but not allowed to do this (missing scope, suspended account or failed CSRF check).

### 409

The idempotency key was used with a different body, or the first request with this key is still running.
Console billing routes also answer 409 for a state conflict: `subscription_exists` (createSubscriptionCheckout
while a subscription is live, joinWaitingList for a plan the account holds), `no_subscription`
(updateSubscription, cancelSubscription, createResetCheckout or createBillingPortalSession without one),
`plan_sold_out` (createSubscriptionCheckout or updateSubscription to a plan with no founding-round seat left;
with `hints`), `key_revoked` (updateKey on a revoked key).


### 500

An unexpected error. Any charge was refunded. Retry with the same idempotency key.

### 503

`maintenance`: the console's database, sign-in or payments are unavailable for a moment (for
`createGoogleSession` also: Google sign-in is not configured, or Google's signing keys cannot be fetched).
Retry after `retry-after`. Nothing was changed.