Interface: PromoCodeResult

Defined in: packages/sdk/src/types/generated/promo_code.ts:127

Outcome of a preview or a redemption.

outcome is the machine-readable enum value and message the customer-safe sentence. Both are returned because the funnel needs to branch (retry the field vs. move on) and display something.

Deliberately carries no campaign internals — not the redemption cap, the remaining slot count, or whether a code merely has not launched yet. Those would let an unauthenticated-ish caller probe the campaign roster by guessing names.

Properties

bonusCredits?

optional bonusCredits: number | null

Defined in: packages/sdk/src/types/generated/promo_code.ts:134

Additional promotional credits included by a usable code.

---

creditsGranted?

optional creditsGranted: number | null

Defined in: packages/sdk/src/types/generated/promo_code.ts:131

---

expiresAt?

optional expiresAt: string | null

Defined in: packages/sdk/src/types/generated/promo_code.ts:132

---

message

message: string

Defined in: packages/sdk/src/types/generated/promo_code.ts:130

---

ok

ok: boolean

Defined in: packages/sdk/src/types/generated/promo_code.ts:128

---

orgProductId?

optional orgProductId: number | null

Defined in: packages/sdk/src/types/generated/promo_code.ts:136

Eligible self-service Organization product included by the code.

---

orgProductName?

optional orgProductName: string | null

Defined in: packages/sdk/src/types/generated/promo_code.ts:138

Display name of the included Organization product.

---

outcome

outcome: PromoCodeResultOutcome

Defined in: packages/sdk/src/types/generated/promo_code.ts:129

---

trialMonths?

optional trialMonths: number | null

Defined in: packages/sdk/src/types/generated/promo_code.ts:140

Number of direct-billing trial months included by the code.