Skip to main content
GET
Retrieve an account.

Authorizations

Authorization
string
header
required

Enter your access token (OAuth / JWT).

Path Parameters

accountUid
string | null
required

The account's unique identifier

Response

Created
string<date-time>
required
read-only
Minimum string length: 1
Updated
string<date-time>
required
read-only
Minimum string length: 1
Name
string
required
Required string length: 1 - 250
Uid
string | null
Maximum string length: 10
_objectType
string | null
ActivityEventData
unknown
SchemaLessData
object | null
StripeId
string | null
Maximum string length: 255
IsLivemode
boolean
ClientIdentifier
string | null
Maximum string length: 250
Currency
string | null
Maximum string length: 3
InvoiceNotes
string | null
IsDemo
boolean
BillingAddress
object | null
MailingAddress
object | null
AccountStage
enum<integer>

2 - Trialing, 3 - Subscribing, 4 - Cancelling, 5 - Expired, 6 - Trial Expired, 7 - Past Due, 8 - Cancelling Trial, 9 - Paused, 10 - Created

Available options:
2,
3,
4,
5,
6,
7,
8,
9,
10
PaymentInformation
object | null
Example:
PersonAccount
object[] | null
StripeDefaultPaymentMethodId
string | null
Maximum string length: 50
StripeInvoices
object[] | null
StripePaymentMethods
object[] | null
StripeSubscriptions
object[] | null
Subscriptions
object[] | null
Deals
object[] | null
LastLoginDateTime
string<date-time> | null
AccountSpecificPageUrl1
string | null
Maximum string length: 255
AccountSpecificPageUrl2
string | null
Maximum string length: 255
AccountSpecificPageUrl3
string | null
Maximum string length: 255
AccountSpecificPageUrl4
string | null
Maximum string length: 255
AccountSpecificPageUrl5
string | null
Maximum string length: 255
AccountSpecificPageUrl6
string | null
Maximum string length: 255
AccountSpecificPageUrl7
string | null
Maximum string length: 255
AccountSpecificPageUrl8
string | null
Maximum string length: 255
AccountSpecificPageUrl9
string | null
Maximum string length: 255
AccountSpecificPageUrl10
string | null
Maximum string length: 255
RewardFulReferralId
string | null
ToltReferralId
string | null
Maximum string length: 36
TaxIds
object[] | null
TaxStatus
string | null
Maximum string length: 20
AccountStageLabel
string | null
CurrentStripeProducts
string | null
CurrentSubscription
object | null
Example:
DomainName
string | null
HasLoggedIn
boolean
LatestSubscription
object | null
Example:
LifetimeRevenue
number<decimal>
NextStripeInvoiceDate
string<date-time> | null
Nonce
string | null
PrimaryContact
object | null
Example:
PrimarySubscription
object | null
Example:
PrimaryStripeSubscription
object | null
RecaptchaToken
string | null
StripeNextInvoiceSequence
integer<int64> | null
StripePrice
string[] | null
StripePromotionCode
string | null
TaxId
string | null
TaxIdIsInvalid
boolean
TaxIdType
string | null
WebflowSlug
string | null