Subscribe to data refreshes for an Account

Changed on

Subscribes to periodic refreshes of data associated with a Financial Connections Account. When the account status is active, data is typically refreshed once a day.

post/v1/financial_connections/accounts/{account}/subscribe

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/financial_connections/accounts/{account}/subscribe
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

accountstring required

Request body application/x-www-form-urlencoded

expandstring[]

Specifies which fields in the response should be expanded.

featuresstring[] required

The list of account features to which you would like to subscribe.

Response

Successful response.

category'cash' | 'credit' | 'investment' | 'other' required

The type of the account. Account category is further divided in subcategory.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

display_namestring nullable

A human-readable name that has been assigned to this account, either by the account holder or by the institution.

idstring required

Unique identifier for the object.

institution_namestring required

The name of the institution that holds this account.

last4string nullable

The last 4 digits of the account number. If present, this will be 4 numeric characters.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object'financial_connections.account' required

String representing the object's type. Objects of the same type share the same value.

permissionsstring[] nullable

The list of permissions granted by this account.

status'active' | 'disconnected' | 'inactive' required

The status of the link to the account.

subcategory'checking' | 'credit_card' | 'line_of_credit' | 'mortgage' | 'other' | 'savings' required

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.

subscriptionsstring[] nullable

The list of data refresh subscriptions requested on this account.

supported_payment_method_typesstring[] required

The PaymentMethod type(s) that can be created from this account.

Changes

  • 585b581504aeRevision changes
    • warning

      added the new final_payment_failure enum value to the //////////////// response property for the response status

    • warning

      added the new final_payment_failure enum value to the ////////// response property for the response status

    • warning

      added the new first_payment_failure enum value to the //////////////// response property for the response status

    • warning

      added the new first_payment_failure enum value to the ////////// response property for the response status

  • 7537419124b6Revision changes
    • info

      added the optional property ///////////// to the response with the status

    • info

      added the optional property /////// to the response with the status

Some revisions have not been checked yet.