Documentation
Documentation
Analytics Schema BETA
accountsubscriber accountsubscriber
  • accountId
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • state
    string
    The object's current state.
  • subscriber
    bigint
     
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
accountsubscription accountsubscription
  • accountSubscriber
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • state
    string
    The object's current state.
  • subscription
    bigint
     
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
boardingtrialsubscription boardingtrialsubscription
  • accountId
    bigint
     
  • couponCodes
    array
     
  • createdOn
    timestamp
    The date and time when the object was created.
  • currency
    string
     
  • expireDate
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • lastNotifiedOn
    timestamp
     
  • productVersion
    bigint
     
  • selectedComponents
    array
     
  • state
    string
    The object's current state.
  • subscriber
    bigint
     
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
subscriptionproductcomponentquantity subscriptionproductcomponentquantity
  • id
    bigint
    A unique identifier for the object.
  • quantity
    bigint
     
  • subscriptionProductComponent
    bigint
     
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
account account
  • active
    boolean
    Whether this account and all its parent accounts are active.
  • activeOrRestrictedActive
    boolean
    Whether this account and all its parent accounts are active or restricted active.
  • createdBy
    bigint
    The ID of the user the account was created by.
  • createdOn
    timestamp
    The date and time when the account was created.
  • deletedBy
    bigint
    The ID of a user the account was deleted by.
  • deletedOn
    timestamp
    The date and time when the account was deleted.
  • id
    bigint
    A unique identifier for the object.
  • lastModifiedDate
    timestamp
    The date and time when the object was last modified.
  • name
    string
    The name used to identify the account.
  • parentAccount
    bigint
    The parent account responsible for administering this account.
  • restrictedActive
    boolean
    Whether this account and all its parent accounts are active or restricted active. There is at least one account that is restricted active.
  • scope
    bigint
    The scope that the account belongs to.
  • state
    string
    The object's current state.
  • subaccountLimit
    bigint
    The number of sub-accounts that can be created within this account.
  • type
    string
    The account's type which defines its role and capabilities.
failurereason failurereason
  • category
    string
    The category that the failure reason belongs to.
  • description
    map
    The localized description of the object.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    The localized name of the object.
labeldescriptor labeldescriptor
  • category
    string
    The label's category.
  • description
    map
    The localized description of the object.
  • group
    bigint
    The group that this label belongs to.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    The localized name of the object.
  • weight
    int
    When listing labels, they can be sorted by this number.
labeldescriptorgroup labeldescriptorgroup
  • description
    map
    The localized description of the object.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    The localized name of the object.
  • weight
    int
    When listing label groups, they can be sorted by this number.
space space
  • account
    bigint
    The account that the space belongs to.
  • active
    boolean
    Whether this space and all its parent accounts are active.
  • activeOrRestrictedActive
    boolean
    Whether this space and all its parent accounts are active or restricted active.
  • createdBy
    bigint
    The ID of the user the space was created by.
  • createdOn
    timestamp
    The date and time when the space was created.
  • deletedBy
    bigint
    The ID of the user the space was deleted by.
  • deletedOn
    timestamp
    The date and time when the space was deleted.
  • id
    bigint
    A unique identifier for the object.
  • lastModifiedDate
    timestamp
    The date and time when the object was last modified.
  • name
    string
    The name used to identify the space.
  • postalAddress
    struct
    The address that is used in communication with clients for example in emails, documents, etc.
  • postalAddress.city
    string
     
  • postalAddress.country
    string
     
  • postalAddress.dependentLocality
    string
     
  • postalAddress.emailAddress
    string
     
  • postalAddress.familyName
    string
     
  • postalAddress.givenName
    string
     
  • postalAddress.mobilePhoneNumber
    string
     
  • postalAddress.organizationName
    string
     
  • postalAddress.phoneNumber
    string
     
  • postalAddress.postalState
    string
     
  • postalAddress.postcode
    string
     
  • postalAddress.salesTaxNumber
    string
     
  • postalAddress.salutation
    string
     
  • postalAddress.sortingCode
    string
     
  • postalAddress.street
    string
     
  • primaryCurrency
    string
    The currency that is used to display aggregated amounts in the space.
  • requestLimit
    bigint
    The maximum number of API requests that are accepted within two minutes. This limit can only be changed with special privileges.
  • restrictedActive
    boolean
    Whether this space and all its parent accounts are active or restricted active. There is least one parent account that is restricted active.
  • state
    string
    The object's current state.
  • technicalContactAddresses
    array
    The email address that will receive messages about technical issues and errors that occur in the space.
  • timeZone
    string
    The time zone that is used to schedule and run background processes. This does not affect the formatting of dates in the user interface.
spacereference spacereference
  • createdOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • spaceId
    bigint
     
  • state
    string
    The object's current state.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
legalorganizationform legalorganizationform
  • country
    string
    The two-letter code of the country the legal organization form is used in (ISO 3166-1 alpha-2 format).
  • description
    array
    The localized descriptions of the legal organization form.
  • englishDescription
    string
    The English name of the legal organization form.
  • id
    bigint
    A unique identifier for the object.
  • shortcut
    array
    The localized shortcuts of the legal organization form.
customer customer
  • createdOn
    timestamp
    The date and time when the object was created.
  • customerId
    string
    The customer's ID in the merchant's system.
  • emailAddress
    string
    The customer's email address.
  • familyName
    string
    The customer's family or last name.
  • givenName
    string
    The customer's given or first name.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • metaData
    map
    Allow to store additional information about the object.
  • preferredCurrency
    string
    The customer's preferred currency.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
