**API versions** · **V2 (Latest)** · [V1](/integrations/v1/docs?lang=en)

# Subscriptions

OpenAPI 3.0.3 · API 2.0.0

```json
[
  {
    "url": "https://api.unisoft.world/integrations/v2",
    "description": "API"
  }
]
```

Recurring donations

## Operations

## GET /abonnements

List subscriptions

`list_abonnements`

Required scope: `abonnements:read`. Reads a stored subscription in the authenticated organisation and allowed campaigns, excluding soft-deleted records. Returns an explicit business projection: identity and billing fields remain under payload.info and payload.facturation; reusable methods, provider references/configuration, tokens, private snapshots, locks and raw schedule are excluded. The nominal monetary contract stays in payload.amount (minor units) and payload.devise; no amount or currency is supplied at the root and no current currency or amount is inferred. Absent or invalid historical scalars are null; payload, info and facturation always have a documented shape. state ACTIVE can coexist with active false while activation is pending. No returned flag grants permission to debit or proves bank settlement. No provider call, debit, refresh, reconciliation, schedule initialization or business-state mutation occurs; shared authentication may update API-key usage telemetry. Unknown query parameters and HTTP request bodies are rejected, including framed empty JSON objects and opaque bytes; MCP synthetic empty objects without transport framing remain supported. List filters are exact stored values and combine with AND. active false does not mean paused. Campaign-restricted keys only receive subscriptions attached to an allowed campaign. Sorted by normalized recorded datetime DESC then id DESC; unreadable dates sort last. New cursors are opaque and bound to organisation and exact state/active/contactId filters. Valid historical datetime/id cursors remain accepted. Reuse nextCursor unchanged with the same filters; concurrent changes are not a snapshot. A malformed historical anchor identity returns 409 INVALID_SUBSCRIPTION_HISTORY instead of an unusable continuation. Subscription-payment cursors are incompatible.

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:read",
  "additional": []
}
```

### Parameters

```json
{
  "name": "limit",
  "in": "query",
  "schema": {
    "type": "integer",
    "minimum": 1,
    "maximum": 200,
    "default": 50
  }
}
```

```json
{
  "name": "cursor",
  "in": "query",
  "description": "Opaque nextCursor from this subscription list. New cursors are bound to the organisation and exact state/active/contactId filters; reuse unchanged with the same filters. Valid historical datetime/id cursors remain accepted. Payment-history cursors are incompatible.",
  "schema": {
    "type": "string",
    "maxLength": 4096
  }
}
```

```json
{
  "name": "active",
  "in": "query",
  "description": "Exact persisted active flag. false includes several lifecycle situations and does not mean paused.",
  "schema": {
    "type": "boolean"
  }
}
```

```json
{
  "name": "contactId",
  "in": "query",
  "description": "Exact CRM contact identifier.",
  "schema": {
    "type": "string",
    "minLength": 1,
    "maxLength": 200
  }
}
```

```json
{
  "name": "state",
  "in": "query",
  "description": "Exact persisted state, case-sensitive. This is not a display category or an execution permission. Unknown future states matching the pattern can be selected. Omit to include all states.",
  "schema": {
    "type": "string",
    "maxLength": 64,
    "pattern": "^[A-Z][A-Z0-9_-]{0,63}$"
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "OK",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Abonnement"
            }
          },
          "meta": {
            "$ref": "#/components/schemas/Pagination"
          }
        }
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_STATE, INVALID_ACTIVE, INVALID_CONTACT_ID, INVALID_LIMIT, INVALID_CURSOR, INVALID_QUERY_PARAMETER, UNKNOWN_QUERY_PARAMETER or UNEXPECTED_REQUEST_BODY.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE: abonnements:read is required.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "INVALID_SUBSCRIPTION_HISTORY: a malformed historical subscription identity prevents a stable continuation cursor.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "INTERNAL_ERROR.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "abonnements:read",
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## GET /abonnements/{id}

Get a subscription

`get_abonnement`

Required scope: `abonnements:read`. Reads a stored subscription in the authenticated organisation and allowed campaigns, excluding soft-deleted records. Returns an explicit business projection: identity and billing fields remain under payload.info and payload.facturation; reusable methods, provider references/configuration, tokens, private snapshots, locks and raw schedule are excluded. The nominal monetary contract stays in payload.amount (minor units) and payload.devise; no amount or currency is supplied at the root and no current currency or amount is inferred. Absent or invalid historical scalars are null; payload, info and facturation always have a documented shape. state ACTIVE can coexist with active false while activation is pending. No returned flag grants permission to debit or proves bank settlement. No provider call, debit, refresh, reconciliation, schedule initialization or business-state mutation occurs; shared authentication may update API-key usage telemetry. Unknown query parameters and HTTP request bodies are rejected, including framed empty JSON objects and opaque bytes; MCP synthetic empty objects without transport framing remain supported. Accepts only the subscription UUID, with no query parameters. Absent, deleted and out-of-scope subscriptions all return 404 NOT_FOUND.

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:read",
  "additional": []
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
    "format": "uuid"
  },
  "description": "Identifier of the existing target resource, returned by its authorised list or read operation. Never generate a new UUID to address an existing record."
}
```

### Responses

#### HTTP 200

```json
{
  "description": "OK",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "$ref": "#/components/schemas/Abonnement"
          }
        }
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_UUID, UNKNOWN_QUERY_PARAMETER or UNEXPECTED_REQUEST_BODY.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE: abonnements:read is required.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND: subscription absent, deleted, in another organisation or outside the allowed campaign scope.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "INTERNAL_ERROR.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "abonnements:read",
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## GET /abonnements/{id}/paiements

List recorded payments of a subscription

`list_abonnement_paiements`

Required scopes: `paiements:read` AND `abonnements:read`. Read-only stored history; no debit, refresh, reconciliation or provider call. The subscription and each payment are independently restricted to the authenticated organisation and allowed campaigns. Soft-deleted records are excluded; this exclusion is not a financial reversal. Omit state to include completed, failed, pending, refunded, imported, technical pause and unknown states. Use state=COMPLETED for recorded completed results, whose financial meaning depends on their producer/provider; this read performs no capture or bank verification. An exact failure state such as FAILED is not a universal failure category. Attempts are individual payments, not necessarily distinct contractual occurrences. Sorted by normalized recorded datetime DESC, then payment id DESC; missing/unreadable dates sort last. Cursor is opaque and bound to the organisation, subscription and state filter; reuse it unchanged with the same filter. Concurrent inserts are not a snapshot. No cross-currency aggregate or paid-count inference is returned. The response is an explicit business projection without donor PII, reusable method references, provider configuration or private snapshots. HTTP request bodies are rejected, including framed empty JSON objects and opaque bytes; MCP synthetic empty objects without transport framing remain supported.

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "paiements:read",
  "additional": [
    "abonnements:read"
  ]
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "description": "Subscription identifier.",
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

```json
{
  "name": "limit",
  "in": "query",
  "schema": {
    "type": "integer",
    "minimum": 1,
    "maximum": 200,
    "default": 50
  }
}
```

```json
{
  "name": "cursor",
  "in": "query",
  "description": "Opaque nextCursor from this exact subscription-payment listing and state filter. Subscription-list cursors are not compatible.",
  "schema": {
    "type": "string",
    "maxLength": 4096
  }
}
```

```json
{
  "name": "state",
  "in": "query",
  "description": "Exact persisted state, case-sensitive. This is not a display category or an execution permission. Unknown future states matching the pattern can be selected. Omit to include all states.",
  "schema": {
    "type": "string",
    "maxLength": 64,
    "pattern": "^[A-Z][A-Z0-9_-]{0,63}$"
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Stored payments and continuation metadata.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/AbonnementPaymentPage"
      },
      "example": {
        "success": true,
        "data": [
          {
            "id": "22222222-2222-4222-8222-222222222222",
            "subscriptionId": "11111111-1111-4111-8111-111111111111",
            "amount": 5000,
            "devise": "eur",
            "assoc": "MAIN",
            "state": "COMPLETED",
            "datetime": "2026-11-01T10:00:00.000Z",
            "type": "GENERAL",
            "typeId": null,
            "parentTypeId": null,
            "method": "CB",
            "platform": "STRIPE",
            "source": "SYSTEM",
            "imported": null,
            "finalized": null,
            "subscriptionOccurrence": "11111111-1111-4111-8111-111111111111:monthly:1",
            "subscriptionPlannedDate": "2026-11-01"
          }
        ],
        "meta": {
          "nextCursor": null,
          "hasMore": false,
          "count": 1
        }
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_UUID, INVALID_STATE, INVALID_LIMIT, INVALID_CURSOR, INVALID_QUERY_PARAMETER, UNKNOWN_QUERY_PARAMETER or UNEXPECTED_REQUEST_BODY.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE: both read scopes are required.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND: subscription absent, deleted, in another organisation or outside the allowed campaign scope.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "INVALID_PAYMENT_HISTORY: a malformed historical payment identity prevents a stable continuation cursor.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "INTERNAL_ERROR.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "paiements:read",
  "x-unisoft-additional-scopes": [
    "abonnements:read"
  ],
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## GET /abonnements/{id}/schedule

Read subscription dates and remaining contract

`get_abonnement_schedule`

Required scopes: `abonnements:read` AND `paiements:read`, including managed contracts. Stored read-only projection; no debit, provider call, synchronization, reconciliation, persistent calendar initialization, lock or document emission. Local monthly and SEPA XML calendars reuse the subscription owner in memory. Dates are civil YYYY-MM-DD in rules.timezone; notBefore and asOf are ISO instants. horizon (1–240, default 12) limits visible occurrences, never contractual totals. nominalAmount is payload.amount; rules.amount is the calendar nominal amount; occurrence.amount is effective and may be reduced by a maximum or changed by an exception. Payment attempts are not distinct occurrences. paidAmount/paidCount mean recorded COMPLETED results under the owner rules, including imported history; they do not verify capture or bank settlement. Committed attempts consume contractual availability. remainingAmount is remaining ceiling capacity, plannedAmount is the full calculable future contractual amount, and remainingCount is the full calculable future occurrence count. Null means unknown or unbounded, never zero. Count, maximum, unlimited and legacy combined limits are distinct. blocked only describes engaged or uncertain payments: false does not imply canExecute. canExecute is common calendar eligibility at this read, not provider/mandate validity or permission to launch a debit; other execution checks still apply. A paused or activation-pending contract may retain future dates without being executable. SEPA XML preparation is a separate date window, not a bank submission or collection date. Managed schedules remain unavailable with null dates, totals and eligibility; no remote date is invented. allocationBudgets and nextAllocations are minor-unit pledge maps, empty maps are valid; per-payment pledge budgets do not denote the whole future contract. No reusable method, private lock, history hash or provider reference is returned. Organisation and campaign restrictions apply to the subscription and all related payments/pledges. A hidden historical relation refuses the projection instead of silently changing totals. Deleted or malformed history is unavailable. Reads over 10000 stored attempts fail with SUBSCRIPTION_HISTORY_TOO_LARGE. 409 requires correcting/reviewing stored data through the owning application; never retry a debit from this read. The response is not a transaction snapshot and can change immediately.

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:read",
  "additional": [
    "paiements:read"
  ]
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "description": "Subscription identifier.",
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

```json
{
  "name": "horizon",
  "in": "query",
  "description": "Visible next occurrences; contractual totals always cover the full calculable future.",
  "schema": {
    "type": "integer",
    "minimum": 1,
    "maximum": 240,
    "default": 12
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Read-only stored subscription projection.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionScheduleResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_UUID, INVALID_HORIZON, INVALID_QUERY_PARAMETER, UNKNOWN_QUERY_PARAMETER or UNEXPECTED_REQUEST_BODY.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE: both read scopes are required.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND: subscription absent, deleted, foreign or outside allowed campaigns.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "INVALID_SUBSCRIPTION_SCHEDULE, INVALID_SUBSCRIPTION_HISTORY, SUBSCRIPTION_HISTORY_UNAVAILABLE, SUBSCRIPTION_HISTORY_TOO_LARGE or SCHEDULE_SCOPE_INCOMPLETE. Review stored data and related-resource access in the owning application; no partial financial projection is returned.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "INTERNAL_ERROR.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "param": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "abonnements:read",
  "x-unisoft-additional-scopes": [
    "paiements:read"
  ],
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## GET /abonnements/{id}/incident

Read a recorded subscription incident and existing regularisation link

`get_abonnement_incident`

Requires abonnements:read AND paiements:read. Accepts only the subscription UUID; query parameters and non-empty bodies are rejected. Missing, deleted or out-of-scope subscriptions return 404. The subscription and each linked payment are independently restricted to the authenticated organisation and allowed campaigns. Reads recorded intervention markers and the latest authorised failed payment; the latter can be historical and already followed by success, and is not proof of a current block. MANUAL/CARD_EXPIRED/paymentMethodPending describe recorded intervention; active and state do not authorize a charge. Missing or invalid dates stay null; no time or expiry is inferred. No raw failure message, reusable method, enrollment token, merchant configuration or private snapshot is exposed. regularization.link is either null with an actionable availability code or an already-stored Stripe Connect PENDING manual checkout. AVAILABLE requires an active MANUAL/CARD_EXPIRED local card contract (reusable_method.isBank must be false) without an explicit review or method change, exact current payer/contact/billing snapshots, same frozen Stripe account/currency/association/revision and recorded occurrence amount, the current PROCESSING occurrence attempt and matching captured card incident, a matching HTTPS checkout.stripe.com Session URL, and an explicit future expiry persisted from Stripe. The subscription, payment, occurrence and contact ownership are rechecked before returning the capability. Share that confidential URL only with its intended payer. This is a database observation, not a live guarantee that the provider will accept the checkout. EXPIRED_RECORDED_LINK means its explicit stored expiry elapsed; INVALID_RECORDED_LINK means missing/invalid expiry, expired marker or invalid URL. CURRENT_PAYER_UNVERIFIED and HISTORY_UNVERIFIED require operator review. READ_OWNER_REQUIRED means no qualifying readable checkout exists; use the existing authorised backoffice workflow. MANAGED_OWNER delegates incidents and renewal to the external provider; SEPA_XML_OWNER requires the SEPA mandate/return workflow. INACTIVE, NO_RECORDED_INTERVENTION, PAYMENT_METHOD_CHANGE_PENDING and MANUAL_REVIEW_REQUIRED do not supply a renewal link. Other provider checkouts and method-enrollment links are deliberately unavailable pending an authoritative read owner. This GET never creates a link, sends a reminder, calls a provider, reconciles, changes a method, initializes a calendar or debits funds. Following a returned checkout is a separate payer action. Authentication may record API-key usage telemetry.

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:read",
  "additional": [
    "paiements:read"
  ]
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "description": "Unisoft subscription UUID.",
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Allowlisted recorded incident and existing-link availability.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionIncidentResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_UUID, UNEXPECTED_QUERY_PARAMETERS or UNEXPECTED_REQUEST_BODY.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE: both read permissions are required.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND: missing, deleted or outside the authorised organisation/campaign.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "INTERNAL_ERROR: incident could not be read; no financial operation was attempted.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "abonnements:read",
  "x-unisoft-additional-scopes": [
    "paiements:read"
  ],
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## POST /abonnements/{id}/revisions/preview

Preview monthly subscription rule changes without writing

`preview_subscription_revision`

Requires abonnements:read AND paiements:read. A read-only POST: no lock, journal write or persistent calendar initialization. Supply the exact intended changes; contradictory day/nextDate or ignored/incompatible limit fields are refused rather than silently discarded. A no-op returns NO_EFFECTIVE_CHANGE. previewToken fingerprints the native authority, full admitted history, references and financial configuration; it is neither a command id nor a reservation. Read beforeRules/afterRules and before/after totals with the user, then apply only the identical changes and token for a confirmed intent. A later change in context invalidates this preview. Uses the native monthly subscription editor and preserves launched attempts and occurrence exceptions. All amount/maximum/total fields are minor units; count and maximum include completed and committed history. Null totals mean unbounded or unknown, never zero. Dates are civil YYYY-MM-DD in the contract timezone. Only existing local ACTIVE/PAUSE contracts with active:true are admitted; managed and specialised SEPA XML ownership, pending activation, ambiguous history and hidden campaign/pledge references are refused. This tranche edits amount/day/nextDate/native limits only. No other frequency or independent endDate exists in this contract. Payer identity, origin, beneficiary, currency, provider, reusable method, notification and CRM effects are not accepted here. Allocation plans must remain natively valid; a change requiring redistribution returns ALLOCATION_REVISION_REQUIRED. No provider, payment transport, debit, document or notification is created. The current stored method may still fail its later execution checks. 

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:read",
  "additional": [
    "paiements:read"
  ]
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  },
  "description": "Existing recurring subscription contract identifier."
}
```

### Request body

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "changes": {
            "$ref": "#/components/schemas/UnisoftRequest_3e9bbc56cab142f79ac7"
          }
        },
        "required": [
          "changes"
        ],
        "additionalProperties": false
      }
    }
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Native owner result projected without private references or snapshots.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionRevisionPreviewResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_REVISION_INPUT, INVALID_UUID or UNKNOWN_QUERY_PARAMETER.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE or API_KEY_CONTEXT_REQUIRED.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "REVISION_OWNER_UNAVAILABLE, ACTIVATION_REQUIRED, SUBSCRIPTION_CLOSED, SUBSCRIPTION_BUSY, SUBSCRIPTION_CONTACT_UNAVAILABLE, INVALID_SUBSCRIPTION_HISTORY, ALLOCATION_REVISION_REQUIRED, CONFLICTING_CALENDAR_FIELDS, NO_EFFECTIVE_CHANGE or another native calendar/reference refusal.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "REVISION_STORAGE_UNAVAILABLE.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "abonnements:read",
  "x-unisoft-additional-scopes": [
    "paiements:read"
  ],
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  },
  "x-unisoft-mcp-output-schema": true
}
```

