Chilkat Online Tools

autoit / New FreshBooks / Update Checkout Link

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; 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"
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("item_id","147778")
$oJson.UpdateString("amount","100")
$oJson.UpdateString("currency","CAD")
$oJson.UpdateString("note","Thank you for your Business")
$oJson.UpdateBool("is_active",False)
$oJson.UpdateBool("send_admin_receipt",True)
$oJson.UpdateString("taxes[0].name","HST")
$oJson.UpdateInt("taxes[0].amount",13)
$oJson.UpdateString("item_name","The Best Doorknob")

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"

$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)

Local $oResp = $oHttp.PTextSb("PUT","https://api.freshbooks.com/payments/account/{{accountid}}/checkout-links/{{checkoutlinkid}}",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

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": [
  ]
}