Mettre à jour un abonnement avec l'API Asaas
Met à jour un abonnement. Les changements s'appliquent aux paiements pas encore générés, sauf si updatePendingPayments vaut true. status INACTIVE suspend l'abonnement et garde ses paiements, et ACTIVE le réactive avec un nouveau nextDueDate.
- Identifiant
- asaas_update_subscription
L'appel
POST https://connect.reportei.com/api/tools/asaas_update_subscription/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"id": "<id>"
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| id | string | Oui | Id of the subscription, starting with sub_, from List subscriptions or Create subscription. |
| value | number | Non | New amount of each payment, in reais. A credit card subscription only changes value with card tokenization enabled on the account. |
| status | string | Non | INACTIVE stops generating payments and keeps the existing ones. ACTIVE reactivates the subscription and needs a new nextDueDate.Valeurs : ACTIVE, INACTIVE |
| nextDueDate | string | Non | Due date of the next payment not generated yet, in YYYY-MM-DD. It does not move the payments already generated. |
| billingType | string | Non | How the customer pays each payment. UNDEFINED lets the payer choose among the methods enabled on the account.Valeurs : BOLETO, PIX, CREDIT_CARD, UNDEFINED |
| cycle | string | Non | How often a payment is generated. BIWEEKLY is every two weeks and BIMONTHLY every two months.Valeurs : WEEKLY, BIWEEKLY, MONTHLY, BIMONTHLY, QUARTERLY, SEMIANNUALLY, YEARLY |
| description | string | Non | Description of the subscription, shown to the payer. |
| endDate | string | Non | Last due date of the subscription, in YYYY-MM-DD. |
| updatePendingPayments | boolean | Non | true also applies the changes to the pending payments already generated. |
| externalReference | string | Non | Identifier of the subscription in your own system, usable as a filter in List subscriptions. |
| discount | object | Non | Discount for paying each payment early. |
| interest | object | Non | Interest for paying after the due date. Leave it out to keep the current setting. |
| fine | object | Non | Fine for paying after the due date. Leave it out to keep the current setting. |
Connexions possibles
Votre client connecte son compte Asaas une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Clé d'API
Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/asaas_update_subscription. Il devient la définition de tool de votre agent sans conversion.
Autres tools Asaas
- Lister les clientsGETListe les clients (payeurs) du compte, avec filtre optionnel par nom, e-mail, CPF ou CNPJ, groupe ou référence externe. La réponse contient data, totalCount et hasMore ; paginez avec offset et limit tant que hasMore vaut true.
- Consulter un clientGETRenvoie un client, avec nom, CPF ou CNPJ, e-mail, téléphones, adresse et paramètre de notification.
- Créer un clientPOSTCrée un client, le payeur des paiements et abonnements. name et cpfCnpj sont obligatoires. Il n'y a pas de champ ville : Asaas déduit la ville de postalCode.
- Mettre à jour un clientPUTMet à jour un client. Les champs non envoyés restent inchangés.
- Lister les paiementsGETListe les paiements (cobrancas), avec filtre optionnel par client, abonnement, statut, mode de paiement, date de paiement ou référence externe. Les montants sont en reais. La réponse contient data, totalCount et hasMore ; paginez avec offset et limit tant que hasMore vaut true.
- Consulter un paiementGETRenvoie un paiement, avec statut, montant, montant net, échéance, date de paiement et les liens invoiceUrl (la page du paiement) et bankSlipUrl (le boleto).
- Créer un paiementPOSTCrée un paiement (cobranca) pour un client, par boleto, Pix ou carte de crédit, en une fois ou en plusieurs fois. La réponse contient invoiceUrl, la page de paiement à envoyer au payeur, et Asaas peut notifier le client selon ses paramètres de notification.
- Mettre à jour un paiementPUTMet à jour un paiement encore en attente ou en retard ; le client ne peut pas changer. Envoyez billingType, value et dueDate même s'ils ne changent pas, avec les valeurs actuelles de Get payment. Un nouveau montant ou une nouvelle échéance peut notifier le client.
Toolkits de la même catégorie
Voir les 100 toolkitsVoyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.

Conta Azul