Documentazione
Documentazione
Docs
accountsubscriber accountsubscriber
  • accountId
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • subscriber
    bigint
     
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
accountsubscription accountsubscription
  • accountSubscriber
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • state
    string
    Lo stato attuale dell'oggetto.
  • subscription
    bigint
     
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
boardingtrialsubscription boardingtrialsubscription
  • accountId
    bigint
     
  • couponCodes
    array
     
  • createdOn
    timestamp
    La data e l'ora di creazione dell'oggetto.
  • currency
    string
     
  • expireDate
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • lastNotifiedOn
    timestamp
     
  • productVersion
    bigint
     
  • selectedComponents
    array
     
  • state
    string
    Lo stato attuale dell'oggetto.
  • subscriber
    bigint
     
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
subscriptionproductcomponentquantity subscriptionproductcomponentquantity
  • id
    bigint
    A unique identifier for the object.
  • quantity
    bigint
     
  • subscriptionProductComponent
    bigint
     
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
account account
  • active
    boolean
    Se questo conto e tutti i suoi conti padre sono attivi.
  • activeOrRestrictedActive
    boolean
    Se questo conto e tutti i suoi conti padre sono attivi o limitati.
  • createdBy
    bigint
    L'ID dell'utente da cui è stato creato l'account.
  • createdOn
    timestamp
    La data e l'ora di creazione dell'account.
  • deletedBy
    bigint
    L'ID di un utente da cui è stato eliminato l'account.
  • deletedOn
    timestamp
    La data e l'ora in cui l'account è stato eliminato.
  • id
    bigint
    A unique identifier for the object.
  • lastModifiedDate
    timestamp
    La data e l'ora dell'ultima modifica dell'oggetto.
  • name
    string
    Il nome utilizzato per identificare il conto.
  • parentAccount
    bigint
    L'account padre responsabile dell'amministrazione di questo account.
  • restrictedActive
    boolean
    Se questo conto e tutti i suoi conti padre sono attivi o attivi con restrizioni. Esiste almeno un conto attivo limitato.
  • scope
    bigint
    L'ambito a cui appartiene il conto.
  • state
    string
    Lo stato attuale dell'oggetto.
  • subaccountLimit
    bigint
    Il numero di sottoconti che possono essere creati all'interno di questo conto.
  • type
    string
    Il tipo di conto che definisce il suo ruolo e le sue capacità.
failurereason failurereason
  • category
    string
    La categoria a cui appartiene il motivo del fallimento.
  • description
    map
    La descrizione localizzata dell'oggetto.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Il nome localizzato dell'oggetto.
labeldescriptor labeldescriptor
  • category
    string
    La categoria dell'etichetta.
  • description
    map
    La descrizione localizzata dell'oggetto.
  • group
    bigint
    Il gruppo a cui appartiene questa etichetta.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Il nome localizzato dell'oggetto.
  • weight
    int
    Quando si elencano le etichette, queste possono essere ordinate in base a questo numero.
labeldescriptorgroup labeldescriptorgroup
  • description
    map
    La descrizione localizzata dell'oggetto.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Il nome localizzato dell'oggetto.
  • weight
    int
    Quando si elencano i gruppi di etichette, questi possono essere ordinati in base a questo numero.
space space
  • account
    bigint
    L'account a cui appartiene lo spazio.
  • active
    boolean
    Se questo spazio e tutti i suoi conti padre sono attivi.
  • activeOrRestrictedActive
    boolean
    Se questo spazio e tutti i suoi conti padre sono attivi o limitati.
  • createdBy
    bigint
    L'ID dell'utente che ha creato lo spazio.
  • createdOn
    timestamp
    La data e l'ora di creazione dello spazio.
  • deletedBy
    bigint
    L'ID dell'utente che ha cancellato lo spazio.
  • deletedOn
    timestamp
    La data e l'ora in cui lo spazio è stato eliminato.
  • id
    bigint
    A unique identifier for the object.
  • lastModifiedDate
    timestamp
    La data e l'ora dell'ultima modifica dell'oggetto.
  • name
    string
    Il nome utilizzato per identificare lo spazio.
  • postalAddress
    struct
    L'indirizzo che viene utilizzato nelle comunicazioni con i clienti, ad esempio nelle e-mail, nei documenti, ecc.
  • 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
    La valuta utilizzata per visualizzare gli importi aggregati nello spazio.
  • requestLimit
    bigint
    Il numero massimo di richieste API accettate entro due minuti. Questo limite può essere modificato solo con privilegi speciali.
  • restrictedActive
    boolean
    Se questo spazio e tutti i suoi conti padre sono attivi o attivi con restrizioni. C'è almeno un conto padre che è attivo con restrizioni.
  • state
    string
    Lo stato attuale dell'oggetto.
  • technicalContactAddresses
    array
    L'indirizzo e-mail che riceverà i messaggi relativi ai problemi tecnici e agli errori che si verificano nello spazio.
  • timeZone
    string
    Il fuso orario utilizzato per pianificare ed eseguire i processi in background. Questo non influisce sulla formattazione delle date nell'interfaccia utente.
spacereference spacereference
  • createdOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • spaceId
    bigint
     
  • state
    string
    Lo stato attuale dell'oggetto.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
legalorganizationform legalorganizationform
  • country
    string
    Il codice di due lettere del Paese in cui viene utilizzato il modulo di organizzazione legale (formato ISO 3166-1 alpha-2).
  • description
    array
    Le descrizioni localizzate della forma organizzativa legale.
  • englishDescription
    string
    Il nome inglese della forma giuridica dell'organizzazione.
  • id
    bigint
    A unique identifier for the object.
  • shortcut
    array
    Le scorciatoie localizzate del modulo di organizzazione legale.
customer customer
  • createdOn
    timestamp
    La data e l'ora di creazione dell'oggetto.
  • customerId
    string
    L'ID del cliente nel sistema dell'esercente.
  • emailAddress
    string
    L'indirizzo e-mail del cliente.
  • familyName
    string
    Il cognome o la famiglia del cliente.
  • givenName
    string
    Il nome o il cognome del cliente.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • metaData
    map
    Consente di memorizzare informazioni aggiuntive sull'oggetto.
  • preferredCurrency
    string
    La valuta preferita dal cliente.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