## POST /abonnements/{id}/revisions

Apply a confirmed native subscription rule revision

`apply_subscription_revision`

Requires abonnements:write AND abonnements:read AND paiements:read AND opt-in abonnements:revise, plus acknowledgeFutureCollections:true. This changes future automatic collection authority. First use preview_subscription_revision; send its exact previewToken and identical changes. Generate idempotencyKey once and retain the exact request after a timeout. The real native editor acquires its EDIT lock, rechecks the preview, changes the contract and records its native audit; no payment is launched. APPLIED/appliedRevision describe an acknowledged edit, not current contract state, receipt issue or bank settlement. RUNNING/UNCERTAIN are observed through get_subscription_revision_command and must never re-enter the owner. The shared durable per-contract fence also refuses a different UUID after uncertainty; no TTL/reclaim is supported. PREVIEW_CONFLICT needs a fresh preview and reconfirmed intent, never a stale-token override. Uses the native monthly subscription editor and preserves launched attempts and occurrence exceptions. All amount/maximum/total fields are minor units; count and maximum include completed and committed history. Null totals mean unbounded or unknown, never zero. Dates are civil YYYY-MM-DD in the contract timezone. Only existing local ACTIVE/PAUSE contracts with active:true are admitted; managed and specialised SEPA XML ownership, pending activation, ambiguous history and hidden campaign/pledge references are refused. This tranche edits amount/day/nextDate/native limits only. No other frequency or independent endDate exists in this contract. Payer identity, origin, beneficiary, currency, provider, reusable method, notification and CRM effects are not accepted here. Allocation plans must remain natively valid; a change requiring redistribution returns ALLOCATION_REVISION_REQUIRED. No provider, payment transport, debit, document or notification is created. The current stored method may still fail its later execution checks. 

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:write",
  "additional": [
    "abonnements:read",
    "paiements:read",
    "abonnements:revise"
  ]
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  },
  "description": "Existing recurring subscription contract identifier."
}
```

### Request body

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "idempotencyKey": {
            "type": "string",
            "format": "uuid"
          },
          "previewToken": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "acknowledgeFutureCollections": {
            "type": "boolean",
            "enum": [
              true
            ],
            "description": "Explicitly acknowledge that changed rules govern future automatic collections on this existing contract."
          },
          "changes": {
            "$ref": "#/components/schemas/UnisoftRequest_3e9bbc56cab142f79ac7"
          }
        },
        "required": [
          "idempotencyKey",
          "previewToken",
          "acknowledgeFutureCollections",
          "changes"
        ],
        "additionalProperties": false
      }
    }
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Native owner result projected without private references or snapshots.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionRevisionCommandResponse"
      }
    }
  }
}
```

#### HTTP 202

```json
{
  "description": "Native owner result projected without private references or snapshots.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionRevisionCommandResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_REVISION_INPUT, INVALID_UUID or UNKNOWN_QUERY_PARAMETER.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE or API_KEY_CONTEXT_REQUIRED.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "PREVIEW_CONFLICT, IDEMPOTENCY_CONFLICT, LIFECYCLE_RECONCILIATION_REQUIRED, ALLOCATION_REVISION_REQUIRED or another native calendar/reference refusal before command ownership.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "REVISION_STORAGE_UNAVAILABLE. Inspect commandId and current records before another intent when supplied.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "abonnements:write",
  "x-unisoft-additional-scopes": [
    "abonnements:read",
    "paiements:read",
    "abonnements:revise"
  ],
  "x-unisoft-mcp": {
    "category": "write",
    "readOnly": false,
    "destructive": true,
    "idempotent": true,
    "warn": true
  },
  "x-unisoft-mcp-output-schema": true
}
```

## GET /abonnements/{id}/revisions/commands/{commandId}

Read a recorded subscription revision outcome

`get_subscription_revision_command`

Requires abonnements:read. Reads the external revision journal without locking, editing, retrying the native owner, exposing a preview snapshot or calling a provider. id is the contract and commandId is the returned external command id. APPLIED/appliedRevision describe the acknowledged historical edit, not the current subscription or bank status. RUNNING/UNCERTAIN never permit a new key or owner retry; inspect current records and resolve through the owning application. Organisation/campaign restrictions still apply to the contract.

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:read",
  "additional": []
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  },
  "description": "Existing recurring subscription contract identifier."
}
```

```json
{
  "name": "commandId",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  },
  "description": "External revision command identifier returned by apply_subscription_revision."
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Native owner result projected without private references or snapshots.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionRevisionCommandResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_UUID, UNKNOWN_QUERY_PARAMETER or UNEXPECTED_REQUEST_BODY.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "INVALID_REVISION_COMMAND_HISTORY.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "REVISION_STORAGE_UNAVAILABLE.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "abonnements:read",
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  },
  "x-unisoft-mcp-output-schema": true
}
```

## POST /abonnements/{id}/payment-method-changes/preview

Preview a secure subscription payment method change

`preview_subscription_payment_method_change`

Requires abonnements:read AND paiements:read AND opt-in abonnements:change-method. Read-only POST with platform. No provider, lock, persistent initialization or reconciliation. Review flow, currency and any occurrence amount/date before confirming. expectedRevision and previewToken fingerprint the exact authority, history, references, contact and target configuration; neither reserves it. Preparation supports only existing local monthly ACTIVE/PAUSE/MANUAL/CARD_EXPIRED contracts with active:true, complete admitted history, a current merchant and an owned CRM contact. Managed and specialised SEPA XML owners, pending changes/activation, bank uncertainty and hidden campaign references are refused. Initial targets are the currently configured Stripe Connect STRIPE.SEPA mandate setup and STRIPE card replacement. Other providers remain with their native application owner. SETUP prepares a bank mandate without a payment. ADVANCE prepares payer-authorised payment of the returned real occurrence and saves the new card through the native verified callback; amount is minor units (5000 EUR means EUR 50), with no synthetic tokenisation debit and no charge to the stored method. Allocation-bearing card advances require ALLOCATION_ADVANCE_OWNER_REQUIRED and are not guessed. Preparation blocks automatic execution while pending; native confirmation preserves a pause and only restores prior permitted authority. When SETUP confirmation resumes an originally ACTIVE contract, the native owner reanchors the unlaunched schedule to the next configured collection day strictly after confirmation in the contract timezone; the prior next date is not guaranteed. PAUSE remains paused; ADVANCE settles its selected occurrence without this SETUP reanchor. A browser return, PREPARED, an URL, or payment COMPLETED alone never proves activated reusable means or bank settlement. No card, mandate, account/configuration id, public callback token or payer snapshot is accepted or returned. 

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:read",
  "additional": [
    "paiements:read",
    "abonnements:change-method"
  ]
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  },
  "description": "Existing subscription contract id."
}
```

### Request body

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "platform": {
            "type": "string",
            "enum": [
              "STRIPE",
              "STRIPE.SEPA"
            ]
          }
        },
        "required": [
          "platform"
        ],
        "additionalProperties": false
      }
    }
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Admitted recorded result; no reusable method or private references.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionPaymentChangePreviewResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_METHOD_CHANGE_INPUT.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "METHOD_TARGET_UNAVAILABLE, METHOD_CHANGE_ALREADY_PENDING, LIFECYCLE_RECONCILIATION_REQUIRED, CONTACT_CONTEXT_UNAVAILABLE or native owner/reference refusal.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "METHOD_CHANGE_STORAGE_UNAVAILABLE.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-scope": "abonnements:read",
  "x-unisoft-additional-scopes": [
    "paiements:read",
    "abonnements:change-method"
  ],
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## POST /abonnements/{id}/payment-method-changes

Prepare payer authorisation for a payment method change

`prepare_subscription_payment_method_change`

Requires abonnements:write AND abonnements:read AND paiements:read AND opt-in abonnements:change-method. STRIPE card additionally requires paiements:write AND opt-in abonnements:advance AND acknowledgeAdvancePayment:true. First preview_subscription_payment_method_change; send identical platform, expectedRevision and previewToken plus acknowledgeFutureCollections:true and one retained idempotencyKey. This is a real mutation and may create a provider Checkout. The payer must complete the returned authorizationUrl; this call sends no notification. The capability URL appears only in this authorised POST including a safe identical replay, never GET status. PREPARED acknowledges preparation, not payer consent, activation or collection. A link that became unavailable is omitted while the acknowledged preparation remains. RUNNING/UNCERTAIN must only be observed with get_subscription_payment_method_change_command: never re-enter the owner, change UUID or infer failure. A durable shared per-contract fence is retained after uncertainty without TTL/reclaim. Preparation supports only existing local monthly ACTIVE/PAUSE/MANUAL/CARD_EXPIRED contracts with active:true, complete admitted history, a current merchant and an owned CRM contact. Managed and specialised SEPA XML owners, pending changes/activation, bank uncertainty and hidden campaign references are refused. Initial targets are the currently configured Stripe Connect STRIPE.SEPA mandate setup and STRIPE card replacement. Other providers remain with their native application owner. SETUP prepares a bank mandate without a payment. ADVANCE prepares payer-authorised payment of the returned real occurrence and saves the new card through the native verified callback; amount is minor units (5000 EUR means EUR 50), with no synthetic tokenisation debit and no charge to the stored method. Allocation-bearing card advances require ALLOCATION_ADVANCE_OWNER_REQUIRED and are not guessed. Preparation blocks automatic execution while pending; native confirmation preserves a pause and only restores prior permitted authority. When SETUP confirmation resumes an originally ACTIVE contract, the native owner reanchors the unlaunched schedule to the next configured collection day strictly after confirmation in the contract timezone; the prior next date is not guaranteed. PAUSE remains paused; ADVANCE settles its selected occurrence without this SETUP reanchor. A browser return, PREPARED, an URL, or payment COMPLETED alone never proves activated reusable means or bank settlement. No card, mandate, account/configuration id, public callback token or payer snapshot is accepted or returned. 

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:write",
  "additional": [
    "abonnements:read",
    "paiements:read",
    "abonnements:change-method"
  ]
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  },
  "description": "Existing subscription contract id."
}
```

### Request body

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/UnisoftRequest_e4c2e3a5eb7c3cc511e2"
      }
    }
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Admitted recorded result; no reusable method or private references.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionPaymentChangePreparationResponse"
      }
    }
  }
}
```

#### HTTP 201

```json
{
  "description": "Admitted recorded result; no reusable method or private references.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionPaymentChangePreparationResponse"
      }
    }
  }
}
```

#### HTTP 202

```json
{
  "description": "Admitted recorded result; no reusable method or private references.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionPaymentChangePreparationResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_METHOD_CHANGE_INPUT.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE; card advance additionally needs paiements:write and abonnements:advance.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "PREVIEW_CONFLICT, IDEMPOTENCY_CONFLICT, METHOD_CHANGE_LINK_UNAVAILABLE, ALLOCATION_ADVANCE_OWNER_REQUIRED or another admitted owner refusal.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "METHOD_CHANGE_STORAGE_UNAVAILABLE; inspect commandId when supplied.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-scope": "abonnements:write",
  "x-unisoft-additional-scopes": [
    "abonnements:read",
    "paiements:read",
    "abonnements:change-method"
  ],
  "x-unisoft-mcp": {
    "category": "write",
    "readOnly": false,
    "destructive": true,
    "idempotent": true,
    "warn": true
  }
}
```

## GET /abonnements/{id}/payment-method-changes/commands/{commandId}

Read stored method change activation without a capability URL

`get_subscription_payment_method_change_command`

