PHP Extension Stripe: Create a Coupon

Back to Index

Creates a coupon object.

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

CURL Command

curl https://api.stripe.com/v1/coupons \
   -u STRIPE_SECRET_KEY: \
   -d percent_off=25 \
   -d duration=repeating \
   -d duration_in_months=3 \
   -d id=25OFF \
   -X POST

PHP Extension Example

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

$rest = new CkRest();

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

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

$rest->AddQueryParam('percent_off','25');
$rest->AddQueryParam('duration','repeating');
$rest->AddQueryParam('duration_in_months','3');
$rest->AddQueryParam('id','25OFF');

$strResponseBody = $rest->fullRequestFormUrlEncoded('POST','/v1/coupons');
if ($rest->get_LastMethodSuccess() != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

$jsonResponse = new CkJsonObject();
$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');
$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": {},
  "percent_off": 25,
  "redeem_by": null,
  "times_redeemed": 0,
  "valid": true
}