customeraddress customeraddress
  • address
    struct
    L'indirizzo postale effettivo.
  • 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
    Se l'indirizzo è per la fatturazione, per la spedizione o per entrambi.
  • createdOn
    timestamp
    La data e l'ora di creazione dell'oggetto.
  • customer
    bigint
    Il cliente a cui appartiene l'oggetto.
  • defaultAddress
    boolean
    Se questo è l'indirizzo predefinito del cliente.
  • id
    bigint
    A unique identifier for the object.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
taxclass taxclass
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Il nome utilizzato per identificare la classe fiscale.
  • state
    string
    Lo stato attuale dell'oggetto.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
charge charge
  • createdOn
    timestamp
    Data in cui sono state registrate le spese.
  • failureReason
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • spaceViewId
    bigint
    L'ID della vista dello spazio a cui questo oggetto è collegato.
  • state
    string
    Lo stato attuale dell'oggetto.
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • transaction
    bigint
     
  • type
    string
     
  • userFailureMessage
    string
    Il messaggio d’errore spiega all’utente finale il motivo per cui l’addebito non è andato a buon fine. Il messaggio d’errore viene lanciato soltanto se l’addebito non è andato a buon fine.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
chargeattempt chargeattempt
  • charge
    bigint
     
  • completionBehavior
    string
     
  • connectorConfiguration
    bigint
     
  • createdOn
    timestamp
    La data e l'ora di creazione dell'oggetto.
  • customersPresence
    string
    La presenza del cliente indica quale tipo di interazione con il cliente è stata utilizzata durante il tentativo di addebito.
  • 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
    L'ID della vista dello spazio a cui questo oggetto è collegato.
  • state
    string
    Lo stato attuale dell'oggetto.
  • succeededOn
    timestamp
     
  • terminal
    bigint
     
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • userFailureMessage
    string
    Inserire un messaggio da mostrare al cliente in caso di transazione fallita. Il messaggio viene localizzato in base alla lingua selezionata.
  • wallet
    bigint
     
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
saleschannel saleschannel
  • description
    map
    La descrizione localizzata dell'oggetto.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Il nome localizzato dell'oggetto.
  • sortOrder
    int
    Quando si elencano i canali di vendita, è possibile ordinarli in base a questo numero.
connectorinvocation connectorinvocation
  • createdOn
    timestamp
    La data e l'ora di creazione dell'oggetto.
  • id
    bigint
    A unique identifier for the object.
  • stage
    string
     
  • timeTookInMilliseconds
    bigint
     
  • transaction
    bigint
     
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
paymentconnector paymentconnector
  • dataCollectionType
    string
    Il tipo di raccolta dati specifica la modalità di raccolta delle informazioni di pagamento.
  • deprecated
    boolean
    Se l'oggetto è stato deprecato.
  • deprecationReason
    map
    Il motivo della deprecazione descrive il motivo per cui l'oggetto è stato deprecato.
  • description
    map
    La descrizione localizzata dell'oggetto.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Il nome localizzato dell'oggetto.
  • paymentMethod
    bigint
    Il metodo di pagamento supportato dal connettore.
  • paymentMethodBrand
    bigint
    Il marchio specifico supportato da questo connettore di pagamento.
  • primaryRiskTaker
    string
    L'entità che si assume il rischio principale nel caso in cui una parte contraente non adempia ai propri obblighi.
  • processor
    bigint
    Il processore a cui appartiene il connettore.
  • supportedCurrencies
    array
    Le valute supportate dal connettore.
paymentconnectorconfiguration paymentconnectorconfiguration
  • applicableForTransactionProcessing
    boolean
    Se la configurazione del connettore è abilitata all'elaborazione dei pagamenti, tenendo conto dello stato delle configurazioni del processore e del metodo di pagamento.
  • connector
    bigint
    Il connettore per il quale è stata effettuata la configurazione.
  • enabledSalesChannels
    array
    I canali di vendita per i quali è abilitata la configurazione del connettore. Se è vuota, è abilitata per tutti i canali di vendita.
  • enabledSpaceViews
    array
    Le viste dello spazio per le quali è abilitata la configurazione del connettore. Se è vuota, è abilitata per tutte le viste dello spazio.
  • id
    bigint
    A unique identifier for the object.
  • imagePath
    string
    L'URL dell'immagine del connettore.
  • name
    string
    Il nome usato per identificare la configurazione del connettore.
  • paymentMethodConfiguration
    bigint
    La configurazione del metodo di pagamento a cui appartiene la configurazione del connettore.
  • priority
    int
    La priorità che determina l'ordine in cui le configurazioni dei connettori vengono prese in considerazione durante l'elaborazione di un pagamento. I valori bassi vengono considerati per primi.
  • processorConfiguration
    bigint
    La configurazione del processore a cui appartiene la configurazione del connettore.
  • state
    string
    Lo stato attuale dell'oggetto.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
paymentcontract paymentcontract
  • account
    bigint
    Questo conto a cui appartiene il contratto.
  • activatedOn
    timestamp
    La data e l'ora di attivazione del contratto.
  • contractIdentifier
    string
    L'identificatore del contratto.
  • createdOn
    timestamp
    La data e l'ora di creazione dell'oggetto.
  • externalId
    string
    Un nonce generato dal client che identifica l'entità da creare. Le richieste di creazione successive con lo stesso ID esterno non creeranno nuove entità, ma restituiranno invece l'entità creata inizialmente.
  • id
    bigint
    A unique identifier for the object.
  • lastModifiedDate
    timestamp
    La data e l'ora dell'ultima modifica dell'oggetto.
  • rejectedOn
    timestamp
    La data e l'ora in cui il contratto è stato rifiutato.
  • rejectionReason
    bigint
    Il motivo del rifiuto del contratto.
  • startTerminatingOn
    timestamp
    La data e l'ora in cui è stato avviato il processo di risoluzione del contratto.
  • state
    string
    Lo stato attuale dell'oggetto.
  • terminatedOn
    timestamp
    La data e l'ora di risoluzione del contratto.
