# doomPriceList

mutation · in the family [Price list](/reference/price-list/)

## What it does

Permanently retire a price list — a named set of prices.

Doom (terminal) a PriceList by id, within the caller's org group; requires the unrestricted capability + the record's CURRENT revision. -GATED by non-doomed OrgCustomer/CustomerPriceGroup carriers; its OWN entries never block (they die with the plane at purge). Deactivate is the FREE pause — the plane simply falls through at the next capture.

## Careful

Doom is forever — a doomed record never comes back into use (its history remains readable). Anything still referencing it live will block the doom.

## Who may call it

Capability area: **Pricing** — Prices, price schedules, promotions, coupons and the money rules of selling.

- Owner
- Manager
- An API key whose scope allows `api:doomPriceList`

## Arguments

| Name | Type | Required | Notes |
| --- | --- | --- | --- |
| `id` | [ID](/types/#scalars) `ID!` | yes | The id of the record. |
| `revision` | [ID](/types/#scalars) `ID!` | yes | The revision id you read on the record; the change is refused if an edit landed in the meantime. |
| `reason` | [String](/types/#scalars) | no | No further notes. |

## Returns

[PriceList](/types/PriceList/) `PriceList!` — A PriceList — a named ALTERNATE base-price plane (a 'price book'): the pipeline STEP-1 base for eligible customers, resolved at line capture ContractPrice → assigned PriceList → SalePrice and snapshotted IMMUTABLE at capture. ≠ step-2 discounts (promos/coupons/loyalty/employee compute OFF the captured base); ≠ markdowns (which WRITE SalePrice records — a list is READ-THROUGH at capture: nothing moves on a date, ZERO SCHEDULED_DUE growth; the resolve-time window IS the gating). THE CONTRACT SCOPE: orgCustomerId? — the lock's ContractPrice IS a PriceList scoped to ONE OrgCustomer, NOT a third construct: set at create, IMMUTABLE thereafter (the Edit shape excludes it — author a new list); a SCOPED list REQUIRES both window bounds (the contract TERM — STRICT). The effective window \[startAt, endAt) is half-open and optional-per-side on an UNSCOPED list (absent = boundless); non-ACTIVE / out-of-window / org-unselected ⇒ the whole plane FALLS THROUGH silently at capture (the / degrade class — the LAPSE law STANDS: the effective SalePrice window remains REQUIRED, a plane hit overrides the captured VALUE only). Entries are child PriceListEntry dated windows (≤ 500 live per list); carrier law: a scoped list may be carried ONLY by its scoped OrgCustomer's priceListId, a CustomerPriceGroup carries UNSCOPED lists only. Org participation is the canned-pool selection (≤ 32; ABSENT = every org); at most 32 ACTIVE per org group (the create/reactivate gate). SEARCHABLE (the book law — the Promotion/LP/CPG/Affiliate operational-master class). Doom ← non-doomed OrgCustomer/CustomerPriceGroup carriers (the THIRD carrier-gated doom family); its OWN entries never block (they die with the plane at purge). NO UNIQ marker (captions are non-unique; nothing bearer-resolvable).

## Example request

```graphql
mutation ExampleDoomPriceList($id: ID!, $revision: ID!, $reason: String) {
  doomPriceList(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    organizationIds
    startAt
    endAt
    orgCustomerId
  }
}
```

Variables:

```json
{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "reason": "Correcting a miscount."
}
```

Send it with the envelope naming the version: `"extensions": {"at": {"version": {"name":"genesis","number":0}}}`.

## Example response

```json
{
  "data": {
    "doomPriceList": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "PB-EXMP-0000-000F",
      "type": "PriceList",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "organizationIds": [
        "01900000-0000-7000-8000-60e064dc0000"
      ],
      "startAt": "2027-01-31T00:00:00.000Z",
      "endAt": "2027-01-31T00:00:00.000Z",
      "orgCustomerId": "01900000-0000-7000-8000-ba56ff800000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}
```

## Errors this call can answer

- `VALIDATION/INVALID` — Something in the request is not valid. ([VALIDATION](/errors/VALIDATION/))
- `AUTHN/REQUIRED` — Sign in to do this. ([AUTHN](/errors/AUTHN/))
- `AUTHZ/FORBIDDEN` — Your role does not allow this action. ([AUTHZ](/errors/AUTHZ/))
- `RATE_LIMIT/THROTTLED` — Too many requests in a short time. ([RATE_LIMIT](/errors/RATE_LIMIT/))
- `NOT_FOUND/*` — That record could not be found. ([NOT_FOUND](/errors/NOT_FOUND/))
- `CONFLICT/*` — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. ([CONFLICT](/errors/CONFLICT/))
- `VALIDATION/VERSION_REQUIRED` — The request did not say which app version it came from. ([VALIDATION](/errors/VALIDATION/))