Documentation
Documentation
Schéma d'analyse BETA
accountsubscriber accountsubscriber
  • accountId
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • subscriber
    bigint
     
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
accountsubscription accountsubscription
  • accountSubscriber
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • state
    string
    L'état actuel de l'objet.
  • subscription
    bigint
     
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
boardingtrialsubscription boardingtrialsubscription
  • accountId
    bigint
     
  • couponCodes
    array
     
  • createdOn
    timestamp
    La date et l'heure de création de l'objet.
  • currency
    string
     
  • expireDate
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • lastNotifiedOn
    timestamp
     
  • productVersion
    bigint
     
  • selectedComponents
    array
     
  • state
    string
    L'état actuel de l'objet.
  • subscriber
    bigint
     
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
subscriptionproductcomponentquantity subscriptionproductcomponentquantity
  • id
    bigint
    A unique identifier for the object.
  • quantity
    bigint
     
  • subscriptionProductComponent
    bigint
     
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
account account
  • active
    boolean
    Si ce compte et tous ses comptes parents sont actifs.
  • activeOrRestrictedActive
    boolean
    Si ce compte et tous ses comptes parents sont actifs ou actifs restreints.
  • createdBy
    bigint
    L'ID de l'utilisateur par lequel le compte a été créé.
  • createdOn
    timestamp
    La date et l'heure de la création du compte.
  • deletedBy
    bigint
    L'ID d'un utilisateur par lequel le compte a été supprimé.
  • deletedOn
    timestamp
    La date et l'heure auxquelles le compte a été supprimé.
  • id
    bigint
    A unique identifier for the object.
  • lastModifiedDate
    timestamp
    La date et l'heure de la dernière modification de l'objet.
  • name
    string
    Nom utilisé pour identifier le compte.
  • parentAccount
    bigint
    Le compte parent responsable de l'administration de ce compte.
  • restrictedActive
    boolean
    Si ce compte et tous ses comptes parents sont actifs ou actifs restreints. Il y a au moins un compte qui est actif restreint.
  • scope
    bigint
    L'étendue à laquelle le compte appartient.
  • state
    string
    L'état actuel de l'objet.
  • subaccountLimit
    bigint
    Nombre de sous-comptes pouvant être créés au sein de ce compte.
  • type
    string
    Le type de compte qui définit son rôle et ses capacités.
failurereason failurereason
  • category
    string
    Catégorie à laquelle appartient le motif d'échec.
  • description
    map
    La description localisée de l'objet.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Le nom localisé de l'objet.
labeldescriptor labeldescriptor
  • category
    string
    La catégorie du label.
  • description
    map
    La description localisée de l'objet.
  • group
    bigint
    Le groupe auquel appartient cette étiquette.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Le nom localisé de l'objet.
  • weight
    int
    Lors de l'établissement de la liste des étiquettes, celles-ci peuvent être triées en fonction de ce numéro.
labeldescriptorgroup labeldescriptorgroup
  • description
    map
    La description localisée de l'objet.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Le nom localisé de l'objet.
  • weight
    int
    Lors de l'établissement de la liste des groupes d'étiquettes, il est possible de les trier en fonction de ce numéro.
space space
  • account
    bigint
    Le compte auquel appartient l'espace.
  • active
    boolean
    Si cet espace et tous ses comptes parents sont actifs.
  • activeOrRestrictedActive
    boolean
    Si cet espace et tous ses comptes parents sont actifs ou actifs restreints.
  • createdBy
    bigint
    L'ID de l'utilisateur qui a créé l'espace.
  • createdOn
    timestamp
    La date et l'heure de création de l'espace.
  • deletedBy
    bigint
    L'ID de l'utilisateur qui a supprimé l'espace.
  • deletedOn
    timestamp
    La date et l'heure auxquelles l'espace a été supprimé.
  • id
    bigint
    A unique identifier for the object.
  • lastModifiedDate
    timestamp
    La date et l'heure de la dernière modification de l'objet.
  • name
    string
    Nom utilisé pour identifier l'espace.
  • postalAddress
    struct
    L'adresse utilisée dans la communication avec les clients, par exemple dans les courriels, les 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
    La devise utilisée pour afficher les montants agrégés dans l'espace.
  • requestLimit
    bigint
    Nombre maximal de demandes d'API acceptées en deux minutes. Cette limite ne peut être modifiée qu'avec des privilèges spéciaux.
  • restrictedActive
    boolean
    Si cet espace et tous ses comptes parents sont actifs ou actifs restreints. Il y a au moins un compte parent qui est actif restreint.
  • state
    string
    L'état actuel de l'objet.
  • technicalContactAddresses
    array
    L'adresse électronique qui recevra les messages concernant les problèmes techniques et les erreurs qui se produisent dans l'espace.
  • timeZone
    string
    Le fuseau horaire utilisé pour planifier et exécuter les processus d'arrière-plan. Cela n'affecte pas le formatage des dates dans l'interface utilisateur.
spacereference spacereference
  • createdOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • spaceId
    bigint
     
  • state
    string
    L'état actuel de l'objet.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
legalorganizationform legalorganizationform
  • country
    string
    Code à deux lettres du pays dans lequel la forme d'organisation juridique est utilisée (format ISO 3166-1 alpha-2).
  • description
    array
    Les descriptions localisées de la forme d'organisation juridique.
  • englishDescription
    string
    Le nom anglais de la forme d'organisation légale.
  • id
    bigint
    A unique identifier for the object.
  • shortcut
    array
    Les raccourcis localisés de la forme d'organisation juridique.
customer customer
  • createdOn
    timestamp
    La date et l'heure de création de l'objet.
  • customerId
    string
    L'identifiant du client dans le système du commerçant.
  • emailAddress
    string
    L'adresse électronique du client.
  • familyName
    string
    Le nom de famille du client.
  • givenName
    string
    Le nom ou le prénom du client.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • metaData
    map
    Permet de stocker des informations supplémentaires sur l'objet.
  • preferredCurrency
    string
    La devise préférée du client.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