paymentmethod paymentmethod
  • dataCollectionTypes
    array
    I tipi di raccolta dati supportati dal metodo di pagamento.
  • description
    map
    La descrizione localizzata dell'oggetto.
  • id
    bigint
    A unique identifier for the object.
  • merchantDescription
    map
     
  • name
    map
    Il nome localizzato dell'oggetto.
  • supportedCurrencies
    array
    Le valute supportate dal metodo di pagamento.
paymentmethodbrand paymentmethodbrand
  • description
    map
    La descrizione localizzata dell'oggetto.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Il nome localizzato dell'oggetto.
  • paymentMethod
    bigint
    Il metodo di pagamento a cui appartiene il marchio.
paymentmethodconfiguration paymentmethodconfiguration

La configurazione della modalità di pagamento rappresenta il requisito necessario per collegare un gestore a una configurazione concreta.

La configurazione della modalità di pagamento rappresenta il requisito necessario per collegare un gestore a una configurazione concreta.
  • dataCollectionType
    string
    Il tipo di raccolta dati specifica la modalità di raccolta delle informazioni di pagamento.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Il nome utilizzato per identificare la configurazione del metodo di pagamento.
  • oneClickPaymentMode
    string
    La modalità di pagamento con un solo clic determina se il cliente può salvare i suoi dettagli di pagamento per pagamenti successivi.
  • paymentMethod
    bigint
    Il metodo di pagamento per il quale è stata effettuata la configurazione.
  • resolvedDescription
    map
    La descrizione del metodo di pagamento che viene effettivamente mostrata al cliente. Si tratta della descrizione personalizzata, se definita, oppure di quella predefinita del metodo di pagamento.
  • resolvedTitle
    map
    Il titolo del metodo di pagamento che viene effettivamente visualizzato dal cliente. Si tratta del titolo personalizzato, se definito, oppure di quello predefinito del metodo di pagamento.
  • sortOrder
    int
    Quando si elencano i metodi di pagamento, è possibile ordinarli in base a questo numero.
  • state
    string
    Lo stato attuale dell'oggetto.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
paymentprocessor paymentprocessor

I processori di pagamento gestiscono il collegamento con società terze (fornitori di servizi di pagamento) che gestiscono tecnicamente le transazioni di pagamento e quindi elaborano i pagamenti.

I processori di pagamento gestiscono il collegamento con società terze (fornitori di servizi di pagamento) che gestiscono tecnicamente le transazioni di pagamento e quindi elaborano i pagamenti.
  • companyName
    map
    Il nome della società a cui appartiene l'elaboratore.
  • description
    map
    La descrizione localizzata dell'oggetto.
  • headquartersLocation
    map
    Dove si trova la sede del processore.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Il nome localizzato dell'oggetto.
  • productName
    map
    Il nome del prodotto del processore.
paymentprocessorconfiguration paymentprocessorconfiguration
  • applicationManaged
    boolean
    Se la configurazione del processore è gestita dall'applicazione e quindi non può essere modificata.
  • contractId
    bigint
    L'ID del contratto di pagamento a cui è collegata la configurazione dell'elaboratore.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Il nome utilizzato per identificare la configurazione del metodo di pagamento.
  • processor
    bigint
    Il processore di pagamento per il quale è stata effettuata la configurazione.
  • state
    string
    Lo stato attuale dell'oggetto.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
refund refund

Un accredito rappresenta un rimborso a favore del cliente. Questo può essere effettuato dal commerciante o dal cliente (charge back).

Un accredito rappresenta un rimborso a favore del cliente. Questo può essere effettuato dal commerciante o dal cliente (charge back).
  • amount
    decimal
     
  • baseLineItems
    array
     
  • completion
    bigint
     
  • createdBy
    bigint
     
  • createdOn
    timestamp
    La data e l'ora di creazione dell'oggetto.
  • environment
    string
     
  • externalId
    string
    L’ID esterno aiuta a identificare le chiamate ripetute al servizio accrediti. Per questo l’ID esterno dovrebbe essere unico per ogni transazione.
  • failedOn
    timestamp
     
  • failureReason
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • labels
    array
    Le etichette che forniscono informazioni aggiuntive sull'oggetto.
  • 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
    Lo stato attuale dell'oggetto.
  • succeededOn
    timestamp
     
  • taxes
    array
     
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • totalAppliedFees
    decimal
    Il totale delle tasse applicate è la somma di tutte le tasse che sono state applicate finora.
  • totalSettledAmount
    decimal
    L'importo totale liquidato è l'importo totale che è stato liquidato finora.
  • transaction
    bigint
     
  • type
    string
     
  • updatedInvoice
    bigint
     
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
paymentterminal paymentterminal
  • defaultCurrency
    string
    La valuta predefinita del terminale.
  • id
    bigint
    A unique identifier for the object.
  • identifier
    string
    L'identificativo univoco del terminale, che viene visualizzato sul dispositivo.
  • name
    string
    Il nome utilizzato per identificare il terminale di pagamento.
  • state
    string
    Lo stato attuale dell'oggetto.
  • type
    bigint
    Il tipo di terminale di pagamento.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
paymentterminaltype paymentterminaltype
  • description
    map
    La descrizione localizzata dell'oggetto.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Il nome localizzato dell'oggetto.
