Uso de acciones de Recurly en los flujos de acciones

Suite, todas las versiones

Team, Growth, Professional, Enterprise o Enterprise Plus

Support

Team, Professional o Enterprise

Resumen: ◀▼

Los flujos de acciones se pueden conectar a Recurly para automatizar la cuenta del cliente y la administración de la suscripción. Las acciones incluyen crear, actualizar y buscar cuentas y suscripciones, así como cancelar suscripciones y recuperar los detalles de una factura o transacción. Utilice una cuenta de servicio exclusiva para las conexiones y proporcione las credenciales de API de Recurly. Esta integración ayuda a optimizar los flujos de trabajo de facturación y suscripción dentro de los procesos de soporte.

Si el generador de acciones se conecta con sistemas externos, como Recurly, los administradores pueden integrar Zendesk con sistemas externos en los flujos de trabajo automatizados, lo que mejora la colaboración y mantiene una experiencia fluida en las distintas plataformas.

Nota: Los pasos asociados a los sistemas externos en los flujos de acciones se denominan colectivamente acciones externas.

Los temas tratados en el artículo son estos:

Conectar Recurly con el generador de acciones
Usar las acciones de Recurly en los flujos de acciones

Conectar Recurly con el generador de acciones

Para poder incluir acciones externas en los flujos de acciones, primero se debe conectar el generador de acciones con el sistema externo.

Las siguientes prácticas son las más recomendadas a la hora de conectarse a sistemas externos para usarlos en flujos de acciones:

Todas las acciones externas realizadas por un flujo de acciones se atribuyen al usuario que conectó el sistema externo. Por esta razón, cuando vaya a conectarse a cada sistema externo, conviene usar una cuenta dedicada exclusivamente a este servicio, y no una cuenta que emplee credenciales personales.
Todas las integraciones solicitan acceso a los ámbitos necesarios. Sin embargo, es importante que revise y valide los ámbitos antes de autorizar la conexión al sistema externo.
Cuando necesite administrar credenciales para herramientas que funcionan con claves de API (como OpenAI), lo mejor es guardar las claves en una bóveda o con un administrador de credenciales.

Para ubicar el dominio de Recurly y la clave de API

La conexión de Recurly requiere una clave de API para la autenticación. Para ello, proporcione lo siguiente:

Subdominio de Recurly. La porción del subdominio del URL de Recurly (por ejemplo, "sucompañía" de sucompañía.recurly.com).
Clave de API. Su clave de API privada de Recurly que encontrará en Recurly bajo Integrations > API Credentials > Private API Key.

Consulte la documentación de Recurly si desea más información.

Para conectar el generador de acciones con Recurly

En el Centro de administración, haga clic en Aplicaciones e integraciones en la barra lateral y luego seleccione Acciones > Flujos de acciones.
Cree o edite un flujo de acciones.
Abra la barra lateral de pasos.
En Acciones externas, haga clic en Recurly.
Haga clic en Conectar.
Siga las indicaciones de Recurly para ingresar su clave de API de Recurly y completar la conexión.
Importante: Todas las acciones externas realizadas por un flujo de acciones se atribuyen al usuario que conectó el sistema externo. Por esta razón, cuando vaya a conectarse a cada sistema externo, conviene usar una cuenta dedicada exclusivamente a este servicio, y no una cuenta que emplee credenciales personales.

Después de conectarse al sistema, verá un indicador de conexión y detalles sobre la instancia a la que está conectado, así como las acciones disponibles para Recurly.

Uso de acciones de Recurly en los flujos de acciones

Están disponibles las siguientes acciones de Recurly:

Crear cuenta
Actualizar cuenta
Buscar cuenta
Crear suscripción
Actualizar suscripción
Cancelar suscripción
Buscar suscripción
Buscar factura
Buscar transacción

Crear una cuenta

Utilice la acción Crear cuenta para crear una nueva cuenta de cliente en Recurly.

Esta acción tiene las siguientes entradas y salidas:

Variables

Entrada

	Variables
Entrada	Requerido: `Account Code` Código de cuenta es un identificador único para la cuenta con un máximo de 50 caracteres. Use una ID de usuario u organización de Zendesk para facilitar las referencias cruzadas. Opcional: `Email`, `First Name`, `Last Name`, `Company`, `Tax Exempt` Exento de impuestos se puede definir en sí o no.
Salida	Los detalles de la cuenta como id, code, email, state, created_at y hosted_login_token.

