A Promo Code object represents a promotional code that a Customer can redeem to add funds to their balance.
Promo Codes are a great tool for physical handouts or other marketing collateral to drive wallet adoption.
Promo Code Attributes
| Field | Type | Description | Example value |
|---|---|---|---|
id | string | Unique identifier for the promo code. | 2aa3d415-8256-4d0e-97a1-7cd0a09e0230 |
merchantId | string | Identifier of the merchant for this promo code. | 83ac5214-5c2b-4d41-83a2-ffc58903f392 |
code | string | The code that user's will enter to redeem the code. Case insensitive, stored in uppercase. | FREE-COFFEE |
amount | integer | The credit amount that the user receives when this promo code is redeemed. The integer amount is in the lowest denomination of the merchant currency code. | 500 (equivalent to $5 USD) |
isActive | boolean | A simple flag to determine if the code is still active. The code field must be unique for all active codes. In order to re-use the same code text, update the previous promo code to be inactive. | true |
startDate | timestamp | The timestamp (in RFC 3339 format) when the promo code will start. A promo code is not redeemable before the startDate | 2022-12-08T23:47:41.643Z |
endDate | timestamp | The timestamp (in RFC 3339 format) when the promo code will end. A promo code is not redeemable after the endDate.If endDate is not provided, the promo code will be indefinite. | 2022-12-09T23:47:41.643Z |
| expirationMetadata | object | information regarding the expiration configuration for this promo code | { "expirationType": "x_days_after_redeeming", "numDays": 10, } |
created | timestamp | The timestamp (in RFC 3339 format) when the promo code was created. | 2022-12-07T23:47:41.643Z |
updated | timestamp | The timestamp (in RFC 3339 format) when the promo code was last updated. | 2022-12-07T23:47:41.643Z |
Expiration Metadata
| Field | Type | Descrpition |
|---|---|---|
| expirationType | string | enum of "x_days_after_redeeming" or "fixed_date" |
| numDays | integer | the number of days for type "x_days_after_redeeming", note, creating with numDays = 0 will not configure any expiration for this promo code |
| fixedDate | timestamp | the date to expire these promo funds on for the type "fixed_date" |