Requires abonnements:read. Read only the external command and native stored state after organisation/campaign admission. No provider, progress/reconciliation, lock, retry, notification or authorizationUrl. commandId is the returned external command id, not the subscription, native key or payment id. activated:true requires native CONFIRMED and the current contract lastMethodChange matching it with paymentMethodPending:false. activated:false is a stored observation, never proof that a remote payment failed. RUNNING/UNCERTAIN means no automatic retry, including another UUID. Preparation supports only existing local monthly ACTIVE/PAUSE/MANUAL/CARD_EXPIRED contracts with active:true, complete admitted history, a current merchant and an owned CRM contact. Managed and specialised SEPA XML owners, pending changes/activation, bank uncertainty and hidden campaign references are refused. Initial targets are the currently configured Stripe Connect STRIPE.SEPA mandate setup and STRIPE card replacement. Other providers remain with their native application owner. SETUP prepares a bank mandate without a payment. ADVANCE prepares payer-authorised payment of the returned real occurrence and saves the new card through the native verified callback; amount is minor units (5000 EUR means EUR 50), with no synthetic tokenisation debit and no charge to the stored method. Allocation-bearing card advances require ALLOCATION_ADVANCE_OWNER_REQUIRED and are not guessed. Preparation blocks automatic execution while pending; native confirmation preserves a pause and only restores prior permitted authority. When SETUP confirmation resumes an originally ACTIVE contract, the native owner reanchors the unlaunched schedule to the next configured collection day strictly after confirmation in the contract timezone; the prior next date is not guaranteed. PAUSE remains paused; ADVANCE settles its selected occurrence without this SETUP reanchor. A browser return, PREPARED, an URL, or payment COMPLETED alone never proves activated reusable means or bank settlement. No card, mandate, account/configuration id, public callback token or payer snapshot is accepted or returned. 

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:read",
  "additional": []
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  },
  "description": "Existing subscription contract id."
}
```

```json
{
  "name": "commandId",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Admitted recorded result; no reusable method or private references.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionPaymentChangeCommandResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_UUID, UNKNOWN_QUERY_PARAMETER or UNEXPECTED_REQUEST_BODY.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "INVALID_METHOD_CHANGE_COMMAND_HISTORY or INVALID_METHOD_CHANGE_HISTORY.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "METHOD_CHANGE_STORAGE_UNAVAILABLE.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-scope": "abonnements:read",
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## POST /abonnements/{id}/occurrences/preview

Preview moving or postponing one future occurrence

`preview_subscription_occurrence`

Requires abonnements:read AND paiements:read. Read-only POST using the native calendar/editor: no lock, journal or persistent initialization. Read before/after/next with the user; previewToken fingerprints authority, history, references and merchant configuration and reserves nothing. Use exactly this occurrence action and token for the confirmed apply. NO_EFFECTIVE_CHANGE refuses an identical exception. Dates are civil YYYY-MM-DD in the returned timezone; amount and remainingAmount are minor units (5000 EUR means EUR 50). Null remaining totals mean unbounded or unknown, never zero. Only existing local ACTIVE/PAUSE contracts with active:true and fully admitted history/references are supported. Managed and specialised SEPA XML owners, pending activation, due or launched occurrences, ambiguous history, hidden campaign/pledge references and allocation review are refused. The selected occurrence must be visible within the next 240 native planned/deferred occurrences both before and after the edit; otherwise OCCURRENCE_NOT_PLANNED refuses this bounded preview. action date assigns one explicit future date and bypasses inherited 25-day spacing. action skip postpones a finite instalment after the actual last date without forgiving its amount; for an unlimited contract it becomes DEFERRED with date:null until a future explicit date or reset. action reset with field:date removes date/skip only and preserves any existing amount exception; OCCURRENCE_WOULD_BECOME_DUE refuses a reset that would make it immediately collectible. Other exceptions, rules, amounts, reusable method, payer and financial history remain intact. No debit, payment, provider, notification or document is invoked. To change overall rules use preview_subscription_revision; an advance is only available as the real payer-authorised card-change flow, never an arbitrary early debit. 

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:read",
  "additional": [
    "paiements:read"
  ]
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  },
  "description": "Existing monthly subscription contract identifier."
}
```

### Request body

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "occurrence": {
            "$ref": "#/components/schemas/UnisoftRequest_2401b237a86dca02fa7c"
          }
        },
        "required": [
          "occurrence"
        ],
        "additionalProperties": false
      }
    }
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Admitted native occurrence result without private snapshots.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionOccurrencePreviewResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_OCCURRENCE_INPUT or UNKNOWN_QUERY_PARAMETER.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "OCCURRENCE_NOT_PLANNED, OCCURRENCE_ALREADY_DUE, OCCURRENCE_WOULD_BECOME_DUE, NO_EFFECTIVE_CHANGE, LIFECYCLE_RECONCILIATION_REQUIRED or native calendar/reference refusal.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "OCCURRENCE_STORAGE_UNAVAILABLE.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-scope": "abonnements:read",
  "x-unisoft-additional-scopes": [
    "paiements:read"
  ],
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## POST /abonnements/{id}/occurrences

Apply a confirmed future occurrence date exception

`apply_subscription_occurrence`

Requires abonnements:write AND abonnements:read AND paiements:read AND opt-in abonnements:revise, with acknowledgeFutureCollections:true. First preview_subscription_occurrence and confirm its effects. Send the identical occurrence action and previewToken and generate idempotencyKey once. The native editor takes an EDIT lock and uses a full-source CAS. APPLIED/appliedRevision proves an acknowledged historical edit, not a collection or current state. Keep the exact request after a timeout. RUNNING/UNCERTAIN must only be observed with get_subscription_occurrence_command; never retry the owner or use another UUID. A shared durable per-contract fence remains after uncertainty with no TTL/reclaim. PREVIEW_CONFLICT requires a fresh preview and reconfirmation. Dates are civil YYYY-MM-DD in the returned timezone; amount and remainingAmount are minor units (5000 EUR means EUR 50). Null remaining totals mean unbounded or unknown, never zero. Only existing local ACTIVE/PAUSE contracts with active:true and fully admitted history/references are supported. Managed and specialised SEPA XML owners, pending activation, due or launched occurrences, ambiguous history, hidden campaign/pledge references and allocation review are refused. The selected occurrence must be visible within the next 240 native planned/deferred occurrences both before and after the edit; otherwise OCCURRENCE_NOT_PLANNED refuses this bounded preview. action date assigns one explicit future date and bypasses inherited 25-day spacing. action skip postpones a finite instalment after the actual last date without forgiving its amount; for an unlimited contract it becomes DEFERRED with date:null until a future explicit date or reset. action reset with field:date removes date/skip only and preserves any existing amount exception; OCCURRENCE_WOULD_BECOME_DUE refuses a reset that would make it immediately collectible. Other exceptions, rules, amounts, reusable method, payer and financial history remain intact. No debit, payment, provider, notification or document is invoked. To change overall rules use preview_subscription_revision; an advance is only available as the real payer-authorised card-change flow, never an arbitrary early debit. 

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:write",
  "additional": [
    "abonnements:read",
    "paiements:read",
    "abonnements:revise"
  ]
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  },
  "description": "Existing monthly subscription contract identifier."
}
```

### Request body

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "idempotencyKey": {
            "type": "string",
            "format": "uuid"
          },
          "previewToken": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "acknowledgeFutureCollections": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "occurrence": {
            "$ref": "#/components/schemas/UnisoftRequest_2401b237a86dca02fa7c"
          }
        },
        "required": [
          "idempotencyKey",
          "previewToken",
          "acknowledgeFutureCollections",
          "occurrence"
        ],
        "additionalProperties": false
      }
    }
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Admitted native occurrence result without private snapshots.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionOccurrenceCommandResponse"
      }
    }
  }
}
```

#### HTTP 202

```json
{
  "description": "Admitted native occurrence result without private snapshots.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionOccurrenceCommandResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_OCCURRENCE_INPUT or UNKNOWN_QUERY_PARAMETER.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "PREVIEW_CONFLICT, IDEMPOTENCY_CONFLICT, LIFECYCLE_RECONCILIATION_REQUIRED or another native refusal before ownership.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "OCCURRENCE_STORAGE_UNAVAILABLE. Inspect commandId when supplied.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-scope": "abonnements:write",
  "x-unisoft-additional-scopes": [
    "abonnements:read",
    "paiements:read",
    "abonnements:revise"
  ],
  "x-unisoft-mcp": {
    "category": "write",
    "readOnly": false,
    "destructive": true,
    "idempotent": true,
    "warn": true
  }
}
```

## GET /abonnements/{id}/occurrences/commands/{commandId}

Read a recorded occurrence edit outcome

`get_subscription_occurrence_command`

Requires abonnements:read. Read only the external command journal for this admitted organisation/campaign contract. commandId is the external command id, never an occurrence or payment id. APPLIED describes an acknowledged historical edit. RUNNING/UNCERTAIN never permit retry or a new key; inspect current records and resolve in the owning application. No lock, provider, reconciliation, private snapshot or URL is returned.

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:read",
  "additional": []
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  },
  "description": "Existing monthly subscription contract identifier."
}
```

```json
{
  "name": "commandId",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Admitted native occurrence result without private snapshots.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionOccurrenceCommandResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_UUID, UNKNOWN_QUERY_PARAMETER or UNEXPECTED_REQUEST_BODY.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "INVALID_OCCURRENCE_COMMAND_HISTORY.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "OCCURRENCE_STORAGE_UNAVAILABLE.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-scope": "abonnements:read",
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## GET /abonnements/{id}/lifecycle

Read pause, resume and final cancellation eligibility

`get_subscription_lifecycle`

Requires abonnements:read AND paiements:read. Read-only stored capability evaluation, no provider, lock, debit, reconciliation or persistent calendar initialization. expectedRevision is an opaque version for a subsequent lifecycle command, distinct from schedule.revision; eligibility may change immediately. canPause permits stopping future authority even during an EXECUTE operation, which it cannot recall. canResume is eligibility to restore future automatic debits, never permission to debit now or proof of bank settlement. It requires active:true and PAUSE, a supported configured stored method, an unambiguous complete history and future native calendar availability. PAUSE keeps active:true; active:false may instead mean pending activation or closure. Managed remote pause/resume and specialised SEPA XML lifecycle are explicitly unavailable here. canCancel separately qualifies local closure and native NEDARIM/STRIPE_EXTERNAL managed cancellation; cancellation is final and cannot be resumed. A capability can be false with a concrete reason; do not infer a workaround or use another command to bypass it. Organisation and campaign restrictions apply to the subscription, origin and related pledges; resume additionally admits the complete relevant history. Stored ambiguous or hidden financial data cannot authorize a resume. No reusable instrument, merchant credential, lock token, private snapshot or provider error is returned. An unresolved external lifecycle command blocks subsequent lifecycle writes with LIFECYCLE_RECONCILIATION_REQUIRED, including a different request UUID; time never clears that fence. 

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:read",
  "additional": [
    "paiements:read"
  ]
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "description": "Subscription identifier; distinct from an occurrence, payment attempt or lifecycle command identifier.",
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Stored lifecycle eligibility at asOf.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionLifecycleResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_UUID, UNKNOWN_QUERY_PARAMETER or UNEXPECTED_REQUEST_BODY.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE, ORGANISATION_REQUIRED or API_KEY_CONTEXT_REQUIRED.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "LIFECYCLE_CONTEXT_UNAVAILABLE or LIFECYCLE_SCOPE_INCOMPLETE; related data require review.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "LIFECYCLE_STORAGE_UNAVAILABLE.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "abonnements:read",
  "x-unisoft-additional-scopes": [
    "paiements:read"
  ],
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  },
  "x-unisoft-mcp-output-schema": true
}
```

## POST /abonnements/{id}/pause

Pause future subscription collections

`pause_subscription`

First read get_subscription_lifecycle and use its exact expectedRevision. Requires abonnements:write AND abonnements:read AND paiements:read. The caller generates idempotencyKey once per intent; keep it with the identical input after a timeout. APPLIED records an acknowledged lifecycle change at appliedAt, not the current subscription state or bank settlement. RUNNING and UNCERTAIN require reading get_subscription_lifecycle_command and the current subscription; never replay the owner or change the key to bypass uncertainty. No provider is called by these lifecycle commands. They do not revoke a mandate, refund a payment, cancel an already submitted debit, settle an instalment or erase history. The native EXECUTE lock is preserved when pausing. A pause cannot recall an operation already in progress. 409 SUBSCRIPTION_REVISION_CHANGED requires a fresh read and a newly confirmed intent. The command journal has no time-based reclaim. Only a local active:true contract that is not terminal or already paused is eligible; PAUSE leaves active:true. This stops future authority without rewriting financial history or changing the reusable method. An EXECUTE lock does not prevent pausing; another lock does. Managed remote contracts report REMOTE_LIFECYCLE_UNAVAILABLE. SEPA XML reports SEPA_LIFECYCLE_REQUIRED because its specialised owner must also preserve mandate, retry and native audit semantics. Organisation and campaign restrictions apply to the subscription, origin and related pledges; resume additionally admits the complete relevant history. Stored ambiguous or hidden financial data cannot authorize a resume. No reusable instrument, merchant credential, lock token, private snapshot or provider error is returned. An unresolved external lifecycle command blocks subsequent lifecycle writes with LIFECYCLE_RECONCILIATION_REQUIRED, including a different request UUID; time never clears that fence. 

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:write",
  "additional": [
    "abonnements:read",
    "paiements:read"
  ]
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "description": "Subscription identifier; distinct from an occurrence, payment attempt or lifecycle command identifier.",
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### Request body

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "idempotencyKey": {
            "type": "string",
            "format": "uuid",
            "description": "Caller-generated command UUID, unique within the organisation. Keep this key and the identical input after a timeout; a new key is a new request."
          },
          "expectedRevision": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$",
            "description": "Opaque exact version returned by get_subscription_lifecycle. Never construct it from the calendar revision."
          }
        },
        "required": [
          "idempotencyKey",
          "expectedRevision"
        ],
        "additionalProperties": false
      }
    }
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Stored lifecycle command observation; APPLIED is not a live state.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionLifecycleCommandResponse"
      }
    }
  }
}
```

#### HTTP 202

```json
{
  "description": "RUNNING or UNCERTAIN; owner execution is never retried automatically.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionLifecycleCommandResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_UUID, INVALID_LIFECYCLE_COMMAND or UNKNOWN_QUERY_PARAMETER.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE, ORGANISATION_REQUIRED, API_KEY_CONTEXT_REQUIRED or INVALID_CAMPAIGN_RESTRICTION.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "IDEMPOTENCY_CONFLICT, SUBSCRIPTION_REVISION_CHANGED or the explicit capability refusal reason. Review the current state and data; do not bypass a refusal.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "LIFECYCLE_STORAGE_UNAVAILABLE. If commandId is present, inspect that command and current state before another intent.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "abonnements:write",
  "x-unisoft-additional-scopes": [
    "abonnements:read",
    "paiements:read"
  ],
  "x-unisoft-mcp": {
    "category": "write",
    "readOnly": false,
    "destructive": true,
    "idempotent": true,
    "warn": true
  },
  "x-unisoft-mcp-output-schema": true
}
```

## POST /abonnements/{id}/resume

Resume future automatic subscription collections

`resume_subscription`

First read get_subscription_lifecycle and use its exact expectedRevision. Requires abonnements:write AND abonnements:read AND paiements:read. The caller generates idempotencyKey once per intent; keep it with the identical input after a timeout. APPLIED records an acknowledged lifecycle change at appliedAt, not the current subscription state or bank settlement. RUNNING and UNCERTAIN require reading get_subscription_lifecycle_command and the current subscription; never replay the owner or change the key to bypass uncertainty. No provider is called by these lifecycle commands. They do not revoke a mandate, refund a payment, cancel an already submitted debit, settle an instalment or erase history. The native EXECUTE lock is preserved when pausing. A pause cannot recall an operation already in progress. 409 SUBSCRIPTION_REVISION_CHANGED requires a fresh read and a newly confirmed intent. The command journal has no time-based reclaim. Additionally requires the opt-in abonnements:resume scope and acknowledgeFutureDebits:true. This makes future automatic debits possible using the current stored method. Only an active:true local monthly contract in PAUSE can resume, with a valid configured stored method, no pending replacement, no native lock, no uncertain/committed payment and a calculable future occurrence. Native calendar initialization may be persisted under its lock. The native owner reanchors the first unlaunched occurrence to the next monthly day strictly after today in the contract timezone; missed months are not charged by this command. Payment execution remains subject to its own later checks. Managed remote contracts report REMOTE_LIFECYCLE_UNAVAILABLE. SEPA XML reports SEPA_LIFECYCLE_REQUIRED because its specialised owner must also preserve mandate, retry and native audit semantics. Organisation and campaign restrictions apply to the subscription, origin and related pledges; resume additionally admits the complete relevant history. Stored ambiguous or hidden financial data cannot authorize a resume. No reusable instrument, merchant credential, lock token, private snapshot or provider error is returned. An unresolved external lifecycle command blocks subsequent lifecycle writes with LIFECYCLE_RECONCILIATION_REQUIRED, including a different request UUID; time never clears that fence. 

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:write",
  "additional": [
    "abonnements:read",
    "paiements:read",
    "abonnements:resume"
  ]
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "description": "Subscription identifier; distinct from an occurrence, payment attempt or lifecycle command identifier.",
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### Request body

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "idempotencyKey": {
            "type": "string",
            "format": "uuid",
            "description": "Caller-generated command UUID, unique within the organisation. Keep this key and the identical input after a timeout; a new key is a new request."
          },
          "expectedRevision": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$",
            "description": "Opaque exact version returned by get_subscription_lifecycle. Never construct it from the calendar revision."
          },
          "acknowledgeFutureDebits": {
            "type": "boolean",
            "enum": [
              true
            ],
            "description": "Explicitly acknowledge that resuming grants future automatic collection authority to the existing subscription owner."
          }
        },
        "required": [
          "idempotencyKey",
          "expectedRevision",
          "acknowledgeFutureDebits"
        ],
        "additionalProperties": false
      }
    }
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Stored lifecycle command observation; APPLIED is not a live state.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionLifecycleCommandResponse"
      }
    }
  }
}
```

#### HTTP 202