customeraddress customeraddress
  • address
    struct
    L'adresse postale actuelle.
  • 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
    Si l'adresse est destinée à la facturation, à l'expédition ou aux deux.
  • createdOn
    timestamp
    La date et l'heure de création de l'objet.
  • customer
    bigint
    Le client auquel l'objet appartient.
  • defaultAddress
    boolean
    S'il s'agit de l'adresse par défaut du client.
  • id
    bigint
    A unique identifier for the object.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
taxclass taxclass
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Nom utilisé pour identifier la classe d'impôt.
  • state
    string
    L'état actuel de l'objet.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
charge charge
  • createdOn
    timestamp
    La date à laquelle les frais ont été saisis.
  • failureReason
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • spaceViewId
    bigint
    L'ID de la vue de l'espace à laquelle cet objet est lié.
  • state
    string
    L'état actuel de l'objet.
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • transaction
    bigint
     
  • type
    string
     
  • userFailureMessage
    string
    Le message d’erreur explique à l’utilisateur final dans sa langue la raison pour laquelle le débit a échoué. Le message d’erreur n’est activé que lorsque le débit a échoué.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
chargeattempt chargeattempt
  • charge
    bigint
     
  • completionBehavior
    string
     
  • connectorConfiguration
    bigint
     
  • createdOn
    timestamp
    La date et l'heure de création de l'objet.
  • customersPresence
    string
    La présence du client indique quel type d'interaction avec le client a été utilisé lors de la tentative de facturation.
  • 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 de la vue de l'espace à laquelle cet objet est lié.
  • state
    string
    L'état actuel de l'objet.
  • succeededOn
    timestamp
     
  • terminal
    bigint
     
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • userFailureMessage
    string
    Indiquez un message qui sera affiché au client si la transaction échoue. La localisation s’effectue à l’aide de la langue spécifiée dans la transaction.
  • wallet
    bigint
     
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
saleschannel saleschannel
  • description
    map
    La description localisée de l'objet.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Le nom localisé de l'objet.
  • sortOrder
    int
    Lors de l'établissement de la liste des canaux de vente, ceux-ci peuvent être triés en fonction de ce numéro.
connectorinvocation connectorinvocation
  • createdOn
    timestamp
    La date et l'heure de création de l'objet.
  • id
    bigint
    A unique identifier for the object.
  • stage
    string
     
  • timeTookInMilliseconds
    bigint
     
  • transaction
    bigint
     
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
paymentconnector paymentconnector
  • dataCollectionType
    string
    Le type de collecte de données spécifie la manière dont les informations relatives au paiement sont collectées.
  • deprecated
    boolean
    Si l'objet a été déprécié.
  • deprecationReason
    map
    Le motif de dépréciation décrit pourquoi l'objet a été déprécié.
  • description
    map
    La description localisée de l'objet.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Le nom localisé de l'objet.
  • paymentMethod
    bigint
    Le mode de paiement pris en charge par le connecteur.
  • paymentMethodBrand
    bigint
    La marque spécifique que ce connecteur de paiement prend en charge.
  • primaryRiskTaker
    string
    L'entité qui supporte le risque principal dans le cas où une partie contractante ne remplit pas ses obligations.
  • processor
    bigint
    Le processeur auquel appartient le connecteur.
  • supportedCurrencies
    array
    Les devises prises en charge par le connecteur.
paymentconnectorconfiguration paymentconnectorconfiguration
  • applicableForTransactionProcessing
    boolean
    Si cette configuration de connecteur est activée pour le traitement des paiements, en tenant compte de l'état des configurations du processeur et de la méthode de paiement.
  • connector
    bigint
    Le connecteur pour lequel la configuration est effectuée.
  • enabledSalesChannels
    array
    Les canaux de vente pour lesquels la configuration du connecteur est activée. Si elle est vide, elle est activée pour tous les canaux de vente.
  • enabledSpaceViews
    array
    Vues de l'espace pour lesquelles la configuration du connecteur est activée. Si elle est vide, elle est activée pour toutes les vues de l'espace.
  • id
    bigint
    A unique identifier for the object.
  • imagePath
    string
    L'URL de l'image du connecteur.
  • name
    string
    Nom utilisé pour identifier la configuration du connecteur.
  • paymentMethodConfiguration
    bigint
    La configuration du mode de paiement à laquelle appartient la configuration du connecteur.
  • priority
    int
    Priorité qui détermine l'ordre dans lequel les configurations des connecteurs sont prises en compte lors du traitement d'un paiement. Les valeurs faibles sont prises en compte en premier.
  • processorConfiguration
    bigint
    La configuration du processeur à laquelle appartient la configuration du connecteur.
  • state
    string
    L'état actuel de l'objet.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
paymentcontract paymentcontract
  • account
    bigint
    Compte auquel appartient le contrat.
  • activatedOn
    timestamp
    La date et l'heure auxquelles le contrat a été activé.
  • contractIdentifier
    string
    L'identifiant du contrat.
  • createdOn
    timestamp
    La date et l'heure de création de l'objet.
  • externalId
    string
    Un nonce généré par le client qui identifie l'entité à créer. Les demandes de création ultérieures avec le même identifiant externe ne créeront pas de nouvelles entités mais renverront l'entité initialement créée.
  • id
    bigint
    A unique identifier for the object.
  • lastModifiedDate
    timestamp
    La date et l'heure de la dernière modification de l'objet.
  • rejectedOn
    timestamp
    La date et l'heure auxquelles le contrat a été rejeté.
  • rejectionReason
    bigint
    Le motif du rejet du contrat.
  • startTerminatingOn
    timestamp
    La date et l'heure auxquelles la procédure de résiliation du contrat a été lancée.
  • state
    string
    L'état actuel de l'objet.
  • terminatedOn
    timestamp
    La date et l'heure auxquelles le contrat a été résilié.
