🔒
Requires price_rules access scope. More access scope

The Update Discount Code API allows you to update the details of an existing discount code associated with a specific price rule.

This API is especially useful for:

Request Parameters

📘
Public Request Parameters

Parameter	Type	Required	Description	Example
`price_rule_id`	string	Yes	ID of the price rule associated with the discount code	`pr_123456`
`discount_code_id`	string	Yes	ID of the discount code to retrieve details for	`dc_789012`

Parameter	Type	Required	Description	Example
`discount_codes`	object	Yes	The discount code configuration object	`{...}`
`discount_codes[].code`	string	Yes	The actual discount code text (must be unique)	`SUMMER20`

Response Explanation

📘
Public Response Parameters

Parameter	Type	Example	Description
`code`	string	`200`	Error code (200 indicates success)
`message`	string	`Success`	Error message
`data`	object	`{...}`	Contains the price rules data
`data.discount_code`	`object`	`{...}`	discount code object

Parameter	Type	Example	Description
`id`	string	`dc_123456`	Unique identifier of the discount code
`price_rule_id`	string	`pr_123456`	ID of the associated price rule
`code`	string	`SUMMER20`	The actual discount code text
`created_at`	string	`2023-06-20T15:30:00Z`	Timestamp when the discount code was created
`updated_at`	string	`2023-06-21T09:15:00Z`	Timestamp when the discount code was last updated
`use_with_other`	int32	`1`	Whether the code can be used with other discounts (1=yes, 0=no)
`usage_count`	int32	`42`	Number of times the discount code has been used

Field	Type	Example	Description
`code`	string	`InvalidParameter`	Error http message
`message`	string	``	Error message