Pricing API

Retrieve, localize and calculate prices on the fly

Our existing Localized Prices API for Paddle.js already allows you to dynamically display a localized price on your page. This helps you avoid hardcoding prices, or showing the wrong currency to a user, which would hurt conversion.

This is a useful, but fairly simplistic solution. For a more advanced usage, use this Pricing API:

  • Easier batch price lookup: retrieve the prices of many products (for example your whole store page) in one single API call
  • Effortless custom localization: rather than letting us decide which price to return, pass the visitor IP or country code you want us to localize
  • No more coupon calculations: pass the coupon code and the price will automatically take it into account (this applies to one-time purchase products only)
  • On the server side: our Pricing API allows you to run these calls server side, which allows for greater control and flexibility than Paddle.js allows on the client side
  • For one-off and subscriptions: all business models are supported

Method: GET Endpoint: https://checkout.paddle.com/api/2.0/prices

Fields:

  • product_ids - A comma separated list of product (or subscription plan) IDs to return prices for.
  • customer_country - A two character country code (eg. GB) for localised pricing.
  • customer_ip - An IP address of the customer to return pricing for.
  • coupons - A comma separated list of coupon codes to apply to the product prices (currently unsupported with subscriptions).

Examples

Request - Single Product

https://checkout.paddle.com/api/2.0/prices?product_ids=123456&customer_country=GB

Response

{
    "success": true,
    "response": {
        "customer_country": "GB",
        "products": [
            {
                "product_id": 123456,
                "product_title": "My Product 3",
                "currency": "GBP",
                "vendor_set_prices_included_tax": true,
                "price": {
                    "gross": 34.95,
                    "net": 29.13,
                    "tax": 5.83
                },
                "list_price": {
                    "gross": 34.95,
                    "net": 29.13,
                    "tax": 5.83
                },
                "applied_coupon": []
            }
        ]
    }
}

Request - Multiple Products

https://checkout.paddle.com/api/2.0/prices?product_ids=12345,678910,111213&customer_country=GB

Response

{
    "success": true,
    "response": {
        "customer_country": "GB",
        "products": [
            {
                "product_id": 123456,
                "product_title": "My Product 3",
                "currency": "GBP",
                "vendor_set_prices_included_tax": true,
                "price": {
                    "gross": 34.95,
                    "net": 29.13,
                    "tax": 5.83
                },
                "list_price": {
                    "gross": 34.95,
                    "net": 29.13,
                    "tax": 5.83
                },
                "applied_coupon": []
            },
            {
                "product_id": 23456,
                "product_title": "My Product 2",
                "currency": "GBP",
                "vendor_set_prices_included_tax": true,
                "price": {
                    "gross": 17.95,
                    "net": 14.96,
                    "tax": 2.99
                },
                "list_price": {
                    "gross": 17.95,
                    "net": 14.96,
                    "tax": 2.99
                },
                "applied_coupon": []
            },
            {
                "product_id": 34567,
                "product_title": "My Product 3",
                "currency": "GBP",
                "vendor_set_prices_included_tax": true,
                "price": {
                    "gross": 34.95,
                    "net": 29.13,
                    "tax": 5.83
                },
                "list_price": {
                    "gross": 34.95,
                    "net": 29.13,
                    "tax": 5.83
                },
                "applied_coupon": []
            }
        ]
    }
}

Request - Multiple Products with Coupon(s)

https://checkout.paddle.com/api/2.0/prices?product_ids=12345,678910,111213&customer_country=GB&coupons=COUPONOFF,COUPONOFF2

Response

