Use a Stripe CLI

O Stripe CLI permite que você crie, teste e gerencie sua integração com a Stripe a partir da linha de comando. Com o CLI, você pode criar e gerenciar recursos da Stripe, acionar eventos de webhook, transmitir logs de solicitações de API em tempo real e encaminhar eventos para seu ambiente de desenvolvimento local.

Especificar uma versão da API durante a execução de solicitações

Ao chamar as APIs da Stripe no CLI, ele usa a versão padrão da API em todas as solicitações, que você pode identificar no Workbench. Para testar diferentes versões da API no CLI, use as seguintes sinalizações:

Você também pode ver uma lista de versões da API.

Transmitir logs de solicitação

Use o comando stripe logs tail para transmitir logs de solicitações de API. Mantenha esta janela aberta. Se ocorrer um erro nas suas chamadas de API, este terminal retornará a mensagem de erro da API e o motivo do erro.

stripe logs tail

Encaminhe eventos para seu endpoint webhook local

Use o sinalizador --forward-to para enviar todos os eventos da Stripe em uma área restrita para o seu endpoint webhook local. Para desabilitar a verificação de certificado HTTPS, use flag --skip-verify.

stripe listen --forward-to localhost:4242/webhooks

Ready! Your webhook signing secret is '{{WEBHOOK_SIGNING_SECRET}}' (^C to quit)

Para encaminhar eventos específicos em uma lista separada por vírgulas, use o sinalizador --events.

stripe listen --events payment_intent.created,customer.created,payment_intent.succeeded,charge.succeeded,checkout.session.completed,charge.failed \
  --forward-to localhost:4242/webhook

Se você já registou o seu endpoint na Stripe, poderá usar os sinalizadores --load-from-webhooks-api e --forward-to.

stripe listen --load-from-webhooks-api --forward-to localhost:4242

Este comando encaminha os eventos enviados ao seu endpoint de webhook público registrado no Stripe para o seu endpoint de webhook local. Ele carrega o endpoint registrado, analisa o caminho e os eventos registrados e, em seguida, anexa o caminho ao seu endpoint de webhook local no caminho --forward-to. Se estiver verificando assinaturas de webhook, use o {{WEBHOOK_SIGNING_SECRET}} da saída inicial do comando listen.

Listar todos os eventos disponíveis

Use o sinalizador de ajuda (--help) para listar todos os eventos possíveis que podem ocorrer para uma categoria de evento. Por exemplo, para listar todos os eventos possíveis para a página de checkout pré-criada do Stripe Checkout:

stripe trigger checkout --help

Crie um produto e um preço únicos

1. Faça uma única solicitação de API para criar um produto.

   Command Line

   stripe products create \
   --name="My First Product" \
   --description="Created with the Stripe CLI"

2. Procure o identificador do produto (em id) no objeto de resposta. Salve-o para a próxima etapa. Se tudo funcionou, a linha de comando exibirá a seguinte resposta:

   {
     "id": 
   "prod_LTenIrmp8Q67sa",
     "object": "product",

   Ver todas as 25 linhas

3. Chame Criar um preço para anexar um preço de US$ 30. Troque o espaço reservado em product pelo seu identificador de produto (por exemplo, prod_LTenIrmp8Q67sa).

   Command Line

   stripe prices create \
     --unit-amount=3000 \
     --currency=usd \
     --product=
   "{{PRODUCT_ID}}"

4. Se tudo funcionar, a linha de comando exibirá a seguinte resposta:

   {
     "id": 
   "price_1KzlAMJJDeE9fu01WMJJr79o",
     "object": "price",

   Ver todas as 20 linhas

Acionar um evento de Webhook durante o teste

Acione o evento checkout.session.completed para criar os objetos de API que resultam da conclusão de uma sessão de checkout.

stripe trigger checkout.session.completed

Seu terminal stripe listen exibe a seguinte saída:

Setting up fixture for: checkout_session
Running fixture for: checkout_session
Setting up fixture for: payment_page
Running fixture for: payment_page
Setting up fixture for: payment_method
Running fixture for: payment_method
Setting up fixture for: payment_page_confirm
Running fixture for: payment_page_confirm
Trigger succeeded!