Create Promotion Code

POST

/api/:account_id/promotion-codes/

Create a new promotion code linked to a coupon.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

account_idstringRequired

This endpoint expects an object.

coupon_idstringRequired

ID of the coupon this code applies

codestringRequired1-100 characters

The promotion code string

activebooleanOptionalDefaults to true

Whether the code is active

max_redemptionsinteger or nullOptional>=1

Maximum number of times this code can be redeemed

expires_atdatetime or nullOptional

When this promotion code expires

restrictionsobject or nullOptional

Restrictions on promotion code usage

metadatamap from strings to any or nullOptional

Arbitrary metadata

Successful Response

idstring

coupon_idstring

codestring

activeboolean

max_redemptionsinteger or null

times_redeemedinteger

expires_atdatetime or null

restrictionsmap from strings to any or null

metadatamap from strings to any or null

created_atdatetime

updated_atdatetime

422

Unprocessable Entity Error

$	curl -X POST https://app.paymentkit.com/api/account_id/promotion-codes/ \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"coupon_id": "coup_9f8e7d6c5b4a3",
>	"code": "SUMMER2024"
>	}'