Stripe Parameters

Parameters are used to pass information from one page to another. This is a common practice in web development and it's an important part of the integration between Ultimate Member and Stripe. It has several purposes:

  1. Data Transfer: The parameter allows you to pass data (in this case, the Stripe checkout session ID) from the page that initiated the payment process to the "stripe-payment-successful" page. This way, the successful payment page can retrieve and use this information.
  2. Dynamic Content: By using parameters, you can dynamically generate content on the "stripe-payment-successful" page based on the specific checkout session ID. This is particularly useful when you want to display transaction details or other relevant information related to a specific payment.
  3. Server-Side Processing: The server handling the "stripe-payment-successful" page can use the provided session ID to retrieve additional details from the server side (such as payment confirmation, transaction history, etc.).
  4. Tracking and Analytics: Parameters can also be used for tracking purposes, helping you understand the flow of users and their interactions on your site.

Ultimate Member Stripe Extension requires these parameters to integrate Stripe with Ultimate Member:

Parameters Attribute Description
?umm_stripe_sid={CHECKOUT_SESSION_ID} This checkout URL parameter attribute is added to the Stripe success page URL of your website, in the Stripe payment link setting to redirect your customers to your website. You can read more info here.

Example: https://yoursite.com/stripe-payment-successful/?umm_stripe_sid={CHECKOUT_SESSION_ID}
um_stripe_custom_checkout This parameter is added in the client reference ID, in the URL parameters of your product payment link.
?client_reference_id=um_stripe_custom_checkout This parameter is used to make the payment link compatible with the UM Stripe extension. It is added to the payment link of your product. 

Example: https://buy.stripe.com/test_3cs3dk77sf2o5tmfYZ?client_reference_id=um_stripe_custom_checkout
client-reference-id="um_stripe_custom_checkout” This attribute must be added to the Buy button code when adding the code to your site.
?umm_stripe_sid=UM_STRIPE_CHECKOUT_SID To ensure that users are redirected to the success page after successfully purchasing a product or subscription from your registration form, you need to add this parameter attribute to the payment successful page URL in the registration options. For a detailed guide on how to set up the redirection, please refer to this article.

Example: https://ultimate-member-32680-6296830.umsites.net/payment-successful/?umm_stripe_sid=UM_STRIPE_CHECKOUT_SID
redirect_to This parameter is used to specify the URL to which users should be redirected after completing a certain action. The redirect_to parameter in the "Switch to this Plan URL" allows you to customize where users are sent after they confirm their plan selection.

For example, if you want users to be redirected to a specific page on your site after they switch their subscription plan, you can add the redirect_to parameter with the desired URL. This gives you the flexibility to control the user experience and guide users to relevant pages based on their actions. You can read more info here.

Example: https://um.x/checkout/NTFkOTJiZTFjNjBkMWRiMWQyZTVlN2EwN2RhNTViMjY?switch=1&redirect_to=https://um.x/account/