Skip to content
Exhale

Get a subscription

GET
/api/v1/subscriptions/{id}
curl --request GET \
  --url http://127.0.0.1:8484/api/v1/subscriptions/example \
  --header 'Authorization: Bearer <token>'

One subscription with its upcoming charges (with charge ids) and its charge history.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

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
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
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
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
id
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
at
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
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/SubscriptionDetail.json",
  "history": [
    {
      "kind": "renewal"
    }
  ],
  "subscription": {
    "altPrice": {
      "unit": "month"
    }
  },
  "upcoming": [
    {
      "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"
}