List payment links.

GEThttps://staging.softsolz.uk/api/v1/services/payments/payment-links

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Query Params

kindstring

Filter by link type (button|link). Any other value is ignored.

limitinteger

Page size, 1-200 (default 50).

offsetinteger

Pagination offset (default 0).

Response

Response Body · array of objects

idintegerPayment link id.

tokenstringOpaque public token used in hosted-pay links and checkout-session creation.

kindstringSurface type. "button" embeds on a page; "link" is a shareable hosted link.

titlestringDisplay title / Stripe line-item name.

descriptionstring | nullOptional longer description.

amount_centsinteger | nullFixed charge amount in minor units, or null when the customer chooses the amount.

min_amount_centsinteger | nullMinimum allowed amount in minor units for custom-amount links; null when a fixed amount is set.

currencystringISO 4217 currency code, upper-cased.

activebooleanWhether the link can currently take payments.

show_business_namebooleanWhether the tenant business name is shown on the hosted page.

button_colorstring | nullHex button background colour, or null.

button_text_colorstring | nullHex button text colour, or null.

paid_countintegerNumber of successful payments recorded against this link.

created_atstringCreation timestamp.

updated_atstringLast-update timestamp; round-trip as expected_updated_at for optimistic concurrency on PATCH.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.payments.listPaymentLinks({});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": [
    {
      "id": 0,
      "token": "string",
      "kind": "string",
      "title": "string",
      "description": "string",
      "amount_cents": 0,
      "min_amount_cents": 0,
      "currency": "string",
      "active": true,
      "show_business_name": true,
      "button_color": "string",
      "button_text_color": "string",
      "paid_count": 0,
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}