`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:readaccounting:write

Who can call it

admin, finance

Retries

Idempotency key required, with expectedRevision

MCP

accounting_subscriptions_save

Fields

vendorKeystringRequired
1–120 characters · Matches ^[a-z0-9 ]+$
merchantstringRequired
1–160 characters
currencystringRequired
Three-letter currency code, such as CAD or USD.
expectedRevisionintegerRequired
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
cadenceenum or nullRequired
monthlyquarterlyyearlyunknown
statusenum or nullRequired
Only include records with this status.
activepausedended
renewalOnstring (date) or nullRequired
amountMinorstring or nullRequired
An amount in cents (the currency's smallest unit), written as a whole-number string such as "1250" for $12.50.
quantityCountinteger or nullRequired
quantityUnitenum or nullRequired
seatuserlicensetokencredit
notestringRequired
A short note, kept with the record.
at most 500 characters
idempotencyKeystringRequired
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

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"
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/subscriptions.save", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "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"
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os
import uuid

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/accounting/subscriptions.save",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "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",
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Response

{
  "data": { … }
}

Try it

Checks your input with this action’s real schema and answers like the API, with synthetic data. No key needed, and nothing changes.

Input

POST/api/v1/accounting/subscriptions.save

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"
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/subscriptions.save", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "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"
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os
import uuid

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/accounting/subscriptions.save",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "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",
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Example

Try it