STstreampay
Checkout/Payment Links

List Payment Links

Changed on

List all payment links with pagination, filtering, and sorting options.

get/api/v2/payment_links

Request

  • Base URL
    https://stream-app-service.streampay.sa
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Query parameters

statusesPaymentLinkStatus[] nullable

Filter by subscription status

from_datestring date-time nullable

datetime is created_at

to_datestring date-time nullable

datetime is created_at

number
OR
string
number
OR
string
product_idsstring[] nullable

Product ids that need to be in the list of payment links

currenciesstring nullable

Filter by currency codes (OR). E.g. currencies=SAR,USD

pageinteger

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

sort_fieldstring nullable

Field to sort by, e.g., 'amount', 'scheduled_on'

sort_directionstring nullable

Sorting direction ('asc' or 'desc')

Response

Successful Response

Example response

{
  "data": [
    {
      "custom_fields": {
        "properties": {
          "child_name": {
            "title": "Child Name",
            "type": "string"
          },
          "parent_email": {
            "title": "Parent Email",
            "type": "string"
          }
        },
        "required": [
          "child_name"
        ],
        "type": "object"
      }
    }
  ]
}

Changes

  • 6762ca2358eaRevision changes
    • info

      response property data/items/exclude_coupons_if_installments deprecated

  • dfac786362d9Revision changes
    • warning

      removed the optional property ///// from the response with the status

    • info

      added the optional property ///// to the response with the status