Create contract
Créer un nouveau contrat dans votre compte HubSpot à l’aide de l’API Commerce Contracts. Ce point de terminaison vous permet de spécifier divers détails de contrat, y compris les informations de facturation, les lignes de produit et les méthodes de paiement. La date d’entrée en vigueur et le code de devise du contrat sont requis, ainsi que d’autres détails essentiels. Cette opération renvoie l’URL de la ressource de contrat nouvellement créée après une création réussie.
Supported products
Supported products
Required Scopes
Required Scopes
Corps
Un objet indiquant si les taxes automatisées sont activées pour le contrat.
Un objet représentant l'adresse de facturation du contrat.
Un objet représentant l'ID de l'entreprise de facturation.
Une chaîne représentant l'ID du contact de facturation.
Un objet représentant une dérogation pour la date de début de facturation.
Une chaîne représentant la date d'entrée en vigueur du contrat, au format date.
Une chaîne représentant le code de devise du contrat.
Un objet représentant l'ID de la transaction associée.
Un objet représentant l'ID de référence externe du mode de paiement.
Un booléen indiquant si la facturation HubSpot est activée pour le contrat.
Un ensemble de lignes de produit inclus dans le contrat, qui peuvent être personnalisées, issues d'un produit ou clonées.
- CUSTOM
- FROM_PRODUCT
- CLONE
Un objet représentant les paramètres régionaux du contrat.
Une chaîne représentant le nom du contrat.
Un objet représentant les conditions de paiement nettes du contrat.
Un objet représentant l'ID du propriétaire du contrat.
Un booléen indiquant si le paiement est activé pour le contrat.
Un objet représentant le numéro de bon de commande pour le contrat.
Un objet représentant l'adresse de l'entreprise du vendeur.
Un objet représentant le domaine de l'entreprise du vendeur.
Un objet représentant le nom de l'entreprise du vendeur.
Un objet représentant l'adresse e-mail du vendeur.
Un objet représentant le prénom du vendeur.
Un objet représentant le nom de famille du vendeur.
Un objet représentant le numéro de téléphone du vendeur.
Un ensemble de types d'adresse à collecter : « BILLING_ADDRESS » et « SHIPPING_ADDRESS ».
BILLING_ADDRESS, SHIPPING_ADDRESS Un ensemble de méthodes de paiement autorisées pour le contrat, telles que « CREDIT_OR_DEBIT_CARD », « ACH », « SEPA », « BACS », « PADS », « AFFIRM » et « KLARNA ».
CREDIT_OR_DEBIT_CARD, ACH, SEPA, BACS, PADS, AFFIRM, KLARNA Une chaîne représentant l'ID de l'unité commerciale associée au contrat.
Une chaîne indiquant le processus de recouvrement pour le contrat, qui peut être « MANUAL_PAYMENTS » ou « AUTOMATIC_PAYMENTS ».
AUTOMATIC_PAYMENTS, MANUAL_PAYMENTS Un objet contenant des propriétés personnalisées pour le contrat, avec des valeurs de chaîne.
Réponse
successful operation
Un tableau indiquant les types d'adresses à collecter. Les valeurs valides incluent « BILLING_ADDRESS » et « SHIPPING_ADDRESS ».
BILLING_ADDRESS, SHIPPING_ADDRESS Un tableau des méthodes de paiement autorisées. Les valeurs valides incluent « CREDIT_OR_DEBIT_CARD », « ACH », « SEPA », « BACS », « PADS », « AFFIRM » et « KLARNA ».
CREDIT_OR_DEBIT_CARD, ACH, SEPA, BACS, PADS, AFFIRM, KLARNA Indique si les taxes automatisées sont activées pour le contrat.
Une carte des noms de propriétés personnalisées et de leurs valeurs.
Indique si la facturation HubSpot est activée pour le contrat.
L'identifiant unique du contrat.
Un ensemble de lignes de produit incluses dans le contrat.
Indique si le paiement est activé pour le contrat.
Le statut actuel du contrat. Les valeurs valides incluent « BROUILLON », « ACTIF », « EN PAUSE », « TERMINÉ » et « RÉSILIÉ ».
ACTIVE, COMPLETED, DRAFT, PAUSED, TERMINATED Indique si le mode de paiement doit être enregistré lors du paiement.
Le nom des frais appliqués à toutes les transactions.
Le pourcentage des frais appliqués à toutes les transactions.
La valeur annuelle du contrat.
L'identifiant unique de l'entreprise de facturation associée au contrat.
L'identifiant unique du contact de facturation associé au contrat.
La date de remplacement de la date de début de facturation, au format ISO 8601.
L'identifiant unique de l'unité commerciale associée au contrat.
Nom des frais appliqués aux transactions par carte.
Le pourcentage des frais appliqués aux transactions par carte.
Le processus de collecte des paiements. Les valeurs valides incluent « MANUAL_PAYMENTS » et « AUTOMATIC_PAYMENTS ».
AUTOMATIC_PAYMENTS, MANUAL_PAYMENTS La date d'entrée en vigueur du contrat, au format ISO 8601.
L'identifiant unique de la source du contrat.
La date et l'heure de création du contrat, au format ISO 8601.
Le code de devise associé au contrat, représenté sous forme de chaîne.
Le revenu annuel récurrent actuel pour le contrat.
Le revenu récurrent mensuel actuel du contrat.
L'identifiant unique de la transaction associée au contrat.
Le nom des frais appliqués aux transactions par prélèvement automatique.
Le pourcentage des frais appliqués aux transactions par prélèvement automatique.
Le code de réduction appliqué au contrat.
La date de fin du contrat, au format ISO 8601.
L'ID de référence externe pour le mode de paiement.
La langue associée au contrat.
Les paramètres régionaux associés au contrat.
Le nom du contrat.
Les conditions de paiement nettes du contrat, représentées par un entier.
La méthode de paiement utilisée pour le contrat.
Le numéro de bon de commande associé au contrat.
La valeur du contrat avant résiliation.
L'identifiant unique du contrat de renouvellement.
La date de renouvellement du contrat, au format ISO 8601.
Le nom de l'entreprise du vendeur.
L'adresse e-mail du vendeur.
Le prénom du vendeur.
Le nom de famille du vendeur.
Le numéro de téléphone du vendeur.
La date de début du contrat, au format ISO 8601.
La date de résiliation du contrat, au format ISO 8601.
Le montant total facturé dans le cadre du contrat.
Le montant total facturé dans le cadre du contrat avant impôts.
Le montant total des frais perçus dans le cadre du contrat.
Le montant total des taxes collectées dans le cadre du contrat.
La valeur totale du contrat.
Le montant total payé au titre du contrat.
La date et l'heure de la dernière mise à jour du contrat, au format ISO 8601.