Skip to main content
GET
/
lps
/
payment-links
/
{id}
Get payment link
curl --request GET \
  --url https://api.cheqpay.dev/lps/payment-links/{id} \
  --header 'x-api-key: <api-key>'
{
  "_id": "<string>",
  "url": "<string>",
  "id": "<string>",
  "merchantId": "<string>",
  "type": "products_subscriptions",
  "products": [
    {
      "id": "<string>",
      "name": "<string>",
      "qty": 2,
      "price": 1,
      "total": 1,
      "description": "<string>",
      "imageUrl": "<string>",
      "isQtyAdjustable": true,
      "minQty": 123,
      "maxQty": 123
    }
  ],
  "currency": "<string>",
  "totals": {
    "total": 1,
    "taxes": 1,
    "shipping": 1,
    "fees": 1,
    "discounts": 1
  },
  "numberOfPayments": 2,
  "paymentMethods": [
    "<string>"
  ],
  "isDraft": true,
  "isEnabled": true,
  "redirectUrl": "<string>",
  "reference": "<string>",
  "defaults": {
    "billingAddress": {
      "firstName": "<string>",
      "lastName": "<string>",
      "organizationName": "<string>",
      "email": "[email protected]",
      "phone": "<string>",
      "addressLine1": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postalCode": "<string>",
      "country": "<string>",
      "isSameAsShipping": true
    },
    "shippingAddress": {
      "firstName": "<string>",
      "lastName": "<string>",
      "organizationName": "<string>",
      "email": "[email protected]",
      "phone": "<string>",
      "addressLine1": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postalCode": "<string>",
      "country": "<string>"
    }
  },
  "metadata": {},
  "expiresAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "merchant": {
    "name": "<string>",
    "logo": "<string>",
    "refundPolicyUrl": "<string>",
    "returnsAndExchangesPolicyUrl": "<string>",
    "country": "<string>",
    "language": "en"
  }
}

Authorizations

x-api-key
string
header
required

API key for merchant authentication

Path Parameters

id
string
required

Payment link ID

Response

Payment link retrieved successfully

Payment link entity

_id
string

Payment link ID

url
string

Payment link URL

id
string

Unique payment link identifier

merchantId
string

Merchant identifier

type
enum<string>

Payment link type

Available options:
products_subscriptions,
customer_choice
products
object[]

Products in the payment link

currency
string

Currency code (3 letters)

totals
object

Payment link totals

numberOfPayments
number

Number of payments for subscription

Required range: x >= 1
paymentMethods
string[]

Available payment methods

Minimum array length: 1
isDraft
boolean

Whether the payment link is a draft

isEnabled
boolean

Whether the payment link is enabled

redirectUrl
string

URL to redirect after payment completion

reference
string

Merchant reference for the payment link

defaults
object

Default values for customer choice payment links

metadata
object

Additional metadata

expiresAt
string<date-time>

Expiration date

createdAt
string<date-time>

Creation timestamp

updatedAt
string<date-time>

Last update timestamp

merchant
object