paymentmethod paymentmethod
  • dataCollectionTypes
    array
    Les types de collecte de données pris en charge par la méthode de paiement.
  • description
    map
    La description localisée de l'objet.
  • id
    bigint
    A unique identifier for the object.
  • merchantDescription
    map
     
  • name
    map
    Le nom localisé de l'objet.
  • supportedCurrencies
    array
    Les devises prises en charge par la méthode de paiement.
paymentmethodbrand paymentmethodbrand
  • description
    map
    La description localisée de l'objet.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Le nom localisé de l'objet.
  • paymentMethod
    bigint
    Le mode de paiement auquel la marque appartient.
paymentmethodconfiguration paymentmethodconfiguration

La configuration du mode de paiement est un prérequis pour associer un processeur à une configuration concrète.

La configuration du mode de paiement est un prérequis pour associer un processeur à une configuration concrète.
  • dataCollectionType
    string
    Le type de collecte de données spécifie la manière dont les informations relatives au paiement sont collectées.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Nom utilisé pour identifier la configuration de la méthode de paiement.
  • oneClickPaymentMode
    string
    Le mode de paiement en un clic détermine si le client peut enregistrer ses données de paiement pour des paiements ultérieurs.
  • paymentMethod
    bigint
    Le mode de paiement pour lequel la configuration est effectuée.
  • resolvedDescription
    map
    La description du mode de paiement qui est effectivement affichée au client. Il s'agit soit de la description personnalisée, si elle a été définie, soit de la description par défaut du mode de paiement.
  • resolvedTitle
    map
    Le titre du mode de paiement qui est effectivement affiché au client. Il s'agit soit du titre personnalisé, s'il a été défini, soit du titre par défaut du mode de paiement.
  • sortOrder
    int
    Lors de l'établissement de la liste des modes de paiement, ceux-ci peuvent être triés en fonction de ce numéro.
  • state
    string
    L'état actuel de l'objet.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
paymentprocessor paymentprocessor

Les processeurs de paiement assurent la connexion avec des sociétés tierces (prestataires de services de paiement) qui gèrent techniquement les transactions de paiement et traitent donc les paiements.

Les processeurs de paiement assurent la connexion avec des sociétés tierces (prestataires de services de paiement) qui gèrent techniquement les transactions de paiement et traitent donc les paiements.
  • companyName
    map
    Le nom de la société à laquelle appartient le processeur.
  • description
    map
    La description localisée de l'objet.
  • headquartersLocation
    map
    Le lieu où se trouve le siège du transformateur.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Le nom localisé de l'objet.
  • productName
    map
    Le nom du produit du processeur.
paymentprocessorconfiguration paymentprocessorconfiguration
  • applicationManaged
    boolean
    Si la configuration du processeur est gérée par l'application et ne peut donc pas être modifiée.
  • contractId
    bigint
    L'ID du contrat de paiement auquel la configuration du processeur est liée.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Nom utilisé pour identifier la configuration de la méthode de paiement.
  • processor
    bigint
    Le processeur de paiement pour lequel la configuration a été établie.
  • state
    string
    L'état actuel de l'objet.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
refund refund

Un remboursement représente un crédit transféré en retour au client. Il peut être déclenché par le commerçant ou le client (chargeback).

Un remboursement représente un crédit transféré en retour au client. Il peut être déclenché par le commerçant ou le client (chargeback).
  • amount
    decimal
     
  • baseLineItems
    array
     
  • completion
    bigint
     
  • createdBy
    bigint
     
  • createdOn
    timestamp
    La date et l'heure de création de l'objet.
  • environment
    string
     
  • externalId
    string
    L’External ID aide à identifier les appels répétés au service de remboursement. L’Extrernal ID doit donc être unique pour chaque transaction.
  • failedOn
    timestamp
     
  • failureReason
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • labels
    array
    Les étiquettes fournissant des informations supplémentaires sur l'objet.
  • 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
    L'état actuel de l'objet.
  • succeededOn
    timestamp
     
  • taxes
    array
     
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • totalAppliedFees
    decimal
    Le total des frais appliqués est la somme de tous les frais qui ont été appliqués jusqu'à présent.
  • totalSettledAmount
    decimal
    Le montant total réglé est le montant total qui a été réglé jusqu'à présent.
  • transaction
    bigint
     
  • type
    string
     
  • updatedInvoice
    bigint
     
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
paymentterminal paymentterminal
  • defaultCurrency
    string
    La devise par défaut du terminal.
  • id
    bigint
    A unique identifier for the object.
  • identifier
    string
    L'identifiant unique du terminal, qui est affiché sur l'appareil.
  • name
    string
    Nom utilisé pour identifier le terminal de paiement.
  • state
    string
    L'état actuel de l'objet.
  • type
    bigint
    Le type de terminal de paiement.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
paymentterminaltype paymentterminaltype
  • description
    map
    La description localisée de l'objet.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Le nom localisé de l'objet.