token token
  • createdOn
    timestamp
    La data e l'ora di creazione dell'oggetto.
  • customerEmailAddress
    string
    L'indirizzo e-mail del cliente.
  • customerId
    string
    L'identificativo univoco del cliente nel sistema esterno.
  • enabledForOneClickPayment
    boolean
    Se il token è abilitato ai pagamenti con un solo clic, che semplificano il processo di pagamento per il cliente. I token one-click sono collegati ai clienti tramite l'ID cliente.
  • externalId
    string
    Un nonce generato dal client che identifica l'entità da creare. Le richieste di creazione successive con lo stesso ID esterno non creeranno nuove entità, ma restituiranno invece l'entità creata inizialmente.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • state
    string
    Lo stato attuale dell'oggetto.
  • timeZone
    string
    Il fuso orario del cliente, che influisce sulla formattazione di date e orari nelle comunicazioni con il cliente.
  • tokenReference
    string
    Il riferimento utilizzato per identificare il token di pagamento (ad esempio, l'ID o l'indirizzo e-mail del cliente).
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
transaction transaction
  • acceptHeader
    string
    L'intestazione 'Accept' del browser web del cliente.
  • acceptLanguageHeader
    string
    L'intestazione 'Accept Language' del browser web del cliente.
  • allowedPaymentMethodBrands
    array
    I marchi dei metodi di pagamento che possono essere utilizzati per autorizzare la transazione.
  • allowedPaymentMethodConfigurations
    array
    Le configurazioni del metodo di pagamento che possono essere utilizzate per autorizzare la transazione.
  • authorizationAmount
    decimal
    La somma di tutti i prezzi delle voci, comprese le imposte, nella valuta della transazione.
  • authorizationEnvironment
    string
    L'ambiente in cui è stata autorizzata la transazione.
  • authorizationSalesChannel
    bigint
    Il canale di vendita attraverso il quale è stata effettuata la transazione.
  • authorizationTimeoutOn
    timestamp
    La data e l'ora in cui la transazione deve essere autorizzata, altrimenti verrà annullata.
  • authorizedOn
    timestamp
    La data e l'ora in cui la transazione è stata autorizzata.
  • autoConfirmationEnabled
    boolean
    Se la transazione può essere confermata automaticamente o se deve essere fatta esplicitamente tramite l'API. L'impostazione predefinita è true.
  • billingAddress
    struct
    L'indirizzo associato al metodo di pagamento ai fini della fatturazione e dell'elaborazione delle transazioni.
  • 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
    Se il cliente può effettuare ulteriori tentativi di pagamento se il primo non è andato a buon fine. L'impostazione predefinita è true.
  • completedAmount
    decimal
    L'importo totale che è stato completato, nella valuta della transazione.
  • completedOn
    timestamp
    La data e l'ora in cui è stata completata la transazione.
  • completionBehavior
    string
    Il comportamento che controlla il completamento della transazione.
  • completionTimeoutOn
    timestamp
    La data e l'ora in cui la transazione viene completata automaticamente.
  • confirmedBy
    bigint
    L'ID dell'utente che ha confermato la transazione.
  • confirmedOn
    timestamp
    La data e l'ora di creazione della transazione.
  • createdBy
    bigint
    L'ID dell'utente che ha creato la transazione.
  • createdOn
    timestamp
    La data e l'ora di creazione dell'oggetto.
  • currency
    string
    Codice di tre lettere (formato ISO 4217) della valuta della transazione.
  • customerEmailAddress
    string
    L'indirizzo e-mail del cliente.
  • customerId
    string
    L'identificativo univoco del cliente nel sistema esterno.
  • customersPresence
    string
    La presenza del cliente indica se e in che modo il cliente della transazione è presente. L'impostazione predefinita è VIRTUAL_PRESENT.
  • deliveryDecisionMadeOn
    timestamp
    La data e l'ora in cui è stata presa la decisione di spedire l'ordine.
  • deviceSessionIdentifier
    string
    Permette di collegare la transazione ai dati raccolti dal dispositivo del cliente.
  • emailsDisabled
    boolean
    Se l'invio di e-mail è disattivato per la transazione. L'impostazione predefinita è false.
  • environment
    string
     
  • environmentSelectionStrategy
    string
    La strategia per determinare se la transazione deve essere elaborata nell'ambiente di test o di produzione.
  • failedOn
    timestamp
    La data e l'ora in cui la transazione è fallita.
  • failedUrl
    string
    L'URL a cui reindirizzare il cliente dopo l'annullamento o la mancata autenticazione del pagamento.
  • failureReason
    bigint
    Il motivo del fallimento della transazione.
  • id
    bigint
    A unique identifier for the object.
  • internetProtocolAddress
    string
    L'indirizzo IP del dispositivo del cliente.
  • internetProtocolAddressCountry
    string
    Il paese determinato dall'indirizzo IP del dispositivo del cliente.
  • invoiceMerchantReference
    string
    Il riferimento dell'esercente utilizzato per identificare la fattura.
  • javaEnabled
    boolean
    Se Java è abilitato sul browser web del cliente.
  • language
    string
    The language that is linked to the object.
  • lineItems
    array
    Gli articoli acquistati dal cliente.
  • merchantReference
    string
    Il riferimento dell'esercente utilizzato per identificare la transazione.
  • metaData
    map
    Consente di memorizzare informazioni aggiuntive sull'oggetto.
  • parent
    bigint
    La transazione padre che è stata (parzialmente) sostituita da questa transazione.
  • paymentConnectorConfiguration
    bigint
    La configurazione del connettore di pagamento utilizzata per autorizzare la transazione.
  • processingOn
    timestamp
    La data e l'ora in cui è stata avviata l'elaborazione della transazione.
  • refundedAmount
    decimal
    L'importo totale che è stato rimborsato, nella valuta della transazione.
  • screenColorDepth
    string
    La profondità di colore dello schermo del browser web del cliente.
  • screenHeight
    string
    L'altezza dello schermo del browser web del cliente.
  • screenWidth
    string
    La larghezza dello schermo del browser web del cliente.
  • shippingAddress
    struct
    L'indirizzo a cui verrà spedito l'ordine.
  • 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
    Il nome del metodo di spedizione utilizzato per spedire i prodotti.
  • spaceViewId
    bigint
    L'ID della vista dello spazio a cui questo oggetto è collegato.
  • state
    string
    Lo stato attuale dell'oggetto.
  • successUrl
    string
    L'URL a cui reindirizzare il cliente dopo l'autenticazione del pagamento.
  • terminal
    bigint
    Il terminale di pagamento attraverso il quale è stato elaborato il pagamento.
  • timeZone
    string
    Il fuso orario del cliente, che influisce sulla formattazione di date e orari nelle comunicazioni con il cliente.
  • token
    bigint
    Il token di pagamento da utilizzare per addebitare il cliente.
  • tokenizationMode
    string
    La modalità di tokenizzazione specifica se e come la tokenizzazione delle informazioni di pagamento viene applicata alla transazione.
  • totalAppliedFees
    decimal
    Il totale di tutte le commissioni addebitate, nella valuta della transazione.
  • totalSettledAmount
    decimal
    L'importo totale che è stato regolato, nella valuta della transazione.
  • userAgentHeader
    string
    L'intestazione 'User Agent' del browser web del cliente.
  • userFailureMessage
    string
    Il messaggio che può essere visualizzato al cliente per spiegare il motivo del fallimento della transazione, nella lingua del cliente.
  • userInterfaceType
    string
    Il tipo di interfaccia utente utilizzata dal cliente per fornire le informazioni di pagamento.
  • windowHeight
    string
    L'altezza della finestra del browser web del cliente.
  • windowWidth
    string
    La larghezza della finestra del browser web del cliente.
  • yearsToKeep
    int
    Il numero di anni in cui la transazione viene conservata dopo la sua autorizzazione.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
