Connection
- Authentication: API key (Secret key (sk_live_/sk_test_…)).
Stripe Dashboard (dashboard.stripe.com) → Developers → API keys → reveal and copy the Secret key (sk_live_…), or click “Create restricted key” and grant only the resources the agent needs (Customers, PaymentIntents, Products, Prices, Subscriptions, Invoices, Refunds, Checkout Sessions — Read or Write). Use a sk_test_ key from Test mode to try things out safely.See Stripe’s documentation.
Read actions (28)
| Action | Description |
|---|---|
get_balance | Fetch the current available and pending account balance per currency. |
get_charge | Fetch a charge by ID, including outcome, receipt and refund state. |
get_checkout_session | Fetch a Checkout Session by ID, including its payment status and URL. |
get_credit_note | Fetch a credit note by ID, including amounts and the linked invoice. |
get_customer | Fetch a customer by ID, including balance and default payment settings. |
get_invoice | Fetch an invoice by ID, including line items, status and amounts. |
get_payment_intent | Fetch a PaymentIntent by ID, including its status and latest charge. |
get_payment_method | Fetch a PaymentMethod by ID, including its type and card/bank summary. |
get_price | Fetch a price by ID, including amount, currency and recurrence. |
get_product | Fetch a product by ID, including its default price and active flag. |
get_refund | Fetch a refund by ID, including its status and amount. |
get_setup_intent | Fetch a SetupIntent by ID, including its status and attached payment method. |
get_subscription | Fetch a subscription by ID, including status, items and billing period. |
list_balance_transactions | List balance transactions (charges, refunds, payouts, fees) on the account. |
list_charges | List charges, optionally filtered by customer or PaymentIntent. |
list_checkout_sessions | List Checkout Sessions, optionally filtered by customer, PaymentIntent or status. |
list_credit_notes | List credit notes, optionally filtered by customer or invoice. |
list_customers | List customers, optionally filtered by exact email. |
list_events | List recent account events (e.g. invoice.paid), optionally filtered by type. |
list_invoice_items | List invoice items, optionally filtered by customer or invoice. |
list_invoices | List invoices, optionally filtered by customer, subscription or status. |
list_payment_intents | List PaymentIntents, optionally filtered by customer. |
list_payment_methods | List the payment methods saved on a customer, optionally filtered by type. |
list_prices | List prices, optionally filtered by product or active flag. |
list_products | List products, optionally filtering to active ones only. |
list_refunds | List refunds, optionally filtered by charge or PaymentIntent. |
list_subscriptions | List subscriptions, optionally filtered by customer, price or status. |
search_customers | Search customers with the Stripe query language (e.g. email~“jane”). |
Write actions (33)
| Action | Description |
|---|---|
attach_payment_method | Attach a PaymentMethod to a customer for reuse. |
cancel_payment_intent | Cancel a PaymentIntent that has not been captured yet. |
cancel_setup_intent | Cancel a SetupIntent that has not succeeded yet. |
cancel_subscription | Cancel a subscription immediately (use update_subscription for end-of-period cancellation). |
capture_payment_intent | Capture the funds of a PaymentIntent authorized with manual capture. |
confirm_payment_intent | Confirm a PaymentIntent to attempt the payment with the attached payment method. |
create_checkout_session | Create a hosted Checkout Session and get a payment URL to share with the customer. |
create_credit_note | Issue a credit note against an invoice (refund, credit or out-of-band adjustment). |
create_customer | Create a customer to attach payments, subscriptions and invoices to. |
create_invoice | Create a draft invoice for a customer (pulls in pending invoice items). |
create_invoice_item | Add a one-off line item (charge or credit) to a customer’s next or a specific invoice. |
create_payment_intent | Create a PaymentIntent to collect a payment from a customer. |
create_payment_link | Create a reusable, shareable payment link from existing prices. |
create_payment_method | Create a PaymentMethod (card details require the account to allow raw card data). |
create_price | Create a one-time or recurring price for a product. |
create_product | Create a product to sell (attach prices to it afterwards). |
create_refund | Refund a charge or PaymentIntent, fully or partially. |
create_setup_intent | Create a SetupIntent to save a payment method for future charges. |
create_subscription | Create a subscription for a customer from one or more prices. |
delete_customer | Permanently delete a customer and cancel their active subscriptions. |
delete_invoice | Delete a draft invoice (finalized invoices must be voided instead). |
delete_invoice_item | Remove an invoice item that is not yet attached to a finalized invoice. |
delete_product | Delete a product that has no prices attached (otherwise archive it instead). |
detach_payment_method | Detach a PaymentMethod from its customer. |
expire_checkout_session | Expire an open Checkout Session so its URL can no longer be used. |
finalize_invoice | Finalize a draft invoice so it can be paid or sent. |
pay_invoice | Attempt payment of an open invoice with the customer’s default payment method. |
send_invoice | Email a finalized invoice to the customer for manual payment. |
update_customer | Update a customer’s email, name, phone, description or metadata. |
update_price | Update a price’s nickname or archive it (prices cannot be deleted, set active=false). |
update_product | Update a product’s name, description, default price or active flag. |
update_subscription | Update a subscription (e.g. schedule cancellation at period end or change payment method). |
void_invoice | Void a finalized invoice (similar to deletion but keeps the record). |