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

# SEPA subscriptions

OpenAPI 3.0.3 · API 2.0.0

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

## Operations

## GET /sepa/subscriptions/{id}/lifecycle

Read SEPA pause/resume availability and native schedule

`get_sepa_subscription_lifecycle`

Dedicated SEPA_XML subscription owner; generic subscription lifecycle/edition operations remain unavailable for this platform. Requires sepa:read, abonnements:read and paiements:read, all explicitly checked; campaign-restricted keys are refused. The server re-admits current organisation/association, SEPA entitlement, subscription, linked mandate and bounded same-scope payment history. amountMinor is in EUR MINOR units (5000 = EUR 50); do not confuse it with banking amountMajor. The native schedule supplies ordinal/date/exhaustion, without inventing missing money or today. Unknown dates/projection remain null/UNKNOWN. Mandate USABLE describes the native ACTIVE/36-month-use rule, not bank acceptance or proof of settlement. No bank data, IBAN, payer identity, reusable method, donor information, raw mandate/settings or private error is exposed. No provider call, daemon, occurrence launch, notification or GET initialisation/index creation occurs. Shared authentication may record key usage. Unknown arguments and non-empty GET bodies are rejected. canPause/canResume are observations, rechecked before delegation. Stopped, inactive, manual-review, mandate-unusable, method-pending and exhausted schedules are not silently resumed. This read never performs the native transition or prepares an occurrence.

### Authentication

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

### Required permissions

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

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "description": "Current Unisoft SEPA_XML subscription UUID; not a mandate, collection or payment ID.",
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Qualified native schedule or established native command outcome.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionLifecycleResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "Invalid UUID, command UUID, ordinal, date, version, unknown fields/query or non-empty GET body.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE, CAMPAIGN_RESTRICTED_KEY, API_ACTOR_UNAVAILABLE or disabled organisation.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND in the current organisation, association and SEPA_XML owner.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "SEPA_DISABLED, INVALID_SEPA_HISTORY, SEPA_HISTORY_LIMIT, SEPA_RELATED_OWNER_UNAVAILABLE, SEPA_SUBSCRIPTION_INACTIVE, SEPA_MANDATE_UNUSABLE, SEPA_SCHEDULE_CHANGED, SEPA_SCHEDULE_FINISHED, SEPA_RESCHEDULE_REQUIRED, PAYMENT_METHOD_PENDING, SUBSCRIPTION_BUSY, LIFECYCLE_RECONCILIATION_REQUIRED, COMMAND_ID_REUSED, SEPA_COMMAND_UNCERTAIN, INVALID_SEPA_COMMAND_HISTORY or an admitted native prerequisite. No automatic financial retry.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "INTERNAL_ERROR without private data. Preserve commandId after an uncertain write.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "SEPA_INDEXES_REQUIRED: existing native migration/index invariants are missing; no index is created by this request.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

### OpenAPI

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

## POST /sepa/subscriptions/{id}/pause

Pause a local SEPA_XML subscription through its native owner

`pause_sepa_subscription`

Dedicated SEPA_XML subscription owner; generic subscription lifecycle/edition operations remain unavailable for this platform. Requires sepa:read, abonnements:read and paiements:read, all explicitly checked; campaign-restricted keys are refused. The server re-admits current organisation/association, SEPA entitlement, subscription, linked mandate and bounded same-scope payment history. amountMinor is in EUR MINOR units (5000 = EUR 50); do not confuse it with banking amountMajor. The native schedule supplies ordinal/date/exhaustion, without inventing missing money or today. Unknown dates/projection remain null/UNKNOWN. Mandate USABLE describes the native ACTIVE/36-month-use rule, not bank acceptance or proof of settlement. No bank data, IBAN, payer identity, reusable method, donor information, raw mandate/settings or private error is exposed. No provider call, daemon, occurrence launch, notification or GET initialisation/index creation occurs. Shared authentication may record key usage. Unknown arguments and non-empty GET bodies are rejected. Additionally requires abonnements:write. Use a caller-generated commandId UUID and the revision from get_sepa_subscription_lifecycle. The adapter delegates to the actual native SEPA commandBus and schedule methods; actor APIKEY_<authenticated key id> is visible, source SYSTEM is only the native audit classification and grants no privilege. No ADMIN is fabricated. The shared lifecycle fence is durably claimed for each subscription before owner entry and removed only after positively acknowledged native completion and terminal journal publication; uncertainty retains it without TTL, stealing or GET cleanup. Native subscription locks retain their own authority. Established native unique indexes are inspected before a write; missing invariants return SEPA_INDEXES_REQUIRED, never an implicit migration. The command ID is namespaced by organisation/principal and forwarded as a stable native key. An identical replay recovers the native DONE receipt without executing the owner again; changed reuse is refused. Missing/failed/in-flight native proof stays SEPA_COMMAND_UNCERTAIN, never permission for a new ID, automatic retry or charge. Read get_sepa_subscription_command to resolve it. Claims require acknowledged:true and exact insertedId; native writes and terminal publication require positive driver acknowledgements, forced majority+j:true. Any lost/absent/false acknowledgement returns SEPA_COMMAND_UNCERTAIN; a later receipt read may resolve native DONE proof without any retry. Delegates pauseSchedule. Stops future subscription preparation authority only; it does not cancel, delete or reverse an already prepared/reserved/exported/submitted collection, bank file, transfer or debit. The subscription remains active with state PAUSE; a separate explicit resume is needed.

