Uso de ações do Recurly em fluxos de ações

Suite, todas as versões

Team, Growth, Professional, Enterprise ou Enterprise Plus

Support

Team, Professional ou Enterprise

Resumo: ◀▼

É possível conectar fluxos de ação ao Recurly para automatizar o gerenciamento de contas de clientes e assinaturas. As ações incluem criar, atualizar e consultar contas e assinaturas, bem como cancelar assinaturas e recuperar detalhes de faturas ou transações. Use uma conta de serviço dedicada para conexões e forneça credenciais de API do Recurly. Essa integração ajuda a simplificar os fluxos de trabalho de faturamento e assinatura em seus processos de suporte.

Ao conectar o criador de ações a sistemas externos, como o Recurly, os administradores podem integrar o Zendesk a sistemas externos em fluxos de trabalho automatizados, melhorando a colaboração e mantendo uma experiência contínua em várias plataformas.

Observação: as etapas associadas aos sistemas externos em fluxos de ação são chamadas coletivamente de ações externas.

Este artigo contém os seguintes tópicos:

Conexão do Recurly ao criador de ações
Uso de ações do Recurly em fluxos de ações

Conexão do Recurly ao criador de ações

Antes de incluir ações externas nos seus fluxos de ação, é preciso conectar o criador de ações ao sistema externo.

Ao se conectar a sistemas externos para uso em fluxos de ação, as seguintes práticas recomendadas devem ser observadas:

Todas as ações externas realizadas por um fluxo de ação são atribuídas ao usuário que conectou o sistema externo. Portanto, é uma prática recomendada usar uma conta de serviço dedicada em vez de credenciais pessoais ao se conectar a cada sistema externo.
Todas as integrações solicitam acesso aos escopos necessários. No entanto, é importante que você avalie e valide os escopos antes de autorizar a conexão com o sistema externo.
Ao gerenciar credenciais para ferramentas baseadas em chave de API, como a OpenAI, recomendamos armazenar as chaves em um cofre seguro ou em um gerenciador de credenciais.

Como localizar seu domínio Recurly e chave de API

A conexão do Recurly requer uma chave da API para autenticação. Você precisará fornecer:

Subdomínio do Recurly: a parte do subdomínio da sua URL do Recurly (por exemplo, "suaempresa" de suaempresa.recurly.com).
Chave da API: Sua chave de API privada do Recurly, encontrada no Recurly em Integrações> Credenciais de API > Chave de API Privada.

Para obter mais informações, consulte a documentação do Recurly.

Como conectar o criador de ações ao Recurly

Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione Ações > Fluxos de ação.
Crie ou edite um fluxo de ação.
Abra a barra lateral da etapa.
Em Ações externas, clique em Recurly.
Clique em Conectar.
Siga as instruções do Recurly para inserir sua chave de API do Recurly e concluir a conexão.
Importante: Todas as ações externas realizadas por um fluxo de ação são atribuídas ao usuário que conectou o sistema externo. Portanto, é uma prática recomendada usar uma conta de serviço dedicada em vez de credenciais pessoais ao se conectar a cada sistema externo.

Depois de se conectar ao sistema, você verá um indicador de conexão e detalhes sobre a instância à qual está conectado, bem como as ações disponíveis para o Recurly.

Uso de ações do Recurly em fluxos de ações

As seguintes ações do Recurly estão disponíveis:

Criar conta
Atualizar conta
Pesquisar conta
Criar assinatura
Atualizar assinatura
Cancelar assinatura
Pesquisar assinatura
Pesquisar fatura
Pesquisar transação

Criação de uma conta

Use a ação Criar conta para criar uma nova conta de cliente no Recurly.

As entradas e saídas dessa ação são:

Variáveis

Entradas

	Variáveis
Entradas	Obrigatória: `Account Code` O Código da conta é um identificador único da conta com um máximo de 50 caracteres. Use um ID de usuário ou organização do Zendesk para facilitar a consulta cruzada. Opcionais: `Email`, `First Name`, `Last Name`, `Company`, `Tax Exempt` Isenção de impostos pode ser definida como Sim ou Não.
Saída	Detalhes da conta, incluindo id, code, email, state, created_at e hosted_login_token.