customeraddress customeraddress
  • address
    struct
    The actual postal address.
  • address.city
    string
     
  • address.commercialRegisterNumber
    string
     
  • address.country
    string
     
  • address.dateOfBirth
    date
     
  • address.dependentLocality
    string
     
  • address.emailAddress
    string
     
  • address.familyName
    string
     
  • address.gender
    string
     
  • address.givenName
    string
     
  • address.legalOrganizationForm
    bigint
     
  • address.mobilePhoneNumber
    string
     
  • address.organizationName
    string
     
  • address.phoneNumber
    string
     
  • address.postalState
    string
     
  • address.postcode
    string
     
  • address.salesTaxNumber
    string
     
  • address.salutation
    string
     
  • address.socialSecurityNumber
    string
     
  • address.sortingCode
    string
     
  • address.street
    string
     
  • addressType
    string
    Whether the address is for billing or shipping or both.
  • createdOn
    timestamp
    The date and time when the object was created.
  • customer
    bigint
    The customer that the object belongs to.
  • defaultAddress
    boolean
    Whether this is the customer's default address.
  • id
    bigint
    A unique identifier for the object.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
taxclass taxclass
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    The name used to identify the tax class.
  • state
    string
    The object's current state.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
charge charge
  • createdOn
    timestamp
    The date on which the charge was created on.
  • failureReason
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • spaceViewId
    bigint
    The ID of the space view this object is linked to.
  • state
    string
    The object's current state.
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • transaction
    bigint
     
  • type
    string
     
  • userFailureMessage
    string
    The failure message describes for an end user why the charge is failed in the language of the user. This is only provided when the charge is marked as failed.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
chargeattempt chargeattempt
  • charge
    bigint
     
  • completionBehavior
    string
     
  • connectorConfiguration
    bigint
     
  • createdOn
    timestamp
    The date and time when the object was created.
  • customersPresence
    string
    The customers presence indicates which kind of customer interaction was used during the charge attempt.
  • environment
    string
     
  • failedOn
    timestamp
     
  • failureReason
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • initializingTokenVersion
    boolean
     
  • invocation
    bigint
     
  • language
    string
    The language that is linked to the object.
  • linkedTransaction
    bigint
     
  • nextUpdateOn
    timestamp
     
  • redirectionUrl
    string
     
  • salesChannel
    bigint
     
  • spaceViewId
    bigint
    The ID of the space view this object is linked to.
  • state
    string
    The object's current state.
  • succeededOn
    timestamp
     
  • terminal
    bigint
     
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • userFailureMessage
    string
    The user failure message contains the message for the user in case the attempt failed. The message is localized into the language specified on the transaction.
  • wallet
    bigint
     
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
saleschannel saleschannel
  • description
    map
    The localized description of the object.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    The localized name of the object.
  • sortOrder
    int
    When listing sales channels, they can be sorted by this number.
connectorinvocation connectorinvocation
  • createdOn
    timestamp
    The date and time when the object was created.
  • id
    bigint
    A unique identifier for the object.
  • stage
    string
     
  • timeTookInMilliseconds
    bigint
     
  • transaction
    bigint
     
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
paymentconnector paymentconnector
  • dataCollectionType
    string
    The data collection type specifies how the payment information is collected.
  • deprecated
    boolean
    Whether the object was deprecated.
  • deprecationReason
    map
    The deprecation reason describes why the object was deprecated.
  • description
    map
    The localized description of the object.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    The localized name of the object.
  • paymentMethod
    bigint
    The payment method that the connector supports.
  • paymentMethodBrand
    bigint
    The specific brand that this payment connector supports.
  • primaryRiskTaker
    string
    The entity that bears the main risk in the event that a contracting party fails to meet its obligations.
  • processor
    bigint
    The processor that the connector belongs to.
  • supportedCurrencies
    array
    The currencies that are supported by the connector.
paymentconnectorconfiguration paymentconnectorconfiguration
  • applicableForTransactionProcessing
    boolean
    Whether this connector configuration is enabled for processing payments, taking into account the state of the processor and payment method configurations.
  • connector
    bigint
    The connector that the configuration is for.
  • enabledSalesChannels
    array
    The sales channels for which the connector configuration is enabled. If empty, it is enabled for all sales channels.
  • enabledSpaceViews
    array
    The space views for which the connector configuration is enabled. If empty, it is enabled for all space views.
  • id
    bigint
    A unique identifier for the object.
  • imagePath
    string
    The URL to the connector's image.
  • name
    string
    The name used to identify the connector configuration.
  • paymentMethodConfiguration
    bigint
    The payment method configuration that the connector configuration belongs to.
  • priority
    int
    The priority that determines the order in which connector configurations are taken into account when processing a payment. Low values are considered first.
  • processorConfiguration
    bigint
    The processor configuration that the connector configuration belongs to.
  • state
    string
    The object's current state.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
paymentcontract paymentcontract
  • account
    bigint
    This account that the contract belongs to.
  • activatedOn
    timestamp
    The date and time when the contract was activated.
  • contractIdentifier
    string
    The identifier of the contract.
  • createdOn
    timestamp
    The date and time when the object was created.
  • externalId
    string
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
  • id
    bigint
    A unique identifier for the object.
  • lastModifiedDate
    timestamp
    The date and time when the object was last modified.
  • rejectedOn
    timestamp
    The date and time when the contract was rejected.
  • rejectionReason
    bigint
    The reason for rejecting the contract.
  • startTerminatingOn
    timestamp
    The date and time when the termination process of the contract was started.
  • state
    string
    The object's current state.
  • terminatedOn
    timestamp
    The date and time when the contract was terminated.
