Skip to main content
PUT
/
coupons
/
{id}
Update coupon
curl --request PUT \
  --url https://us.api.flexprice.io/v1/coupons/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "metadata": {},
  "name": "<string>"
}
'
{
  "amount_off": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "currency": "<string>",
  "duration_in_periods": 123,
  "environment_id": "<string>",
  "id": "<string>",
  "max_redemptions": 123,
  "metadata": {},
  "name": "<string>",
  "percentage_off": "<string>",
  "redeem_after": "<string>",
  "redeem_before": "<string>",
  "rules": {},
  "tenant_id": "<string>",
  "total_redemptions": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.flexprice.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

​
id
string
required

Coupon ID

Body

application/json

Coupon update request

​
metadata
object
​
name
string

Response

OK

​
amount_off
string
​
cadence
enum<string>
Available options:
once,
repeated,
forever
​
created_at
string<date-time>
​
created_by
string
​
currency
string
​
duration_in_periods
integer
​
environment_id
string
​
id
string
​
max_redemptions
integer
​
metadata
object
​
name
string
​
percentage_off
string
​
redeem_after
string
​
redeem_before
string
​
rules
object
​
status
enum<string>
Available options:
published,
deleted,
archived
​
tenant_id
string
​
total_redemptions
integer
​
type
enum<string>
Available options:
fixed,
percentage
​
updated_at
string<date-time>
​
updated_by
string