Obrigatória: Account Code

O Código da conta é um identificador único da conta com um máximo de 50 caracteres. Use um ID de usuário ou organização do Zendesk para facilitar a consulta cruzada.

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

Isenção de impostos pode ser definida como Sim ou Não.

Saída Detalhes da conta, incluindo id, code, email, state, created_at e hosted_login_token.

Atualização de uma conta

Use a ação Atualizar conta para modificar uma conta de cliente existente no Recurly.

As entradas e saídas dessa ação são:

Variáveis

Entradas

	Variáveis
Entradas	Obrigatória: `Account Code` O código da conta pode ser tanto o código da conta quanto o UUID. Opcionais: `Email`, `First Name`, `Last Name`, `Company` Forneça valores somente para campos que deseja atualizar. Os valores existentes para os campos que você não especificar permanecerão inalterados.
Saída	Detalhes da conta, incluindo ID, código, estado e carimbo de data/hora da atualização.

Obrigatória: Account Code

O código da conta pode ser tanto o código da conta quanto o UUID.

Opcionais: Email, First Name, Last Name, Company

Forneça valores somente para campos que deseja atualizar. Os valores existentes para os campos que você não especificar permanecerão inalterados.

Saída Detalhes da conta, incluindo ID, código, estado e carimbo de data/hora da atualização.

Pesquisa de uma conta

Use a ação Pesquisar conta para recuperar detalhes da conta pelo código da conta ou UUID. Use esta ação para obter informações completas sobre a conta de um cliente, incluindo o status da assinatura e os detalhes de faturamento.

As entradas e saídas dessa ação são:

	Variáveis
Entradas	Obrigatória: `Account Code` O código da conta pode ser tanto o código da conta quanto o UUID.
Saída	Detalhes da conta, incluindo ID, código, e-mail, nome, sobrenome, empresa, estado, saldo, possui assinatura ativa, possui fatura vencida, data de criação e data de atualização.

Criação de uma assinatura

Use a ação Criar assinatura para criar uma nova assinatura para uma conta Recurly.

As entradas e saídas dessa ação são:

Variáveis

Entradas

	Variáveis
Entradas	Obrigatórias: `Account Code`, `Plan`, `Currency`, `Collection method` Opcionais: `Quantity`, `Trial End Date`, `Start Date`, `Billing Info ID` Ao usar a ação Criar assinatura, considere o seguinte: O campo Plano é preenchido dinamicamente com os planos de assinatura disponíveis em sua conta Recurly. As opções de moeda incluem USD, EUR, GBP, CAD, AUD, JPY e INR. O método de cobrança determina o comportamento de faturamento: cobranças automáticas na renovação, envia uma fatura manualmente. A data de término e a data de início do período de avaliação devem estar no formato ISO 8601 (por exemplo, 2026-12-31T00:00:00Z). A quantidade será definida como 1 por padrão se não for especificada. O ID de informações de faturamento não é compatível no momento e requer o recurso "Carteira" do Recurly.
Saída	Detalhes da assinatura, incluindo 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 e created_at.

Obrigatórias: Account Code, Plan, Currency, Collection method

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

Ao usar a ação Criar assinatura, considere o seguinte:

O campo Plano é preenchido dinamicamente com os planos de assinatura disponíveis em sua conta Recurly.
As opções de moeda incluem USD, EUR, GBP, CAD, AUD, JPY e INR.
O método de cobrança determina o comportamento de faturamento: cobranças automáticas na renovação, envia uma fatura manualmente.
A data de término e a data de início do período de avaliação devem estar no formato ISO 8601 (por exemplo, 2026-12-31T00:00:00Z).
A quantidade será definida como 1 por padrão se não for especificada.
O ID de informações de faturamento não é compatível no momento e requer o recurso "Carteira" do Recurly.

Saída Detalhes da assinatura, incluindo 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 e created_at.

Atualização de uma assinatura

Use a ação Atualizar assinatura para alterar o plano, a quantidade ou o período de tempo de uma assinatura existente.

