Sign in

v1

latestOpenAPI 3.0.02026-07-243678114.1 KB
Paylinks

List Paylinks

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

📘 Note

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

get/v1/paylinks

Query parameters

afterstring

Return paylinks after this cursor for pagination.

beforestring

Return paylinks before this cursor for pagination.

limitinteger

The maximum number of paylinks to return per page (1-100).

pageinteger

The page number of the results to return.

sincestring

Return paylinks created or updated since this timestamp.

sort'asc' | 'desc'

Sort order for the results.

untilstring

Return paylinks created or updated until this timestamp.

Response

OK

errorboolean

Example response

{
  "data": {
    "items": [
      {
        "id": "2Z4zsnmp37AF3WKM6N2j4wmeakr",
        "plan_id": "2Z4zspFMhs2pMYjcR3l6JpJaWdA",
        "source": "BoomFi",
        "enabled": true,
        "deleted_at": "2023-12-04T13:25:48.499Z",
        "created_by": "2TzGhPCAfFWLPBjtc6h52Aao2S6",
        "created_at": "2023-12-04T13:25:48.496Z",
        "updated_at": "2023-12-04T13:25:48.499Z",
        "expires_at": "2026-12-31T23:59:59Z",
        "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",
          "recurring_interval": "Unknown",
          "recurring_interval_count": 1,
          "recurring_usage_type": "Unknown",
          "enabled": true,
          "v1": "eyJwbGFucyI6IHsiaWQiOiAiYWE1ZmI5MjQtMmMzZi00NzcwLTkyZDEtMjFjYmY3ODc3ODc2IiwgIm5hbWUiOiAidGVzdCBwYXlsaW5rIDEyIDA0IiwgInN0YXR1cyI6ICJhY3RpdmUiLCAiaW50ZXJ2YWwiOiBudWxsLCAicmVmZXJlbmNlIjogIiIsICJhbW91bnRfd2VpIjogIjEwMCIsICJjcmVhdGVkX2F0IjogIjIwMjMtMTI...",
          "created_by": "2TzGhPCAfFWLPBjtc6h52Aao2S6",
          "created_at": "2023-12-04T13:25:47.656Z",
          "updated_at": "2023-12-04T13:25:48.491Z",
          "metadata": {}
        }
      }
    ],
    "last_update": "2021-01-01T00:00:00Z",
    "next": 10,
    "total": 10
  }
}