Skip to main content
POST
Stripe Checkout

Body

application/json
checkout_data
object
required

Checkout data similar to the data specified in Stripe documentation (https://docs.stripe.com/api/checkout/sessions/create). This parameter is required if payment_id is not provided.

Example:
pd_identifier
string
required

Unique identifier associated with a particular deal.

Example:

"your_pd_identifier"

success_url
string<uri>
required

The URL to which a user will be redirected after a successful purchase.

Example:

"https://your-success-url.com"

ip_address
string | null

Pass the IP address. This is necessary only if you are implementing this in server-side.

Example:

"192.168.1.1"

apply_coupons
boolean
default:false

Set this field true to automatically fetches and applies pricing based on the user’s location at checkout. Warning: If this is set to false, the Stripe price_id for adjusted pricing may not be available directly in the response.

Example:

true

Response

Successfully created Checkout session

id
string

The unique identifier for the Stripe Checkout Session.

Example:

"cs_live_a1HmmI9644trNrGaxfCMYrsZgK3QMiklsMqNEBNzEKWmNkzJtViECUBNpB"

url
string<uri>

The URL to redirect the user to for completing the checkout process.

Example:

"https://checkout.stripe.com/c/pay/cs_live_a1HmmI9644trNrGaxfCMYrsZgK3QMiklsMqNEBNpB#fid2cXdsdWBEZmZqcGtxJz8nZGZmcVo0SnYzXGdJSzZUVUlxRnRgJyknZHVsTmB8Jz8ndW5aaWxzYFowNE49Q0hnVkZsMWJHYjBcRmBGVEZ8ZFxWVF1XcUpEVXRgYE9HNGExQElMMz1IaDQ1ZkpqTl0wTGdwRm1AUVddbzdHclRIR1J8MjJfPEhKY3Z1czU1NF1PbX9TclMnKSdjd2poVmB3c2B3Jz9xd3BgKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGB4JSUl"