Requerido: Account Code

Código de cuenta es un identificador único para la cuenta con un máximo de 50 caracteres. Use una ID de usuario u organización de Zendesk para facilitar las referencias cruzadas.

Opcional: Email, First Name, Last Name, Company, Tax Exempt

Exento de impuestos se puede definir en sí o no.

Salida Los detalles de la cuenta como id, code, email, state, created_at y hosted_login_token.

Actualizar una cuenta

Utilice la acción Actualizar cuenta para modificar una cuenta de cliente existente en Recurly.

Esta acción tiene las siguientes entradas y salidas:

Variables

Entrada

	Variables
Entrada	Requerido: `Account Code` Código de cuenta puede ser ya sea el código de la cuenta o un UUID. Opcional: `Email`, `First Name`, `Last Name`, `Company` Proporcione valores solo para los campos que desea actualizar. Los valores existentes para los campos que no especifique permanecerán intactos.
Salida	Los detalles de la cuenta como id, code, state y updated_at timestamp.

Requerido: Account Code

Código de cuenta puede ser ya sea el código de la cuenta o un UUID.

Opcional: Email, First Name, Last Name, Company

Proporcione valores solo para los campos que desea actualizar. Los valores existentes para los campos que no especifique permanecerán intactos.

Salida Los detalles de la cuenta como id, code, state y updated_at timestamp.

Buscar una cuenta

Utilice la acción Buscar cuenta para obtener los detalles de una cuenta por el código de cuenta o un UUID. Utilice esta acción para obtener información exhaustiva de la cuenta de un cliente, lo que incluye el estado de su suscripción y los detalles de facturación.

Esta acción tiene las siguientes entradas y salidas:

	Variables
Entrada	Requerido: `Account Code` Código de cuenta puede ser ya sea el código de la cuenta o un UUID.
Salida	Los detalles de la cuenta como id, code, email, first_name, last_name, company, state, balance, has_active_subscription, has_past_due_invoice, created_at y updated_at.

Crear una suscripción

Utilice la acción Crear suscripción para crear una nueva suscripción para una cuenta de Recurly.

Esta acción tiene las siguientes entradas y salidas:

Variables

Entrada

	Variables
Entrada	Requerido: `Account Code`, `Plan`, `Currency`, `Collection method` Opcional: `Quantity`, `Trial End Date`, `Start Date`, `Billing Info ID` Considere lo siguiente al usar la acción Crear suscripción: El campo Plan se rellena de forma dinámica con los planes de suscripción disponibles de su cuenta de Recurly. Las opciones de moneda son: USD, EUR, GBP, CAD, AUD, JPY e INR. Método de cobro determina el comportamiento de facturación: cargo automático para renovación o facturación enviada manualmente. Fecha de finalización y Fecha de inicio de la prueba deben seguir el formato ISO 8601 (por ejemplo: 2026-12-31T00:00:00Z). Si la cantidad no se especifica, se usa el valor predeterminado 1. ID de la información de facturación no se admite actualmente y exige el uso de la función "Wallet" de Recurly.
Salida	Los detalles de la suscripción como uuid, account_code, account_email, plan_code, plan_name, state, quantity, currency, current_period_started_at, current_period_ends_at, trial_ends_at, activated_at y created_at.

Requerido: Account Code, Plan, Currency, Collection method

Opcional: Quantity, Trial End Date, Start Date, Billing Info ID

Considere lo siguiente al usar la acción Crear suscripción:

El campo Plan se rellena de forma dinámica con los planes de suscripción disponibles de su cuenta de Recurly.
Las opciones de moneda son: USD, EUR, GBP, CAD, AUD, JPY e INR.
Método de cobro determina el comportamiento de facturación: cargo automático para renovación o facturación enviada manualmente.
Fecha de finalización y Fecha de inicio de la prueba deben seguir el formato ISO 8601 (por ejemplo: 2026-12-31T00:00:00Z).
Si la cantidad no se especifica, se usa el valor predeterminado 1.
ID de la información de facturación no se admite actualmente y exige el uso de la función "Wallet" de Recurly.

Salida Los detalles de la suscripción como uuid, account_code, account_email, plan_code, plan_name, state, quantity, currency, current_period_started_at, current_period_ends_at, trial_ends_at, activated_at y created_at.