```json
{
  "description": "RUNNING or UNCERTAIN; owner execution is never retried automatically.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionLifecycleCommandResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_UUID, INVALID_LIFECYCLE_COMMAND or UNKNOWN_QUERY_PARAMETER.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE, ORGANISATION_REQUIRED, API_KEY_CONTEXT_REQUIRED or INVALID_CAMPAIGN_RESTRICTION.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "IDEMPOTENCY_CONFLICT, SUBSCRIPTION_REVISION_CHANGED or the explicit capability refusal reason. Review the current state and data; do not bypass a refusal.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "LIFECYCLE_STORAGE_UNAVAILABLE. If commandId is present, inspect that command and current state before another intent.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "abonnements:write",
  "x-unisoft-additional-scopes": [
    "abonnements:read",
    "paiements:read",
    "abonnements:resume"
  ],
  "x-unisoft-mcp": {
    "category": "write",
    "readOnly": false,
    "destructive": true,
    "idempotent": true,
    "warn": true
  },
  "x-unisoft-mcp-output-schema": true
}
```

## POST /abonnements/{id}/cancel

Close a subscription and stop future collection authority

`cancel_subscription`

Read get_subscription_lifecycle and its exact expectedRevision first. Requires abonnements:write AND abonnements:read AND paiements:read, plus acknowledgeCancellation:true. This final closure differs from PAUSE: resume_subscription cannot reopen FINISHED. A local contract is closed by the native lifecycle owner with state:FINISHED, active:false, manualCancel:true and canceledAt; a native EXECUTE lock is preserved and an already launched debit cannot be recalled. For managed NEDARIM or STRIPE_EXTERNAL, the existing native provider cancellation must confirm success BEFORE the scoped local contract is closed; there is no force-close fallback. This managed POST may call the provider, unlike local cancellation and the read. The current stored remote reference and exact organisation/association configuration are used; caller-supplied provider references and credentials are forbidden. A response failure or timeout may mean cancellation already happened remotely while local state remains unchanged. It becomes UNCERTAIN and the owner is never replayed, even with a new UUID. APPLIED records only acknowledged closure at appliedAt, not current bank status, refund or settlement. Existing/in-flight attempts remain, and later provider results may still arrive. Missing remote references, unsupported managed providers and specialised SEPA XML lifecycle return explicit refusals before provider entry. Keep one idempotencyKey UUID and the exact request after a timeout; use get_subscription_lifecycle_command and current contract/history reads for resolution. Organisation and campaign restrictions apply to the subscription, origin and related pledges; resume additionally admits the complete relevant history. Stored ambiguous or hidden financial data cannot authorize a resume. No reusable instrument, merchant credential, lock token, private snapshot or provider error is returned. An unresolved external lifecycle command blocks subsequent lifecycle writes with LIFECYCLE_RECONCILIATION_REQUIRED, including a different request UUID; time never clears that fence. 

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:write",
  "additional": [
    "abonnements:read",
    "paiements:read"
  ]
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "description": "Subscription identifier; distinct from an occurrence, payment attempt or lifecycle command identifier.",
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### Request body

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "idempotencyKey": {
            "type": "string",
            "format": "uuid",
            "description": "Caller-generated command UUID, unique within the organisation. Keep this key and the identical input after a timeout; a new key is a new request."
          },
          "expectedRevision": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$",
            "description": "Opaque exact version returned by get_subscription_lifecycle. Never construct it from the calendar revision."
          },
          "acknowledgeCancellation": {
            "type": "boolean",
            "enum": [
              true
            ],
            "description": "Explicitly acknowledge final contract closure; unlike PAUSE, this contract cannot be resumed through resume_subscription."
          }
        },
        "required": [
          "idempotencyKey",
          "expectedRevision",
          "acknowledgeCancellation"
        ],
        "additionalProperties": false
      }
    }
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Stored lifecycle command observation; APPLIED is not a live state.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionLifecycleCommandResponse"
      }
    }
  }
}
```

#### HTTP 202

```json
{
  "description": "RUNNING or UNCERTAIN; owner execution is never retried automatically.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionLifecycleCommandResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_UUID, INVALID_LIFECYCLE_COMMAND or UNKNOWN_QUERY_PARAMETER.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE, ORGANISATION_REQUIRED, API_KEY_CONTEXT_REQUIRED or INVALID_CAMPAIGN_RESTRICTION.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "SUBSCRIPTION_CLOSED, SUBSCRIPTION_BUSY, REMOTE_CANCELLATION_UNAVAILABLE, REMOTE_CANCELLATION_REFERENCE_REQUIRED, REMOTE_CANCELLATION_CONFIGURATION_UNAVAILABLE, SEPA_LIFECYCLE_REQUIRED, IDEMPOTENCY_CONFLICT, SUBSCRIPTION_REVISION_CHANGED or LIFECYCLE_RECONCILIATION_REQUIRED.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "LIFECYCLE_STORAGE_UNAVAILABLE. If commandId is present, inspect that command and current state before another intent.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "abonnements:write",
  "x-unisoft-additional-scopes": [
    "abonnements:read",
    "paiements:read"
  ],
  "x-unisoft-mcp": {
    "category": "write",
    "readOnly": false,
    "destructive": true,
    "idempotent": true,
    "warn": true
  },
  "x-unisoft-mcp-output-schema": true
}
```

## GET /abonnements/{id}/lifecycle/commands/{commandId}

Read a recorded subscription lifecycle result

`get_subscription_lifecycle_command`

Requires abonnements:read. Reads a stored lifecycle command only, without calling or retrying its owner. id is the subscription identifier and commandId is the lifecycle command identifier. APPLIED/appliedState describe the acknowledged change at appliedAt, not the current contract or payer status. RUNNING or UNCERTAIN never become retry permission with elapsed time; inspect current subscription state and use the owning application to resolve uncertainty. No provider or lock is touched. Organisation and campaign restrictions apply to the subscription, origin and related pledges; resume additionally admits the complete relevant history. Stored ambiguous or hidden financial data cannot authorize a resume. No reusable instrument, merchant credential, lock token, private snapshot or provider error is returned. An unresolved external lifecycle command blocks subsequent lifecycle writes with LIFECYCLE_RECONCILIATION_REQUIRED, including a different request UUID; time never clears that fence. 

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:read",
  "additional": []
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "description": "Subscription identifier; distinct from an occurrence, payment attempt or lifecycle command identifier.",
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

```json
{
  "name": "commandId",
  "in": "path",
  "required": true,
  "description": "Lifecycle command identifier returned by pause_subscription, resume_subscription or cancel_subscription.",
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Stored lifecycle command observation; APPLIED is not a live state.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionLifecycleCommandResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_UUID, UNKNOWN_QUERY_PARAMETER or UNEXPECTED_REQUEST_BODY.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE, ORGANISATION_REQUIRED or API_KEY_CONTEXT_REQUIRED.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "INVALID_LIFECYCLE_COMMAND_HISTORY or LIFECYCLE_CONTEXT_UNAVAILABLE.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "LIFECYCLE_STORAGE_UNAVAILABLE.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "abonnements:read",
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  },
  "x-unisoft-mcp-output-schema": true
}
```

## POST /abonnements/{id}/reminder/preview

Inspect and preview a reminder for an interrupted subscription

`preview_abonnement_reminder`

Requires abonnements:read, paiements:read AND contacts:read. Exact organisation, API principal, related objects, allocations, association/currency and permitted campaigns are enforced. No query parameters are accepted. Private instruments, merchant configuration, owner proofs, raw exceptions and action URLs are never returned. Pure preview: no journal, reservation, queue, execution, reconciliation, persistent calendar, checkout or method setup. READY requires a local active MANUAL or CARD_EXPIRED contract, an exact current payer snapshot, admitted financial history and no engaged/uncertain attempt outside an admitted recorded checkout. Supported owner capabilities span Stripe, Stripe External, Kesher, Cardcom, PayGreen, Authorize.Net, Axepta, iPay and native Stripe/Gocardless mandate paths when configured for the exact merchant, method and currency; this is local admission, not a live provider guarantee. Locally owned enabled frozen Stripe External/Kesher configuration references may remain admitted after current defaults change; global namespace, association and all documentary configuration fingerprints are checked. A prior Stripe Connect account without local ownership proof is refused instead of guessed. linkKind=EXISTING_CHECKOUT uses the incident owner to verify an existing Stripe Session, original payer/billing, merchant, occurrence, revision and future expiry. An expired or contradictory recorded Session never authorizes replacement. linkKind=NATIVE_MANUAL_ENTRY uses the real manual_card_renewal selection with fenced effect ports: its versioned setup or manual-settlement branch is captured before any execution/setup/progress/write. No synthetic owner success or invented PSP URL is accepted. Its URL comes only from the canonical native reminder content and the configured API environment. When the payer later follows that entry, the native owner rechecks current state and may reconcile, prepare a checkout/mandate or settle a due occurrence and renew a method; preview and send do none of those actions. The payer remains payload.info, not a subsequently edited CRM contact. A caller-authored plain-text subject and the canonical native message are used, with every action URL masked by [REGULARIZATION_LINK]. nominalAmountMinor is the contract monthly amount. settlementAmountMinor is available only for the admitted existing attempt; it remains null for a native entry, never substituted by the nominal amount or a guessed arrears balance. Values use minor units (5000 = 50.00 EUR), with no inferred/mixed/converted currency. The snapshot binds subscription/history, merchant/related proofs, native capability/entry or existing Session, recipient, content and subject. Send only READY with the unchanged snapshot. Otherwise message/snapshot/linkKind remain null. PENDING_ACTIVATION_OWNER_REQUIRED is initial enrolment, a distinct owner prerequisite; no new activation is exposed. MANAGED_OWNER, SEPA_XML_OWNER, pending method change or explicit manual review retain their own workflows. NATIVE_MANUAL_OWNER_UNAVAILABLE means this native entry has no verified current setup/settlement capability, including PAYME.IDD versioned-link and unsupported-adapter cases; it is not a blanket Stripe restriction. Rest status is informational for preview. A durable organisation/resource guard also blocks a different request key after PENDING, UNCERTAIN or missing terminal completion proof, even after native minute/day dedupe expires. REMINDER_PREVIOUS_RESULT_UNCERTAIN requires observing and resolving the existing intention in Unisoft; never invent a new key or bypass the guard. Resource claims require positive exact durable insert/CAS acknowledgements. A completion record is written only after a positively acknowledged terminal journal; a stored QUEUED/UPDATED/REFUSED alone cannot grant another owner. Failure of only accessory completion bookkeeping preserves a positively proven effect and retains the guard.

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:read",
  "additional": [
    "paiements:read",
    "contacts:read"
  ]
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### Request body

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "subject": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200,
            "allOf": [
              {
                "pattern": "\\S"
              },
              {
                "pattern": "^[^\\r\\n]*$"
              }
            ]
          }
        },
        "required": [
          "subject"
        ],
        "additionalProperties": false
      }
    }
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Allowlisted subscription reminder availability or recorded command observation.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/SubscriptionReminderPreview"
          }
        },
        "required": [
          "success",
          "data"
        ]
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_UUID, INVALID_REMINDER_INPUT, EXPLICIT_REST_OVERRIDE_REQUIRED or UNEXPECTED_REQUEST_BODY. Unknown fields and all query parameters are refused.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE or INVALID_PRINCIPAL. Read scopes are cumulative; sending requires the explicit opt-in scope.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND: the subscription, a required payer/related reference or this API principal command is unavailable in the organisation and permitted campaign scope.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "SUBSCRIPTION_REMINDER_UNAVAILABLE: inspect preview.availability. REST_TIME and REST_STATUS_UNAVAILABLE block queueing. REMINDER_SNAPSHOT_CHANGED, REMINDER_RECENT and IDEMPOTENCY_CONFLICT refuse a changed or concurrent intention. Invalid schedule, merchant, association, currency, historical allocation or payer data requires owning-application review. An uncertain result never authorizes a fresh-key retry.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "INTERNAL_ERROR. Do not infer that the send failed or retry with a fresh key.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "REMINDER_JOURNAL_UNCERTAIN, REMINDER_QUEUE_UNCERTAIN, REMINDER_LINK_UNCERTAIN, REMINDER_TOKEN_UNCERTAIN or REMINDER_RESERVATION_UNCERTAIN. A durable write acknowledgement is missing or contradictory; no new effect or retry is authorized. Observe the existing request using the same identity. REMINDER_RESOURCE_RESERVATION_UNCERTAIN grants no resource owner and permits no later effect.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-scope": "abonnements:read",
  "x-unisoft-additional-scopes": [
    "paiements:read",
    "contacts:read"
  ],
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## POST /abonnements/{id}/reminder/send

Queue an admitted native subscription reminder

`send_abonnement_reminder`

Requires abonnements:read, paiements:read AND contacts:read. Exact organisation, API principal, related objects, allocations, association/currency and permitted campaigns are enforced. No query parameters are accepted. Private instruments, merchant configuration, owner proofs, raw exceptions and action URLs are never returned. Additionally requires the explicit opt-in abonnements:reminders:send. First preview READY and review linkKind, the payer and the later native-entry effects. Send the identical subject, expectedSnapshot and UUID idempotencyKey. A durable journal and cross-key resource fence precede the exact reminderAttempt CAS and queue insert. Current state, merchant/capability, related history, payer and minute throttle are readmitted before queueing. Negative write/error-concern metadata never grants authority even with acknowledged=true; uncertainty is retained. Only the admitted existing checkout URL or the canonical native payer-entry URL is placed in the email; the API never follows it, calls reconciliation/execution/setup/progress, creates or recreates a checkout, debits, resumes, replaces a method, activates initial enrolment or notifies staff. The recipient may later use the native entry for its own separately checked financial workflow; sending the email proves none of its outcome. A changed source refuses the snapshot/reservation. Chabbat and Yom Tov use the canonical Paris/diaspora calendar (Europe/Paris); REST_TIME or unavailable calculation refuses admission. forceRest=true requires restOverrideReason AND the user explicit override intention, never an automatic bypass. This guards queue admission, not later transport/inbox timing. Identical principal/key/input observes the prior command; changed input gives IDEMPOTENCY_CONFLICT. Keep native reservations after uncertainty. QUEUED proves local durable admission only, not delivery, payment, method renewal or resumed support. No automatic command retry or provider polling occurs. Checks are optimistic observations, not a global transaction or future provider/link usability guarantee. Optional delivery-read failure gives deliveryRead=UNAVAILABLE without undoing a known queue effect. A durable organisation/resource guard also blocks a different request key after PENDING, UNCERTAIN or missing terminal completion proof, even after native minute/day dedupe expires. REMINDER_PREVIOUS_RESULT_UNCERTAIN requires observing and resolving the existing intention in Unisoft; never invent a new key or bypass the guard. Resource claims require positive exact durable insert/CAS acknowledgements. A completion record is written only after a positively acknowledged terminal journal; a stored QUEUED/UPDATED/REFUSED alone cannot grant another owner. Failure of only accessory completion bookkeeping preserves a positively proven effect and retains the guard.

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:reminders:send",
  "additional": [
    "abonnements:read",
    "paiements:read",
    "contacts:read"
  ]
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### Request body

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "subject": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200,
            "allOf": [
              {
                "pattern": "\\S"
              },
              {
                "pattern": "^[^\\r\\n]*$"
              }
            ]
          },
          "idempotencyKey": {
            "type": "string",
            "format": "uuid"
          },
          "expectedSnapshot": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "forceRest": {
            "type": "boolean"
          },
          "restOverrideReason": {
            "type": "string",
            "minLength": 1,
            "maxLength": 500,
            "pattern": "\\S"
          }
        },
        "required": [
          "subject",
          "idempotencyKey",
          "expectedSnapshot"
        ],
        "additionalProperties": false,
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "forceRest": {
                "type": "boolean",
                "enum": [
                  true
                ]
              }
            },
            "required": [
              "forceRest",
              "restOverrideReason"
            ],
            "additionalProperties": true
          },
          {
            "type": "object",
            "properties": {
              "forceRest": {
                "type": "boolean",
                "enum": [
                  false
                ]
              }
            },
            "additionalProperties": true,
            "not": {
              "required": [
                "restOverrideReason"
              ]
            }
          }
        ]
      }
    }
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Allowlisted subscription reminder availability or recorded command observation.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/SubscriptionReminderCommand"
          }
        },
        "required": [
          "success",
          "data"
        ]
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_UUID, INVALID_REMINDER_INPUT, EXPLICIT_REST_OVERRIDE_REQUIRED or UNEXPECTED_REQUEST_BODY. Unknown fields and all query parameters are refused.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE or INVALID_PRINCIPAL. Read scopes are cumulative; sending requires the explicit opt-in scope.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND: the subscription, a required payer/related reference or this API principal command is unavailable in the organisation and permitted campaign scope.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "SUBSCRIPTION_REMINDER_UNAVAILABLE: inspect preview.availability. REST_TIME and REST_STATUS_UNAVAILABLE block queueing. REMINDER_SNAPSHOT_CHANGED, REMINDER_RECENT and IDEMPOTENCY_CONFLICT refuse a changed or concurrent intention. Invalid schedule, merchant, association, currency, historical allocation or payer data requires owning-application review. An uncertain result never authorizes a fresh-key retry.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "INTERNAL_ERROR. Do not infer that the send failed or retry with a fresh key.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "REMINDER_JOURNAL_UNCERTAIN, REMINDER_QUEUE_UNCERTAIN, REMINDER_LINK_UNCERTAIN, REMINDER_TOKEN_UNCERTAIN or REMINDER_RESERVATION_UNCERTAIN. A durable write acknowledgement is missing or contradictory; no new effect or retry is authorized. Observe the existing request using the same identity. REMINDER_RESOURCE_RESERVATION_UNCERTAIN grants no resource owner and permits no later effect.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-scope": "abonnements:reminders:send",
  "x-unisoft-additional-scopes": [
    "abonnements:read",
    "paiements:read",
    "contacts:read"
  ],
  "x-unisoft-mcp": {
    "category": "write",
    "readOnly": false,
    "destructive": false,
    "idempotent": true,
    "warn": true
  }
}
```

