Retrieve Subscriptions

get https://api-sandbox.thisisbud.com/v1/subscriptions

This endpoint is used to retrieve information about a user's subscriptions

Responses

Response body

object

operation_id

string

required

v1_subscriptions_get

data

array of objects

required

Subscriptions Finder Response Data*

object

subscription_type

string

required

Type of subscription identified. Potential values are subject to change and may be converted to enums at a future unspecified date.

Subscription type	Description
`unknown`	Unknown subscription type
`media_streaming`	Digital media streaming subscriptions
`newspapers_and_magazines`	Print media subscriptions
`food_and_drink`	Grocery and specialty food/drink subscriptions
`technology`	Technology subscriptions, including software and hardware
`fitness_and_gym`	Health and fitness subscriptions
`charitable_donations`	Recurring donations to charity

period

string

required

To describe the period between each transaction within a subscription. Potential values could be (but are not limited to) monthly, quarterly and unknown, and may be converted to enums at a future unspecified date.

categories

object

required

Categories of the subscription

merchant

object

Details surrounding the identified merchant of the transaction (this field will be omitted if a merchant is not detected)

transactions

array of objects

required

transactions*

object

transaction_id

string

required

A unique identifier for the transaction

account_id

string

required

A unique identifier for the Customer bank account

transaction_description

string

required

A description of the transaction, similar to the transaction information in Open Banking. e.g. a bank transfer reference"

provider

string

required

The name of the relevant provider relevant to the source of the original transaction data

date

string

required

The date of the transaction in the format RFC 3339.

Examples:

2023-03-17T17:29:51Z
2023-03-17T17:29:51-08:00

amount

object

required

The monetary amount.

credit_debit_indicator

string

required

Indication as to whether the transaction was a credit or debit

Credit Debit

metadata

object

required

Metadata associated with the response schema

from

string

required

The date from when results were retrieved in the format ISO-8601.
This is either populated with the default value used when retrieving the results, or the user specified parameter.

Example: 2023-01-17

string

required

The date up to when results were retrieved in the format ISO-8601.
This is either populated with the default value used when retrieving the results, or the user specified parameter.

Example: 2023-03-17

results

number

required

Number of results returned

204

No subscriptions found

400

The request contains an invalid payload.

401

Unauthorised request

405

An unexpected HTTP method was used

5XX

An unexpected error occurred on the server side

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-sandbox.thisisbud.com/v1/subscriptions \
3
     --header 'accept: application/json'

Choose an example:

application/json

200OK