Actualizar una suscripción

Utilice la acción Actualizar suscripción para actualizar un plan de suscripción existente, la cantidad o el periodo de tiempo.

Esta acción tiene las siguientes entradas y salidas:

Variables

Entrada

	Variables
Entrada	Requerido: `Subscription UIID` Opcional: `New Plan`, `Quantity`, `When to Apply` El campo Nuevo plan se rellena de forma dinámica con los planes de suscripción disponibles. Cuándo aplicar determina si los cambios tienen efecto de inmediato (Ahora) o con el próximo ciclo de facturación (Al renovar). Proporcione valores solo para los campos que desea actualizar.
Salida	Los detalles de la suscripción como uuid, state, plan_code, plan_name, quantity y updated_at timestamp.

Requerido: Subscription UIID

Opcional: New Plan, Quantity, When to Apply

El campo Nuevo plan se rellena de forma dinámica con los planes de suscripción disponibles. Cuándo aplicar determina si los cambios tienen efecto de inmediato (Ahora) o con el próximo ciclo de facturación (Al renovar). Proporcione valores solo para los campos que desea actualizar.

Salida Los detalles de la suscripción como uuid, state, plan_code, plan_name, quantity y updated_at timestamp.

Cancelar una suscripción

Utilice la acción Cancelar subscripción para cancelar una suscripción activa al finalizar el plazo o de manera inmediata.

Esta acción tiene las siguientes entradas y salidas:

Variables

Entrada

	Variables
Entrada	Requerido: `Subscription UUID` Opcional: `When to Cancel` Cuándo cancelar determina el momento de la cancelación. "Al final del periodo" (recomendado) cancela la suscripción al final de todos los ciclos de facturación, mientras que "En el próximo ciclo de facturación" la cancela en la fecha de la siguiente facturación. Elija la opción que más le convenga de acuerdo con su política empresarial.
Salida	Los detalles de la suscripción como uuid, state, canceled_at y expires_at timestamps.

Requerido: Subscription UUID

Opcional: When to Cancel

Cuándo cancelar determina el momento de la cancelación. "Al final del periodo" (recomendado) cancela la suscripción al final de todos los ciclos de facturación, mientras que "En el próximo ciclo de facturación" la cancela en la fecha de la siguiente facturación. Elija la opción que más le convenga de acuerdo con su política empresarial.

Salida Los detalles de la suscripción como uuid, state, canceled_at y expires_at timestamps.

Buscar una suscripción

Utilice la acción Buscar suscripción para obtener información de suscripción detallada por UUID. Utilice esta acción para obtener información de suscripción exhaustiva como los periodos de facturación, los precios y el estado de cancelación. La salida incluye tanto el estado actual como las marcas de tiempo históricas.

Esta acción tiene las siguientes entradas y salidas:

	Variables
Entrada	Requerido: `Subscription UUID`
Salida	Los detalles de la suscripción como uuid, account_code, account_email, plan_code, plan_name, plan_interval_unit, plan_interval_length, state, quantity, currency, unit_amount, subtotal, current_period_started_at, current_period_ends_at, trial_ends_at, activated_at, canceled_at y expires_at.

Buscar una factura

Utilice la acción Buscar factura para obtener los detalles de la factura por número de factura o UUID. La salida incluye “pdf_url”, que proporciona un vínculo directo para descargar el PDF de la factura.

Esta acción tiene las siguientes entradas y salidas:

	Variables
Entrada	Requerido: `Invoice ID` ID de la factura puede consistir ya sea de un número de factura (por ejemplo, 1234) o el UUID.
Salida	Los detalles de la factura como id, number, account_code, state, type, subtotal, tax, total, balance, currency, created_at, due_at, closed_at y pdf_url.

Buscar una transacción

Utilice la acción Buscar transacción para obtener los detalles de pago por UUID. Utilice esta acción para obtener información detallada sobre las transacciones de pago, lo que incluye el método de pago, la respuesta de la puerta de enlace y el estado de la transacción. La salida incluye las marcas de tiempo para anulados y reembolsos, si corresponde.

Esta acción tiene las siguientes entradas y salidas:

	Variables
Entrada	Requerido: `Transaction UUID`
Salida	Los detalles de la transacción como uuid, account_code, invoice_number, subscription_uuid, type, status, amount, currency, payment_method, gateway_code, gateway_message, created_at, voided_at y refunded_at.