Update Paylink

curl --request PATCH \
  --url https://mapi.zbx.boomfi.xyz/v1/paylinks/{paylinkId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "enabled": true,
  "metadata": {
    "customer_fields": [
      "<string>"
    ],
    "omit_possible_duplicate_acknowledgement": true,
    "payment_method_types": [],
    "variable_mode_only": true
  },
  "plan": {
    "description": "<string>",
    "image_url": "<string>",
    "name": "<string>"
  }
}
'

import requests

url = "https://mapi.zbx.boomfi.xyz/v1/paylinks/{paylinkId}"

payload = {
    "enabled": True,
    "metadata": {
        "customer_fields": ["<string>"],
        "omit_possible_duplicate_acknowledgement": True,
        "payment_method_types": [],
        "variable_mode_only": True
    },
    "plan": {
        "description": "<string>",
        "image_url": "<string>",
        "name": "<string>"
    }
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enabled: true,
    metadata: {
      customer_fields: ['<string>'],
      omit_possible_duplicate_acknowledgement: true,
      payment_method_types: [],
      variable_mode_only: true
    },
    plan: {description: '<string>', image_url: '<string>', name: '<string>'}
  })
};

fetch('https://mapi.zbx.boomfi.xyz/v1/paylinks/{paylinkId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://mapi.zbx.boomfi.xyz/v1/paylinks/{paylinkId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'enabled' => true,
    'metadata' => [
        'customer_fields' => [
                '<string>'
        ],
        'omit_possible_duplicate_acknowledgement' => true,
        'payment_method_types' => [
                
        ],
        'variable_mode_only' => true
    ],
    'plan' => [
        'description' => '<string>',
        'image_url' => '<string>',
        'name' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://mapi.zbx.boomfi.xyz/v1/paylinks/{paylinkId}"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"metadata\": {\n    \"customer_fields\": [\n      \"<string>\"\n    ],\n    \"omit_possible_duplicate_acknowledgement\": true,\n    \"payment_method_types\": [],\n    \"variable_mode_only\": true\n  },\n  \"plan\": {\n    \"description\": \"<string>\",\n    \"image_url\": \"<string>\",\n    \"name\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://mapi.zbx.boomfi.xyz/v1/paylinks/{paylinkId}")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true,\n  \"metadata\": {\n    \"customer_fields\": [\n      \"<string>\"\n    ],\n    \"omit_possible_duplicate_acknowledgement\": true,\n    \"payment_method_types\": [],\n    \"variable_mode_only\": true\n  },\n  \"plan\": {\n    \"description\": \"<string>\",\n    \"image_url\": \"<string>\",\n    \"name\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mapi.zbx.boomfi.xyz/v1/paylinks/{paylinkId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": true,\n  \"metadata\": {\n    \"customer_fields\": [\n      \"<string>\"\n    ],\n    \"omit_possible_duplicate_acknowledgement\": true,\n    \"payment_method_types\": [],\n    \"variable_mode_only\": true\n  },\n  \"plan\": {\n    \"description\": \"<string>\",\n    \"image_url\": \"<string>\",\n    \"name\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "created_at": "<string>",
    "created_by": "<string>",
    "customer_ident_collection": true,
    "deleted_at": "<string>",
    "enabled": true,
    "id": "<string>",
    "invoice_id": "<string>",
    "metadata": {},
    "plan": {
      "available_quantity": 123,
      "created_at": "<string>",
      "created_by": "<string>",
      "currency": "<string>",
      "deleted_at": "<string>",
      "enabled": true,
      "expires_at": "<string>",
      "id": "<string>",
      "metadata": {},
      "name": "<string>",
      "org_id": "<string>",
      "payment_link": {
        "created_at": "<string>",
        "created_by": "<string>",
        "customer_ident_collection": true,
        "deleted_at": "<string>",
        "enabled": true,
        "id": "<string>",
        "invoice_id": "<string>",
        "metadata": {},
        "plan_id": "<string>",
        "properties": {},
        "shipping_address_collection": true,
        "tax_ident_collection": true,
        "updated_at": "<string>",
        "updated_by": "<string>"
      },
      "price": "<string>",
      "properties": {},
      "recurring_interval_count": 123,
      "reference": "<string>",
      "trial_period": "<string>",
      "updated_at": "<string>"
    },
    "plan_id": "<string>",
    "properties": {},
    "shipping_address_collection": true,
    "tax_ident_collection": true,
    "updated_at": "<string>",
    "updated_by": "<string>"
  },
  "error": true,
  "message": "<string>"
}

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

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

PATCH

paylinks

{paylinkId}

Update Paylink

curl --request PATCH \
  --url https://mapi.zbx.boomfi.xyz/v1/paylinks/{paylinkId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "enabled": true,
  "metadata": {
    "customer_fields": [
      "<string>"
    ],
    "omit_possible_duplicate_acknowledgement": true,
    "payment_method_types": [],
    "variable_mode_only": true
  },
  "plan": {
    "description": "<string>",
    "image_url": "<string>",
    "name": "<string>"
  }
}
'

