Clients
Créez et gérez des profils clients réutilisables.
Un client est un profil réutilisable, identifié par son e-mail ou son téléphone.
Marketplaces : agir pour le compte d'un sous-compte
Une plateforme peut gérer les clients d'un sous-compte connecté en envoyant un en-tête X-Sync
avec sa propre clé (capacité customers requise). Consultez Sous-comptes
pour les règles et les cas d'erreur.
Endpoints
| Méthode | Chemin | Description |
|---|---|---|
POST | /customers | Créer |
GET | /customers/{id} | Récupérer |
GET | /customers | Lister |
PUT | /customers/{id} | Modifier |
DELETE | /customers/{id} | Supprimer |
POST | /customers/{id}/block | Bloquer |
POST | /customers/{id}/unblock | Débloquer |
POST | /customers/{id}/activate | Activer |
POST | /customers/{id}/deactivate | Désactiver |
GET | /customers/{id}/tax_ids | Lister les identifiants fiscaux (live uniquement) |
POST | /customers/{id}/tax_ids | Ajouter un identifiant fiscal (live uniquement) |
DELETE | /customers/{id}/tax_ids/{tax_id} | Retirer un identifiant fiscal (live uniquement) |
L'objet Customer
Un champ sans valeur est absent de l'objet au lieu d'être envoyé à null : lisez chaque champ
comme facultatif. metadata fait exception : c'est toujours un objet, {} quand il est vide.
idstringfacultatifIdentifiant unique :
cus_ suivi de 24 caractères, cus_test_ en sandbox.typeenumfacultatifindividual ou business.namestringfacultatifNom complet, ou raison sociale pour une entreprise.
emailstringfacultatifAdresse e-mail.
phonestringfacultatifNuméro de téléphone.
phone_countrystringfacultatifCode pays à deux lettres dans lequel le numéro a été lu.
descriptionstringfacultatifVotre description du client.
notesstringfacultatifVos notes.
currencystringfacultatifDevise préférée, ISO 4217.
statusenumfacultatifactive, inactive, blocked.blockedbooleanfacultatiftrue après POST /customers/{id}/block, jusqu'à ce que vous débloquiez le client.block_reasonstringfacultatifLa
reason envoyée avec le blocage. Absent quand le client n'est pas bloqué.blocked_atdatetimefacultatifDate du blocage du client. Absent quand il n'est pas bloqué.
customer_groupstringfacultatifLa chaîne de groupe que vous avez définie.
tagsstring[]facultatifVos étiquettes,
[] sans étiquette.preferred_currenciesstring[]facultatifCodes ISO 4217,
[] sans préférence.preferred_localesstring[]facultatifLangues comme
fr, [] sans préférence.metadataobjectfacultatifDonnées libres,
{} quand elles sont vides.addressobjectfacultatifL'adresse de livraison principale :
address_line1, address_line2, city, state, postal_code, country.billingobjectfacultatifL'adresse de facturation principale, mêmes champs.
first_namestringfacultatifParticuliers uniquement. En lecture seule via l'API, qui le refuse en écriture.
last_namestringfacultatifParticuliers uniquement. En lecture seule via l'API, comme ci-dessus.
date_of_birthdatefacultatifParticuliers uniquement,
YYYY-MM-DD.genderenumfacultatifParticuliers uniquement :
male, female ou other.business_namestringfacultatifEntreprises uniquement.
business_typestringfacultatifEntreprises uniquement.
business_registration_numberstringfacultatifEntreprises uniquement.
tax_idstringfacultatifEntreprises uniquement. Les identifiants fiscaux vérifiés par Tax se trouvent sous
/customers/{id}/tax_ids.tax_exemptenumfacultatifEntreprises uniquement :
none (par défaut) ou exempt, défini depuis le Dashboard.legal_representative_namestringfacultatifEntreprises uniquement.
legal_representative_titlestringfacultatifEntreprises uniquement.
sandboxbooleanfacultatiftrue pour un client de la sandbox.created_atdatetimefacultatifDate de création, ISO 8601.
updated_atdatetimefacultatifDate de la dernière modification, ISO 8601.