playbook-pricing

Create Promo Code

Creator creates a discount code (FR-09).

Code is normalised to UPPERCASE before persistence + uniqueness check. Uniqueness is per-playbook (two playbooks can both have a code "LAUNCH20").

post/api/v1/playbooks/{playbook_id}/promo-codes

Request

  • Base URL: https://api.badgeia.com
  • URL: https://api.badgeia.com/api/v1/playbooks/{playbook_id}/promo-codes
  • Auth: none declared

Path parameters

playbook_idstring uuid required

Request body

codestring required
discount_type'percent' | 'fixed' required
discount_valueinteger required
max_redemptionsinteger nullable
expires_atstring date-time nullable
min_buyer_account_age_daysinteger

Example request

{
  "code": "LAUNCH20"
}

Response

Successful Response

idstring uuid required
playbook_idstring uuid nullable required
creator_user_idstring uuid nullable required
codestring required
discount_typestring required
discount_valueinteger required
max_redemptionsinteger nullable required
current_redemptionsinteger required
expires_atstring date-time nullable required
min_buyer_account_age_daysinteger required
created_atstring date-time required
revoked_atstring date-time nullable required

Changes

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