Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.methodfi.com/llms.txt

Use this file to discover all available pages before exploring further.

The Account Subscriptions endpoint controls the state of all Subscriptions for an Account. Subscriptions are Products that can provide continuous updates via Webhooks. (e.g. Transaction Subscription provides real-time updates on a Credit Card’s transactions)
Most subscriptions are accessible by default. However, some subscriptions have restricted access requiring team-by-team enablement and elevated account verification.

​
Subscription Names

Subscriptions that an Account can be enrolled in:
NameUse-CaseSupported TypesResource Doc
transactionNear real-time transaction notifications for Credit / Debit Card Accounts.Credit CardsTransactions
updateNear real-time account update (balance, due dates, etc) from the Account’s financial institution. Includes update.snapshot updates.All liabilitiesUpdates
update.snapshotMonthly account snapshot update (balance, due dates, etc) from the credit bureau.All liabilitiesUpdates
card_brandNear real-time information regarding credit card metadata (Product / Brand Name, Art, etc).Credit CardsCard Brands
payment_instrumentNear real-time information regarding Credit / Debit Card credentials to be used for checkout.Credit CardsPayment Instruments
When you create a subscription for update, you will receive both direct and snapshot updates.
An account can either have an update or update.snapshot subscription at any given time, not both.

​
Subscriptions Objects

​
Webhook Payload

The Webhook payload will contain the following information: 
{
  "id": "string",
  "type": "subscription.create" | "subscription.update",
  "path": "/accounts/<acc_id>/subscriptions/<sub_id>",
}

{
  "transaction": {
    "id": "sub_P8c4bjj6xajxF",
    "name": "transaction",
    "status": "active",
    "payload": null,
    "latest_request_id": "txn_GBCW694AEgfAh",
    "created_at": "2024-04-10T22:14:21.951Z",
    "updated_at": "2024-04-10T22:14:21.951Z"
  },
  "update": {
    "id": "sub_P8c4bjj6xajxF",
    "name": "update",
    "status": "active",
    "payload": null,
    "latest_request_id": "upt_TXDTR7Amyz7Az",
    "created_at": "2024-04-10T22:14:21.951Z",
    "updated_at": "2024-04-10T22:14:21.951Z"
  }
}