List Paylinks

GET https://paylinks.uqualify.co.uk/api/v1/paylinks

The List Paylinks endpoint allows you to retrieve a comprehensive list of all pay links created within your organization on the Uqualify platform. Use this endpoint to efficiently manage and review all the payment links you have generated, ensuring they align with your business needs.

info

Paylinks are created automatically when a plan is created. Each plan has a corresponding paylink that can be used to facilitate payments.

Query Parameters

Parameter	Type	Description
after	string	Return paylinks after this cursor for pagination.
before	string	Return paylinks before this cursor for pagination.
limit	integer	The maximum number of paylinks to return per page (1-100).
page	integer	The page number of the results to return (≥ 1).
since	string	Return paylinks created or updated since this timestamp.
sort	string	Sort order for the results.
until	string	Return paylinks created or updated until this timestamp.

Example Request

curl --request GET \
     --url https://paylinks.uqualify.co.uk/api/v1/paylinks \
     --header 'X-API-KEY: API-KEY \
     --header 'accept: application/json'

Responses

200

Field	Type	Description
data	object	The data object containing the paylinks.
data.items	object	An array of paylink objects.
data.items.id	string	The unique identifier for the paylink.
data.items.plan_id	string	The ID of the associated plan.
data.items.invoice_id	string	The ID of the associated invoice.
data.items.source	string	The source of the paylink.
data.items.customer_ident_collection	boolean	Indicates if customer identification collection is enabled.
data.items.shipping_address_collection	boolean	Indicates if shipping address collection is enabled.
data.items.tax_ident_collection	boolean	Indicates if tax identification collection is enabled.
data.items.enabled	boolean	Indicates if the paylink is enabled.
data.items.deleted_at	date-time	The timestamp when the paylink was deleted.
data.items.created_by	string	The ID of the user who created the paylink.
data.items.updated_by	string	The ID of the user who last updated the paylink.
data.items.created_at	date-time	The timestamp when the paylink was created.
data.items.updated_at	date-time	The timestamp when the paylink was last updated.
data.items.metadata	object	Additional metadata associated with the paylink.
data.items.metadata.properties	object	Additional properties associated with the paylink.
data.items.plan	object	The details of the associated plan.
data.last_update	string	The timestamp indicating when the data was last updated.
data.next	integer	The index of the next page of paylinks.
data.total	integer	The total number of paylinks available.
error	boolean	Indicates if there was an error.

{
  "data": {
    "items": [
      {
        "id": "2Z4zsnmp37AF3WKM6N2j4wmeakr",
        "plan_id": "2Z4zspFMhs2pMYjcR3l6JpJaWdA",
        "invoice_id": "",
        "source": "BoomFi",
        "customer_ident_collection": false,
        "shipping_address_collection": false,
        "tax_ident_collection": false,
        "enabled": true,
        "deleted_at": "2023-12-04T13:25:48.499Z",
        "created_by": "2TzGhPCAfFWLPBjtc6h52Aao2S6",
        "updated_by": "",
        "created_at": "2023-12-04T13:25:48.496Z",
        "updated_at": "2023-12-04T13:25:48.499Z",
        "metadata": {},
        "properties": {
          "short_code": "AANj9Dm7Zl"
        },
        "plan": {
          "id": "2Z4zspFMhs2pMYjcR3l6JpJaWdA",
          "org_id": "2Tpmnmh6GHJXumKN1oBy2u56Ima",
          "source": "Lago",
          "name": "test paylink 12 04",
          "type": "OneTime",
          "billing_scheme": "FlatFee",
          "price": "1",
          "currency": "USD",
          "available_quantity": 0,
          "trial_period": "",
          "recurring_interval": "Unknown",
          "recurring_interval_count": 1,
          "recurring_usage_type": "Unknown",
          "reference": "",
          "enabled": true,
          "v1": "eyJwbGFucyI6IHsiaWQiOiAiYWE1ZmI5MjQtMmMzZi00NzcwLTkyZDEtMjFjYmY3ODc3ODc2IiwgIm5hbWUiOiAidGVzdCBwYXlsaW5rIDEyIDA0IiwgInN0YXR1cyI6ICJhY3RpdmUiLCAiaW50ZXJ2YWwiOiBudWxsLCAicmVmZXJlbmNlIjogIiIsICJhbW91bnRfd2VpIjogIjEwMCIsICJjcmVhdGVkX2F0IjogIjIwMjMtMTI...",
          "created_by": "2TzGhPCAfFWLPBjtc6h52Aao2S6",
          "created_at": "2023-12-04T13:25:47.656Z",
          "updated_at": "2023-12-04T13:25:48.491Z",
          "deleted_at": null,
          "metadata": {}
        }
      }
    ],
    "last_update": "2021-01-01T00:00:00Z",
    "next": 10,
    "total": 10
  },
  "error": true
}

400

Field	Type	Description	Example
error	object	The error returned by the server.
error.code	integer	The error code returned by the server.	400
error.errors	object	A list of detailed error objects.
error.error.domain	string	The domain associated with the error.	orders
error.error.reason	string	The reason for the error.	InsufficientQuantity
error.message	string	A descriptive message explaining the error.	Insufficient quantity

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

500

Field	Type	Description	Example
error	object	The error returned by the server.
error.code	integer	The error code returned by the server.	500
error.errors	object	A list of detailed error objects.
error.errors.domain	string	The domain associated with the error.	orders
error.errors.reason	string	The reason for the error.	Internal
error.message	string	A descriptive message explaining the error.	Internal server error

{
  "error": {
    "code": 500,
    "errors": [
      {
        "domain": "orders",
        "reason": "Internal"
      }
    ],
    "message": "Internal server error"
  }
}