Listar suscripciones en Asaas, con una API

Lista las suscripciones, con filtro opcional por cliente, estado, forma de pago o referencia externa. Los cobros que genera una suscripción vienen de List payments con el filtro de suscripción. Pagina con offset y limit mientras hasMore sea true.

Identificador
asaas_list_subscriptions

La llamada

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>"
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
customerstringNoOnly the subscriptions of this customer, the cus_ id from List customers.
statusstringNoOnly the subscriptions in this status. INACTIVE is suspended, and EXPIRED reached its end date or maximum of payments.Valores: ACTIVE, INACTIVE, EXPIRED
billingTypestringNoOnly the subscriptions of this billing type.Valores: UNDEFINED, BOLETO, CREDIT_CARD, PIX
externalReferencestringNoOnly the subscriptions with this identifier of your own system, saved in externalReference.
includeDeletedstringNotrue also returns the removed subscriptions.Valores: true, false
offsetintegerNoPosition of the first subscription of the page. The default is 0; add limit to it for the next page.
limitintegerNoSubscriptions per page, from 1 to 100. The default is 10.

Conexiones posibles

Tu cliente conecta su cuenta de Asaas una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

Clave de API

Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/asaas_list_subscriptions. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Asaas

Ver las 12 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.