Platform Object
This represents a Platform account: a per-host account (a hosted child of the fiscal host) that holds platform tips collected on behalf of the Open Collective platform.
Fields
#
id
The public id identifying the account (ie: 5v08jk63-w4g9nbpz-j7qmyder-p7ozax5g)
type
The type of the account (BOT/COLLECTIVE/EVENT/ORGANIZATION/INDIVIDUAL/VENDOR)
taxableCountry
The country the account is taxable in (residence for individuals, incorporation for organizations), set from the US tax form (W-9 / W-8BEN / W-8BEN-E) submitted by the account. Scope: "account".
description
longDescription
tags
isIncognito
Defines if the contributors wants to be incognito (name not displayed)
mainProfile
For an incognito account, returns the main profile. Only visible to users with the right permissions. Scope: "account".
imageUrl
backgroundImageUrl
isActive
Returns whether it's active: can accept financial contributions and pay expenses.
isHost
Returns whether the account has money management activated.
emails
Returns the emails of the account. Individuals only have one, but organizations can have multiple emails. Scope: "email".
transferwise
payoutMethods
The list of payout methods that this collective can use to get paid. In most cases, admin only and scope: "expenses".
paymentMethods
The list of payment methods that this collective can use to pay for Orders. Admin or Host only. Scope: "orders".
paymentMethodsWithPendingConfirmation
The list of payment methods for this account that are pending a client confirmation (3D Secure / SCA)
connectedAccounts
The list of connected accounts (Stripe, PayPal, etc ...). Admin only. Scope: "connectedAccounts".
oAuthApplications
The list of applications created by this account. Admin only. Scope: "applications".
location
The address associated to this account. This field is always public for collectives and events.
stats
updates
Updates published by the account. To see unpublished updates, you need to be an admin and have the scope "updates".
features
Describes the features enabled and available for this account
virtualCards
Virtual Cards attached to the account. Admin only. Scope: "virtualCards".
virtualCardMerchants
Virtual Cards Merchants used by the account. Admin only. Scope: "virtualCards".
policies
Policies for the account. To see non-public policies you need to be admin and have the scope: "account".
activitySubscriptions
List of activities that the logged-in user is subscribed for this collective
hostApplicationRequests
Host application requests. Scope: "applications".
feed
duplicatedFromAccount
If created by duplication, the account from which this one was duplicated
duplicatedAccounts
If this account was duplicated, the accounts that were created from it
communityStats
Various stats about how this account is connected to the rest of the community
kycVerificationRequests
KYC Verification requests made by this account
hostAgreements
Returns agreements this account has with its host, or null if not enough permissions.
summary
Interfaces
#
Also implements Account , AccountWithHost , AccountWithParent .
PlaidLinkTokenCreateResponse
PlatformBilling
