Chilkat Online Tools

Perl / New FreshBooks / Update Checkout Link

Back to Collection Items

use chilkat();

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = chilkat::CkHttp->new();

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "item_id": "147778",
#   "amount": "100",
#   "currency": "CAD",
#   "note": "Thank you for your Business",
#   "is_active": false,
#   "send_admin_receipt": true,
#   "taxes": [
#     {
#       "name": "HST",
#       "amount": 13
#     }
#   ],
#   "item_name": "The Best Doorknob"
# }

$json = chilkat::CkJsonObject->new();
$json->UpdateString("item_id","147778");
$json->UpdateString("amount","100");
$json->UpdateString("currency","CAD");
$json->UpdateString("note","Thank you for your Business");
$json->UpdateBool("is_active",0);
$json->UpdateBool("send_admin_receipt",1);
$json->UpdateString("taxes[0].name","HST");
$json->UpdateInt("taxes[0].amount",13);
$json->UpdateString("item_name","The Best Doorknob");

# Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken("<access_token>");

$sbRequestBody = chilkat::CkStringBuilder->new();
$json->EmitSb($sbRequestBody);

# resp is a HttpResponse
$resp = $http->PTextSb("PUT","https://api.freshbooks.com/payments/account/{{accountid}}/checkout-links/{{checkoutlinkid}}",$sbRequestBody,"utf-8","application/json",0,0);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

print $resp->get_StatusCode() . "\r\n";
print $resp->bodyStr() . "\r\n";

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '{
    "item_id": "147778",
    "amount": "100",
    "currency": "CAD",
    "note": "Thank you for your Business",
    "is_active": false,
    "send_admin_receipt": true,
    "taxes": [{"name":"HST","amount":13}],
    "item_name": "The Best Doorknob"
}'
https://api.freshbooks.com/payments/account/{{accountid}}/checkout-links/{{checkoutlinkid}}

Postman Collection Item JSON

{
  "name": "Update Checkout Link",
  "request": {
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"item_id\": \"147778\",\n    \"amount\": \"100\",\n    \"currency\": \"CAD\",\n    \"note\": \"Thank you for your Business\",\n    \"is_active\": false,\n    \"send_admin_receipt\": true,\n    \"taxes\": [{\"name\":\"HST\",\"amount\":13}],\n    \"item_name\": \"The Best Doorknob\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.freshbooks.com/payments/account/{{accountid}}/checkout-links/{{checkoutlinkid}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "payments",
        "account",
        "{{accountid}}",
        "checkout-links",
        "{{checkoutlinkid}}"
      ]
    }
  },
  "response": [
  ]
}