Skip to content
Get started

Shared

ModelsExpand Collapse
class ApiKeyReference:

A reference to an API key with basic identifying information

String apiKeyId

Unique API key identifier (UUIDv4 format)

formatuuid
String description

Human-readable description of the API key

minLength1
Optional<Boolean> isViewerEnabled

Whether this API key has access to the Viewer product

class ExpressCustomerReference:

A reference to an Express customer with basic identifying information

String expressCustomerId

Unique Express customer identifier. Format: cus_{32-hex-chars}

String expressCustomerName

Name of the Express customer

minLength1
class UserReference:

A reference to a user with basic identifying information

String email

User's email address

String userId

Unique user identifier. Format: usr_{32-hex-chars}

Optional<String> firstName

User's first name

Optional<String> lastName

User's last name

Optional<String> middleName

User's middle name

Optional<String> suffix1

Name suffix (e.g., 'MD', 'Jr.')

Optional<String> suffix2

Additional name suffix