### Authentication

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

### Required permissions

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

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "description": "Current Unisoft SEPA_XML subscription UUID; not a mandate, collection or payment ID.",
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### Request body

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "expectedRevision": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          }
        },
        "required": [
          "commandId",
          "expectedRevision"
        ],
        "additionalProperties": false
      }
    }
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Qualified native schedule or established native command outcome.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "Invalid UUID, command UUID, ordinal, date, version, unknown fields/query or non-empty GET body.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE, CAMPAIGN_RESTRICTED_KEY, API_ACTOR_UNAVAILABLE or disabled organisation.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND in the current organisation, association and SEPA_XML owner.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "SEPA_DISABLED, INVALID_SEPA_HISTORY, SEPA_HISTORY_LIMIT, SEPA_RELATED_OWNER_UNAVAILABLE, SEPA_SUBSCRIPTION_INACTIVE, SEPA_MANDATE_UNUSABLE, SEPA_SCHEDULE_CHANGED, SEPA_SCHEDULE_FINISHED, SEPA_RESCHEDULE_REQUIRED, PAYMENT_METHOD_PENDING, SUBSCRIPTION_BUSY, LIFECYCLE_RECONCILIATION_REQUIRED, COMMAND_ID_REUSED, SEPA_COMMAND_UNCERTAIN, INVALID_SEPA_COMMAND_HISTORY or an admitted native prerequisite. No automatic financial retry.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "INTERNAL_ERROR without private data. Preserve commandId after an uncertain write.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "SEPA_INDEXES_REQUIRED: existing native migration/index invariants are missing; no index is created by this request.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

### OpenAPI

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

## POST /sepa/subscriptions/{id}/resume

Resume a paused SEPA_XML subscription with an explicit future date

`resume_sepa_subscription`

Dedicated SEPA_XML subscription owner; generic subscription lifecycle/edition operations remain unavailable for this platform. Requires sepa:read, abonnements:read and paiements:read, all explicitly checked; campaign-restricted keys are refused. The server re-admits current organisation/association, SEPA entitlement, subscription, linked mandate and bounded same-scope payment history. amountMinor is in EUR MINOR units (5000 = EUR 50); do not confuse it with banking amountMajor. The native schedule supplies ordinal/date/exhaustion, without inventing missing money or today. Unknown dates/projection remain null/UNKNOWN. Mandate USABLE describes the native ACTIVE/36-month-use rule, not bank acceptance or proof of settlement. No bank data, IBAN, payer identity, reusable method, donor information, raw mandate/settings or private error is exposed. No provider call, daemon, occurrence launch, notification or GET initialisation/index creation occurs. Shared authentication may record key usage. Unknown arguments and non-empty GET bodies are rejected. Additionally requires abonnements:write. Use a caller-generated commandId UUID and the revision from get_sepa_subscription_lifecycle. The adapter delegates to the actual native SEPA commandBus and schedule methods; actor APIKEY_<authenticated key id> is visible, source SYSTEM is only the native audit classification and grants no privilege. No ADMIN is fabricated. The shared lifecycle fence is durably claimed for each subscription before owner entry and removed only after positively acknowledged native completion and terminal journal publication; uncertainty retains it without TTL, stealing or GET cleanup. Native subscription locks retain their own authority. Established native unique indexes are inspected before a write; missing invariants return SEPA_INDEXES_REQUIRED, never an implicit migration. The command ID is namespaced by organisation/principal and forwarded as a stable native key. An identical replay recovers the native DONE receipt without executing the owner again; changed reuse is refused. Missing/failed/in-flight native proof stays SEPA_COMMAND_UNCERTAIN, never permission for a new ID, automatic retry or charge. Read get_sepa_subscription_command to resolve it. Claims require acknowledged:true and exact insertedId; native writes and terminal publication require positive driver acknowledgements, forced majority+j:true. Any lost/absent/false acknowledgement returns SEPA_COMMAND_UNCERTAIN; a later receipt read may resolve native DONE proof without any retry. Delegates reschedule with resume:true, exact current ordinal and explicit firstCollectionDate YYYY-MM-DD. The native owner rechecks mandate, configuration, remaining schedule and date not before the next contractual date or current organisation-local day. It may persist its canonical schedule initialisation/fences; no occurrence or debit is launched here. Only active PAUSE contracts are accepted. MANUAL review is a different owner action and is not acknowledged implicitly. Amount/frequency/mandate changes are forbidden in this request.

