# Bud Developer Hub Documentation ## Guides - [Model Context Protocol](https://docs.thisisbud.com/docs/model-context-protocol.md) - [Affordability risk insights (beta)](https://docs.thisisbud.com/docs/api-affordability-insights.md) - [Affordability report](https://docs.thisisbud.com/docs/api-affordability-report.md) - [Common aggregations](https://docs.thisisbud.com/docs/api-common-aggregations.md) - [Custom aggregations](https://docs.thisisbud.com/docs/api-custom-aggregation.md) - [Financial health indicators](https://docs.thisisbud.com/docs/api-financial-health-data.md) - [Creating Customer Applications](https://docs.thisisbud.com/docs/creating-customers-applications-for-assess-api-one-time-consent.md): Assess API (One Time Consent) - [Assess API to Assess Dashboard Create Customer Application Journey](https://docs.thisisbud.com/docs/hybrid-assess-api-to-assess-dashboard-create-customer-application-journey.md): The below steps should be followed when integrating the hybrid Assess API to Assess Dashboard Journey. - [Assess API](https://docs.thisisbud.com/docs/assess-api-get-started.md) - [Affordability Risk Insights](https://docs.thisisbud.com/docs/affordability-risk-insights.md) - [Creating applications](https://docs.thisisbud.com/docs/dashboard-create-applications.md) - [Exporting application data](https://docs.thisisbud.com/docs/dashboard-export-application.md) - [Managing applications](https://docs.thisisbud.com/docs/dashboard-managing-applications.md) - [Reviewing applications](https://docs.thisisbud.com/docs/dashboard-reviewing-applications.md) - [Assess dashboard](https://docs.thisisbud.com/docs/assess-dashboard-get-started.md) - [Categorisation and aggregation](https://docs.thisisbud.com/docs/categorisation-and-aggregation.md) - [Create your own dashboard](https://docs.thisisbud.com/docs/create-your-own-dashboard.md) - [Intro to Assess](https://docs.thisisbud.com/docs/intro-to-assess.md) - [Console sign up](https://docs.thisisbud.com/docs/console-sign-up-and-login.md) - [Accounts](https://docs.thisisbud.com/docs/accounts.md) - [Authorised payments](https://docs.thisisbud.com/docs/authorised-payments.md) - [Transactions](https://docs.thisisbud.com/docs/transactions.md) - [Intro to Bud](https://docs.thisisbud.com/docs/intro-to-bud.md) - [Want a demo?](https://docs.thisisbud.com/docs/want_a_demo.md) - [Check coverage table](https://docs.thisisbud.com/docs/check-coverage-table.md) - [How to perform account verification with Check](https://docs.thisisbud.com/docs/how-to-perform-account-verification-with-check.md) - [Intro to Check](https://docs.thisisbud.com/docs/intro-to-check.md) - [Configure the journey](https://docs.thisisbud.com/docs/configure-the-journey.md) - [Connect coverage table](https://docs.thisisbud.com/docs/connect-coverage-table.md) - [Auth Denied](https://docs.thisisbud.com/docs/auth-denied.md) - [Auth Expired](https://docs.thisisbud.com/docs/auth-expired.md) - [Auth Used](https://docs.thisisbud.com/docs/auth-used.md) - [Awaiting Authorisation](https://docs.thisisbud.com/docs/awaiting-authorisation.md) - [Connection Expired](https://docs.thisisbud.com/docs/connection-expired.md) - [Connection Not Found](https://docs.thisisbud.com/docs/connection-not-found.md) - [Connection Permission](https://docs.thisisbud.com/docs/connection-permission.md) - [Connection Revoked](https://docs.thisisbud.com/docs/connection-revoked.md) - [Connection Status](https://docs.thisisbud.com/docs/connection-status.md) - [Consent Not Found](https://docs.thisisbud.com/docs/consent-not-found.md) - [Extension Not Permitted](https://docs.thisisbud.com/docs/extension-not-permitted.md) - [Connect API errors](https://docs.thisisbud.com/docs/connect-errors.md) - [Internal Auth Error](https://docs.thisisbud.com/docs/internal-auth-error.md) - [Provider Endpoint Deprecated](https://docs.thisisbud.com/docs/provider-endpoint-deprecated.md) - [Provider Endpoint Unimplemented](https://docs.thisisbud.com/docs/provider-endpoint-unimplemented.md) - [Provider Endpoint Unsupported](https://docs.thisisbud.com/docs/provider-endpoint-unsupported.md) - [Provider Failure](https://docs.thisisbud.com/docs/provider-failed.md) - [Provider Limit](https://docs.thisisbud.com/docs/provider-limit.md) - [Provider Maintenance](https://docs.thisisbud.com/docs/provider-maintenance.md) - [Provider Marked Account Invalid](https://docs.thisisbud.com/docs/provider-marked-account-invalid.md) - [Provider Not Found](https://docs.thisisbud.com/docs/provider-not-found.md) - [Provider Timeout](https://docs.thisisbud.com/docs/provider-timeout.md) - [Provider Unauthorised](https://docs.thisisbud.com/docs/provider-unauthorised.md) - [Provider Unavailable](https://docs.thisisbud.com/docs/provider-unavailable.md) - [Connection Reauthenticate](https://docs.thisisbud.com/docs/re-authenticate.md) - [Request Decoding](https://docs.thisisbud.com/docs/request-decoding.md) - [Request Validation](https://docs.thisisbud.com/docs/request-validation.md) - [Resource Not Found](https://docs.thisisbud.com/docs/resource-not-found.md) - [Task Not Found](https://docs.thisisbud.com/docs/task-not-found.md) - [First Party Data Ingestion Events](https://docs.thisisbud.com/docs/first-party-data-ingestion-events.md): first_party_ingester.ingest.succeeded and first_party_ingester.ingest.failed - [Webhooks](https://docs.thisisbud.com/docs/connect-webhooks.md): Use webhooks to be notified when Open Banking or ingestion events occur - [Open Banking Connect Completed](https://docs.thisisbud.com/docs/open-banking-connect-completed.md): open_banking.connect.completed - [Open Banking Consent Reconfirmed](https://docs.thisisbud.com/docs/open-banking-consent-reconfirmed.md): open_banking.consent.reconfirmed - [Open Banking Consent Revoked](https://docs.thisisbud.com/docs/open-banking-consent-revoked.md): open_banking.consent.revoked - [Open Banking Refresh Completed](https://docs.thisisbud.com/docs/open-banking-refresh-completed.md): open_banking.refresh.completed - [Open Banking Refresh V2 Completed](https://docs.thisisbud.com/docs/open-banking-v2-refresh-completed.md): open_banking.v2.refresh.completed - [Open Banking Refresh V2 Provider Completed](https://docs.thisisbud.com/docs/open-banking-v2-refresh-provider-completed.md): open_banking.v2.refresh.provider.completed - [Consent Revoke Reasons](https://docs.thisisbud.com/docs/consent-revoke-reasons.md) - [Consents](https://docs.thisisbud.com/docs/consents.md): Learn about consents and how they should be managed. - [Customise user interface (UI)](https://docs.thisisbud.com/docs/customise-the-user-interface-ui.md) - [Get the most out of Connect](https://docs.thisisbud.com/docs/get-the-most-out-of-connect.md) - [Intro to Connect](https://docs.thisisbud.com/docs/intro-to-connect.md) - [Keep Your Data in Sync with Bud](https://docs.thisisbud.com/docs/keep-your-data-in-sync-with-bud.md) - [Working with existing aggregators](https://docs.thisisbud.com/docs/migrating-from-existing-aggregators.md) - [Bud Hosted Refreshes](https://docs.thisisbud.com/docs/open-banking-hosted-refreshes.md): For a simpler integration, let Bud take control of your background refreshes. - [Refreshing customer accounts](https://docs.thisisbud.com/docs/refreshing-customer-accounts.md) - [Revoking consent and deleting data](https://docs.thisisbud.com/docs/revoking-consent-and-deleting-data.md) - [Set up Connect under Bud's licence](https://docs.thisisbud.com/docs/setup-bud-banking-connections.md) - [Set up Connect with your own license](https://docs.thisisbud.com/docs/setup-connect-with-your-own-license.md) - [Set up First Party Ingestion](https://docs.thisisbud.com/docs/setup_data_enrichment.md): How to successfully ingest customer transactions into the Bud Platform. - [Synchronous Transaction Enrichment End-to-End Walkthrough](https://docs.thisisbud.com/docs/synchronous-transaction-enrichment-end-to-end-walkthrough.md) - [Connect sandbox credential(s)](https://docs.thisisbud.com/docs/connect-sandbox-credentials.md) - [Transaction history](https://docs.thisisbud.com/docs/transaction-history.md) - [Actionable Insights](https://docs.thisisbud.com/docs/actionable-insights.md) - [Benefits Finder](https://docs.thisisbud.com/docs/benefits-finder.md) - [Correcting transactions merchants](https://docs.thisisbud.com/docs/correcting-transactions-merchants.md) - [Correcting transactions categories](https://docs.thisisbud.com/docs/correcting-transactions.md) - [Custom Insights](https://docs.thisisbud.com/docs/custom-insights.md) - [Customer Characteristics](https://docs.thisisbud.com/docs/customer-characteristics.md) - [Displaying Category and Merchant Totals](https://docs.thisisbud.com/docs/displaying-category-and-merchant-totals.md) - [Corrections Category Corrected](https://docs.thisisbud.com/docs/corrections-category-corrected.md): corrections.category.corrected - [Corrections Merchant Corrected](https://docs.thisisbud.com/docs/corrections-merchant-corrected.md): corrections.merchant.corrected - [Engage Webhooks](https://docs.thisisbud.com/docs/engage-webhooks.md): Use webhooks to be notified when Insights or Financial data change events occur - [Insight Summary Completed](https://docs.thisisbud.com/docs/insight-summary-completed.md): insights.summary.completed - [Insights Balances Triggered](https://docs.thisisbud.com/docs/insights-balances-triggered.md): insights.balances.triggered - [Insights Income Triggered](https://docs.thisisbud.com/docs/insights-income-triggered.md): insights.income.triggered - [Insights Spending Triggered](https://docs.thisisbud.com/docs/insights-spending-triggered.md): insights.spending.triggered - [Accounts Widget](https://docs.thisisbud.com/docs/accounts-widget.md) - [Balances Over Time Widget](https://docs.thisisbud.com/docs/balances-over-time.md) - [Financial Calendar Widget](https://docs.thisisbud.com/docs/financial-calendar.md) - [Frontend Widgets](https://docs.thisisbud.com/docs/frontend-widgets-1.md): Frontend widgets that a developer can quickly and easily embed into your application - [Insight Summary Widget](https://docs.thisisbud.com/docs/insight-summary.md) - [Intelligent Search Widget](https://docs.thisisbud.com/docs/intelligent-search.md) - [Recurring and Forecasted Transactions Widget](https://docs.thisisbud.com/docs/recurring-and-forecasted-transactions.md) - [Savings Goals Widget](https://docs.thisisbud.com/docs/savings-goals.md) - [Spending Analysis Widget](https://docs.thisisbud.com/docs/spending-analysis.md) - [Spending Budgets Widget](https://docs.thisisbud.com/docs/spending-budgets-2.md) - [Credit cards](https://docs.thisisbud.com/docs/credit-cards.md) - [Emergency fund](https://docs.thisisbud.com/docs/emergency-fund.md) - [Forecasting future transactions](https://docs.thisisbud.com/docs/forecasting-future-transactions.md) - [How Engage can help with cost of living](https://docs.thisisbud.com/docs/how-insights-can-help-with-cost-of-living.md) - [Loan repayments](https://docs.thisisbud.com/docs/loan-repayments.md) - [Spending compared to last month](https://docs.thisisbud.com/docs/spending-compared-to-last-month.md) - [Spending on non-essentials](https://docs.thisisbud.com/docs/spending-on-non-essentials.md) - [Subscriptions](https://docs.thisisbud.com/docs/subscriptions.md) - [Total debt](https://docs.thisisbud.com/docs/total-debt.md) - [Income Finder](https://docs.thisisbud.com/docs/income-finder-1.md) - [Intelligent Search](https://docs.thisisbud.com/docs/intelligent-search-2.md) - [Introduction to Engage](https://docs.thisisbud.com/docs/intro-to-engage.md) - [Loan & Debt Finders](https://docs.thisisbud.com/docs/loan-debt-finders.md) - [Locations](https://docs.thisisbud.com/docs/locations.md) - [Product Finder](https://docs.thisisbud.com/docs/product-finder-1.md) - [Regular Payments Finder](https://docs.thisisbud.com/docs/regular-payments-finder-1.md) - [Spending Budgets](https://docs.thisisbud.com/docs/spending-budgets-1.md) - [Subscription Finder](https://docs.thisisbud.com/docs/subscription-finder-1.md) - [API message formats](https://docs.thisisbud.com/docs/api-message-formats.md) - [Authentication](https://docs.thisisbud.com/docs/authentication.md) - [Client Secret Rotation](https://docs.thisisbud.com/docs/rotate-an-app-secret.md) - [Best Practice Recommendations](https://docs.thisisbud.com/docs/best-practice-recommendations.md): Optimise and fine tune your integration with Bud by following these recommendations. - [Environments and limits](https://docs.thisisbud.com/docs/environments.md) - [Production environment](https://docs.thisisbud.com/docs/production-environment.md) - [Sandbox call limits](https://docs.thisisbud.com/docs/sandbox-call-limits.md) - [Sandbox environment](https://docs.thisisbud.com/docs/sandbox-environment.md) - [Error responses](https://docs.thisisbud.com/docs/error-responses.md) - [Fair Use Implementation Guide](https://docs.thisisbud.com/docs/fair-use-implementation-guide.md): This guidance should be front of mind when integrating the Bud platform - [Custom headers](https://docs.thisisbud.com/docs/request-custom-headers.md) - [Setup your Customers](https://docs.thisisbud.com/docs/setup-customers.md) - [Use your own User ID](https://docs.thisisbud.com/docs/use-your-own-user-id.md) - [Success responses](https://docs.thisisbud.com/docs/success-responses.md) - [Versioning & deprecations](https://docs.thisisbud.com/docs/versioning.md) - [Webhook setup](https://docs.thisisbud.com/docs/webhook-setup.md) - [Webhooks](https://docs.thisisbud.com/docs/payment-webhooks.md): Use webhooks to be notified when Payments change state - [Payment Status Updated](https://docs.thisisbud.com/docs/payment-status-updated.md): payment.status.updated - [Scheduled Payment Status Updated](https://docs.thisisbud.com/docs/scheduled-payment-status-updated.md): scheduled_payment.status.updated - [Standing Order Status Updated](https://docs.thisisbud.com/docs/standing-order-status-updated.md): standing_order.status.updated - [Payments coverage table](https://docs.thisisbud.com/docs/payments-coverage-table.md) - [Payments sandbox credential(s)](https://docs.thisisbud.com/docs/payments-sandbox-credentials.md) - [Setup payments](https://docs.thisisbud.com/docs/setup-bud-payments.md) - [Setup Payments with your own license](https://docs.thisisbud.com/docs/setup-payments-with-your-own-license.md) - [Contact support](https://docs.thisisbud.com/docs/contact-support.md) - [Start here](https://docs.thisisbud.com/docs/console-get-started.md) - [Get access to Bud API](https://docs.thisisbud.com/docs/get-access-to-bud.md) - [OpenAPI spec and libraries](https://docs.thisisbud.com/docs/openapi-spec-and-libraries.md) - [Postman collection quick start](https://docs.thisisbud.com/docs/postman-collection.md) ## API Reference - [Delete Buckets](https://docs.thisisbud.com/reference/aggregations_v2_bucket_delete.md) - [Retrieve Bucket](https://docs.thisisbud.com/reference/aggregations_v2_bucket_get.md): Retrieve the definition of a bucket, and retrieve helper metadata which can be used for presenting options to customers. For example, the `metadata.category_lookup` property can be used to show a dialog box to customers for the customers to be able to correct their transactions (using the [Correct Transaction Categories V2](https://docs.thisisbud.com/reference/corrections_v2_categories_post)), and using the correct `category_l1/category_l2` pair. - [Update Bucket](https://docs.thisisbud.com/reference/aggregations_v2_bucket_put.md): Update an existing bucket (overwrites all content). - [Retrieve Bucket Totals](https://docs.thisisbud.com/reference/aggregations_v2_bucket_totals_get.md): Retrieve the totals of a defined bucket for a particular customer. Use the `group_by` property to configure how the totals are grouped together (e.g. by `bucket_l1`, by `month`, etc...) - [Retrieve All Buckets](https://docs.thisisbud.com/reference/aggregations_v2_buckets_get.md): Retrieve the top-level definitions of buckets you have created. Use this to retrieve the IDs of buckets to then retrieve their individual definitions and totals for customer transactions. - [Create Buckets](https://docs.thisisbud.com/reference/aggregations_v2_buckets_post.md): Create a new bucket, which can be used to group transactions for totals. - [Retrieve Customer Application URL](https://docs.thisisbud.com/reference/v1_customer_applications_customer_links_post.md): Allow customers to share their account information in relation to a specific application. A URL is provided in the response, which is to be given to the customer for them to follow in order to share their information. If a valid email is specified in the request, Bud will automatically send an email to the customer with the link embedded, and with instructions for the customer to proceed. This email will also override/set the `metadata.customer_email` property on the customer application. - [Delete Customer Application](https://docs.thisisbud.com/reference/v1_customer_application_delete.md): Delete an individual customer's application, and all financial data associated with it. - [Retrieve Customer Application](https://docs.thisisbud.com/reference/v1_customer_application_get.md): Retrieve an individual customer's application. - [Retrieve Customer Applications](https://docs.thisisbud.com/reference/v1_customer_applications_get.md): Retrieve a list of all your customer applications. - [Create Customer Application](https://docs.thisisbud.com/reference/v1_customer_applications_post.md): Create a new customer application. Applications can hold more data than just the standard Bud Customer information, such as: - Applicant First Name - Applicant Last Name - Names for Secondary Applicants (if this is a joint application) - Key-value pairs for additional metadata you may want to associate to this application (e.g. if the customer is applying for finance, your system may have a product code for the relevant finance product). - [Retrieve Affordability Report](https://docs.thisisbud.com/reference/v1_affordability_report-1.md): Get an overview of a customer's financial status. > โ—๏ธ Deprecation: > > Support will cease for this endpoint on the 31st of August 2025 - please complete your migration to the Retrieve Affordability Report V2 endpoint by that point in time. > For further details, contact your Bud account manager or email help@thisisbud.com. - [Retrieve Affordability Transactions](https://docs.thisisbud.com/reference/v1_affordability_transactions_get-1.md): View the transactions that were used to calculate a customer's Retrieve Affordability Report. > โ—๏ธ Deprecation: > > Support will cease for this endpoint on the 31st of Jan 2025 - please complete your migration to the Retrieve Affordability Transactions V2 endpoint by that point in time. For further details, contact your Bud account manager or email help@thisisbud.com. - [Retrieve Affordability Transactions V2](https://docs.thisisbud.com/reference/v2_affordability_transactions_get-1.md): This is a complimentary endpoint to the Retrieve Affordability Report V2 endpoint. This endpoint is designed to allow clients to retrieve transactions used to generate sections of the V2 affordability report. Transactions returned via this endpoint are filtered based on the criteria provided in the request, and resemble the V2 transaction response format found in the v2_transactions_get endpoint. - [Retrieve Affordability Report V2](https://docs.thisisbud.com/reference/v2_affordability_report.md): Get an overview of a customer's financial status. - [Retrieve a report on a customers unauthorised overdraft.](https://docs.thisisbud.com/reference/insights_beta_report_balance_unauthorised_overdraft_get.md): Endpoint is responsible for returning balance based aggregated transaction breakdowns and insights. The reports are presented in a way that allows for a high level overview of a customers balances. This particular route focuses on customer accounts with unauthorised overdrafts. For transactional analysis of particular aggregate, please refer to the transactions reference found within the `_links` properties. - [Retrieve income/expenditure break down reports](https://docs.thisisbud.com/reference/insights_beta_report_income_expenditure_get.md): Retrieve income/expenditure break down reports. Each report is presented as a total expenditure vs income break down to give a high level overview of a customers spending's in comparison to income. For transactional analysis of particular aggregate, please refer to the transactions reference found within the `_links` properties. - [Retrieve transactions relating to a specific insight report section.](https://docs.thisisbud.com/reference/insights_beta_report_income_expenditure_transactions_get.md): Each report, where appropriate will have a unique reference for that specific aggregated section of the report. using the same parameters used in the call to `insights_beta_report_income_expenditure_get`, in combination with the unique reference, will return the raw transactions list used to produce that aggregation. This is useful if requiring further investigation or analysis. The reference can be found in the `_links` section of the insight reports. NOTE: Alterations to the `to`/`from` query properties will result in an alternative dataset being returned. - [Retrieve a health report on a customers financial profile.](https://docs.thisisbud.com/reference/insights_beta_report_income_health_get.md): Retrieve a list of insights that reflect various health reports based on a customers ingested data. Reports found within this grouping reflect aggregations against a customers income sources. Where feasible, deep aggregate analysis is provided to allow for further insight. For transactional analysis of particular aggregate, please refer to the transactions reference found within the `_links` properties. - [Retrieve transactions relating to a specific insight report section.](https://docs.thisisbud.com/reference/insights_beta_report_income_health_transactions_get.md): Each report, where appropriate will have a unique reference for that specific aggregated section of the report. using the same parameters used in the call to `insights_beta_report_balance_unauthorised_overdraft_get`, in combination with the unique reference, will return the raw transactions list used to produce that aggregation. This is useful if requiring further investigation or analysis. The reference can be found in the `_links` section of the insight reports. NOTE: Alterations to the `to`/`from` query properties will result in an alternative dataset being returned. - [Retrieve merchant-specific breakdown reports.](https://docs.thisisbud.com/reference/insights_beta_report_merchants_get.md): Endpoint is responsible for returning merchant based aggregated transaction breakdowns. The reports are presented in a way that allows for a high level overview of a customers spending habits with specific merchants. For transactional analysis of particular aggregate, please refer to the transactions reference found within the `_links` properties. - [Retrieve transactions relating to a specific insight report section.](https://docs.thisisbud.com/reference/insights_beta_report_merchants_transactions_get.md): Each report, where appropriate will have a unique reference for that specific aggregated section of the report. using the same parameters used in the call to `insights_beta_report_merchants_get`, in combination with the unique reference, will return the raw transactions list used to produce that aggregation. This is useful if requiring further investigation or analysis. The reference can be found in the `_links` section of the insight reports. NOTE: Alterations to the `to`/`from` query properties will result in an alternative dataset being returned. - [Retrieve transactions relating to a specific insight report section.](https://docs.thisisbud.com/reference/insights_beta_report_unauthorised_overdraft_transactions_get.md): Each report, where appropriate will have a unique reference for that specific aggregated section of the report. using the same parameters used in the call to `insights_beta_report_balance_unauthorised_overdraft_get`, in combination with the unique reference, will return the raw transactions list used to produce that aggregation. This is useful if requiring further investigation or analysis. The reference can be found in the `_links` section of the insight reports. NOTE: Alterations to the `to`/`from` query properties will result in an alternative dataset being returned. - [OAuth2](https://docs.thisisbud.com/reference/oauth_token_post.md): This endpoint is used to create access and refresh tokens. The access token is used as a bearer token to authenticate requests to Bud endpoints; the refresh token is used to generate a new access token without the need to supply your client credentials again. The access token usually expires after the `expires_in` time (in seconds) has elapsed. However this is not guaranteed, so it is recomended to integrate such as to handle the `401` response code and refresh the token when it this response code is seen. Refresh tokens typically expire after 24 hours, but this is not guaranteed. > **๐Ÿšง** Recognise the sensitive nature of access tokens. Implement appropriate security measures to prevent unauthorized access. Related Guides: - https://docs.thisisbud.com/docs/authentication - [Retrieve Customer Characteristics - Credit Card](https://docs.thisisbud.com/reference/characteristics_v1_customer_credit_card_get.md): Retrieves detailed information for a customer that marks them as a credit card user. - [Retrieve Customer Characteristics](https://docs.thisisbud.com/reference/characteristics_v1_customer_get.md): Retrieves a collection of characteristics associated with an individual Customer. For data on why an individual characteristic applies to a Customer, use the relevant detailed endpoint. The currently supported characteristics are: | Characteristic | Description | |:---------------|:-----------------------------------------------------------| | `credit_card` | Customer has made credit card repayments | | `loan` | Customer has made loan repayments (excluding credit cards) | | `overdraft` | Customer has paid overdraft fees | | `saver` | Customer has savings transactions | New characteristics will be released and added to this list without a breaking change notice. - [Retrieve Customer Characteristics - Loan](https://docs.thisisbud.com/reference/characteristics_v1_customer_loan_get.md): Retrieves detailed information for a customer that marks them as a loan user. - [Retrieve Customer Characteristics - Overdraft](https://docs.thisisbud.com/reference/characteristics_v1_customer_overdraft_get.md): Retrieves detailed information for a customer that marks them as an overdraft user. - [Retrieve Customer Characteristics - Saver](https://docs.thisisbud.com/reference/characteristics_v1_customer_saver_get.md): Retrieves detailed information for a customer that marks them as a saver. - [Retrieve Authorisation URL](https://docs.thisisbud.com/reference/open_banking_authorisation_url_get.md): Check the status and get the result of an Initiate Provider Authorisation URL task. If the task is not yet completed, the data element will be null. Once the customer has successfully authorised with the ASPSP, Bud will create a task to fetch the relevant data from the ASPSP. The task id created will be passed back within the supplied re-direct url. Please refer to the Check Connection Status endpoint for updates on this fetching process using the task id provided in the redirect URL. - [Initiate Provider Authorisation](https://docs.thisisbud.com/reference/open_banking_authorisation_url_post.md): Request a new Open Banking authorisation url for a specific Customer and provider. This endpoint should be used when using Bud as a Technical Service Provider(TSP). This means that Bud will be using your license (as a registered Account Information Service Provider (AISP)). This will allow you to use your own interface to connect new account(s). A generated consent has a 90 day expiry, to allow for re-authentication to extend this expiry the id of the customers previous consent can be included as the `consent_id` property. This re-authenciation if the customer grants consent would extend the consent by another 90 days. > ๐Ÿ“˜ Note: > > For more information about Consents, please refer to our [guide](https://docs.thisisbud.com/docs/consents). - [Retrieve Connection Status](https://docs.thisisbud.com/reference/open_banking_connect_get.md): Check the status of an account connection task. If the task is not yet completed, the status will be shown as pending. If the status is completed, then the data is ready to be ingested. The __connection_task_id__ is provided as a parameter in the redirect url after the Customer has undergone a successful authorisation with a relevant Open Banking provider. - [Retrieve OB Providers](https://docs.thisisbud.com/reference/open_banking_providers_get.md): List the available account providers with their name, icon and maintenance status. - [Submit Authorisation Codes](https://docs.thisisbud.com/reference/v1_open_banking_authorisation_codes_post.md): When using Bud as a TSP (Technical Service Provider) and doing full app-to-app authorisation, the customer is returned from the provider directly back to your app. Your app will then need to send all the query and hash fragment parameters to Bud so that we can complete the connection. Query and fragment parameters should be merged with query taking precedence. If you receive a request `/path?a=1#a=2&b=3` then you should perform this request with `{"a":"1","b":"3"}`. Given the nature of the fragment queries most server side languages will not process these so javascript may be required to correctly gather both parameters. Regardless of what parameters are present, all of them should be sent to Bud so that we can choose to either continue the connection or to map and record the error. Code and error are shown here only because they are the most common parameters you will see, but this object could contain any number of unspecified properties. Currently state is a common property among all authorisation flows and is the current task ID. The state property is not guaranteed for the future of this API contract and will not be treated as backwards incompatible if a new authentication flow does not use it. - [Retrieve Authorisation Gateway URL (v2)](https://docs.thisisbud.com/reference/v2_ob_authorisation_gateway_url_post.md): Allow customers to authorise with, and connect to, a provider, using Budโ€™s __Bud Connect__. Bud Connect is a UI component hosted by Bud that can be integrated into any mobile or web experience, and allows your customers to connect to and authorise with their chosen provider, allowing Bud to pull their account information using Bud's AISP license. Using the different configuration options that can be set through the request body you can personalize the experience for your Customer. Please, refer to the documentation below for more information about the available configurations. Use Budโ€™s Authorisation Gateway (__Bud Connect__) if you are not regulated as an AISP in order to connect your customers to their banks to share account information. You may still choose to use __Bud Connect__ in order to give the customer a slick account connection experience or to speed up your technical build and integration, even if you are a regulated AISP yourself. The status of the authorisation step will be provided to you as a path parameter within the `redirect_url` specified within the request payload. This `redirect_url` is where your customer will be redirected to once they have either failed, or successfully completed, the authorisation process with their provider. The URL generated with this endpoint is valid for up to 30 minutes. We suggest to generate the URL right before redirecting your Customer to it. Please note that in order to recieve status updates on a given account connection task, you will need to configure your Callback URL within the developer console. Once the entire connection process has been completed and the customer's account information is ready to be collected, Bud will send a request to your callback URL. - [Submit Authorisation Codes V2](https://docs.thisisbud.com/reference/v2_open_banking_authorisation_codes_post.md): When using Bud as a TSP (Technical Service Provider) and doing full app-to-app authorisation, the customer is returned from the provider directly back to your app. Your app will then need to send all the query and hash fragment parameters to Bud so that we can complete the connection. Query and fragment parameters should be merged with query taking precedence. If you receive a request `/path?a=1#a=2&b=3` then you should perform this request with `{"a":"1","b":"3"}`. Given the nature of the fragment queries most server side languages will not process these so javascript may be required to correctly gather both parameters. Regardless of what parameters are present, all of them should be sent to Bud so that we can choose to either continue the connection or to map and record the error. Code and error are shown here only because they are the most common parameters you will see, but this object could contain any number of unspecified properties. Currently state is a common property among all authorisation flows and is the current task ID. The state property is not guaranteed for the future of this API contract and will not be treated as backwards incompatible if a new authentication flow does not use it. This endpoint triggers an asynchronous collection of OpenBanking data within the Bud platform. Therefore after calling this endpoint the [Retrieve Connection Status](/reference/open_banking_connect_get) endpoint should be called to retrieve the status of the collection - [Ingest Accounts](https://docs.thisisbud.com/reference/v2_ingest_accounts_post.md): This endpoint is for pushing customer(s) account(s) and balance(s) through the Bud architecture. It can ingest data for multiple customers per request. By default, this is synchronous and will report any issue with the data in the response. If a 'X-Disable-Synchronous' header is present and set to true, the process will create a task in the background and be entirely 'non-blocking'. In this scenario, the response metadata will contain a Task ID and the next URL which would then be used for finding out the operation's result. - [Ingest Transactions](https://docs.thisisbud.com/reference/v2_ingest_transactions_post.md): This endpoint should be used to ingest customer transactions into the Bud Platform. By default, this endpoint is synchronous but can be easily switched to asynchronous using the 'X-Disable-Synchronous' header. Please refer to the following [guide](https://docs.thisisbud.com/docs/setup_data_enrichment) to ensure you set up First Party Ingestion correctly for your organisation based on your use case. We accept a maximum of 1.000 transactions. If this threshold is not respected, a 400 error is returned. We support the ingestion of transactions for multiple customers as part of the same request. The detailed location enrichment response is an additional addon, otherwise only tokens are returned (read more about this in the location [guide](https://docs.thisisbud.com/docs/locations)). An ingestion request with an empty transaction list and provided transaction windows will be treated as a request to clear persisted transactions in the specified windows. > ๐Ÿ“˜ Note: > > The enrichment values returned in the synchronous response of this endpoint may differ from those returned when fetching the ingested data from __Retrieve Transactions V2__. > > The synchronous response provides an initial enrichment based solely on the submitted transaction data. During asynchronous ingestion, the data is re-enriched using the customer's existing transaction history and additional enrichment services, producing a more accurate and comprehensive result. - [Close Accounts](https://docs.thisisbud.com/reference/v3_ingest_accounts_close_post.md): Close one or more accounts for a given customer. This will set the account status to closed and set the `closed_at` field on the __Retrieve Accounts V3__ response. If an account is already closed, then the request will be ignored, and the `closed_at` field will remain unchanged. If a 400 response is returned, any accountIDs or customerIDs __not__ defailted in the error response will have been closed succesfully. - [Reopen Accounts](https://docs.thisisbud.com/reference/v3_ingest_accounts_reopen_post.md): Reopen one or more accounts for a given customer. This will remove the account status and `closed_at` fields on the __Retrieve Accounts V3__ response. If an account is already open, then the request will be ignored and the account is unchanged. If a 400 response is returned, any accountIDs or customerIDs __not__ defailted in the error response will have been reopened succesfully. - [Retrieve Ingestion Task Status](https://docs.thisisbud.com/reference/v3_ingest_status_get.md): Check the status of an ingest request. Please note that this works for both the Ingest Transactions endpoints And Ingest Accounts endpoints. Reports status of the ingestion task, with details for each subtask (1 per customer). - [Book Transactions](https://docs.thisisbud.com/reference/v3_ingest_transactions_book_post.md): The Book Transactions endpoint, allows transactions ingested with a `status` of `pending` to set their status to `booked`. The date_time field indicates the timestamp when the transaction booked. This is reflected in the `date_time` of __Retrieve Transactions V2__. - [Decline Transactions](https://docs.thisisbud.com/reference/v3_ingest_transactions_decline_post.md): The Decline Transactions endpoint, allows transactions ingested with a `status` of `pending` to set their status to `declined`. The date_time field indicates the timestamp when the transaction declined. This is reflected in the `date_time` of __Retrieve Transactions V2__. - [Retrieve Revoke Consent Status](https://docs.thisisbud.com/reference/open_banking_account_access_consent_revoke_get.md): Check the status and result of a Revoke Consent task. Use the `task_id` taken from a successful `Initiate Revoke Consent` request. - [Initiate Revoke Consent](https://docs.thisisbud.com/reference/open_banking_account_access_consent_revoke_post.md): Start a task to remove consent and remove Budโ€™s ability to download further information for a specified customer account. This will revoke `all` the consents for the specified provider associated to the customer. To check the status of this task, use the `Retrieve Revoke Consent Status` using the returned `task_id`. Alternatively, there is a `Open Banking Consent Revoked` webhook that will trigger per consent successfully revoked. As such this task could generate multiple of these. - [Retrieve Customer Consents](https://docs.thisisbud.com/reference/open_banking_connections_get.md): Retrieve the list of all available Open Banking consents granted by the customer. > ๐Ÿ“˜ Note: > > For more information about Consents, please refer to our [guide](https://docs.thisisbud.com/docs/consents). - [Reconfirm Consent](https://docs.thisisbud.com/reference/open_banking_consents_reconfirm_post.md): Reconfirm a customer's consent to extend the expiration date by 90 days. If the provider requires SCA authentication or the consent status is not showing "Authorised" or the consent is expired, the `reconnect_required` flag will show as true. If true, you should make a call to the Retrieve Authoirsation Gateway URL endpoint with the `reconfirm_consent` flag set to true to direct your customer to the reconfirm consent journey. If false, the consent has been extended. > ๐Ÿ“˜ Note: > > This endpoint should only be used by TSP clients (Technical Service Provider). > > Requests to this endpoint from TPP clients (Third Party Provider) will fail, i.e. you are not yourself regulated as an PISP (Payment Initiation Service Provider). > > > For more information about Consents, please refer to our [guide](https://docs.thisisbud.com/docs/consents). - [Retrieve Refresh Status](https://docs.thisisbud.com/reference/open_banking_refresh_get.md): Check the status of an account information refresh task. If the task is not yet completed, the status will be shown as pending. If the status is completed, then the data is ready to be collected via the [Retrieve Financial Data](/reference/retrieve-financial-data) endpoints. Successful requests will include `step` (1-4) and associated `text` values to indicate the current progress of the refresh task. Make sure to check the status of the task till completion before trying to access the Customer's data or initiating another process. When the task is successful, we include in the response body a `metadata.has_new_transactions` boolean attribute that tells you if the refresh resulted in storing new data. This attribute must be used to decide if it's necessary to pull the Customer's data or not. When the refresh fails, we include the reason of the failure as part of the `data.result` attribute. We also include the `data.reconnect_required` boolean attribute that indicates if the consent used to fetch the data for this customer and provider is no longer valid. If reconnect_required is true, the customer will need to go through the bank account connection flow again. - [Initiate Refresh](https://docs.thisisbud.com/reference/open_banking_refresh_post.md): Instruct Bud to retrieve the latest account information for a customer. Refresh the accounts from a single provider with an existing connection. By default this task will retrieve transactions since the last pull of transactions less seven days. This can be overridden using the `from` body parameter to a maximum of 90 days previously. After initiating this long running process, make sure to check the status of the it till completion before trying to access the Customer's data or initiating another refresh. If the customer's provider was fetched (connect or refresh) within the last hour, the endpoint will return the task_id of the previous task instead of refreshing the data again. If the customer's consent has been revoked or expired for this provider, Bud will be unable to refresh the account. This will be confirmed in the response of the refresh status endpoint associated with the `task_id` provided in the response to this endpoint, where the `reconnect_required` field will set to `true` and status set to `Completed`. - [Retrieve Refresh Status V2](https://docs.thisisbud.com/reference/v2_open_banking_refresh_get.md): Check the status of an account information refresh task. If the task is not yet completed, the status will be shown as pending. If the status is completed, then the data is ready to be collected via the [Retrieve Financial Data](/reference/retrieve-financial-data) endpoints. To monitor the status of a refresh task we provide two methods. The preferred approach is to utilise the webhook functionality within the Bud platform where Bud will send a webhook to your configured endpoint when the task completes. Alternatively you can poll this endpoint to retrieve the status of the task. Please ensure that you either receive a webhook with a status of `Completed` and result of `success` or this endpoint returns a status of `Completed` and result of `success` before trying to access the Customer's data or initiating another process. When the task is successful, we include in the response body a `metadata.has_new_transactions` boolean attribute that tells you if the refresh resulted in storing new data. This attribute must be used to decide if it's necessary to pull the Customer's data or not. When the refresh fails, we include the reason of the failure as part of the `data.result` attribute. We also include the `data.sub_tasks[i].reconnect_required` boolean attribute that indicates if the consent used to fetch the data for this customer and provider is no longer valid. If reconnect_required is true, the customer will need to go through the bank account connection flow and the consent will be marked as revoked. When only a subset of sub tasks fails the main task will be marked as `Failed` but for each provider where the refresh was successful (result is equal to `success`) customers data will be updated and available from the [Retrieve Financial Data](/reference/retrieve-financial-data) endpoints. In the case of a partial success you are able to specify the `providers` body parameter to the [Initiate Refresh V2](/reference/v2_open_banking_refresh_post) endpoint to initiate a refresh for the failing provider(s). - [Initiate Refresh V2](https://docs.thisisbud.com/reference/v2_open_banking_refresh_post.md): Instruct Bud to retrieve the latest account information for a customer. Refresh the accounts from all providers with an existing connection. By default this task will retrieve transactions since the last pull of transactions less seven days. This can be overridden using the `from` body parameter to a maximum of 90 days previously. On completion of this task Bud will send a webhook to your configured endpoint including details of the refresh completed and the status of the refresh for each provider. Alternatively the status of the task can be checked using the Retrieve Refresh Status V2 endpoint. Please check that the task has completed successfully before trying to access the Customer's data or initiating another refresh. If a similar refresh (same providers) for this customer has been initiated within the last hour, the endpoint will return the task_id of the previous task instead of refreshing the data again. If the customer's consent has been revoked or expired for a provider, Bud will be unable to refresh the customers account at that provider. This will be confirmed in the response of the refresh status endpoint associated with the `task_id` provided in the response to this endpoint, where the `reconnect_required` field will set to `true` and status set to `Completed`. If the consent within the Bud system was marked as `Authorised` at this point the consent will be updated to `Revoked` To simplify your integration Bud is able to take control of your background refreshes and manage these regularly for you. Full details can be found on the following [guide](https://docs.thisisbud.com/docs/open-banking-hosted-refreshes) - [Create Customer](https://docs.thisisbud.com/reference/customers_create_v1.md): This endpoint is used to create a new Customer in order for them to consume the Bud services. **Please note: this endpoint is now deprecated, please migrate to using the POST /v2/customers endpoint.** - [Create Customer(s)](https://docs.thisisbud.com/reference/customers_create_v2.md): This endpoint is used to create one or many new Customers, in order for them to consume the Bud services. - [Remove Customer](https://docs.thisisbud.com/reference/customers_delete.md): This endpoint is used to delete an existing Customer. Calling this deletes all data associated with the customer including any Open Banking Consents. If the customer with the given ID does not exist or has already been deleted, a 404 error is returned. - [Create Customers V3 (Batch)](https://docs.thisisbud.com/reference/platform_v3_customers_batch_post.md): This endpoint is used to create a batch of new Customers in order for them to consume the Bud services. For more information on Customers in the Bud platform, please refer to our handy [guide](https://docs.thisisbud.com/docs/setup-customers). - [Retrieve Remove Customer V3 Status](https://docs.thisisbud.com/reference/platform_v3_customers_delete_status.md): Check the status and get the result of a Remove Customer V3 task. - [Remove Customer V3](https://docs.thisisbud.com/reference/platform_v3_customers_delete.md): This endpoint is used to delete an existing Customer. Calling this endpoint initiates deleting all data relating to a customer returning a task id that can be used to check the status of the delete task. - [Retrieve Customers V3](https://docs.thisisbud.com/reference/platform_v3_customers_get.md): This endpoint is used to list customers associated with the current project. Customers are listed ordered by their ID. Deleted customers will not be included in the list. The list of customers can be filtered by creation date with the `date_from` and `date_to` query parameters, which expect dates in the RFC3339 format. If more results pages are available, the response metadata object will contain a `next_page_token` field which can be used to fetch the next page of results. The token should be provided in the `page_token` query parameter for subsequent requests. For more information on how to manage your Bud Customers, please, refer to the following [guide](https://docs.thisisbud.com/docs/setup-customers) - [Remove Customer By Idempotent Identifier V3](https://docs.thisisbud.com/reference/platform_v3_customers_idempotent_identifier_delete.md): This endpoint is used to delete an existing Customer. Calling this endpoint initiates deleting all data relating to a customer returning a task id that can be used to check the status of the delete task. - [Create Customer V3](https://docs.thisisbud.com/reference/platform_v3_customers_post.md): This endpoint is used to create a new Customer in order for them to consume the Bud services. When we refer to a Customer, we're talking about the end-user of yours and Bud's technology. Customer entities in Bud have unique identifiers and this is used to store the customer data on the Bud platform. For more information on how to manage your Bud Customers, please, refer to the following [guide](https://docs.thisisbud.com/docs/setup-customers) > ๐Ÿ“˜ Note: > > By specifying a `client_metadata.idempotent_identifier` value, Bud will associate that identifier to a Customer, > and in future Bud will return the same Customer entity everytime we receive the same `idempotent_identifier` value. > > This allows you to associate your internal resource to the concept of the Bud Customer. > > On subsequent requests for a customer with a given `idempotent_identifier`, Bud will return a 200 status code instead of a 201. > > Please, make sure the `idempotent_identifier` is immutable on your application. - [Retrieve Customer Context](https://docs.thisisbud.com/reference/v1_customer_context_get.md): Retrieve the customer level context, i.e. a set of parameters that defines their language, region and their customer type. - [Update Customer Context](https://docs.thisisbud.com/reference/v1_customer_context_put.md): Updates the customer context. All three body parameters (region, locale, and models) will overwrite any existing values. If a parameter is not provided, it's corresponding context field will be set to empty. - [Retrieve Categories V2](https://docs.thisisbud.com/reference/resources_v2_categories_get.md): Retrieve a list of primary and secondary categories supported by Bud's categorisation model. - [Retrieve Available Categorisation Models V2](https://docs.thisisbud.com/reference/resources_v2_models_get.md): Retrieve the available Bud categorisation models. - [Retrieve Statistics For Essential Total Spend](https://docs.thisisbud.com/reference/aggregations_v2_totals_essential_statistics_get.md): Provides a few useful statistics which allow you to quickly see a customers total essential and non essential spend. Will also allow you to see this spend as a percentage of overall spend. - [Retrieve Category Totals V2](https://docs.thisisbud.com/reference/v2_category_totals_get.md): Provides a customerโ€™s total income and expenditure for each l1 and l2 category, over a given time period. L1 and l2 categories can be filtered using the category query parameter. Example: - 'shopping' - 'shopping.groceries' Each income and expenditure total is separated by currency, as we cannot sum totals in different currencies. - [Retrieve Category Totals Trends](https://docs.thisisbud.com/reference/v2_category_totals_trends_get.md): Provides category totals for desired categories over a given time period of time with a given granularity. L1 and l2 categories can be filtered using the category query parameter. Example: - 'shopping' - 'shopping.groceries' Each income and expenditure total is separated by currency, as we cannot sum totals in different currencies. Can be used for producing graphs of category totals over time. - [Retrieve Merchant Totals V2](https://docs.thisisbud.com/reference/v2_merchants_totals_get-1.md): Provides a customerโ€™s total debit and credit amounts for each merchant. - [Correct Transaction Categories V2](https://docs.thisisbud.com/reference/corrections_v2_categories_post.md): Allow a customer to change a transactionโ€™s (and similar transactions') category and/or subcategory. If `include_similar` is set to `true`, then all previous and future transactions (i.e. those that are yet to happen yet) that are similar in nature to the specified transaction id will be corrected with the provided category and/or subcategory. Similar transactions are determined based on transactions with similar descriptions & amounts. - [Fetch custom merchants for customer](https://docs.thisisbud.com/reference/corrections_v2_custom_merchants_get.md): Retrieves custom merchants for a given customer - [Create a new custom merchant](https://docs.thisisbud.com/reference/corrections_v2_custom_merchants_post.md): Creates a new custom merchant for use in the merchant corrections flow. - [Suggests changes to a merchant](https://docs.thisisbud.com/reference/corrections_v2_merchant_feedback_post.md): Records feedback we can use to improve our merchant database. - [Correction Merchant Search](https://docs.thisisbud.com/reference/corrections_v2_merchant_search_get.md): Allows a customer to find a merchant to be used for a correction. - [Correct Transaction Merchant](https://docs.thisisbud.com/reference/corrections_v2_merchants_post.md): Allow a customer to change a transactionโ€™s (and similar transactions') merchant. If `include_similar` is set to `true`, then all previous and future transactions (i.e. those that are yet to happen yet) that are similar in nature to the specified transaction id will be corrected with the provided merchant. Similar transactions are determined based on transactions with similar descriptions & amounts. - [Similar Transactions](https://docs.thisisbud.com/reference/corrections_v2_similar_categories_get.md): This endpoint is used to find similar transactions to the *source* transaction. Similar transactions are determined based on transactions with similar descriptions & amounts to the source transaction. There will **not** be any duplicate transactions in the response. Use the `exclude_source` query parameter to toggle whether the endpoint returns the source transaction in the response. By **default** it will. For example if there are **no** similar transactions to transaction A: > `exclude_source = true` >> The response will contain **0** transactions > `exclude_source = false` or not present (**default**) >> The response will contain **1** transaction, that being the source transaction A - [Similar Transactions Including Merchants](https://docs.thisisbud.com/reference/corrections_v2_similar_merchants_get.md): This endpoint is used to find similar transactions to the *source* transaction. Similar transactions are determined based on transactions with similar descriptions & amounts to the source transaction. In addition, transactions that also have the same merchant are returned. There will **not** be any duplicate transactions in the response. Use the `exclude_source` query parameter to toggle whether the endpoint returns the source transaction in the response. By **default** it will. For example if there are **no** similar transactions to transaction A: > `exclude_source = true` >> The response will contain **0** transactions > `exclude_source = false` or not present (**default**) >> The response will contain **1** transaction, that being the source transaction A - [Remove Provider Data](https://docs.thisisbud.com/reference/v1_provider_delete-1.md): Delete all data (transactions, enrichments, accounts) related to the specified provider. - [Remove Account Data V2](https://docs.thisisbud.com/reference/v2_account_delete.md): Delete all data (including transactions and balances) related to the specified account. - [Unassign Transaction Label](https://docs.thisisbud.com/reference/v2_transaction_labels_delete.md): Remove a customer-defined label from a transaction. The label itself is not deleted; use __Delete Transaction Label__ to remove the label entirely. - [Assign Transaction Label](https://docs.thisisbud.com/reference/v2_transaction_labels_post.md): Attach a customer-defined label to a transaction. The label must already exist for the customer (create one with __Create Transaction Label__). - [Delete Transaction Label](https://docs.thisisbud.com/reference/financial_v2_labels_delete.md): Delete an existing transaction label owned by the authenticated customer. The label is removed from any transactions it was attached to. - [Retrieve Transaction Labels](https://docs.thisisbud.com/reference/financial_v2_labels_get.md): List all transaction labels owned by the authenticated customer. - [Rename Transaction Label](https://docs.thisisbud.com/reference/financial_v2_labels_patch.md): Rename an existing transaction label owned by the authenticated customer. Label names are case-insensitively unique per customer; an attempt to rename to a name that already exists returns `409`. - [Create Transaction Label](https://docs.thisisbud.com/reference/financial_v2_labels_post.md): Create a new transaction label for the authenticated customer. Label names are case-insensitively unique per customer; an attempt to create a label with a name that already exists returns `409`. - [Retrieve Account By ID V2](https://docs.thisisbud.com/reference/financial_v2_accounts_account_id.md): Retrieves a customer's connected account by its ID. > โ—๏ธ Deprecation: > > Support will cease for this endpoint on the 1st of April 2025 - please complete your migration to the Retrieve Accounts V3 endpoint by that point in time. For further details, contact your Bud account manager or email help@thisisbud.com. - [Retrieve Balances Over Time By Account](https://docs.thisisbud.com/reference/financial_v2_accounts_balances_get.md): > โ—๏ธ Deprecation: > > Support will cease for this endpoint on the 1st of April 2025 - please complete your migration to the Retrieve Balances Over Time By Account V3 endpoint by that point in time. For further details, contact your Bud account manager or email help@thisisbud.com. List the balances of a specific bank account for a customer across all ingestion sources. Ordered by balance date. It calculates the balance for each date, by iterating from the date the account was last refreshed to the `to` and `from` dates provided. It then checks all the transactions within this range, calculating the balance at the end of each day. This endpoint limits the date from which it gets balances by the oldest `transaction_window` on the account. If `transaction_windows` are not present, it is not possible to calculate balances and the endpoint returns an empty list. You can only request balances within transaction windows, therefore if you ingest transactions without a transaction window, you won't be able to request balance for that time range. However those transactions will be used to calculate the balance as well. For users ingesting data via the `Ingest Accounts` endpoint, you can increase the range and accuracy of the data supplied from this service by including the transaction_window field upon account ingestion. Results are limited to up to 5000 balance items. - [Retrieve Accounts V2](https://docs.thisisbud.com/reference/financial_v2_accounts.md): Retrieves a list of a customer's connected accounts. The result can be filtered using the parameters outlined below. > โ—๏ธ Deprecation: > > Support will cease for this endpoint on the 1st of April 2025 - please complete your migration to the Retrieve Accounts V3 endpoint by that point in time. For further details, contact your Bud account manager or email help@thisisbud.com. - [Retrieve Authorised Payments V2](https://docs.thisisbud.com/reference/financial_v2_authorised_payments_get.md): Retrieves a list of a customer's authorised payments. Currently supported authorised payment types include (but are not necessarily limited to): - direct debits - standing orders - scheduled payments > ๐Ÿ“˜ Note: > > Not all providers support authorised payments - [Retrieve Balances Over Time](https://docs.thisisbud.com/reference/financial_v2_balances_get.md): > โ—๏ธ Deprecation: > > Support will cease for this endpoint on the 1st of April 2025 - please complete your migration to the Retrieve Balances Over Time V3 endpoint by that point in time. For further details, contact your Bud account manager or email help@thisisbud.com. List the balances of each bank account for a customer across all ingestion sources. Ordered by balance date. It calculates the balance for each date, by iterating from the date the account was last refreshed to the `to` and `from` dates provided. It then checks all the transactions within this range, calculating the balance at the end of each day. This endpoint limits the date from which it gets balances by the oldest `transaction_window` on the account. If `transaction_windows` are not present, it is not possible to calculate balances and the endpoint returns an empty list. You can only request balances within transaction windows, therefore if you ingest transactions without a transaction window, you won't be able to request balance for that time range. However those transactions will be used to calculate the balance as well. For users ingesting data via the `Ingest Accounts` endpoint, you can increase the range and accuracy of the data supplied from this service by including the transaction_window field upon account ingestion. Results are limited to up to 5000 balance items across all accounts. - [Retrieve Account By ID V3](https://docs.thisisbud.com/reference/financial_v3_accounts_account_id_get.md): Retrieves a customer's connected account by its ID. > ๐Ÿ“˜ Note: > > For more information on the Account object, please refer to our handy [guide](https://docs.thisisbud.com/docs/accounts). - [Retrieve Balances Over Time By Account V3](https://docs.thisisbud.com/reference/financial_v3_accounts_balances_get.md): List the balances of a specific bank account for a customer across all ingestion sources. Ordered by balance date. It calculates the balance for each date, by iterating from the date the account was last refreshed to the `to` and `from` dates provided. It then checks all the transactions within this range, calculating the balance at the end of each day. This endpoint limits the date from which it gets balances by the oldest `transaction_window` on the account. If `transaction_windows` are not present, it is not possible to calculate balances and the endpoint returns an empty list. You can only request balances within transaction windows, therefore if you ingest transactions without a transaction window, you won't be able to request balance for that time range. However those transactions will be used to calculate the balance as well. For users ingesting data via the `Ingest Accounts` endpoint, you can increase the range and accuracy of the data supplied from this service by including the transaction_window field upon account ingestion. The balances selected to use as latest pending & latest booked in the calculation are selected according to a provider specific balance type priority list. Results are limited to up to 5000 balance items. - [Retrieve Accounts V3](https://docs.thisisbud.com/reference/financial_v3_accounts_get.md): Retrieves a list of a customer's connected accounts. The result can be filtered using the parameters outlined below. > ๐Ÿ“˜ Note: > > For more information on the Account object, please refer to our handy [guide](https://docs.thisisbud.com/docs/accounts). - [Retrieve Account Transaction Dates](https://docs.thisisbud.com/reference/financial_v3_accounts_transaction_dates_get.md): Retrieves a summary listing the first and last transaction per customer's accounts. - [Retrieve Balances Over Time V3](https://docs.thisisbud.com/reference/financial_v3_balances_get.md): List the balances of each bank account for a customer across all ingestion sources. Ordered by balance date. It calculates the balance for each date, by iterating from the date the account was last refreshed to the `to` and `from` dates provided. It then checks all the transactions within this range, calculating the balance at the end of each day. This endpoint limits the date from which it gets balances by the oldest `transaction_window` on the account. If `transaction_windows` are not present, it is not possible to calculate balances and the endpoint returns an empty list. You can only request balances within transaction windows, therefore if you ingest transactions without a transaction window, you won't be able to request balance for that time range. However those transactions will be used to calculate the balance as well. For users ingesting data via the `Ingest Accounts` endpoint, you can increase the range and accuracy of the data supplied from this service by including the transaction_window field upon account ingestion. The balances selected to use as latest pending & latest booked in the calculation are selected according to a provider specific balance type priority list. Results are limited to up to 5000 balance items across all accounts. - [Retrieve Transactions V2](https://docs.thisisbud.com/reference/v2_transactions_get.md): List the Transactions for a customer across all ingestion sources and accounts. Ordered by `date_time` and then `transaction_id` descending. They are also provided with Enrichments - contextual information generated by Bud's artificial intelligence models. Enrichments are optional because not all Enrichments are relevant to all Transactions, or because they did not have enough information to generate enrichments (e.g. pending Transactions). The Enrichment process also generates tags, which can be used for filtering using the `include_tags` and `exclude_tags` query parameters. - [Remove Savings Goal V2](https://docs.thisisbud.com/reference/goals_v2_savings_goal_delete.md): Remove a savings goal with the given `savings_goal_id`. - [Retrieve Savings Goal V2](https://docs.thisisbud.com/reference/goals_v2_savings_goal_get.md): Retrieve a savings goal by its `savings_goal_id`. The `goal_balance` is calculated as the current account balance multiplied by the `allocation_ratio`. - [Update Savings Goal V2](https://docs.thisisbud.com/reference/goals_v2_savings_goal_patch.md): Update a savings goal with the given `savings_goal_id`. All fields are optional. The `goal_balance` returned in the response is recalculated as the current account balance multiplied by the updated `allocation_ratio`. - [Create Savings Goal V2](https://docs.thisisbud.com/reference/goals_v2_savings_goal_post.md): Create a savings goal for the given account. The `allocation_ratio` defines the proportion of the account balance that is considered allocated to this goal. For example, an `allocation_ratio` of `0.2` means that 20% of the account balance is treated as the goal balance. The `goal_balance` returned in the response is calculated as the current account balance multiplied by the `allocation_ratio`. - [Retrieve Savings Goals V2](https://docs.thisisbud.com/reference/goals_v2_savings_goals_get.md): Retrieve all savings goals for the customer. The results can be filtered by the `account_id` query parameter. The `goal_balance` for each goal is calculated as the current account balance multiplied by the `allocation_ratio`. - [Retrieve Spending Budget Transactions](https://docs.thisisbud.com/reference/goals_v1_spending_budget_transactions_get.md): Retrieve all of the transactions associated with a spending budget. The results of this endpoint are paginated with a default page size of `100` and a maximum of `200`. The page size is configurable by the `page_size` query parameter. The next page of results can be retrieved using the `page_token` query parameter. Account IDs can be supplied as part of the URL query to filter transactions to those only associated with the specified accounts. If no account IDs are specified, we will return transactions associated with all of the customer's accounts, relevant to the spending budget. - [Delete all Spending Budgets](https://docs.thisisbud.com/reference/goals_v1_spending_budgets_delete_all.md): Delete all of a customers' spending budgets. - [Delete a Spending Budget](https://docs.thisisbud.com/reference/goals_v1_spending_budgets_delete.md): Delete a specific spending budget with the given `budget_id` - [Retrieve Spending Budgets](https://docs.thisisbud.com/reference/goals_v1_spending_budgets_get.md): Retrieve all spending budgets. Accounts IDs can be supplied as part of the URL query to return budgets with values filtered to the accounts IDs supplied. These budgets' spent amounts will only consider transactions associated with the specified accounts. If no account IDs are specified, the returned budgets will have a value combined from transactions across all of the customer's accounts. - [Patch a Spending Budget](https://docs.thisisbud.com/reference/goals_v1_spending_budgets_patch.md): Update a Spending Budget with a given `budget_id`. - [Create Spending Budget](https://docs.thisisbud.com/reference/goals_v1_spending_budgets_post.md): Create a spending budget. - [Detail the transactions used to generate a custom insight](https://docs.thisisbud.com/reference/custom_insight_v1_detail_get.md): This endpoint will return some transactions used to determine the custom insight. More specifically it will return transactions filtered for in the WHERE expression of the custom insight query. - [Delete all existing custom insights](https://docs.thisisbud.com/reference/custom_insight_v1_manage_delete_all.md): Permanently deletes all custom insight queries - [Delete existing custom insight](https://docs.thisisbud.com/reference/custom_insight_v1_manage_delete.md): Permanently deletes a custom insight query - [List existing custom insights](https://docs.thisisbud.com/reference/custom_insight_v1_manage_get.md): Retrieve a list of created custom insights, if they are currently active, and when they were created - [Update existing custom insight](https://docs.thisisbud.com/reference/custom_insight_v1_manage_patch.md): Patches a custom insight, updating the query, or setting it to active/inactive - [Create new custom insight](https://docs.thisisbud.com/reference/custom_insight_v1_manage_post.md): Create a custom insight to be applied to all customers upon ingestion or refresh of transactions - [Retrieve custom insights profile](https://docs.thisisbud.com/reference/custom_insight_v1_profile_get.md): Lists the insights which applied to a customer at \'created_at\'. To recompute make a call to Build custom insights profile. - [Build custom insights profile](https://docs.thisisbud.com/reference/custom_insight_v1_profile_post.md): Manually builds a custom insight profile for a customer, is automatically called after successful ingestion and enrichment. - [Generate Accounts URL](https://docs.thisisbud.com/reference/insights_v1_accounts_url_post.md): Generates a URL to access the customer's account. - [Generate Balances Over Time URL](https://docs.thisisbud.com/reference/insights_v1_balances_over_time_url_post.md): Generates a URL to access the customer's balances over time. - [Generate Financial Calendar URL](https://docs.thisisbud.com/reference/insights_v1_financial_calendar_url_post.md): Generates a URL to access the customer's financial calendar. - [Generate Intelligent Search Widget URL](https://docs.thisisbud.com/reference/insights_v1_intelligent_search_url_post-1.md): Generates a URL to a frontend to allow searching a customers transactions. - [Generate Recurring and Forecasted Transactions URL](https://docs.thisisbud.com/reference/insights_v1_recurring_and_forecasted_transactions_url_post.md): Generates a URL to access the customer's recurring and forecasted transactions. - [Generate Savings Goals URL](https://docs.thisisbud.com/reference/insights_v1_savings_goals_url_post.md): Generates a URL to access the customer's savings goals. - [Generate Spending Analysis URL](https://docs.thisisbud.com/reference/insights_v1_spending_analysis_url_post.md): Generates a URL to access the customer's spending analysis. - [Generate Spending Budgets URL](https://docs.thisisbud.com/reference/insights_v1_spending_budgets_url_post.md): Generates a URL to access the customer's spending budgets. - [Generate Card Summary URL](https://docs.thisisbud.com/reference/insights_v1_summary_url_post.md): Generates customer's weekly summary insights. - [Retrieve Balances Actionable Insight Details](https://docs.thisisbud.com/reference/insights_v1_actionable_balances_details_get.md): Retrieve insight-specific details and transaction and account data responsible for the triggered balances insight of the given type and ID. > ๐Ÿ“˜ Note: > > For more information about Actionable Insights, please refer to our [guide](https://docs.thisisbud.com/docs/actionable-insights). - [Retrieve Balances Actionable Insights](https://docs.thisisbud.com/reference/insights_v1_actionable_balances_get.md): Generate balances actionable insights. > ๐Ÿ“˜ Note: > > For more information about Actionable Insights, please refer to our [guide](https://docs.thisisbud.com/docs/actionable-insights). - [Retrieve Income Actionable Insight Details](https://docs.thisisbud.com/reference/insights_v1_actionable_income_details_get.md): Retrieve insight-specific details and transaction and account data responsible for the triggered income insight of the given type and ID. > ๐Ÿ“˜ Note: > > For more information about Actionable Insights, please refer to our [guide](https://docs.thisisbud.com/docs/actionable-insights). - [Retrieve Income Actionable Insights](https://docs.thisisbud.com/reference/insights_v1_actionable_income_get.md): Generate income actionable insights. > ๐Ÿ“˜ Note: > > For more information about Actionable Insights, please refer to our [guide](https://docs.thisisbud.com/docs/actionable-insights). - [Retrieve Spending Actionable Insight Details](https://docs.thisisbud.com/reference/insights_v1_actionable_spending_details_get.md): Retrieve insight-specific details and transaction and account data responsible for the triggered income insight of the given type and ID. > ๐Ÿ“˜ Note: > > For more information about Actionable Insights, please refer to our [guide](https://docs.thisisbud.com/docs/actionable-insights). - [Retrieve Spending Actionable Insights](https://docs.thisisbud.com/reference/insights_v1_actionable_spending_get.md): Generate spending actionable insights. > ๐Ÿ“˜ Note: > > For more information about Actionable Insights, please refer to our [guide](https://docs.thisisbud.com/docs/actionable-insights). - [Search customer transactions.](https://docs.thisisbud.com/reference/search_beta_transactions_get.md): Finds the most relevant transactions matching the `user_input` text. An initial free text search will then suggest `suggested_searches` which use structured data e.g. `category_l1` or `merchant_name`. At most one of the following query parameters can be used per request, if multiple are set the endpoint will return a `Bad Request` response (if none are set, transactions will be returned with no filtering to facilitate showing an initial transaction list to the user): - `user_input` - `merchant_name` - `category_l1` - `category_l2` - `description` - `tag` This endpoint also provides a link to view an AI-generated insight about the current search. Please wait for the allotted `insight.url_delay` before following this link to avoid unnecessary polling before the insight has been generated. - [Get transaction search insight.](https://docs.thisisbud.com/reference/search_beta_transactions_insight_get.md): Retrieves an AI-generated insight to enrich the output, or answer the question asked in the input to the transaction search. There is no multi-currency support in insights, so the default currency for the customer's region will be assumed. This insight can take some time to generate, so the `status` property can be used in combination with the `Retry-After` response header to poll until the insight is generated (at which point the status will be `success`). **๐Ÿ“˜ Note: Searches are transient. After the search expires (see `metadata.expires_in`), this endpoint will return a `Not Found` response. The recommended behaviour in this case is to resubmit the desired search using the `Search customer transactions` endpoint.** - [Get transactions used by the search insight.](https://docs.thisisbud.com/reference/search_beta_transactions_insight_transactions_get.md): Retrieves transactions used to calculate the AI-generated transaction search insight, to provide explainability for the insight. This insight can take some time to generate, so until the insight is generated (use the insight endpoint to check status), this endpoint will return a `Not Found` response. **๐Ÿ“˜ Note: Searches are transient. After the search expires (see `metadata.expires_in`), this endpoint will return a `Not Found` response. The recommended behaviour in this case is to resubmit the desired search using the `Search customer transactions` endpoint.** - [Get transaction search by ID.](https://docs.thisisbud.com/reference/search_beta_transactions_search_get.md): Retrieves an existing transaction search by its search ID. **๐Ÿ“˜ Note: Searches are transient. After the search expires (see `metadata.expires_in`), this endpoint will return a `Not Found` response. The recommended behaviour in this case is to resubmit the desired search using the `Search customer transactions` endpoint.** - [Create MCP (Model Context Protocol) URL](https://docs.thisisbud.com/reference/beta_bud_api_mcp_url_post.md): Generates a URL and customer specific authentication bearer token for an MCP Client to connect with. Currently in beta - [Retrieve Providers](https://docs.thisisbud.com/reference/v1_payments_providers_get.md): This endpoint is used list the payment service providers (PSPs) supported via Bud's Payment APIs. - [Retrieve Bud Pay URL - Scheduled Payment](https://docs.thisisbud.com/reference/v1_payments_scheduled_bud_pay_url_post.md): Retrieve a Bud Pay URL to initiate a Scheduled Payment. Please note that this endpoint should be used if you are using Bud as a Third Party Provider (TPP), i.e. you are not yourself regulated as an Payment Initiation Service Provider (PISP) - [Retrieve Bud Pay URL - Single Payment](https://docs.thisisbud.com/reference/v1_payments_single_bud_pay_url_post.md): Retrieve a Bud Pay URL to initiate a single payment. Please note that this endpoint should be used if you are using Bud as a Third Party Provider (TPP), i.e. you are not yourself regulated as an Payment Initiation Service Provider (PISP) - [Retrieve Bud Pay URL - Standing Order](https://docs.thisisbud.com/reference/v1_payments_standing_order_bud_pay_url_post.md): Retrieve a Bud Pay URL to initiate a Standing Order. Please note that this endpoint should be used if you are using Bud as a Third Party Provider (TPP), i.e. you are not yourself regulated as an Payment Initiation Service Provider (PISP) - [Submit Authorisation Codes](https://docs.thisisbud.com/reference/v1_payments_authorisation_codes_post.md): When using Bud as a TSP (Technical Service Provider) and doing full app-to-app authorisation, the customer is returned from the provider directly back to your app. Your app will then need to send all the query and hash fragment parameters to Bud so that we can continue with the payment flow. Query and fragment parameters should be merged with query taking precedence. If you receive a request /path?a=1#a=2&b=3 then you should perform this request with {"a":"1","b":"3"}. Given the nature of the fragment queries most server side languages will not process these so javascript may be required to correctly gather both parameters. Regardless of what parameters are present, all of them should be sent to Bud so that we can choose to either continue the connection or to map and record the error. State, Code and error are the most common parameters you will see, but this object may contain any number of unspecified properties. Currently state is a common property among all authorisation flows and is the current task ID. The state property is not guaranteed for the future of this API contract and will not be treated as backwards incompatible if a new authentication flow does not use it. - [Confirm Scheduled Payment](https://docs.thisisbud.com/reference/v1_payments_scheduled_payment_id_confirm_post.md): Confirm and execute a Scheduled Payment for a specific payment id. - [Create Scheduled Payment](https://docs.thisisbud.com/reference/v1_payments_scheduled_post.md): Create a new scheduled payment identifier and retrieve the authorisation url for the specific payment provider. Please note that this endpoint can only be used in the event that you are using Bud as a Technical Service Provider (TSP), i.e. you must be regulated as an Payment Initiation Service Provider (PISP) - [Confirm Single Payment](https://docs.thisisbud.com/reference/v1_payments_single_confirm_post.md): Confirm and execute payment order for a specific payment. - [Create Single Payment](https://docs.thisisbud.com/reference/v1_payments_single_post.md): Create a unique single payment identifier and retrieve the authorisation url for the specific payment provider. Please note that this endpoint can only be used in the event that you are using Bud as a Technical Service Provider (TSP), i.e. you must be regulated as an Payment Initiation Service Provider (PISP) - [Confirm Standing Order](https://docs.thisisbud.com/reference/v1_payments_standing_order_confirm_post.md): Confirm and execute a Standing Order for a specific payment id. - [Create Standing Order](https://docs.thisisbud.com/reference/v1_payments_standing_order_post.md): Create a new Standing Order payment identifier and retrieve the authorisation url for the specific payment provider. Please note that this endpoint can only be used in the event that you are using Bud as a Technical Service Provider (TSP), i.e. you must be regulated as an Payment Initiation Service Provider (PISP) - [Search for Single Payments](https://docs.thisisbud.com/reference/v1_payment_get.md): Retrieve and view the status of multiple payments - [Search for Scheduled Payments](https://docs.thisisbud.com/reference/v1_payments_scheduled_get.md): Retrieve and view the status of multiple Scheduled Payments - [Retrieve Scheduled Payment Status](https://docs.thisisbud.com/reference/v1_payments_scheduled_payment_id_get.md): Retrieve and view the status of a specific Scheduled payment - [Retrieve Single Payment Status](https://docs.thisisbud.com/reference/v1_payments_single_payment_id_get.md): Retrieve and view the status of a payment - [Search for Standing Orders](https://docs.thisisbud.com/reference/v1_payments_standing_order_get.md): Retrieve and view the status of multiple Standing Orders - [Retrieve Standing Order Payment Status](https://docs.thisisbud.com/reference/v1_payments_standing_order_payment_id_get.md): Retrieve and view the status of a specific Standing Order payment - [Retrieve Debt Collection Transactions](https://docs.thisisbud.com/reference/v1_debt_collection_get.md): Provides a list of a customers' outgoing debt collection transactions found within their connected accounts. When `X-From` is omitted from the request, a default value of 30 days from before today's date will be used. When `X-To` is omitted from the request, a default value of today's date will be used. **Notes:** - Transactions with multiple currencies are supported, but the statistics are currently only calculated for one currency. The endpoint takes the currency of the first transaction and ignores non-matching currencies in its calculations. - [Retrieve Benefits Transactions](https://docs.thisisbud.com/reference/v1_benefits_get.md): Provides a list of a customer's benefits based transactions found within their connected accounts. When `X-From` is omitted from the request, a default value of 30 days from before today's date will be used. When `X-To` is omitted from the request, a default value of today's date will be used. - [Retrieve Benefits Totals](https://docs.thisisbud.com/reference/v1_benefits_totals_get.md): Provides a customers' total income under each detected benefit type. When `X-From` is omitted from the request, a default value of 30 days from before today's date will be used. When `X-To` is omitted from the request, a default value of today's date will be used. - [Retrieve Income Transactions V2](https://docs.thisisbud.com/reference/v2_income_get.md): Provides a list of a customer's income based transactions found within their connected accounts, and predicts whether each income transaction is related to a customer's `salary_or_wages`. Any income which is not salary or wages is given the type `other_incoming`, which can include other income sources such as investments or pension income. When `X-From` is omitted from the request, a default value of 9 months from before today's date will be used. When `X-To` is omitted from the request, a default value of today's date will be used. **Notes:** - Transactions with multiple currencies are supported, but the statistics are currently only calculated for one currency. The endpoint takes the currency of the first transaction and ignores non-matching currencies in its calculations. - In contrast to the V1 endpoint, Income Finder V2 no longer filters income transactions to only return the latest per reference. - [Retrieve Loan Transactions](https://docs.thisisbud.com/reference/v1_loans_get.md): Provides a list of a customers' outgoing loan transactions found within their connected accounts. When `X-From` is omitted from the request, a default value of 30 days from before today's date will be used. When `X-To` is omitted from the request, a default value of today's date will be used. **Notes:** - Transactions with multiple currencies are supported, but the statistics are currently only calculated for one currency. The endpoint takes the currency of the first transaction and ignores non-matching currencies in its calculations. - [Retrieve Financial Products V2](https://docs.thisisbud.com/reference/insights_v2_products.md): Financial Products returns the finance oriented products and services that a customer uses. This endpoint generates data using a customer's transaction history. Financial Products detects the following types of products and services: - Loans - Buy Now, Pay Later (BNPL) - Mortgages - Insurance products - Credit Cards - Private Pensions - Savings and Investments *Notes:* - If from and to parameters are not set, this endpoint will default to using transactions from the last six months. > ๐Ÿšง Limitations > > Financial Products are only identified from debit transactions. - [Retrieve Regular Transactions](https://docs.thisisbud.com/reference/regular_transactions_get.md): Provides a list of customer transactions that occur regularly. Currently the following periods are supported: - `daily` - `weekly` - `biweekly` - `monthly` - `quarterly` - `unknown` - [Retrieve Future Transactions V2](https://docs.thisisbud.com/reference/v2_future_transactions_get.md): Provides a list of transactions predicted to occur in the next specified number of months. Currently the following periods are supported: - `daily` - `weekly` - `biweekly` - `monthly` - `quarterly` - `unknown` - [Retrieve Subscriptions](https://docs.thisisbud.com/reference/v1_subscriptions_get.md): This endpoint is used to retrieve information about a user's subscriptions When `X-From` is omitted from the request, a default value of 30 days from before today's date will be used. When `X-To` is omitted from the request, a default value of today's date will be used. ## Changelog - [Version 5.0.0: 08/05/2026](https://docs.thisisbud.com/changelog/version-500-08052026.md) - [Version 4.4.1: 07/05/2026](https://docs.thisisbud.com/changelog/version-441-07052026.md) - [Version 4.4.0: 30/04/2026](https://docs.thisisbud.com/changelog/version-440-30042026.md) - [Version 4.3.0: 23/04/2026](https://docs.thisisbud.com/changelog/version-430-23042026.md) - [Version 4.2.0: 21/04/2026](https://docs.thisisbud.com/changelog/version-420-21042026.md)