As entradas e saídas dessa ação são:

Variáveis

Entradas

	Variáveis
Entradas	Obrigatória: `Subscription UIID` Opcionais: `New Plan`, `Quantity`, `When to Apply` O campo Novo plano é preenchido dinamicamente com os planos de assinatura disponíveis. Quando aplicar determina se as alterações entram em vigor imediatamente (Agora) ou no próximo ciclo de faturamento (Na renovação). Forneça valores somente para campos que deseja atualizar.
Saída	Detalhes da assinatura, incluindo uuid, estado, código do plano, nome do plano, quantidade e carimbo de data/hora da atualização.

Obrigatória: Subscription UIID

Opcionais: New Plan, Quantity, When to Apply

O campo Novo plano é preenchido dinamicamente com os planos de assinatura disponíveis. Quando aplicar determina se as alterações entram em vigor imediatamente (Agora) ou no próximo ciclo de faturamento (Na renovação). Forneça valores somente para campos que deseja atualizar.

Saída Detalhes da assinatura, incluindo uuid, estado, código do plano, nome do plano, quantidade e carimbo de data/hora da atualização.

Cancelamento de uma assinatura

Use a ação Cancelar assinatura para cancelar uma assinatura ativa no fim da vigência ou imediatamente.

As entradas e saídas dessa ação são:

Variáveis

Entradas

	Variáveis
Entradas	Obrigatória: `Subscription UUID` Opcional: `When to Cancel` Quando cancelar determina o momento do cancelamento: "No fim da vigência" (recomendado) é cancelado no final de todos os ciclos de faturamento, enquanto "No próximo ciclo de faturamento" é cancelado na próxima data de faturamento. Escolha a opção que melhor se adequa à política da sua empresa.
Saída	Detalhes da assinatura, incluindo os carimbos de data/hora de uuid, estado, cancelamento e expiração.

Obrigatória: Subscription UUID

Opcional: When to Cancel

Quando cancelar determina o momento do cancelamento: "No fim da vigência" (recomendado) é cancelado no final de todos os ciclos de faturamento, enquanto "No próximo ciclo de faturamento" é cancelado na próxima data de faturamento. Escolha a opção que melhor se adequa à política da sua empresa.

Saída Detalhes da assinatura, incluindo os carimbos de data/hora de uuid, estado, cancelamento e expiração.

Pesquisa de uma assinatura

Use a ação Pesquisar assinatura para recuperar informações detalhadas da assinatura por UUID. Use esta opção para obter informações completas sobre a assinatura, incluindo períodos de faturamento, preços e status de cancelamento. A saída inclui tanto o estado atual quanto os históricos de carimbos de data/hora.

As entradas e saídas dessa ação são:

	Variáveis
Entradas	Obrigatória: `Subscription UUID`
Saída	Detalhes da assinatura, incluindo 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 e expires_at

Pesquisar fatura

Use a ação Pesquisar fatura para recuperar detalhes da fatura pelo número da fatura ou UUID. O resultado inclui o pdf_url, que fornece um link direto para baixar o PDF da fatura.

As entradas e saídas dessa ação são:

	Variáveis
Entradas	Obrigatória: `Invoice ID` O ID da fatura pode ser um número de fatura (por exemplo, 1234) ou um UUID.
Saída	Detalhes da fatura, incluindo ID e número, account_code, state, type, subtotal, tax, total, balance, currency, created_at, due_at, closed_at e pdf_url.

Pesquisa de transação

Utilize a ação Pesquisar transação para recuperar detalhes da transação de pagamento por UUID. Use esta ação para recuperar informações detalhadas sobre a transação de pagamento, incluindo o método de pagamento, a resposta do gateway e o status da transação. O resultado inclui carimbos de data/hora para cancelamentos e reembolsos, quando aplicável.

As entradas e saídas dessa ação são:

	Variáveis
Entradas	Obrigatória: `Transaction UUID`
Saída	Detalhes da transação, incluindo o uuid, account_code, invoice_number, subscription_uuid, type, status, amount, currency, payment_method, gateway_code, gateway_message, created_at, voided_at e refunded_at.