Promo Codes

Create a new Promo Code

post/api/promo-codes

Request

  • Base URL: https://hellosafe.com
  • URL: https://hellosafe.com/api/promo-codes
  • Auth: OAuth 2 (password, token URL /api//openapi-auth)

Query parameters

depthnumber
localestring

Request body

codestring required

What the customer types. Case-insensitive, stored uppercase. Letters, digits, - and _ (3–32 chars), e.g. HELLO2026 or HELLO-ETE-2026.

labelstring nullable

Internal note: campaign, partner name, who asked for it… Never shown to customers.

activeboolean nullable

Kill switch. An inactive code is refused at checkout.

validUntilstring nullable

Optional expiry (inclusive). Empty = no expiry.

usesnumber nullable

Paid / subscribed sales where this code reduced the fee. Computed on read.

discountType'fee_percent' | 'price_percent' required

% of the fee, or % of the price capped at the fee. See the preview above.

discountValuenumber required

0–100. The preview above shows the exact effect.

origin'hellosafe' | 'follow-up' required

Atlas partner codes are not here: partners create them in atlas.hellosafe.com and the checkout reads them from Atlas.

deletedAtstring nullable

Response

Promo Code object

messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.