transactioncompletion transactioncompletion
  • amount
    decimal
    L'importo che viene catturato. L'importo rappresenta la somma degli elementi pubblicitari, tasse incluse.
  • baseLineItems
    array
    Gli elementi pubblicitari di base su cui viene applicato il completamento.
  • createdBy
    bigint
     
  • createdOn
    timestamp
    La data e l'ora di creazione dell'oggetto.
  • externalId
    string
    L'ID esterno aiuta a identificare l'entità e una successiva creazione di un'entità con lo stesso ID non creerà una nuova entità.
  • failedOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • invoiceMerchantReference
    string
     
  • labels
    array
    Le etichette che forniscono informazioni aggiuntive sull'oggetto.
  • language
    string
    The language that is linked to the object.
  • lastCompletion
    boolean
    Indica se questo è l'ultimo completamento. Dopo la creazione dell'ultimo completamento, la transazione non può più essere completata.
  • lineItems
    array
    Gli elementi pubblicitari acquisiti.
  • linkedTransaction
    bigint
     
  • mode
    string
     
  • nextUpdateOn
    timestamp
     
  • paymentInformation
    string
     
  • processingOn
    timestamp
     
  • processorReference
    string
     
  • remainingLineItems
    array
     
  • spaceViewId
    bigint
    L'ID della vista dello spazio a cui questo oggetto è collegato.
  • state
    string
    Lo stato attuale dell'oggetto.
  • statementDescriptor
    string
    Il descrittore dell'estratto conto spiega gli addebiti o i pagamenti sugli estratti conto bancari.
  • succeededOn
    timestamp
     
  • taxAmount
    decimal
    La somma totale di tutte le tasse degli elementi pubblicitari.
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
transactioninvoice transactioninvoice

La fattura della transazione rappresenta il documento di una transazione.

La fattura della transazione rappresenta il documento di una transazione.
  • 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
    Data in cui è stata creata la fattura.
  • derecognizedBy
    bigint
    L'id dell'utente che ha segnato la fattura come non riconosciuta.
  • derecognizedOn
    timestamp
    La data in cui la fattura è contrassegnata come stornata.
  • dueOn
    timestamp
    Data in cui deve essere pagata la fattura.
  • environment
    string
     
  • externalId
    string
    L'ID esterno aiuta a identificare l'entità e una successiva creazione di un'entità con lo stesso ID non creerà una nuova entità.
  • 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
    L’importo in sospeso indica quanto il cliente deve al commerciante. Un importo negativo significa che il cliente ha pagato troppo.
  • paidOn
    timestamp
    La data in cui la fattura è stata contrassegnata come saldata. È possibile che questa data sia precedente alla data di pagamento attuale.
  • spaceViewId
    bigint
    L'ID della vista dello spazio a cui questo oggetto è collegato.
  • state
    string
    Lo stato attuale dell'oggetto.
  • taxAmount
    decimal
     
  • timeZone
    string
     
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
wallettype wallettype
  • description
    map
    La descrizione localizzata dell'oggetto.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Il nome localizzato dell'oggetto.
subscriptionaffiliate subscriptionaffiliate
  • externalId
    string
    Un nonce generato dal client che identifica l'entità da creare. Le richieste di creazione successive con lo stesso ID esterno non creeranno nuove entità, ma restituiranno invece l'entità creata inizialmente.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • metaData
    map
    Consente di memorizzare informazioni aggiuntive sull'oggetto.
  • name
    string
    Il nome utilizzato per identificare l'affiliato.
  • reference
    string
    Il riferimento utilizzato per identificare l'affiliato.
  • state
    string
    Lo stato attuale dell'oggetto.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
subscription subscription
  • activatedOn
    timestamp
    La data e l'ora di attivazione dell'abbonamento.
  • affiliate
    bigint
    L'affiliazione che ha portato alla creazione dell'abbonamento.
  • createdOn
    timestamp
    La data e l'ora di creazione dell'abbonamento.
  • currentProductVersion
    bigint
    La versione del prodotto a cui l'abbonamento è attualmente collegato.
  • description
    string
    Descrizione utilizzata per identificare l'abbonamento.
  • id
    bigint
    A unique identifier for the object.
  • initializedOn
    timestamp
    La data e l'ora di inizializzazione dell'abbonamento.
  • language
    string
    The language that is linked to the object.
  • plannedTerminationDate
    timestamp
    La data e l'ora in cui si prevede di terminare l'abbonamento.
  • reference
    string
    Il riferimento dell'esercente utilizzato per identificare l'abbonamento.
  • state
    string
    Lo stato attuale dell'oggetto.
  • subscriber
    bigint
    Il sottoscrittore a cui appartiene l'abbonamento.
  • terminatedBy
    bigint
    L'ID dell'utente che ha terminato l'abbonamento.
  • terminatedOn
    timestamp
    La data e l'ora di cessazione dell'abbonamento.
  • terminatingOn
    timestamp
    La data e l'ora in cui è iniziata la cessazione dell'abbonamento.
  • terminationScheduledOn
    timestamp
    La data e l'ora in cui è stata programmata la chiusura dell'abbonamento.
  • token
    bigint
    Il token di pagamento utilizzato per addebitare il cliente.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