### Authentication

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

### Required permissions

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

### Parameters

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "description": "Current Unisoft SEPA_XML subscription UUID; not a mandate, collection or payment ID.",
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### Request body

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "expectedRevision": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "ordinal": {
            "type": "integer",
            "minimum": 1,
            "maximum": 1200
          },
          "firstCollectionDate": {
            "type": "string",
            "pattern": "^20\\d{2}-\\d{2}-\\d{2}$",
            "format": "date"
          }
        },
        "required": [
          "commandId",
          "expectedRevision",
          "ordinal",
          "firstCollectionDate"
        ],
        "additionalProperties": false
      }
    }
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Qualified native schedule or established native command outcome.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "Invalid UUID, command UUID, ordinal, date, version, unknown fields/query or non-empty GET body.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE, CAMPAIGN_RESTRICTED_KEY, API_ACTOR_UNAVAILABLE or disabled organisation.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND in the current organisation, association and SEPA_XML owner.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "SEPA_DISABLED, INVALID_SEPA_HISTORY, SEPA_HISTORY_LIMIT, SEPA_RELATED_OWNER_UNAVAILABLE, SEPA_SUBSCRIPTION_INACTIVE, SEPA_MANDATE_UNUSABLE, SEPA_SCHEDULE_CHANGED, SEPA_SCHEDULE_FINISHED, SEPA_RESCHEDULE_REQUIRED, PAYMENT_METHOD_PENDING, SUBSCRIPTION_BUSY, LIFECYCLE_RECONCILIATION_REQUIRED, COMMAND_ID_REUSED, SEPA_COMMAND_UNCERTAIN, INVALID_SEPA_COMMAND_HISTORY or an admitted native prerequisite. No automatic financial retry.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "INTERNAL_ERROR without private data. Preserve commandId after an uncertain write.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "SEPA_INDEXES_REQUIRED: existing native migration/index invariants are missing; no index is created by this request.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

### OpenAPI

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

## GET /sepa/subscription-commands/{commandId}

Read a SEPA lifecycle command receipt without repeating it

`get_sepa_subscription_command`

Dedicated SEPA_XML subscription owner; generic subscription lifecycle/edition operations remain unavailable for this platform. Requires sepa:read, abonnements:read and paiements:read, all explicitly checked; campaign-restricted keys are refused. The server re-admits current organisation/association, SEPA entitlement, subscription, linked mandate and bounded same-scope payment history. amountMinor is in EUR MINOR units (5000 = EUR 50); do not confuse it with banking amountMajor. The native schedule supplies ordinal/date/exhaustion, without inventing missing money or today. Unknown dates/projection remain null/UNKNOWN. Mandate USABLE describes the native ACTIVE/36-month-use rule, not bank acceptance or proof of settlement. No bank data, IBAN, payer identity, reusable method, donor information, raw mandate/settings or private error is exposed. No provider call, daemon, occurrence launch, notification or GET initialisation/index creation occurs. Shared authentication may record key usage. Unknown arguments and non-empty GET bodies are rejected. Requires abonnements:write plus the three read scopes, matching the original command. Reads the current principal's outer journal and the native DONE command with matching actor/scope/kind/key, then projects only the safe lifecycle result. This GET never resumes a failed native command, changes a fence or executes a financial transition. Missing proof remains SEPA_COMMAND_UNCERTAIN; preserve the original command ID.

