List subscriptions

GET/admin/v1/subscriptions

List subscriptions.

query parameters

organizationId
string
Filter results by organization identifier.
userId
string
Filter results by user identifier.
state
enum
Filter results by state.
Possible values:
CREATINGTRIALINGCHECKOUT_ISSUEACTIVEPAST_DUEPAUSEDCANCELED
planGroupId
string
Filter results by plan group identifier.
You can specify unmanaged to see all subscriptions without a plan.
pageSize
int32
The maximum number of subscriptions to return. The API may return fewer than this value.
If unspecified, at most 20 subscriptions will be returned. The maximum value is 100; values above 100 will be coerced to 100.
pageToken
string
A page token, received from a previous list subscriptions call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to list subscriptions must match the call that provided the page token.
orderBy
string
A comma-separated list of fields to order by.
This is only supported when either organizationId or userId is specified.
view
enum
The Subscription view to return in the results.
This defaults to the BASIC view.
Possible values:
BASICFULL

Returns

subscriptions
Subscription[]
BASIC
The list of subscriptions.
id
string
The system-assigned identifier of the subscription.
state
enum
The status of the subscription.
Possible values:
CREATINGTRIALINGCHECKOUT_ISSUEACTIVEPAST_DUEPAUSEDCANCELED
stateReason
string
The code that best describes the reason for the state.
connection
Connection
The billing connection.
id
string
The system-assigned identifier of the connection.
uniqueId
string
The client defined unique identifier of the connection.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with conn_ are reserved.
displayName
string
The human-readable display name of the connection.
The maximum length is 200 characters.
state
enum
The current status of the connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
enum
The connection type.
Possible values:
AMAZON_COGNITOAUTH0BUILTIN_EMAILCUSTOM_USERSGOOGLE_CLOUD_IDENTITY_PLATFORMPOSTMARKSTRIPEWEBHOOK
delegate
ConnectionDelegate
The delegated connection.
id
string
The delegated connection identifier.
uniqueId
string
The client defined unique identifier of the delegated connection.
displayName
string
The human-readable display name of the delegated connection.
state
enum
The current status of the delegated connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
enum
The delegated connection type.
Possible values:
AMAZON_COGNITOAUTH0BUILTIN_EMAILCUSTOM_USERSGOOGLE_CLOUD_IDENTITY_PLATFORMPOSTMARKSTRIPEWEBHOOK
providers
ConnectionProvider[]
The connection providers.
type
enum
The provider type.
Possible values:
ACCOUNTBILLINGEMAILUSER
default
boolean
Whether the connection is the default for the provider type.
amazonCognito
AmazonCognitoConnection
The Amazon Cognito connection data.
userPoolId
string
The Amazon Cognito user pool ID.
region
string
The Amazon region.
accessKeyId
string
The Amazon access key ID.
accessKeySecret
string
The Amazon access key secret.
oidc
OidcConfig
OpenID Connect (OIDC) configuration.
If configured, this can be used instead of implementing a Portal callback.
issuerUrl
string
The issuer URL.
clientId
string
The client ID.
clientSecret
string
The client secret.
auth0
Auth0Connection
The Auth0 connection data.
domain
string
The Auth0 domain.
clientId
string
The Auth0 client ID.
clientSecret
string
The Auth0 client secret.
oidc
OidcConfig
OpenID Connect (OIDC) configuration.
If configured, this can be used instead of implementing a Portal callback.
issuerUrl
string
The issuer URL.
clientId
string
The client ID.
clientSecret
string
The client secret.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
googleCloudIdentityPlatform
GoogleCloudIdentityPlatformConnection
The Google Cloud Identity Platform (Firebase Auth) connection.
credentials
string
The service account key in JSON format.
projectId
string
The Google Cloud Identity Platform/Firebase project ID.
This will default to the project ID in the service account key if not specified.
postmark
PostmarkConnection
The Postmark configuration data.
serverToken
string
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
serverId
string
The Postmark server ID.
This is automatically populated when the server token is updated.
from
Email
The from email address.
The Postmark account must be allowed to send from this email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
replyTo
Email
The reply to email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
stripe
StripeConnection
The Stripe billing configuration data.
accountId
string
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
live
boolean
The live vs test status for the Stripe account.
webhook
WebhookConnection
The webhooks configuration data.
url
string
The URL of the events webhook.
headers
string
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The webhook secrets
secret
string
The signing secret value.
expireTime
date-time
The time the signing secret is set to expire.
view
enum
The connection view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the connection.
updateTime
date-time
The last update time of the connection.
externalId
string
The external identifier of the subscription.
plan
Plan
The plan.
id
string
The system-assigned identifier of the plan.
state
enum
The status of the plan.
Possible values:
AVAILABLEUNAVAILABLE
uniqueId
string
The client defined unique identifier of the plan.
displayName
string
The name of the plan.
description
string
The description of the plan.
tier
enum
The tier for the plan.
This is only available in checkout and pricing.
Possible values:
FREETIER1TIER2TIER3TIER4TIER5ENTERPRISE
currencyCode
string
The currency code for the plan (e.g. USD).
interval
Interval
The billing interval for the plan.
quantity
int32
The interval quantity.
unit
enum
The interval unit.
Possible values:
DAYWEEKMONTHYEAR
revision
PlanRevision
The revision for the plan.
id
string
The system-assigned identifier of the plan revision.
current
boolean
Whether this is the current revision for the subscription.
This is only set in checkout.
selected
boolean
Whether this is the selected revision.
This is only set in checkout.
latest
boolean
Whether this is the latest revision for the plan.
This is only set for a current or selected plan in checkout.
tag
string
The tag for the revision.
This is only set in checkout for plans selected using a tag.
current
boolean
Whether this is the current plan for the subscription.
This is only set in checkout.
selected
boolean
Whether this is the selected plan.
This is only set in checkout.
default
boolean
Whether this is the default term for the plan.
trial
PlanTrial
The trial settings.
For authenticated requests, this will only be set for accounts that are eligible for a new trial.
days
int32
The number of days in the trial.
changePath
enum
Whether the change is considered an upgrade or a downgrade.
This is only set in checkout.
Possible values:
UPGRADEDOWNGRADE
tags
string[]
The tags associated with the revision.
items
PlanItem[]
The items associated with plan.
type
enum
The plan item type.
Possible values:
PLANPLAN_ADDONSEAT
product
Product
The product associated with the item.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with pd_ are reserved.
displayName
string
The customer facing human-readable display name of the product.
The maximum length is 200 characters.
description
string
The public description of the product.
The maximum length is 1000 characters.
committed
boolean
Whether the price has been committed.
This is automatically set the first time the product is used in a plan.
archived
boolean
The archived status of the product.
It determines if the product can be activated by self-serve plans.
productConnections
ProductConnection[]
The connected products.
connection
Connection
The basic view of the connection.
id
string
The system-assigned identifier of the connection.
uniqueId
string
The client defined unique identifier of the connection.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with conn_ are reserved.
displayName
string
The human-readable display name of the connection.
The maximum length is 200 characters.
state
enum
The current status of the connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
enum
The connection type.
Possible values:
AMAZON_COGNITOAUTH0BUILTIN_EMAILCUSTOM_USERSGOOGLE_CLOUD_IDENTITY_PLATFORMPOSTMARKSTRIPEWEBHOOK
delegate
ConnectionDelegate
The delegated connection.
id
string
The delegated connection identifier.
uniqueId
string
The client defined unique identifier of the delegated connection.
displayName
string
The human-readable display name of the delegated connection.
state
enum
The current status of the delegated connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
enum
The delegated connection type.
Possible values:
AMAZON_COGNITOAUTH0BUILTIN_EMAILCUSTOM_USERSGOOGLE_CLOUD_IDENTITY_PLATFORMPOSTMARKSTRIPEWEBHOOK
providers
ConnectionProvider[]
The connection providers.
type
enum
The provider type.
Possible values:
ACCOUNTBILLINGEMAILUSER
default
boolean
Whether the connection is the default for the provider type.
amazonCognito
AmazonCognitoConnection
The Amazon Cognito connection data.
userPoolId
string
The Amazon Cognito user pool ID.
region
string
The Amazon region.
accessKeyId
string
The Amazon access key ID.
accessKeySecret
string
The Amazon access key secret.
oidc
OidcConfig
OpenID Connect (OIDC) configuration.
If configured, this can be used instead of implementing a Portal callback.
issuerUrl
string
The issuer URL.
clientId
string
The client ID.
clientSecret
string
The client secret.
auth0
Auth0Connection
The Auth0 connection data.
domain
string
The Auth0 domain.
clientId
string
The Auth0 client ID.
clientSecret
string
The Auth0 client secret.
oidc
OidcConfig
OpenID Connect (OIDC) configuration.
If configured, this can be used instead of implementing a Portal callback.
issuerUrl
string
The issuer URL.
clientId
string
The client ID.
clientSecret
string
The client secret.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
googleCloudIdentityPlatform
GoogleCloudIdentityPlatformConnection
The Google Cloud Identity Platform (Firebase Auth) connection.
credentials
string
The service account key in JSON format.
projectId
string
The Google Cloud Identity Platform/Firebase project ID.
This will default to the project ID in the service account key if not specified.
postmark
PostmarkConnection
The Postmark configuration data.
serverToken
string
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
serverId
string
The Postmark server ID.
This is automatically populated when the server token is updated.
from
Email
The from email address.
The Postmark account must be allowed to send from this email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
replyTo
Email
The reply to email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
stripe
StripeConnection
The Stripe billing configuration data.
accountId
string
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
live
boolean
The live vs test status for the Stripe account.
webhook
WebhookConnection
The webhooks configuration data.
url
string
The URL of the events webhook.
headers
string
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The webhook secrets
secret
string
The signing secret value.
expireTime
date-time
The time the signing secret is set to expire.
view
enum
The connection view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the connection.
updateTime
date-time
The last update time of the connection.
externalId
string
The external identifier of the connected product.
state
enum
The status of the connected product.
Possible values:
ACTIVEBROKENDISABLED
stateReason
string
The code that best describes the reason for the state.
createTime
date-time
The creation time of the product connection.
updateTime
date-time
The last update time of the product connection.
view
enum
The product view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the product.
updateTime
date-time
The last update time of the product.
price
Price
The price associated with the item.
id
string
The system-assigned identifier of the price.
connection
Connection
The connection.
id
string
The system-assigned identifier of the connection.
uniqueId
string
The client defined unique identifier of the connection.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with conn_ are reserved.
displayName
string
The human-readable display name of the connection.
The maximum length is 200 characters.
state
enum
The current status of the connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
enum
The connection type.
Possible values:
AMAZON_COGNITOAUTH0BUILTIN_EMAILCUSTOM_USERSGOOGLE_CLOUD_IDENTITY_PLATFORMPOSTMARKSTRIPEWEBHOOK
delegate
ConnectionDelegate
The delegated connection.
id
string
The delegated connection identifier.
uniqueId
string
The client defined unique identifier of the delegated connection.
displayName
string
The human-readable display name of the delegated connection.
state
enum
The current status of the delegated connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
enum
The delegated connection type.
Possible values:
AMAZON_COGNITOAUTH0BUILTIN_EMAILCUSTOM_USERSGOOGLE_CLOUD_IDENTITY_PLATFORMPOSTMARKSTRIPEWEBHOOK
providers
ConnectionProvider[]
The connection providers.
type
enum
The provider type.
Possible values:
ACCOUNTBILLINGEMAILUSER
default
boolean
Whether the connection is the default for the provider type.
amazonCognito
AmazonCognitoConnection
The Amazon Cognito connection data.
userPoolId
string
The Amazon Cognito user pool ID.
region
string
The Amazon region.
accessKeyId
string
The Amazon access key ID.
accessKeySecret
string
The Amazon access key secret.
oidc
OidcConfig
OpenID Connect (OIDC) configuration.
If configured, this can be used instead of implementing a Portal callback.
issuerUrl
string
The issuer URL.
clientId
string
The client ID.
clientSecret
string
The client secret.
auth0
Auth0Connection
The Auth0 connection data.
domain
string
The Auth0 domain.
clientId
string
The Auth0 client ID.
clientSecret
string
The Auth0 client secret.
oidc
OidcConfig
OpenID Connect (OIDC) configuration.
If configured, this can be used instead of implementing a Portal callback.
issuerUrl
string
The issuer URL.
clientId
string
The client ID.
clientSecret
string
The client secret.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
googleCloudIdentityPlatform
GoogleCloudIdentityPlatformConnection
The Google Cloud Identity Platform (Firebase Auth) connection.
credentials
string
The service account key in JSON format.
projectId
string
The Google Cloud Identity Platform/Firebase project ID.
This will default to the project ID in the service account key if not specified.
postmark
PostmarkConnection
The Postmark configuration data.
serverToken
string
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
serverId
string
The Postmark server ID.
This is automatically populated when the server token is updated.
from
Email
The from email address.
The Postmark account must be allowed to send from this email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
replyTo
Email
The reply to email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
stripe
StripeConnection
The Stripe billing configuration data.
accountId
string
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
live
boolean
The live vs test status for the Stripe account.
webhook
WebhookConnection
The webhooks configuration data.
url
string
The URL of the events webhook.
headers
string
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The webhook secrets
secret
string
The signing secret value.
expireTime
date-time
The time the signing secret is set to expire.
view
enum
The connection view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the connection.
updateTime
date-time
The last update time of the connection.
externalId
string
The external identifier of the connected price.
state
enum
The status of the connected price.
Possible values:
ACTIVEBROKENARCHIVED
stateReason
string
The code that best describes the reason for the state.
currencyCode
string
The currency for the price.
billingMode
enum
The billing mode for the price.
Possible values:
FIXED_TERMUSAGE_BASED
interval
Interval
The billing interval for the price.
quantity
int32
The interval quantity.
unit
enum
The interval unit.
Possible values:
DAYWEEKMONTHYEAR
displayName
string
The admin-facing display name of the price.
product
Product
The product associated with the price.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with pd_ are reserved.
displayName
string
The customer facing human-readable display name of the product.
The maximum length is 200 characters.
description
string
The public description of the product.
The maximum length is 1000 characters.
committed
boolean
Whether the price has been committed.
This is automatically set the first time the product is used in a plan.
archived
boolean
The archived status of the product.
It determines if the product can be activated by self-serve plans.
productConnections
ProductConnection[]
The connected products.
connection
Connection
The basic view of the connection.
id
string
The system-assigned identifier of the connection.
uniqueId
string
The client defined unique identifier of the connection.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with conn_ are reserved.
displayName
string
The human-readable display name of the connection.
The maximum length is 200 characters.
state
enum
The current status of the connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
enum
The connection type.
Possible values:
AMAZON_COGNITOAUTH0BUILTIN_EMAILCUSTOM_USERSGOOGLE_CLOUD_IDENTITY_PLATFORMPOSTMARKSTRIPEWEBHOOK
delegate
ConnectionDelegate
The delegated connection.
id
string
The delegated connection identifier.
uniqueId
string
The client defined unique identifier of the delegated connection.
displayName
string
The human-readable display name of the delegated connection.
state
enum
The current status of the delegated connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
enum
The delegated connection type.
Possible values:
AMAZON_COGNITOAUTH0BUILTIN_EMAILCUSTOM_USERSGOOGLE_CLOUD_IDENTITY_PLATFORMPOSTMARKSTRIPEWEBHOOK
providers
ConnectionProvider[]
The connection providers.
type
enum
The provider type.
Possible values:
ACCOUNTBILLINGEMAILUSER
default
boolean
Whether the connection is the default for the provider type.
amazonCognito
AmazonCognitoConnection
The Amazon Cognito connection data.
userPoolId
string
The Amazon Cognito user pool ID.
region
string
The Amazon region.
accessKeyId
string
The Amazon access key ID.
accessKeySecret
string
The Amazon access key secret.
oidc
OidcConfig
OpenID Connect (OIDC) configuration.
If configured, this can be used instead of implementing a Portal callback.
issuerUrl
string
The issuer URL.
clientId
string
The client ID.
clientSecret
string
The client secret.
auth0
Auth0Connection
The Auth0 connection data.
domain
string
The Auth0 domain.
clientId
string
The Auth0 client ID.
clientSecret
string
The Auth0 client secret.
oidc
OidcConfig
OpenID Connect (OIDC) configuration.
If configured, this can be used instead of implementing a Portal callback.
issuerUrl
string
The issuer URL.
clientId
string
The client ID.
clientSecret
string
The client secret.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
googleCloudIdentityPlatform
GoogleCloudIdentityPlatformConnection
The Google Cloud Identity Platform (Firebase Auth) connection.
credentials
string
The service account key in JSON format.
projectId
string
The Google Cloud Identity Platform/Firebase project ID.
This will default to the project ID in the service account key if not specified.
postmark
PostmarkConnection
The Postmark configuration data.
serverToken
string
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
serverId
string
The Postmark server ID.
This is automatically populated when the server token is updated.
from
Email
The from email address.
The Postmark account must be allowed to send from this email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
replyTo
Email
The reply to email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
stripe
StripeConnection
The Stripe billing configuration data.
accountId
string
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
live
boolean
The live vs test status for the Stripe account.
webhook
WebhookConnection
The webhooks configuration data.
url
string
The URL of the events webhook.
headers
string
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The webhook secrets
secret
string
The signing secret value.
expireTime
date-time
The time the signing secret is set to expire.
view
enum
The connection view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the connection.
updateTime
date-time
The last update time of the connection.
externalId
string
The external identifier of the connected product.
state
enum
The status of the connected product.
Possible values:
ACTIVEBROKENDISABLED
stateReason
string
The code that best describes the reason for the state.
createTime
date-time
The creation time of the product connection.
updateTime
date-time
The last update time of the product connection.
view
enum
The product view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the product.
updateTime
date-time
The last update time of the product.
empty
PriceEmptyPrice
The price is dependent on the quantity.
fixed
PriceFixedPrice
The price is fixed per quantity.
amount
string
The decimal amount for the defined currency (e.g. 9.95).
transformQuantity
PriceTransformQuantity
Whether to transform the quantity before multiplying amount.
divisor
int32
The amount to divide the quantity by.
round
enum
Whether to round the result up or down.
Possible values:
UPDOWN
tiered
PriceTieredPrice
The price is dependent on the quantity.
mode
enum
The strategy for evaluating the tiers.
Possible values:
GRADUATEDVOLUME
tiers
PriceTieredPriceTier[]
The tiers for the price.
upper
int32
The upper quantity for tier (inclusive).
unitAmount
string
The per quantity amount for the tier.
flatAmount
string
The flat amount for the tier.
archived
boolean
The archived status of the price.
It determines if the price can be used.
view
enum
The price view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the price.
updateTime
date-time
The last update time of the price.
view
enum
The subscription view.
Possible values:
BASICFULL
currencyCode
string
The currency code for the subscription (e.g. USD).
paymentMethod
PaymentMethod
The payment method.
id
string
The system-assigned identifier of the payment method.
externalId
string
The external identifier of the connected payment method.
state
enum
The status of the connected payment method.
Possible values:
ACTIVEBROKENARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
enum
The payment method type.
Possible values:
CARDUNKNOWN
displayName
string
A human-readable description of the payment method.
This can be used to show a description of the payment method when the type is UNKNOWN or not explicitly handled.
fullName
string
The full name of the owner of the payment method.
address
Address
The address for the payment method.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
default
boolean
Whether the payment method is the default for the connected account.
lastPaymentError
Status
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
localeMessage
string
A user-facing error message.
card
CardPaymentMethod
Card payment method (e.g. Visa credit card).
brand
enum
The brand of the card (e.g. VISA).
Possible values:
AMERICAN_EXPRESSDINERS_CLUBDISCOVERJCBMASTERCARDUNIONPAYVISA
last4
string
The last for digits of the card.
fundingType
enum
The funding method for the card (e.g. DEBIT).
Possible values:
CREDITDEBITPREPAID
expYear
int32
The expiration year.
expMonth
int32
The expiration month.
view
enum
The payment method view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the payment method connection.
updateTime
date-time
The last update time of the payment method connection.
renewCanceled
boolean
Whether the subscription is scheduled to be canceled at the end of the current billing period.
cancelPeriodEnd
boolean
Deprecated
Whether the subscription is scheduled to be canceled at the end of the current billing period.
anchorTime
date-time
The anchor time for the billing cycle.
startTime
date-time
The time the subscription started.
endTime
date-time
The time the subscription ends/ended.
trial
SubscriptionTrial
The trial information for the subscription.
startTime
date-time
The time the trial started.
endTime
date-time
The time the trial ended/ends.
days
int32
The number of days in the trial.
This number is rounded to the nearest whole number of days.
remainingDays
int32
The number of days remaining in the trial.
This number is rounded down, so will generally be less than days. It will be zero on the last day of the trial and null when the trial expires.
currentPeriod
SubscriptionCurrentPeriod
The current billing period for the subscription.
startTime
date-time
The time the current billing period started.
endTime
date-time
The time the current billing period ends.
organization
Organization
The organization owner of the subscription.
id
string
The system-assigned identifier of the organization.
state
enum
The current state of the organization.
Possible values:
ACTIVEDISABLEDARCHIVEDPENDING_DELETION
stateReason
string
The code that best describes the reason for the state.
uniqueId
string
The client defined unique identifier of the organization account.
displayName
string
The human-readable display name of the organization.
email
string
The email address of the organization.
emailVerified
boolean
Whether the organization's email address has been verified.
phoneNumber
string
The E164 phone number for the organization (e.g. +12125550123).
phoneNumberVerified
boolean
Whether the organization's phone number has been verified.
imageUrl
string
The photo/avatar URL of the organization.
currencyCode
string
The default ISO-4217 currency code for the organization (e.g. USD).
languageCode
string
The IETF BCP-47 language code for the organization (e.g. en).
regionCode
string
The country/region code for the organization (e.g. US).
timeZone
string
The IANA time zone for the organization (e.g. America/New_York).
address
Address
The default address for the organization.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
accountConnections
AccountConnection[]
The connected accounts.
connection
Connection
The tenant connection.
id
string
The system-assigned identifier of the connection.
uniqueId
string
The client defined unique identifier of the connection.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with conn_ are reserved.
displayName
string
The human-readable display name of the connection.
The maximum length is 200 characters.
state
enum
The current status of the connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
enum
The connection type.
Possible values:
AMAZON_COGNITOAUTH0BUILTIN_EMAILCUSTOM_USERSGOOGLE_CLOUD_IDENTITY_PLATFORMPOSTMARKSTRIPEWEBHOOK
delegate
ConnectionDelegate
The delegated connection.
id
string
The delegated connection identifier.
uniqueId
string
The client defined unique identifier of the delegated connection.
displayName
string
The human-readable display name of the delegated connection.
state
enum
The current status of the delegated connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
enum
The delegated connection type.
Possible values:
AMAZON_COGNITOAUTH0BUILTIN_EMAILCUSTOM_USERSGOOGLE_CLOUD_IDENTITY_PLATFORMPOSTMARKSTRIPEWEBHOOK
providers
ConnectionProvider[]
The connection providers.
type
enum
The provider type.
Possible values:
ACCOUNTBILLINGEMAILUSER
default
boolean
Whether the connection is the default for the provider type.
amazonCognito
AmazonCognitoConnection
The Amazon Cognito connection data.
userPoolId
string
The Amazon Cognito user pool ID.
region
string
The Amazon region.
accessKeyId
string
The Amazon access key ID.
accessKeySecret
string
The Amazon access key secret.
oidc
OidcConfig
OpenID Connect (OIDC) configuration.
If configured, this can be used instead of implementing a Portal callback.
issuerUrl
string
The issuer URL.
clientId
string
The client ID.
clientSecret
string
The client secret.
auth0
Auth0Connection
The Auth0 connection data.
domain
string
The Auth0 domain.
clientId
string
The Auth0 client ID.
clientSecret
string
The Auth0 client secret.
oidc
OidcConfig
OpenID Connect (OIDC) configuration.
If configured, this can be used instead of implementing a Portal callback.
issuerUrl
string
The issuer URL.
clientId
string
The client ID.
clientSecret
string
The client secret.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
googleCloudIdentityPlatform
GoogleCloudIdentityPlatformConnection
The Google Cloud Identity Platform (Firebase Auth) connection.
credentials
string
The service account key in JSON format.
projectId
string
The Google Cloud Identity Platform/Firebase project ID.
This will default to the project ID in the service account key if not specified.
postmark
PostmarkConnection
The Postmark configuration data.
serverToken
string
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
serverId
string
The Postmark server ID.
This is automatically populated when the server token is updated.
from
Email
The from email address.
The Postmark account must be allowed to send from this email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
replyTo
Email
The reply to email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
stripe
StripeConnection
The Stripe billing configuration data.
accountId
string
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
live
boolean
The live vs test status for the Stripe account.
webhook
WebhookConnection
The webhooks configuration data.
url
string
The URL of the events webhook.
headers
string
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The webhook secrets
secret
string
The signing secret value.
expireTime
date-time
The time the signing secret is set to expire.
view
enum
The connection view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the connection.
updateTime
date-time
The last update time of the connection.
externalId
string
The external identifier of the connected account.
adminUrl
string
The external admin URL for the connected account.
state
enum
The status of the connected account.
Possible values:
ACTIVEBROKENDISABLED
stateReason
string
The code that best describes the reason for the state.
displayName
string
The human-readable display name of the external account.
email
string
The email address of the external account.
emailVerified
boolean
Whether the external account's email address has been verified.
phoneNumber
string
The E164 phone number for the external account (e.g. +12125550123).
phoneNumberVerified
boolean
Whether the external account's phone number has been verified.
address
Address
The billing address for the external account.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
currencyCode
string
The currency code for the account.
balanceAmount
string
The balance amount for the account.
A negative value indicates an amount which will be subtracted from the next invoice (credit).
A positive value indicates an amount which will be added to the next invoice (debt).
paymentMethods
PaymentMethod[]
The payment methods for connections that support it.
id
string
The system-assigned identifier of the payment method.
externalId
string
The external identifier of the connected payment method.
state
enum
The status of the connected payment method.
Possible values:
ACTIVEBROKENARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
enum
The payment method type.
Possible values:
CARDUNKNOWN
displayName
string
A human-readable description of the payment method.
This can be used to show a description of the payment method when the type is UNKNOWN or not explicitly handled.
fullName
string
The full name of the owner of the payment method.
address
Address
The address for the payment method.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
default
boolean
Whether the payment method is the default for the connected account.
lastPaymentError
Status
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
localeMessage
string
A user-facing error message.
card
CardPaymentMethod
Card payment method (e.g. Visa credit card).
brand
enum
The brand of the card (e.g. VISA).
Possible values:
AMERICAN_EXPRESSDINERS_CLUBDISCOVERJCBMASTERCARDUNIONPAYVISA
last4
string
The last for digits of the card.
fundingType
enum
The funding method for the card (e.g. DEBIT).
Possible values:
CREDITDEBITPREPAID
expYear
int32
The expiration year.
expMonth
int32
The expiration month.
view
enum
The payment method view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the payment method connection.
updateTime
date-time
The last update time of the payment method connection.
createTime
date-time
The creation time of the account connection.
updateTime
date-time
The last update time of the account connection.
subscription
AccountSubscription
The organization's default active subscription.
id
string
The system-assigned identifier of the subscription.
state
enum
The state of the subscription.
Possible values:
TRIALINGCHECKOUT_ISSUEACTIVEPAST_DUEPAUSED
anchorTime
date-time
The anchor time of the billing cycle.
plan
AccountSubscriptionPlan
The plan.
id
string
The identifier of the plan.
displayName
string
The human-readable display name of the plan.
product
AccountSubscriptionProduct
The plan product.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
displayName
string
The human-readable display name of the product.
signupTime
date-time
The sign-up time for the organization.
memberCount
int32
The number of members in the organization.
This includes disabled users, but does not include user's marked for deletion.
disabled
boolean
Whether the organization is disabled.
view
enum
The organization view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the organization.
updateTime
date-time
The last update time of the organization.
user
User
The user owner of the subscription.
id
string
The system-assigned identifier of the user.
state
enum
The current state of the user.
Possible values:
ACTIVEDISABLEDARCHIVEDPENDING_DELETION
stateReason
string
The code that best describes the reason for the state.
uniqueId
string
The client defined unique identifier of the user account.
displayName
string
The human-readable display name of the user.
email
string
The email address of the user.
emailVerified
boolean
Whether the user's email address has been verified.
phoneNumber
string
The E164 phone number for the user (e.g. +12125550123).
phoneNumberVerified
boolean
Whether the user's phone number has been verified.
imageUrl
string
The photo/avatar URL of the user.
currencyCode
string
The default ISO-4217 currency code for the user (e.g. USD).
languageCode
string
The IETF BCP-47 language code for the user (e.g. en).
regionCode
string
The country/region code for the user (e.g. US).
timeZone
string
The IANA time zone for the user (e.g. America/New_York).
address
Address
The default address for the user.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
accountConnections
AccountConnection[]
The connected accounts.
connection
Connection
The tenant connection.
id
string
The system-assigned identifier of the connection.
uniqueId
string
The client defined unique identifier of the connection.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with conn_ are reserved.
displayName
string
The human-readable display name of the connection.
The maximum length is 200 characters.
state
enum
The current status of the connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
enum
The connection type.
Possible values:
AMAZON_COGNITOAUTH0BUILTIN_EMAILCUSTOM_USERSGOOGLE_CLOUD_IDENTITY_PLATFORMPOSTMARKSTRIPEWEBHOOK
delegate
ConnectionDelegate
The delegated connection.
id
string
The delegated connection identifier.
uniqueId
string
The client defined unique identifier of the delegated connection.
displayName
string
The human-readable display name of the delegated connection.
state
enum
The current status of the delegated connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
enum
The delegated connection type.
Possible values:
AMAZON_COGNITOAUTH0BUILTIN_EMAILCUSTOM_USERSGOOGLE_CLOUD_IDENTITY_PLATFORMPOSTMARKSTRIPEWEBHOOK
providers
ConnectionProvider[]
The connection providers.
type
enum
The provider type.
Possible values:
ACCOUNTBILLINGEMAILUSER
default
boolean
Whether the connection is the default for the provider type.
amazonCognito
AmazonCognitoConnection
The Amazon Cognito connection data.
userPoolId
string
The Amazon Cognito user pool ID.
region
string
The Amazon region.
accessKeyId
string
The Amazon access key ID.
accessKeySecret
string
The Amazon access key secret.
oidc
OidcConfig
OpenID Connect (OIDC) configuration.
If configured, this can be used instead of implementing a Portal callback.
issuerUrl
string
The issuer URL.
clientId
string
The client ID.
clientSecret
string
The client secret.
auth0
Auth0Connection
The Auth0 connection data.
domain
string
The Auth0 domain.
clientId
string
The Auth0 client ID.
clientSecret
string
The Auth0 client secret.
oidc
OidcConfig
OpenID Connect (OIDC) configuration.
If configured, this can be used instead of implementing a Portal callback.
issuerUrl
string
The issuer URL.
clientId
string
The client ID.
clientSecret
string
The client secret.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
googleCloudIdentityPlatform
GoogleCloudIdentityPlatformConnection
The Google Cloud Identity Platform (Firebase Auth) connection.
credentials
string
The service account key in JSON format.
projectId
string
The Google Cloud Identity Platform/Firebase project ID.
This will default to the project ID in the service account key if not specified.
postmark
PostmarkConnection
The Postmark configuration data.
serverToken
string
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
serverId
string
The Postmark server ID.
This is automatically populated when the server token is updated.
from
Email
The from email address.
The Postmark account must be allowed to send from this email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
replyTo
Email
The reply to email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
stripe
StripeConnection
The Stripe billing configuration data.
accountId
string
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
live
boolean
The live vs test status for the Stripe account.
webhook
WebhookConnection
The webhooks configuration data.
url
string
The URL of the events webhook.
headers
string
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The webhook secrets
secret
string
The signing secret value.
expireTime
date-time
The time the signing secret is set to expire.
view
enum
The connection view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the connection.
updateTime
date-time
The last update time of the connection.
externalId
string
The external identifier of the connected account.
adminUrl
string
The external admin URL for the connected account.
state
enum
The status of the connected account.
Possible values:
ACTIVEBROKENDISABLED
stateReason
string
The code that best describes the reason for the state.
displayName
string
The human-readable display name of the external account.
email
string
The email address of the external account.
emailVerified
boolean
Whether the external account's email address has been verified.
phoneNumber
string
The E164 phone number for the external account (e.g. +12125550123).
phoneNumberVerified
boolean
Whether the external account's phone number has been verified.
address
Address
The billing address for the external account.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
currencyCode
string
The currency code for the account.
balanceAmount
string
The balance amount for the account.
A negative value indicates an amount which will be subtracted from the next invoice (credit).
A positive value indicates an amount which will be added to the next invoice (debt).
paymentMethods
PaymentMethod[]
The payment methods for connections that support it.
id
string
The system-assigned identifier of the payment method.
externalId
string
The external identifier of the connected payment method.
state
enum
The status of the connected payment method.
Possible values:
ACTIVEBROKENARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
enum
The payment method type.
Possible values:
CARDUNKNOWN
displayName
string
A human-readable description of the payment method.
This can be used to show a description of the payment method when the type is UNKNOWN or not explicitly handled.
fullName
string
The full name of the owner of the payment method.
address
Address
The address for the payment method.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
default
boolean
Whether the payment method is the default for the connected account.
lastPaymentError
Status
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
localeMessage
string
A user-facing error message.
card
CardPaymentMethod
Card payment method (e.g. Visa credit card).
brand
enum
The brand of the card (e.g. VISA).
Possible values:
AMERICAN_EXPRESSDINERS_CLUBDISCOVERJCBMASTERCARDUNIONPAYVISA
last4
string
The last for digits of the card.
fundingType
enum
The funding method for the card (e.g. DEBIT).
Possible values:
CREDITDEBITPREPAID
expYear
int32
The expiration year.
expMonth
int32
The expiration month.
view
enum
The payment method view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the payment method connection.
updateTime
date-time
The last update time of the payment method connection.
createTime
date-time
The creation time of the account connection.
updateTime
date-time
The last update time of the account connection.
subscription
AccountSubscription
The user's default active individual subscription.
See memberships for organization subscription and seat information.
id
string
The system-assigned identifier of the subscription.
state
enum
The state of the subscription.
Possible values:
TRIALINGCHECKOUT_ISSUEACTIVEPAST_DUEPAUSED
anchorTime
date-time
The anchor time of the billing cycle.
plan
AccountSubscriptionPlan
The plan.
id
string
The identifier of the plan.
displayName
string
The human-readable display name of the plan.
product
AccountSubscriptionProduct
The plan product.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
displayName
string
The human-readable display name of the product.
memberships
Membership[]
The user's organization memberships.
organization
Organization
The organization.
id
string
The system-assigned identifier of the organization.
state
enum
The current state of the organization.
Possible values:
ACTIVEDISABLEDARCHIVEDPENDING_DELETION
stateReason
string
The code that best describes the reason for the state.
uniqueId
string
The client defined unique identifier of the organization account.
displayName
string
The human-readable display name of the organization.
email
string
The email address of the organization.
emailVerified
boolean
Whether the organization's email address has been verified.
phoneNumber
string
The E164 phone number for the organization (e.g. +12125550123).
phoneNumberVerified
boolean
Whether the organization's phone number has been verified.
imageUrl
string
The photo/avatar URL of the organization.
currencyCode
string
The default ISO-4217 currency code for the organization (e.g. USD).
languageCode
string
The IETF BCP-47 language code for the organization (e.g. en).
regionCode
string
The country/region code for the organization (e.g. US).
timeZone
string
The IANA time zone for the organization (e.g. America/New_York).
address
Address
The default address for the organization.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
accountConnections
AccountConnection[]
The connected accounts.
connection
Connection
The tenant connection.
id
string
The system-assigned identifier of the connection.
uniqueId
string
The client defined unique identifier of the connection.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with conn_ are reserved.
displayName
string
The human-readable display name of the connection.
The maximum length is 200 characters.
state
enum
The current status of the connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
enum
The connection type.
Possible values:
AMAZON_COGNITOAUTH0BUILTIN_EMAILCUSTOM_USERSGOOGLE_CLOUD_IDENTITY_PLATFORMPOSTMARKSTRIPEWEBHOOK
delegate
ConnectionDelegate
The delegated connection.
id
string
The delegated connection identifier.
uniqueId
string
The client defined unique identifier of the delegated connection.
displayName
string
The human-readable display name of the delegated connection.
state
enum
The current status of the delegated connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
enum
The delegated connection type.
Possible values:
AMAZON_COGNITOAUTH0BUILTIN_EMAILCUSTOM_USERSGOOGLE_CLOUD_IDENTITY_PLATFORMPOSTMARKSTRIPEWEBHOOK
providers
ConnectionProvider[]
The connection providers.
type
enum
The provider type.
Possible values:
ACCOUNTBILLINGEMAILUSER
default
boolean
Whether the connection is the default for the provider type.
amazonCognito
AmazonCognitoConnection
The Amazon Cognito connection data.
userPoolId
string
The Amazon Cognito user pool ID.
region
string
The Amazon region.
accessKeyId
string
The Amazon access key ID.
accessKeySecret
string
The Amazon access key secret.
oidc
OidcConfig
OpenID Connect (OIDC) configuration.
If configured, this can be used instead of implementing a Portal callback.
issuerUrl
string
The issuer URL.
clientId
string
The client ID.
clientSecret
string
The client secret.
auth0
Auth0Connection
The Auth0 connection data.
domain
string
The Auth0 domain.
clientId
string
The Auth0 client ID.
clientSecret
string
The Auth0 client secret.
oidc
OidcConfig
OpenID Connect (OIDC) configuration.
If configured, this can be used instead of implementing a Portal callback.
issuerUrl
string
The issuer URL.
clientId
string
The client ID.
clientSecret
string
The client secret.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
googleCloudIdentityPlatform
GoogleCloudIdentityPlatformConnection
The Google Cloud Identity Platform (Firebase Auth) connection.
credentials
string
The service account key in JSON format.
projectId
string
The Google Cloud Identity Platform/Firebase project ID.
This will default to the project ID in the service account key if not specified.
postmark
PostmarkConnection
The Postmark configuration data.
serverToken
string
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
serverId
string
The Postmark server ID.
This is automatically populated when the server token is updated.
from
Email
The from email address.
The Postmark account must be allowed to send from this email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
replyTo
Email
The reply to email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
stripe
StripeConnection
The Stripe billing configuration data.
accountId
string
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
live
boolean
The live vs test status for the Stripe account.
webhook
WebhookConnection
The webhooks configuration data.
url
string
The URL of the events webhook.
headers
string
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The webhook secrets
secret
string
The signing secret value.
expireTime
date-time
The time the signing secret is set to expire.
view
enum
The connection view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the connection.
updateTime
date-time
The last update time of the connection.
externalId
string
The external identifier of the connected account.
adminUrl
string
The external admin URL for the connected account.
state
enum
The status of the connected account.
Possible values:
ACTIVEBROKENDISABLED
stateReason
string
The code that best describes the reason for the state.
displayName
string
The human-readable display name of the external account.
email
string
The email address of the external account.
emailVerified
boolean
Whether the external account's email address has been verified.
phoneNumber
string
The E164 phone number for the external account (e.g. +12125550123).
phoneNumberVerified
boolean
Whether the external account's phone number has been verified.
address
Address
The billing address for the external account.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
currencyCode
string
The currency code for the account.
balanceAmount
string
The balance amount for the account.
A negative value indicates an amount which will be subtracted from the next invoice (credit).
A positive value indicates an amount which will be added to the next invoice (debt).
paymentMethods
PaymentMethod[]
The payment methods for connections that support it.
id
string
The system-assigned identifier of the payment method.
externalId
string
The external identifier of the connected payment method.
state
enum
The status of the connected payment method.
Possible values:
ACTIVEBROKENARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
enum
The payment method type.
Possible values:
CARDUNKNOWN
displayName
string
A human-readable description of the payment method.
This can be used to show a description of the payment method when the type is UNKNOWN or not explicitly handled.
fullName
string
The full name of the owner of the payment method.
address
Address
The address for the payment method.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
default
boolean
Whether the payment method is the default for the connected account.
lastPaymentError
Status
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
localeMessage
string
A user-facing error message.
card
CardPaymentMethod
Card payment method (e.g. Visa credit card).
brand
enum
The brand of the card (e.g. VISA).
Possible values:
AMERICAN_EXPRESSDINERS_CLUBDISCOVERJCBMASTERCARDUNIONPAYVISA
last4
string
The last for digits of the card.
fundingType
enum
The funding method for the card (e.g. DEBIT).
Possible values:
CREDITDEBITPREPAID
expYear
int32
The expiration year.
expMonth
int32
The expiration month.
view
enum
The payment method view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the payment method connection.
updateTime
date-time
The last update time of the payment method connection.
createTime
date-time
The creation time of the account connection.
updateTime
date-time
The last update time of the account connection.
subscription
AccountSubscription
The organization's default active subscription.
id
string
The system-assigned identifier of the subscription.
state
enum
The state of the subscription.
Possible values:
TRIALINGCHECKOUT_ISSUEACTIVEPAST_DUEPAUSED
anchorTime
date-time
The anchor time of the billing cycle.
plan
AccountSubscriptionPlan
The plan.
id
string
The identifier of the plan.
displayName
string
The human-readable display name of the plan.
product
AccountSubscriptionProduct
The plan product.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
displayName
string
The human-readable display name of the product.
signupTime
date-time
The sign-up time for the organization.
memberCount
int32
The number of members in the organization.
This includes disabled users, but does not include user's marked for deletion.
disabled
boolean
Whether the organization is disabled.
view
enum
The organization view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the organization.
updateTime
date-time
The last update time of the organization.
role
Role
The user's role within the organization.
id
string
The system-assigned identifier of the role.
uniqueId
string
The client defined unique identifier of the role.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with role_ are reserved.
displayName
string
The human-readable display name of the role.
type
enum
The role type.
Possible values:
OWNERMEMBERGUEST
description
string
The description of the role.
The maximum length is 1000 characters.
seatPolicy
enum
The policy that defines how a member is assigned a seat.
Possible values:
DEFAULTMANUAL
permissionSets
string[]
The additional permissions allowed by the role.
default
boolean
Whether the role is the default for the tenant.
archived
boolean
The archived status of the role.
view
enum
The role view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the role.
updateTime
date-time
The last update time of the role.
seat
AccountSubscriptionSeat
The seat associated with the membership.
This will be absent if there is no active default subscription for the organization or the user has not been assigned a seat.
product
AccountSubscriptionProduct
The seat product.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
displayName
string
The human-readable display name of the product.
createTime
date-time
The creation time of the membership.
updateTime
date-time
The last update time of the membership.
signupTime
date-time
The sign-up time for the user.
disabled
boolean
Whether the user is disabled.
view
enum
The user view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the user.
updateTime
date-time
The last update time of the user.
default
boolean
Whether the subscription is the default for the account.
view
enum
The subscription view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the subscription.
updateTime
date-time
The last update time of the subscription.
nextPageToken
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
previousPageToken
string
A token, which can be sent as pageToken to retrieve the previous page. If this field is absent, there are no preceding pages. If this field is an empty string then the previous page is the first result.

