Listar suscripciones en Stripe, con una API

Lista las suscripciones, de la más nueva a la más antigua, opcionalmente de un cliente, un precio o un estado. Sin status, las suscripciones canceladas quedan fuera. Cada suscripción trae sus precios en items.data. Pagina con starting_after mientras has_more sea true.

Identificador
stripe_list_subscriptions

La llamada

POST https://connect.reportei.com/api/tools/stripe_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 Search customers.
pricestringNoOnly the subscriptions with this price, the price_ id in items.data.price.id of a subscription returned by List subscriptions or Search subscriptions.
statusstringNoOnly the subscriptions in this status. all includes the canceled ones, and ended means canceled or incomplete_expired.Valores: active, all, canceled, ended, incomplete, incomplete_expired, past_due, paused, trialing, unpaid
limitintegerNoSubscriptions per page, from 1 to 100. The default is 10.
starting_afterstringNoId of the last subscription of the previous page, 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_list_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.