Criar assinatura no Recharge, por uma API
Cria uma assinatura em um endereço de um cliente e a retorna. O produto precisa de ao menos um plano no Recharge. Os campos de frequência, a data da primeira cobrança, a variante, a quantidade e o endereço são obrigatórios.
- Identificador
- recharge_create_subscription
A chamada
POST https://connect.reportei.com/api/tools/recharge_create_subscription/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"address_id": 1,
"external_variant_id": {},
"quantity": 1,
"next_charge_scheduled_at": "<next_charge_scheduled_at>",
"order_interval_unit": "day",
"order_interval_frequency": 1,
"charge_interval_frequency": 1
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| address_id | integer | Sim | Id of an address of the customer, from the addresses of Get customer with include addresses, or the address_id of a subscription in List subscriptions. |
| external_variant_id | object | Sim | Product variant in the store platform. The variant id comes from external_variant_id of a subscription in List subscriptions, or from the product page in the store admin. |
| quantity | integer | Sim | Number of units in each order. |
| next_charge_scheduled_at | string | Sim | Date of the first charge, as YYYY-MM-DD. |
| order_interval_unit | string | Sim | Unit of the order and charge frequencies.Valores: day, week, month |
| order_interval_frequency | integer | Sim | Number of order_interval_unit between orders, such as 1 for a monthly order. |
| charge_interval_frequency | integer | Sim | Number of order_interval_unit between charges. Equal to order_interval_frequency when each order is paid on its own; a multiple of it for a prepaid subscription. |
| order_day_of_month | integer | Não | Day of the month the orders are created on, when order_interval_unit is month. |
| order_day_of_week | integer | Não | Day of the week the orders are created on, when order_interval_unit is week. |
| expire_after_specific_number_of_charges | integer | Não | Number of charges after which the subscription expires. Without it, the subscription runs until it is cancelled. |
| price | string | Não | Price of one unit, such as 10.00. |
| product_title | string | Não | Name of the product. |
| properties | array | Não | Line item properties of the subscription, such as a color or an engraving text. |
Conexões possíveis
O seu cliente conecta a conta do Recharge uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/recharge_create_subscription. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Recharge
- Listar assinaturasGETLista as assinaturas da loja com cliente, endereço, produto, quantidade, preço, frequência, status e next_charge_scheduled_at. Até 250 por página: envie o next_cursor da resposta como cursor para ler a próxima página.
- Consultar assinaturaGETRetorna uma assinatura com produto, quantidade, preço, frequência, status, motivo do cancelamento e next_charge_scheduled_at.
- Atualizar assinaturaPUTAltera uma assinatura ativa e a retorna. Mudar order_interval_unit, order_interval_frequency ou charge_interval_frequency exige os três, recalcula a data da próxima cobrança e remove cobranças puladas e alteradas manualmente. Para mover só a próxima cobrança, use Set subscription next charge date.
- Cancelar assinaturaPOSTCancela uma assinatura ativa e a retorna. O Recharge pode enviar e-mail ao cliente e ao dono da loja sobre isso, a menos que send_email seja false.
- Reativar assinaturaPOSTReativa uma assinatura cancelada e a retorna, limpando a data e o motivo do cancelamento.
- Definir data da próxima cobrançaPOSTMove a próxima cobrança de uma assinatura para outra data e retorna a assinatura. Quando duas assinaturas ativas do mesmo endereço ficam na mesma data, suas cobranças são unidas em uma nova cobrança com um novo id.
- Listar clientesGETLista os clientes da loja com e-mail, nome, a quantidade de assinaturas ativas e se o meio de pagamento é válido ou está em cobrança de recuperação (dunning). Filtre por e-mail para achar um cliente. Até 250 por página: envie o next_cursor da resposta como cursor.
- Consultar clienteGETRetorna um cliente. Com include, a resposta também traz os endereços, assinaturas ou meios de pagamento do cliente; o id de cada endereço é o address_id que Create subscription recebe.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