code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
localeMessage
string
A user-facing error message.

curl https://api.userhub.com/admin/v1/subscriptions?organizationId=org_28seyVGVL1got6 \
  -H "Authorization: Bearer $USERHUB_ADMIN_KEY"

const res = await adminApi.subscriptions.list({
  organizationId: "org_28seyVGVL1got6",
});

res, err := adminApi.Subscriptions().List(
    context.Background(),
    &adminapi.SubscriptionListInput{
        OrganizationId: "org_28seyVGVL1got6",
    },
)

$res = $adminApi->subscriptions->list(
    organizationId: 'org_28seyVGVL1got6',
);

res = admin_api.subscriptions.list(
    organization_id="org_28seyVGVL1got6",
)

Response bodyJSON

{
  "subscriptions": [
    {
      "id": "sub_UBUqH64iKRBdCD",
      "state": "ACTIVE",
      "connection": {
        "id": "conn_4HdRKnTvPmmjYK",
        "displayName": "Stripe",
        "state": "ACTIVE",
        "type": "STRIPE",
        "providers": [],
        "view": "BASIC",
        "createTime": "2025-05-15T13:00:00Z",
        "updateTime": "2025-05-15T13:00:00Z"
      },
      "externalId": "sub_1PGhMaI1Zx1mDKAzigGeR4s9",
      "plan": {
        "id": "plan_2wnGzPMSrDBYK5:ukfHizos:monthly:usd",
        "state": "AVAILABLE",
        "uniqueId": "pro:ukfHizos:monthly:usd",
        "displayName": "Pro",
        "description": "The pro plan.",
        "currencyCode": "USD",
        "interval": {
          "quantity": 1,
          "unit": "MONTH"
        },
        "revision": {
          "id": "plan_2wnGzPMSrDBYK5:ukfHizos"
        },
        "tags": [
          "default"
        ],
        "items": [],
        "view": "BASIC"
      },
      "currencyCode": "USD",
      "items": [],
      "seats": [],
      "anchorTime": "2025-05-15T13:00:00Z",
      "startTime": "2025-05-15T13:00:00Z",
      "currentPeriod": {
        "startTime": "2025-05-15T13:00:00Z",
        "endTime": "2025-06-15T13:00:00Z"
      },
      "organization": {
        "id": "org_28seyVGVL1got6",
        "state": "ACTIVE",
        "displayName": "Acme Inc",
        "email": "[email protected]",
        "emailVerified": true,
        "imageUrl": "https://example.com/acme.jpg",
        "accountConnections": [],
        "signupTime": "2025-05-15T13:00:00Z",
        "memberCount": 1,
        "view": "BASIC",
        "createTime": "2025-05-15T13:00:00Z",
        "updateTime": "2025-05-15T13:00:00Z"
      },
      "default": true,
      "view": "BASIC",
      "createTime": "2025-05-15T13:00:00Z",
      "updateTime": "2025-05-15T13:00:00Z"
    }
  ]
}

PreviousThe subscription object

NextGet a subscription

List subscriptions

.css-10iahqc{text-transform:capitalize;}query parameters

Returns

query parameters