PHP ActiveX 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

PHP ActiveX Example

<?php

$rest = new COM("Chilkat_9_5_0.Rest");

//  URL: https://api.stripe.com/v1/coupons/25OFF
$bTls = 1;
$port = 443;
$bAutoReconnect = 1;
$success = $rest->Connect('api.stripe.com',$port,$bTls,$bAutoReconnect);
if ($success != 1) {
    print 'ConnectFailReason: ' . $rest->ConnectFailReason . "\n";
    print $rest->LastErrorText . "\n";
    exit;
}

$rest->SetAuthBasic('STRIPE_SECRET_KEY','');

$rest->AddQueryParam('metadata[order_id]','6735');

$strResponseBody = $rest->fullRequestFormUrlEncoded('POST','/v1/coupons/25OFF');
if ($rest->LastMethodSuccess != 1) {
    print $rest->LastErrorText . "\n";
    exit;
}

$jsonResponse = new COM("Chilkat_9_5_0.JsonObject");
$jsonResponse->Load($strResponseBody);

$id = $jsonResponse->stringOf('id');
$object = $jsonResponse->stringOf('object');
$amount_off = $jsonResponse->IsNullOf('amount_off');
$created = $jsonResponse->IntOf('created');
$currency = $jsonResponse->IsNullOf('currency');
$duration = $jsonResponse->stringOf('duration');
$duration_in_months = $jsonResponse->IntOf('duration_in_months');
$livemode = $jsonResponse->BoolOf('livemode');
$max_redemptions = $jsonResponse->IsNullOf('max_redemptions');
$metadataOrder_id = $jsonResponse->stringOf('metadata.order_id');
$percent_off = $jsonResponse->IntOf('percent_off');
$redeem_by = $jsonResponse->IsNullOf('redeem_by');
$times_redeemed = $jsonResponse->IntOf('times_redeemed');
$valid = $jsonResponse->BoolOf('valid');

?>

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
}