Skip to main content
PATCH

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, notification settings, analytics, and audit endpoints, while a write key additionally allows create, update, delete, and notification settings updates.

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. Monthly means the same calendar day each month; fixed-day intervals use custom.

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"

​
nextPaymentDate
string

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

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

"2026-06-01"

​
billingAnchorDay
integer
Required range: 1 <= x <= 31
​
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
​
isTrial
boolean
​
trialEndsOn
string

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

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

"2026-06-01"

Response

Subscription updated.

​
data
object
required
​
requestId
string
required