Atualizar assinatura no Stripe, por uma API
Atualiza uma assinatura, por exemplo para cancelá-la no fim do período atual com cancel_at_period_end, ou para desfazer isso. Alterar os itens ou preços da assinatura não está disponível aqui.
- Identificador
- stripe_update_subscription
A chamada
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>"
}
}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 |
|---|---|---|---|
| subscription | string | Sim | Id of the subscription, starting with sub_, from List subscriptions or Search subscriptions. |
| cancel_at_period_end | boolean | Não | true cancels the subscription at the end of the current period, and false undoes a cancellation scheduled this way. |
| cancel_at | integer | Não | Unix timestamp, in seconds, at which the subscription is canceled. A date before the end of the current period prorates according to proration_behavior. |
| description | string | Não | Description of the subscription, shown to the customer. |
| trial_end | string | Não | End of the trial, as a Unix timestamp in seconds, or now to end the trial right away. |
| collection_method | string | Não | charge_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_due | integer | Não | Days the customer has to pay each invoice. Only with collection_method send_invoice. |
| proration_behavior | string | Não | How 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 |
Conexões possíveis
O seu cliente conecta a conta do Stripe 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/stripe_update_subscription. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Stripe
- Buscar clientesGETBusca clientes com a linguagem de consulta de busca do Stripe, por email, nome, telefone, data de criação ou metadata. A resposta traz data, has_more e next_page; envie next_page como page para a próxima página. Um cliente criado ou atualizado no último minuto pode ainda não aparecer.
- Obter clienteGETRetorna um cliente, com nome, email, telefone, endereço, saldo em centavos e configurações de fatura. Um cliente excluído volta apenas com id e deleted true.
- Criar clientePOSTCria um cliente. Nenhum campo é obrigatório, mas o Stripe só envia faturas e recibos a clientes com email. Endereço, tax ids e metadata não estão disponíveis aqui.
- Atualizar clientePOSTAtualiza o nome, o email, o telefone ou a descrição de um cliente. Os campos não enviados permanecem como estão.
- Buscar cobrançasGETBusca as cobranças, que são as tentativas de pagamento com status, valor, reembolsos e disputas, com a linguagem de consulta de busca do Stripe. Os valores estão na menor unidade da moeda, como centavos. A resposta traz data, has_more e next_page; envie next_page como page para a próxima página.
- Listar assinaturasGETLista as assinaturas, da mais nova à mais antiga, opcionalmente de um cliente, um preço ou um status. Sem status, assinaturas canceladas ficam de fora. Cada assinatura traz seus preços em items.data. Pagine com starting_after enquanto has_more for true.
- Buscar assinaturasGETBusca assinaturas por status, data de criação, data de cancelamento ou metadata com a linguagem de consulta de busca do Stripe, o que serve para perguntas como assinaturas novas ou canceladas em um período. A resposta traz data, has_more e next_page; envie next_page como page para a próxima página.
- Buscar faturasGETBusca faturas por cliente, assinatura, status, data, total ou número com a linguagem de consulta de busca do Stripe. Os valores estão na menor unidade da moeda, como centavos. A resposta traz data, has_more e next_page; envie next_page como page para a próxima página.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.

Conta Azul