SCscalev
Discounts

Update a discount code

Updates discount-code availability, usage, expiry, page, payment-method, and minimum-revenue settings. Code, discount type, and discount amount are immutable after creation.

patch/v3/discount-codes/{id}

Request

  • Base URL
    https://api.scalev.com
  • URL
    https://api.scalev.com/v3/discount-codes/{id}
  • Auth
    • HTTP bearer
    • or API key in header authorization
    • or OAuth 2
      Authorization code: https://api.scalev.com/v3/oauth/authorize
      Token URL: https://api.scalev.com/v3/oauth/token scopes: discount_code:update

Request body

is_enabledboolean
is_usage_limitboolean
usage_limitinteger nullable
is_expiryboolean
expiry_timestring date-time nullable
is_limited_to_pagesboolean
page_idsinteger[]
is_limited_to_payment_methodsboolean
payment_methodsstring[]
is_minimum_revenueboolean
minimum_revenuenumber nullable

Response

Discount code

idinteger
business_idinteger
is_enabledboolean
codestring
applied_tostring nullable
amount_typestring nullable
is_max_amountboolean
is_usage_limitboolean
usage_limitinteger nullable
current_usageinteger nullable
is_expiryboolean
expiry_timestring date-time nullable
is_limited_to_pagesboolean
pagesobject[]
is_limited_to_payment_methodsboolean
payment_methodsstring[]
is_minimum_revenueboolean
inserted_atstring date-time nullable
updated_atstring date-time nullable

Changes

No recorded changes to this operation across all 14 revisions of this API.