Tcl Stripe: Update a Coupon

Back to Index

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

Documentation: https://stripe.com/docs/api/curl#update_coupon

CURL Command

curl https://api.stripe.com/v1/coupons/25OFF \
   -u STRIPE_SECRET_KEY: \
   -d metadata[order_id]=6735 \
   -X POST

Tcl Example

load ./chilkat.dll

set rest [new_CkRest]

#  URL: https://api.stripe.com/v1/coupons/25OFF
set bTls 1
set port 443
set bAutoReconnect 1
set success [CkRest_Connect $rest "api.stripe.com" $port $bTls $bAutoReconnect]
if {[expr $success != 1]} then {
    puts "ConnectFailReason: [CkRest_ConnectFailReason $rest]"
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    exit
}

CkRest_SetAuthBasic $rest "STRIPE_SECRET_KEY" ""

CkRest_AddQueryParam $rest "metadata[order_id]" "6735"

set strResponseBody [CkRest_fullRequestFormUrlEncoded $rest "POST" "/v1/coupons/25OFF"]
if {[expr [CkRest_LastMethodSuccess $rest] != 1]} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    exit
}

set jsonResponse [new_CkJsonObject]

CkJsonObject_Load $jsonResponse $strResponseBody

set id [CkJsonObject_stringOf $jsonResponse "id"]
set object [CkJsonObject_stringOf $jsonResponse "object"]
set amount_off [CkJsonObject_IsNullOf $jsonResponse "amount_off"]
set created [CkJsonObject_IntOf $jsonResponse "created"]
set currency [CkJsonObject_IsNullOf $jsonResponse "currency"]
set duration [CkJsonObject_stringOf $jsonResponse "duration"]
set duration_in_months [CkJsonObject_IntOf $jsonResponse "duration_in_months"]
set livemode [CkJsonObject_BoolOf $jsonResponse "livemode"]
set max_redemptions [CkJsonObject_IsNullOf $jsonResponse "max_redemptions"]
set metadataOrder_id [CkJsonObject_stringOf $jsonResponse "metadata.order_id"]
set percent_off [CkJsonObject_IntOf $jsonResponse "percent_off"]
set redeem_by [CkJsonObject_IsNullOf $jsonResponse "redeem_by"]
set times_redeemed [CkJsonObject_IntOf $jsonResponse "times_redeemed"]
set valid [CkJsonObject_BoolOf $jsonResponse "valid"]

delete_CkRest $rest
delete_CkJsonObject $jsonResponse

Sample JSON Response Body

{
  "id": "25OFF",
  "object": "coupon",
  "amount_off": null,
  "created": 1516662783,
  "currency": null,
  "duration": "repeating",
  "duration_in_months": 3,
  "livemode": false,
  "max_redemptions": null,
  "metadata": {
    "order_id": "6735"
  },
  "percent_off": 25,
  "redeem_by": null,
  "times_redeemed": 0,
  "valid": true
}