Delete a subscription

Deletes a dashboard, report, or commitment subscription and every scheduled entry on it. Returns 204. Deleting an id that is already gone also returns 204, so a retry does not fail. If-Match is required when the document still exists; a stale value is 412. An id that matches no scheduled subscription, alert, or budget returns 204 when If-Match is present.
Create does not accept alert or budget. GET returns them. PATCH may replace their recipient lists. DELETE of an alert or a budget returns 409 customers.entry_is_resource.
The caller must have canDelete for the subscription. Manage Settings users, a creator with the permission for each scheduled type, and a source owner or editor may delete it. Source viewers and recipients cannot. Users Manager alone grants no access. A service-account token is evaluated from its own permissions and does not inherit the permissions of the subscription creator.
Idempotency-Key is required. The same key, caller, customer, method, path, and If-Match replays the stored success response. A different If-Match is 422 idempotency_key_reused. A missing key is 400 idempotency_key_required. While the first request is in progress, another request with that key is 409 idempotency_request_in_progress. A 4xx response releases the key. dryRun=true does not reserve the key and does not delete.
Reads are immediately consistent. After a completed delete, a GET of that id returns 404.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≥ 1

Subscription id returned by list or create. Ids are independent ids of a scheduled subscription, an alert, or a budget. The server looks up a scheduled subscription, then an alert, then a budget. An id found in more than one of those collections is 409 customers.subscription_id_ambiguous. That is an invariant breach. There is no second identifier to send, and a client cannot disambiguate it. Auto-generated ids do not collide.

Query Params
boolean
Defaults to false

If true, validates the request and returns the would-be result without applying it. The response then carries the X-Dry-Run header.

Headers
string
required

The ETag of the current version, from a get, create or update response. A stale value returns 412; re-read the resource and retry with the new ETag.

string
required
length between 1 and 255

Client-generated key (UUID v4 or ULID recommended). Retrying with the same key and request returns the stored response instead of repeating the operation; the key is kept for 24 hours.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json
application/problem+json