The Subscription object
The representation of an activated plan.
The system-assigned identifier of the subscription.
The status of the subscription.
Possible values:ACTIVECANCELEDCREATINGTRIALINGPAST_DUEPAUSED
The code that best describes the reason for the state.
The system-assigned identifier of the connection.
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.
The human-readable display name of the connection.
The maximum length is 200 characters.
The current status of the connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
delegate
ConnectionDelegate
The delegated connection.
The delegated connection identifier.
The client defined unique identifier of the delegated connection.
The human-readable display name of the delegated connection.
The current status of the delegated connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
The delegated connection type.
providers
ConnectionProvider[]
The connection providers.
Whether the connection is the default for the provider type.
The creation time of the connection.
The last update time of the connection.
The Auth0 connection data.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The service account key in JSON format.
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.
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
The Postmark server ID.
This is automatically populated when the server token is updated.
The from email address.
The Postmark account must be allowed to send from this email address.
The email name (e.g. Jane Doe).
The reply to email address.
The email name (e.g. Jane Doe).
The Stripe billing configuration data.
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
The live vs test status for the Stripe account.
The webhooks configuration data.
The URL of the events webhook.
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The signing secret value.
The time the signing secret is set to expire.
The external identifier of the subscription.
The system-assigned identifier of the plan.
The description of the plan.
The currency code for the plan (e.g. USD).
The billing interval for the plan.
Possible values:DAYWEEKMONTHYEAR
The tags associated with the revision.
The items associated with plan.
The product associated with the item.
The system-assigned identifier of the product.
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.
The customer facing human-readable display name of the product.
The maximum length is 200 characters.
The public description of the product.
The maximum length is 1000 characters.
Whether the price has been committed.
This is automatically set the first time the product is used in a plan.
The archived status of the product.
It determines if the product can be activated by self-serve plans.
productConnections
ProductConnection[]
The basic view of the connection.
The system-assigned identifier of the connection.
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.
The human-readable display name of the connection.
The maximum length is 200 characters.
The current status of the connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
delegate
ConnectionDelegate
The delegated connection.
The delegated connection identifier.
The client defined unique identifier of the delegated connection.
The human-readable display name of the delegated connection.
The current status of the delegated connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
The delegated connection type.
providers
ConnectionProvider[]
The connection providers.
Whether the connection is the default for the provider type.
The creation time of the connection.
The last update time of the connection.
The Auth0 connection data.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The service account key in JSON format.
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.
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
The Postmark server ID.
This is automatically populated when the server token is updated.
The from email address.
The Postmark account must be allowed to send from this email address.
The email name (e.g. Jane Doe).
The reply to email address.
The email name (e.g. Jane Doe).
The Stripe billing configuration data.
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
The live vs test status for the Stripe account.
The webhooks configuration data.
The URL of the events webhook.
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The signing secret value.
The time the signing secret is set to expire.
The external identifier of the connected product.
The status of the connected product.
Possible values:ACTIVEBROKENDISABLED
The code that best describes the reason for the state.
The last time the product was pulled from the connection.
The last time the product was pushed to the connection.
The creation time of the product connection.
The last update time of the product connection.
The creation time of the product.
The last update time of the product.
The price associated with them item.
The system-assigned identifier of the price.
The system-assigned identifier of the connection.
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.
The human-readable display name of the connection.
The maximum length is 200 characters.
The current status of the connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
delegate
ConnectionDelegate
The delegated connection.
The delegated connection identifier.
The client defined unique identifier of the delegated connection.
The human-readable display name of the delegated connection.
The current status of the delegated connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
The delegated connection type.
providers
ConnectionProvider[]
The connection providers.
Whether the connection is the default for the provider type.
The creation time of the connection.
The last update time of the connection.
The Auth0 connection data.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The service account key in JSON format.
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.
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
The Postmark server ID.
This is automatically populated when the server token is updated.
The from email address.
The Postmark account must be allowed to send from this email address.
The email name (e.g. Jane Doe).
The reply to email address.
The email name (e.g. Jane Doe).
The Stripe billing configuration data.
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
The live vs test status for the Stripe account.
The webhooks configuration data.
The URL of the events webhook.
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The signing secret value.
The time the signing secret is set to expire.
The external identifier of the connected price.
The status of the connected price.
Possible values:ACTIVEBROKENARCHIVED
The code that best describes the reason for the state.
The currency for the price.
The billing mode for the price.
Possible values:FIXED_TERMUSAGE_BASED
The billing interval for the price.
Possible values:DAYWEEKMONTHYEAR
The admin-facing display name of the price.
The product associated with the price.
The system-assigned identifier of the product.
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.
The customer facing human-readable display name of the product.
The maximum length is 200 characters.
The public description of the product.
The maximum length is 1000 characters.
Whether the price has been committed.
This is automatically set the first time the product is used in a plan.
The archived status of the product.
It determines if the product can be activated by self-serve plans.
productConnections
ProductConnection[]
The basic view of the connection.
The system-assigned identifier of the connection.
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.
The human-readable display name of the connection.
The maximum length is 200 characters.
The current status of the connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
delegate
ConnectionDelegate
The delegated connection.
The delegated connection identifier.
The client defined unique identifier of the delegated connection.
The human-readable display name of the delegated connection.
The current status of the delegated connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
The delegated connection type.
providers
ConnectionProvider[]
The connection providers.
Whether the connection is the default for the provider type.
The creation time of the connection.
The last update time of the connection.
The Auth0 connection data.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The service account key in JSON format.
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.
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
The Postmark server ID.
This is automatically populated when the server token is updated.
The from email address.
The Postmark account must be allowed to send from this email address.
The email name (e.g. Jane Doe).
The reply to email address.
The email name (e.g. Jane Doe).
The Stripe billing configuration data.
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
The live vs test status for the Stripe account.
The webhooks configuration data.
The URL of the events webhook.
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The signing secret value.
The time the signing secret is set to expire.
The external identifier of the connected product.
The status of the connected product.
Possible values:ACTIVEBROKENDISABLED
The code that best describes the reason for the state.
The last time the product was pulled from the connection.
The last time the product was pushed to the connection.
The creation time of the product connection.
The last update time of the product connection.
The creation time of the product.
The last update time of the product.
The archived status of the price.
It determines if the price can be used.
The last time the price was pulled from the connection.
The last time the price was pushed to the connection.
The creation time of the price.
The last update time of the price.
The price is fixed per quantity.
The decimal amount for the defined currency (e.g. 9.95).
Whether to transform the quantity before multiplying amount.
The amount to divide the quantity by.
Whether to round the result up or down.
The price is dependent on the quantity.
The strategy for evaluating the tiers.
Possible values:GRADUATEDVOLUME
The upper quantity for tier (inclusive).
The per quantity amount for the tier.
The flat amount for the tier.
Possible values:PLANPLAN_ADDONSEAT
The currency code for the subscription (e.g. USD).
The identifier of the item.
The system-assigned identifier of the product.
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.
The customer facing human-readable display name of the product.
The maximum length is 200 characters.
The public description of the product.
The maximum length is 1000 characters.
Whether the price has been committed.
This is automatically set the first time the product is used in a plan.
The archived status of the product.
It determines if the product can be activated by self-serve plans.
productConnections
ProductConnection[]
The basic view of the connection.
The system-assigned identifier of the connection.
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.
The human-readable display name of the connection.
The maximum length is 200 characters.
The current status of the connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
delegate
ConnectionDelegate
The delegated connection.
The delegated connection identifier.
The client defined unique identifier of the delegated connection.
The human-readable display name of the delegated connection.
The current status of the delegated connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
The delegated connection type.
providers
ConnectionProvider[]
The connection providers.
Whether the connection is the default for the provider type.
The creation time of the connection.
The last update time of the connection.
The Auth0 connection data.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The service account key in JSON format.
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.
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
The Postmark server ID.
This is automatically populated when the server token is updated.
The from email address.
The Postmark account must be allowed to send from this email address.
The email name (e.g. Jane Doe).
The reply to email address.
The email name (e.g. Jane Doe).
The Stripe billing configuration data.
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
The live vs test status for the Stripe account.
The webhooks configuration data.
The URL of the events webhook.
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The signing secret value.
The time the signing secret is set to expire.
The external identifier of the connected product.
The status of the connected product.
Possible values:ACTIVEBROKENDISABLED
The code that best describes the reason for the state.
The last time the product was pulled from the connection.
The last time the product was pushed to the connection.
The creation time of the product connection.
The last update time of the product connection.
The creation time of the product.
The last update time of the product.
The system-assigned identifier of the price.
The system-assigned identifier of the connection.
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.
The human-readable display name of the connection.
The maximum length is 200 characters.
The current status of the connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
delegate
ConnectionDelegate
The delegated connection.
The delegated connection identifier.
The client defined unique identifier of the delegated connection.
The human-readable display name of the delegated connection.
The current status of the delegated connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
The delegated connection type.
providers
ConnectionProvider[]
The connection providers.
Whether the connection is the default for the provider type.
The creation time of the connection.
The last update time of the connection.
The Auth0 connection data.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The service account key in JSON format.
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.
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
The Postmark server ID.
This is automatically populated when the server token is updated.
The from email address.
The Postmark account must be allowed to send from this email address.
The email name (e.g. Jane Doe).
The reply to email address.
The email name (e.g. Jane Doe).
The Stripe billing configuration data.
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
The live vs test status for the Stripe account.
The webhooks configuration data.
The URL of the events webhook.
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The signing secret value.
The time the signing secret is set to expire.
The external identifier of the connected price.
The status of the connected price.
Possible values:ACTIVEBROKENARCHIVED
The code that best describes the reason for the state.
The currency for the price.
The billing mode for the price.
Possible values:FIXED_TERMUSAGE_BASED
The billing interval for the price.
Possible values:DAYWEEKMONTHYEAR
The admin-facing display name of the price.
The product associated with the price.
The system-assigned identifier of the product.
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.
The customer facing human-readable display name of the product.
The maximum length is 200 characters.
The public description of the product.
The maximum length is 1000 characters.
Whether the price has been committed.
This is automatically set the first time the product is used in a plan.
The archived status of the product.
It determines if the product can be activated by self-serve plans.
productConnections
ProductConnection[]
The basic view of the connection.
The system-assigned identifier of the connection.
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.
The human-readable display name of the connection.
The maximum length is 200 characters.
The current status of the connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
delegate
ConnectionDelegate
The delegated connection.
The delegated connection identifier.
The client defined unique identifier of the delegated connection.
The human-readable display name of the delegated connection.
The current status of the delegated connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
The delegated connection type.
providers
ConnectionProvider[]
The connection providers.
Whether the connection is the default for the provider type.
The creation time of the connection.
The last update time of the connection.
The Auth0 connection data.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The service account key in JSON format.
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.
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
The Postmark server ID.
This is automatically populated when the server token is updated.
The from email address.
The Postmark account must be allowed to send from this email address.
The email name (e.g. Jane Doe).
The reply to email address.
The email name (e.g. Jane Doe).
The Stripe billing configuration data.
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
The live vs test status for the Stripe account.
The webhooks configuration data.
The URL of the events webhook.
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The signing secret value.
The time the signing secret is set to expire.
The external identifier of the connected product.
The status of the connected product.
Possible values:ACTIVEBROKENDISABLED
The code that best describes the reason for the state.
The last time the product was pulled from the connection.
The last time the product was pushed to the connection.
The creation time of the product connection.
The last update time of the product connection.
The creation time of the product.
The last update time of the product.
The archived status of the price.
It determines if the price can be used.
The last time the price was pulled from the connection.
The last time the price was pushed to the connection.
The creation time of the price.
The last update time of the price.
The price is fixed per quantity.
The decimal amount for the defined currency (e.g. 9.95).
Whether to transform the quantity before multiplying amount.
The amount to divide the quantity by.
Whether to round the result up or down.
The price is dependent on the quantity.
The strategy for evaluating the tiers.
Possible values:GRADUATEDVOLUME
The upper quantity for tier (inclusive).
The per quantity amount for the tier.
The flat amount for the tier.
The quantity of products.
seats
SubscriptionSeatInfo[]
The system-assigned identifier of the product.
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.
The customer facing human-readable display name of the product.
The maximum length is 200 characters.
The public description of the product.
The maximum length is 1000 characters.
Whether the price has been committed.
This is automatically set the first time the product is used in a plan.
The archived status of the product.
It determines if the product can be activated by self-serve plans.
productConnections
ProductConnection[]
The basic view of the connection.
The system-assigned identifier of the connection.
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.
The human-readable display name of the connection.
The maximum length is 200 characters.
The current status of the connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
delegate
ConnectionDelegate
The delegated connection.
The delegated connection identifier.
The client defined unique identifier of the delegated connection.
The human-readable display name of the delegated connection.
The current status of the delegated connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
The delegated connection type.
providers
ConnectionProvider[]
The connection providers.
Whether the connection is the default for the provider type.
The creation time of the connection.
The last update time of the connection.
The Auth0 connection data.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The service account key in JSON format.
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.
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
The Postmark server ID.
This is automatically populated when the server token is updated.
The from email address.
The Postmark account must be allowed to send from this email address.
The email name (e.g. Jane Doe).
The reply to email address.
The email name (e.g. Jane Doe).
The Stripe billing configuration data.
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
The live vs test status for the Stripe account.
The webhooks configuration data.
The URL of the events webhook.
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The signing secret value.
The time the signing secret is set to expire.
The external identifier of the connected product.
The status of the connected product.
Possible values:ACTIVEBROKENDISABLED
The code that best describes the reason for the state.
The last time the product was pulled from the connection.
The last time the product was pushed to the connection.
The creation time of the product connection.
The last update time of the product connection.
The creation time of the product.
The last update time of the product.
currentPeriodQuantity
int32
The quantity which has been invoiced for the current billing period.
This might be less than the total quantity while a subscription change is pending or if the subscription is over-provisioned.
The quantity scheduled to appear on the next invoice.
This will only be set when different from current period quantity.
The quantity currently in use.
The quantity available for use.
The sum of the assigned and unassigned quantities.
paymentMethod
PaymentMethod
The system-assigned identifier of the payment method.
The external identifier of the connected payment method.
The status of the connected payment method.
Possible values:ACTIVEBROKENARCHIVED
The code that best describes the reason for the state.
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.
The full name of the owner of the payment method.
The address for the payment method.
The city, district, suburb, town, or village.
The state, country, province, or region.
The 2-letter country code.
Whether the payment method is the default for the connected account.
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
The general error code (e.g. INVALID_ARGUMENT).
Possible values:OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
A developer-facing error message.
A reason code for the error (e.g. USER_PENDING_DELETION).
The parameter path related to the error (e.g. member.userId).
Additional metadata related to the error.
The last time the payment method was pulled from the connection.
The creation time of the payment method connection.
The last update time of the payment method connection.
Card payment method (e.g. Visa credit card).
The brand of the card (e.g. VISA).
Possible values:AMERICAN_EXPRESSDINERS_CLUBDISCOVERJCBMASTERCARDUNIONPAYVISA
The last for digits of the card.
The funding method for the card (e.g. DEBIT).
Possible values:CREDITDEBITPREPAID
Whether the subscription is scheduled to be canceled at the end of the current billing period.
The anchor time for the billing cycle.
The time the subscription started.
The time the subscription ends/ended.
The trial information for the subscription.
The time the trial started.
The time the trial ended/ends.
The number of days in the trial.
This number is rounded to the nearest whole number of days.
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.
The time the current billing period started.
The time the current billing period ends.
The organization owner of the subscription.
The ID field of this object must be populated if if user isn't specified.
The system-assigned identifier of the organization.
The current state of the organization.
Possible values:ACTIVEDISABLEDARCHIVEDPENDING_DELETION
The code that best describes the reason for the state.
The client defined unique identifier of the organization account.
The human-readable display name of the organization.
The email address of the organization.
Whether the organization's email address has been verified.
The E164 phone number for the organization (e.g. +12125550123).
phoneNumberVerified
boolean
Whether the organization's phone number has been verified.
The photo/avatar URL of the organization.
The default ISO-4217 currency code for the organization (e.g. USD).
The IETF BCP-47 language code for the organization (e.g. en).
The country/region code for the organization (e.g. US).
The IANA time zone for the organization (e.g. America/New_York).
The address for the organization.
The city, district, suburb, town, or village.
The state, country, province, or region.
The 2-letter country code.
accountConnections
AccountConnection[]
The system-assigned identifier of the connection.
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.
The human-readable display name of the connection.
The maximum length is 200 characters.
The current status of the connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
delegate
ConnectionDelegate
The delegated connection.
The delegated connection identifier.
The client defined unique identifier of the delegated connection.
The human-readable display name of the delegated connection.
The current status of the delegated connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
The delegated connection type.
providers
ConnectionProvider[]
The connection providers.
Whether the connection is the default for the provider type.
The creation time of the connection.
The last update time of the connection.
The Auth0 connection data.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The service account key in JSON format.
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.
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
The Postmark server ID.
This is automatically populated when the server token is updated.
The from email address.
The Postmark account must be allowed to send from this email address.
The email name (e.g. Jane Doe).
The reply to email address.
The email name (e.g. Jane Doe).
The Stripe billing configuration data.
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
The live vs test status for the Stripe account.
The webhooks configuration data.
The URL of the events webhook.
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The signing secret value.
The time the signing secret is set to expire.
The external identifier of the connected account.
The external admin URL for the connected account.
The status of the connected account.
Possible values:ACTIVEBROKENDISABLED
The code that best describes the reason for the state.
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).
The currency code for the account.
paymentMethods
PaymentMethod[]
The payment methods for connections that support it.
The system-assigned identifier of the payment method.
The external identifier of the connected payment method.
The status of the connected payment method.
Possible values:ACTIVEBROKENARCHIVED
The code that best describes the reason for the state.
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.
The full name of the owner of the payment method.
The address for the payment method.
The city, district, suburb, town, or village.
The state, country, province, or region.
The 2-letter country code.
Whether the payment method is the default for the connected account.
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
The general error code (e.g. INVALID_ARGUMENT).
Possible values:OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
A developer-facing error message.
A reason code for the error (e.g. USER_PENDING_DELETION).
The parameter path related to the error (e.g. member.userId).
Additional metadata related to the error.
The last time the payment method was pulled from the connection.
The creation time of the payment method connection.
The last update time of the payment method connection.
Card payment method (e.g. Visa credit card).
The brand of the card (e.g. VISA).
Possible values:AMERICAN_EXPRESSDINERS_CLUBDISCOVERJCBMASTERCARDUNIONPAYVISA
The last for digits of the card.
The funding method for the card (e.g. DEBIT).
Possible values:CREDITDEBITPREPAID
The last time the account was pulled from the connection.
The last time the account was pushed to the connection.
The creation time of the account connection.
The last update time of the account connection.
subscription
AccountSubscription
The organization's default active subscription.
The system-assigned identifier of the subscription.
The state of the subscription.
Possible values:ACTIVETRIALINGPAST_DUEPAUSED
The anchor time of the billing cycle.
plan
AccountSubscriptionPlan
The identifier of the plan.
The human-readable display name of the plan.
product
AccountSubscriptionProduct
The system-assigned identifier of the product.
The client defined unique identifier of the product.
The human-readable display name of the product.
The sign-up time for the organization.
The number of members in the organization.
This includes disabled users, but does not include user's marked for deletion.
Whether the organization is disabled.
The creation time of the organization.
The last update time of the organization.
The user owner of the subscription.
The ID field of this object must be populated if if organization isn't specified.
The system-assigned identifier of the user.
The current state of the user.
Possible values:ACTIVEDISABLEDARCHIVEDPENDING_DELETION
The code that best describes the reason for the state.
The client defined unique identifier of the user account.
The human-readable display name of the user.
The email address of the user.
Whether the user's email address has been verified.
The E164 phone number for the user (e.g. +12125550123).
phoneNumberVerified
boolean
Whether the user's phone number has been verified.
The photo/avatar URL of the user.
The default ISO-4217 currency code for the user (e.g. USD).
The IETF BCP-47 language code for the user (e.g. en).
The country/region code for the user (e.g. US).
The IANA time zone for the user (e.g. America/New_York).
The billing address for the user.
The city, district, suburb, town, or village.
The state, country, province, or region.
The 2-letter country code.
accountConnections
AccountConnection[]
The system-assigned identifier of the connection.
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.
The human-readable display name of the connection.
The maximum length is 200 characters.
The current status of the connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
delegate
ConnectionDelegate
The delegated connection.
The delegated connection identifier.
The client defined unique identifier of the delegated connection.
The human-readable display name of the delegated connection.
The current status of the delegated connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
The delegated connection type.
providers
ConnectionProvider[]
The connection providers.
Whether the connection is the default for the provider type.
The creation time of the connection.
The last update time of the connection.
The Auth0 connection data.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The service account key in JSON format.
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.
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
The Postmark server ID.
This is automatically populated when the server token is updated.
The from email address.
The Postmark account must be allowed to send from this email address.
The email name (e.g. Jane Doe).
The reply to email address.
The email name (e.g. Jane Doe).
The Stripe billing configuration data.
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
The live vs test status for the Stripe account.
The webhooks configuration data.
The URL of the events webhook.
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The signing secret value.
The time the signing secret is set to expire.
The external identifier of the connected account.
The external admin URL for the connected account.
The status of the connected account.
Possible values:ACTIVEBROKENDISABLED
The code that best describes the reason for the state.
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).
The currency code for the account.
paymentMethods
PaymentMethod[]
The payment methods for connections that support it.
The system-assigned identifier of the payment method.
The external identifier of the connected payment method.
The status of the connected payment method.
Possible values:ACTIVEBROKENARCHIVED
The code that best describes the reason for the state.
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.
The full name of the owner of the payment method.
The address for the payment method.
The city, district, suburb, town, or village.
The state, country, province, or region.
The 2-letter country code.
Whether the payment method is the default for the connected account.
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
The general error code (e.g. INVALID_ARGUMENT).
Possible values:OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
A developer-facing error message.
A reason code for the error (e.g. USER_PENDING_DELETION).
The parameter path related to the error (e.g. member.userId).
Additional metadata related to the error.
The last time the payment method was pulled from the connection.
The creation time of the payment method connection.
The last update time of the payment method connection.
Card payment method (e.g. Visa credit card).
The brand of the card (e.g. VISA).
Possible values:AMERICAN_EXPRESSDINERS_CLUBDISCOVERJCBMASTERCARDUNIONPAYVISA
The last for digits of the card.
The funding method for the card (e.g. DEBIT).
Possible values:CREDITDEBITPREPAID
The last time the account was pulled from the connection.
The last time the account was pushed to the connection.
The creation time of the account connection.
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.
The system-assigned identifier of the subscription.
The state of the subscription.
Possible values:ACTIVETRIALINGPAST_DUEPAUSED
The anchor time of the billing cycle.
plan
AccountSubscriptionPlan
The identifier of the plan.
The human-readable display name of the plan.
product
AccountSubscriptionProduct
The system-assigned identifier of the product.
The client defined unique identifier of the product.
The human-readable display name of the product.
The user's organization memberships.
The system-assigned identifier of the organization.
The current state of the organization.
Possible values:ACTIVEDISABLEDARCHIVEDPENDING_DELETION
The code that best describes the reason for the state.
The client defined unique identifier of the organization account.
The human-readable display name of the organization.
The email address of the organization.
Whether the organization's email address has been verified.
The E164 phone number for the organization (e.g. +12125550123).
phoneNumberVerified
boolean
Whether the organization's phone number has been verified.
The photo/avatar URL of the organization.
The default ISO-4217 currency code for the organization (e.g. USD).
The IETF BCP-47 language code for the organization (e.g. en).
The country/region code for the organization (e.g. US).
The IANA time zone for the organization (e.g. America/New_York).
The address for the organization.
The city, district, suburb, town, or village.
The state, country, province, or region.
The 2-letter country code.
accountConnections
AccountConnection[]
The system-assigned identifier of the connection.
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.
The human-readable display name of the connection.
The maximum length is 200 characters.
The current status of the connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
delegate
ConnectionDelegate
The delegated connection.
The delegated connection identifier.
The client defined unique identifier of the delegated connection.
The human-readable display name of the delegated connection.
The current status of the delegated connection.
Possible values:PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
The code that best describes the reason for the state.
The delegated connection type.
providers
ConnectionProvider[]
The connection providers.
Whether the connection is the default for the provider type.
The creation time of the connection.
The last update time of the connection.
The Auth0 connection data.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
The Google Cloud Identity Platform (Firebase Auth) connection.
The service account key in JSON format.
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.
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
The Postmark server ID.
This is automatically populated when the server token is updated.
The from email address.
The Postmark account must be allowed to send from this email address.
The email name (e.g. Jane Doe).
The reply to email address.
The email name (e.g. Jane Doe).
The Stripe billing configuration data.
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
The live vs test status for the Stripe account.
The webhooks configuration data.
The URL of the events webhook.
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The signing secret value.
The time the signing secret is set to expire.
The external identifier of the connected account.
The external admin URL for the connected account.
The status of the connected account.
Possible values:ACTIVEBROKENDISABLED
The code that best describes the reason for the state.
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).
The currency code for the account.
paymentMethods
PaymentMethod[]
The payment methods for connections that support it.
The system-assigned identifier of the payment method.
The external identifier of the connected payment method.
The status of the connected payment method.
Possible values:ACTIVEBROKENARCHIVED
The code that best describes the reason for the state.
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.
The full name of the owner of the payment method.
The address for the payment method.
The city, district, suburb, town, or village.
The state, country, province, or region.
The 2-letter country code.
Whether the payment method is the default for the connected account.
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
The general error code (e.g. INVALID_ARGUMENT).
Possible values:OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
A developer-facing error message.
A reason code for the error (e.g. USER_PENDING_DELETION).
The parameter path related to the error (e.g. member.userId).
Additional metadata related to the error.
The last time the payment method was pulled from the connection.
The creation time of the payment method connection.
The last update time of the payment method connection.
Card payment method (e.g. Visa credit card).
The brand of the card (e.g. VISA).
Possible values:AMERICAN_EXPRESSDINERS_CLUBDISCOVERJCBMASTERCARDUNIONPAYVISA
The last for digits of the card.
The funding method for the card (e.g. DEBIT).
Possible values:CREDITDEBITPREPAID
The last time the account was pulled from the connection.
The last time the account was pushed to the connection.
The creation time of the account connection.
The last update time of the account connection.
subscription
AccountSubscription
The organization's default active subscription.
The system-assigned identifier of the subscription.
The state of the subscription.
Possible values:ACTIVETRIALINGPAST_DUEPAUSED
The anchor time of the billing cycle.
plan
AccountSubscriptionPlan
The identifier of the plan.
The human-readable display name of the plan.
product
AccountSubscriptionProduct
The system-assigned identifier of the product.
The client defined unique identifier of the product.
The human-readable display name of the product.
The sign-up time for the organization.
The number of members in the organization.
This includes disabled users, but does not include user's marked for deletion.
Whether the organization is disabled.
The creation time of the organization.
The last update time of the organization.
The user's role within the organization.
The system-assigned identifier of the role.
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.
The human-readable display name of the role.
Possible values:OWNERMEMBERGUEST
The description of the role.
The maximum length is 1000 characters.
The additional permissions allowed by the role.
Whether the role is the default for the tenant.
The archived status of the role.
The creation time of the role.
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 system-assigned identifier of the product.
The client defined unique identifier of the product.
The human-readable display name of the product.
The creation time of the membership.
The last update time of the membership.
The sign-up time for the user.
Whether the user is disabled.
The creation time of the user.
The last update time of the user.
Whether the subscription is the default for the account.
The last time the subscription was pulled from the connection.
The last time the subscription was pushed to the connection.
The creation time of the subscription.
The last update time of the subscription.