Stripe tools
The 12 Stripe operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- Search customersGETSearches the customers with the Stripe search query language, by email, name, phone, creation date or metadata. The response has data, has_more and next_page; send next_page as page to get the next page. A customer created or updated in the last minute may not show up yet.
- Get customerGETReturns one customer, with name, email, phone, address, balance in cents and invoice settings. A deleted customer comes back with only id and deleted set to true.
- Create customerPOSTCreates a customer. No field is required, but Stripe sends invoices and receipts only to customers with an email. Address, tax ids and metadata are not available here.
- Update customerPOSTUpdates the name, email, phone or description of a customer. Fields not sent stay as they are.
- Search chargesGETSearches the charges, which are the payment attempts with their status, amount, refunds and disputes, with the Stripe search query language. Amounts are in the smallest unit of the currency, like cents. The response has data, has_more and next_page; send next_page as page to get the next page.
- List subscriptionsGETLists the subscriptions, newest first, optionally of one customer, one price or one status. Without status, canceled subscriptions are left out. Each subscription has its prices in items.data. Page with starting_after while has_more is true.
- Search subscriptionsGETSearches the subscriptions by status, creation date, cancellation date or metadata with the Stripe search query language, which fits questions like new or canceled subscriptions in a period. The response has data, has_more and next_page; send next_page as page to get the next page.
- Update subscriptionPOSTUpdates a subscription, for example to cancel it at the end of the current period with cancel_at_period_end, or to undo that. Changing the items or prices of the subscription is not available here.
- Search invoicesGETSearches the invoices by customer, subscription, status, date, total or number with the Stripe search query language. Amounts are in the smallest unit of the currency, like cents. The response has data, has_more and next_page; send next_page as page to get the next page.
- Create invoicePOSTCreates a draft invoice for a customer. Add the lines with Create invoice item, then email it with Send invoice. With collection_method send_invoice, send days_until_due or due_date.
- Create invoice itemPOSTAdds a line to a draft invoice, with a description and an amount in the smallest unit of the currency, like cents. Send amount, or unit_amount_decimal with quantity. Without invoice, the line waits for the next invoice of the customer.
- Send invoicePOSTFinalizes a draft invoice and emails it to the customer with payment instructions. A finalized invoice can no longer change its amounts. In a sandbox no email goes out.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.

Conta Azul