Discount codes

Create a discount code (site admin)

Requires a write key with explicit discount-management permission and a current site-admin creator. Single-use; terms editable until redemption starts. Omit recipient IDs for shareable signup redemption. Does not enable global redemption or call Stripe. On uncertain completion, GET the same code before retrying.

post/discount-codes

Request

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

Request body

codestring required

Unique code, 6–64 letters, digits, dashes or underscores; normalized to uppercase.

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

Required for repeating duration.

planKey'pro' | 'team' required

USD monthly base subscription only; excludes AI usage.

targetOrgIdstring

Optional recipient organization. Recipient-targeted codes are single-use.

targetUserIdstring

Optional recipient user; mutually exclusive with targetOrgId.

maxRedemptionsinteger nullable

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

redeemFromnumber

Optional redemption start, Unix milliseconds.

redeemBynumber

Optional future redemption deadline, Unix milliseconds.

Response

The resource.

Changes

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