Docs

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.

All hosted checkout URL query parameters are optional. You can set defaults when creating a hosted checkout in Paddle > Checkout > Hosted Checkouts, like the prices to open the checkout with if no priceId or transactionId is passed. However, one is required if no default price is set.

Hosted checkout parameters also work with the Paddle mobile web payments starter kit, which you can use to deploy your own mobile purchase workflow.

Parameters

price_idstring
Example: pri_01gm81eqze2vmmvhpjg13bfeqg
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. If omitted and no transaction_id is passed, the default prices for the hosted checkout are used. Required if no default prices are set and no transaction_id is passed.
discount_codestring
Example: BF20OFF
Discount code to apply. Use to prepopulate a discount at checkout. Takes precedence over discount_id. If omitted, no discount is applied.
discount_idstring
Example: dsc_01gtf15svsqzgp9325ss4ebmwt
Paddle ID of a discount to apply. Use to prepopulate a discount at checkout. Ignored if discount_code is also passed. If omitted, no discount is applied.
paddle_customer_idstring
Example: ctm_01gm82kny0ad1tk358gxmsq87m
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.
user_emailstring
Email for this customer. You can't use if you're passing paddle_customer_id.
country_codestring
Example: US
Two-letter ISO 3166 country code for this customer.
postal_codestring
Example: 10021
ZIP or postal code of the address. Only asked for in countries with postal codes.
app_user_idstring
Unique identifier for this customer in RevenueCat. Used for fulfillment using entitlements in RevenueCat.
transaction_idstring
Example: txn_01gp3z8cfkqgdq07hcr3ja0q95
Paddle ID of an existing transaction. You can create a transaction on your backend and pass to checkout to use, instead of passing price_id and customer details. If omitted and no price_id is passed, the default prices for the hosted checkout are used. Required if no default prices are set and no price_id is passed.
localestring
Default: (browser default)
Language for the checkout.
Values
  • ar
    Arabic (العربية)
  • zh-Hans
    Chinese (Simplified) (简化字)
  • zh-TW
    Chinese (Traditional) (正體字)
  • da
    Danish (Dansk)
  • nl
    Dutch (Nederlands)
+ Show all values
  • en
    English
  • fr
    French (Français)
  • de
    German (Deutsch)
  • it
    Italian (Italiano)
  • ja
    Japanese (日本語)
  • ko
    Korean (한국어)
  • no
    Norwegian (Norsk)
  • pl
    Polish (Polski)
  • pt
    Portuguese (Português)
  • pt-BR
    Portuguese (Brazilian) (Português do Brasil)
  • tr
    Turkish (Türkçe)
  • ru
    Russian (Русский)
  • es
    Spanish (Español)
  • sv
    Swedish (Svenska)
themestring
Default: light
Theme for the checkout. If omitted, defaults to light.
Values
  • light
    Light-themed checkout.
  • dark
    Dark-themed checkout.
allowed_payment_methodsarray
Payment options presented to customers at checkout.
Values
  • alipay
    Alipay, popular in China.
  • apple_pay
    Apple Pay on a supported Apple device.
  • bancontact
    Bancontact, popular in Belgium.
  • blik
    BLIK, a popular payment method in Poland.
  • card
    Credit or debit card.
+ Show all values
  • google_pay
    Google Pay on a supported Android device, Chromebook, or Google Chrome browser.
  • ideal
    iDEAL, popular in the Netherlands.
  • kakao_pay
    Kakao Pay, a popular payment method in Korea.
  • mb_way
    MB WAY, a popular payment method in Portugal.
  • naver_pay
    Naver Pay, a popular payment method in Korea.
  • payco
    Payco, a popular payment method in Korea.
  • paypal
    PayPal.
  • pix
    Pix, popular in Brazil. Available in early access.
  • samsung_pay
    Samsung Pay, a popular payment method in Korea.
  • south_korea_local_card
    Korean local credit or debit card.
  • upi
    Unified Payments Interface (UPI), popular in India. Available in early access.
show_add_tax_idboolean
Default: true
Whether the option to add a tax number is displayed at checkout. Defaults to true.

Examples

Was this page helpful?