Lister les abonnements avec l'API Asaas

Liste les abonnements, avec filtre optionnel par client, statut, mode de paiement ou référence externe. Les paiements générés par un abonnement viennent de List payments avec le filtre d'abonnement. Paginez avec offset et limit tant que hasMore vaut true.

Identifiant
asaas_list_subscriptions

L'appel

POST https://connect.reportei.com/api/tools/asaas_list_subscriptions/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "customer": "<customer>"
  }
}

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ètreTypeObligatoireDescription
customerstringNonOnly the subscriptions of this customer, the cus_ id from List customers.
statusstringNonOnly the subscriptions in this status. INACTIVE is suspended, and EXPIRED reached its end date or maximum of payments.Valeurs : ACTIVE, INACTIVE, EXPIRED
billingTypestringNonOnly the subscriptions of this billing type.Valeurs : UNDEFINED, BOLETO, CREDIT_CARD, PIX
externalReferencestringNonOnly the subscriptions with this identifier of your own system, saved in externalReference.
includeDeletedstringNontrue also returns the removed subscriptions.Valeurs : true, false
offsetintegerNonPosition of the first subscription of the page. The default is 0; add limit to it for the next page.
limitintegerNonSubscriptions per page, from 1 to 100. The default is 10.

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_list_subscriptions. Il devient la définition de tool de votre agent sans conversion.

Autres tools Asaas

Voir les 12 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.