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âmetroTipoObrigatórioDescrição
subscriptionstringSimId of the subscription, starting with sub_, from List subscriptions or Search subscriptions.
cancel_at_period_endbooleanNãotrue cancels the subscription at the end of the current period, and false undoes a cancellation scheduled this way.
cancel_atintegerNãoUnix timestamp, in seconds, at which the subscription is canceled. A date before the end of the current period prorates according to proration_behavior.
descriptionstringNãoDescription of the subscription, shown to the customer.
trial_endstringNãoEnd of the trial, as a Unix timestamp in seconds, or now to end the trial right away.
collection_methodstringNãocharge_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_dueintegerNãoDays the customer has to pay each invoice. Only with collection_method send_invoice.
proration_behaviorstringNãoHow 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

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.