Update a Coupon

Update a coupon

curl --request PUT \
  --url https://www.referly.so/api/v1/coupons \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "couponId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "percentOff": 123,
  "amountOff": 123,
  "currency": "<string>",
  "durationInMonths": 123,
  "maxRedemptions": 123,
  "limitToProducts": true,
  "productIds": [
    "<string>"
  ],
  "valid": true,
  "redeemBy": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://www.referly.so/api/v1/coupons"

payload = {
    "couponId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "percentOff": 123,
    "amountOff": 123,
    "currency": "<string>",
    "durationInMonths": 123,
    "maxRedemptions": 123,
    "limitToProducts": True,
    "productIds": ["<string>"],
    "valid": True,
    "redeemBy": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    couponId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: '<string>',
    percentOff: 123,
    amountOff: 123,
    currency: '<string>',
    durationInMonths: 123,
    maxRedemptions: 123,
    limitToProducts: true,
    productIds: ['<string>'],
    valid: true,
    redeemBy: '2023-11-07T05:31:56Z'
  })
};

fetch('https://www.referly.so/api/v1/coupons', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.referly.so/api/v1/coupons",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'couponId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => '<string>',
    'percentOff' => 123,
    'amountOff' => 123,
    'currency' => '<string>',
    'durationInMonths' => 123,
    'maxRedemptions' => 123,
    'limitToProducts' => true,
    'productIds' => [
        '<string>'
    ],
    'valid' => true,
    'redeemBy' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.referly.so/api/v1/coupons"

	payload := strings.NewReader("{\n  \"couponId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"percentOff\": 123,\n  \"amountOff\": 123,\n  \"currency\": \"<string>\",\n  \"durationInMonths\": 123,\n  \"maxRedemptions\": 123,\n  \"limitToProducts\": true,\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"valid\": true,\n  \"redeemBy\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://www.referly.so/api/v1/coupons")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"couponId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"percentOff\": 123,\n  \"amountOff\": 123,\n  \"currency\": \"<string>\",\n  \"durationInMonths\": 123,\n  \"maxRedemptions\": 123,\n  \"limitToProducts\": true,\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"valid\": true,\n  \"redeemBy\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.referly.so/api/v1/coupons")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"couponId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"percentOff\": 123,\n  \"amountOff\": 123,\n  \"currency\": \"<string>\",\n  \"durationInMonths\": 123,\n  \"maxRedemptions\": 123,\n  \"limitToProducts\": true,\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"valid\": true,\n  \"redeemBy\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "externalId": "<string>",
  "percentOff": 123,
  "amountOff": 123,
  "currency": "<string>",
  "durationInMonths": 123,
  "maxRedemptions": 123,
  "timesRedeemed": 123,
  "limitToProducts": true,
  "productIds": [
    "<string>"
  ],
  "collectionIds": [
    "<string>"
  ],
  "valid": true,
  "redeemBy": "2023-11-07T05:31:56Z",
  "affiliateProgramId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "promotionalCodes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "code": "<string>",
      "couponId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "affiliateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalId": "<string>",
      "active": true,
      "expiresAt": "2023-11-07T05:31:56Z",
      "maxRedemptions": 123,
      "timesRedeemed": 123,
      "firstTimeOrder": true,
      "minimumAmount": 123,
      "minimumAmountCurrency": "<string>",
      "limitToCustomers": true,
      "customerId": "<string>",
      "limitToAffiliate": true,
      "isAutoGenerated": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "coupon": "<unknown>",
      "affiliate": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "jsmith@example.com"
      },
      "isAffiliateGenerated": true
    }
  ],
  "autoCouponRule": {}
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

PUT

coupons

Update a coupon

curl --request PUT \
  --url https://www.referly.so/api/v1/coupons \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "couponId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "percentOff": 123,
  "amountOff": 123,
  "currency": "<string>",
  "durationInMonths": 123,
  "maxRedemptions": 123,
  "limitToProducts": true,
  "productIds": [
    "<string>"
  ],
  "valid": true,
  "redeemBy": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://www.referly.so/api/v1/coupons"

payload = {
    "couponId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "percentOff": 123,
    "amountOff": 123,
    "currency": "<string>",
    "durationInMonths": 123,
    "maxRedemptions": 123,
    "limitToProducts": True,
    "productIds": ["<string>"],
    "valid": True,
    "redeemBy": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    couponId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: '<string>',
    percentOff: 123,
    amountOff: 123,
    currency: '<string>',
    durationInMonths: 123,
    maxRedemptions: 123,
    limitToProducts: true,
    productIds: ['<string>'],
    valid: true,
    redeemBy: '2023-11-07T05:31:56Z'
  })
};

