User Offers

User offers represent trials, discounts, partner perks, rewards, and reactivation incentives available to a user.

User Offers Object

Represents trial and discount offers available to the current user.

User Offers Structure

Field	Type	Description
trial	array[user trial offer object]	Trial offers available to the user
discount	array[user discount offer object]	Discount offers available to the user

Partner Perk Activation Status Object

Represents the activation state of a partner perk.

Partner Perk Activation Status Structure

Field	Type	Description
perk	integer	The partner perk
state	integer	The activation state
entitlement_id	?snowflake	The ID of the entitlement granted for the perk
redirect	?string	The URL used to continue partner-side activation

Partner Perk Type

Value	Name	Description
1	XGPP	Xbox Game Pass perk

Partner Perk State

Value	Name	Description
1	INITIAL	Activation has started
2	AWAITING_ACTIVATION	Activation is awaiting partner action
3	ACTIVATED	The perk is active
4	FAILED	Activation failed
5	EXPIRED	The activation expired
6	CANCELLATION_PENDING	Cancellation is pending

Example Partner Perk Activation Status

{
  "perk": 1,
  "state": 3,
  "entitlement_id": "1422548914485198869",
  "redirect": null
}

Program Rewards Object

Contains rewards granted through Discord reward programs.

Program Rewards Structure

Field	Type	Description
rewards	array[program reward object]	The user's program rewards

Program Reward Structure

Field	Type	Description
reward_program	integer	The program through which the reward was granted

Endpoints

List User Offer IDs

GET/user-offer-ids

Returns the IDs of offers available to the current user.

The response is an array of snowflakes.

List User Offers

GET/user-offers

Returns a user offers object.

List Program Rewards

GET/users/@me/program-rewards

Returns a program rewards object.

Redeem Reactivation Offer

POST/users/@me/billing/subscriptions/{subscription.id}/reactivation-offers/{reactivation-offer.id}/redeem

Redeems a subscription reactivation offer. Returns the updated subscription object on success.

Activate Partner Perk

POST/users/@me/partner-perks/{partner-perk.id}

Activates a partner perk. Returns a partner perk activation status object on success.

List Partner Perk Activation Status

GET/users/@me/partner-perks/{partner-perk.id}/activation-status

Returns a partner perk activation status object.

Create Reverse Trial

POST/user-offers/reverse-trial

Creates a reverse trial.

JSON Params

Field	Type	Description
ends_at	ISO8601 timestamp	When the reverse trial ends

Modify User Offer

PATCH/user-offers/{offer_type}/{offer.id}

Modifies user offer.

JSON Params

Field	Type	Description
expires_at	ISO8601 timestamp	When the offer expires