token token
  • createdOn
    timestamp
    La date et l'heure de création de l'objet.
  • customerEmailAddress
    string
    L'adresse électronique du client.
  • customerId
    string
    L'identifiant unique du client dans le système externe.
  • enabledForOneClickPayment
    boolean
    Si le jeton est activé pour les paiements en un clic, ce qui simplifie le processus de paiement pour le client. Les jetons de paiement en un clic sont liés aux clients par l'intermédiaire de l'identifiant du client.
  • externalId
    string
    Un nonce généré par le client qui identifie l'entité à créer. Les demandes de création ultérieures avec le même identifiant externe ne créeront pas de nouvelles entités mais renverront l'entité initialement créée.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • state
    string
    L'état actuel de l'objet.
  • timeZone
    string
    Le fuseau horaire du client, qui affecte la façon dont les dates et les heures sont formatées lors de la communication avec le client.
  • tokenReference
    string
    La référence utilisée pour identifier le jeton de paiement (par exemple, l'identifiant ou l'adresse électronique du client).
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
transaction transaction
  • acceptHeader
    string
    L'en-tête "Accept" du navigateur web du client.
  • acceptLanguageHeader
    string
    L'en-tête "Accept Language" du navigateur web du client.
  • allowedPaymentMethodBrands
    array
    Les marques de la méthode de paiement qui peuvent être utilisées pour autoriser la transaction.
  • allowedPaymentMethodConfigurations
    array
    Les configurations de la méthode de paiement qui peuvent être utilisées pour autoriser la transaction.
  • authorizationAmount
    decimal
    La somme de tous les prix des postes, taxes comprises, dans la devise de la transaction.
  • authorizationEnvironment
    string
    L'environnement dans lequel la transaction a été autorisée.
  • authorizationSalesChannel
    bigint
    Le canal de vente par lequel la transaction a été effectuée.
  • authorizationTimeoutOn
    timestamp
    La date et l'heure auxquelles la transaction doit être autorisée, sinon elle sera annulée.
  • authorizedOn
    timestamp
    La date et l'heure auxquelles la transaction a été autorisée.
  • autoConfirmationEnabled
    boolean
    Indique si la transaction peut être confirmée automatiquement ou si cela doit être fait explicitement via l'API. La valeur par défaut est true.
  • billingAddress
    struct
    L'adresse associée à la méthode de paiement à des fins de facturation et de traitement des transactions.
  • 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
    Indique si le client peut effectuer d'autres tentatives de paiement si la première a échoué. La valeur par défaut est true.
  • completedAmount
    decimal
    Le montant total qui a été réalisé, dans la devise de la transaction.
  • completedOn
    timestamp
    La date et l'heure auxquelles la transaction a été effectuée.
  • completionBehavior
    string
    Le comportement qui contrôle la fin de la transaction.
  • completionTimeoutOn
    timestamp
    La date et l'heure auxquelles la transaction est terminée automatiquement.
  • confirmedBy
    bigint
    L'ID de l'utilisateur par lequel la transaction a été confirmée.
  • confirmedOn
    timestamp
    La date et l'heure auxquelles la transaction a été créée.
  • createdBy
    bigint
    L'ID de l'utilisateur par lequel la transaction a été créée.
  • createdOn
    timestamp
    La date et l'heure de création de l'objet.
  • currency
    string
    Code à trois lettres (format ISO 4217) de la devise de la transaction.
  • customerEmailAddress
    string
    L'adresse électronique du client.
  • customerId
    string
    L'identifiant unique du client dans le système externe.
  • customersPresence
    string
    La présence du client indique si le client de la transaction est présent et de quelle manière. La valeur par défaut est VIRTUAL_PRESENT.
  • deliveryDecisionMadeOn
    timestamp
    Date et heure auxquelles la décision a été prise d'expédier ou non la commande.
  • deviceSessionIdentifier
    string
    Permet de lier la transaction aux données collectées sur l'appareil du client.
  • emailsDisabled
    boolean
    Indique si l'envoi d'e-mails est désactivé pour la transaction. La valeur par défaut est false.
  • environment
    string
     
  • environmentSelectionStrategy
    string
    La stratégie permettant de déterminer si la transaction doit être traitée dans l'environnement de test ou de production.
  • failedOn
    timestamp
    Date et heure de l'échec de la transaction.
  • failedUrl
    string
    URL vers laquelle rediriger le client après l'annulation ou l'échec de l'authentification de son paiement.
  • failureReason
    bigint
    La raison de l'échec de la transaction.
  • id
    bigint
    A unique identifier for the object.
  • internetProtocolAddress
    string
    L'adresse IP de l'appareil du client.
  • internetProtocolAddressCountry
    string
    Le pays déterminé à partir de l'adresse IP de l'appareil du client.
  • invoiceMerchantReference
    string
    Référence du commerçant utilisée pour identifier la facture.
  • javaEnabled
    boolean
    Si Java est activé sur le navigateur web du client.
  • language
    string
    The language that is linked to the object.
  • lineItems
    array
    Les articles achetés par le client.
  • merchantReference
    string
    Référence du commerçant utilisée pour identifier la transaction.
  • metaData
    map
    Permet de stocker des informations supplémentaires sur l'objet.
  • parent
    bigint
    La transaction mère qui a été (partiellement) remplacée par cette transaction.
  • paymentConnectorConfiguration
    bigint
    La configuration du connecteur de paiement qui a été utilisée pour autoriser la transaction.
  • processingOn
    timestamp
    La date et l'heure auxquelles le traitement de la transaction a commencé.
  • refundedAmount
    decimal
    Le montant total remboursé, dans la devise de la transaction.
  • screenColorDepth
    string
    La profondeur de couleur de l'écran du navigateur web du client.
  • screenHeight
    string
    La hauteur de l'écran du navigateur web du client.
  • screenWidth
    string
    Largeur de l'écran du navigateur web du client.
  • shippingAddress
    struct
    L'adresse à laquelle la commande sera expédiée.
  • 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
    Le nom de la méthode d'expédition utilisée pour expédier les produits.
  • spaceViewId
    bigint
    L'ID de la vue de l'espace à laquelle cet objet est lié.
  • state
    string
    L'état actuel de l'objet.
  • successUrl
    string
    L'URL vers laquelle le client doit être redirigé après avoir authentifié son paiement.
  • terminal
    bigint
    Le terminal de paiement par lequel le paiement a été effectué.
  • timeZone
    string
    Le fuseau horaire du client, qui affecte la façon dont les dates et les heures sont formatées lors de la communication avec le client.
  • token
    bigint
    Le jeton de paiement qui doit être utilisé pour facturer le client.
  • tokenizationMode
    string
    Le mode de symbolisation spécifie si et comment la symbolisation des informations de paiement est appliquée à la transaction.
  • totalAppliedFees
    decimal
    Le total de tous les frais facturés, dans la devise de la transaction.
  • totalSettledAmount
    decimal
    Le montant total qui a été réglé, dans la devise de la transaction.
  • userAgentHeader
    string
    L'en-tête "User Agent" du navigateur web du client.
  • userFailureMessage
    string
    Le message qui peut être affiché au client expliquant pourquoi la transaction a échoué, dans la langue du client.
  • userInterfaceType
    string
    Le type d'interface utilisateur que le client a utilisé pour fournir les informations de paiement.
  • windowHeight
    string
    La hauteur de la fenêtre du navigateur web du client.
  • windowWidth
    string
    Largeur de la fenêtre du navigateur web du client.
  • yearsToKeep
    int
    Le nombre d'années pendant lesquelles la transaction est conservée après son autorisation.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
