Stripe: Unsubscribe from data refreshes for an Account

Stripe financialConnections.postFinancialConnectionsAccountsAccountUnsubscribe: arguments, response, policy and SDK examples.

← Financial connections operations · Get started

Operation stripe.postfinancialconnectionsaccountsaccountunsubscribe

Provider route: POST /v1/financial_connections/accounts/{account}/unsubscribe. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["financialConnections"]["postFinancialConnectionsAccountsAccountUnsubscribe"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.financialConnections.postFinancialConnectionsAccountsAccountUnsubscribe(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.financial_connections.post_financial_connections_accounts_account_unsubscribe(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.account`	string	Required within parent	Maximum length: 5000
`headers`	object	Optional	Additional keys: not allowed
`headers.Idempotency-Key`	string	Optional	Minimum length: 1 Maximum length: 255
`body`	object	Required within parent	Additional keys: not allowed
`body.expand`	array	Optional	Specifies which fields in the response should be expanded.
`body.expand[]`	string	Each item	Maximum length: 5000
`body.features`	array	Required within parent	The list of account features from which you would like to unsubscribe.
`body.features[]`	string	Each item	One of: transactions

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Subscribe to data refreshes for an Account — response body

Referenced models: Subscribe to data refreshes for an Account — response body

Schemas

718 more schemas are linked from the tables above, on the schema pages.

Subscribe to data refreshes for an Account — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.
`account_holder`	JSON	Optional
`account_holder (anyOf 1)`	JSON	Alternative	The account holder that this account belongs to.
`account_holder (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Create a Session — linkAccountSessions.postLinkAccountSessions — response body — account_holder / value / type: account, customer
`account_holder (anyOf 2)`	null	Alternative
`account_numbers`	JSON	Optional
`account_numbers (anyOf 1)`	array	Alternative	Details about the account numbers.
`account_numbers (anyOf 1)[]`	Model	Each item	Expand Subscribe to data refreshes for an Account — response body — account numbers Details about the account numbers item
`account_numbers (anyOf 2)`	null	Alternative
`balance`	JSON	Optional
`balance (anyOf 1)`	JSON	Alternative	The most recent information about the account's balance.
`balance (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Subscribe to data refreshes for an Account — response body — balance / value / type: cash, credit
`balance (anyOf 2)`	null	Alternative
`balance_refresh`	JSON	Optional
`balance_refresh (anyOf 1)`	JSON	Alternative	The state of the most recent attempt to refresh the account balance.
`balance_refresh (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Subscribe to data refreshes for an Account — response body — balance_refresh / value / status: failed, pending, succeeded
`balance_refresh (anyOf 2)`	null	Alternative
`category`	string	Required within parent	The type of the account. Account category is further divided in `subcategory`. Known values: cash, credit, investment, other
`created`	JSON	Required within parent
`created (anyOf 1)`	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
`created (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`display_name`	JSON	Optional
`display_name (anyOf 1)`	string	Alternative	A human-readable name that has been assigned to this account, either by the account holder or by the institution. Maximum length: 5000
`display_name (anyOf 2)`	null	Alternative
`id`	string	Required within parent	Unique identifier for the object. Maximum length: 5000
`institution_name`	string	Required within parent	The name of the institution that holds this account. Maximum length: 5000
`last4`	JSON	Optional
`last4 (anyOf 1)`	string	Alternative	The last 4 digits of the account number. If present, this will be 4 numeric characters. Maximum length: 5000
`last4 (anyOf 2)`	null	Alternative
`livemode`	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: financial_connections.account
`ownership`	JSON	Optional
`ownership (anyOf 1)`	JSON	Alternative	The most recent information about the account's owners.
`ownership (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`ownership (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Subscribe to data refreshes for an Account — response body — ownership / value / object: financial connections account ownership
`ownership (anyOf 2)`	null	Alternative
`ownership_refresh`	JSON	Optional
`ownership_refresh (anyOf 1)`	JSON	Alternative	The state of the most recent attempt to refresh the account owners.
`ownership_refresh (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Subscribe to data refreshes for an Account — response body — ownership_refresh / value / status: failed, pending, succeeded
`ownership_refresh (anyOf 2)`	null	Alternative
`permissions`	JSON	Optional
`permissions (anyOf 1)`	array	Alternative	The list of permissions granted by this account.
`permissions (anyOf 1)[]`	string	Each item	Known values: balances, ownership, payment_method, transactions
`permissions (anyOf 2)`	null	Alternative
`status`	string	Required within parent	The status of the link to the account. Known values: active, disconnected, inactive
`status_details`	Model	Optional	Expand Subscribe to data refreshes for an Account — response body — status details
`subcategory`	string	Required within parent	If `category` is `cash`, one of: - `checking` - `savings` - `other` If `category` is `credit`, one of: - `mortgage` - `line_of_credit` - `credit_card` - `other` If `category` is `investment` or `other`, this will be `other`. Known values: checking, credit_card, line_of_credit, mortgage, other, savings
`subscriptions`	JSON	Optional
`subscriptions (anyOf 1)`	array	Alternative	The list of data refresh subscriptions requested on this account.
`subscriptions (anyOf 1)[]`	string	Each item	Known values: transactions
`subscriptions (anyOf 2)`	null	Alternative
`supported_payment_method_types`	array	Required within parent	The [PaymentMethod type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.
`supported_payment_method_types[]`	string	Each item	Known values: link, us_bank_account
`transaction_refresh`	JSON	Optional
`transaction_refresh (anyOf 1)`	JSON	Alternative	The state of the most recent attempt to refresh the account transactions.
`transaction_refresh (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Subscribe to data refreshes for an Account — response body — transaction_refresh / value / status: failed, pending, succeeded
`transaction_refresh (anyOf 2)`	null	Alternative

Subscribe to data refreshes for an Account — response body — account numbers Details about the account numbers item

Field	Type	Presence	Description and constraints
`$`	object	Root
`expected_expiry_date`	JSON	Optional
`expected_expiry_date (anyOf 1)`	JSON	Alternative
`expected_expiry_date (anyOf 1) (anyOf 1)`	integer	Alternative	When the account number is expected to expire, if applicable. Format: unix-time
`expected_expiry_date (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`expected_expiry_date (anyOf 2)`	null	Alternative
`identifier_type`	string	Required within parent	The type of account number associated with the account. Known values: account_number, tokenized_account_number
`status`	string	Required within parent	Whether the account number is currently active and usable for transactions. Known values: deactivated, expired, pending, transactable
`supported_networks`	array	Required within parent	The payment networks that the account number can be used for.
`supported_networks[]`	string	Each item	Known values: ach

Subscribe to data refreshes for an Account — response body — status details

Field	Type	Presence	Description and constraints
`$`	object	Root
`active`	Model	Optional	Expand Subscribe to data refreshes for an Account — response body — status details active

Referenced models: Subscribe to data refreshes for an Account — response body — status details active

Create an account — response body — groups The groups associated with the account payments pricing

Field	Type	Presence	Description and constraints
`$`	object	Root
`payments_pricing`	JSON	Optional
`payments_pricing (anyOf 1)`	string	Alternative	The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://docs.stripe.com/connect/platform-pricing-tools) for details. Maximum length: 5000
`payments_pricing (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: stripe.postfinancialconnectionsaccountsaccountunsubscribe. Catalog operation: PostFinancialConnectionsAccountsAccountUnsubscribe. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source

Report an issue with this page