Chilkat Online Tools

Ruby / New FreshBooks / Single Checkout Link

Back to Collection Items

require '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": true,
#   "send_admin_receipt": true,
#   "created_at": "2020-06-26",
#   "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",true)
json.UpdateBool("send_admin_receipt",true)
json.UpdateString("created_at","2020-06-26")
json.UpdateString("taxes[0].name","HST")
json.UpdateInt("taxes[0].amount",13)
json.UpdateString("item_name","The Best Doorknob")

http.SetRequestHeader("Authorization","Bearer")

# resp is a CkHttpResponse
resp = http.PostJson3("https://api.freshbooks.com/payments/account/{{accountid}}/checkout-links","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

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

Postman Collection Item JSON

{
  "name": "Single Checkout Link",
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "POST",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer",
        "type": "text",
        "disabled": true
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"item_id\": \"147778\",\n    \"amount\": \"100\",\n    \"currency\": \"CAD\",\n    \"note\": \"Thank you for your Business\",\n    \"is_active\": true,\n    \"send_admin_receipt\": true,\n    \"created_at\": \"2020-06-26\",\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",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "payments",
        "account",
        "{{accountid}}",
        "checkout-links"
      ]
    }
  },
  "response": [
  ]
}