## GET /abonnements/{id}/reminder/commands/{requestId}

Observe a subscription reminder command without replaying it

`get_abonnement_reminder_command`

Requires abonnements:read, paiements:read AND contacts:read. Exact organisation, API principal, related objects, allocations, association/currency and permitted campaigns are enforced. No query parameters are accepted. Private instruments, merchant configuration, owner proofs, raw exceptions and action URLs are never returned. Additionally requires explicitly granted abonnements:reminders:send and the original initiating API principal. Read-only: no provider polling, reminder reservation, resend, financial reconciliation or new checkout. Current subscription organisation/campaign rights are readmitted; later lifecycle changes do not cancel an email already queued. PENDING/UNCERTAIN never means failed and never authorizes a new key. QUEUED_OR_IN_FLIGHT does not distinguish waiting from an active worker. SMTP_ACCEPTED proves transport acceptance only; DELIVERED requires an explicit report and valid deliveredAt. UNKNOWN, UNCERTAIN or deliveryRead=UNAVAILABLE leaves delivery unproven. Neither queue admission nor delivery proves that the payer followed the native entry, paid, renewed a method or resumed the contract. A durable organisation/resource guard also blocks a different request key after PENDING, UNCERTAIN or missing terminal completion proof, even after native minute/day dedupe expires. REMINDER_PREVIOUS_RESULT_UNCERTAIN requires observing and resolving the existing intention in Unisoft; never invent a new key or bypass the guard. Resource claims require positive exact durable insert/CAS acknowledgements. A completion record is written only after a positively acknowledged terminal journal; a stored QUEUED/UPDATED/REFUSED alone cannot grant another owner. Failure of only accessory completion bookkeeping preserves a positively proven effect and retains the guard.

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:reminders:send",
  "additional": [
    "abonnements:read",
    "paiements:read",
    "contacts:read"
  ]
}
```

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

```json
{
  "name": "requestId",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Allowlisted subscription reminder availability or recorded command observation.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/SubscriptionReminderCommand"
          }
        },
        "required": [
          "success",
          "data"
        ]
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_UUID, INVALID_REMINDER_INPUT, EXPLICIT_REST_OVERRIDE_REQUIRED or UNEXPECTED_REQUEST_BODY. Unknown fields and all query parameters are refused.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE or INVALID_PRINCIPAL. Read scopes are cumulative; sending requires the explicit opt-in scope.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND: the subscription, a required payer/related reference or this API principal command is unavailable in the organisation and permitted campaign scope.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "SUBSCRIPTION_REMINDER_UNAVAILABLE: inspect preview.availability. REST_TIME and REST_STATUS_UNAVAILABLE block queueing. REMINDER_SNAPSHOT_CHANGED, REMINDER_RECENT and IDEMPOTENCY_CONFLICT refuse a changed or concurrent intention. Invalid schedule, merchant, association, currency, historical allocation or payer data requires owning-application review. An uncertain result never authorizes a fresh-key retry.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "INTERNAL_ERROR. Do not infer that the send failed or retry with a fresh key.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "REMINDER_JOURNAL_UNCERTAIN, REMINDER_QUEUE_UNCERTAIN, REMINDER_LINK_UNCERTAIN, REMINDER_TOKEN_UNCERTAIN or REMINDER_RESERVATION_UNCERTAIN. A durable write acknowledgement is missing or contradictory; no new effect or retry is authorized. Observe the existing request using the same identity. REMINDER_RESOURCE_RESERVATION_UNCERTAIN grants no resource owner and permits no later effect.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-scope": "abonnements:reminders:send",
  "x-unisoft-additional-scopes": [
    "abonnements:read",
    "paiements:read",
    "contacts:read"
  ],
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## POST /abonnements/requests

Prepare a monthly subscription requiring payer authorisation

`prepare_subscription`

Required scopes: `abonnements:write` AND `paiements:write`. Creates/enriches CRM identity, creates a GENERAL subscription contract with active:false and prepares a hosted first-payment Checkout through the existing owners. Ambiguous, deleted, foreign or duplicate CRM matches are refused; CRM writes use one admitted contact with scoped conditional updates. This is a real write and may create a provider customer/Checkout; it does not charge a stored method. The payer must authorise and pay on the returned page. Initial coverage is monthly GENERAL with a proved Stripe Connect or Stripe External hosted-card adapter. Linked targets, managed contracts, bank mandates and reusable methods are not admitted here. montant is major; maxAmount is minor. Both zero limits explicitly mean unbounded. The same idempotencyKey and identical input never re-execute the creation owners. A different input returns IDEMPOTENCY_CONFLICT. PREPARING or UNCERTAIN means reconcile by request id; never change the key to force a retry. PREPARED records a prepared Checkout, not confirmed consent, activation, capture or settlement. Its expiry is proved by an authenticated native Session read; no duration is invented when the creation owner omits expiry. Before any URL disclosure, including replay, current merchant/policy, native pending records and the authenticated open/unpaid Session must still agree. Replay may read the provider, but never recreates the Checkout or contract. The URL is returned only to this dual-write principal; GET status deliberately excludes it and makes no provider call. Campaign-restricted keys are refused. Read the subscription-commands guide before writing.

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:write",
  "additional": [
    "paiements:write"
  ]
}
```

### Request body

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/UnisoftRequest_7bdae3ccb939dc1b03a6"
      }
    }
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Recorded preparation, not proof of payer consent, collection or bank settlement.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionPreparationResponse"
      }
    }
  }
}
```

#### HTTP 202

```json
{
  "description": "Recorded preparation, not proof of payer consent, collection or bank settlement.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionPreparationResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "Fixed error code; no provider exception, credential or private payload.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionPreparationError"
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "Fixed error code; no provider exception, credential or private payload.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionPreparationError"
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "Fixed error code; no provider exception, credential or private payload.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionPreparationError"
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "Fixed error code; no provider exception, credential or private payload.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionPreparationError"
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "Fixed error code; no provider exception, credential or private payload.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionPreparationError"
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "abonnements:write",
  "x-unisoft-additional-scopes": [
    "paiements:write"
  ],
  "x-unisoft-mcp": {
    "category": "create",
    "readOnly": false,
    "destructive": false,
    "idempotent": true,
    "warn": true
  },
  "x-unisoft-mcp-output-schema": true
}
```

## GET /abonnements/requests/{requestId}

Read a subscription preparation without its capability link

`get_subscription_preparation`

Required scope: `abonnements:read`. Reads only the recorded external preparation and its financial intent, in the authenticated organisation. It does not contact a provider, initialise a calendar, retry creation or expose the payer-authorisation URL. PREPARED is the initial Checkout observation, not the current provider or subscription state; read get_abonnement/get_paiement_status with their own grants for current records. PREPARING and UNCERTAIN must not be replaced by a new request. No identity snapshot, merchant reference, card, customer token or mandate is returned. Campaign-restricted keys are refused.

### Authentication

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Required permissions

```json
{
  "accepted": "abonnements:read",
  "additional": []
}
```

### Parameters

```json
{
  "name": "requestId",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  },
  "description": "Existing preparation id returned by prepare_subscription, not an abonnement id or a newly generated UUID."
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Recorded preparation, not proof of payer consent, collection or bank settlement.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionPreparationResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "Fixed error code; no provider exception, credential or private payload.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionPreparationError"
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "Fixed error code; no provider exception, credential or private payload.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionPreparationError"
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "Fixed error code; no provider exception, credential or private payload.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionPreparationError"
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "Fixed error code; no provider exception, credential or private payload.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionPreparationError"
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "Fixed error code; no provider exception, credential or private payload.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SubscriptionPreparationError"
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "abonnements:read",
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  },
  "x-unisoft-mcp-output-schema": true
}
```

## Schemas

