Résumé ◀▼
Vous pouvez connecter des flux d’actions à Recurly afin d’automatiser la gestion des comptes clients et des abonnements. Ces actions comprennent la création, la mise à jour et la recherche de comptes et d’abonnements, ainsi que la résiliation d’abonnements et la récupération des détails des factures ou des transactions. Utilisez un compte de service dédié pour les connexions et fournissez les identifiants de l’API Recurly. Cette intégration permet de rationaliser les workflows de facturation et d’abonnement au sein de vos processus d’assistance.
Connexion de Recurly au générateur d’actions
Avant de pouvoir inclure des actions externes dans vos workflows d’actions, vous devez connecter le créateur d’actions au système externe.
- Toutes les actions externes effectuées par un workflow d’actions sont attribuées à l’utilisateur qui a connecté le système externe. Il est donc recommandé d’utiliser un compte de service dédié plutôt que des identifiants personnels quand vous vous connectez à chaque système externe.
- Toutes les intégrations nécessitent des autorisations obligatoires. Cependant, il est important d’examiner et de valider les autorisations avant de valider l’accès au système externe.
- Si vous gérez les identifiants pour les outils basés sur des clés API, comme OpenAI, nous vous conseillons de stocker les clés dans un gestionnaire d’identifiants ou un coffre-fort sécurisé.
Pour trouver votre domaine Recurly et votre clé API
- Sous-domaine Recurly : la partie « sous-domaine » de votre URL Recurly (par exemple, « yourcompany » dans yourcompany.recurly.com).
- Clé API : votre clé API privée Recurly, disponible dans Recurly sous Intégrations > Identifiants API > Clé API privée.
Consultez la documentation Recurly pour plus d’informations.
- Dans le Centre d’administration, cliquez sur Applications et intégrations (
) dans la barre latérale, puis sélectionnez Actions > Workflows d’actions. - Créez ou modifiez un workflow d’actions.
- Ouvrez la barre latérale.
- Sous Actions externes, cliquez sur Recurly.
- Cliquez sur Connexion.
- Suivez les invites de Recurly pour saisir votre clé API Recurly et finaliser la connexion.Important : toutes les actions externes effectuées par un workflow d’actions sont attribuées à l’utilisateur qui a connecté le système externe. Il est donc recommandé d’utiliser un compte de service dédié plutôt que des identifiants personnels quand vous vous connectez à chaque système externe.
Une fois que vous vous êtes connecté au système, vous verrez un indicateur de connexion et des détails sur l’instance à laquelle vous êtes connecté, ainsi que les actions disponibles pour Recurly.
Utilisation des actions Recurly dans les flux d’actions
Création d’un compte
Utilisez l’action Créer un compte pour créer un compte client dans Recurly.
Cette action a les entrées et les sorties suivantes :
| Variables | |
|---|---|
| Entrées | Obligatoire : Code du compteLe code du compte est un identifiant unique composé de 50 caractères au maximum. Utilisez un ID d’utilisateur ou d’organisation Zendesk pour faciliter les recoupements. Facultatives : Exemption fiscale peut être définie sur Oui ou Non. |
| Sortie | Détails du compte, notamment id, code, email, state, created_at et hosted_login_token. |
Mise à jour d’un compte
Utilisez l’action Mettre à jour un compte pour modifier un compte client dans Recurly.
Cette action a les entrées et les sorties suivantes :
| Variables | |
|---|---|
| Entrées | Obligatoire : Code du compteCode du compte peut être soit le code du compte, soit l’UUID. Facultatives : Fournissez uniquement des valeurs pour les champs que vous voulez mettre à jour. Les valeurs existantes pour les champs que vous ne spécifiez pas resteront inchangées. |
| Sortie | Les détails du compte, notamment id, code, state et updated_at timestamp. |
Recherche d’un compte
Utilisez l’action Rechercher un compte pour récupérer les informations du compte par code de compte ou UUID. Utilisez cette action pour récupérer des informations complètes sur le compte d’un client, notamment l’état de son abonnement et les détails de facturation.
Cette action a les entrées et les sorties suivantes :
| Variables | |
|---|---|
| Entrées | Obligatoire : Code du compteCode du compte peut être soit le code du compte, soit l’UUID. |
| Sortie | Informations du compte, notamment id, code, email, first_name, last_name, company, state, balance, has_active_subscription, has_past_due_invoice, created_at et updated_at. |
Création d’un abonnement
Utilisez l’action Créer un abonnement pour créer un abonnement pour un compte Recurly.
Cette action a les entrées et les sorties suivantes :
| Variables | |
|---|---|
| Entrées | Obligatoires : Code du compte, Édition, Devise, Méthode de collectionFacultatives : Prenez en compte ce qui suit lorsque vous utilisez l’action Créer un abonnement :
|
| Sortie | Les informations d’abonnement incluent uuid, account_code, account_email, plan_code, plan_name, state, quantity, currency, current_period_started_at, current_period_ends_at, trial_ends_at, activated_at et created_at. |
Mise à jour d’un abonnement
Utilisez l’action Mettre à jour un abonnement pour modifier l’édition d’un abonnement existant, la quantité ou le calendrier.
Cette action a les entrées et les sorties suivantes :
| Variables | |
|---|---|
| Entrées | Obligatoire : UIID d'abonnementFacultatives : Le champ Nouvelle édition se remplit dynamiquement avec les éditions d’abonnement disponibles. Le champ Quand appliquer détermine si les modifications prennent effet immédiatement (Maintenant) ou lors du prochain cycle de facturation (Au renouvellement). Fournissez uniquement des valeurs pour les champs que vous voulez mettre à jour. |
| Sortie | Les détails d’abonnement, notamment uuid, state, plan_code, plan_name, quantity et updated_at timestamp. |
Annulation d’un abonnement
Utilisez l’action Annuler un abonnement pour annuler un abonnement actif à la fin de sa durée ou immédiatement.
Cette action a les entrées et les sorties suivantes :
| Variables | |
|---|---|
| Entrées | Obligatoire : UUID d'abonnementFacultatives : L’option Quand annuler votre abonnement détermine le moment de l’annulation : « À la fin du contrat » (conseillé) l’annule à la fin de tous les cycles de facturation, tandis que « Au prochain cycle de facturation » l’annule à la prochaine date de facturation. Choisissez l’option qui répond le mieux à votre politique d’entreprise. |
| Sortie | Informations d’abonnement, notamment uuid, state, canceled_at et expires_at timestamps. |
Recherche d’un abonnement
Utilisez l’action Rechercher un abonnement pour récupérer des informations d’abonnement détaillées par UUID. Utilisez cette action pour récupérer des informations complètes sur l’abonnement, notamment les périodes de facturation, les tarifs et le statut de résiliation. Le résultat comprend à la fois l’état actuel et l’historique des horodatages.
Cette action a les entrées et les sorties suivantes :
| Variables | |
|---|---|
| Entrées | Obligatoire : UUID d'abonnement
|
| Sortie | Les informations d’abonnement incluent uuid, account_code, account_email, plan_code, plan_name, plan_interval_unit, plan_interval_length, state, quantity, currency, unit_amount, subtotal, current_period_started_at, current_period_ends_at, trial_ends_at, activated_at, canceled_at et expires_at. |
Recherche d’une facture
Utilisez l’action Rechercher une facture pour récupérer les détails d’une facture à partir de son numéro ou de son UUID. La sortie comprend « pdf_url », qui fournit un lien direct pour télécharger la facture au format PDF.
Cette action a les entrées et les sorties suivantes :
| Variables | |
|---|---|
| Entrées | Obligatoire : ID de factureL’identifiant de la facture peut être soit un numéro de facture (par exemple, 1234), soit un UUID. |
| Sortie | Détails de la facture, notamment id, number, account_code, state, type, subtotal, tax, total, balance, currency, created_at, due_at, closed_at et pdf_url. |
Recherche d’une transaction
Utilisez l’action Rechercher une transaction pour récupérer les détails d’une transaction de paiement à l’aide de l’UUID. Utilisez cette action pour récupérer des informations détaillées sur une transaction de paiement, notamment le mode de paiement, la réponse de la passerelle et le statut de la transaction. Les données de sortie incluent les horodatages des annulations et des remboursements, le cas échéant.
Cette action a les entrées et les sorties suivantes :
| Variables | |
|---|---|
| Entrées | Obligatoire : UUID de transaction
|
| Sortie | Les informations de transactions incluent uuid, account_code, invoice_number, subscription_uuid, type, status, amount, currency, payment_method, gateway_code, gateway_message, created_at, voided_at et refunded_at. |