subscriptioncomponentconfiguration subscriptioncomponentconfiguration
  • component
    bigint
    Il componente che si sta configurando.
  • id
    bigint
    A unique identifier for the object.
  • quantity
    decimal
    La quantità da applicare al componente.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
subscriptionperiodbill subscriptionperiodbill
  • createdOn
    timestamp
    La data e l'ora in cui è stata creata la fattura del periodo.
  • effectivePeriodEndDate
    timestamp
    La data e l'ora in cui il periodo è effettivamente terminato.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • periodStartDate
    timestamp
    La data e l'ora di inizio del periodo.
  • plannedPeriodEndDate
    timestamp
    La data e l'ora in cui è prevista la fine del periodo.
  • state
    string
    Lo stato attuale dell'oggetto.
  • subscriptionVersion
    bigint
    La versione dell'abbonamento a cui appartiene la fattura del periodo.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
subscriptionperiodbillitem subscriptionperiodbillitem
  • bill
    bigint
     
  • fee
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • ledgerEntry
    bigint
     
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
subscriptionversion subscriptionversion
  • activatedOn
    timestamp
    La data e l'ora di attivazione della versione in abbonamento.
  • billingCurrency
    string
    Codice di tre lettere (formato ISO 4217) della valuta utilizzata per la fatturazione al cliente. Deve essere una delle valute supportate dal prodotto.
  • createdOn
    timestamp
    La data e l'ora di creazione della versione dell'abbonamento.
  • expectedLastPeriodEnd
    timestamp
    La data e l'ora in cui si prevede la fine dell'ultimo periodo.
  • failedOn
    timestamp
    La data e l'ora in cui la versione dell'abbonamento è fallita.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • plannedTerminationDate
    timestamp
    La data e l'ora in cui è prevista la cessazione della versione in abbonamento.
  • productVersion
    bigint
    La versione del prodotto sottoscritta.
  • state
    string
    Lo stato attuale dell'oggetto.
  • subscription
    bigint
    L'abbonamento a cui appartiene questa versione.
  • terminatedOn
    timestamp
    La data e l'ora in cui la versione dell'abbonamento è stata terminata.
  • terminatingOn
    timestamp
    La data e l'ora in cui è iniziata la cessazione della versione dell'abbonamento.
  • terminationIssuedOn
    timestamp
    La data e l'ora in cui è stata emessa la disdetta della versione dell'abbonamento.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
subscriptioncharge subscriptioncharge

Il costo dell'abbonamento rappresenta un unico addebito effettuato per un particolare abbonamento.

Il costo dell'abbonamento rappresenta un unico addebito effettuato per un particolare abbonamento.
  • createdOn
    timestamp
    La data e l'ora in cui è stato creato l'addebito.
  • discardedBy
    bigint
    L'ID dell'utente da cui è stato scartato l'addebito.
  • discardedOn
    timestamp
    La data e l'ora in cui la carica è stata scartata.
  • externalId
    string
    Un nonce generato dal client che identifica l'entità da creare. Le richieste di creazione successive con lo stesso ID esterno non creeranno nuove entità, ma restituiranno invece l'entità creata inizialmente.
  • failedOn
    timestamp
    La data e l'ora in cui la carica è fallita.
  • failedUrl
    string
    L'URL a cui reindirizzare il cliente dopo l'annullamento o la mancata autenticazione del pagamento.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • ledgerEntries
    array
    Le voci del registro che appartengono all'addebito.
  • plannedExecutionDate
    timestamp
    La data e l'ora in cui è prevista l'esecuzione dell'addebito.
  • processingType
    string
    Il tipo di elaborazione specifica come deve essere elaborato l'addebito.
  • reference
    string
    Il riferimento dell'esercente utilizzato per identificare l'addebito.
  • state
    string
    Lo stato attuale dell'oggetto.
  • subscription
    bigint
    L'abbonamento a cui appartiene l'addebito.
  • succeedOn
    timestamp
    La data e l'ora in cui l'addebito è avvenuto.
  • successUrl
    string
    L'URL a cui reindirizzare il cliente dopo l'autenticazione del pagamento.
  • transaction
    bigint
    La transazione utilizzata per elaborare l'addebito.
  • type
    string
    Il tipo ha specificato come è stato avviato l'addebito.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
subscriptionledgerentry subscriptionledgerentry

La voce del libro mastro degli abbonamenti rappresenta un singolo cambiamento sul saldo dell'abbonamento.

La voce del libro mastro degli abbonamenti rappresenta un singolo cambiamento sul saldo dell'abbonamento.
  • aggregatedTaxRate
    decimal
    L'aliquota fiscale totale applicata alla voce del registro, calcolata a partire dalle aliquote di tutte le righe fiscali.
  • amountExcludingTax
    decimal
    L'importo della voce "leger" con gli sconti applicati, escluse le tasse.
  • amountIncludingTax
    decimal
    L'importo della voce "leger" con gli sconti applicati, comprese le tasse.
  • createdBy
    bigint
    L'ID dell'utente che ha creato la voce del libro mastro.
  • createdOn
    timestamp
    La data e l'ora di creazione dell'oggetto.
  • discountIncludingTax
    decimal
    Lo sconto assegnato alla voce del registro, comprese le imposte.
  • externalId
    string
    Un nonce generato dal client che identifica l'entità da creare. Le richieste di creazione successive con lo stesso ID esterno non creeranno nuove entità, ma restituiranno invece l'entità creata inizialmente.
  • id
    bigint
    A unique identifier for the object.
  • proRataCalculated
    boolean
     
  • quantity
    decimal
    Il numero di articoli consumati.
  • state
    string
    Lo stato attuale dell'oggetto.
  • subscriptionVersion
    bigint
    La versione dell'abbonamento a cui appartiene la voce del libro mastro.
  • taxAmount
    decimal
    La somma di tutte le imposte applicate alla voce del registro.
  • taxes
    array
    Un insieme di righe fiscali, ciascuna delle quali specifica un'imposta applicata alla voce del libro mastro.
  • title
    string
    Il titolo che indica l'oggetto della voce del libro mastro.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
