Skip to main content
POST
/
product-payment
/
create
Create Checkout Payment Button
curl --request POST \
  --url https://cloud-api.freshlimepay.com/product-payment/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "productName": "<string>",
  "amount": "<string>",
  "currency": "<string>",
  "paymentMethod": "PayPal",
  "paymentType": "one_time",
  "isLive": true,
  "description": "<string>",
  "billingInterval": "<string>",
  "ApplicationFeePercentage": "<string>"
}
'
{
  "isSuccess": true,
  "data": "<string>",
  "message": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

API Key required for authorization (mandatory for all endpoints)

Body

application/json
​
productName
string
required

Name of the product associated with the checkout button

​
amount
string
required

Amount for the payment (decimal string)

​
currency
string
required

Currency code (e.g., USD, EUR)

​
paymentMethod
enum<string>
required

External payment provider

Available options:
PayPal,
Stripe,
StripeConnect
​
paymentType
enum<string>
required

Type of payment

Available options:
one_time,
subscription
​
isLive
boolean
required

Indicates live or sandbox mode

​
description
string

Description of the product or service

​
billingInterval
string

Billing interval for subscriptions

​
ApplicationFeePercentage
string

Required if PaymentMethod is StripeConnect. Must be between 0.01 and 100.

Response

Checkout Payment Button created successfully

​
isSuccess
boolean
​
data
string

Usually returns the Checkout Payment Button ID

​
message
string