```json
{
  "components": {
    "schemas": {
      "Abonnement": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "organisation",
          "contact",
          "recurrentType",
          "active",
          "confirmed",
          "managed",
          "state",
          "datetime",
          "canceledAt",
          "nb",
          "max",
          "payload"
        ],
        "properties": {
          "id": {
            "type": "string",
            "nullable": true,
            "description": "Stored subscription identifier. Missing or incorrectly typed historical values are null."
          },
          "organisation": {
            "type": "string",
            "nullable": true,
            "description": "Owning organisation, selected from the authenticated organisation before projection."
          },
          "contact": {
            "type": "string",
            "nullable": true,
            "description": "Recorded CRM contact identifier. No contact identity or permissions are inferred from the reference."
          },
          "recurrentType": {
            "type": "string",
            "nullable": true,
            "description": "Recorded recurrence code. The current local engine uses MONTH; the field alone does not describe a calculated schedule."
          },
          "active": {
            "type": "boolean",
            "nullable": true,
            "description": "Exact recorded active marker. false covers several lifecycle situations and does not mean paused; null is unknown."
          },
          "confirmed": {
            "type": "boolean",
            "nullable": true,
            "description": "Exact recorded confirmation marker, or null when absent/invalid. It is not a bank-settlement result."
          },
          "managed": {
            "type": "boolean",
            "nullable": true,
            "description": "Exact recorded remote-management marker, or null when absent/invalid. No remote reference or synchronization is exposed."
          },
          "state": {
            "type": "string",
            "nullable": true,
            "description": "Exact recorded lifecycle state matching the documented pattern. Unknown well-formed codes are preserved; missing or malformed values are null. No debit permission or inferred display state is returned.",
            "pattern": "^[A-Z][A-Z0-9_-]{0,63}$",
            "maxLength": 64
          },
          "datetime": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Recorded initial/anchor datetime, normalized to ISO with years 0000 to 9999. Accepts valid stored dates, integer epoch milliseconds, strict ISO datetimes with timezone or YYYY-MM-DD at midnight UTC. Impossible civil dates and ambiguous strings are null without rollover. This is not the calculated next debit date."
          },
          "canceledAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Recorded cancellation datetime, normalized with the same strict date rules as datetime. null means absent or invalid, not proof that cancellation is impossible or unnecessary."
          },
          "nb": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991,
            "nullable": true,
            "description": "Recorded contractual occurrence-count limit. null means absent/invalid; it is not a paid count or a recurrence frequency. Explicit stored zero is preserved and is not a positive limit."
          },
          "max": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991,
            "nullable": true,
            "description": "Recorded total contractual ceiling in minor currency units. null means absent/invalid, without a fabricated ceiling; explicit stored zero is preserved and is not a positive limit. This is not a remaining or collected amount."
          },
          "payload": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "amount",
              "devise",
              "assoc",
              "type",
              "typeId",
              "parentTypeId",
              "method",
              "platform",
              "name",
              "cerfa",
              "cerfaYear",
              "pledgeReceiptRequested",
              "info",
              "facturation",
              "dettes"
            ],
            "properties": {
              "amount": {
                "type": "integer",
                "minimum": 1,
                "maximum": 9007199254740991,
                "nullable": true,
                "description": "Recorded nominal amount in minor currency units: 5000 = 50.00 EUR. It is not a collected total or an occurrence amount. Missing, zero, negative or invalid values are null without conversion or fallback."
              },
              "devise": {
                "type": "string",
                "nullable": true,
                "pattern": "^[a-z]{3}$",
                "description": "Recorded nominal currency, lowercased. Missing or malformed values are null; the organisation currency is never substituted."
              },
              "assoc": {
                "type": "string",
                "nullable": true,
                "description": "Recorded beneficiary association. MAIN is a valid main-association reference; no absent association is guessed."
              },
              "type": {
                "type": "string",
                "nullable": true,
                "description": "Recorded business allocation type. Legacy and future strings are preserved without granting access to the target."
              },
              "typeId": {
                "type": "string",
                "nullable": true,
                "description": "Recorded business target. FORM means a submission; GENERAL may be null. This reference does not grant authority over another resource."
              },
              "parentTypeId": {
                "type": "string",
                "nullable": true,
                "description": "Recorded parent form identifier when present; no parent is inferred from the subscription."
              },
              "method": {
                "type": "string",
                "nullable": true,
                "description": "Recorded instrument for the contract. No reusable instrument or provider capability is inferred."
              },
              "platform": {
                "type": "string",
                "nullable": true,
                "description": "Recorded execution provider. No reusable provider reference or configuration is exposed."
              },
              "name": {
                "type": "string",
                "nullable": true,
                "description": "Recorded human-readable contract label."
              },
              "cerfa": {
                "type": "boolean",
                "nullable": true,
                "description": "Recorded tax-document choice for future payments. This does not assert tax eligibility, receipt issuance or a collected amount."
              },
              "cerfaYear": {
                "type": "boolean",
                "nullable": true,
                "description": "Recorded annual tax-document mode. It is independent of payment collection and ordinary per-payment document processing."
              },
              "pledgeReceiptRequested": {
                "type": "boolean",
                "nullable": true,
                "description": "Recorded tax-document intention for pledge allocations, when present. Existing payment snapshots remain authoritative for those payments."
              },
              "info": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "nom",
                  "prenom",
                  "email",
                  "tel"
                ],
                "properties": {
                  "nom": {
                    "type": "string",
                    "nullable": true,
                    "description": "Recorded donor identity field. Empty strings are preserved; absent or incorrectly typed values are null. No contact enrichment is performed."
                  },
                  "prenom": {
                    "type": "string",
                    "nullable": true,
                    "description": "Recorded donor identity field. Empty strings are preserved; absent or incorrectly typed values are null. No contact enrichment is performed."
                  },
                  "email": {
                    "type": "string",
                    "nullable": true,
                    "description": "Recorded donor identity field. Empty strings are preserved; absent or incorrectly typed values are null. No contact enrichment is performed."
                  },
                  "tel": {
                    "type": "string",
                    "nullable": true,
                    "description": "Recorded donor identity field. Empty strings are preserved; absent or incorrectly typed values are null. No contact enrichment is performed."
                  }
                },
                "description": "Allowlisted recorded donor identity. No CRM lookup, payment-method data or additional private fields."
              },
              "facturation": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "nom",
                  "prenom",
                  "raison",
                  "siren",
                  "civilite",
                  "adresse",
                  "postal",
                  "ville",
                  "etat",
                  "pays",
                  "social_id",
                  "perso",
                  "giftAid"
                ],
                "properties": {
                  "nom": {
                    "type": "string",
                    "nullable": true,
                    "description": "Recorded billing identity or address field. Empty strings are preserved; absent or incorrectly typed values are null. Provider buyer and card references are excluded."
                  },
                  "prenom": {
                    "type": "string",
                    "nullable": true,
                    "description": "Recorded billing identity or address field. Empty strings are preserved; absent or incorrectly typed values are null. Provider buyer and card references are excluded."
                  },
                  "raison": {
                    "type": "string",
                    "nullable": true,
                    "description": "Recorded billing identity or address field. Empty strings are preserved; absent or incorrectly typed values are null. Provider buyer and card references are excluded."
                  },
                  "siren": {
                    "type": "string",
                    "nullable": true,
                    "description": "Recorded billing identity or address field. Empty strings are preserved; absent or incorrectly typed values are null. Provider buyer and card references are excluded."
                  },
                  "civilite": {
                    "type": "string",
                    "nullable": true,
                    "description": "Recorded billing identity or address field. Empty strings are preserved; absent or incorrectly typed values are null. Provider buyer and card references are excluded."
                  },
                  "adresse": {
                    "type": "string",
                    "nullable": true,
                    "description": "Recorded billing identity or address field. Empty strings are preserved; absent or incorrectly typed values are null. Provider buyer and card references are excluded."
                  },
                  "postal": {
                    "type": "string",
                    "nullable": true,
                    "description": "Recorded billing identity or address field. Empty strings are preserved; absent or incorrectly typed values are null. Provider buyer and card references are excluded."
                  },
                  "ville": {
                    "type": "string",
                    "nullable": true,
                    "description": "Recorded billing identity or address field. Empty strings are preserved; absent or incorrectly typed values are null. Provider buyer and card references are excluded."
                  },
                  "etat": {
                    "type": "string",
                    "nullable": true,
                    "description": "Recorded billing identity or address field. Empty strings are preserved; absent or incorrectly typed values are null. Provider buyer and card references are excluded."
                  },
                  "pays": {
                    "type": "string",
                    "nullable": true,
                    "description": "Recorded billing identity or address field. Empty strings are preserved; absent or incorrectly typed values are null. Provider buyer and card references are excluded."
                  },
                  "social_id": {
                    "type": "string",
                    "nullable": true,
                    "description": "Recorded billing identity or address field. Empty strings are preserved; absent or incorrectly typed values are null. Provider buyer and card references are excluded."
                  },
                  "perso": {
                    "type": "boolean",
                    "nullable": true,
                    "description": "Recorded personal/company billing discriminator. null is unknown, without an inferred personal identity."
                  },
                  "giftAid": {
                    "type": "boolean",
                    "nullable": true,
                    "description": "Explicit recorded Gift Aid declaration, or null when absent or invalid. No eligibility is inferred."
                  }
                },
                "description": "Allowlisted recorded billing identity and address. No stored cards, buyer/customer reference or provider data."
              },
              "dettes": {
                "type": "array",
                "nullable": true,
                "description": "Recorded pledge-allocation rows. montant is in MAJOR currency units and can describe the total legacy contract budget, not one collected payment. An explicit empty array stays empty; absent/invalid containers are null and malformed rows retain null fields. No allocation total or current pledge balance is inferred.",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "id",
                    "montant"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "nullable": true,
                      "description": "Recorded pledge identifier. This reference does not grant authority to read the pledge."
                    },
                    "montant": {
                      "type": "number",
                      "minimum": 0,
                      "maximum": 90071992547409.9,
                      "nullable": true,
                      "description": "Recorded allocation in MAJOR currency units, without rounding or unit conversion. Non-finite, negative, incorrectly typed or out-of-range values are null."
                    }
                  }
                }
              }
            },
            "description": "Allowlisted recorded subscription contract. Nominal money stays under payload.amount/devise. No reusable method, provider configuration or execution/document snapshot is returned."
          }
        },
        "description": "Stored subscription business projection, shared by list and detail. It does not compute a schedule, collected total, execution permission or settlement status."
      },
      "Pagination": {
        "type": "object",
        "properties": {
          "nextCursor": {
            "type": "string",
            "nullable": true
          },
          "hasMore": {
            "type": "boolean"
          },
          "count": {
            "type": "integer"
          }
        }
      },
      "AbonnementPaymentPage": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data",
          "meta"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AbonnementPayment"
            }
          },
          "meta": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "nextCursor",
              "hasMore",
              "count"
            ],
            "properties": {
              "nextCursor": {
                "type": "string",
                "nullable": true,
                "maxLength": 4096
              },
              "hasMore": {
                "type": "boolean"
              },
              "count": {
                "type": "integer",
                "minimum": 0,
                "maximum": 200
              }
            }
          }
        }
      },
      "AbonnementPayment": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "subscriptionId",
          "amount",
          "devise",
          "assoc",
          "state",
          "datetime",
          "type",
          "typeId",
          "parentTypeId",
          "method",
          "platform",
          "source",
          "imported",
          "finalized",
          "subscriptionOccurrence",
          "subscriptionPlannedDate"
        ],
        "properties": {
          "id": {
            "type": "string",
            "nullable": true,
            "description": "Persisted payment identifier. null if a malformed historical identity cannot be represented."
          },
          "subscriptionId": {
            "type": "string",
            "nullable": true,
            "description": "Subscription identifier from the persisted payment.abo relation."
          },
          "amount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991,
            "nullable": true,
            "description": "Actual recorded amount in minor currency units: 5000 = 50.00 EUR. Zero is possible for technical ABO_PAUSE records. null means missing or invalid; it never means zero."
          },
          "devise": {
            "type": "string",
            "nullable": true,
            "pattern": "^[a-z]{3}$",
            "description": "Recorded currency, lowercased. null means missing or invalid; no currency is inferred from the current subscription."
          },
          "assoc": {
            "type": "string",
            "nullable": true,
            "description": "Recorded beneficiary association. MAIN is the main association; null means missing, with no inferred replacement."
          },
          "state": {
            "type": "string",
            "nullable": true,
            "description": "Exact recorded payment-state code. COMPLETED is a recorded completed result whose financial meaning depends on the producer and provider; this read does not verify a capture or bank settlement. INIT is an unfinished preparation, PRELEVEMENT-SUBMITED a submitted bank order, ABO_PAUSE a technical pause trace. Missing or malformed state is null and is not counted as a success. Unknown well-formed state codes are preserved. A reference or elapsed time never implies completion or expiration.",
            "pattern": "^[A-Z][A-Z0-9_-]{0,63}$",
            "maxLength": 64
          },
          "datetime": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Recorded payment datetime, normalized to ISO with years 0000 to 9999. This is set before checkout in online preparation, or supplied as the business date in manual/import flows; it is not a guaranteed settlement timestamp. Accepts valid stored dates, integer epoch milliseconds, strict ISO datetimes with timezone or YYYY-MM-DD at midnight UTC. Impossible civil dates and ambiguous strings are null without rollover and sort last."
          },
          "type": {
            "type": "string",
            "nullable": true,
            "description": "Recorded business allocation type."
          },
          "typeId": {
            "type": "string",
            "nullable": true,
            "description": "Recorded business target. FORM references a form submission, not the parent form."
          },
          "parentTypeId": {
            "type": "string",
            "nullable": true,
            "description": "Recorded parent form identifier when available; no missing relation is guessed."
          },
          "method": {
            "type": "string",
            "nullable": true,
            "description": "Recorded instrument. No instrument is inferred from the platform."
          },
          "platform": {
            "type": "string",
            "nullable": true,
            "description": "Recorded payment provider, when this flow has one. No provider calls are made."
          },
          "source": {
            "type": "string",
            "nullable": true,
            "description": "Recorded creation channel."
          },
          "imported": {
            "type": "boolean",
            "nullable": true,
            "description": "true denotes imported historical collection. false is explicit; null means the marker is absent. Imported completed records are included unless another filter excludes them."
          },
          "finalized": {
            "type": "boolean",
            "nullable": true,
            "description": "Information-completion marker when present. It is independent of whether funds were collected and whether a receipt was issued. null means absent."
          },
          "subscriptionOccurrence": {
            "type": "string",
            "nullable": true,
            "description": "Recorded logical occurrence identity for engines which persist it. Several attempts may belong to one occurrence. Missing legacy or managed values remain null."
          },
          "subscriptionPlannedDate": {
            "type": "string",
            "format": "date",
            "nullable": true,
            "description": "Civil planned date YYYY-MM-DD frozen by the local execution engine when available. It does not specify an instant or timezone. Managed and SEPA XML producers do not necessarily use this field."
          }
        }
      },
      "SubscriptionScheduleResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/SubscriptionSchedule"
          }
        }
      },
      "SubscriptionSchedule": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "asOf",
          "mode",
          "calendarStatus",
          "nominalAmount",
          "devise",
          "state",
          "active",
          "revision",
          "rules",
          "today",
          "occurrences",
          "deferred",
          "next",
          "due",
          "blocked",
          "blocks",
          "canExecute",
          "awaitingActivation",
          "complete",
          "truncated",
          "plannedAmount",
          "remainingAmount",
          "remainingCount",
          "facts",
          "allocationBudgets",
          "nextAllocations",
          "preparation"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "asOf": {
            "type": "string",
            "format": "date-time"
          },
          "mode": {
            "type": "string",
            "enum": [
              "local",
              "managed",
              "sepa_xml"
            ]
          },
          "calendarStatus": {
            "type": "string",
            "enum": [
              "PROJECTED",
              "REMOTE_SCHEDULE_UNAVAILABLE"
            ]
          },
          "nominalAmount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991,
            "nullable": true,
            "description": "Stored payload.amount in minor units; 5000 = 50.00 EUR. Managed malformed or missing values remain null."
          },
          "devise": {
            "type": "string",
            "nullable": true,
            "description": "Stored contract currency in lowercase; unknown managed currency remains null.",
            "pattern": "^[a-z]{3}$"
          },
          "state": {
            "type": "string",
            "nullable": true,
            "description": "Exact persisted lifecycle state; ACTIVE with active false can await activation."
          },
          "active": {
            "type": "boolean",
            "nullable": true
          },
          "revision": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991,
            "nullable": true
          },
          "rules": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "amount",
              "day",
              "anchor",
              "timezone",
              "mode",
              "count",
              "maximum",
              "firstSequence"
            ],
            "properties": {
              "amount": {
                "type": "integer",
                "minimum": 1
              },
              "day": {
                "type": "integer",
                "minimum": 1,
                "maximum": 31
              },
              "anchor": {
                "type": "string",
                "format": "date"
              },
              "timezone": {
                "type": "string"
              },
              "mode": {
                "type": "string",
                "enum": [
                  "count",
                  "maximum",
                  "unlimited",
                  "legacy"
                ]
              },
              "count": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991,
                "nullable": true
              },
              "maximum": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991,
                "nullable": true
              },
              "firstSequence": {
                "type": "integer",
                "minimum": 1
              }
            },
            "nullable": true
          },
          "today": {
            "type": "string",
            "nullable": true,
            "format": "date"
          },
          "occurrences": {
            "type": "array",
            "maxItems": 240,
            "items": {
              "$ref": "#/components/schemas/SubscriptionScheduleOccurrence"
            }
          },
          "deferred": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SubscriptionScheduleOccurrence"
            }
          },
          "next": {
            "$ref": "#/components/schemas/SubscriptionScheduleNullableOccurrence"
          },
          "due": {
            "type": "boolean",
            "nullable": true
          },
          "blocked": {
            "type": "boolean",
            "nullable": true
          },
          "blocks": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "canExecute": {
            "type": "boolean",
            "nullable": true
          },
          "awaitingActivation": {
            "type": "boolean",
            "nullable": true
          },
          "complete": {
            "type": "boolean",
            "nullable": true
          },
          "truncated": {
            "type": "boolean",
            "nullable": true
          },
          "plannedAmount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991,
            "nullable": true,
            "description": "Full remaining contractual amount after recorded completed/committed attempts and owner exceptions, independent of horizon. null for an unbounded or unavailable schedule."
          },
          "remainingAmount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991,
            "nullable": true,
            "description": "Unused maximum after recorded completed and committed amounts. null when no ceiling is declared or the remote schedule is unavailable."
          },
          "remainingCount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991,
            "nullable": true,
            "description": "Full remaining occurrence count under count/maximum/legacy rules, independent of horizon. null for an unbounded or unavailable schedule."
          },
          "facts": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "paidCount",
              "committedCount",
              "paidAmount",
              "committedAmount",
              "uncertainCount"
            ],
            "properties": {
              "paidCount": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991,
                "nullable": true
              },
              "committedCount": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991,
                "nullable": true
              },
              "paidAmount": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991,
                "nullable": true
              },
              "committedAmount": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991,
                "nullable": true
              },
              "uncertainCount": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991,
                "nullable": true
              }
            },
            "nullable": true
          },
          "allocationBudgets": {
            "type": "object",
            "nullable": true,
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "description": "Owner pledge budgets in minor units, or null when unavailable. A per-payment direct pledge budget applies to the next payment, not the entire contract."
          },
          "nextAllocations": {
            "type": "object",
            "nullable": true,
            "additionalProperties": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "description": "Owner split for the next effective occurrence in minor units; null if no next occurrence or allocation review is required. Empty map is valid outside pledge allocation."
          },
          "preparation": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "allowed",
              "reason",
              "availableFrom",
              "latestDay"
            ],
            "properties": {
              "allowed": {
                "type": "boolean"
              },
              "reason": {
                "type": "string",
                "nullable": true,
                "enum": [
                  "SEPA_NOT_DUE",
                  "SEPA_CATCHUP_REVIEW_REQUIRED",
                  null
                ]
              },
              "availableFrom": {
                "type": "string",
                "format": "date"
              },
              "latestDay": {
                "type": "string",
                "format": "date"
              }
            },
            "nullable": true
          }
        }
      },
      "SubscriptionScheduleOccurrence": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "sequence",
          "originalDate",
          "date",
          "amount",
          "state",
          "notBefore"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "sequence": {
            "type": "integer",
            "minimum": 1
          },
          "originalDate": {
            "type": "string",
            "format": "date"
          },
          "date": {
            "type": "string",
            "nullable": true,
            "format": "date"
          },
          "amount": {
            "type": "integer",
            "minimum": 1,
            "maximum": 9007199254740991
          },
          "state": {
            "type": "string",
            "enum": [
              "PLANNED",
              "POSTPONED",
              "DEFERRED"
            ]
          },
          "notBefore": {
            "type": "string",
            "nullable": true,
            "format": "date-time"
          }
        }
      },
      "SubscriptionScheduleNullableOccurrence": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "sequence",
          "originalDate",
          "date",
          "amount",
          "state",
          "notBefore"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "sequence": {
            "type": "integer",
            "minimum": 1
          },
          "originalDate": {
            "type": "string",
            "format": "date"
          },
          "date": {
            "type": "string",
            "nullable": true,
            "format": "date"
          },
          "amount": {
            "type": "integer",
            "minimum": 1,
            "maximum": 9007199254740991
          },
          "state": {
            "type": "string",
            "enum": [
              "PLANNED",
              "POSTPONED",
              "DEFERRED"
            ]
          },
          "notBefore": {
            "type": "string",
            "nullable": true,
            "format": "date-time"
          }
        },
        "nullable": true
      },
      "SubscriptionIncidentResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/SubscriptionIncident"
          }
        }
      },
      "SubscriptionIncident": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "subscriptionId",
          "state",
          "active",
          "mode",
          "intervention",
          "latestFailedPayment",
          "regularization"
        ],
        "properties": {
          "subscriptionId": {
            "type": "string",
            "format": "uuid"
          },
          "state": {
            "type": "string",
            "nullable": true,
            "enum": [
              "ACTIVE",
              "MANUAL",
              "CARD_EXPIRED",
              "PAUSE",
              "FINISHED",
              "CANCELED",
              "CANCELLED",
              null
            ],
            "description": "Recorded lifecycle state. Missing, invalid or unsupported historical states remain null."
          },
          "active": {
            "type": "boolean",
            "nullable": true,
            "description": "Recorded active flag; null when absent or malformed. It is not permission to charge."
          },
          "mode": {
            "type": "string",
            "enum": [
              "local",
              "managed",
              "sepa_xml"
            ],
            "description": "Execution owner: local calendar, external provider, or SEPA XML."
          },
          "intervention": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "required",
              "reason",
              "recordedAt"
            ],
            "properties": {
              "required": {
                "type": "boolean",
                "nullable": true,
                "description": "Stored MANUAL/CARD_EXPIRED or payment-method-pending marker; null for an unknown state. False does not prove absence of a payment failure."
              },
              "reason": {
                "type": "string",
                "nullable": true,
                "enum": [
                  "CARD_EXPIRED",
                  "PAYMENT_METHOD_CHANGE_PENDING",
                  "MANUAL_INTERVENTION",
                  "MANUAL_REVIEW_REQUIRED",
                  "GOCARDLESS_DEBIT_DISPUTED",
                  "GOCARDLESS_MANDATE_UNUSABLE",
                  "SEPA_XML_DEBIT_DISPUTED",
                  "SEPA_XML_MANDATE_UNUSABLE",
                  "SEPA_XML_REVIEW_REQUIRED",
                  null
                ],
                "description": "Allowlisted blocking reason. Unknown private manual reasons become MANUAL_REVIEW_REQUIRED; free-text errors are never returned."
              },
              "recordedAt": {
                "type": "string",
                "format": "date-time",
                "nullable": true,
                "description": "Stored manualDate as an ISO instant, when applicable. Null means absent or invalid; never inferred from age."
              }
            }
          },
          "latestFailedPayment": {
            "type": "object",
            "nullable": true,
            "additionalProperties": false,
            "required": [
              "id",
              "state",
              "recordedAt",
              "incidentAt"
            ],
            "description": "Latest authorised stored failed attempt, including historical incidents subsequently followed by success. This is not necessarily the current blocking incident or a distinct occurrence.",
            "properties": {
              "id": {
                "type": "string",
                "format": "uuid",
                "nullable": true
              },
              "state": {
                "type": "string",
                "enum": [
                  "FAILED",
                  "ERROR",
                  "REQUIRES_PAYMENT_METHOD",
                  "CANCELED"
                ]
              },
              "recordedAt": {
                "type": "string",
                "format": "date-time",
                "nullable": true
              },
              "incidentAt": {
                "type": "string",
                "format": "date-time",
                "nullable": true,
                "description": "GoCardless failureAt/lateFailureAt when present, otherwise payment datetime. Other providers use datetime. Invalid or missing values stay null."
              }
            }
          },
          "regularization": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "availability",
              "link"
            ],
            "properties": {
              "availability": {
                "type": "string",
                "enum": [
                  "AVAILABLE",
                  "NO_RECORDED_INTERVENTION",
                  "INACTIVE",
                  "MANAGED_OWNER",
                  "SEPA_XML_OWNER",
                  "PAYMENT_METHOD_CHANGE_PENDING",
                  "MANUAL_REVIEW_REQUIRED",
                  "READ_OWNER_REQUIRED",
                  "INVALID_RECORDED_LINK",
                  "EXPIRED_RECORDED_LINK",
                  "CURRENT_PAYER_UNVERIFIED",
                  "HISTORY_UNVERIFIED"
                ],
                "description": "AVAILABLE means a qualifying stored Stripe Connect checkout passed the local proof checks. Other codes explain why link is null; they never authorize creating or retrying a payment."
              },
              "link": {
                "type": "object",
                "nullable": true,
                "additionalProperties": false,
                "required": [
                  "url",
                  "expiresAt",
                  "paymentId",
                  "purpose"
                ],
                "properties": {
                  "url": {
                    "type": "string",
                    "format": "uri",
                    "description": "Already-persisted HTTPS Stripe Checkout URL for this payer. Treat as a confidential payer capability; opening it lets the payer settle and renew their card."
                  },
                  "expiresAt": {
                    "type": "string",
                    "format": "date-time",
                    "description": "Explicit Session expiry persisted by the Stripe producer, not a locally inferred duration. No live provider availability check is made."
                  },
                  "paymentId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "purpose": {
                    "type": "string",
                    "enum": [
                      "SETTLE_AND_RENEW_CARD"
                    ]
                  }
                }
              }
            }
          }
        }
      },
      "UnisoftRequest_3e9bbc56cab142f79ac7": {
        "type": "object",
        "minProperties": 1,
        "properties": {
          "amount": {
            "type": "integer",
            "minimum": 1,
            "maximum": 100000000,
            "description": "Nominal monthly amount in minor units; 5000 is EUR 50. Existing launched attempts retain their amount."
          },
          "day": {
            "type": "integer",
            "minimum": 1,
            "maximum": 31,
            "description": "Monthly collection day in the native contract timezone. Short months use the native calendar rule."
          },
          "nextDate": {
            "type": "string",
            "format": "date",
            "description": "Civil YYYY-MM-DD, today or later in the contract timezone. Reanchors only the first unlaunched occurrence. It must agree with day if both are supplied."
          },
          "mode": {
            "type": "string",
            "enum": [
              "unlimited",
              "count",
              "maximum",
              "legacy"
            ],
            "description": "Native limit mode. unlimited has no count or amount ceiling; count limits total occurrences; maximum limits total minor units; legacy combines both limits. This never changes the monthly frequency."
          },
          "count": {
            "type": "integer",
            "minimum": 1,
            "maximum": 1200,
            "nullable": true,
            "description": "Total contractual occurrence count, including completed and committed occurrences; not the remaining count or a number of months to add. null means no count limit and must match mode."
          },
          "maximum": {
            "type": "integer",
            "minimum": 1,
            "maximum": 9007199254740991,
            "nullable": true,
            "description": "Total contractual ceiling in minor units, including completed and committed amounts; not a fresh remaining budget. null means no ceiling and must match mode."
          }
        },
        "additionalProperties": false
      },
      "SubscriptionRevisionPreviewResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/SubscriptionRevisionPreview"
          }
        }
      },
      "SubscriptionRevisionPreview": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "asOf",
          "previewToken",
          "revision",
          "currency",
          "beforeRules",
          "afterRules",
          "before",
          "after",
          "changedFields",
          "preservedExceptionCount"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "asOf": {
            "type": "string",
            "format": "date-time"
          },
          "previewToken": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "revision": {
            "type": "integer",
            "minimum": 0
          },
          "currency": {
            "type": "string",
            "pattern": "^[a-z]{3}$"
          },
          "beforeRules": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "amount",
              "day",
              "anchor",
              "timezone",
              "mode",
              "count",
              "maximum",
              "firstSequence"
            ],
            "properties": {
              "amount": {
                "type": "integer",
                "minimum": 1
              },
              "day": {
                "type": "integer",
                "minimum": 1,
                "maximum": 31
              },
              "anchor": {
                "type": "string",
                "format": "date"
              },
              "timezone": {
                "type": "string"
              },
              "mode": {
                "type": "string",
                "enum": [
                  "unlimited",
                  "count",
                  "maximum",
                  "legacy"
                ]
              },
              "count": {
                "type": "integer",
                "nullable": true
              },
              "maximum": {
                "type": "integer",
                "nullable": true
              },
              "firstSequence": {
                "type": "integer",
                "minimum": 1
              }
            }
          },
          "afterRules": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "amount",
              "day",
              "anchor",
              "timezone",
              "mode",
              "count",
              "maximum",
              "firstSequence"
            ],
            "properties": {
              "amount": {
                "type": "integer",
                "minimum": 1
              },
              "day": {
                "type": "integer",
                "minimum": 1,
                "maximum": 31
              },
              "anchor": {
                "type": "string",
                "format": "date"
              },
              "timezone": {
                "type": "string"
              },
              "mode": {
                "type": "string",
                "enum": [
                  "unlimited",
                  "count",
                  "maximum",
                  "legacy"
                ]
              },
              "count": {
                "type": "integer",
                "nullable": true
              },
              "maximum": {
                "type": "integer",
                "nullable": true
              },
              "firstSequence": {
                "type": "integer",
                "minimum": 1
              }
            }
          },
          "before": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "remainingCount",
              "remainingAmount",
              "plannedAmount",
              "complete",
              "blocks"
            ],
            "properties": {
              "remainingCount": {
                "type": "integer",
                "minimum": 0,
                "nullable": true
              },
              "remainingAmount": {
                "type": "integer",
                "minimum": 0,
                "nullable": true
              },
              "plannedAmount": {
                "type": "integer",
                "minimum": 0,
                "nullable": true
              },
              "complete": {
                "type": "boolean"
              },
              "blocks": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          },
          "after": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "remainingCount",
              "remainingAmount",
              "plannedAmount",
              "complete",
              "blocks"
            ],
            "properties": {
              "remainingCount": {
                "type": "integer",
                "minimum": 0,
                "nullable": true
              },
              "remainingAmount": {
                "type": "integer",
                "minimum": 0,
                "nullable": true
              },
              "plannedAmount": {
                "type": "integer",
                "minimum": 0,
                "nullable": true
              },
              "complete": {
                "type": "boolean"
              },
              "blocks": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          },
          "changedFields": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "preservedExceptionCount": {
            "type": "integer",
            "minimum": 0
          }
        }
      },
      "SubscriptionRevisionCommandResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/SubscriptionRevisionCommand"
          }
        }
      },
      "SubscriptionRevisionCommand": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "subscriptionId",
          "state",
          "appliedRevision",
          "createdAt",
          "updatedAt"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "subscriptionId": {
            "type": "string",
            "format": "uuid"
          },
          "state": {
            "type": "string",
            "enum": [
              "RUNNING",
              "APPLIED",
              "UNCERTAIN"
            ]
          },
          "appliedRevision": {
            "type": "integer",
            "minimum": 0,
            "nullable": true
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "SubscriptionPaymentChangePreviewResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/SubscriptionPaymentChangePreview"
          }
        }
      },
      "SubscriptionPaymentChangePreview": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "platform",
          "flow",
          "expectedRevision",
          "previewToken",
          "currency",
          "timezone",
          "occurrence",
          "requiresPayerAuthorization"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "platform": {
            "type": "string",
            "enum": [
              "STRIPE",
              "STRIPE.SEPA"
            ]
          },
          "flow": {
            "type": "string",
            "enum": [
              "SETUP",
              "ADVANCE"
            ]
          },
          "expectedRevision": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "previewToken": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "currency": {
            "type": "string"
          },
          "timezone": {
            "type": "string"
          },
          "occurrence": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "date",
              "amount"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "format": "date"
              },
              "amount": {
                "type": "integer",
                "minimum": 1
              }
            },
            "nullable": true
          },
          "requiresPayerAuthorization": {
            "type": "boolean",
            "enum": [
              true
            ]
          }
        }
      },
      "UnisoftRequest_e4c2e3a5eb7c3cc511e2": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "platform": {
                "type": "string",
                "enum": [
                  "STRIPE.SEPA"
                ]
              },
              "idempotencyKey": {
                "type": "string",
                "format": "uuid"
              },
              "expectedRevision": {
                "type": "string",
                "pattern": "^[a-f0-9]{64}$"
              },
              "previewToken": {
                "type": "string",
                "pattern": "^[a-f0-9]{64}$"
              },
              "acknowledgeFutureCollections": {
                "type": "boolean",
                "enum": [
                  true
                ]
              }
            },
            "required": [
              "platform",
              "idempotencyKey",
              "expectedRevision",
              "previewToken",
              "acknowledgeFutureCollections"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "platform": {
                "type": "string",
                "enum": [
                  "STRIPE"
                ]
              },
              "idempotencyKey": {
                "type": "string",
                "format": "uuid"
              },
              "expectedRevision": {
                "type": "string",
                "pattern": "^[a-f0-9]{64}$"
              },
              "previewToken": {
                "type": "string",
                "pattern": "^[a-f0-9]{64}$"
              },
              "acknowledgeFutureCollections": {
                "type": "boolean",
                "enum": [
                  true
                ]
              },
              "acknowledgeAdvancePayment": {
                "type": "boolean",
                "enum": [
                  true
                ]
              }
            },
            "required": [
              "platform",
              "idempotencyKey",
              "expectedRevision",
              "previewToken",
              "acknowledgeFutureCollections",
              "acknowledgeAdvancePayment"
            ],
            "additionalProperties": false
          }
        ]
      },
      "SubscriptionPaymentChangePreparationResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/SubscriptionPaymentChangePreparation"
          }
        }
      },
      "SubscriptionPaymentChangePreparation": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "subscriptionId",
          "state",
          "platform",
          "flow",
          "requiresPayerAuthorization",
          "createdAt",
          "updatedAt"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "subscriptionId": {
            "type": "string",
            "format": "uuid"
          },
          "state": {
            "type": "string",
            "enum": [
              "RUNNING",
              "PREPARED",
              "UNCERTAIN"
            ]
          },
          "platform": {
            "type": "string",
            "enum": [
              "STRIPE",
              "STRIPE.SEPA"
            ]
          },
          "flow": {
            "type": "string",
            "enum": [
              "SETUP",
              "ADVANCE"
            ]
          },
          "requiresPayerAuthorization": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          },
          "nativeState": {
            "type": "string",
            "nullable": true
          },
          "activated": {
            "type": "boolean",
            "nullable": true
          },
          "authorizationExpiresAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "authorizationUrl": {
            "type": "string",
            "format": "uri"
          }
        }
      },
      "SubscriptionPaymentChangeCommandResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/SubscriptionPaymentChangeCommand"
          }
        }
      },
      "SubscriptionPaymentChangeCommand": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "subscriptionId",
          "state",
          "platform",
          "flow",
          "requiresPayerAuthorization",
          "createdAt",
          "updatedAt"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "subscriptionId": {
            "type": "string",
            "format": "uuid"
          },
          "state": {
            "type": "string",
            "enum": [
              "RUNNING",
              "PREPARED",
              "UNCERTAIN"
            ]
          },
          "platform": {
            "type": "string",
            "enum": [
              "STRIPE",
              "STRIPE.SEPA"
            ]
          },
          "flow": {
            "type": "string",
            "enum": [
              "SETUP",
              "ADVANCE"
            ]
          },
          "requiresPayerAuthorization": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          },
          "nativeState": {
            "type": "string",
            "nullable": true
          },
          "activated": {
            "type": "boolean",
            "nullable": true
          },
          "authorizationExpiresAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          }
        }
      },
      "UnisoftRequest_2401b237a86dca02fa7c": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^[a-fA-F0-9-]{36}:monthly:[1-9][0-9]{0,8}$",
                "description": "Stable occurrence id returned by the native subscription schedule; distinct from a payment attempt id."
              },
              "action": {
                "type": "string",
                "enum": [
                  "date"
                ]
              },
              "value": {
                "type": "string",
                "format": "date",
                "description": "New civil YYYY-MM-DD strictly after today in the contract timezone. Explicit dates bypass the inherited 25-day spacing guard."
              }
            },
            "required": [
              "id",
              "action",
              "value"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^[a-fA-F0-9-]{36}:monthly:[1-9][0-9]{0,8}$",
                "description": "Stable occurrence id returned by the native subscription schedule; distinct from a payment attempt id."
              },
              "action": {
                "type": "string",
                "enum": [
                  "skip"
                ]
              }
            },
            "required": [
              "id",
              "action"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^[a-fA-F0-9-]{36}:monthly:[1-9][0-9]{0,8}$",
                "description": "Stable occurrence id returned by the native subscription schedule; distinct from a payment attempt id."
              },
              "action": {
                "type": "string",
                "enum": [
                  "reset"
                ]
              },
              "field": {
                "type": "string",
                "enum": [
                  "date"
                ]
              }
            },
            "required": [
              "id",
              "action",
              "field"
            ],
            "additionalProperties": false
          }
        ]
      },
      "SubscriptionOccurrencePreviewResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/SubscriptionOccurrencePreview"
          }
        }
      },
      "SubscriptionOccurrencePreview": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "asOf",
          "previewToken",
          "revision",
          "currency",
          "timezone",
          "before",
          "after",
          "next",
          "remainingCount",
          "remainingAmount"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "asOf": {
            "type": "string",
            "format": "date-time"
          },
          "previewToken": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "revision": {
            "type": "integer",
            "minimum": 0
          },
          "currency": {
            "type": "string",
            "pattern": "^[a-z]{3}$"
          },
          "timezone": {
            "type": "string"
          },
          "before": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "sequence",
              "originalDate",
              "date",
              "amount",
              "state"
            ],
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^[a-fA-F0-9-]{36}:monthly:[1-9][0-9]{0,8}$",
                "description": "Stable occurrence id returned by the native subscription schedule; distinct from a payment attempt id."
              },
              "sequence": {
                "type": "integer",
                "minimum": 1
              },
              "originalDate": {
                "type": "string",
                "format": "date"
              },
              "date": {
                "type": "string",
                "format": "date",
                "nullable": true
              },
              "amount": {
                "type": "integer",
                "minimum": 1
              },
              "state": {
                "type": "string",
                "enum": [
                  "PLANNED",
                  "POSTPONED",
                  "DEFERRED"
                ]
              }
            }
          },
          "after": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "sequence",
              "originalDate",
              "date",
              "amount",
              "state"
            ],
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^[a-fA-F0-9-]{36}:monthly:[1-9][0-9]{0,8}$",
                "description": "Stable occurrence id returned by the native subscription schedule; distinct from a payment attempt id."
              },
              "sequence": {
                "type": "integer",
                "minimum": 1
              },
              "originalDate": {
                "type": "string",
                "format": "date"
              },
              "date": {
                "type": "string",
                "format": "date",
                "nullable": true
              },
              "amount": {
                "type": "integer",
                "minimum": 1
              },
              "state": {
                "type": "string",
                "enum": [
                  "PLANNED",
                  "POSTPONED",
                  "DEFERRED"
                ]
              }
            }
          },
          "next": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "sequence",
              "originalDate",
              "date",
              "amount",
              "state"
            ],
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^[a-fA-F0-9-]{36}:monthly:[1-9][0-9]{0,8}$",
                "description": "Stable occurrence id returned by the native subscription schedule; distinct from a payment attempt id."
              },
              "sequence": {
                "type": "integer",
                "minimum": 1
              },
              "originalDate": {
                "type": "string",
                "format": "date"
              },
              "date": {
                "type": "string",
                "format": "date",
                "nullable": true
              },
              "amount": {
                "type": "integer",
                "minimum": 1
              },
              "state": {
                "type": "string",
                "enum": [
                  "PLANNED",
                  "POSTPONED",
                  "DEFERRED"
                ]
              }
            },
            "nullable": true
          },
          "remainingCount": {
            "type": "integer",
            "minimum": 0,
            "nullable": true
          },
          "remainingAmount": {
            "type": "integer",
            "minimum": 0,
            "nullable": true
          }
        }
      },
      "SubscriptionOccurrenceCommandResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/SubscriptionOccurrenceCommand"
          }
        }
      },
      "SubscriptionOccurrenceCommand": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "subscriptionId",
          "state",
          "appliedRevision",
          "createdAt",
          "updatedAt"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "subscriptionId": {
            "type": "string",
            "format": "uuid"
          },
          "state": {
            "type": "string",
            "enum": [
              "RUNNING",
              "APPLIED",
              "UNCERTAIN"
            ]
          },
          "appliedRevision": {
            "type": "integer",
            "minimum": 0,
            "nullable": true
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "SubscriptionLifecycleResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/SubscriptionLifecycle"
          }
        }
      },
      "SubscriptionLifecycle": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "state",
          "active",
          "expectedRevision",
          "asOf",
          "canPause",
          "pauseReason",
          "canResume",
          "resumeReason",
          "canCancel",
          "cancelReason"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "state": {
            "type": "string"
          },
          "active": {
            "type": "boolean"
          },
          "expectedRevision": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "asOf": {
            "type": "string",
            "format": "date-time"
          },
          "canPause": {
            "type": "boolean"
          },
          "pauseReason": {
            "type": "string",
            "nullable": true
          },
          "canResume": {
            "type": "boolean"
          },
          "resumeReason": {
            "type": "string",
            "nullable": true
          },
          "canCancel": {
            "type": "boolean"
          },
          "cancelReason": {
            "type": "string",
            "nullable": true
          }
        }
      },
      "SubscriptionLifecycleCommandResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/SubscriptionLifecycleCommand"
          }
        }
      },
      "SubscriptionLifecycleCommand": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "subscriptionId",
          "action",
          "state",
          "appliedState",
          "appliedAt",
          "createdAt",
          "updatedAt"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "subscriptionId": {
            "type": "string",
            "format": "uuid"
          },
          "action": {
            "type": "string",
            "enum": [
              "PAUSE",
              "RESUME",
              "CANCEL"
            ]
          },
          "state": {
            "type": "string",
            "enum": [
              "RUNNING",
              "APPLIED",
              "UNCERTAIN"
            ]
          },
          "appliedState": {
            "type": "string",
            "enum": [
              "PAUSE",
              "ACTIVE",
              "FINISHED",
              null
            ],
            "nullable": true
          },
          "appliedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "SubscriptionReminderPreview": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "subscriptionId": {
            "type": "string",
            "format": "uuid"
          },
          "availability": {
            "type": "string",
            "enum": [
              "READY",
              "PENDING_ACTIVATION_OWNER_REQUIRED",
              "NOT_INTERRUPTED",
              "MANAGED_OWNER",
              "SEPA_XML_OWNER",
              "PAYMENT_IN_PROGRESS",
              "SUBSCRIPTION_LIMIT_REACHED",
              "REMINDER_RECENT",
              "LIFECYCLE_RECONCILIATION_REQUIRED",
              "NATIVE_MANUAL_OWNER_UNAVAILABLE",
              "NO_EMAIL_CHANNEL",
              "INACTIVE",
              "PAYMENT_METHOD_CHANGE_PENDING",
              "MANUAL_REVIEW_REQUIRED",
              "READ_OWNER_REQUIRED",
              "NO_RECORDED_INTERVENTION",
              "INVALID_RECORDED_LINK",
              "EXPIRED_RECORDED_LINK",
              "CURRENT_PAYER_UNVERIFIED",
              "HISTORY_UNVERIFIED"
            ]
          },
          "state": {
            "type": "string",
            "pattern": "^[A-Z][A-Z0-9_-]{0,63}$"
          },
          "active": {
            "type": "boolean"
          },
          "nominalAmountMinor": {
            "type": "integer",
            "minimum": 1,
            "maximum": 9007199254740991,
            "nullable": true
          },
          "settlementAmountMinor": {
            "type": "integer",
            "minimum": 1,
            "maximum": 9007199254740991,
            "nullable": true
          },
          "currency": {
            "type": "string",
            "pattern": "^[a-z]{3}$",
            "nullable": true
          },
          "assoc": {
            "type": "string",
            "nullable": true
          },
          "platform": {
            "type": "string",
            "nullable": true
          },
          "method": {
            "type": "string",
            "nullable": true
          },
          "recipientEmail": {
            "type": "string",
            "nullable": true
          },
          "linkKind": {
            "type": "string",
            "nullable": true,
            "enum": [
              "EXISTING_CHECKOUT",
              "NATIVE_MANUAL_ENTRY",
              null
            ],
            "description": "EXISTING_CHECKOUT is an admitted recorded Session; NATIVE_MANUAL_ENTRY is the canonical payer entry whose owner may prepare a settlement or method renewal when the payer follows it. Null means unavailable. Neither creates anything during preview or send."
          },
          "recipientSource": {
            "type": "string",
            "enum": [
              "SUBSCRIPTION_PAYER_SNAPSHOT"
            ]
          },
          "subject": {
            "type": "string"
          },
          "message": {
            "type": "string",
            "nullable": true
          },
          "snapshot": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$",
            "nullable": true
          },
          "existingPaymentId": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "existingLinkExpiresAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "linkIsPreview": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "rest": {
            "$ref": "#/components/schemas/SubscriptionReminderRest"
          }
        },
        "required": [
          "subscriptionId",
          "availability",
          "state",
          "active",
          "nominalAmountMinor",
          "settlementAmountMinor",
          "currency",
          "assoc",
          "platform",
          "method",
          "recipientEmail",
          "linkKind",
          "recipientSource",
          "subject",
          "message",
          "snapshot",
          "existingPaymentId",
          "existingLinkExpiresAt",
          "linkIsPreview",
          "rest"
        ]
      },
      "SubscriptionReminderRest": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "blocked": {
            "type": "boolean"
          },
          "reason": {
            "type": "string",
            "nullable": true
          },
          "until": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "timeZone": {
            "type": "string",
            "enum": [
              "Europe/Paris"
            ]
          }
        },
        "required": [
          "blocked",
          "reason",
          "until",
          "timeZone"
        ]
      },
      "SubscriptionReminderCommand": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "requestId": {
            "type": "string",
            "format": "uuid"
          },
          "action": {
            "type": "string",
            "enum": [
              "SEND",
              "RULES"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "PENDING",
              "QUEUED",
              "UPDATED",
              "REFUSED",
              "UNCERTAIN"
            ]
          },
          "requestedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "completedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "targetIds": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string"
            }
          },
          "error": {
            "type": "string",
            "nullable": true
          },
          "outcomes": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "targetId": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "QUEUED",
                    "DUPLICATE",
                    "REFUSED",
                    "UNCERTAIN"
                  ]
                }
              },
              "required": [
                "targetId",
                "status"
              ]
            }
          },
          "retryable": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "deliveryRead": {
            "type": "string",
            "enum": [
              "AVAILABLE",
              "UNAVAILABLE"
            ]
          },
          "deliveries": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "targetId": {
                  "type": "string"
                },
                "sendId": {
                  "type": "string",
                  "format": "uuid"
                },
                "state": {
                  "type": "string",
                  "enum": [
                    "QUEUED_OR_IN_FLIGHT",
                    "SMTP_ACCEPTED",
                    "DELIVERED",
                    "FAILED",
                    "CANCELED",
                    "UNCERTAIN",
                    "UNKNOWN"
                  ]
                }
              },
              "required": [
                "targetId",
                "sendId",
                "state"
              ]
            }
          },
          "subscriptionId": {
            "type": "string",
            "format": "uuid"
          }
        },
        "required": [
          "requestId",
          "action",
          "status",
          "requestedAt",
          "completedAt",
          "targetIds",
          "error",
          "outcomes",
          "retryable",
          "deliveryRead",
          "deliveries",
          "subscriptionId"
        ]
      },
      "UnisoftRequest_7bdae3ccb939dc1b03a6": {
        "type": "object",
        "properties": {
          "idempotencyKey": {
            "type": "string",
            "format": "uuid",
            "description": "Caller-generated request UUID. Reuse it with the identical input after a timeout; changing the key may create another pending contract."
          },
          "montant": {
            "type": "number",
            "minimum": 0.01,
            "maximum": 1000000,
            "multipleOf": 0.01,
            "description": "Nominal monthly amount in major units, e.g. 50 for EUR 50. The exact minor-unit equivalent is used for the hosted first payment."
          },
          "devise": {
            "type": "string",
            "pattern": "^[a-z]{3}$",
            "description": "Recorded collection currency, lowercase. It must match the chosen association; there is no implicit conversion."
          },
          "assoc": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200,
            "pattern": "^[A-Za-z0-9_-]+$",
            "description": "Existing beneficiary association identifier from list_associations, including MAIN. No default association is inferred."
          },
          "cerfa": {
            "type": "boolean",
            "description": "Requested tax-receipt treatment for future payments. This does not issue a document. A conflicting association policy is refused."
          },
          "nbMonth": {
            "type": "integer",
            "minimum": 0,
            "maximum": 1200,
            "description": "Maximum number of monthly occurrences; 0 means no count limit. Supply it explicitly. This is neither a paid count nor a duration in days."
          },
          "maxAmount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991,
            "description": "Total contractual ceiling in minor units, unlike montant. 0 means no amount ceiling. A positive ceiling must cover the first nominal payment. Both limits can apply; both zero explicitly request an unbounded contract."
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200,
            "description": "Human-readable label carried by the native contract and its first Checkout. The owner may append occurrence details."
          },
          "info": {
            "type": "object",
            "properties": {
              "nom": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "prenom": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "email": {
                "type": "string",
                "maxLength": 320,
                "format": "email"
              },
              "tel": {
                "type": "string",
                "maxLength": 50
              }
            },
            "required": [
              "nom",
              "prenom",
              "email"
            ],
            "additionalProperties": false,
            "description": "Payer identity snapshot. The native owner can create or enrich a matching CRM contact. No contact id, reusable card, customer token or mandate is accepted."
          },
          "facturation": {
            "type": "object",
            "properties": {
              "perso": {
                "type": "boolean"
              },
              "nom": {
                "type": "string",
                "maxLength": 500
              },
              "prenom": {
                "type": "string",
                "maxLength": 500
              },
              "civilite": {
                "type": "string",
                "maxLength": 500
              },
              "raison": {
                "type": "string",
                "maxLength": 500
              },
              "siren": {
                "type": "string",
                "maxLength": 500
              },
              "adresse": {
                "type": "string",
                "maxLength": 500
              },
              "postal": {
                "type": "string",
                "maxLength": 500
              },
              "ville": {
                "type": "string",
                "maxLength": 500
              },
              "etat": {
                "type": "string",
                "maxLength": 500
              },
              "pays": {
                "type": "string",
                "maxLength": 500
              },
              "social_id": {
                "type": "string",
                "maxLength": 500
              },
              "giftAid": {
                "type": "boolean"
              }
            },
            "required": [
              "perso"
            ],
            "additionalProperties": false,
            "description": "Billing identity for subsequent documents. Text values are strings; no private payment-method field is admitted."
          }
        },
        "required": [
          "idempotencyKey",
          "name",
          "montant",
          "devise",
          "assoc",
          "cerfa",
          "nbMonth",
          "maxAmount",
          "info"
        ],
        "additionalProperties": false
      },
      "SubscriptionPreparationResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/SubscriptionPreparation"
          }
        }
      },
      "SubscriptionPreparation": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "state",
          "subscriptionId",
          "paymentId",
          "contract",
          "requiresPayerAuthorization",
          "createdAt",
          "updatedAt"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "state": {
            "type": "string",
            "enum": [
              "PREPARING",
              "PREPARED",
              "UNCERTAIN"
            ]
          },
          "subscriptionId": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "paymentId": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "contract": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "type",
              "amountMinor",
              "currency",
              "association",
              "receiptRequested",
              "maxOccurrences",
              "maxAmountMinor"
            ],
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "GENERAL"
                ]
              },
              "amountMinor": {
                "type": "integer",
                "minimum": 1
              },
              "currency": {
                "type": "string"
              },
              "association": {
                "type": "string"
              },
              "receiptRequested": {
                "type": "boolean"
              },
              "maxOccurrences": {
                "type": "integer",
                "minimum": 0
              },
              "maxAmountMinor": {
                "type": "integer",
                "minimum": 0
              }
            }
          },
          "requiresPayerAuthorization": {
            "type": "boolean",
            "enum": [
              true
            ],
            "description": "This flow requires payer authorisation. This is a flow requirement, not an observation of whether the payer has already completed it."
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          },
          "authorizationExpiresAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Recorded Checkout expiry, not proof of its current provider status. An expired or no-longer-pending preparation cannot yield its link again."
          },
          "authorizationUrl": {
            "type": "string",
            "format": "uri",
            "description": "Returned only by the dual-write-authorised POST, including identical replay. GET status never returns this capability URL."
          }
        }
      },
      "SubscriptionPreparationError": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string",
            "pattern": "^[A-Z][A-Z0-9_]+$"
          },
          "requestId": {
            "type": "string",
            "format": "uuid"
          },
          "required": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "details": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "code"
            ],
            "properties": {
              "code": {
                "type": "string"
              },
              "location": {
                "type": "string",
                "enum": [
                  "body",
                  "path",
                  "query"
                ]
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "API Key",
        "description": "Format: `ke_live_xxx`"
      },
      "apiKeyHeader": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key"
      }
    }
  }
}
```
