Skip to content
Exhale

Spending summary

GET
/api/v1/summary
curl --request GET \
  --url http://127.0.0.1:8484/api/v1/summary \
  --header 'Authorization: Bearer <token>'

Monthly and yearly recurring spend per currency, spend per category and payment method, how much to set aside each month for yearly bills, what is due before the next payday, the charges of the next 7 days, and what cancelled subscriptions no longer cost per year (stopped).

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
activeSubscriptions
required
integer format: int64
beforePayday
object
charges
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
id
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
due
required
object
currency
required
string
minor
required
integer format: int64
payday
required
string
byCategory
required
Array<object> | null
object
category
required
string
count
required
integer format: int64
monthly
required
object
currency
required
string
minor
required
integer format: int64
byPaymentMethod
required
Array<object> | null
object
count
required
integer format: int64
monthly
required
object
currency
required
string
minor
required
integer format: int64
paymentMethod
required
string
converted
required
boolean
mainCurrency
required
string
monthlyByCurrency
required
Array<object> | null
object
currency
required
string
minor
required
integer format: int64
monthlyTotal
required
object
currency
required
string
minor
required
integer format: int64
next7Days
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
id
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
rates
required
object
key
additional properties
string
ratesDate
string
setAsideMonthly
required
object
currency
required
string
minor
required
integer format: int64
stopped
required
object
count
required
integer format: int64
subscriptions
required
Array<object> | null
object
id
required
string
name
required
string
until
string
yearly
required
object
currency
required
string
minor
required
integer format: int64
yearlyMain
required
object
currency
required
string
minor
required
integer format: int64
yearly
required
object
currency
required
string
minor
required
integer format: int64
unconverted
required
Array<string> | null
yearlyByCurrency
required
Array<object> | null
object
currency
required
string
minor
required
integer format: int64
yearlyTotal
required
object
currency
required
string
minor
required
integer format: int64

Example 

{
  "$schema": "https://example.com/api/schemas/SpendingSummary.json",
  "beforePayday": {
    "charges": [
      {
        "kind": "renewal"
      }
    ]
  },
  "next7Days": [
    {
      "kind": "renewal"
    }
  ]
}

default

Section titled “default”

Error

Media typeapplication/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"
}