Skip to content
Exhale

Audit the subscriptions

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

Facts worth acting on, computed not guessed: duplicates, price increases in the last year, free trials about to charge, last days to cancel, things about to expire, big charges coming, cards about to expire with the subscriptions that depend on them, unconfirmed charges and subscriptions marked as not used.

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
bigCharges
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
cancelDeadlines
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
cardsExpiring
required
Array<object> | null
object
paymentMethod
required
object
expiresOn
string
householdId
required
string
id
required
string
kind
required
string
last4
string
name
required
string
ownerId
string
subscriptions
required
Array<object> | null
object
id
required
string
monthly
required
object
currency
required
string
minor
required
integer format: int64
name
required
string
payer
string
cheaperPlans
required
Array<object> | null
object
currentYearly
required
object
currency
required
string
minor
required
integer format: int64
other
required
object
price
required
object
currency
required
string
minor
required
integer format: int64
unit
required
string
Allowed values: month year
subscription
required
object
id
required
string
monthly
required
object
currency
required
string
minor
required
integer format: int64
name
required
string
payer
string
yearlySaving
required
object
currency
required
string
minor
required
integer format: int64
duplicates
required
Array<object> | null
object
key
required
string
service
required
string
subscriptions
required
Array<object> | null
object
id
required
string
monthly
required
object
currency
required
string
minor
required
integer format: int64
name
required
string
payer
string
expiring
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
findings
required
integer format: int64
notUsed
required
Array<object> | null
object
answeredOn
required
string
subscription
required
object
id
required
string
monthly
required
object
currency
required
string
minor
required
integer format: int64
name
required
string
payer
string
yearly
required
object
currency
required
string
minor
required
integer format: int64
priceIncreases
required
Array<object> | null
object
changePercent
required
string
from
required
object
currency
required
string
minor
required
integer format: int64
since
required
string
subscription
required
object
id
required
string
monthly
required
object
currency
required
string
minor
required
integer format: int64
name
required
string
payer
string
to
required
object
currency
required
string
minor
required
integer format: int64
yearlyDelta
required
object
currency
required
string
minor
required
integer format: int64
trialsEnding
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
unconfirmed
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

Example 

{
  "$schema": "https://example.com/api/schemas/AuditReport.json",
  "bigCharges": [
    {
      "kind": "renewal"
    }
  ],
  "cancelDeadlines": [
    {
      "kind": "renewal"
    }
  ],
  "cheaperPlans": [
    {
      "other": {
        "unit": "month"
      }
    }
  ],
  "expiring": [
    {
      "kind": "renewal"
    }
  ],
  "trialsEnding": [
    {
      "kind": "renewal"
    }
  ],
  "unconfirmed": [
    {
      "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"
}