Skip to main content

API Settings

To access the API Settings page, navigate to WooCommerce > Stripe by Payment Plugins > Settings in your WordPress admin dashboard, or visit:

https://your-site.com/wp-admin/admin.php?page=wc-settings&tab=checkout&section=stripe_api

The API Settings page is where you control your connection to the Stripe Test and Live environments, manage your webhooks, and configure logging settings. This is the foundation of your Stripe integration – every payment, webhook notification, and debugging feature depends on the configurations you set here.

Here you'll establish secure connections to Stripe's systems, configure how your site communicates with Stripe through webhooks, and set up the logging tools that help you troubleshoot issues when they arise. Whether you're testing new features in test mode or processing real transactions in live mode, these settings ensure your Stripe integration runs smoothly and securely.

Mode

Controls whether you are processing real transactions or test transactions. Test mode allows you to simulate payments so you can test your integration without handling actual money, while live mode processes real transactions with actual payments. You can switch between modes at any time, and the plugin will automatically show the appropriate connection settings for your selected mode.

Default: Test

Account ID

This is your Stripe Account ID and serves as a unique identifier for your Stripe account. The Account ID is automatically populated when you connect to Stripe, whether using the "Connect Stripe Account" button or by manually entering your API keys, and helps the plugin identify which Stripe account to communicate with during API operations.

Default: Empty (populated automatically upon connection)

Connect Stripe Account

Establishes the secure connection between your WooCommerce store and your Stripe account. When you click "Click to Connect," you'll be taken through an easy connect flow that allows you to log in to your Stripe account and authorize the plugin to access your account. This connection provides the plugin with the necessary credentials to process payments and communicate with Stripe's systems securely. When your Stripe account is connected, a green checkmark will display.

Default: Not connected (requires manual action)

Test Publishable Key

Your publishable key is used to initialize Stripe assets on the frontend of your website. This key is safe to include in client-side code and is used to create payment forms, collect card information securely, and communicate with Stripe's client-side libraries. The test publishable key is only used when operating in test mode.

Default: Empty (populated automatically upon connection or entered manually)

Test Secret Key

Your secret key is used to authenticate requests to Stripe from your server. This sensitive credential acts like a password for your Stripe integration and should be kept confidential. It's used for server-side operations like creating charges, refunding payments, and managing customer data. The test secret key is only used when operating in test mode.

Default: Empty (populated automatically upon connection or entered manually)

Connection Test

Click this button to perform a connection test between your WooCommerce store and Stripe. If successful, your site is properly connected to Stripe and can communicate with their API. This test verifies that your API credentials are valid and that your server can reach Stripe's servers. The test will use the appropriate credentials based on your current mode setting.

Default: Available after credentials are configured

Create Webhook

Sets up automatic communication between Stripe and your WooCommerce store for real-time payment updates. Webhooks allow Stripe to instantly notify your store when payment events occur, such as when a payment completes, fails, or requires additional authentication. Webhooks are created automatically when using the OAuth connect flow, but you can use this button to manually create webhooks if you've manually entered your API keys.

Default: Webhooks are created automatically during the OAuth connect process or can be created manually by clicking this button

Webhook URL

Displays the unique URL that Stripe uses to send webhook notifications to your store. This URL is automatically generated by the plugin based on your site's structure and cannot be modified. You'll need to use this URL if you're manually creating webhooks in your Stripe Dashboard instead of using the plugin's automatic webhook creation feature.

Default: Automatically generated based on your site's URL

Live Webhook Secret

The webhook secret is used to authenticate webhooks sent from Stripe to ensure that no third party can send you fake events pretending to be Stripe. This security measure verifies that webhook notifications are genuinely coming from Stripe. The live webhook secret is used to process live mode webhook events and should be kept confidential. For detailed instructions on where to find your webhook secret, see our webhook secret guide.

Default: Empty (obtained when creating webhooks)

Test Webhook Secret

The webhook secret is used to authenticate webhooks sent from Stripe to ensure that no third party can send you fake events pretending to be Stripe. This security measure verifies that webhook notifications are genuinely coming from Stripe. The test webhook secret is used when testing in test mode and helps you verify webhook functionality during development. For detailed instructions on where to find your webhook secret, see our webhook secret guide.

Default: Empty (obtained when creating webhooks)

Debug Log

When enabled, the plugin logs important errors and information that can help you troubleshoot potential issues with your Stripe integration. These logs capture API communications, payment processing details, and error messages that can be invaluable when diagnosing problems. The debug logs can be accessed through WooCommerce > Status > Logs > wc-stripe.

Default: Enabled

Example of a log entry showing a failed webhook notification.