Buscar suscripciones en Stripe, con una API

Busca suscripciones por estado, fecha de creación, fecha de cancelación o metadata con el lenguaje de consulta de búsqueda de Stripe, lo que sirve para preguntas como suscripciones nuevas o canceladas en un periodo. La respuesta trae data, has_more y next_page; envía next_page como page para la página siguiente.

Identificador
stripe_search_subscriptions

La llamada

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

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

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
querystringSíUp to 10 clauses joined by AND or by OR, never both, for example status:"canceled". Fields: status (active, canceled, incomplete, incomplete_expired, past_due, paused, trialing, unpaid), metadata["key"]:"value", and created and canceled_at (Unix seconds), which also take a greater-than or less-than sign, optionally followed by an equals sign, in place of the colon. There is no customer field: use List subscriptions for one customer. Text values go in double quotes.
limitintegerNoSubscriptions per page, from 1 to 100. The default is 10.
pagestringNoThe next_page value of the previous response, to get the next page.

Conexiones posibles

Tu cliente conecta su cuenta de Stripe 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/stripe_search_subscriptions. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Stripe

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.