fetch('https://www.referly.so/api/v1/coupons', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.referly.so/api/v1/coupons",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'couponId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => '<string>',
    'percentOff' => 123,
    'amountOff' => 123,
    'currency' => '<string>',
    'durationInMonths' => 123,
    'maxRedemptions' => 123,
    'limitToProducts' => true,
    'productIds' => [
        '<string>'
    ],
    'valid' => true,
    'redeemBy' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.referly.so/api/v1/coupons"

	payload := strings.NewReader("{\n  \"couponId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"percentOff\": 123,\n  \"amountOff\": 123,\n  \"currency\": \"<string>\",\n  \"durationInMonths\": 123,\n  \"maxRedemptions\": 123,\n  \"limitToProducts\": true,\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"valid\": true,\n  \"redeemBy\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://www.referly.so/api/v1/coupons")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"couponId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"percentOff\": 123,\n  \"amountOff\": 123,\n  \"currency\": \"<string>\",\n  \"durationInMonths\": 123,\n  \"maxRedemptions\": 123,\n  \"limitToProducts\": true,\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"valid\": true,\n  \"redeemBy\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.referly.so/api/v1/coupons")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"couponId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"percentOff\": 123,\n  \"amountOff\": 123,\n  \"currency\": \"<string>\",\n  \"durationInMonths\": 123,\n  \"maxRedemptions\": 123,\n  \"limitToProducts\": true,\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"valid\": true,\n  \"redeemBy\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "externalId": "<string>",
  "percentOff": 123,
  "amountOff": 123,
  "currency": "<string>",
  "durationInMonths": 123,
  "maxRedemptions": 123,
  "timesRedeemed": 123,
  "limitToProducts": true,
  "productIds": [
    "<string>"
  ],
  "collectionIds": [
    "<string>"
  ],
  "valid": true,
  "redeemBy": "2023-11-07T05:31:56Z",
  "affiliateProgramId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "promotionalCodes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "code": "<string>",
      "couponId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "affiliateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalId": "<string>",
      "active": true,
      "expiresAt": "2023-11-07T05:31:56Z",
      "maxRedemptions": 123,
      "timesRedeemed": 123,
      "firstTimeOrder": true,
      "minimumAmount": 123,
      "minimumAmountCurrency": "<string>",
      "limitToCustomers": true,
      "customerId": "<string>",
      "limitToAffiliate": true,
      "isAutoGenerated": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "coupon": "<unknown>",
      "affiliate": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "jsmith@example.com"
      },
      "isAffiliateGenerated": true
    }
  ],
  "autoCouponRule": {}
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Updating Coupons

Update an existing coupon’s properties. Changes to the coupon will affect all associated promotional codes.

Be careful when updating coupons that have active promotional codes. Changes to discount amounts or validity will affect all codes using this coupon.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Fields to update

couponId

string<uuid>

required

The coupon to update

name

string

Name of the coupon

couponType

enum<string>

Whether the discount is a percentage or a fixed amount

Available options:

PERCENTAGE,

FLAT

percentOff

number<float>

Percentage taken off, 1–100

amountOff

number<float>

Fixed amount taken off. Must be greater than zero.

currency

string

Currency for amountOff

duration

enum<string>

How long the discount keeps applying to a subscription

Available options:

once,

forever,

repeating

durationInMonths

integer

Number of months the discount repeats for

maxRedemptions

integer

Total redemptions allowed

limitToProducts

boolean

Restrict the coupon to productIds

productIds

string[]

Products the coupon applies to

valid

boolean

Set to false to stop the coupon being redeemed

redeemBy

string<date-time>

Last date the coupon can be redeemed

Response

The updated coupon.

A discount definition. Promotional codes point at a coupon for their value.

string<uuid>

The coupon ID

name

string | null

Name of the coupon

externalId

string | null

The coupon's ID in the connected billing provider, for example a Stripe coupon ID

couponType

enum<string>

Whether the discount is a percentage or a fixed amount

Available options:

PERCENTAGE,

FLAT

percentOff

number<float> | null

Percentage taken off, 1–100. Used when couponType is PERCENTAGE.

amountOff

number<float> | null

Fixed amount taken off. Used when couponType is FLAT.

currency

string | null

Currency for amountOff, for example USD

duration

enum<string>

How long the discount keeps applying to a subscription

Available options:

once,

forever,

repeating

durationInMonths

integer | null

Number of months the discount repeats for. Only set when duration is repeating.

maxRedemptions

integer | null

Total redemptions allowed across every promotional code on this coupon. null means unlimited.

timesRedeemed

integer

How many times this coupon has been redeemed so far

couponCategory

enum<string>

Whether the coupon discounts customers or is used to pay affiliates as a non-cash reward

Available options:

CUSTOMER,

PAYOUT

limitToProducts

boolean

Whether the coupon only applies to productIds

productIds

string[]

Products the coupon is restricted to

collectionIds

string[]

Collections the coupon is restricted to

valid

boolean

Whether the coupon can currently be redeemed

redeemBy

string<date-time> | null

Last date the coupon can be redeemed

integrationType

enum<string> | null

The billing provider this coupon is synced with

Available options:

NONE,

STRIPE,

CHARGEBEE,

PADDLE,

SHOPIFY,

WOOCOMMERCE,

ZYLVIE,

POLAR

affiliateProgramId

string<uuid>

The affiliate program this coupon belongs to

createdAt

string<date-time>

When the coupon was created

updatedAt

string<date-time>

When the coupon was last updated

promotionalCodes

object[]

Promotional codes that point at this coupon

Show child attributes

autoCouponRule

object | null

Rule used to generate codes automatically for affiliates, if configured

Last modified on July 20, 2026

Delete a Coupon

Get Promotional Codes

API Documentation

Affiliate Endpoints

Referral Endpoints

Sale Endpoints

Affiliate Link Endpoints

Coupon Endpoints

Promotional Code Endpoints

Update a Coupon

Updating Coupons

Authorizations

Body

Response

​Updating Coupons

Authorizations

Body

Response

Updating Coupons