import requests

url = "https://mapi.zbx.boomfi.xyz/v1/paylinks/{paylinkId}"

payload = {
    "enabled": True,
    "metadata": {
        "customer_fields": ["<string>"],
        "omit_possible_duplicate_acknowledgement": True,
        "payment_method_types": [],
        "variable_mode_only": True
    },
    "plan": {
        "description": "<string>",
        "image_url": "<string>",
        "name": "<string>"
    }
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enabled: true,
    metadata: {
      customer_fields: ['<string>'],
      omit_possible_duplicate_acknowledgement: true,
      payment_method_types: [],
      variable_mode_only: true
    },
    plan: {description: '<string>', image_url: '<string>', name: '<string>'}
  })
};

fetch('https://mapi.zbx.boomfi.xyz/v1/paylinks/{paylinkId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://mapi.zbx.boomfi.xyz/v1/paylinks/{paylinkId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'enabled' => true,
    'metadata' => [
        'customer_fields' => [
                '<string>'
        ],
        'omit_possible_duplicate_acknowledgement' => true,
        'payment_method_types' => [
                
        ],
        'variable_mode_only' => true
    ],
    'plan' => [
        'description' => '<string>',
        'image_url' => '<string>',
        'name' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://mapi.zbx.boomfi.xyz/v1/paylinks/{paylinkId}"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"metadata\": {\n    \"customer_fields\": [\n      \"<string>\"\n    ],\n    \"omit_possible_duplicate_acknowledgement\": true,\n    \"payment_method_types\": [],\n    \"variable_mode_only\": true\n  },\n  \"plan\": {\n    \"description\": \"<string>\",\n    \"image_url\": \"<string>\",\n    \"name\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://mapi.zbx.boomfi.xyz/v1/paylinks/{paylinkId}")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true,\n  \"metadata\": {\n    \"customer_fields\": [\n      \"<string>\"\n    ],\n    \"omit_possible_duplicate_acknowledgement\": true,\n    \"payment_method_types\": [],\n    \"variable_mode_only\": true\n  },\n  \"plan\": {\n    \"description\": \"<string>\",\n    \"image_url\": \"<string>\",\n    \"name\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mapi.zbx.boomfi.xyz/v1/paylinks/{paylinkId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": true,\n  \"metadata\": {\n    \"customer_fields\": [\n      \"<string>\"\n    ],\n    \"omit_possible_duplicate_acknowledgement\": true,\n    \"payment_method_types\": [],\n    \"variable_mode_only\": true\n  },\n  \"plan\": {\n    \"description\": \"<string>\",\n    \"image_url\": \"<string>\",\n    \"name\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "created_at": "<string>",
    "created_by": "<string>",
    "customer_ident_collection": true,
    "deleted_at": "<string>",
    "enabled": true,
    "id": "<string>",
    "invoice_id": "<string>",
    "metadata": {},
    "plan": {
      "available_quantity": 123,
      "created_at": "<string>",
      "created_by": "<string>",
      "currency": "<string>",
      "deleted_at": "<string>",
      "enabled": true,
      "expires_at": "<string>",
      "id": "<string>",
      "metadata": {},
      "name": "<string>",
      "org_id": "<string>",
      "payment_link": {
        "created_at": "<string>",
        "created_by": "<string>",
        "customer_ident_collection": true,
        "deleted_at": "<string>",
        "enabled": true,
        "id": "<string>",
        "invoice_id": "<string>",
        "metadata": {},
        "plan_id": "<string>",
        "properties": {},
        "shipping_address_collection": true,
        "tax_ident_collection": true,
        "updated_at": "<string>",
        "updated_by": "<string>"
      },
      "price": "<string>",
      "properties": {},
      "recurring_interval_count": 123,
      "reference": "<string>",
      "trial_period": "<string>",
      "updated_at": "<string>"
    },
    "plan_id": "<string>",
    "properties": {},
    "shipping_address_collection": true,
    "tax_ident_collection": true,
    "updated_at": "<string>",
    "updated_by": "<string>"
  },
  "error": true,
  "message": "<string>"
}

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

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

Authorizations

X-API-KEY

string

header

required

Path Parameters

paylinkId

string

required

Unique payment link identifier (plink_...)

Body

application/json

Update paylink request

enabled

boolean

Whether the payment link is enabled.

metadata

object

Payment link metadata and checkout settings.

Show child attributes

plan

object

Plan fields to update on this payment link.

Show child attributes

Response

data

object

Response payload when the request succeeded.

Show child attributes

error

boolean

True when the request failed.

message

string

Human-readable status or error message.

Basics

Paylinks

Plans

Subscriptions

Customers

Invoices

Payments

Events

Organisation

Secrets

Accounts

Bank Address Book

Virtual Accounts

Partners

Partner Automations

Partner Balance Monitoring

Instruments

Quotes

Orders

Trades

Update Paylink

Authorizations

Path Parameters

Body

Response