Stripe Settings

Overview

Effortless online payments are essential for modern e-commerce and digital businesses, especially when managing memberships and subscriptions. The Stripe Settings feature provides a powerful, secure, and customizable payment processing solution. With these settings, you can tailor your Stripe integration to fit your specific business requirements, including managing recurring memberships and subscriptions and ensuring smooth and reliable transactions.

Stripe Settings

To configure your Stripe settings, navigate to: wp-admin > Ultimate Member > Settings > Extension > Stripe. Here you’ll find the following options:

Sandbox/Test Mode

Toggle this setting to switch between test mode and live mode. When Sandbox/Text Mode is  enabled or checked, the Test Publishable Key and Test Secret Key fields will be displayed.

Test Publishable Key

You can enter your Stripe test publishable key here. This key is used when operating in test mode.

Test Secret Key

Enter your Stripe test secret key here. It is recommended to use this key for local or staging sites during testing.

When Sandbox/Text Mode is  disabled, the Live Publishable Key and Live Restricted or Secret Key fields will appear.

Live Publishable Key

Enter your Stripe live publishable key here. This key is used for live transactions.

Live Restricted or Secret Key

Enter your Stripe live restricted key or secret key here. For live sites, using a restricted key is recommended for enhanced security.

Buttons

  • Connect with Stripe - When you enter the keys in their designated fields, this button becomes available. When clicked, it triggers the Stripe extension to create a new webhook endpoint for your Stripe account settings.


    If connected successfully, it will display these buttons:

    • Disconnect Stripe Account - Click this button to disconnect your site from your Stripe account.
    • Import Prices from Your Stripe Account - Clicking this button imports pricing data from your Stripe account. Imported prices will appear in a scroll box and create Ultimate Member Stripe Plans, each with unique settings for role assignment based on subscription status. For more details about this setting, go to this article.
    • Re-Sync All Users Subscriptions & Roles - When clicked, this button will scan for any missing user roles or statuses based on their current subscription status. It will then fix and reapply the correct roles and statuses according to active subscriptions.

Stripe API Version

Select the Stripe API version to be used by this webhook endpoint. This version determines how Stripe processes requests and responses for events sent to your site.

  • 2025-02-24.acacia - v17.1.1-stripe-php-lib: Recommended. Uses the latest API features and improvements.
  • 2022-11-15 (legacy) - v10.0.0-stripe-php-lib: For compatibility with older integrations.

Note: Ensure the selected API version matches your Stripe account’s webhook version settings to avoid processing issues.Webhook Endpoints

When you click the "Connect with Stripe" button, the webhook endpoint will be automatically integrated into your Stripe account. If this process is unsuccessful, you can manually copy the webhook endpoint from this setting and paste it into your Stripe account.

Replace Existing Roles When Subscription Status Changes

By default, when a user's subscription status changes in the Stripe module, their existing role is merged with their new role. However, you have the option to modify this behaviour and replace the user's existing role with their new role instead. If you enable or check this setting, it will replace all existing roles. If you're logged in as an administrator, your role will remain unaffected.

Test Clock

This setting must be enabled if you’re testing your integration using Stripe’s test clocks. It will create a Stripe customer specifically for your test clock. Note that the Test Clock setting only appears when Sandbox/Test Mode is enabled. When this setting is checked or enabled, a field will appear where you can enter the Test Clock ID.

Disable Activity Logs

If this setting is checked or enabled, the activity logs will be disabled. The activity logs feature provides a comprehensive log of all user activities associated with their subscription and onboarding process for User Registrations. It records all the details related to Stripe fields or direct Subscribe URLs. The activity log allows users to keep track of all their activities, including subscriptions, payments, and other related operations.

Stripe Embedded Checkout

By default, when a user makes a purchase or checks out from your website, they will be redirected to a secure, Stripe-hosted checkout page. This checkout page is designed to help users complete their transactions quickly and easily. However, if you prefer to embed the checkout form directly on your website, you can enable this setting. This will allow users to complete their purchase without having to leave your site.

Stripe Cancellation Page

This setting allows administrators to manage how recurring user subscriptions are handled upon cancellation. By default, users cancel subscriptions via the Stripe-hosted customer portal. To allow cancellations directly on your website, you need to manually enable this setting. This setting provides a seamless and transparent cancellation process directly on your site, giving users more control and flexibility in managing their subscriptions. For more details about this setting or feature, please refer to this article.

Display Tax Option in Stripe Plan Settings

When enabled, this setting adds a “Display Tax on Stripe Checkout Form” option to each Stripe Plan’s settings. This allows you to control whether tax amounts are shown to users on the Stripe-hosted checkout form for that specific plan.

Enable an Option to Change Payment Collection Method

When enabled, this setting adds an option to the Account form under the Billings tab, allowing users to change their payment collection method (e.g., automatic or manual collection for invoices) for their active Stripe subscription.

If this option is enabled, an additional setting will appear:

Invoice Days Until Due

Specify the number of days a customer has to pay invoices generated by a subscription when the payment collection method is set to manual.

  • Default value: 10
  • This value determines how long a customer has to settle their invoice before it’s considered overdue.