Objective-C 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

Objective-C Example

#import <CkoRest.h>
#import <NSString.h>
#import <CkoJsonObject.h>

CkoRest *rest = [[CkoRest alloc] init];
BOOL success;

//  URL: https://api.stripe.com/v1/coupons/25OFF
BOOL bTls = YES;
int port = 443;
BOOL bAutoReconnect = YES;
success = [rest Connect: @"api.stripe.com" port: [NSNumber numberWithInt: port] tls: bTls autoReconnect: bAutoReconnect];
if (success != YES) {
    NSLog(@"%@%d",@"ConnectFailReason: ",[rest.ConnectFailReason intValue]);
    NSLog(@"%@",rest.LastErrorText);
    return;
}

[rest SetAuthBasic: @"STRIPE_SECRET_KEY" password: @""];

[rest AddQueryParam: @"metadata[order_id]" value: @"6735"];

NSString *strResponseBody = [rest FullRequestFormUrlEncoded: @"POST" uriPath: @"/v1/coupons/25OFF"];
if (rest.LastMethodSuccess != YES) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

CkoJsonObject *jsonResponse = [[CkoJsonObject alloc] init];
[jsonResponse Load: strResponseBody];

NSString *id = 0;
NSString *object = 0;
BOOL amount_off;
int created;
BOOL currency;
NSString *duration = 0;
int duration_in_months;
BOOL livemode;
BOOL max_redemptions;
NSString *metadataOrder_id = 0;
int percent_off;
BOOL redeem_by;
int times_redeemed;
BOOL valid;

id = [jsonResponse StringOf: @"id"];
object = [jsonResponse StringOf: @"object"];
amount_off = [jsonResponse IsNullOf: @"amount_off"];
created = [[jsonResponse IntOf: @"created"] intValue];
currency = [jsonResponse IsNullOf: @"currency"];
duration = [jsonResponse StringOf: @"duration"];
duration_in_months = [[jsonResponse IntOf: @"duration_in_months"] intValue];
livemode = [jsonResponse BoolOf: @"livemode"];
max_redemptions = [jsonResponse IsNullOf: @"max_redemptions"];
metadataOrder_id = [jsonResponse StringOf: @"metadata.order_id"];
percent_off = [[jsonResponse IntOf: @"percent_off"] intValue];
redeem_by = [jsonResponse IsNullOf: @"redeem_by"];
times_redeemed = [[jsonResponse IntOf: @"times_redeemed"] intValue];
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
}