{
    "success": true,
    "response": {
        "customer_country": "GB",
        "products": [
            {
                "product_id": 12345,
                "product_title": "My Product 3",
                "currency": "GBP",
                "vendor_set_prices_included_tax": true,
                "price": {
                    "gross": 17.48,
                    "net": 14.56,
                    "tax": 2.91
                },
                "list_price": {
                    "gross": 34.95,
                    "net": 29.13,
                    "tax": 5.83
                },
                "applied_coupon": {
                    "code": "COUPONOFF2",
                    "discount": 17.475
                }
            },
            {
                "product_id": 23456,
                "product_title": "My Product 2",
                "currency": "GBP",
                "vendor_set_prices_included_tax": true,
                "price": {
                    "gross": 14.36,
                    "net": 11.97,
                    "tax": 2.39
                },
                "list_price": {
                    "gross": 17.95,
                    "net": 14.96,
                    "tax": 2.99
                },
                "applied_coupon": {
                    "code": "COUPONOFF",
                    "discount": 3.59
                }
            },
            {
                "product_id": 34567,
                "product_title": "My Product 3",
                "currency": "GBP",
                "vendor_set_prices_included_tax": true,
                "price": {
                    "gross": 27.96,
                    "net": 23.3,
                    "tax": 4.66
                },
                "list_price": {
                    "gross": 34.95,
                    "net": 29.13,
                    "tax": 5.83
                },
                "applied_coupon": {
                    "code": "COUPONOFF",
                    "discount": 6.99
                }
            }
        ]
    }
}

Notes:

  • If more than one coupon is specified, Paddle will calculate the price of each product on the basis of the coupon that provides the greatest discount.
  • If the product has an active sale discount this will only be reflected in the price, list-price will contain the full price of the product.

Recognised Countries

