Hosted checkout URL query parameters
Append query parameters to hosted checkout launch URLs to pass information about a customer and items to a checkout.
You can use hosted checkouts to let users securely make purchases outside your mobile app. Each hosted checkout has a unique link that you can add to your app to let customers open a checkout that's fully hosted by Paddle.
Hosted checkout parameters also work with the Paddle in-app checkout starter kit, which you can use to deploy your own mobile purchase workflow.
For maximum compatibility across browsers, make sure to percent-encode query strings. For example, pass
max%2Bpaddle%40example.com
formax+paddle@example.com
.
Parameters
Paddle ID of the price for the item that this hosted checkout is for. Pass a comma-separated list of price IDs to open a checkout for multiple prices.
Paddle ID of the customer for this checkout. Use if you know the customer, like if they're authenticated and making a change to their subscription. You can't use if you're passing user_email
.
Email for this customer. You can't use if you're passing paddle_customer_id
.
Two-letter ISO 3166 country code for this customer.
ZIP or postal code of this address. Paddle Checkout only asks for this in countries with postal codes.
Unique identifier for this customer in RevenueCat. Used for fulfilment using entitlements in RevenueCat.
Paddle ID of an existing transaction to use for this checkout. Use this to create a transaction on your backend and pass to checkout, instead of passing price_id
and customer details.
Examples
This example passes a price ID to Paddle Checkout to specify what the customer is purchasing.
11https://pay.paddle.io/checkout/hsc_01jt8s46kx4nv91002z7vy4ecj_1as3scas9cascascasasx23dsa3asd2a?price_id=pri_01h1vjg3sqjj1y9tvazkdqe5vt
This example passes two price IDs to Paddle Checkout to specify that a customer is purchasing two items. The separating comma is percent-encoded.
11https://pay.paddle.io/checkout/hsc_01jt8s46kx4nv91002z7vy4ecj_1as3scas9cascascasasx23dsa3asd2a?price_id=pri_01h1vjg3sqjj1y9tvazkdqe5vt%2Cpri_01hv0vax6rv18t4tamj848ne4d
This example passes a price ID to specify Paddle Checkout what the customer is purchasing, along with a user email address. The email address is percent-encoded.
11https://pay.paddle.io/checkout/hsc_01jt8s46kx4nv91002z7vy4ecj_1as3scas9cascascasasx23dsa3asd2a?price_id=pri_01h1vjg3sqjj1y9tvazkdqe5vt&user_email=sam%40example.com