paymentmethod paymentmethod
  • dataCollectionTypes
    array
    The data collection types that are supported by the payment method.
  • description
    map
    The localized description of the object.
  • id
    bigint
    A unique identifier for the object.
  • merchantDescription
    map
     
  • name
    map
    The localized name of the object.
  • supportedCurrencies
    array
    The currencies that are supported by the payment method.
paymentmethodbrand paymentmethodbrand
  • description
    map
    The localized description of the object.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    The localized name of the object.
  • paymentMethod
    bigint
    The payment method that the brand belongs to.
paymentmethodconfiguration paymentmethodconfiguration

The payment method configuration builds the base to connect with different payment method connectors.

The payment method configuration builds the base to connect with different payment method connectors.
  • dataCollectionType
    string
    The data collection type specifies how the payment information is collected.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    The name used to identify the payment method configuration.
  • oneClickPaymentMode
    string
    The one-click payment mode determines whether the customer can save their payment details for later payments.
  • paymentMethod
    bigint
    The payment method that the configuration is for.
  • resolvedDescription
    map
    The description for the payment method that is actually displayed to the customer. This is either the custom description, if defined, or otherwise the payment method's default one.
  • resolvedTitle
    map
    The title for the payment method that is actually displayed to the customer. This is either the custom title, if defined, or otherwise the payment method's default one.
  • sortOrder
    int
    When listing payment methods, they can be sorted by this number.
  • state
    string
    The object's current state.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
paymentprocessor paymentprocessor

Payment processors handle the connection to third part companies (payment service providers) that technically manage payment transactions and therefore process payments.

Payment processors handle the connection to third part companies (payment service providers) that technically manage payment transactions and therefore process payments.
  • companyName
    map
    The name of the company to which the processor belongs.
  • description
    map
    The localized description of the object.
  • headquartersLocation
    map
    Where the processor's headquarters are located.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    The localized name of the object.
  • productName
    map
    The name of the processor's product.
paymentprocessorconfiguration paymentprocessorconfiguration
  • applicationManaged
    boolean
    Whether the processor configuration is managed by the application and therefore cannot be changed.
  • contractId
    bigint
    The ID of the payment contract the processor configuration is linked to.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    The name used to identify the payment method configuration.
  • processor
    bigint
    The payment processor that the configuration is for.
  • state
    string
    The object's current state.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
refund refund

The refund represents a credit back to the customer. It can be issued by the merchant or by the customer (reversal).

The refund represents a credit back to the customer. It can be issued by the merchant or by the customer (reversal).
  • amount
    decimal
     
  • baseLineItems
    array
     
  • completion
    bigint
     
  • createdBy
    bigint
     
  • createdOn
    timestamp
    The date and time when the object was created.
  • environment
    string
     
  • externalId
    string
    The external id helps to identify duplicate calls to the refund service. As such the external ID has to be unique per transaction.
  • failedOn
    timestamp
     
  • failureReason
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • labels
    array
    The labels providing additional information about the object.
  • language
    string
    The language that is linked to the object.
  • lineItems
    array
     
  • merchantReference
    string
     
  • nextUpdateOn
    timestamp
     
  • processingOn
    timestamp
     
  • processorReference
    string
     
  • reducedLineItems
    array
     
  • reductions
    array
     
  • state
    string
    The object's current state.
  • succeededOn
    timestamp
     
  • taxes
    array
     
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • totalAppliedFees
    decimal
    The total applied fees is the sum of all fees that have been applied so far.
  • totalSettledAmount
    decimal
    The total settled amount is the total amount which has been settled so far.
  • transaction
    bigint
     
  • type
    string
     
  • updatedInvoice
    bigint
     
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
paymentterminal paymentterminal
  • defaultCurrency
    string
    The default currency of the terminal.
  • id
    bigint
    A unique identifier for the object.
  • identifier
    string
    The unique identifier of the terminal, that is displayed on the device.
  • name
    string
    The name used to identify the payment terminal.
  • state
    string
    The object's current state.
  • type
    bigint
    The type of the payment terminal.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
paymentterminaltype paymentterminaltype
  • description
    map
    The localized description of the object.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    The localized name of the object.