The following countries are accepted values to be passed with the customer_country field within a Custom Checkout API request.

  • AF: Afghanistan
  • AL: Albania
  • DZ: Algeria
  • AS: American Samoa
  • AD: Andorra
  • AO: Angola
  • AI: Anguilla
  • AG: Antigua and Barbuda
  • AR: Argentina
  • AM: Armenia
  • AW: Aruba
  • AU: Australia
  • AT: Austria
  • AZ: Azerbaijan
  • BS: Bahamas
  • BH: Bahrain
  • BD: Bangladesh
  • BB: Barbados
  • BY: Belarus
  • BE: Belgium
  • BZ: Belize
  • BJ: Benin
  • BM: Bermuda
  • BT: Bhutan
  • BO: Bolivia
  • BA: Bosnia and Herzegovina
  • BW: Botswana
  • BV: Bouvet Island
  • BR: Brazil
  • IO: Brit. Indian Ocean
  • VG: British Virgin Islands
  • BN: Brunei Darussalam
  • BG: Bulgaria
  • BF: Burkina Faso
  • BI: Burundi
  • KH: Cambodia
  • CM: Cameroon
  • CA: Canada
  • CV: Cape Verde
  • KY: Cayman Islands
  • CF: Central African Republic
  • TD: Chad
  • CL: Chile
  • CN: China
  • CX: Christmas Island
  • CC: Cocos Islands
  • CO: Colombia
  • KM: Comoros
  • CG: Congo
  • CK: Cook Islands
  • CR: Costa Rica
  • CI: Cote D’Ivoire
  • HR: Croatia
  • CU: Cuba
  • CW: Curaçao
  • CY: Cyprus
  • CZ: Czech Republic
  • DK: Denmark
  • DJ: Djibouti
  • DM: Dominica
  • DO: Dominican Republic
  • EC: Ecuador
  • EG: Egypt
  • SV: El Salvador
  • GQ: Equatorial Guinea
  • ER: Eritrea
  • EE: Estonia
  • ET: Ethiopia
  • FK: Falkland Islands
  • FO: Faroe Islands
  • FJ: Fiji
  • FI: Finland
  • FR: France
  • GF: French Guiana
  • PF: French Polynesia
  • TF: French Southern Terr.
  • GA: Gabon
  • GM: Gambia
  • GE: Georgia
  • DE: Germany
  • GH: Ghana
  • GI: Gibraltar
  • GR: Greece
  • GL: Greenland
  • GD: Grenada
  • GP: Guadeloupe
  • GU: Guam
  • GT: Guatemala
  • GG: Guernsey
  • GN: Guinea
  • GW: Guinea-Bissau
  • GY: Guyana
  • HT: Haiti
  • HM: Heard/ Mcdonald Islands
  • VA: Holy See/ Vatican City
  • HN: Honduras
  • HK: Hong Kong
  • HU: Hungary
  • IS: Iceland
  • IN: India
  • ID: Indonesia
  • IR: Iran
  • IQ: Iraq
  • IE: Ireland
  • IL: Israel
  • IT: Italy
  • JM: Jamaica
  • JP: Japan
  • JE: Jersey
  • JO: Jordan
  • KZ: Kazakhstan
  • KE: Kenya
  • KI: Kiribati
  • KW: Kuwait
  • KG: Kyrgyzstan
  • LA: Lao People’s DR
  • LV: Latvia
  • LB: Lebanon
  • LS: Lesotho
  • LR: Liberia
  • LY: Libyan Arab Jamahiriya
  • LI: Liechtenstein
  • LT: Lithuania
  • LU: Luxembourg
  • MO: Macao
  • MK: Macedonia
  • MG: Madagascar
  • MW: Malawi
  • MY: Malaysia
  • MV: Maldives
  • ML: Mali
  • MT: Malta
  • MH: Marshall Islands
  • MQ: Martinique
  • MR: Mauritania
  • MU: Mauritius
  • YT: Mayotte
  • MX: Mexico
  • FM: Micronesia
  • MD: Moldova
  • MC: Monaco
  • MN: Mongolia
  • ME: Montenegro
  • MS: Montserrat
  • MA: Morocco
  • MZ: Mozambique
  • MM: Myanmar
  • NA: Namibia
  • NR: Nauru
  • NP: Nepal
  • NL: Netherlands
  • AN: Netherlands Antilles
  • NC: New Caledonia
  • NZ: New Zealand
  • NI: Nicaragua
  • NE: Niger
  • NG: Nigeria
  • NU: Niue
  • NF: Norfolk Island
  • KP: North Korea
  • MP: Northern Mariana Islands
  • NO: Norway
  • OM: Oman
  • PK: Pakistan
  • PW: Palau
  • PS: Palestinian Territory
  • PA: Panama
  • PG: Papua New Guinea
  • PY: Paraguay
  • PE: Peru
  • PH: Philippines
  • PN: Pitcairn
  • PL: Poland
  • PT: Portugal
  • PR: Puerto Rico
  • QA: Qatar
  • RS: Republic of Serbia
  • RE: Reunion
  • RO: Romania
  • RU: Russian Federation
  • RW: Rwanda
  • GS: S. Georgia/ Sandwich Islands
  • SH: Saint Helena
  • KN: Saint Kitts and Nevis
  • LC: Saint Lucia
  • PM: Saint Pierre and Miquelon
  • VC: Saint Vincent/ Grenadines
  • WS: Samoa
  • SM: San Marino
  • ST: Sao Tome and Principe
  • SA: Saudi Arabia
  • SN: Senegal
  • SC: Seychelles
  • SL: Sierra Leone
  • SG: Singapore
  • SK: Slovakia
  • SI: Slovenia
  • SB: Solomon Islands
  • SO: Somalia
  • ZA: South Africa
  • KR: South Korea
  • ES: Spain
  • LK: Sri Lanka
  • SD: Sudan
  • SR: Suriname
  • SJ: Svalbard and Jan Mayen
  • SZ: Swaziland
  • SE: Sweden
  • CH: Switzerland
  • SY: Syrian Arab Republic
  • TW: Taiwan
  • TJ: Tajikistan
  • TZ: Tanzania
  • TH: Thailand
  • TL: Timor-Leste
  • TG: Togo
  • TK: Tokelau
  • TO: Tonga
  • TT: Trinidad and Tobago
  • TN: Tunisia
  • TR: Turkey
  • TM: Turkmenistan
  • TC: Turks and Caicos Islands
  • TV: Tuvalu
  • VI: U.S. Virgin Islands
  • UG: Uganda
  • UA: Ukraine
  • AE: United Arab Emirates
  • GB: United Kingdom
  • US: United States
  • UM: United States (M.O.I.)
  • UY: Uruguay
  • UZ: Uzbekistan
  • VU: Vanuatu
  • VE: Venezuela
  • VN: Viet Nam
  • WF: Wallis and Futuna
  • EH: Western Sahara
  • YE: Yemen
  • ZM: Zambia
  • ZW: Zimbabwe

Questions about Paddle?

If you need any help regarding your Paddle integration, please get in touch with our Customer Success team using the form below.