# subscriptions.save

Confirm or correct one subscription's cadence, status, renewal, amount or explicitly evidenced seat or usage quantity. Requires expectedRevision and idempotencyKey. Does not change accounting entries or cancel a provider subscription.

`POST /api/v1/accounting/subscriptions.save`

Permissions: `accounting:read`, `accounting:write` · Roles: admin, finance · Idempotency key required · Send `expectedRevision`

MCP tool: `accounting_subscriptions_save`

## Fields

| Field | Type | Required | Notes |
| --- | --- | --- | --- |
| `vendorKey` | string | Yes | 1–120 characters; Matches ^[a-z0-9 ]+$. |
| `merchant` | string | Yes | 1–160 characters. |
| `currency` | string | Yes | Three-letter currency code, such as CAD or USD. |
| `expectedRevision` | integer | Yes | The record's current revision, from the last time you read it. If someone changed the record since, the request is refused with a conflict so you can reload and check before trying again. 0 to 9007199254740991. |
| `cadence` | enum or null | Yes | One of: `monthly`, `quarterly`, `yearly`, `unknown`. |
| `status` | enum or null | Yes | Only include records with this status. One of: `active`, `paused`, `ended`. |
| `renewalOn` | string (date) or null | Yes |  |
| `amountMinor` | string or null | Yes | An amount in cents (the currency's smallest unit), written as a whole-number string such as "1250" for $12.50. |
| `quantityCount` | integer or null | Yes |  |
| `quantityUnit` | enum or null | Yes | One of: `seat`, `user`, `license`, `token`, `credit`. |
| `note` | string | Yes | A short note, kept with the record. at most 500 characters. |
| `idempotencyKey` | string | Yes | Any unique text you generate once per intended change, so a retried request only happens once. Send it as the Idempotency-Key header instead if you prefer; if you send both they must match. 8–200 characters. |

## Example request

```bash
curl https://app.getoatmilk.com/api/v1/accounting/subscriptions.save \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "vendorKey": "example",
  "merchant": "example",
  "currency": "CAD",
  "expectedRevision": 3,
  "cadence": "monthly",
  "status": "active",
  "renewalOn": "2026-09-01",
  "amountMinor": "1250",
  "quantityCount": 1,
  "quantityUnit": "seat",
  "note": "Synthetic example from the docs"
}'
```

Reference page: https://app.getoatmilk.com/docs/api/subscriptions.save
