> ## Documentation Index > Fetch the complete documentation index at: https://developers.hubspot.fr/docs/llms.txt > Use this file to discover all available pages before exploring further. # Create a payment link > Créez un nouveau lien de paiement dans votre compte HubSpot. Ce point de terminaison vous permet de spécifier divers attributs pour le lien de paiement, tels que les modes de paiement acceptés, la devise et les champs de formulaire supplémentaires. Le lien de paiement peut être configuré pour une utilisation unique et peut également collecter les adresses de livraison et de facturation. Cette opération nécessite un corps de requête JSON valide. Certaines valeurs par défaut seront appliquées si aucune valeur n'est fournie. > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/2026-09/commerce-payment-links-v2026-09.json POST /commerce/payment-links/2026-09/payment-links openapi: 3.0.1 info: title: Commerce Payment Links description: Basepom for all HubSpot Projects version: 2026-09 x-hubspot-product-tier-requirements: marketing: FREE sales: FREE service: FREE cms: FREE commerce: FREE crmHub: FREE dataHub: FREE servers: - url: https://api.hubapi.com security: [] tags: - name: Basic paths: /commerce/payment-links/2026-09/payment-links: post: tags: - Basic summary: Créer un lien de paiement description: >- Créez un nouveau lien de paiement dans votre compte HubSpot. Ce point de terminaison vous permet de spécifier divers attributs pour le lien de paiement, tels que les modes de paiement acceptés, la devise et les champs de formulaire supplémentaires. Le lien de paiement peut être configuré pour une utilisation unique et peut également collecter les adresses de livraison et de facturation. Cette opération nécessite un corps de requête JSON valide. Certaines valeurs par défaut seront appliquées si aucune valeur n'est fournie. operationId: post-/commerce/payment-links/2026-09/payment-links parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentLinkCreateRequest' required: true responses: '201': description: successful operation headers: Location: description: URL of the newly created resource style: simple explode: false schema: type: string content: application/json: schema: $ref: '#/components/schemas/PaymentLinkResponse' default: $ref: '#/components/responses/Error' description: '' security: [] components: schemas: PaymentLinkCreateRequest: required: - acceptedPaymentMethods - additionalFormFields - currencyCode - enableDefaultCheckoutFees - feeObjectIds - fees - includeEmailInSuccessRedirect - isOneTimeUseEnabled - lineItemObjectIds - lineItems - paymentLinkName - state - taxObjectIds - taxes type: object properties: acceptedPaymentMethods: type: array description: "Un ensemble de méthodes de paiement acceptées pour le lien de paiement. Les valeurs valides incluent «\_CREDIT_OR_DEBIT_CARD\_», «\_ACH\_», «\_SEPA\_», «\_BACS\_» et «\_PADS\_»." items: type: string enum: - CREDIT_OR_DEBIT_CARD - ACH - SEPA - BACS - PADS - AFFIRM - KLARNA additionalFormFields: type: array description: >- Un tableau d'objets PaymentLinkFormField représentant des champs de formulaire supplémentaires à inclure dans le lien de paiement. items: $ref: '#/components/schemas/PaymentLinkFormField' automatedSalesTaxEnabled: type: boolean description: Un booléen indiquant si la taxe de vente automatisée est activée. businessUnitId: type: string description: >- Chaîne représentant l'identifiant de l'unité commerciale associée au lien de paiement. collectFullBillingAddress: type: boolean description: >- Un booléen indiquant de collecter l'adresse de facturation complète lors du paiement. collectShippingAddress: type: boolean description: >- Un booléen indiquant si l'adresse de livraison doit être recueillie pendant le processus de paiement. createContractOnPurchase: type: boolean description: Un booléen indiquant s'il faut créer un contrat lors de l'achat. currencyCode: type: string description: Le code de devise du paiement, représenté sous forme de chaîne. dealConfigurations: $ref: '#/components/schemas/DealConfigurations' descriptionHtml: type: string description: Une chaîne contenant la description HTML du lien de paiement. discount: $ref: '#/components/schemas/DiscountRequest' discountCodeEnabled: type: boolean description: >- Un booléen indiquant si les codes de réduction sont activés pour le lien de paiement. discountObjectId: type: string description: >- Une chaîne représentant l'ID d'objet d'une réduction associée au lien de paiement. domainId: type: string description: >- L'ID de domaine associé au lien de paiement, représenté sous forme de chaîne de caractères. enableDefaultCheckoutFees: type: boolean description: >- Un booléen indiquant si les frais de paiement par défaut sont activés. expirationSettings: $ref: '#/components/schemas/ExpirationSettings' feeObjectIds: type: array description: >- Un tableau de chaînes de caractères représentant les identifiants des objets de frais associés au lien de paiement. items: type: string fees: type: array description: >- Un tableau d'objets FeeRequest, représentant les frais à appliquer au lien de paiement. items: $ref: '#/components/schemas/FeeRequest' includeEmailInSuccessRedirect: type: boolean description: >- Un booléen indiquant s'il faut inclure l'e-mail dans l'URL de redirection en cas de succès. isOneTimeUseEnabled: type: boolean description: >- Un booléen indiquant si le lien de paiement est activé pour une utilisation unique. lineItemObjectIds: type: array description: >- Un tableau d'ID d'objets de lignes de produit, associés au lien de paiement, chacun représenté sous forme de chaîne de caractères. items: type: string lineItems: type: array description: >- Un tableau de lignes de produit, qui peuvent être personnalisées, issues d'un produit ou clonées, telles que définies par leurs schémas respectifs. items: oneOf: - $ref: '#/components/schemas/LineItemCustomCreateRequest' - $ref: '#/components/schemas/LineItemFromProductCreateRequest' - $ref: '#/components/schemas/LineItemCloneCreateRequest' paymentLinkName: type: string description: Le nom du lien de paiement. Il s'agit d'une valeur de chaîne. state: type: string description: "L'état du lien de paiement, représenté sous forme de chaîne de caractères. Les valeurs valides sont «\_ON\_» et «\_OFF\_»." enum: - 'OFF' - 'ON' storePaymentMethodAtCheckout: type: boolean description: >- Un booléen indiquant s'il faut enregistrer le mode de paiement lors du paiement. successUrl: type: string description: >- Une chaîne qui définit l'URL vers laquelle rediriger après un paiement réussi. taxObjectIds: type: array description: >- Un tableau d'identifiants de chaînes représentant les objets fiscaux associés au lien de paiement. items: type: string taxes: type: array description: >- Un tableau d'objets TaxRequest, chacun représentant une taxe associée au lien de paiement. items: $ref: '#/components/schemas/TaxRequest' PaymentLinkResponse: required: - acceptedPaymentMethods - additionalFormFields - archived - automatedSalesTaxEnabled - checkoutFeeIds - collectFullBillingAddress - collectShippingAddress - completedPurchaseCount - createContractOnPurchase - currencyCode - discountCodeEnabled - discounts - fees - formGuid - id - includeEmailInSuccessRedirect - isOneTimeUseEnabled - lineItems - paymentLinkName - paymentLinkUrl - state - storePaymentMethodAtCheckout - taxes type: object properties: acceptedPaymentMethods: type: array description: "Un ensemble de méthodes de paiement acceptées pour le lien de paiement. Les valeurs valides incluent\_: «\_CREDIT_OR_DEBIT_CARD\_», «\_ACH\_», «\_SEPA\_», «\_BACS\_» et «\_PADS\_»." items: type: string enum: - CREDIT_OR_DEBIT_CARD - ACH - SEPA - BACS - PADS - AFFIRM - KLARNA additionalFormFields: type: array description: >- Un ensemble de champs de formulaire supplémentaires inclus dans le lien de paiement. items: $ref: '#/components/schemas/PaymentLinkFormField' archived: type: boolean description: Un booléen indiquant si le lien de paiement est archivé. archivedAt: type: string description: >- La date et l'heure d'archivage du lien de paiement, au format ISO 8601. format: date-time automatedSalesTaxEnabled: type: boolean description: >- Un booléen indiquant si la taxe de vente automatisée est activée pour le lien de paiement. businessUnitId: type: string description: >- L'ID de l'unité commerciale associée au lien de paiement, représenté sous forme de chaîne de caractères. checkoutFeeIds: type: array description: Un tableau d'ID de frais associés au lien de paiement. items: type: string collectFullBillingAddress: type: boolean description: >- Un booléen indiquant s'il faut collecter l'adresse de facturation complète lors du paiement. collectShippingAddress: type: boolean description: >- Un booléen indiquant s'il faut collecter l'adresse de livraison lors du paiement. completedPurchaseCount: type: integer description: Le nombre d'achats effectués via ce lien de paiement. format: int32 createContractOnPurchase: type: boolean description: Un booléen indiquant si un contrat doit être créé lors de l'achat. createdAt: type: string description: >- La date et l'heure de création du lien de paiement, au format ISO 8601. format: date-time currencyCode: type: string description: >- Le code de devise du lien de paiement, représenté sous forme de chaîne. dealConfigurations: $ref: '#/components/schemas/DealConfigurations' descriptionHtml: type: string description: >- La description HTML du lien de paiement, représentée sous forme de chaîne. discountCodeEnabled: type: boolean description: >- Un booléen indiquant si les codes de réduction sont activés pour le lien de paiement. discounts: type: array description: Un tableau d'objets en réduction associés au lien de paiement. items: $ref: '#/components/schemas/DiscountResponse' domainId: type: string description: >- L'ID de domaine associé au lien de paiement, représenté sous forme de chaîne de caractères. expirationSettings: $ref: '#/components/schemas/ExpirationSettings' fees: type: array description: Un tableau d'objets de frais associés au lien de paiement. items: $ref: '#/components/schemas/FeeResponse' formGuid: type: string description: >- Le GUID du formulaire associé au lien de paiement, représenté sous forme de chaîne de caractères. id: type: string description: >- L'identifiant unique du lien de paiement, représenté sous forme de chaîne de caractères. includeEmailInSuccessRedirect: type: boolean description: >- Un booléen indiquant s'il faut inclure l'e-mail dans l'URL de redirection en cas de succès. isOneTimeUseEnabled: type: boolean description: >- Un booléen indiquant si le lien de paiement est activé pour une utilisation unique. lineItems: type: array description: Un tableau de lignes de produit associées au lien de paiement. items: $ref: '#/components/schemas/LineItem' paymentLinkName: type: string description: >- Le nom du lien de paiement, représenté sous forme de chaîne de caractères. paymentLinkUrl: type: string description: >- L'URL du lien de paiement, représentée sous forme de chaîne de caractères. state: type: string description: "L'état actuel du lien de paiement, représenté sous forme de chaîne de caractères. Les valeurs valides sont «\_ON\_» et «\_OFF\_»." enum: - 'OFF' - 'ON' storePaymentMethodAtCheckout: type: boolean description: >- Un booléen indiquant s'il faut enregistrer le mode de paiement au moment du règlement. successUrl: type: string description: >- L'URL de redirection en cas de paiement réussi, représentée sous forme de chaîne de caractères. taxes: type: array description: Un tableau d'objets fiscaux associés au lien de paiement. items: $ref: '#/components/schemas/TaxResponse' updatedAt: type: string description: >- La date et l'heure de la dernière mise à jour du lien de paiement, au format ISO 8601. format: date-time PaymentLinkFormField: required: - isRequired - label - objectType - options - propertyName type: object properties: description: type: string description: >- Description du champ de formulaire, fournissant un contexte ou des instructions supplémentaires, représentée sous forme de chaîne de caractères. isRequired: type: boolean description: Un booléen indiquant si ce champ de formulaire doit être rempli. label: type: string description: >- L'étiquette du champ de formulaire, affichée aux utilisateurs, représentée sous forme de chaîne de caractères. objectType: type: string description: "Le type d'objet auquel ce champ de formulaire est associé, représenté sous forme de chaîne de caractères. Les valeurs valides incluent «\_CONTACT\_» et «\_COMPANY\_»." enum: - COMPANY - CONTACT options: type: array description: >- Un ensemble d'options disponibles pour ce champ de formulaire, chacune représentée comme un objet FormFieldOption. items: $ref: '#/components/schemas/FormFieldOption' propertyName: type: string description: >- Le nom de la propriété associée à ce champ de formulaire, représenté sous forme de chaîne de caractères. DealConfigurations: required: - createNewDealOnPurchase type: object properties: createNewDealOnPurchase: type: boolean description: >- Un booléen indiquant si une nouvelle transaction doit être créée dans HubSpot lors d'un achat. Champ obligatoire. pipelineStageId: type: string description: >- L'identifiant de l'étape du pipeline où la nouvelle transaction sera placée. Il s'agit d'une valeur de type chaîne de caractères. DiscountRequest: required: - label - value - valueType type: object properties: label: type: string description: >- Un libellé descriptif pour la remise. Il s'agit d'une chaîne de caractères. value: type: number description: La valeur numérique de la remise à appliquer. Il s'agit d'un nombre. valueType: type: string description: "Le type de valeur de remise, qui peut être «\_FIXE\_» ou «\_POURCENTAGE\_»." enum: - FIXED - PERCENT ExpirationSettings: type: object properties: expirationDate: type: string description: >- La date et l'heure d'expiration du lien de paiement, au format ISO 8601. format: date-time maxPurchases: type: integer description: >- Le nombre maximal d'achats autorisés pour ce lien de paiement. Il s'agit d'une valeur entière. format: int32 FeeRequest: required: - label - value - valueType type: object properties: label: type: string description: >- Un libellé descriptif pour les frais, représentée sous forme de chaîne. value: type: number description: >- La valeur numérique des frais. Il s'agit d'un nombre représentant soit un montant fixe, soit un pourcentage, selon le valueType. valueType: type: string description: "Le type de valeur des frais, indiquant s'il s'agit d'un montant fixe ou d'un pourcentage. Les valeurs valides incluent «\_FIXED\_» et «\_PERCENT\_»." enum: - FIXED - PERCENT LineItemCustomCreateRequest: title: CUSTOM required: - mode - name - pricing - quantity type: object properties: allowBuyerSelectedQuantity: type: boolean description: >- Un booléen spécifiant si l'acheteur peut sélectionner la quantité de la ligne de produit. billingCycleAnchorDate: type: string description: >- Une chaîne au format de date représentant la date d'ancrage du cycle de facturation. format: date billingStartDelayDays: type: integer description: >- Un entier indiquant le nombre de jours pour retarder le début de la facturation. format: int32 billingStartDelayMonths: type: integer description: >- Un entier indiquant le nombre de mois pour retarder le début de la facturation. format: int32 buyerSelectedQuantityMax: type: number description: >- Un nombre indiquant la quantité maximale que l'acheteur peut sélectionner. buyerSelectedQuantityMin: type: number description: >- Un nombre indiquant la quantité minimale que l'acheteur peut sélectionner. description: type: string description: Une chaîne fournissant une description de la ligne de produit. discount: type: number description: Un nombre représentant la remise appliquée à la ligne de produit. discountPercentage: type: number description: >- Un nombre indiquant le pourcentage de remise appliqué à la ligne de produit. externalId: type: string description: >- Une chaîne représentant un identifiant externe pour la ligne de produit. images: type: string description: >- Une chaîne contenant des URL ou des identifiants pour les images associées à la ligne de produit. isEditablePrice: type: boolean description: >- Un booléen indiquant si le prix de la ligne de produit est modifiable. isOptional: type: boolean description: Un booléen indiquant si la ligne de produit est facultative. lineItemCurrencyCode: type: string description: Une chaîne représentant le code de devise pour la ligne de produit. mode: type: string description: "Une chaîne qui indique le mode de la ligne de produit, défini sur «\_CUSTOM\_»." default: CUSTOM enum: - CUSTOM name: type: string description: Chaîne de caractères représentant le nom de la ligne de produit. positionOnQuote: type: integer description: Un entier indiquant la position de la ligne de produit sur un devis. format: int32 priceBookId: type: string description: >- Une chaîne de caractères qui identifie le catalogue de prix associé à la ligne de produit. pricing: $ref: '#/components/schemas/PricingFullUpdateRequest' productId: type: string description: >- Chaîne de caractères qui identifie le produit associé à l'élément de ligne. productType: type: string description: Une chaîne indiquant le type de produit pour la ligne de produit. quantity: type: number description: Un nombre indiquant la quantité de la ligne de produit. recurringBillingEndDate: type: string description: >- Une chaîne au format de date indiquant la date de fin de la facturation récurrente. format: date recurringBillingFrequency: type: string description: "Une chaîne spécifiant la fréquence de facturation récurrente. Les valeurs valides incluent «\_ANNUELLEMENT\_», «\_BIHEBDOMADAIREMENT\_», «\_MENSUELLEMENT\_», «\_TOUS LES CINQ ANS\_», «\_TOUS LES QUATRE ANS\_», «\_TOUS LES SIX MOIS\_», «\_TOUS LES TROIS ANS\_», «\_TOUS LES DEUX ANS\_», «\_TRIMESTRIELLEMENT\_» et «\_HEBDOMADAIREMENT\_»." enum: - ANNUALLY - BIWEEKLY - MONTHLY - PER_FIVE_YEARS - PER_FOUR_YEARS - PER_SIX_MONTHS - PER_THREE_YEARS - PER_TWO_YEARS - QUARTERLY - WEEKLY recurringBillingPeriod: type: string description: Une chaîne représentant la période de facturation récurrente. recurringBillingStartDate: type: string description: >- Une chaîne au format de date indiquant la date de début de la facturation récurrente. format: date richTextDescription: type: string description: >- Une chaîne contenant une description en texte enrichi de la ligne de produit. sku: type: string description: >- Une chaîne représentant l'unité de gestion des stocks (UGS) de la ligne de produit. taxCategory: type: string description: >- Une chaîne de caractères représentant la catégorie de taxe de la ligne de produit. taxRateGroupId: type: string description: >- L'ID du groupe de taux de taxe associé à la ligne de produit, sous forme de chaîne de caractères. variantId: type: string description: Une chaîne représentant l'identifiant de la variante du produit. x-hubspot-sub-type-impl: true LineItemFromProductCreateRequest: title: FROM_PRODUCT required: - allowBuyerSelectedQuantity - billingCycleAnchorDate - billingStartDelayDays - billingStartDelayMonths - buyerSelectedQuantityMax - buyerSelectedQuantityMin - description - discount - discountPercentage - externalId - images - isEditablePrice - isOptional - lineItemCurrencyCode - mode - name - positionOnQuote - priceBookId - pricing - productId - productType - quantity - recurringBillingEndDate - recurringBillingFrequency - recurringBillingPeriod - recurringBillingStartDate - richTextDescription - sku - taxCategory - taxRateGroupId - variantId type: object properties: allowBuyerSelectedQuantity: type: object properties: {} description: >- Un objet indiquant si l'acheteur peut sélectionner la quantité du produit. billingCycleAnchorDate: type: object properties: {} description: Un objet représentant la date d'ancrage du cycle de facturation. billingStartDelayDays: type: object properties: {} description: >- Un objet représentant le nombre de jours pour retarder le début de la facturation. billingStartDelayMonths: type: object properties: {} description: >- Un objet représentant le nombre de mois pour retarder le début de la facturation. buyerSelectedQuantityMax: type: object properties: {} description: >- Un objet représentant la quantité maximale que l'acheteur peut sélectionner. buyerSelectedQuantityMin: type: object properties: {} description: >- Un objet représentant la quantité minimale que l'acheteur peut sélectionner. description: type: object properties: {} description: >- Un objet représentant la description de l'article associé à la ligne de produit. discount: type: object properties: {} description: Un objet représentant toute remise appliquée à la ligne de produit. discountPercentage: type: object properties: {} description: >- Un objet représentant le pourcentage de remise appliqué à la ligne de produit. externalId: type: object properties: {} description: >- Un objet représentant un identifiant externe pour la ligne de produit. images: type: object properties: {} description: Un objet représentant les images associées au produit. isEditablePrice: type: object properties: {} description: Un objet indiquant si le prix de la ligne de produit est modifiable. isOptional: type: object properties: {} description: Un objet indiquant si la ligne de produit est facultative. lineItemCurrencyCode: type: object properties: {} description: Un objet représentant le code de devise pour la ligne de produit. mode: type: string description: "Une chaîne indiquant le mode de création de la ligne de produit. La valeur par défaut et la seule valeur valide est «\_FROM_PRODUCT\_»." default: FROM_PRODUCT enum: - FROM_PRODUCT name: type: object properties: {} description: >- Un objet représentant le nom du produit associé à la ligne de produit. positionOnQuote: type: object properties: {} description: >- Un objet représentant la position de la ligne de produit sur un devis. priceBookId: type: object properties: {} description: Un objet représentant l'ID du catalogue des prix associé au produit. pricing: type: object properties: {} description: >- Un objet représentant les détails de tarification de la ligne de produit. productId: type: string description: Une chaîne représentant l'identifiant unique du produit. productType: type: object properties: {} description: Un objet représentant le type de produit. quantity: type: object properties: {} description: >- Un objet représentant la quantité du produit à inclure dans la ligne de produit. recurringBillingEndDate: type: object properties: {} description: >- Un objet représentant la date de fin du cycle de facturation récurrente. recurringBillingFrequency: type: object properties: {} description: >- Un objet représentant la fréquence de la facturation récurrente pour la ligne de produit. recurringBillingPeriod: type: object properties: {} description: Un objet représentant la période du cycle de facturation récurrente. recurringBillingStartDate: type: object properties: {} description: >- Un objet représentant la date de début du cycle de facturation récurrente. richTextDescription: type: object properties: {} description: >- Un objet représentant une description en texte enrichi du produit associé à la ligne de produit. sku: type: object properties: {} description: >- Un objet représentant l'unité de gestion des stocks (UGS) du produit. taxCategory: type: object properties: {} description: Un objet représentant la catégorie de taxe du produit. taxRateGroupId: type: object properties: {} description: >- Un objet représentant l'ID du groupe de taux de taxe pour le produit. variantId: type: object properties: {} description: Un objet représentant l'ID de la variante du produit. x-hubspot-sub-type-impl: true LineItemCloneCreateRequest: title: CLONE required: - allowBuyerSelectedQuantity - billingCycleAnchorDate - billingStartDelayDays - billingStartDelayMonths - buyerSelectedQuantityMax - buyerSelectedQuantityMin - description - discount - discountPercentage - externalId - images - isEditablePrice - isOptional - lineItemCurrencyCode - mode - name - positionOnQuote - priceBookId - pricing - productType - quantity - recurringBillingEndDate - recurringBillingFrequency - recurringBillingPeriod - recurringBillingStartDate - richTextDescription - sku - sourceLineItemId - taxCategory - taxRateGroupId - variantId type: object properties: allowBuyerSelectedQuantity: type: object properties: {} description: >- Un objet indiquant si l'acheteur peut sélectionner la quantité de la ligne de produit. billingCycleAnchorDate: type: object properties: {} description: >- Un objet représentant la date d'ancrage pour le cycle de facturation de la ligne de produit. billingStartDelayDays: type: object properties: {} description: >- Un objet représentant le nombre de jours pour retarder le début de la facturation de la ligne de produit. billingStartDelayMonths: type: object properties: {} description: >- Un objet représentant le nombre de mois pour retarder le début de la facturation de la ligne de produit. buyerSelectedQuantityMax: type: object properties: {} description: >- Un objet représentant la quantité maximale que l'acheteur peut sélectionner pour la ligne de produit. buyerSelectedQuantityMin: type: object properties: {} description: >- Un objet représentant la quantité minimale que l'acheteur peut sélectionner pour la ligne de produit. description: type: object properties: {} description: Un objet représentant la description de la ligne de produit. discount: type: object properties: {} description: Un objet représentant la remise appliquée à la ligne de produit. discountPercentage: type: object properties: {} description: >- Un objet représentant le pourcentage de remise appliqué à la ligne de produit. externalId: type: object properties: {} description: >- Un objet représentant un identifiant externe pour la ligne de produit. images: type: object properties: {} description: Un objet représentant les images associées à la ligne de produit. isEditablePrice: type: object properties: {} description: Un objet indiquant si le prix de la ligne de produit est modifiable. isOptional: type: object properties: {} description: Un objet indiquant si la ligne de produit est facultative. lineItemCurrencyCode: type: object properties: {} description: Un objet représentant le code de devise pour la ligne de produit. mode: type: string description: "Une chaîne indiquant le mode de création de la ligne de produit, qui est «\_CLONE\_» pour ce composant." default: CLONE enum: - CLONE name: type: object properties: {} description: Un objet représentant le nom de la ligne de produit. positionOnQuote: type: object properties: {} description: >- Un objet représentant la position de la ligne de produit sur le devis. priceBookId: type: object properties: {} description: >- Un objet représentant l'ID du catalogue des prix associé à la ligne de produit. pricing: type: object properties: {} description: >- Un objet représentant les détails de tarification de la ligne de produit. productType: type: object properties: {} description: Un objet représentant le type de produit pour la ligne de produit. quantity: type: object properties: {} description: Un objet représentant la quantité de la ligne de produit. recurringBillingEndDate: type: object properties: {} description: >- Un objet représentant la date de fin de la facturation récurrente pour la ligne de produit. recurringBillingFrequency: type: object properties: {} description: >- Un objet représentant la fréquence de la facturation récurrente pour la ligne de produit. recurringBillingPeriod: type: object properties: {} description: >- Un objet représentant la période de facturation pour la facturation récurrente de la ligne de produit. recurringBillingStartDate: type: object properties: {} description: >- Un objet représentant la date de début de la facturation récurrente pour la ligne de produit. richTextDescription: type: object properties: {} description: >- Un objet représentant la description en texte enrichi de la ligne de produit. sku: type: object properties: {} description: >- Un objet représentant l'unité de gestion des stocks (UGS) de la ligne de produit. sourceLineItemId: type: string description: Chaîne représentant l'ID de la ligne de produit source à cloner. taxCategory: type: object properties: {} description: Un objet représentant la catégorie de taxe de la ligne de produit. taxRateGroupId: type: object properties: {} description: >- Un objet représentant l'ID du groupe de taux de taxe pour la ligne de produit. variantId: type: object properties: {} description: Un objet représentant l'ID de la variante de la ligne de produit. x-hubspot-sub-type-impl: true TaxRequest: required: - label - value - valueType type: object properties: label: type: string description: >- Une chaîne de caractères qui fournit une étiquette ou une description pour la taxe, utilisée à des fins d'identification ou d'affichage. value: type: number description: >- La valeur numérique de la taxe. Elle représente le montant ou le pourcentage, selon le valueType. valueType: type: string description: "Une chaîne indiquant le type de valeur de taxe. Les valeurs valides sont «\_FIXED\_» pour un montant fixe et «\_PERCENT\_» pour une taxe basée sur un pourcentage." enum: - FIXED - PERCENT DiscountResponse: required: - id type: object properties: archived: type: boolean description: Indique si cette remise a été archivée. Une valeur booléenne. archivedAt: type: string description: La date et l'heure d'archivage de cette remise, au format ISO 8601. format: date-time createdAt: type: string description: La date et l'heure de création de cette remise, au format ISO 8601. format: date-time id: type: string description: L'identifiant unique de cette remise. label: type: string description: Un libellé descriptif pour la remise. updatedAt: type: string description: >- La date et l'heure de la dernière mise à jour de cette remise, au format ISO 8601. format: date-time value: type: number description: La valeur numérique de la remise. valueType: type: string description: "Le type de valeur de remise, qui peut être «\_FIXE\_» ou «\_POURCENTAGE\_»." enum: - FIXED - PERCENT FeeResponse: required: - id type: object properties: archived: type: boolean description: Indique si ces frais ont été archivés. Une valeur booléenne. archivedAt: type: string description: La date et l'heure d'archivage de ces frais, au format ISO 8601. format: date-time createdAt: type: string description: La date et l'heure de création de ces frais, au format ISO 8601. format: date-time id: type: string description: L'identifiant unique de ces frais. label: type: string description: Une étiquette descriptive pour les frais. updatedAt: type: string description: >- La date et l'heure de la dernière mise à jour de ces frais, au format ISO 8601. format: date-time value: type: number description: >- La valeur monétaire des frais. Un nombre représentant le montant des frais. valueType: type: string description: "Le type de valeur pour les frais, qui peut être «\_FIXE\_» ou «\_POURCENTAGE\_»." enum: - FIXED - PERCENT LineItem: required: - id - name - pricing - quantity type: object properties: acv: type: number description: La valeur annuelle du contrat pour la ligne de produit. allowBuyerSelectedQuantity: type: boolean description: >- Indique si l'acheteur peut sélectionner la quantité de la ligne de produit. amount: type: number description: >- Le montant total de la ligne de produit, calculé comme le prix multiplié par la quantité. archived: type: boolean description: Indique si la ligne de produit est archivée. archivedAt: type: string description: >- La date et l'heure d'archivage de la ligne de produit, au format ISO 8601. format: date-time arr: type: number description: Le revenu annuel récurrent pour la ligne de produit. billingCycleAnchorDate: type: string description: >- La date d'ancrage du cycle de facturation, au format de date ISO 8601. format: date billingPeriodEndDate: type: string description: >- La date de fin de la période de facturation, au format de date ISO 8601. format: date billingPeriodStartDate: type: string description: >- La date de début de la période de facturation, au format de date ISO 8601. format: date billingStartDelayDays: type: integer description: Le nombre de jours pour retarder le début de la facturation. format: int32 billingStartDelayMonths: type: integer description: Le nombre de mois pour retarder le début de la facturation. format: int32 billingStartDelayType: type: string description: "Le type de délai pour le début de la facturation. Les valeurs valides incluent «\_HS_BILLING_START_DELAY_DAYS\_», «\_HS_BILLING_START_DELAY_MONTHS\_» et «\_HS_RECURRING_BILLING_START_DATE\_»." enum: - HS_BILLING_START_DELAY_DAYS - HS_BILLING_START_DELAY_MONTHS - HS_RECURRING_BILLING_START_DATE buyerSelectedQuantityMax: type: number description: >- La quantité maximale que l'acheteur peut sélectionner pour la ligne de produit. buyerSelectedQuantityMin: type: number description: >- La quantité minimale que l'acheteur peut sélectionner pour la ligne de produit. createdAt: type: string description: >- La date et l'heure de création de la ligne de produit, au format ISO 8601. format: date-time description: type: string description: Une description textuelle de la ligne de produit. discount: type: number description: La remise appliquée à la ligne de produit. discountPercentage: type: number description: Le pourcentage de remise appliqué à la ligne de produit. effectiveUnitPrice: type: number description: Le prix unitaire effectif après remises. externalId: type: string description: >- Un identifiant externe pour la ligne de produit, utilisé à des fins d'intégration. id: type: string description: L'identifiant unique de la ligne de produit. images: type: string description: >- Une URL ou un identifiant pour les images associées à la ligne de produit. isEditablePrice: type: boolean description: Indique si le prix de la ligne de produit est modifiable. isOptional: type: boolean description: Indique si la ligne de produit est facultative. isParent: type: boolean description: Indique si cette ligne de produit est une ligne de produit parente. lineItemCurrencyCode: type: string description: Le code de devise de la ligne de produit, au format ISO 4217. mrr: type: number description: Le revenu récurrent mensuel pour la ligne de produit. name: type: string description: Le nom de la ligne de produit. parentLineItemId: type: string description: L'identifiant unique de la ligne de produit parente. positionOnQuote: type: integer description: >- La position de la ligne de produit sur un devis, exprimée par un nombre entier. format: int32 postTaxAmount: type: number description: Le montant après application des taxes. preDiscountAmount: type: number description: Le montant avant l'application de toute remise. price: type: number description: Le prix d'une seule unité de la ligne de produit. priceBookId: type: string description: L'identifiant du catalogue des prix associé à la ligne de produit. pricing: $ref: '#/components/schemas/Pricing' pricingModel: type: string description: "Le modèle de tarification utilisé pour la ligne de produit. Les valeurs valides incluent «\_FORFAITAIRE\_», «\_DÉGRESSIF\_», «\_PAR PALIERS\_» ou «\_AU VOLUME\_»." enum: - FLAT - GRADUATED - STAIRSTEP - VOLUME productId: type: string description: L'identifiant du produit associé à la ligne de produit. productType: type: string description: Le type de produit pour la ligne de produit. quantity: type: number description: La quantité de la ligne de produit, représentée par un nombre. rampKey: type: string description: >- Une clé utilisée pour identifier le calendrier d'évolution en puissance de la ligne de produit. recurringBillingDayOfMonth: type: integer description: Le jour du mois où la facturation récurrente a lieu. format: int32 recurringBillingEndDate: type: string description: >- La date de fin de la facturation récurrente, au format de date ISO 8601. format: date recurringBillingFrequency: type: string description: "La fréquence de facturation récurrente pour la ligne de produit. Les valeurs valides incluent «\_ANNUELLEMENT\_», «\_BIHEBDOMADAIREMENT\_», «\_MENSUELLEMENT\_», «\_TOUS LES CINQ ANS\_», «\_TOUS LES QUATRE ANS\_», «\_TOUS LES SIX MOIS\_», «\_TOUS LES TROIS ANS\_», «\_TOUS LES DEUX ANS\_», «\_TRIMESTRIELLEMENT\_» et «\_HEBDOMADAIREMENT\_»." enum: - ANNUALLY - BIWEEKLY - MONTHLY - PER_FIVE_YEARS - PER_FOUR_YEARS - PER_SIX_MONTHS - PER_THREE_YEARS - PER_TWO_YEARS - QUARTERLY - WEEKLY recurringBillingNumberOfPayments: type: integer description: Le nombre de paiements pour le cycle de facturation récurrente. format: int32 recurringBillingPeriod: type: string description: La période de facturation récurrente. recurringBillingStartDate: type: string description: >- La date de début de la facturation récurrente, au format de date ISO 8601. format: date recurringBillingTerms: type: string description: "Les modalités de facturation récurrente. Les valeurs valides incluent «\_AUTOMATICALLY_RENEW\_» et «\_FIXED\_»." enum: - AUTOMATICALLY_RENEW - FIXED richTextDescription: type: string description: Description au format texte enrichi de la ligne de produit. sku: type: string description: >- L'identifiant de l'unité de gestion des stocks (UGS) pour la ligne de produit. tax: type: number description: Le montant de la taxe appliquée à la ligne de produit. taxAmount: type: number description: Le montant total de la taxe pour cette ligne de produit. taxCategory: type: string description: La catégorie de taxe applicable à cette ligne de produit. taxRateGroupId: type: string description: L'identifiant unique du groupe de taux de taxe. tcv: type: number description: La valeur totale du contrat pour la ligne de produit. termInMonths: type: integer description: La durée de la ligne de produit en mois. format: int32 tierAmount: type: number description: Le montant échelonné applicable à la ligne de produit. totalDiscount: type: number description: Le montant total de la remise appliquée à la ligne de produit. updatedAt: type: string description: >- La date et l'heure de la dernière mise à jour de la ligne de produit, au format ISO 8601. format: date-time variantId: type: string description: >- L'identifiant de la variante de produit associée à la ligne de produit. TaxResponse: required: - id type: object properties: archived: type: boolean description: Indique si cette entrée de taxe est archivée. Une valeur booléenne. archivedAt: type: string description: >- La date et l'heure d'archivage de cette entrée fiscale, au format ISO 8601. format: date-time createdAt: type: string description: >- La date et l'heure de création de cette entrée fiscale, au format ISO 8601. format: date-time id: type: string description: L'identifiant unique de cette entrée de taxe. label: type: string description: Un libellé descriptif pour cette entrée de taxe. updatedAt: type: string description: >- La date et l'heure de la dernière mise à jour de cette entrée fiscale, au format ISO 8601. format: date-time value: type: number description: La valeur numérique de la taxe. valueType: type: string description: "Le type de valeur de la taxe, qui peut être «\_FIXE\_» ou «\_POURCENTAGE\_»." enum: - FIXED - PERCENT Error: required: - category - correlationId - message type: object properties: category: type: string description: La catégorie d'erreur context: type: object additionalProperties: type: array items: type: string description: Contexte concernant la condition d'erreur example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- Un identifiant unique pour la demande. Incluez cette valeur dans tous les rapports d'erreurs ou tickets d'assistance format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: informations supplémentaires à propos de l'erreur items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: >- Une carte des noms de liens vers les URI associés contenant de la documentation sur l'erreur ou les mesures correctives recommandées message: type: string description: >- Un message lisible par la personne décrivant l'erreur ainsi que les mesures correctives possibles, le cas échéant example: An error occurred subCategory: type: string description: >- Une catégorie spécifique qui contient des détails plus précis sur l'erreur description: >- Représente une réponse d'erreur renvoyée par l'API lorsqu'une opération échoue. Ce composant est utilisé dans divers points de terminaison pour fournir des informations détaillées sur l'erreur rencontrée. example: message: Invalid input (details will vary based on the error) correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf category: VALIDATION_ERROR links: knowledge-base: https://www.hubspot.com/products/service/knowledge-base FormFieldOption: required: - label - value type: object properties: description: type: string description: >- Une chaîne fournissant des informations ou un contexte supplémentaires sur l'option du champ de formulaire. label: type: string description: >- Une chaîne représentant le nom d'affichage de l'option du champ de formulaire. value: type: string description: >- Une chaîne représentant la valeur sous-jacente associée à l'option du champ de formulaire. PricingFullUpdateRequest: required: - prices - pricingModel type: object properties: prices: type: array description: >- Un tableau d'objets PriceUpdateEntry, chacun spécifiant les détails du prix tels que le code de devise et le montant du prix pour différentes quantités. items: $ref: '#/components/schemas/PriceUpdateEntry' pricingModel: type: string description: "Le modèle de tarification appliqué à la ligne de produit. Les valeurs valides incluent «\_FLAT\_», «\_GRADUATED\_», «\_STAIRSTEP\_», et «\_VOLUME\_»." enum: - FLAT - GRADUATED - STAIRSTEP - VOLUME Pricing: required: - prices - pricingModel type: object properties: prices: type: array description: >- Un tableau d'entrées de prix, chacune détaillant un point de prix spécifique au sein du modèle de tarification. items: $ref: '#/components/schemas/PriceEntry' pricingModel: type: string description: "Le type de modèle de tarification appliqué. Les valeurs valides incluent «\_FORFAITAIRE\_», «\_DÉGRESSIF\_», «\_PAR PALIERS\_» ou «\_AU VOLUME\_»." enum: - FLAT - GRADUATED - STAIRSTEP - VOLUME ErrorDetail: required: - message type: object properties: code: type: string description: Le code du statut associé au détail de l'erreur context: type: object additionalProperties: type: array items: type: string description: Contexte concernant la condition d'erreur example: '{missingScopes=[scope1, scope2]}' in: type: string description: Le nom du champ ou du paramètre dans lequel l'erreur a été trouvée. message: type: string description: >- Un message lisible par la personne décrivant l'erreur ainsi que les mesures correctives possibles, le cas échéant subCategory: type: string description: >- Une catégorie spécifique qui contient des détails plus précis sur l'erreur description: >- Représente des informations détaillées sur une erreur survenue dans l'API. Ce composant est utilisé pour fournir un contexte et des spécificités supplémentaires sur les erreurs, généralement dans le cadre d'une réponse d'erreur. PriceUpdateEntry: required: - currencyCode - price type: object properties: currencyCode: type: string description: >- Le code de la devise dans laquelle le prix est spécifié, représenté sous forme de chaîne de caractères. maxQuantity: type: integer description: >- La quantité maximale pour laquelle ce prix est applicable, représentée sous forme de chaîne. format: int32 price: type: object properties: {} description: >- Un objet représentant les détails du prix. La structure spécifique de cet objet n'est pas détaillée dans la spécification. PriceEntry: required: - currencyCode - price type: object properties: currencyCode: type: string description: Le code de devise du prix, représenté sous forme de chaîne. maxQuantity: type: integer description: >- La quantité maximale pour laquelle ce prix est applicable, représentée sous forme de chaîne. format: int32 price: type: number description: Le prix de l'article, représenté par un nombre. responses: Error: description: An error occurred. content: '*/*': schema: $ref: '#/components/schemas/Error' ````