Skip to main content
PATCH
/
api
/
v1
/
subscriptions
/
{id}
curl --request PATCH \
  --url https://your-site.example/api/v1/subscriptions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "period": "yearly"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "category": "<string>",
    "amount": 499999.995,
    "lastPaymentDate": "2026-06-01",
    "nextPaymentDate": "2026-06-01",
    "notificationEnabled": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "customDate": "<string>"
  },
  "requestId": "<string>"
}

Authorizations

​
Authorization
string
header
default:subm_your_key_here
required

Developer API key generated in the app. Keys carry scopes; a read key can call list, get, analytics, and audit endpoints, while a write key additionally allows create, update, cancel, pause, resume, and delete.

Path Parameters

​
id
string<uuid>
required

Subscription UUID.

Body

application/json
​
name
string
Required string length: 1 - 120
​
category
string
Required string length: 1 - 80
​
amount
number
Required range: 0 <= x <= 999999.99Must be a multiple of 0.01
​
currency
enum<string>

ISO-like currency code supported by the app.

Available options:
CNY,
USD,
EUR,
JPY,
GBP,
AUD,
CAD,
CHF,
HKD,
SGD
​
period
enum<string>

Billing cadence used to calculate nextPaymentDate.

Available options:
monthly,
yearly,
custom
​
lastPaymentDate
string

Calendar date without time, always in YYYY-MM-DD format.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-06-01"

​
customDate
string

Required only when period is custom. Despite the legacy name, this is a positive whole-number string of days, not a calendar date.

Pattern: ^[1-9]\d*$
​
notificationEnabled
boolean
​
status
enum<string>

Lifecycle state. active means billing; paused means temporarily stopped; cancelled means no longer billing but kept for history.

Available options:
active,
paused,
cancelled

Response

Subscription updated.

​
data
object
required
​
requestId
string
required