> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paritydeals.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Promotion Details
> This endpoint provides dynamic discount information based on various criteria like user location, holidays, etc. It supports both client-side and server-side API calls with different parameter requirements.
**Warning:** A paid plan is required to access the promotion API.
## OpenAPI
````yaml /frontend-integration/openapi.json get /deals/discount/
openapi: 3.0.0
info:
title: ParityDeals Checkout API
version: 1.0.0
description: >-
The ParityDeals Checkout API extends the capabilities of Stripe's Checkout
API by incorporating dynamic pricing adjustments based on user location,
holidays, and other criteria defined within ParityDeals.
servers:
- url: https://api.paritydeals.com/api/v1
security: []
paths:
/deals/discount/:
get:
tags:
- Promotions
summary: Promotion Details
description: >-
This endpoint provides dynamic discount information based on various
criteria like user location, holidays, etc. It supports both client-side
and server-side API calls with different parameter requirements.
**Warning:** A paid plan is required to access the promotion API.
parameters:
- name: product_id
in: query
description: >-
Required for client-side API calls. The unique identifier for the
product for which to retrieve a discount.
required: false
schema:
type: string
examples:
productIdExample:
value: promo_4cc5ee64b0ae4fb694221
- name: pd_identifier
in: query
description: >-
Required for server-side API calls. A unique identifier associated
with a particular deal.
required: false
schema:
type: string
examples:
serverSide:
value: DEAL_IDENTIFIER
- name: ip_address
in: query
description: Required for server-side API calls. The user's IP address.
required: false
schema:
type: string
format: ipv4
examples:
serverSide:
value: 34.98.207.242
- name: base_currency_code
in: query
description: >-
Optional for server-side API calls. The desired base currency code
for the discount information (e.g., EUR).
required: false
schema:
type: string
examples:
serverSide:
value: EUR
responses:
'200':
description: >-
Successful retrieval of discount information. The response structure
varies depending on whether a discount is available and if the user
is accessing via a VPN.
content:
application/json:
schema:
oneOf:
- title: Discount Response
type: object
properties:
bar:
type: object
properties:
backgroundColor:
type: string
backgroundTransparency:
type: string
fontColor:
type: string
highlightFontColor:
type: string
placement:
type: string
borderRadius:
type: string
addCloseIcon:
type: boolean
noStyle:
type: boolean
couponCode:
type: string
nullable: true
discountPercentage:
type: string
data:
type: object
properties:
stripePromoCodeId:
type: string
polarDiscountId:
type: string
dodoDiscountId:
type: string
country:
type: string
countryFlag:
type: string
countryFlagSvg:
type: string
holiday:
type: string
nullable: true
time:
type: string
nullable: true
message:
type: string
messageText:
type: string
countryCode:
type: string
currencyCode:
type: string
currencySymbol:
type: string
pricingLocale:
type: string
usdConversionRate:
type: string
baseCurrencyConversionRate:
type: string
isVpn:
type: boolean
isProxy:
type: boolean
isTor:
type: boolean
- title: No Discount Response
type: object
properties:
message:
type: string
countryCode:
type: string
currencyCode:
type: string
currencySymbol:
type: string
pricingLocale:
type: string
usdConversionRate:
type: string
baseCurrencyConversionRate:
type: string
country:
type: string
countryFlag:
type: string
countryFlagSvg:
type: string
isVpn:
type: boolean
isProxy:
type: boolean
isTor:
type: boolean
examples:
discountFound:
summary: Has discounts
value:
bar:
backgroundColor: '#04888e'
backgroundTransparency: '0'
fontColor: '#59ebf1'
highlightFontColor: '#DD5C64'
placement: top
borderRadius: '0'
addCloseIcon: false
noStyle: false
couponCode: PD8CEXAAJL
discountPercentage: '50.00'
data:
stripePromoCodeId: promo_1RaFH8EEwDDegOMGqiAG
country: India
countryFlag: 🇮🇳
countryFlagSvg: >-
holiday: null
time: null
message: 50% OFF for India!
messageText: 50% OFF for India!
countryCode: IN
currencyCode: INR
currencySymbol: ₹
pricingLocale: en-IN
usdConversionRate: '82.2'
baseCurrencyConversionRate: '82.2'
isVpn: false
isProxy: false
isTor: false
noDiscount:
summary: Without discounts
value:
message: No discounts available
countryCode: DE
currencyCode: EUR
currencySymbol: €
pricingLocale: de-DE
usdConversionRate: '0.92'
baseCurrencyConversionRate: '1.0'
country: Germany
countryFlag: 🇩🇪
countryFlagSvg: >-
isVpn: true
isProxy: true
isTor: false
````