# subscription.revoke_cancellation

## What it does

Undo a pending or approved cancellation before it takes effect. This keeps the business active and preserves the cancellation history. Paid plans that the approval cancelled stay cancelled and end with their period; an owner can keep them from the billing page where their agreement allows it.

## Before you send it

An authorized OAuth connection may call it, including a headless client. Effective membership, application grant and token permissions still apply. Describe `subscription.revoke_cancellation` through `GET /v1/catalog/commands/{name}` before acting.

This command does not accept `source_document_id` in its envelope. Any input evidence requirements remain as documented below.

## Inputs

Put these fields inside the envelope's `input` object. The outer envelope names the command, a stable `idempotency_key` and `effective_at`; [request and recovery rules](/docs/api/) explain those separately. Use exact minor-unit integer strings for monetary fields. Take existing IDs from prior reads or command results; choose a new identity only where the command asks for one.

Required means required within its containing object; an optional parent can be omitted.

| Field | Type | Required | Meaning and accepted values |
|---|---|---|---|
| `cancellationId` | string | Yes |  Minimum length: `1`. Example: `"can_example"`. |

## After acceptance

When the command emits events, its documented effects and receipt are recorded in the command transaction. The response returns `commandId`, `replayed`, the command-specific `result` below and emitted `events` with their IDs and CIDs. A command is not automatically a cash movement or revenue recognition: use the behavior above to determine what this command records.

Inspect `result` and the affected records or reports before continuing. Save returned identifiers for later calls. Fetch `GET /v1/commands/{id}` with `commandId` to recover the accepted receipt; retry the same intent with the same idempotency key if the response was lost. Some commands can succeed with `events: []` and return a transient result and `commandId` without persisting a receipt. A lookup of that ID can return null; retain the returned result and verify the affected record. Retrying can re-evaluate the current state rather than replay a stored result. A domain `no_change` is a separate success outcome with no persisted receipt.

### Result fields

Required means required within its containing object; an optional parent can be omitted.

| Field | Type | Required | Meaning and accepted values |
|---|---|---|---|
| `cancellationId` | string | Yes |  Minimum length: `1`. |
| `status` | string | Yes |  Choose `"pending"`, `"scheduled"`, `"revoked"`, `"expired"`, `"completed"`. |
| `requestedAt` | string | Yes |  Format: date-time. |
| `requestedBy` | string | No |   |
| `reason` | string | No |   |
| `expiresAt` | string | Yes |  Format: date-time. |
| `effectiveAt` | string | No |  Format: date-time. |
| `approvedAt` | string | No |  Format: date-time. |
| `approvedBy` | string | No |   |
| `closedAt` | string | No |  Format: date-time. |
| `closedBy` | string | No |   |


[All commands](/docs/command-reference/) · [Operation and errors](/docs/api-reference/operations/commands-execute/) · [Reusable schemas](/docs/api-reference/components/)

Keep credentials out of prompts; rehearse writes only in a disposable sandbox.

## Exact request schema


```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "const": "subscription.revoke_cancellation"
    },
    "input": {
      "type": "object",
      "properties": {
        "cancellationId": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "cancellationId"
      ],
      "additionalProperties": false
    },
    "idempotency_key": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "effective_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
    }
  },
  "required": [
    "name",
    "input",
    "idempotency_key",
    "effective_at"
  ],
  "additionalProperties": false
}
```

## Accepted command receipt


```json
{
  "type": "object",
  "required": [
    "commandId",
    "replayed",
    "result",
    "events"
  ],
  "properties": {
    "commandId": {
      "type": "string"
    },
    "replayed": {
      "type": "boolean"
    },
    "imported": {
      "const": true,
      "description": "The command's events are history from before the business joined Economico, recorded as an import: free of monthly events."
    },
    "result": {
      "type": "object",
      "properties": {
        "cancellationId": {
          "type": "string",
          "minLength": 1
        },
        "status": {
          "enum": [
            "pending",
            "scheduled",
            "revoked",
            "expired",
            "completed"
          ]
        },
        "requestedAt": {
          "type": "string",
          "format": "date-time"
        },
        "requestedBy": {
          "type": "string"
        },
        "reason": {
          "type": "string"
        },
        "expiresAt": {
          "type": "string",
          "format": "date-time"
        },
        "effectiveAt": {
          "type": "string",
          "format": "date-time"
        },
        "approvedAt": {
          "type": "string",
          "format": "date-time"
        },
        "approvedBy": {
          "type": "string"
        },
        "closedAt": {
          "type": "string",
          "format": "date-time"
        },
        "closedBy": {
          "type": "string"
        }
      },
      "required": [
        "cancellationId",
        "status",
        "requestedAt",
        "expiresAt"
      ]
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "cid": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

## Example request


```json
{
  "name": "subscription.revoke_cancellation",
  "input": {
    "cancellationId": "can_example"
  },
  "effective_at": "2026-09-01T00:00:00Z",
  "idempotency_key": "subscription.revoke_cancellation-example-0"
}
```