List Checkout Links

Retrieve all active checkout session links for the active business.

GET /v1/checkout-links

TypeScript SDK

TypeScript

import { Solifyn } from 'solifyn';

const solifyn = new Solifyn({ apiKey: 'your_private_api_key_here' });

// List checkout links
const links = await solifyn.checkoutLinks.list();
console.log('Checkout Links:', links);

200

[
  {
    "id": "chk_123",
    "quantity": 1,
    "showDiscounts": true,
    "createdAt": "2025-01-01T12:00:00Z",
    "updatedAt": "2025-01-01T12:00:00Z",
    "title": "Winter Bundle Checkout",
    "productId": "prod_123",
    "collectionId": "col_123",
    "customerName": "John Doe",
    "customerEmail": "[e-mail]",
    "addressLine1": "123 Main St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "US",
    "redirectUrl": "https://example.com/success",
    "cancelUrl": "https://example.com/cancel"
  }
]

Authorizations

Authorization · string · header · required

Authenticate requests using your standard bearer API key (e.g. YOUR_API_KEY).

Response

200 - application/json

Checkout links retrieved successfully.

id · string<uuid> · required

The checkout link ID

Example:

"chk_123"

quantity · number · required

Quantity to purchase

Example:

1

showDiscounts · boolean · required

Whether to show discounts on the checkout page

Example:

true

createdAt · string<date-time> · required

Timestamp when the link was created

Example:

"2025-01-01T12:00:00Z"

updatedAt · string<date-time> · required

Timestamp when the link was last updated

Example:

"2025-01-01T12:00:00Z"

title · string | null

The title of the checkout link

Example:

"Winter Bundle Checkout"

productId · string | null

The linked Product ID

Example:

"prod_123"

collectionId · string | null

The linked Collection ID

Example:

"col_123"

customerName · string | null

Pre-filled customer name

Example:

"John Doe"

customerEmail · string | null

Pre-filled customer email

Example:

"[e-mail]"

addressLine1 · string | null

Pre-filled address line 1

Example:

"123 Main St"

city · string | null

Pre-filled city

Example:

"New York"

state · string | null

Pre-filled state

Example:

"NY"

postalCode · string | null

Pre-filled postal code

Example:

"10001"

country · string | null

Pre-filled country

Example:

"US"

redirectUrl · string | null

URL to redirect to after successful payment

Example:

"https://example.com/success"

cancelUrl · string | null

URL to redirect to if payment is cancelled

Example:

"https://example.com/cancel"