Skip to content

Stripe Operations Reference

This page covers the parameters and expected output for each operation available in the Stripe integration.

Get Balance

Retrieves the current balance for your Stripe account, including available and pending amounts across all currencies.

This operation has no input parameters.

Returns the balance object, including livemode status, available amount, and pending amount.

List Customers

Retrieves a list of customers from your Stripe account.

Parameter Description Type Required/Optional
Limit The maximum number of customers to return. Defaults to 10. integer Required.
Email The email address to filter customers by. string Optional.

Returns a list of customer objects, including contact details, balance, currency, and account metadata, along with a hasMore flag indicating additional records.

Create Customer

Creates a new customer record in Stripe.

Parameter Description Type Required/Optional
Email The customer's email address. string Required.
Name The customer's full name. string Required.
Phone Number The customer's phone number. string Optional.
Description A description of the customer. string Optional.

Returns the created customer object, including the customer ID, contact details, balance, currency, and account metadata.

Get Customer

Retrieves the details of an existing Stripe customer.

Parameter Description Type Required/Optional
Customer ID The Stripe customer ID (e.g., cus_xxxxx) to retrieve.

To get the customer ID, go to the customer page in the Stripe dashboard. The ID appears after /customers/ in the URL (e.g., https://dashboard.stripe.com/acctxxxx/test/customers/cus_UfjdzVYlGjM4Rg). Or to get this value programmatically, use List Customers and copy the id from the response.		 string Required.

Returns the customer object, including contact details, balance, currency, and account metadata.

Update Customer

Updates an existing customer record in Stripe.

Parameter Description Type Required/Optional
Customer ID The Stripe customer ID (e.g., cus_xxxxx) to update.

To get the customer ID, go to the customer page in the Stripe dashboard. The ID appears after /customers/ in the URL (e.g., https://dashboard.stripe.com/acctxxxx/test/customers/cus_UfjdzVYlGjM4Rg). Or to get this value programmatically, use List Customers and copy the id from the response.		 string Required.
Email The updated email address for the customer. string Optional.
Name The updated name for the customer. string Optional.
Phone Number The updated phone number for the customer. string Optional.
Description The updated description for the customer. string Optional.

Returns the updated customer object, including contact details, balance, currency, and account metadata.

Delete Customer

Deletes an existing customer record from Stripe.

Parameter Description Type Required/Optional
Customer ID The Stripe customer ID (e.g., cus_xxxxx) to delete.

To get the customer ID, go to the customer page in the Stripe dashboard. The ID appears after /customers/ in the URL (e.g., https://dashboard.stripe.com/acctxxxx/test/customers/cus_UfjdzVYlGjM4Rg). Or to get this value programmatically, use List Customers and copy the id from the response.		 string Required.

Returns the deleted customer object, including the customer ID and a deleted confirmation flag.

Create Coupon

Creates a new coupon in Stripe.

Parameter Description Type Required/Optional
ID The arbitrary unique coupon ID or code (e.g., SUMMER2024). string Required.
Percent Off The percentage discount to apply, between 0 and 100. Required if Amount Off is not provided. integer Optional.
Amount Off The discount amount in cents. Required if Percent Off is not provided. integer Optional.
Currency The currency for the discount. Required if Amount Off is provided. string Optional.
Duration How long the coupon applies. Supported values:
  • forever
  • once
  • repeating
 string Optional.
Duration in Months The number of months the coupon applies. Required if Duration is set to repeating. string Optional.
Name A display name for the coupon. string Optional.

Returns the created coupon object, including the coupon ID, discount details, duration, redemption count, and validity status.

List Coupons

Retrieves a list of coupons from your Stripe account.

Parameter Description Type Required/Optional
Limit The maximum number of coupons to return. Defaults to 10. integer Required.

Returns a list of coupon objects, including discount details, duration, redemption count, and validity status, along with a hasMore flag indicating additional records.

Create Payment Intent

Creates a new payment intent in Stripe.

Parameter Description Type Required/Optional
Amount The payment amount in cents (e.g., 1000 = $10.00). integer Required.
Currency The three-letter ISO currency code (e.g., usd, eur, gbp). string Required.
Customer ID The Stripe customer ID (e.g., cus_xxxxx) to associate with payment.

To get the customer ID, go to the customer page in the Stripe dashboard. The ID appears after /customers/ in the URL (e.g., https://dashboard.stripe.com/acctxxxx/test/customers/cus_UfjdzVYlGjM4Rg). Or to get this value programmatically, use List Customers and copy the id from the response.		 string Optional.
Description A description of the payment. string Optional.

Returns the created payment intent object, including the payment intent ID, amount, currency, status, client secret, and capture and confirmation methods.

Get Payment Intent

Retrieves the details of an existing Stripe payment intent.

Parameter Description Type Required/Optional
Payment Intent ID The Stripe payment intent ID (e.g., pi_xxxxx) to retrieve.

To get the payment intent ID, go to the Transactions > Payments page in the Stripe dashboard. The ID appears in the Description column. Alternatively, use Create Payment Intent and copy the id from the response.		 string Required.

Returns the payment intent object, including the amount, currency, status, customer ID, client secret, and capture and confirmation methods.

Cancel Payment Intent

Cancels an existing Stripe payment intent.

Parameter Description Type Required/Optional
Payment Intent ID The Stripe payment intent ID (e.g., pi_xxxxx) to cancel.

To get the payment intent ID, go to the Transactions > Payments page in the Stripe dashboard. The ID appears in the Description column. Alternatively, use Create Payment Intent and copy the id from the response.		 string Required.

Returns the cancelled payment intent object, including the amount, currency, status, customer ID, and cancellation timestamp.

List Charges

Retrieves a list of charges from your Stripe account.

Parameter Description Type Required/Optional
Limit The maximum number of charges to return. Defaults to 10. integer Required.
Customer ID The Stripe customer ID (e.g., cus_xxxxx) to list charges for.

To get the customer ID, go to the customer page in the Stripe dashboard. The ID appears after /customers/ in the URL (e.g., https://dashboard.stripe.com/acctxxxx/test/customers/cus_UfjdzVYlGjM4Rg). Or to get this value programmatically, use List Customers and copy the id from the response.		 string Optional.

Returns a list of charge objects, including charge ID, amount, currency, status, payment details, and receipt URL, along with a hasMore flag indicating additional records.

Create Charge

Creates a new charge in Stripe.

Parameter Description Type Required/Optional
Amount The charge amount in cents. integer Required.
Currency The three-letter ISO currency code (e.g., usd, eur, gbp). string Required.
Source The payment source. Accepts a one-time token (tok_…), a saved card (card_…), or a saved bank account (ba_…) attached to a customer.
  • In test mode, use Stripe's built-in test tokens (e.g., tok_visa, tok_mastercard, tok_chargeDeclined). No frontend needed.
  • In production, pass the token (tok_...) generated by Stripe.js when a customer enters their card details on your frontend.
  • Saved card/bank (card_… /ba_…): Must be used together with the Customer parameter.
At least one of the parameters (Source or Customer) is required.		 string Optional.
Customer The Stripe Customer ID (cus_…) to charge.
  • Use alone if the customer has a default payment method saved in Stripe.
  • Required when Source is a saved card (card_…) or bank account (ba_…).
  • To get the customer ID, go to the customer page in the Stripe dashboard. The ID appears after /customers/ in the URL (e.g., https://dashboard.stripe.com/acctxxxx/test/customers/cus_UfjdzVYlGjM4Rg). Or to get this value programmatically, use List Customers and copy the id from the response.
At least one of the parameters (Source or Customer) is required.		 string Optional.
Description A description of the charge. string Optional.

Returns the created charge object, including the charge ID, amount, currency, status, payment details, and receipt URL.

Update Charge

Updates an existing charge in Stripe.

Parameter Description Type Required/Optional
Charge ID The Stripe charge ID (e.g., ch_xxxxx) to update.

To get the charge ID, go to the Transactions > Payments page in the Stripe dashboard. The ID appears in the Description column. Alternatively, use List Charges and copy the id from the response.		 string Required.
Description The updated description for the charge. string Optional.

Returns the updated charge object, including the charge ID, amount, currency, status, payment details, and receipt URL.

Get Charge

Retrieves the details of an existing Stripe charge.

Parameter Description Type Required/Optional
Charge ID The Stripe charge ID (e.g., ch_xxxxx) to retrieve.

To get the charge ID, go to the Transactions > Payments page in the Stripe dashboard. The ID appears in the Description column. Alternatively, use List Charges and copy the id from the response.		 string Required.

Returns the charge object, including the amount, currency, status, payment details, and receipt URL.

Create Refund

Creates a refund for an existing Stripe charge.

Parameter Description Type Required/Optional
Charge ID The Stripe charge ID (e.g., ch_xxxxx) to refund.

To get the charge ID, go to the Transactions > Payments page in the Stripe dashboard. The ID appears in the Description column. Alternatively, use List Charges and copy the id from the response.		 string Required.
Amount The refund amount in cents. Defaults to the full charge amount. integer Optional.
Reason The reason for the refund. Supported values:
  • duplicate
  • fraudulent
  • requested_by_customer
 string Optional.

Returns the created refund object, including the refund ID, amount, currency, status, and associated charge ID.

Get Refund

Retrieves the details of an existing Stripe refund.

Parameter Description Type Required/Optional
Refund ID The Stripe refund ID (e.g., re_xxxxx). To get this value, use Create Refund and copy the id from the response. string Required.

Returns the refund object, including the amount, currency, status, reason, and associated charge ID.

Attach Payment Method

Attaches a payment method to an existing Stripe customer.

Parameter Description Type Required/Optional
Payment Method ID The Stripe payment method ID (e.g., pm_xxxxx).

To get the payment method ID, go to the Customers page, and select the customer, in the Stripe dashboard. Scroll to the Payment methods section, and click on the payment method; the ID is listed in the ID field.		 string Required.
Customer ID The Stripe customer ID (e.g., cus_xxxxx) to attach the payment method to.

To get the customer ID, go to the customer page in the Stripe dashboard. The ID appears after /customers/ in the URL (e.g., https://dashboard.stripe.com/acctxxxx/test/customers/cus_UfjdzVYlGjM4Rg). Or to get this value programmatically, use List Customers and copy the id from the response.		 string Required.

Returns the payment method object, including the payment method ID, type, customer ID, and livemode status.

Get Payment Method

Retrieves the details of an existing Stripe payment method.

Parameter Description Type Required/Optional
Payment Method ID The Stripe payment method ID (e.g., pm_xxxxx).

To get the payment method ID, go to the Customers page, and select the customer, in the Stripe dashboard. Scroll to the Payment methods section, and click on the payment method; the ID is listed in the ID field.		 string Required.

Returns the payment method object, including the payment method ID, type, customer ID, and livemode status.

Detach Payment Method

Detaches a payment method from a Stripe customer.

Parameter Description Type Required/Optional
Payment Method ID The Stripe payment method ID (e.g., pm_xxxxx).

To get the payment method ID, go to the Customers page, and select the customer, in the Stripe dashboard. Scroll to the Payment methods section, and click on the payment method; the ID is listed in the ID field.		 string Required.

Returns the detached payment method object, including the payment method ID, type, and a null customerId confirming detachment.

Create Meter Event

Creates a meter event to record usage in Stripe.

Parameter Description Type Required/Optional
Event Name The event name configured for your meter in Stripe.

To get the event name, go to Billing > Usage-based > Meters, in the Stripe dashboard. The event name is listed in the Event name column.		 string Required.
Customer ID The Stripe customer ID (e.g., cus_xxxxx).

To get the customer ID, go to the customer page in the Stripe dashboard. The ID appears after /customers/ in the URL (e.g., https://dashboard.stripe.com/acctxxxx/test/customers/cus_UfjdzVYlGjM4Rg). Or to get this value programmatically, use List Customers and copy the id from the response.		 string Required.
Identifier A unique idempotency key for the event. Re-submitting the same identifier will not double-count usage. string Optional.
Value The usage value to record (e.g., 1, 10). Required for sum, max, or average meters. Defaults to 1 for count meters. string Optional.
Timestamp The Unix timestamp of the event. Defaults to the current time if not provided. integer Optional.

Returns the created meter event object, including the event name, identifier, timestamp, and livemode status.