Créer un abonnement avec l'API Asaas

Crée un abonnement pour un client, qui génère un paiement par cycle, le premier à l'échéance nextDueDate. Les paiements apparaissent dans List payments avec le filtre d'abonnement.

Identifiant
asaas_create_subscription

L'appel

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "customer": "<customer>",
    "billingType": "BOLETO",
    "value": 1,
    "nextDueDate": "<nextDueDate>",
    "cycle": "WEEKLY"
  }
}

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
customerstringOuiId of the customer who pays, starting with cus_, from List customers or Create customer.
billingTypestringOuiHow the customer pays each payment. UNDEFINED lets the payer choose among the methods enabled on the account.Valeurs : BOLETO, PIX, CREDIT_CARD, UNDEFINED
valuenumberOuiAmount of each payment, in reais, for example 19.9.
nextDueDatestringOuiDue date of the first payment, in YYYY-MM-DD.
cyclestringOuiHow often a payment is generated. BIWEEKLY is every two weeks and BIMONTHLY every two months.Valeurs : WEEKLY, BIWEEKLY, MONTHLY, BIMONTHLY, QUARTERLY, SEMIANNUALLY, YEARLY
descriptionstringNonDescription of the subscription, shown to the payer.
endDatestringNonLast due date of the subscription, in YYYY-MM-DD. Without it and maxPayments, the subscription has no end.
maxPaymentsintegerNonMaximum number of payments the subscription generates.
externalReferencestringNonIdentifier of the subscription in your own system, usable as a filter in List subscriptions.
discountobjectNonDiscount for paying each payment early.
interestobjectNonInterest for paying after the due date. Leave it out to keep the interest set on the account, because sending it overrides that setting.
fineobjectNonFine for paying after the due date. Leave it out to keep the fine set on the account, because sending it overrides that 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_create_subscription. 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.