Skip to content

Checkout Query Parameters

When you use an API to request a checkout there are a number of required and optional queries. Some apply to all checkouts and some apply to only Paddle checkouts.

Global Parameters

Parameter Description Type Required Notes
globalSuccessUrl URL to send users if they have successfully completed a purchase string 🇽 It must be an absolute URL. Default is the current URL.
globalCancelUrl The URL to send users to if the transaction fails. string ✅ It must be an absolute URL.
globalGranteeId Value to use as granteeId on all plans string ✅
member The member ID of the purchaser string ✅ GranteeId will attach to this value.
marketingConsent string 🇽 Allowed values '1' for true or '0' for false.
couponCode Optional Code to offer discounts. The Code must be set in your payment provider. Boolean 🇽
customerEmail Pre fills customer email in checkout string 🇽

If you are using Paddle as your payment system there are some extra options that you can add. These allow you to pre-fill the checkout form with your user's information or add a custom message to show on the checkout screen.

Paddle Specific Parameters

Parameter Description Type Required
customerCountry Pre-fill the checkout form with the customer's country string 🇽
customerPostcode Pre-fill the checkout form with the customer's postcode string 🇽
vatNumber Pre-fill the checkout form with the customer's VAT number string 🇽
vatCompanyName Pre-fill the checkout form with the customer's Company Name for VAT string 🇽
vatStreet Pre-fill the checkout form with the customer's Street for VAT string 🇽
vatCity Pre-fill the checkout form with the customer's city for VAT string 🇽
vatState Pre-fill the checkout form with the customer's state for VAT string 🇽
vatCountry Pre-fill the checkout form with the customer's country for VAT string 🇽
vatPostcode Pre-fill the checkout form with the customer's postcode for VAT string 🇽
customMessage Add a message to show in Paddle checkout string 🇽