transactioncompletion transactioncompletion
  • amount
    decimal
    Le montant qui est capturé. Le montant représente la somme des postes de la ligne, y compris les taxes.
  • baseLineItems
    array
    Les éléments de la ligne de base sur lesquels l'achèvement est appliqué.
  • createdBy
    bigint
     
  • createdOn
    timestamp
    La date et l'heure de création de l'objet.
  • externalId
    string
    L'ID externe aide à identifier l'entité et la création ultérieure d'une entité avec le même ID ne créera pas une nouvelle entité.
  • failedOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • invoiceMerchantReference
    string
     
  • labels
    array
    Les étiquettes fournissant des informations supplémentaires sur l'objet.
  • language
    string
    The language that is linked to the object.
  • lastCompletion
    boolean
    Indique s'il s'agit du dernier achèvement. Après la création du dernier achèvement, la transaction ne peut plus être achevée.
  • lineItems
    array
    Les postes qui sont capturés.
  • linkedTransaction
    bigint
     
  • mode
    string
     
  • nextUpdateOn
    timestamp
     
  • paymentInformation
    string
     
  • processingOn
    timestamp
     
  • processorReference
    string
     
  • remainingLineItems
    array
     
  • spaceViewId
    bigint
    L'ID de la vue de l'espace à laquelle cet objet est lié.
  • state
    string
    L'état actuel de l'objet.
  • statementDescriptor
    string
    Le descripteur de relevé explique les frais ou les paiements sur les relevés bancaires.
  • succeededOn
    timestamp
     
  • taxAmount
    decimal
    La somme totale de toutes les taxes des postes.
  • timeZone
    string
     
  • timeoutOn
    timestamp
     
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
transactioninvoice transactioninvoice

La facture de transaction représente le document de facture d’une transaction.

La facture de transaction représente le document de facture d’une 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
    La date à laquelle la facture est créée.
  • derecognizedBy
    bigint
    L'identifiant de l'utilisateur qui a marqué la facture comme étant décomptabilisée.
  • derecognizedOn
    timestamp
    La date à laquelle la facture est considérée comme décomptabilisée.
  • dueOn
    timestamp
    La date à laquelle la facture doit être payée.
  • environment
    string
     
  • externalId
    string
    L'identifiant externe permet d'identifier l'entité et la création ultérieure d'une entité avec le même identifiant ne créera pas une nouvelle 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
    Le montant dû indique la somme que le client doit au commerçant. Un montant négatif signifie que le client a trop payé.
  • paidOn
    timestamp
    La date à laquelle la facture a été marquée comme payée. Il est possible que cette date soit quelque peu postérieure à la date de paiement effective.
  • spaceViewId
    bigint
    L'ID de la vue de l'espace à laquelle cet objet est lié.
  • state
    string
    L'état actuel de l'objet.
  • taxAmount
    decimal
     
  • timeZone
    string
     
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
wallettype wallettype
  • description
    map
    La description localisée de l'objet.
  • id
    bigint
    A unique identifier for the object.
  • name
    map
    Le nom localisé de l'objet.
subscriptionaffiliate subscriptionaffiliate
  • externalId
    string
    Un nonce généré par le client qui identifie l'entité à créer. Les demandes de création ultérieures avec le même identifiant externe ne créeront pas de nouvelles entités mais renverront l'entité initialement créée.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • metaData
    map
    Permet de stocker des informations supplémentaires sur l'objet.
  • name
    string
    Nom utilisé pour identifier l'affilié.
  • reference
    string
    La référence utilisée pour identifier l'affilié.
  • state
    string
    L'état actuel de l'objet.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
subscription subscription
  • activatedOn
    timestamp
    La date et l'heure auxquelles l'abonnement a été activé.
  • affiliate
    bigint
    L'affilié qui a conduit à la création de l'abonnement.
  • createdOn
    timestamp
    La date et l'heure de la création de l'abonnement.
  • currentProductVersion
    bigint
    La version du produit à laquelle l'abonnement est actuellement lié.
  • description
    string
    Description utilisée pour identifier l'abonnement.
  • id
    bigint
    A unique identifier for the object.
  • initializedOn
    timestamp
    La date et l'heure auxquelles l'abonnement a été initialisé.
  • language
    string
    The language that is linked to the object.
  • plannedTerminationDate
    timestamp
    La date et l'heure auxquelles il est prévu de mettre fin à l'abonnement.
  • reference
    string
    Référence du commerçant utilisée pour identifier l'abonnement.
  • state
    string
    L'état actuel de l'objet.
  • subscriber
    bigint
    L'abonné auquel l'abonnement appartient.
  • terminatedBy
    bigint
    L'ID de l'utilisateur qui a mis fin à l'abonnement.
  • terminatedOn
    timestamp
    La date et l'heure auxquelles l'abonnement a été résilié.
  • terminatingOn
    timestamp
    Date et heure auxquelles la résiliation de l'abonnement a commencé.
  • terminationScheduledOn
    timestamp
    Date et heure auxquelles la résiliation de l'abonnement a été programmée.
  • token
    bigint
    Le jeton de paiement utilisé pour facturer le client.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
subscriptioncomponentconfiguration subscriptioncomponentconfiguration
  • component
    bigint
    Le composant en cours de configuration.
  • id
    bigint
    A unique identifier for the object.
  • quantity
    decimal
    La quantité à appliquer au composant.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