token token
  • createdOn
    timestamp
    The date and time when the object was created.
  • customerEmailAddress
    string
    The customer's email address.
  • customerId
    string
    The unique identifier of the customer in the external system.
  • enabledForOneClickPayment
    boolean
    Whether the token is enabled for one-click payments, which simplify the payment process for the customer. One-click tokens are linked to customers via the customer ID.
  • externalId
    string
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • state
    string
    The object's current state.
  • timeZone
    string
    The customer's time zone, which affects how dates and times are formatted when communicating with the customer.
  • tokenReference
    string
    The reference used to identify the payment token (e.g. the customer's ID or email address).
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
transaction transaction
  • acceptHeader
    string
    The 'Accept' header of the customer's web browser.
  • acceptLanguageHeader
    string
    The 'Accept Language' header of the customer's web browser.
  • allowedPaymentMethodBrands
    array
    The payment method brands that can be used to authorize the transaction.
  • allowedPaymentMethodConfigurations
    array
    The payment method configurations that can be used to authorize the transaction.
  • authorizationAmount
    decimal
    The sum of all line item prices including taxes in the transaction's currency.
  • authorizationEnvironment
    string
    The environment in which the transaction was authorized.
  • authorizationSalesChannel
    bigint
    The sales channel through which the transaction was placed.
  • authorizationTimeoutOn
    timestamp
    The date and time when the transaction must be authorized, otherwise it will canceled.
  • authorizedOn
    timestamp
    The date and time when the transaction was authorized.
  • autoConfirmationEnabled
    boolean
    Whether the transaction can be confirmed automatically or whether this must be done explicitly via the API. Default is true.
  • billingAddress
    struct
    The address associated with the payment method for invoicing and transaction processing purposes.
  • billingAddress.city
    string
     
  • billingAddress.commercialRegisterNumber
    string
     
  • billingAddress.country
    string
     
  • billingAddress.dateOfBirth
    date
     
  • billingAddress.dependentLocality
    string
     
  • billingAddress.emailAddress
    string
     
  • billingAddress.familyName
    string
     
  • billingAddress.gender
    string
     
  • billingAddress.givenName
    string
     
  • billingAddress.legalOrganizationForm
    bigint
     
  • billingAddress.mobilePhoneNumber
    string
     
  • billingAddress.organizationName
    string
     
  • billingAddress.phoneNumber
    string
     
  • billingAddress.postalState
    string
     
  • billingAddress.postcode
    string
     
  • billingAddress.salesTaxNumber
    string
     
  • billingAddress.salutation
    string
     
  • billingAddress.socialSecurityNumber
    string
     
  • billingAddress.sortingCode
    string
     
  • billingAddress.street
    string
     
  • chargeRetryEnabled
    boolean
    Whether the customer can make further payment attempts if the first one has failed. Default is true.
  • completedAmount
    decimal
    The total amount that was completed, in the transaction's currency.
  • completedOn
    timestamp
    The date and time when the transaction was completed.
  • completionBehavior
    string
    The behavior that controls when the transaction is completed.
  • completionTimeoutOn
    timestamp
    The date and time when the transaction is completed automatically.
  • confirmedBy
    bigint
    The ID of the user the transaction was confirmed by.
  • confirmedOn
    timestamp
    The date and time when the transaction was created.
  • createdBy
    bigint
    The ID of the user the transaction was created by.
  • createdOn
    timestamp
    The date and time when the object was created.
  • currency
    string
    The three-letter code (ISO 4217 format) of the transaction's currency.
  • customerEmailAddress
    string
    The customer's email address.
  • customerId
    string
    The unique identifier of the customer in the external system.
  • customersPresence
    string
    The customer's presence indicates whether and in what way the transaction's customer is present. Default is VIRTUAL_PRESENT.
  • deliveryDecisionMadeOn
    timestamp
    This date and time when the decision was made as to whether the order should be shipped.
  • deviceSessionIdentifier
    string
    Allows to link the transaction to the data collected from the customer's device.
  • emailsDisabled
    boolean
    Whether email sending is deactivated for the transaction. Default is false.
  • environment
    string
     
  • environmentSelectionStrategy
    string
    The strategy for determining whether the transaction is to be processed in the test or production environment.
  • failedOn
    timestamp
    The date and time when the transaction failed.
  • failedUrl
    string
    The URL to redirect the customer back to after they canceled or failed to authenticated their payment.
  • failureReason
    bigint
    The reason for the failure of the transaction.
  • id
    bigint
    A unique identifier for the object.
  • internetProtocolAddress
    string
    The IP address of the customer's device.
  • internetProtocolAddressCountry
    string
    The country determined from the IP address of the customer's device.
  • invoiceMerchantReference
    string
    The merchant's reference used to identify the invoice.
  • javaEnabled
    boolean
    Whether Java is enabled on the customer's web browser.
  • language
    string
    The language that is linked to the object.
  • lineItems
    array
    The line items purchased by the customer.
  • merchantReference
    string
    The merchant's reference used to identify the transaction.
  • metaData
    map
    Allow to store additional information about the object.
  • parent
    bigint
    The parent transaction which was (partially) replaced by this transaction.
  • paymentConnectorConfiguration
    bigint
    The payment connector configuration that was used to authorize the transaction.
  • processingOn
    timestamp
    The date and time when the processing of the transaction was started.
  • refundedAmount
    decimal
    The total amount that was refunded, in the transaction's currency.
  • screenColorDepth
    string
    The screen color depth of the customer's web browser.
  • screenHeight
    string
    The screen height of the customer's web browser.
  • screenWidth
    string
    The screen width of the customer's web browser.
  • shippingAddress
    struct
    The address to where the order will be shipped.
  • shippingAddress.city
    string
     
  • shippingAddress.commercialRegisterNumber
    string
     
  • shippingAddress.country
    string
     
  • shippingAddress.dateOfBirth
    date
     
  • shippingAddress.dependentLocality
    string
     
  • shippingAddress.emailAddress
    string
     
  • shippingAddress.familyName
    string
     
  • shippingAddress.gender
    string
     
  • shippingAddress.givenName
    string
     
  • shippingAddress.legalOrganizationForm
    bigint
     
  • shippingAddress.mobilePhoneNumber
    string
     
  • shippingAddress.organizationName
    string
     
  • shippingAddress.phoneNumber
    string
     
  • shippingAddress.postalState
    string
     
  • shippingAddress.postcode
    string
     
  • shippingAddress.salesTaxNumber
    string
     
  • shippingAddress.salutation
    string
     
  • shippingAddress.socialSecurityNumber
    string
     
  • shippingAddress.sortingCode
    string
     
  • shippingAddress.street
    string
     
  • shippingMethod
    string
    The name of the shipping method used to ship the products.
  • spaceViewId
    bigint
    The ID of the space view this object is linked to.
  • state
    string
    The object's current state.
  • successUrl
    string
    The URL to redirect the customer back to after they successfully authenticated their payment.
  • terminal
    bigint
    The payment terminal through which the payment was processed.
  • timeZone
    string
    The customer's time zone, which affects how dates and times are formatted when communicating with the customer.
  • token
    bigint
    The payment token that should be used to charge the customer.
  • tokenizationMode
    string
    The tokenization mode specifies whether and how the tokenization of payment information is applied to the transaction.
  • totalAppliedFees
    decimal
    The total of all fees charged, in the transaction's currency.
  • totalSettledAmount
    decimal
    The total amount that was settled, in the transaction's currency.
  • userAgentHeader
    string
    The 'User Agent' header of the customer's web browser.
  • userFailureMessage
    string
    The message that can be displayed to the customer explaining why the transaction failed, in the customer's language.
  • userInterfaceType
    string
    The type of user interface the customer used to provide the payment information.
  • windowHeight
    string
    The window height of the customer's web browser.
  • windowWidth
    string
    The window width of the customer's web browser.
  • yearsToKeep
    int
    The number of years the transaction is kept after its authorization.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
transactioncompletion transactioncompletion
  • amount
    decimal
    The amount which is captured. The amount represents sum of line items including taxes.
  • baseLineItems
    array
    The base line items on which the completion is applied on.
  • createdBy
    bigint
     
  • createdOn
    timestamp
    The date and time when the object was created.
  • externalId
    string
    The external ID helps to identify the entity and a subsequent creation of an entity with the same ID will not create a new entity.
  • failedOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • invoiceMerchantReference
    string
     
  • labels
    array
    The labels providing additional information about the object.
  • language
    string
    The language that is linked to the object.
  • lastCompletion
    boolean
    Indicates if this is the last completion. After the last completion is created the transaction cannot be completed anymore.
  • lineItems
    array
    The line items which are captured.
  • linkedTransaction
    bigint
     
  • mode
    string
     
  • nextUpdateOn
    timestamp
     
  • paymentInformation
    string
     
  • processingOn
    timestamp
     
  • processorReference
    string
     
  • remainingLineItems
    array
     
  • spaceViewId
    bigint
    The ID of the space view this object is linked to.
  • state
    string
    The object's current state.
  • statementDescriptor
    string
    The statement descriptor explain charges or payments on bank statements.
  • succeededOn
    timestamp
     
  • taxAmount
    decimal
    The total sum of all taxes of line items.
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
transactioninvoice transactioninvoice

The transaction invoice represents the invoice document for a particular transaction.

The transaction invoice represents the invoice document for a particular transaction.
  • amount
    decimal
     
  • billingAddress
    struct
     
  • billingAddress.city
    string
     
  • billingAddress.commercialRegisterNumber
    string
     
  • billingAddress.country
    string
     
  • billingAddress.dateOfBirth
    date
     
  • billingAddress.dependentLocality
    string
     
  • billingAddress.emailAddress
    string
     
  • billingAddress.familyName
    string
     
  • billingAddress.gender
    string
     
  • billingAddress.givenName
    string
     
  • billingAddress.legalOrganizationForm
    bigint
     
  • billingAddress.mobilePhoneNumber
    string
     
  • billingAddress.organizationName
    string
     
  • billingAddress.phoneNumber
    string
     
  • billingAddress.postalState
    string
     
  • billingAddress.postcode
    string
     
  • billingAddress.salesTaxNumber
    string
     
  • billingAddress.salutation
    string
     
  • billingAddress.socialSecurityNumber
    string
     
  • billingAddress.sortingCode
    string
     
  • billingAddress.street
    string
     
  • completion
    bigint
     
  • createdOn
    timestamp
    The date on which the invoice is created on.
  • derecognizedBy
    bigint
    The id of the user which marked the invoice as derecognized.
  • derecognizedOn
    timestamp
    The date on which the invoice is marked as derecognized.
  • dueOn
    timestamp
    The date on which the invoice should be paid on.
  • environment
    string
     
  • externalId
    string
    The external id helps to identify the entity and a subsequent creation of an entity with the same ID will not create a new entity.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • lineItems
    array
     
  • linkedTransaction
    bigint
     
  • merchantReference
    string
     
  • outstandingAmount
    decimal
    The outstanding amount indicates how much the buyer owes the merchant. A negative amount indicates that the invoice is overpaid.
  • paidOn
    timestamp
    The date on which the invoice is marked as paid. Eventually this date lags behind of the actual paid date.
  • spaceViewId
    bigint
    The ID of the space view this object is linked to.
  • state
    string
    The object's current state.
  • taxAmount
    decimal
     
  • timeZone
    string
     
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
wallettype wallettype
  • description
    map
    The localized description of the object.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    The localized name of the object.
subscriptionaffiliate subscriptionaffiliate
  • externalId
    string
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • metaData
    map
    Allow to store additional information about the object.
  • name
    string
    The name used to identify the affiliate.
  • reference
    string
    The reference used to identify the affiliate.
  • state
    string
    The object's current state.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
subscription subscription
  • activatedOn
    timestamp
    The date and time when the subscription was activate.
  • affiliate
    bigint
    The affiliate that led to the creation of the subscription.
  • createdOn
    timestamp
    The date and time when the subscription was created.
  • currentProductVersion
    bigint
    The version of the product that the subscription is currently linked to.
  • description
    string
    A description used to identify the subscription.
  • id
    bigint
    A unique identifier for the object.
  • initializedOn
    timestamp
    The date and time when the subscription was initialized.
  • language
    string
    The language that is linked to the object.
  • plannedTerminationDate
    timestamp
    The date and time when the subscription is planned to be terminated.
  • reference
    string
    The merchant's reference used to identify the subscription.
  • state
    string
    The object's current state.
  • subscriber
    bigint
    The subscriber that the subscription belongs to.
  • terminatedBy
    bigint
    The ID of the user the subscription was terminated by.
  • terminatedOn
    timestamp
    The date and time when the subscription was terminated.
  • terminatingOn
    timestamp
    The date and time when the termination of the subscription started.
  • terminationScheduledOn
    timestamp
    The date and time when the subscription was scheduled to be terminated.
  • token
    bigint
    The payment token that is used to charge the customer.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
subscriptioncomponentconfiguration subscriptioncomponentconfiguration
  • component
    bigint
    The component that is being configured.
  • id
    bigint
    A unique identifier for the object.
  • quantity
    decimal
    The quantity that should be applied to the component.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
subscriptionperiodbill subscriptionperiodbill
  • createdOn
    timestamp
    The date and time when the period bill was created.
  • effectivePeriodEndDate
    timestamp
    The date and time when the period actually ended.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • periodStartDate
    timestamp
    The date and time when the period started.
  • plannedPeriodEndDate
    timestamp
    The date and time when the period is planned to end.
  • state
    string
    The object's current state.
  • subscriptionVersion
    bigint
    The subscription version that the period bill belongs to.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
subscriptionperiodbillitem subscriptionperiodbillitem
  • bill
    bigint
     
  • fee
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • ledgerEntry
    bigint
     
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
subscriptionversion subscriptionversion
  • activatedOn
    timestamp
    The date and time when the subscription version was activated.
  • billingCurrency
    string
    The three-letter code (ISO 4217 format) of the currency used to invoice the customer. Must be one of the currencies supported by the product.
  • createdOn
    timestamp
    The date and time when the subscription version was created.
  • expectedLastPeriodEnd
    timestamp
    The date and time when the last period is expected to end.
  • failedOn
    timestamp
    The date and time when the subscription version failed.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • plannedTerminationDate
    timestamp
    The date and time when the termination of the subscription version is planned.
  • productVersion
    bigint
    The product version that is subscribed to.
  • state
    string
    The object's current state.
  • subscription
    bigint
    The subscription that this version belongs to.
  • terminatedOn
    timestamp
    The date and time when the subscription version was terminated.
  • terminatingOn
    timestamp
    The date and time when the termination of the subscription version started.
  • terminationIssuedOn
    timestamp
    The date and time when the termination of the subscription version was issued.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
subscriptioncharge subscriptioncharge

The subscription charge represents a single charge carried out for a particular subscription.

The subscription charge represents a single charge carried out for a particular subscription.
  • createdOn
    timestamp
    The date and time when the charge was created.
  • discardedBy
    bigint
    The ID of the user the charge was discarded by.
  • discardedOn
    timestamp
    The date and time when the charge was discarded.
  • externalId
    string
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
  • failedOn
    timestamp
    The date and time when the charge failed.
  • failedUrl
    string
    The URL to redirect the customer back to after they canceled or failed to authenticated their payment.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • ledgerEntries
    array
    The ledger entries that belong to the charge.
  • plannedExecutionDate
    timestamp
    The date and time when the execution of the charge is planned.
  • processingType
    string
    The processing type specifies how the charge is to be processed.
  • reference
    string
    The merchant's reference used to identify the charge.
  • state
    string
    The object's current state.
  • subscription
    bigint
    The subscription that the charge belongs to.
  • succeedOn
    timestamp
    The date and time when the charge succeeded.
  • successUrl
    string
    The URL to redirect the customer back to after they successfully authenticated their payment.
  • transaction
    bigint
    The transaction used to process the charge.
  • type
    string
    The type specified how the charge was initiated.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
subscriptionledgerentry subscriptionledgerentry

The subscription ledger entry represents a single change on the subscription balance.

The subscription ledger entry represents a single change on the subscription balance.
  • aggregatedTaxRate
    decimal
    The total tax rate applied to the ledger entry, calculated from the rates of all tax lines.
  • amountExcludingTax
    decimal
    The leger entry's amount with discounts applied, excluding taxes.
  • amountIncludingTax
    decimal
    The leger entry's amount with discounts applied, including taxes.
  • createdBy
    bigint
    The ID of the user the ledger entry was created by.
  • createdOn
    timestamp
    The date and time when the object was created.
  • discountIncludingTax
    decimal
    The discount allocated to the ledger entry, including taxes.
  • externalId
    string
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
  • id
    bigint
    A unique identifier for the object.
  • proRataCalculated
    boolean
     
  • quantity
    decimal
    The number of items that were consumed.
  • state
    string
    The object's current state.
  • subscriptionVersion
    bigint
    The subscription version that the ledger entry belongs to.
  • taxAmount
    decimal
    The sum of all taxes applied to the ledger entry.
  • taxes
    array
    A set of tax lines, each of which specifies a tax applied to the ledger entry.
  • title
    string
    The title that indicates what the ledger entry is about.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
coupon coupon

Coupons are a way to grant subscription discounts. Create a new coupon, configure it with discounts and rules and then share it with your customers.

Coupons are a way to grant subscription discounts. Create a new coupon, configure it with discounts and rules and then share it with your customers.
  • createdBy
    bigint
    The created by field indicates the user which has created the coupon.
  • createdOn
    timestamp
     
  • deletedBy
    bigint
    The deleted by field indicates the user which has deleted the coupon.
  • deletedOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    The coupon name is only used for coupon management purposes and is never shown to the subscriber. You will be able to give this coupon a more detailed discription or name while configuring the coupon later on.
  • spaceId
    bigint
     
  • state
    string
    The object's current state.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
couponversion couponversion

The coupon version contains a subset of the coupon properties which can change over time.Only one version can be active at the same time.

The coupon version contains a subset of the coupon properties which can change over time.Only one version can be active at the same time.
  • activatedBy
    bigint
    The activated by field indicates the user which has activated the coupon version.
  • activatedOn
    timestamp
     
  • coupon
    bigint
    The coupon to which the coupon version is linked to.
  • createdBy
    bigint
    The created by field indicates the user which has created the coupon version.
  • createdOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    A meaningful name or a short description to communicate the intent of the coupon. This is what the subscriber will see on his invoice or when he redeems the coupon code.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • obsoletedBy
    bigint
    The obsoleted by field indicates the user which has obsoleted the coupon version.
  • obsoletedOn
    timestamp
     
  • state
    string
    The object's current state.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
abstractproductfee abstractproductfee
  • component
    bigint
    The product component that the fee belongs to.
  • description
    struct
    The localized description of the fee that is displayed to the customer.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    The localized name of the fee that is displayed to the customer.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • type
    string
    The type of the fee.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
productmeteredfee productmeteredfee
  • component
    bigint
    The product component that the fee belongs to.
  • description
    struct
    The localized description of the fee that is displayed to the customer.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • metric
    bigint
    The metric used to determine the resource consumption billed to the customer.
  • name
    struct
    The localized name of the fee that is displayed to the customer.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • tierPricing
    string
    The method used to calculate the tier price.
  • type
    string
    The type of the fee.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
productperiodfee productperiodfee
  • component
    bigint
    The product component that the fee belongs to.
  • description
    struct
    The localized description of the fee that is displayed to the customer.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • ledgerEntryTitle
    struct
    The localized title that be used on ledger entries and invoices.
  • ledgerEntryTitle.availableLanguages
    array
     
  • ledgerEntryTitle.displayName
    string
     
  • ledgerEntryTitle.items
    array
     
  • name
    struct
    The localized name of the fee that is displayed to the customer.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • numberOfFreeTrialPeriods
    int
    The number of subscription billing cycles that count as a trial phase and during which no fees are charged.
  • periodFee
    array
    The amount charged to the customer for each billing cycle during the term of a subscription.
  • type
    string
    The type of the fee.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
productsetupfee productsetupfee
  • component
    bigint
    The product component that the fee belongs to.
  • description
    struct
    The localized description of the fee that is displayed to the customer.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    The localized name of the fee that is displayed to the customer.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • onDowngradeCreditedAmount
    array
    The amount charged to the customer when a subscription is downgraded.
  • onUpgradeCreditedAmount
    array
    The amount charged to the customer when a subscription is upgraded.
  • setupFee
    array
    The amount charged to the customer once when they subscribe to a subscription.
  • type
    string
    The type of the fee.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
subscriptionmetric subscriptionmetric

A metric represents the usage of a resource that can be measured.

A metric represents the usage of a resource that can be measured.
  • description
    struct
    The localized description of the metric that is displayed to the customer.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    The localized name of the metric that is displayed to the customer.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • state
    string
    The object's current state.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
subscriptionproduct subscriptionproduct

A subscription product represents a product to which a subscriber can subscribe to. A product defines how much the subscription costs and in what cycles the subscribe is charged.

A subscription product represents a product to which a subscriber can subscribe to. A product defines how much the subscription costs and in what cycles the subscribe is charged.
  • allowedPaymentMethodConfigurations
    array
    The payment methods that can be used to subscribe to this product. If none are selected, no restriction is applied.
  • failedPaymentSuspensionPeriod
    string
    The period after which a subscription that has been suspended due to a failed payment is terminated.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    The name used to identify the product.
  • productLocked
    boolean
    Whether subscriptions can be switched to or from this product, or whether they are locked in.
  • reference
    string
    The merchant's reference used to identify the product, e.g. the SKU.
  • sortOrder
    int
    When listing products, they can be sorted by this number.
  • spaceId
    bigint
    The ID of the space this object belongs to.
  • state
    string
    The object's current state.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
subscriptionproductcomponent subscriptionproductcomponent
  • componentChangeWeight
    int
    If switching from a component with a lower tier to a component with a higher one, this is considered an upgrade and a fee may be applied.
  • componentGroup
    bigint
    The group that the component belongs to.
  • defaultComponent
    boolean
    Whether this is the default component in its group and preselected.
  • description
    struct
    The localized description of the component that is displayed to the customer.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • maximalQuantity
    decimal
    A maximum of the defined quantity can be selected for this component.
  • minimalQuantity
    decimal
    A minimum of the defined quantity must be selected for this component.
  • name
    struct
    The localized name of the component that is displayed to the customer.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • quantityStep
    decimal
    The quantity step determines the interval in which the quantity can be increased.
  • reference
    bigint
    The reference is used to link components across different product versions.
  • sortOrder
    int
    When listing components, they can be sorted by this number.
  • taxClass
    bigint
    The tax class to be applied to fees.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
subscriptionproductcomponentgroup subscriptionproductcomponentgroup
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    The localized name of the component group that is displayed to the customer.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • optional
    boolean
    Whether the component group is optional, i.e. the customer does not have to select any component.
  • productVersion
    bigint
    The product version that the component group belongs to.
  • sortOrder
    int
    When listing component groups, they can be sorted by this number.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
subscriptionproductcomponentreference subscriptionproductcomponentreference

The product component reference links components from different product versions, which makes it possible to carry out migrations.

The product component reference links components from different product versions, which makes it possible to carry out migrations.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    The name used to identify the component reference.
  • state
    string
    The object's current state.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
subscriptionproductversion subscriptionproductversion
  • activatedOn
    timestamp
    The date and time when the product version was activated.
  • billingCycle
    string
    The recurring period of time, typically monthly or annually, for which a subscriber is charged.
  • comment
    string
    A comment that describes the product version and why it was created. It is not disclosed to the subscriber.
  • createdOn
    timestamp
    The date and time when the product version was created.
  • defaultCurrency
    string
    The three-letter code (ISO 4217 format) of the product version's default currency.
  • enabledCurrencies
    array
    The three-letter codes (ISO 4217 format) of the currencies that the product version supports.
  • id
    bigint
    A unique identifier for the object.
  • incrementNumber
    int
    Whenever a new version of a product is created, the number is increased and assigned.
  • minimalNumberOfPeriods
    int
    The minimum number of periods the subscription will run before it can be terminated.
  • name
    struct
    The localized name of the product that is displayed to the customer.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • numberOfNoticePeriods
    int
    The number of periods the subscription will keep running after its termination was requested.
  • obsoletedOn
    timestamp
    The date and time when the product version was made obsolete.
  • product
    bigint
    The product that the version belongs to.
  • reference
    string
    The reference used to identify the product version.
  • retiringFinishedOn
    timestamp
    The date and time when the product version was retired.
  • retiringStartedOn
    timestamp
    The date and time when the product version's retirement was started.
  • state
    string
    The object's current state.
  • taxCalculation
    string
    The way taxes are calculated for fees.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
subscriber subscriber

A subscriber represents everyone who is subscribed to a product.

A subscriber represents everyone who is subscribed to a product.
  • additionalAllowedPaymentMethodConfigurations
    array
    Allow the subscriber to use these payment methods even if subscription products do not accept them.
  • billingAddress
    struct
    The address associated with the subscriber for invoicing and transaction processing purposes.
  • billingAddress.city
    string
     
  • billingAddress.commercialRegisterNumber
    string
     
  • billingAddress.country
    string
     
  • billingAddress.dateOfBirth
    date
     
  • billingAddress.dependentLocality
    string
     
  • billingAddress.emailAddress
    string
     
  • billingAddress.familyName
    string
     
  • billingAddress.gender
    string
     
  • billingAddress.givenName
    string
     
  • billingAddress.legalOrganizationForm
    bigint
     
  • billingAddress.mobilePhoneNumber
    string
     
  • billingAddress.organizationName
    string
     
  • billingAddress.phoneNumber
    string
     
  • billingAddress.postalState
    string
     
  • billingAddress.postcode
    string
     
  • billingAddress.salesTaxNumber
    string
     
  • billingAddress.salutation
    string
     
  • billingAddress.socialSecurityNumber
    string
     
  • billingAddress.sortingCode
    string
     
  • billingAddress.street
    string
     
  • description
    string
    The description used to identify the subscriber.
  • disallowedPaymentMethodConfigurations
    array
    Prevent the subscriber from using these payment methods even if subscription products do accept them.
  • emailAddress
    string
    The email address that is used to communicate with the subscriber. There can be only one subscriber per space with the same email address.
  • externalId
    string
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is used when communicating with the subscriber via emails and documents.
  • metaData
    map
    Allow to store additional information about the object.
  • reference
    string
    The merchant's reference used to identify the subscriber.
  • shippingAddress
    struct
    The address to where orders will be shipped.
  • shippingAddress.city
    string
     
  • shippingAddress.commercialRegisterNumber
    string
     
  • shippingAddress.country
    string
     
  • shippingAddress.dateOfBirth
    date
     
  • shippingAddress.dependentLocality
    string
     
  • shippingAddress.emailAddress
    string
     
  • shippingAddress.familyName
    string
     
  • shippingAddress.gender
    string
     
  • shippingAddress.givenName
    string
     
  • shippingAddress.legalOrganizationForm
    bigint
     
  • shippingAddress.mobilePhoneNumber
    string
     
  • shippingAddress.organizationName
    string
     
  • shippingAddress.phoneNumber
    string
     
  • shippingAddress.postalState
    string
     
  • shippingAddress.postcode
    string
     
  • shippingAddress.salesTaxNumber
    string
     
  • shippingAddress.salutation
    string
     
  • shippingAddress.socialSecurityNumber
    string
     
  • shippingAddress.sortingCode
    string
     
  • shippingAddress.street
    string
     
  • state
    string
    The object's current state.
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.
subscribercustomer subscribercustomer
  • customer
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • subscriber
    bigint
     
  • linkedSpaceId
    bigint
    The ID of the space this object belongs to.