Discount codes

Edit unused discount code terms (site admin)

Requires a write discount-management key and current site-admin creator. Updates supplied fields only. Set duration=repeating and months=12 for twelve months. redeemBy=null clears the deadline. Code and recipient cannot change. Any redemption history locks terms; no Stripe changes are made. Identical updates are no-ops.

patch/discount-codes/{code}

Request

  • Base URL: https://app.pencil.ink/api/v1
  • URL: https://app.pencil.ink/api/v1/discount-codes/{code}
  • Auth: HTTP bearer

Request body

labelstring
percentOffinteger
duration'once' | 'repeating' | 'forever'
monthsinteger

Required for repeating duration.

planKey'pro' | 'team'

USD monthly base subscription only; excludes AI usage.

maxRedemptionsinteger nullable

Maximum distinct organization redemptions. Null means unlimited. Defaults to 1 and must be 1 for recipient-targeted codes.

redeemFromnumber nullable

Optional redemption start, Unix milliseconds.

redeemBynumber nullable

Optional future redemption deadline, Unix milliseconds.

Response

The resource.

Changes

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