Skip to main content
GET
Get a promotion

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

Response

Success.

id
string<uuid>
required
title
string
required
status
enum<string>
required
Available options:
ACTIVE,
PAUSED
description
string
take
number

Percentage of the fee the promotion's owner absorbs.

discountMode
enum<string>
Available options:
SINGLE,
CUSTOM
discount
number

Only meaningful when discountMode is SINGLE.

ownedByOrganization
boolean

True when your organization funds this promotion, false when it benefits from it.

paymentPlans
object[]
createdAt
string<date-time>
updatedAt
string<date-time>