PowerShell Stripe: List all Coupons

Back to Index

Returns a list of your coupons.

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

CURL Command

curl https://api.stripe.com/v1/coupons?limit=3 \
   -u STRIPE_SECRET_KEY: \
   -G

PowerShell Example

[Reflection.Assembly]::LoadFile("C:\myAssemblies\ChilkatDotNet2.dll")

$rest = New-Object Chilkat.Rest

#  URL: https://api.stripe.com/v1/coupons?limit=3
$bTls = $true
$port = 443
$bAutoReconnect = $true
$success = $rest.Connect("api.stripe.com",$port,$bTls,$bAutoReconnect)
if ($success -ne $true) {
    $("ConnectFailReason: " + $rest.ConnectFailReason)
    $($rest.LastErrorText)
    exit
}

$rest.SetAuthBasic("STRIPE_SECRET_KEY","")

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $rest.FullRequestNoBodySb("GET","/v1/coupons?limit=3",$sbResponseBody)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

$jsonResponse = New-Object Chilkat.JsonObject
$jsonResponse.LoadSb($sbResponseBody)

$object = $jsonResponse.StringOf("object")
$url = $jsonResponse.StringOf("url")
$has_more = $jsonResponse.BoolOf("has_more")
$i = 0
$count_i = $jsonResponse.SizeOfArray("data")
while ($i -lt $count_i) {
    $jsonResponse.I = $i
    $id = $jsonResponse.StringOf("data[i].id")
    $object = $jsonResponse.StringOf("data[i].object")
    $amount_off = $jsonResponse.IsNullOf("data[i].amount_off")
    $created = $jsonResponse.IntOf("data[i].created")
    $currency = $jsonResponse.IsNullOf("data[i].currency")
    $duration = $jsonResponse.StringOf("data[i].duration")
    $duration_in_months = $jsonResponse.IntOf("data[i].duration_in_months")
    $livemode = $jsonResponse.BoolOf("data[i].livemode")
    $max_redemptions = $jsonResponse.IsNullOf("data[i].max_redemptions")
    $percent_off = $jsonResponse.IntOf("data[i].percent_off")
    $redeem_by = $jsonResponse.IsNullOf("data[i].redeem_by")
    $times_redeemed = $jsonResponse.IntOf("data[i].times_redeemed")
    $valid = $jsonResponse.BoolOf("data[i].valid")
    $i = $i + 1
}

Sample JSON Response Body

{
  "object": "list",
  "url": "/v1/coupons",
  "has_more": false,
  "data": [
    {
      "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
    }
  ]
}