Subscriptions

Delete a webhook subscription

Soft-deletes a subscription (active=false, deactivation_reason='user_deleted'). Idempotent — subsequent DELETEs return 200, and the optional Idempotency-Key header additionally replays the original response byte-identically with Idempotent-Replay: true on retry. A subscription owned by a different consumer returns 404 (the existence-leak vector is closed by treating cross-consumer access as not-found rather than forbidden).

delete/api/v1/subscriptions/{id}

Request

  • Base URL: https://www.apier.no
  • URL: https://www.apier.no/api/v1/subscriptions/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Headers

Idempotency-Keystring

Optional client-chosen key that makes this write safely retriable. When the same key is presented on a subsequent request with the same body, the gateway returns the original response (with Idempotent-Replay: true) instead of re-executing the write. Reservation is scoped to (consumer, endpoint, key) so the same key on different endpoints or different consumers does not collide. TTL: 24 hours. The key must be 1–255 printable ASCII characters — a v4 UUID or ULID is the recommended format. Keys are SHA-256 hashed before storage so they may safely carry client-internal identifiers.

Response

Subscription deleted (or already inactive — idempotent).

successtrue required

Example response

{
  "_meta": {
    "rulebook_version": "v1.0.0",
    "source": "apier.no",
    "data_source": "Brønnøysund Enhetsregisteret + Apier Universal Rulebook",
    "schema_version": "1.0.0",
    "legal_basis": "NLOD — public registry reuse",
    "response_timestamp": "2026-04-24T12:00:00.000Z",
    "response_hash": "sha256:0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
    "source_snapshot_id": "brreg-2026-04-24T02:00:00.000Z",
    "cost_nok": 0.5,
    "wallet_remaining_nok": 9.5,
    "spend_cap_remaining_nok": 12.5
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.