> ## 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. # Retrieve payment links > Récupérer une liste de liens de paiement depuis votre compte HubSpot. Ce point de terminaison vous permet de filtrer et de trier les liens de paiement en fonction de divers critères, tels que les horodatages de création et de mise à jour. Il prend en charge la pagination et peut inclure les liens de paiement archivés si spécifié. > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/2026-09/commerce-payment-links-v2026-09.json GET /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: get: tags: - Basic summary: Récupérer tous les liens de paiement description: >- Récupérer une liste de liens de paiement depuis votre compte HubSpot. Ce point de terminaison vous permet de filtrer et de trier les liens de paiement en fonction de divers critères, tels que les horodatages de création et de mise à jour. Il prend en charge la pagination et peut inclure les liens de paiement archivés si spécifié. operationId: get-/commerce/payment-links/2026-09/payment-links parameters: - name: after in: query description: >- Le jeton de curseur de pagination de la dernière ressource lue avec succès sera renvoyé en tant que propriété JSON `paging.next.after` d'une réponse paginée contenant plus de résultats. required: false style: form explode: true schema: type: string - name: archived in: query description: S'il faut renvoyer uniquement les résultats qui ont été archivés. required: false style: form explode: true schema: type: boolean default: false - name: createdAfter in: query description: >- Filtrer les résultats pour inclure uniquement ceux créés après l'horodatage spécifié. required: false style: form explode: true schema: type: integer format: int64 - name: createdAt in: query description: Filtrer les résultats par l'horodatage de création exact. required: false style: form explode: true schema: type: integer format: int64 - name: createdBefore in: query description: >- Filtrer les résultats pour inclure uniquement ceux créés avant l'horodatage spécifié. required: false style: form explode: true schema: type: integer format: int64 - name: limit in: query description: Le nombre maximum de résultats à afficher par page. required: false style: form explode: true schema: type: integer format: int32 default: 20 - name: sort in: query description: Spécifie l'ordre dans lequel les résultats sont renvoyés. required: false style: form explode: true schema: type: string - name: updatedAfter in: query description: >- Filtrer les résultats pour inclure uniquement ceux mis à jour après l'horodatage spécifié. required: false style: form explode: true schema: type: integer format: int64 - name: updatedAt in: query description: Filtrer les résultats par l'horodatage exact de la mise à jour. required: false style: form explode: true schema: type: integer format: int64 - name: updatedBefore in: query description: >- Filtrer les résultats pour inclure uniquement ceux mis à jour avant l'horodatage spécifié. required: false style: form explode: true schema: type: integer format: int64 responses: '200': description: successful operation content: application/json: schema: $ref: >- #/components/schemas/CollectionResponsePaymentLinkResponseForwardPaging default: $ref: '#/components/responses/Error' description: '' security: [] components: schemas: CollectionResponsePaymentLinkResponseForwardPaging: required: - results type: object properties: paging: $ref: '#/components/schemas/ForwardPaging' results: type: array description: >- Un tableau d'objets PaymentLinkResponse, chacun représentant un lien de paiement avec ses détails associés. items: $ref: '#/components/schemas/PaymentLinkResponse' ForwardPaging: type: object properties: next: $ref: '#/components/schemas/NextPage' description: "Informations de pagination pour une pagination unidirectionnelle. Contient la référence de la page suivante lorsque d'autres résultats sont disponibles\_; omis ou vide sur la dernière page." 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 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 NextPage: required: - after type: object properties: after: type: string description: >- Un jeton de chaîne qui indique la position après le dernier élément de la page actuelle, utilisé pour récupérer la page de résultats suivante. link: type: string description: >- Une URL de chaîne qui fournit un lien direct vers la page de résultats suivante. description: >- Specifies the paging information needed to retrieve the next set of results in a paginated API response 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. 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 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 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 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. 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. 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 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' ````