The Account object 

Attributes

• idstring

  Unique identifier for the object.

• objectstring

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

• account_holdernullable object

  The account holder that this account belongs to.

  Hide child attributes

  • account_holder.accountnullable stringExpandable

    The ID of the Stripe account this account belongs to. Should only be present if account_holder.type is account.

  • account_holder.customernullable stringExpandable

    ID of the Stripe customer this account belongs to. Present if and only if account_holder.type is customer.

  • account_holder.typeenum

    Type of account holder that this account belongs to.

    Possible enum values

    account Account holder is a Stripe account object.

    customer Account holder is a Stripe customer object.

• balancenullable object

  The most recent information about the account’s balance.

  Hide child attributes

  • balance.as_oftimestamp

    The time that the external institution calculated this balance. Measured in seconds since the Unix epoch.

  • balance.cashnullable object

    Information on a cash balance. Only set if balance.type is cash.

    Hide child attributes

    • balance.cash.availablenullable object

      The funds available to the account holder. Typically this is the current balance after subtracting any outbound pending transactions and adding any inbound pending transactions.

      Each key is a three-letter ISO currency code, in lowercase.

      Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.

  • balance.creditnullable object

    Information on a credit balance. Only set if balance.type is credit.

    Hide child attributes

    • balance.credit.usednullable object

      The credit that has been used by the account holder.

      Each key is a three-letter ISO currency code, in lowercase.

      Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.

  • balance.currentobject

    The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions.

    Each key is a three-letter ISO currency code, in lowercase.

    Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.

  • balance.typeenum

    The type of the balance. An additional hash is included on the balance with a name matching this value.

    Possible enum values

    cash Account balance is a cash balance

    credit Account balance is a credit balance

• balance_refreshnullable object

  The state of the most recent attempt to refresh the account balance.

  Hide child attributes

  • balance_refresh.last_attempted_attimestamp

    The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.

  • balance_refresh.next_refresh_available_atnullable timestamp

    Time at which the next balance refresh can be initiated. This value will be null when status is pending. Measured in seconds since the Unix epoch.

  • balance_refresh.statusenum

    The status of the last refresh attempt.

    Possible enum values

    failed The last balance refresh attempt failed.

    pending The last balance refresh attempt is pending.

    succeeded The last balance refresh attempt succeeded.

• categoryenum

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

  Possible enum values

  cash The account represents real funds held by the institution (e.g. a checking or savings account).

  credit The account represents credit extended by the institution (e.g. a credit card or mortgage).

  investment The account represents investments, or any account where there are funds of unknown liquidity.

  other The account does not fall under the other categories.

• createdtimestamp

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

• display_namenullable string

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

• institution_namestring

  The name of the institution that holds this account.

• last4nullable string

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

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• ownershipnullable stringExpandable

  The most recent information about the account’s owners.

• ownership_refreshnullable object

  The state of the most recent attempt to refresh the account owners.

  Hide child attributes

  • ownership_refresh.last_attempted_attimestamp

    The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.

  • ownership_refresh.next_refresh_available_atnullable timestamp

    Time at which the next ownership refresh can be initiated. This value will be null when status is pending. Measured in seconds since the Unix epoch.

  • ownership_refresh.statusenum

    The status of the last refresh attempt.

    Possible enum values

    failed The last ownership refresh attempt failed.

    pending The last ownership refresh attempt is pending.

    succeeded The last ownership refresh attempt succeeded.

• permissionsnullable array of enums

  The list of permissions granted by this account.

  Possible enum values

  balances Allows accessing balance data from the account.

  ownership Allows accessing ownership data from the account.

  payment_method Allows the creation of a payment method from the account.

  transactions Allows accessing transactions data from the account.

• statusenum

  The status of the link to the account.

  Possible enum values

  active Stripe is able to retrieve data from the Account without issues.

  disconnected Account connection has been terminated through the disconnect API or an end user request.

  inactive Stripe cannot retrieve data from the Account.

• subcategoryenum

  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.

  Possible enum values

  checking The account is a checking account.

  credit_card The account represents a credit card.

  line_of_credit The account represents a line of credit.

  mortgage The account represents a mortgage.

  other The account does not fall under any of the other subcategories.

  savings The account is a savings account.

• subscriptionsnullable array of enums

  The list of data refresh subscriptions requested on this account.

  Possible enum values

  transactions Subscribes to periodic transactions data refreshes from the account.

• supported_payment_method_typesarray of enums

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

  Possible enum values

  link A link PaymentMethod can be created.

  us_bank_account A us_bank_account PaymentMethod can be created.

• transaction_refreshnullable object

  The state of the most recent attempt to refresh the account transactions.

  Hide child attributes

  • transaction_refresh.idstring

    Unique identifier for the object.

  • transaction_refresh.last_attempted_attimestamp

    The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.

  • transaction_refresh.next_refresh_available_atnullable timestamp

    Time at which the next transaction refresh can be initiated. This value will be null when status is pending. Measured in seconds since the Unix epoch.

  • transaction_refresh.statusenum

    The status of the last refresh attempt.

    Possible enum values

    failed The last transaction refresh attempt failed.

    pending The last transaction refresh attempt is pending.

    succeeded The last transaction refresh attempt succeeded.