Docs/Admin API/Checkouts/Object

The checkout object

The checkout.

id
string
The system-assigned identifier of the checkout.
type
enum
The type of checkout.
Possible values:
CHANGECANCELRESTARTMIGRATE
state
enum
The state of the checkout.
Possible values:
STEPS_REQUIREDREADYPROCESSINGSUCCEEDEDFAILEDCANCELED
error
Status
The checkout error.
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.
currencyCode
string
The currently selected currency code.
plans
Plan[]
The plans available for checkout.
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
paymentMethod
PaymentMethod
The payment method for the checkout.
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.
fullName
string
The company or individual's full name.
address
Address
The billing address.
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.
steps
CheckoutStep[]
The steps required to complete the checkout.
type
enum
The type of step.
Possible values:
PLANITEMSTERMSTRIALPAYMENT_METHODBILLING_DETAILSDISCOUNTSCANCELCOMPLETE_PAYMENT
state
enum
The state of the step.
Possible values:
PENDINGOPTIONALREQUIREDCOMPLETED
trial
CheckoutTrialStep
The trial step details.
type
enum
Whether to start or continue a trial.
Possible values:
DEFAULTTRUEFALSE
days
int32
The number of days in the trial.
cancel
CheckoutCancelStep
The cancel step details.
type
enum
The type of cancellation.
Possible values:
RENEWALIMMEDIATELY
completePayment
CheckoutCompletePaymentStep
The complete payment step details.
paymentIntent
PaymentIntent
The payment intent for the checkout.
stripe
StripePaymentIntent
A Stripe payment intent.
accountId
string
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
live
boolean
Whether the Stripe payment intent was created in live mode.
clientSecret
string
The Stripe payment intent client secret.
items
CheckoutItem[]
The products included in the checkout.
id
string
The item identifier.
displayName
string
The display name for the item.
inputType
enum
The input type of the item.
Possible values:
HIDDENTOGGLEQUANTITY
type
enum
The type of the item.
Possible values:
PLANPLAN_ADDONSEAT
unit
enum
The unit for the item.
Possible values:
PLANSEATUNITUSERCREDIT
price
Price
The price for 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.
quantity
int32
The quantity for the item.
minQuantity
int32
The minimum quantity allowed.
This will only be set when quantity is settable.
maxQuantity
int32
The maximum quantity allowed.
This will only be set when the quantity is settable and there is a discrete (non-infinity) maximum.
renewQuantity
int32
The quantity at which the plan will renew.
This will only be set when different from quantity and the subscription is set to renew.
minRenewQuantity
int32
The minimum renew quantity allowed.
This will only be set when renew quantity is settable.
maxRenewQuantity
int32
The maximum renew quantity allowed.
This will only be set when the new quantity is settable and there is a discrete (non-infinity) maximum.
period
Period
The billing period for the item.
startTime
date-time
The start time.
endTime
date-time
The end time.
subtotalAmount
string
The subtotal amount at checkout.
discountAmount
string
The item-level discount amount at checkout.
renewAmount
string
The normal recurring amount.
This does not include any time-limited discounts.
preview
boolean
Whether this is a preview-only item.
Preview-only items are generally prorations or other pending charges or credits.
groupItemId
string
The item identifier for which you can group this item.
This allows you to group credits and other preview items with the related plan, seat, or add-on item.
discounts
CheckoutDiscount[]
The discounts applied to the checkout.
id
string
The checkout discount identifier.
code
string
The discount code.
subtotalAmount
string
The subtotal amount for the checkout.
This includes item-level discounts.
discountAmount
string
The top-level discount amount.
This does not include item level discounts.
taxAmount
string
The tax amount for the checkout.
This is for rendering purposes only and is not the reported tax amount.
totalAmount
string
The total amount for the checkout.
balanceAppliedAmount
string
The amount applied to the checkout from the balance.
A negative amount means a debit from the account balance. A positive amount means a credit to the account balance.
dueAmount
string
The total amount minus any credits automatically associated with the invoice.
renewAmount
string
The normal total recurring amount.
This does not include any time-limited discounts.

PreviousCheckouts

NextCreate a checkout