BOboomfi
Paylinks

Enable or Disable a Paylink

Update the status of a specific paylink by setting the enabled field to true or false.

patch/v1/paylinks/{paylinkId}

Request

Path parameters

paylinkIdstring required

The unique identifier of the paylink to update.

Request body

enabledboolean required

Set to false to disable the paylink or true to enable it.

Response

OK

errorboolean

Example response

{
  "data": {
    "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": {}
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.