coupon coupon

I coupon sono un modo per concedere sconti sugli abbonamenti. Crea un nuovo coupon, configuralo con sconti e regole e poi condividilo con i tuoi clienti.

I coupon sono un modo per concedere sconti sugli abbonamenti. Crea un nuovo coupon, configuralo con sconti e regole e poi condividilo con i tuoi clienti.
  • createdBy
    bigint
    Il campo creato da indica l'utente che ha creato il coupon.
  • createdOn
    timestamp
     
  • deletedBy
    bigint
    Il campo cancellato da indica l'utente che ha cancellato il coupon.
  • deletedOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Il nome del coupon è usato solo per la gestione del coupon e non è mai mostrato all'abbonato. Potrai dare a questo coupon una descrizione o un nome più dettagliato durante la configurazione del coupon in seguito.
  • spaceId
    bigint
     
  • state
    string
    Lo stato attuale dell'oggetto.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
couponversion couponversion

La versione del coupon contiene un sottoinsieme delle proprietà del coupon che può cambiare nel tempo, ma solo una versione può essere attiva allo stesso tempo.

La versione del coupon contiene un sottoinsieme delle proprietà del coupon che può cambiare nel tempo, ma solo una versione può essere attiva allo stesso tempo.
  • activatedBy
    bigint
    Il campo attivato da indica l'utente che ha attivato la versione del coupon.
  • activatedOn
    timestamp
     
  • coupon
    bigint
    Il coupon a cui è collegata la versione del coupon.
  • createdBy
    bigint
    Il campo creato da indica l'utente che ha creato la versione del coupon.
  • createdOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Un nome significativo o una breve descrizione per comunicare l'intento del coupon. Questo è ciò che l'abbonato vedrà sulla sua fattura o quando riscatterà il codice del coupon.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • obsoletedBy
    bigint
    Il campo obsoleto da indica l'utente che ha obsoleto la versione del coupon.
  • obsoletedOn
    timestamp
     
  • state
    string
    Lo stato attuale dell'oggetto.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
abstractproductfee abstractproductfee
  • component
    bigint
    Il componente del prodotto a cui appartiene la tariffa.
  • description
    struct
    La descrizione localizzata della tariffa che viene visualizzata al cliente.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Il nome localizzato della tariffa che viene visualizzato al cliente.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • type
    string
    Il tipo di tassa.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
productmeteredfee productmeteredfee
  • component
    bigint
    Il componente del prodotto a cui appartiene la tariffa.
  • description
    struct
    La descrizione localizzata della tariffa che viene visualizzata al cliente.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • metric
    bigint
    La metrica utilizzata per determinare il consumo di risorse fatturato al cliente.
  • name
    struct
    Il nome localizzato della tariffa che viene visualizzato al cliente.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • tierPricing
    string
    Il metodo utilizzato per calcolare il prezzo del livello.
  • type
    string
    Il tipo di tassa.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
productperiodfee productperiodfee
  • component
    bigint
    Il componente del prodotto a cui appartiene la tariffa.
  • description
    struct
    La descrizione localizzata della tariffa che viene visualizzata al cliente.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • ledgerEntryTitle
    struct
    Il titolo localizzato da utilizzare per le scritture contabili e le fatture.
  • ledgerEntryTitle.availableLanguages
    array
     
  • ledgerEntryTitle.displayName
    string
     
  • ledgerEntryTitle.items
    array
     
  • name
    struct
    Il nome localizzato della tariffa che viene visualizzato al cliente.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • numberOfFreeTrialPeriods
    int
    Il numero di cicli di fatturazione dell'abbonamento che valgono come fase di prova e durante i quali non viene addebitato alcun costo.
  • periodFee
    array
    L'importo addebitato al cliente per ogni ciclo di fatturazione durante la durata dell'abbonamento.
  • type
    string
    Il tipo di tassa.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
productsetupfee productsetupfee
  • component
    bigint
    Il componente del prodotto a cui appartiene la tariffa.
  • description
    struct
    La descrizione localizzata della tariffa che viene visualizzata al cliente.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Il nome localizzato della tariffa che viene visualizzato al cliente.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • onDowngradeCreditedAmount
    array
    L'importo addebitato al cliente quando un abbonamento viene declassato.
  • onUpgradeCreditedAmount
    array
    L'importo addebitato al cliente quando un abbonamento viene aggiornato.
  • setupFee
    array
    L'importo addebitato al cliente una volta quando sottoscrive un abbonamento.
  • type
    string
    Il tipo di tassa.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
subscriptionmetric subscriptionmetric

Una metrica rappresenta l'utilizzo di una risorsa che può essere misurata.

Una metrica rappresenta l'utilizzo di una risorsa che può essere misurata.
  • description
    struct
    La descrizione localizzata della metrica che viene visualizzata al cliente.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Il nome localizzato della metrica che viene visualizzato dal cliente.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • state
    string
    Lo stato attuale dell'oggetto.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
subscriptionproduct subscriptionproduct

Un prodotto di abbonamento rappresenta un prodotto al quale un abbonato può abbonarsi. Un prodotto definisce quanto costa l'abbonamento e in quali cicli l'abbonamento viene addebitato.

Un prodotto di abbonamento rappresenta un prodotto al quale un abbonato può abbonarsi. Un prodotto definisce quanto costa l'abbonamento e in quali cicli l'abbonamento viene addebitato.
  • allowedPaymentMethodConfigurations
    array
    I metodi di pagamento che possono essere utilizzati per abbonarsi a questo prodotto. Se non ne viene selezionato nessuno, non viene applicata alcuna restrizione.
  • failedPaymentSuspensionPeriod
    string
    Il periodo dopo il quale un abbonamento sospeso a causa di un mancato pagamento viene interrotto.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Il nome utilizzato per identificare il prodotto.
  • productLocked
    boolean
    Se gli abbonamenti possono essere cambiati da o verso questo prodotto o se sono bloccati.
  • reference
    string
    Il riferimento del commerciante utilizzato per identificare il prodotto, ad esempio lo SKU.
  • sortOrder
    int
    Quando si elencano i prodotti, questi possono essere ordinati in base a questo numero.
  • spaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
  • state
    string
    Lo stato attuale dell'oggetto.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