### Authentication

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

### Required permissions

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

### Parameters

```json
{
  "name": "commandId",
  "in": "path",
  "required": true,
  "description": "Original command UUID used with this API principal.",
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### Responses

#### HTTP 200

```json
{
  "description": "Qualified native schedule or established native command outcome.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "Invalid UUID, command UUID, ordinal, date, version, unknown fields/query or non-empty GET body.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE, CAMPAIGN_RESTRICTED_KEY, API_ACTOR_UNAVAILABLE or disabled organisation.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND in the current organisation, association and SEPA_XML owner.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "SEPA_DISABLED, INVALID_SEPA_HISTORY, SEPA_HISTORY_LIMIT, SEPA_RELATED_OWNER_UNAVAILABLE, SEPA_SUBSCRIPTION_INACTIVE, SEPA_MANDATE_UNUSABLE, SEPA_SCHEDULE_CHANGED, SEPA_SCHEDULE_FINISHED, SEPA_RESCHEDULE_REQUIRED, PAYMENT_METHOD_PENDING, SUBSCRIPTION_BUSY, LIFECYCLE_RECONCILIATION_REQUIRED, COMMAND_ID_REUSED, SEPA_COMMAND_UNCERTAIN, INVALID_SEPA_COMMAND_HISTORY or an admitted native prerequisite. No automatic financial retry.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "INTERNAL_ERROR without private data. Preserve commandId after an uncertain write.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "SEPA_INDEXES_REQUIRED: existing native migration/index invariants are missing; no index is created by this request.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/SepaSubscriptionCommandError"
      }
    }
  }
}
```

### OpenAPI

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

## Schemas

```json
{
  "components": {
    "schemas": {
      "SepaSubscriptionLifecycleResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/SepaSubscriptionLifecycle"
          }
        }
      },
      "SepaSubscriptionLifecycle": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "subscriptionId",
          "assoc",
          "platform",
          "state",
          "active",
          "revision",
          "mandateId",
          "mandateUsability",
          "amountMinor",
          "currency",
          "nextOrdinal",
          "nextScheduledDate",
          "exhausted",
          "canPause",
          "canResume",
          "reasons"
        ],
        "properties": {
          "subscriptionId": {
            "type": "string",
            "format": "uuid"
          },
          "assoc": {
            "type": "string"
          },
          "platform": {
            "type": "string",
            "enum": [
              "SEPA_XML"
            ]
          },
          "state": {
            "type": "string"
          },
          "active": {
            "type": "boolean"
          },
          "revision": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "mandateId": {
            "type": "string",
            "nullable": true
          },
          "mandateUsability": {
            "type": "string",
            "enum": [
              "USABLE",
              "UNUSABLE",
              "UNKNOWN"
            ]
          },
          "amountMinor": {
            "type": "integer",
            "minimum": 1
          },
          "currency": {
            "type": "string",
            "enum": [
              "eur"
            ]
          },
          "nextOrdinal": {
            "type": "integer",
            "minimum": 1,
            "nullable": true
          },
          "nextScheduledDate": {
            "type": "string",
            "format": "date",
            "nullable": true
          },
          "exhausted": {
            "type": "boolean",
            "nullable": true
          },
          "canPause": {
            "type": "boolean"
          },
          "canResume": {
            "type": "boolean"
          },
          "reasons": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "SepaSubscriptionCommandError": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      },
      "SepaSubscriptionCommandResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "commandId",
          "outcome",
          "replayed",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "commandId": {
            "type": "string",
            "format": "uuid"
          },
          "outcome": {
            "type": "string",
            "enum": [
              "APPLIED"
            ]
          },
          "replayed": {
            "type": "boolean"
          },
          "data": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "subscriptionId",
              "state",
              "nextScheduledDate"
            ],
            "properties": {
              "subscriptionId": {
                "type": "string",
                "format": "uuid"
              },
              "state": {
                "type": "string",
                "enum": [
                  "PAUSE",
                  "ACTIVE"
                ]
              },
              "nextScheduledDate": {
                "type": "string",
                "format": "date",
                "nullable": true
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "API Key",
        "description": "Format: `ke_live_xxx`"
      },
      "apiKeyHeader": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key"
      }
    }
  }
}
```
