Actualizar suscripción en Stripe, con una API

Actualiza una suscripción, por ejemplo para cancelarla al final del periodo actual con cancel_at_period_end, o para deshacerlo. Cambiar los elementos o precios de la suscripción no está disponible aquí.

Identificador
stripe_update_subscription

La llamada

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

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

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
subscriptionstringSíId of the subscription, starting with sub_, from List subscriptions or Search subscriptions.
cancel_at_period_endbooleanNotrue cancels the subscription at the end of the current period, and false undoes a cancellation scheduled this way.
cancel_atintegerNoUnix timestamp, in seconds, at which the subscription is canceled. A date before the end of the current period prorates according to proration_behavior.
descriptionstringNoDescription of the subscription, shown to the customer.
trial_endstringNoEnd of the trial, as a Unix timestamp in seconds, or now to end the trial right away.
collection_methodstringNocharge_automatically charges the default payment method of the customer; send_invoice emails each invoice with payment instructions and needs days_until_due.Valores: charge_automatically, send_invoice
days_until_dueintegerNoDays the customer has to pay each invoice. Only with collection_method send_invoice.
proration_behaviorstringNoHow a change that affects the billing is prorated: create_prorations (the default) adds the proration to the next invoice, always_invoice invoices it right away and none skips it.Valores: always_invoice, create_prorations, none

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_update_subscription. 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.