Update a subscription

POST

/api/v1/subscriptions/update

const url = 'http://127.0.0.1:8484/api/v1/subscriptions/update';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"account":"example","altPrice":"example","altUnit":"month","autoConfirm":true,"cancelUrl":"example","categoryId":"example","dayRule":"day","dryRun":true,"endDate":"example","id":"example","interval":1,"name":"example","nextCharge":"example","notes":"example","noticeDays":1,"payerId":"example","paymentMethodId":"example","price":"example","priceFrom":"example","private":true,"reminderDays":[1],"reminderHour":1,"renewal":"auto","shares":[{"memberId":"example","weight":1}],"startedOn":"example","tags":["example"],"trialEndsOn":"example","unit":"day","url":"example","using":true,"weekendShift":"none"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://127.0.0.1:8484/api/v1/subscriptions/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "account": "example", "altPrice": "example", "altUnit": "month", "autoConfirm": true, "cancelUrl": "example", "categoryId": "example", "dayRule": "day", "dryRun": true, "endDate": "example", "id": "example", "interval": 1, "name": "example", "nextCharge": "example", "notes": "example", "noticeDays": 1, "payerId": "example", "paymentMethodId": "example", "price": "example", "priceFrom": "example", "private": true, "reminderDays": [ 1 ], "reminderHour": 1, "renewal": "auto", "shares": [ { "memberId": "example", "weight": 1 } ], "startedOn": "example", "tags": [ "example" ], "trialEndsOn": "example", "unit": "day", "url": "example", "using": true, "weekendShift": "none" }'

Changes name, price (from the next open charge on, or from priceFrom for a change announced in advance), billing cycle or day (interval, unit, nextCharge: from the next charge on), end date, category, payment method, payer, cost shares, privacy, URL, notes, auto-confirm, reminders, or the contract terms (start date, trial end, notice period, renewal, cancel link, account). Only the fields you pass change.

Authorizations

bearer

Request Body^required

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

account

string

altPrice

string

altUnit

string

Allowed values: month year

autoConfirm

boolean

cancelUrl

string

categoryId

string

dayRule

string

Allowed values: day weekday last-weekday

dryRun

boolean

endDate

string

required

string

interval

integer format: int64

>= 1

name

string

nextCharge

string

notes

string

noticeDays

integer format: int64

payerId

string

paymentMethodId

string

price

string

priceFrom

string

private

boolean

reminderDays

Array<integer> | null

reminderHour

integer format: int64

renewal

string

Allowed values: auto manual

shares

Array<object> | null

object

memberId

required

string

weight

required

integer format: int64

startedOn

string

tags

Array<string> | null

trialEndsOn

string

unit

string

Allowed values: day week month year

url

string

using

boolean

weekendShift

string

Allowed values: none next previous

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

history

required

Array<object> | null

object

amount

required

object

currency

required

string

minor

required

integer format: int64

cancelBy

string

cancelPassed

required

boolean

chargedAmount

object

currency

required

string

minor

required

integer format: int64

daysUntil

required

integer format: int64

decision

string

delayed

required

boolean

dueDate

required

string

required

string

kind

required

string

Allowed values: renewal trial expiry

logo

string

note

string

originalDate

required

string

paymentMethod

string

resolvedAt

string format: date-time

status

required

string

subscriptionId

required

string

subscriptionName

required

string

updatedAt

required

string format: date-time

version

required

integer format: int64

paid

required

object

count

required

integer format: int64

since

string

total

required

object

currency

required

string

minor

required

integer format: int64

priceHistory

required

Array<object> | null

object

changePercent

string

from

required

string

price

required

object

currency

required

string

minor

required

integer format: int64

scheduled

boolean

subscription

required

object

account

string

altPrice

object

price

required

object

currency

required

string

minor

required

integer format: int64

unit

required

string

Allowed values: month year

askUsage

required

boolean

autoConfirm

required

boolean

billingDay

string

cadence

required

string

cancelBy

string

cancelUrl

string

categoryId

string

categoryName

string

createdAt

required

string format: date-time

createdBy

string

expires

required

boolean

householdId

required

string

required

string

inTrial

required

boolean

logo

string

monthlyCost

required

object

currency

required

string

minor

required

integer format: int64

name

required

string

nextCharge

string

nextPrice

object

from

required

string

price

required

object

currency

required

string

minor

required

integer format: int64

nextScheduled

string

notes

string

noticeDays

integer format: int64

payerId

string

payerName

string

paymentMethod

string

paymentMethodId

string

planSwitch

object

currentYearly

required

object

currency

required

string

minor

required

integer format: int64

otherYearly

required

object

currency

required

string

minor

required

integer format: int64

yearlySaving

required

object

currency

required

string

minor

required

integer format: int64

price

required

object

currency

required

string

minor

required

integer format: int64

reminders

required

object

confirmAfterDays

required

integer format: int64

confirmEveryDays

required

integer format: int64

confirmTimes

required

integer format: int64

daysBefore

required

Array<integer> | null

hour

required

integer format: int64

minute

required

integer format: int64

renewal

string

schedule

required

object

maxCharges

integer format: int64

until

string

versions

required

Array<object> | null

object

from

required

string

rule

required

object

anchor

required

string

dayRule

string

interval

required

integer format: int64

unit

required

string

weekendShift

string

serviceUntil

string

shares

Array<object> | null

object

memberId

required

string

weight

required

integer format: int64

startedOn

string

status

required

string

tags

Array<string> | null

trialEndsOn

string

updatedAt

required

string format: date-time

url

string

usage

object

required

string format: date-time

using

required

boolean

version

required

integer format: int64

visibility

required

string

yearlyCost

required

object

currency

required

string

minor

required

integer format: int64

upcoming

required

Array<object> | null

object

amount

required

object

currency

required

string

minor

required

integer format: int64

cancelBy

string

cancelPassed

required

boolean

chargedAmount

object

currency

required

string

minor

required

integer format: int64

daysUntil

required

integer format: int64

decision

string

delayed

required

boolean

dueDate

required

string

required

string

kind

required

string

Allowed values: renewal trial expiry

logo

string

note

string

originalDate

required

string

paymentMethod

string

resolvedAt

string format: date-time

status

required

string

subscriptionId

required

string

subscriptionName

required

string

updatedAt

required

string format: date-time

version

required

integer format: int64

Example

{
  "$schema": "https://example.com/api/schemas/SubscriptionDetail.json",
  "history": [
    {
      "kind": "renewal"
    }
  ],
  "subscription": {
    "altPrice": {
      "unit": "month"
    }
  },
  "upcoming": [
    {
      "kind": "renewal"
    }
  ]
}

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "https://example.com/api/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

Update a subscription

Authorizations

Request Bodyrequired

Responses

200

Example

default

Example

Request Body^required