subscriptionproductcomponent subscriptionproductcomponent
  • componentChangeWeight
    int
    Il passaggio da un componente di livello inferiore a uno di livello superiore è considerato un upgrade e potrebbe essere applicata una tariffa.
  • componentGroup
    bigint
    Il gruppo a cui appartiene il componente.
  • defaultComponent
    boolean
    Se questo è il componente predefinito nel suo gruppo e preselezionato.
  • description
    struct
    La descrizione localizzata del componente che viene visualizzata al cliente.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • maximalQuantity
    decimal
    Per questo componente è possibile selezionare un massimo della quantità definita.
  • minimalQuantity
    decimal
    Per questo componente è necessario selezionare almeno la quantità definita.
  • name
    struct
    Il nome localizzato del componente che viene visualizzato dal cliente.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • quantityStep
    decimal
    Il passo quantità determina l'intervallo in cui la quantità può essere aumentata.
  • reference
    bigint
    Il riferimento viene utilizzato per collegare i componenti tra le diverse versioni del prodotto.
  • sortOrder
    int
    Quando si elencano i componenti, questi possono essere ordinati in base a questo numero.
  • taxClass
    bigint
    La classe fiscale da applicare alle tasse.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
subscriptionproductcomponentgroup subscriptionproductcomponentgroup
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Il nome localizzato del gruppo di componenti che viene visualizzato dal cliente.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • optional
    boolean
    Se il gruppo di componenti è opzionale, cioè il cliente non deve selezionare alcun componente.
  • productVersion
    bigint
    La versione del prodotto a cui appartiene il gruppo di componenti.
  • sortOrder
    int
    Quando si elencano i gruppi di componenti, questi possono essere ordinati in base a questo numero.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
subscriptionproductcomponentreference subscriptionproductcomponentreference

Il riferimento ai componenti del prodotto collega i componenti di diverse versioni del prodotto, rendendo possibile la migrazione.

Il riferimento ai componenti del prodotto collega i componenti di diverse versioni del prodotto, rendendo possibile la migrazione.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Il nome utilizzato per identificare il riferimento al componente.
  • state
    string
    Lo stato attuale dell'oggetto.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
subscriptionproductversion subscriptionproductversion
  • activatedOn
    timestamp
    La data e l'ora di attivazione della versione del prodotto.
  • billingCycle
    string
    Il periodo di tempo ricorrente, in genere mensile o annuale, per il quale viene addebitato un abbonamento.
  • comment
    string
    Un commento che descrive la versione del prodotto e il motivo per cui è stata creata. Non viene divulgato all'abbonato.
  • createdOn
    timestamp
    La data e l'ora di creazione della versione del prodotto.
  • defaultCurrency
    string
    Codice di tre lettere (formato ISO 4217) della valuta predefinita della versione del prodotto.
  • enabledCurrencies
    array
    I codici a tre lettere (formato ISO 4217) delle valute supportate dalla versione del prodotto.
  • id
    bigint
    A unique identifier for the object.
  • incrementNumber
    int
    Ogni volta che viene creata una nuova versione di un prodotto, il numero viene incrementato e assegnato.
  • minimalNumberOfPeriods
    int
    Il numero minimo di periodi di validità dell'abbonamento prima che possa essere interrotto.
  • name
    struct
    Il nome localizzato del prodotto che viene visualizzato al cliente.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • numberOfNoticePeriods
    int
    Il numero di periodi in cui l'abbonamento continuerà a funzionare dopo che ne è stata richiesta la cessazione.
  • obsoletedOn
    timestamp
    La data e l'ora in cui la versione del prodotto è stata resa obsoleta.
  • product
    bigint
    Il prodotto a cui appartiene la versione.
  • reference
    string
    Il riferimento utilizzato per identificare la versione del prodotto.
  • retiringFinishedOn
    timestamp
    La data e l'ora in cui la versione del prodotto è stata ritirata.
  • retiringStartedOn
    timestamp
    La data e l'ora in cui è stato avviato il pensionamento della versione del prodotto.
  • state
    string
    Lo stato attuale dell'oggetto.
  • taxCalculation
    string
    Il modo in cui vengono calcolate le tasse per le tariffe.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
subscriber subscriber

Un abbonato rappresenta tutti coloro che sono iscritti a un prodotto.

Un abbonato rappresenta tutti coloro che sono iscritti a un prodotto.
  • additionalAllowedPaymentMethodConfigurations
    array
    Consentire all'abbonato di utilizzare questi metodi di pagamento anche se i prodotti in abbonamento non li accettano.
  • billingAddress
    struct
    L'indirizzo associato all'abbonato ai fini della fatturazione e dell'elaborazione delle transazioni.
  • 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
    Descrizione utilizzata per identificare l'abbonato.
  • disallowedPaymentMethodConfigurations
    array
    Impedire all'abbonato di utilizzare questi metodi di pagamento, anche se i prodotti di abbonamento li accettano.
  • emailAddress
    string
    L'indirizzo e-mail utilizzato per comunicare con l'abbonato. Può esserci un solo abbonato per spazio con lo stesso indirizzo e-mail.
  • externalId
    string
    Un nonce generato dal client che identifica l'entità da creare. Le richieste di creazione successive con lo stesso ID esterno non creeranno nuove entità, ma restituiranno invece l'entità creata inizialmente.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    Il linguaggio utilizzato per comunicare con l'abbonato tramite e-mail e documenti.
  • metaData
    map
    Consente di memorizzare informazioni aggiuntive sull'oggetto.
  • reference
    string
    Il riferimento dell'esercente utilizzato per identificare l'abbonato.
  • shippingAddress
    struct
    L'indirizzo a cui verranno spediti gli ordini.
  • 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
    Lo stato attuale dell'oggetto.
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.
subscribercustomer subscribercustomer
  • customer
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • subscriber
    bigint
     
  • linkedSpaceId
    bigint
    L'ID dello spazio a cui appartiene questo oggetto.