Skip to main content
PATCH
/
api
/
dashboard
/
discount-codes
/
{code_id}
Update Discount Code
curl --request PATCH \
  --url https://api.example.com/api/dashboard/discount-codes/{code_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "value": 1,
  "currency": "<string>",
  "min_order_amount": 1,
  "max_uses_total": 2,
  "max_uses_per_customer": 2,
  "starts_at": "2023-11-07T05:31:56Z",
  "ends_at": "2023-11-07T05:31:56Z"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "<string>",
  "description": "<string>",
  "kind": "<string>",
  "value": "<string>",
  "currency": "<string>",
  "min_order_amount": "<string>",
  "max_uses_total": 123,
  "max_uses_per_customer": 123,
  "starts_at": "2023-11-07T05:31:56Z",
  "ends_at": "2023-11-07T05:31:56Z",
  "revoked_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.stella-commerce.com/llms.txt

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

Headers

​
authorization
string | null
​
X-API-Key
string | null
​
X-Stella-Merchant-Id
string | null

Path Parameters

​
code_id
string<uuid>
required

Body

application/json
​
description
string | null
Maximum string length: 255
​
value
Required range: x >= 0
​
currency
string | null
Required string length: 3
​
min_order_amount
Required range: x >= 0
​
max_uses_total
integer | null
Required range: x >= 1
​
max_uses_per_customer
integer | null
Required range: x >= 1
​
starts_at
string<date-time> | null
​
ends_at
string<date-time> | null

Response

Successful Response

Dashboard view of a single discount code.

​
id
string<uuid>
required
​
code
string
required
​
description
string | null
required
​
kind
string
required
​
value
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
currency
string | null
required
​
min_order_amount
string | null
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
max_uses_total
integer | null
required
​
max_uses_per_customer
integer | null
required
​
starts_at
string<date-time> | null
required
​
ends_at
string<date-time> | null
required
​
revoked_at
string<date-time> | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required