Listar assinaturas no Stripe, por uma API

Lista 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.

Identificador
stripe_list_subscriptions

A chamada

POST https://connect.reportei.com/api/tools/stripe_list_subscriptions/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "customer": "<customer>"
  }
}

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
customerstringNãoOnly the subscriptions of this customer, the cus_ id from Search customers.
pricestringNãoOnly the subscriptions with this price, the price_ id in items.data.price.id of a subscription returned by List subscriptions or Search subscriptions.
statusstringNãoOnly the subscriptions in this status. all includes the canceled ones, and ended means canceled or incomplete_expired.Valores: active, all, canceled, ended, incomplete, incomplete_expired, past_due, paused, trialing, unpaid
limitintegerNãoSubscriptions per page, from 1 to 100. The default is 10.
starting_afterstringNãoId of the last subscription of the previous page, to get the next page.

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_list_subscriptions. 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.