subscriptionperiodbill subscriptionperiodbill
  • createdOn
    timestamp
    Date et heure de création de la facture périodique.
  • effectivePeriodEndDate
    timestamp
    La date et l'heure de la fin effective de la période.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • periodStartDate
    timestamp
    La date et l'heure du début de la période.
  • plannedPeriodEndDate
    timestamp
    La date et l'heure auxquelles la période est censée se terminer.
  • state
    string
    L'état actuel de l'objet.
  • subscriptionVersion
    bigint
    La version de l'abonnement à laquelle la facture périodique appartient.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
subscriptionperiodbillitem subscriptionperiodbillitem
  • bill
    bigint
     
  • fee
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • ledgerEntry
    bigint
     
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
subscriptionversion subscriptionversion
  • activatedOn
    timestamp
    La date et l'heure auxquelles la version de l'abonnement a été activée.
  • billingCurrency
    string
    Code à trois lettres (format ISO 4217) de la devise utilisée pour facturer le client. Il doit s'agir d'une des devises prises en charge par le produit.
  • createdOn
    timestamp
    La date et l'heure auxquelles la version de l'abonnement a été créée.
  • expectedLastPeriodEnd
    timestamp
    La date et l'heure auxquelles la dernière période est censée se terminer.
  • failedOn
    timestamp
    Date et heure de l'échec de la version de l'abonnement.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • plannedTerminationDate
    timestamp
    La date et l'heure auxquelles la résiliation de la version de l'abonnement est prévue.
  • productVersion
    bigint
    La version du produit à laquelle on a souscrit.
  • state
    string
    L'état actuel de l'objet.
  • subscription
    bigint
    L'abonnement auquel cette version appartient.
  • terminatedOn
    timestamp
    La date et l'heure auxquelles la version de l'abonnement a été résiliée.
  • terminatingOn
    timestamp
    Date et heure auxquelles la résiliation de la version de l'abonnement a commencé.
  • terminationIssuedOn
    timestamp
    La date et l'heure auxquelles la résiliation de la version de l'abonnement a été émise.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
subscriptioncharge subscriptioncharge

La redevance d'abonnement représente une redevance unique effectuée pour un abonnement particulier.

La redevance d'abonnement représente une redevance unique effectuée pour un abonnement particulier.
  • createdOn
    timestamp
    La date et l'heure de la création de la charge.
  • discardedBy
    bigint
    L'ID de l'utilisateur par lequel la charge a été rejetée.
  • discardedOn
    timestamp
    La date et l'heure auxquelles la charge a été rejetée.
  • externalId
    string
    Un nonce généré par le client qui identifie l'entité à créer. Les demandes de création ultérieures avec le même identifiant externe ne créeront pas de nouvelles entités mais renverront l'entité initialement créée.
  • failedOn
    timestamp
    La date et l'heure de l'échec de la charge.
  • failedUrl
    string
    URL vers laquelle rediriger le client après l'annulation ou l'échec de l'authentification de son paiement.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    The language that is linked to the object.
  • ledgerEntries
    array
    Les écritures du grand livre qui appartiennent à l'imputation.
  • plannedExecutionDate
    timestamp
    La date et l'heure auxquelles l'exécution de la charge est prévue.
  • processingType
    string
    Le type de traitement spécifie la manière dont la taxe doit être traitée.
  • reference
    string
    Référence du commerçant utilisée pour identifier la charge.
  • state
    string
    L'état actuel de l'objet.
  • subscription
    bigint
    L'abonnement auquel appartient le prélèvement.
  • succeedOn
    timestamp
    La date et l'heure auxquelles la charge a réussi.
  • successUrl
    string
    L'URL vers laquelle le client doit être redirigé après avoir authentifié son paiement.
  • transaction
    bigint
    La transaction utilisée pour traiter la charge.
  • type
    string
    Le type spécifie la manière dont l'accusation a été initiée.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
subscriptionledgerentry subscriptionledgerentry

L'écriture du livre d'abonnement représente une seule modification du solde de l'abonnement.

L'écriture du livre d'abonnement représente une seule modification du solde de l'abonnement.
  • aggregatedTaxRate
    decimal
    Le taux d'imposition total appliqué à l'entrée du grand livre, calculé à partir des taux de toutes les lignes d'imposition.
  • amountExcludingTax
    decimal
    Le montant de l'entrée du journal avec les remises appliquées, hors taxes.
  • amountIncludingTax
    decimal
    Le montant de l'entrée du journal avec les réductions appliquées, y compris les taxes.
  • createdBy
    bigint
    L'ID de l'utilisateur qui a créé l'entrée dans le grand livre.
  • createdOn
    timestamp
    La date et l'heure de création de l'objet.
  • discountIncludingTax
    decimal
    La remise attribuée à l'entrée du grand livre, y compris les taxes.
  • externalId
    string
    Un nonce généré par le client qui identifie l'entité à créer. Les demandes de création ultérieures avec le même identifiant externe ne créeront pas de nouvelles entités mais renverront l'entité initialement créée.
  • id
    bigint
    A unique identifier for the object.
  • proRataCalculated
    boolean
     
  • quantity
    decimal
    Le nombre d'articles consommés.
  • state
    string
    L'état actuel de l'objet.
  • subscriptionVersion
    bigint
    La version de l'abonnement à laquelle l'entrée du grand livre appartient.
  • taxAmount
    decimal
    La somme de toutes les taxes appliquées à l'entrée du grand livre.
  • taxes
    array
    Un ensemble de lignes de taxe, chacune d'entre elles spécifiant une taxe appliquée à l'entrée du grand livre.
  • title
    string
    Titre indiquant l'objet de l'écriture dans le grand livre.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
coupon coupon

Les coupons sont un moyen d'accorder des réductions sur les abonnements. Créez un nouveau coupon, configurez-le avec des remises et des règles, puis partagez-le avec vos clients.

