Access tokens1

Account links1

Accounts15

Ad Campaigns9

Ad Conversion Value Rules7

Ad Groups10

Ads8

Affiliates10

Ai chats5

API Keys7

Api Logs1

App Builds4

Apps8

Audiences5

Authorized users4

Bounties7

Bounty Submissions5

Cards6

Cashback Rules4

Chat channels3

Checkout Configurations4

Company token transactions3

Confirmation Tokens1

Course chapters5

Course lesson interactions2

Course lessons8

Course students2

Courses5

Deposits1

Dispute alerts2

Disputes6

Dm channels5

Dm members5

Domains5

Economic Intelligence2

Events4

Experiences8

Experiments8

Exports3

Fee markups3

Files4

Forum posts4

Forums3

Identity profiles4

Invoices9

Leads4

Ledger accounts1

Ledgers3

Media2

Members3

Memberships11

Messages5

Notifications6

Partner Referral Requests6

Partners7

Payment Method Domains5

Payment methods3

Payment Rules9

Payments12

Payout accounts1

Payout methods2

Payouts10

People2

Permissions1

Plans6

Products7

Promo Codes6

Reactions4

Refunds2

Resolution Center Cases11

Reviews2

Setup Intents6

Shipments4

Social Accounts7

Stats2

Support channels3

Swaps4

Team Members5

Topups1

Trades5

Transfers4

Users18

Verifications4

Waitlist Entries7

Webhooks9

Webhooks

Accounts3

Ad Campaigns2

Ads1

Cards13

Course lesson interactions1

Deposits1

Dispute alerts1

Disputes2

Entries4

Exports2

Invoices5

Ledger accounts1

Ledgers1

Members2

Memberships4

Messages1

Payments7

Payout accounts1

Payouts4

Plans3

Products5

Reactions1

Refunds2

Resolution Center Cases3

Setup Intents3

Shipments2

Swaps1

Transfers3

Verifications2

Promo Codes

Retrieve Promo Code

Retrieves a promo code by ID.

get/promo_codes/{id}

Response

promo code retrieved

amount_offnumber required

Discount amount. Percentage discounts are represented as a decimal fraction.

churned_users_onlyboolean required

Whether the promo code is restricted to churned customers.

codestring nullable required

Code entered at checkout.

created_atstring required

When the promo code was created, as an ISO 8601 timestamp.

currency'usd' | 'sgd' | 'inr' | 'aud' | 'brl' | 'cad' | 'dkk' | 'eur' | 'nok' | 'gbp' | 'sek' | 'chf' | 'hkd' | 'huf' | 'jpy' | 'mxn' | 'myr' | 'pln' | 'czk' | 'nzd' | 'aed' | 'eth' | 'ape' | 'cop' | 'ron' | 'thb' | 'bgn' | 'idr' | 'dop' | 'php' | 'try' | 'krw' | 'twd' | 'vnd' | 'pkr' | 'clp' | 'uyu' | 'ars' | 'zar' | 'dzd' | 'tnd' | 'mad' | 'kes' | 'kwd' | 'jod' | 'all' | 'xcd' | 'amd' | 'bsd' | 'bhd' | 'bob' | 'bam' | 'khr' | 'crc' | 'xof' | 'egp' | 'etb' | 'gmd' | 'ghs' | 'gtq' | 'gyd' | 'ils' | 'jmd' | 'mop' | 'mga' | 'mur' | 'mdl' | 'mnt' | 'nad' | 'ngn' | 'mkd' | 'omr' | 'pyg' | 'pen' | 'qar' | 'rwf' | 'sar' | 'rsd' | 'lkr' | 'tzs' | 'ttd' | 'uzs' | 'rub' | 'btc' | 'cny' | 'usdt' | 'kzt' | 'awg' | 'whop_usd' | 'xau' required

Currency used for a fixed-amount discount.

duration'forever' | 'once' | 'repeating' required

How long the discount applies.

existing_memberships_onlyboolean required

Whether the promo code applies only to existing memberships.

expires_atstring nullable required

When the promo code expires, as an ISO 8601 timestamp.

idstring required

Promo code ID, prefixed promo_.

metadataobject required

Custom key-value metadata stored on the promo code.

new_users_onlyboolean required

Whether the promo code is restricted to new customers.

one_per_customerboolean required

Whether each customer may redeem the promo code only once.

promo_duration_monthsinteger nullable required

Billing intervals the discount applies to.

promo_type'percentage' | 'flat_amount' required

Whether the discount is percentage-based or a fixed amount.

status'active' | 'inactive' | 'archived' required

Promo code lifecycle status.

stockinteger required

Maximum uses when stock is limited.

unlimited_stockboolean required

Whether the promo code has no redemption limit.

updated_atstring required

When the promo code was updated, as an ISO 8601 timestamp.

usesinteger required

Memberships that used the promo code.

Example response

{
  "account": {
    "id": "biz_xxxxxxxxxxxxxx",
    "title": "Shine Time Auto Detailing"
  },
  "amount_off": 0.25,
  "code": "affiliate25",
  "created_at": "2026-01-01T12:00:00.000Z",
  "currency": "usd",
  "duration": "repeating",
  "expires_at": "2026-01-01T12:00:00.000Z",
  "id": "promo_xxxxxxxxxxxxxx",
  "metadata": {},
  "new_users_only": true,
  "one_per_customer": true,
  "product": {
    "id": "prod_xxxxxxxxxxxxxx",
    "title": "Ceramic Coating Package"
  },
  "promo_duration_months": 3,
  "promo_type": "percentage",
  "status": "active",
  "stock": 200,
  "updated_at": "2026-01-01T12:00:00.000Z"
}

Changes

Changed in 2 of the 74 revisions of this API.8615

Aug 7, 2026f1020c3ecda41See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 4, 2026bdd0e2c70d588614See the full diff
- ▲
  added subschema #2 to the response property oneOf list for the response status
  response-property-one-of-added
- ▲
  the response's property format changed from date-time to no format for status
  response-property-type-changed
- ▲
  the response's property type changed from no type to string for status
  response-property-type-changed
- ▲
  the response's property format changed from date-time to no format for status
  response-property-type-changed
- ▲
  the response's property type changed from object null to no type for status
  response-property-type-changed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ●
  deleted the path request parameter id
  request-parameter-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  added the new forever enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new once enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new repeating enum value to the response property for the response status
  response-property-enum-value-added
- ○
  the security scope access_pass:basic:read was removed from the endpoint's security scheme bearerAuth
  api-security-scope-removed
- ○
  api tag Promo Codes added
  api-tag-added
- ○
  api tag Promo codes removed
  api-tag-removed
- ○
  added the new optional header request parameter Api-Version-Date to all path's operations
  new-optional-request-default-parameter-to-existing-path
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed subschema #2 from the response property oneOf list for the response status
  response-property-one-of-removed
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.

Full history