Detected subscriptions and renewals

GET

/v1/intel/subscriptions

const url = 'https://api.trustysweep.com/v1/intel/subscriptions?limit=50';
const options = {method: 'GET', headers: {cookie: 'sweep_session=<sweep_session>'}};

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

curl --request GET \
  --url 'https://api.trustysweep.com/v1/intel/subscriptions?limit=50' \
  --cookie sweep_session=<sweep_session>

Authorizations

sessionCookie
sessionToken
apiKey
intel:read
oauth2
intel:read

Parameters

Query Parameters

connection_id

string

/^cxn_[0-9A-HJKMNP-TV-Z]{26}$/

Delegated end-user connection (required when authenticating with a developer API key).

limit

integer

default: 50 >= 1 <= 200

cursor

string

Opaque cursor from next_cursor.

Responses

200

application/json

object

data

required

Array<object>

object

required

Prefixed ULID (sub_…)

string

/^sub_[0-9A-HJKMNP-TV-Z]{26}$/

vendor

required

string

vendorDomain

One of:

string
null

string

product

One of:

string
null

string

status

required

string

Allowed values: active trial cancelled paused unknown

cadence

required

string

Allowed values: weekly monthly quarterly annual usage one_time unknown

amountCents

One of:

integer
null

integer

currency

required

string

annualizedCents

One of:

integer
null

integer

nextRenewalAt

One of:

string
null

string format: date-time

lastChargeAt

One of:

string
null

string format: date-time

previousAmountCents

One of:

integer
null

integer

priceChangePercent

One of:

number
null

number

cancellationPath

One of:

string
null

string

evidenceLevel

required

CONFIRMED = direct platform/API/settlement evidence; DETECTED = reliable statement/email/invoice evidence; ESTIMATED = calculation from observable rates or incomplete evidence. An estimate is never presented as confirmed.

string

Allowed values: CONFIRMED DETECTED ESTIMATED

confidence

required

number

evidence

required

Array<object>

object

kind

required

string

Allowed values: email statement api invoice contract receipt user derived

ref

required

string

sourceId

string

observedAt

required

string format: date-time

excerpt

string

<= 300 characters

lastActivityAt

One of:

string
null

string format: date-time

activeDays90

One of:

integer
null

integer

updatedAt

required

string format: date-time

next_cursor

required

string | null

Example

{
  "data": [
    {
      "id": "sub_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
      "status": "active",
      "cadence": "weekly",
      "evidenceLevel": "CONFIRMED",
      "evidence": [
        {
          "kind": "email"
        }
      ]
    }
  ]
}

Headers

RateLimit-Limit

integer

Requests allowed in the current window.

RateLimit-Remaining

integer

Requests remaining in the current window.

RateLimit-Reset

integer

Seconds until the window resets.

400

Validation failed

application/problem+json

RFC 9457 problem details.

object

type

required

Https://developers.trustysweep.com/errors/

string format: uri

titlerequired

string

statusrequired

integer

detail

string

coderequired

Machine-readable error code from errors.json

string

request_idrequired

string

errors

Array<object>

object

pathrequired

string

messagerequired

string

`Example^generated`

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`401`

Section titled “401”

Unauthenticated

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`403`

Section titled “403”

Forbidden / action denied / step-up required

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`404`

Section titled “404”

Not found

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`429`

Section titled “429”

Rate limited

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`Headers`

Section titled “Headers”

Retry-After

integer

Seconds to wait before retrying.

RateLimit-Limit

integer

Requests allowed in the current window.

RateLimit-Remaining

integer

Requests remaining in the current window.

RateLimit-Reset

integer

Seconds until the window resets.

`500`

Section titled “500”

Internal error

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

Detected subscriptions and renewals

Authorizations

Parameters

Query Parameters

Responses

200

Example

Headers

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

429

Examplegenerated

Headers

500

Examplegenerated

`Example^generated`

`401`

`Example^generated`

`403`

`Example^generated`

`404`

`Example^generated`

`429`

`Example^generated`

`Headers`

`500`

`Example^generated`