Les coupons sont un moyen d'accorder des réductions sur les abonnements. Créez un nouveau coupon, configurez-le avec des remises et des règles, puis partagez-le avec vos clients.
  • createdBy
    bigint
    Le champ créé par indique l'utilisateur qui a créé le coupon.
  • createdOn
    timestamp
     
  • deletedBy
    bigint
    Le champ "supprimé par" indique l'utilisateur qui a supprimé le coupon.
  • deletedOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Le nom du coupon est uniquement utilisé à des fins de gestion du coupon et n'est jamais montré à l'abonné. Vous pourrez donner à ce coupon une description ou un nom plus détaillé lors de sa configuration ultérieure.
  • spaceId
    bigint
     
  • state
    string
    L'état actuel de l'objet.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
couponversion couponversion

La version du coupon contient un sous-ensemble des propriétés du coupon qui peuvent changer au fil du temps. Une seule version peut être active en même temps.

La version du coupon contient un sous-ensemble des propriétés du coupon qui peuvent changer au fil du temps. Une seule version peut être active en même temps.
  • activatedBy
    bigint
    Le champ activé par indique l'utilisateur qui a activé la version du coupon.
  • activatedOn
    timestamp
     
  • coupon
    bigint
    Le coupon auquel la version du coupon est liée.
  • createdBy
    bigint
    Le champ créé par indique l'utilisateur qui a créé la version du coupon.
  • createdOn
    timestamp
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Un nom significatif ou une courte description pour communiquer l'intention du coupon. C'est ce que l'abonné verra sur sa facture ou lorsqu'il échangera le code du coupon.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • obsoletedBy
    bigint
    Le champ "obsolète par" indique l'utilisateur qui a rendu obsolète la version du coupon.
  • obsoletedOn
    timestamp
     
  • state
    string
    L'état actuel de l'objet.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
abstractproductfee abstractproductfee
  • component
    bigint
    La composante du produit à laquelle appartient la redevance.
  • description
    struct
    La description localisée de la taxe qui est affichée au client.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Nom localisé de la taxe affichée au client.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • type
    string
    Le type de redevance.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
productmeteredfee productmeteredfee
  • component
    bigint
    La composante du produit à laquelle appartient la redevance.
  • description
    struct
    La description localisée de la taxe qui est affichée au client.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • metric
    bigint
    La mesure utilisée pour déterminer la consommation de ressources facturée au client.
  • name
    struct
    Nom localisé de la taxe affichée au client.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • tierPricing
    string
    La méthode utilisée pour calculer le prix de l'échelon.
  • type
    string
    Le type de redevance.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
productperiodfee productperiodfee
  • component
    bigint
    La composante du produit à laquelle appartient la redevance.
  • description
    struct
    La description localisée de la taxe qui est affichée au client.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • ledgerEntryTitle
    struct
    Le titre localisé qui sera utilisé sur les écritures du grand livre et les factures.
  • ledgerEntryTitle.availableLanguages
    array
     
  • ledgerEntryTitle.displayName
    string
     
  • ledgerEntryTitle.items
    array
     
  • name
    struct
    Nom localisé de la taxe affichée au client.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • numberOfFreeTrialPeriods
    int
    Nombre de cycles de facturation de l'abonnement considérés comme une phase d'essai et pendant lesquels aucune redevance n'est prélevée.
  • periodFee
    array
    Le montant facturé au client pour chaque cycle de facturation pendant la durée de l'abonnement.
  • type
    string
    Le type de redevance.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
productsetupfee productsetupfee
  • component
    bigint
    La composante du produit à laquelle appartient la redevance.
  • description
    struct
    La description localisée de la taxe qui est affichée au client.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Nom localisé de la taxe affichée au client.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • onDowngradeCreditedAmount
    array
    Le montant facturé au client lorsqu'un abonnement est déclassé.
  • onUpgradeCreditedAmount
    array
    Le montant facturé au client lorsqu'un abonnement est mis à niveau.
  • setupFee
    array
    Le montant facturé au client une seule fois lorsqu'il souscrit à un abonnement.
  • type
    string
    Le type de redevance.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
subscriptionmetric subscriptionmetric

Une métrique représente l'utilisation d'une ressource qui peut être mesurée.

Une métrique représente l'utilisation d'une ressource qui peut être mesurée.
  • description
    struct
    Description localisée de la mesure affichée au client.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Le nom localisé de l'indicateur qui est affiché au client.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • state
    string
    L'état actuel de l'objet.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
subscriptionproduct subscriptionproduct

Un produit d'abonnement représente un produit auquel un abonné peut s'abonner. Un produit définit le coût de l'abonnement et les cycles de facturation de l'abonnement.

Un produit d'abonnement représente un produit auquel un abonné peut s'abonner. Un produit définit le coût de l'abonnement et les cycles de facturation de l'abonnement.
  • allowedPaymentMethodConfigurations
    array
    Les méthodes de paiement qui peuvent être utilisées pour s'abonner à ce produit. Si aucune méthode n'est sélectionnée, aucune restriction n'est appliquée.
  • failedPaymentSuspensionPeriod
    string
    Période au terme de laquelle un abonnement suspendu en raison d'un défaut de paiement est résilié.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Nom utilisé pour identifier le produit.
  • productLocked
    boolean
    Si les abonnements peuvent être transférés vers ou depuis ce produit, ou s'ils sont verrouillés.
  • reference
    string
    La référence du commerçant utilisée pour identifier le produit, par exemple le SKU.
  • sortOrder
    int
    Lors de l'établissement de la liste des produits, ceux-ci peuvent être triés en fonction de ce numéro.
  • spaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
  • state
    string
    L'état actuel de l'objet.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
subscriptionproductcomponent subscriptionproductcomponent
  • componentChangeWeight
    int
    Le passage d'un composant d'un niveau inférieur à un composant d'un niveau supérieur est considéré comme une mise à niveau et une redevance peut être appliquée.
  • componentGroup
    bigint
    Le groupe auquel appartient le composant.
  • defaultComponent
    boolean
    S'il s'agit du composant par défaut dans son groupe et présélectionné.
  • description
    struct
    La description localisée du composant qui est affichée au client.
  • description.availableLanguages
    array
     
  • description.displayName
    string
     
  • description.items
    array
     
  • id
    bigint
    A unique identifier for the object.
  • maximalQuantity
    decimal
    Un maximum de la quantité définie peut être sélectionné pour ce composant.
  • minimalQuantity
    decimal
    Un minimum de la quantité définie doit être sélectionné pour ce composant.
  • name
    struct
    Le nom localisé du composant qui est affiché au client.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • quantityStep
    decimal
    L'échelon de quantité détermine l'intervalle dans lequel la quantité peut être augmentée.
  • reference
    bigint
    La référence est utilisée pour relier les composants entre les différentes versions du produit.
  • sortOrder
    int
    Lors de l'établissement de la liste des composants, ceux-ci peuvent être triés en fonction de ce numéro.
  • taxClass
    bigint
    La classe de taxe à appliquer aux frais.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
subscriptionproductcomponentgroup subscriptionproductcomponentgroup
  • id
    bigint
    A unique identifier for the object.
  • name
    struct
    Nom localisé du groupe de composants affiché au client.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • optional
    boolean
    Si le groupe de composants est facultatif, c'est-à-dire que le client ne doit sélectionner aucun composant.
  • productVersion
    bigint
    La version du produit à laquelle le groupe de composants appartient.
  • sortOrder
    int
    Lors de l'établissement de la liste des groupes de composants, ceux-ci peuvent être triés en fonction de ce numéro.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
subscriptionproductcomponentreference subscriptionproductcomponentreference

La référence du composant du produit relie les composants de différentes versions du produit, ce qui permet d'effectuer des migrations.

La référence du composant du produit relie les composants de différentes versions du produit, ce qui permet d'effectuer des migrations.
  • id
    bigint
    A unique identifier for the object.
  • name
    string
    Nom utilisé pour identifier la référence du composant.
  • state
    string
    L'état actuel de l'objet.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
subscriptionproductversion subscriptionproductversion
  • activatedOn
    timestamp
    La date et l'heure auxquelles la version du produit a été activée.
  • billingCycle
    string
    Période récurrente, généralement mensuelle ou annuelle, pour laquelle un abonné est facturé.
  • comment
    string
    Un commentaire qui décrit la version du produit et la raison pour laquelle elle a été créée. Il n'est pas divulgué à l'abonné.
  • createdOn
    timestamp
    La date et l'heure auxquelles la version du produit a été créée.
  • defaultCurrency
    string
    Code à trois lettres (format ISO 4217) de la devise par défaut de la version du produit.
  • enabledCurrencies
    array
    Les codes à trois lettres (format ISO 4217) des devises que la version du produit prend en charge.
  • id
    bigint
    A unique identifier for the object.
  • incrementNumber
    int
    Chaque fois qu'une nouvelle version d'un produit est créée, le numéro est augmenté et attribué.
  • minimalNumberOfPeriods
    int
    Nombre minimum de périodes pendant lesquelles l'abonnement sera en vigueur avant qu'il ne puisse être résilié.
  • name
    struct
    Le nom localisé du produit qui est affiché au client.
  • name.availableLanguages
    array
     
  • name.displayName
    string
     
  • name.items
    array
     
  • numberOfNoticePeriods
    int
    Le nombre de périodes pendant lesquelles l'abonnement continuera à fonctionner après que sa résiliation a été demandée.
  • obsoletedOn
    timestamp
    Date et heure auxquelles la version du produit a été rendue obsolète.
  • product
    bigint
    Le produit auquel la version appartient.
  • reference
    string
    La référence utilisée pour identifier la version du produit.
  • retiringFinishedOn
    timestamp
    La date et l'heure auxquelles la version du produit a été retirée.
  • retiringStartedOn
    timestamp
    La date et l'heure auxquelles la retraite de la version du produit a été lancée.
  • state
    string
    L'état actuel de l'objet.
  • taxCalculation
    string
    La manière dont les taxes sont calculées pour les honoraires.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
subscriber subscriber

Un abonné représente toutes les personnes qui sont abonnées à un produit.

Un abonné représente toutes les personnes qui sont abonnées à un produit.
  • additionalAllowedPaymentMethodConfigurations
    array
    Permettre à l'abonné d'utiliser ces modes de paiement même si les produits d'abonnement ne les acceptent pas.
  • billingAddress
    struct
    L'adresse associée à l'abonné à des fins de facturation et de traitement des transactions.
  • 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
    Description utilisée pour identifier l'abonné.
  • disallowedPaymentMethodConfigurations
    array
    Empêcher l'abonné d'utiliser ces modes de paiement, même si les produits d'abonnement les acceptent.
  • emailAddress
    string
    L'adresse électronique utilisée pour communiquer avec l'abonné. Il ne peut y avoir qu'un seul abonné par espace avec la même adresse électronique.
  • externalId
    string
    Un nonce généré par le client qui identifie l'entité à créer. Les demandes de création ultérieures avec le même identifiant externe ne créeront pas de nouvelles entités mais renverront l'entité initialement créée.
  • id
    bigint
    A unique identifier for the object.
  • language
    string
    La langue utilisée pour communiquer avec l'abonné par le biais de courriels et de documents.
  • metaData
    map
    Permet de stocker des informations supplémentaires sur l'objet.
  • reference
    string
    Référence du commerçant utilisée pour identifier l'abonné.
  • shippingAddress
    struct
    L'adresse à laquelle les commandes seront expédiées.
  • 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
    L'état actuel de l'objet.
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.
subscribercustomer subscribercustomer
  • customer
    bigint
     
  • id
    bigint
    A unique identifier for the object.
  • subscriber
    bigint
     
  • linkedSpaceId
    bigint
    L'ID de l'espace auquel appartient cet objet.