Withdraw Credits

Headers

x-api-key

string

required

The API key to authenticate with.

Path Parameters

app_user_id

string

required

The app user id of the user to withdraw credits from.

Body

application/json

key

string

required

The key of the credit reward to withdraw

Example:

"credit-reward"

amount

integer

required

The amount of credits to withdraw

Required range: x >= 1

Example:

100

operation_id

string | null

An optional operation id that ensures the same operation won't be performed again

Example:

"821fae4b5-0123-4567-9152-5297086a161c"

Response

The result of the withdrawal of credits

data

object

required

Show child attributes

data.withdraw_result

object

required

The withdraw result

Show child attributes

data.withdraw_result.credits_available_at_start

integer

required

The amount of credits available at the start

Example:

100

data.withdraw_result.credits_available_at_end

integer

required

The amount of credits available at the end

Example:

90

data.withdraw_result.credits_requested_to_withdraw

integer

required

The amount of credits requested to withdraw

Example:

10

data.withdraw_result.credits_withdrawn

integer

required

The amount of credits withdrawn

Example:

10

data.user

object

required

The user

Show child attributes

data.user.app_user_id

string

required

The unique identifier of the user in your app.

Example:

"821fae4b5-1a2d-4c1e-9152-5297086a161c"

data.user.referral_code

string | null

required

The referral code of the user.

Example:

"XYZ123"

data.user.referral_code_link

string | null

required

The referral code link of the user.

Example:

"https://appname.wwk.link/XYZ123"

data.user.is_trial

boolean | null

required

Whether the user is a trial user.

Example:

false

data.user.is_premium

boolean | null

required

Whether the user is a premium user.

Example:

false

data.user.first_seen_at

string<date-time> | null

required

The date when the user was first seen at.

Example:

"2024-11-10T10:28:18.104Z"

data.user.last_seen_at

string<date-time> | null

required

deprecated

The date when the user was last seen at. Deprecated, always returns null and will be removed in the future.

Example:

null

data.user.metadata

object

required

The metadata of the user.

Example:

{}

data.user.stripe_customer_id

string | null

required

The unique identifier of the user in Stripe.

Example:

"cus_1234567890"

data.user.claim_code_eligibility

object

required

The claim code eligibility of the user.

Show child attributes

data.user.claim_code_eligibility.eligible

boolean

required

The claim code eligibility flag.

Example:

true

data.user.claim_code_eligibility.eligible_until

string<date-time> | null

required

The claim code eligibility until date.

Example:

"2024-11-10T10:28:18.104Z"

data.user.referred_by

object

required

The referred by object of the user.

Show child attributes

data.user.referred_by.code

string | null

required

The code claimed by the user. Can be null if the code's entity has been deleted.

Example:

"XYZ123"

data.user.referred_by.type

enum<string>

required

The type of the code. Can be one of "affiliate", "promo", or "referral".

Available options:

affiliate,

promo,

referral

Example:

"referral"

data.user.stats

object

required

The stats of the user.

Show child attributes

data.user.stats.claims

integer

required

The number of users who have claimed the referral code.

Example:

0

data.user.stats.conversions

integer

required

The number of users who have converted to premium.

Example:

0

data.user.stats.churns

integer

required

The number of users who have churned.

Example:

0

data.user.rewards

object

required

The rewards of the user.

Show child attributes

data.user.rewards.active

object

required

The referral user active rewards

Show child attributes

data.user.rewards.active.basic

object[]

required

The referral user basic rewards

Show child attributes

data.user.rewards.active.basic.reward

object

required

The reward

Show child attributes

data.user.rewards.active.basic.reward.key

string

required

The key of the reward

Example:

"basic-reward"

data.user.rewards.active.basic.reward.name

string

required

The name of the reward

Example:

"Basic Reward"

data.user.rewards.active.basic.reward.description

string | null

required

The description of the reward

Example:

"This is a basic reward"

data.user.rewards.active.basic.reward.metadata

object

required

The metadata of the reward

Example:

{}

data.user.rewards.active.basic.reward.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.basic.reward.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.basic.expires_at

string<date-time> | null

required

The expiration date of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.basic.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.basic.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.credit

object[]

required

The referral user credit rewards

Show child attributes

data.user.rewards.active.credit.reward

object

required

The reward

Show child attributes

data.user.rewards.active.credit.reward.key

string

required

The key of the reward

Example:

"credit-reward"

data.user.rewards.active.credit.reward.credits

integer

required

The credits of the reward

Example:

100

data.user.rewards.active.credit.reward.name

string

required

The name of the reward

Example:

"Credit Reward"

data.user.rewards.active.credit.reward.description

string | null

required

The description of the reward

Example:

"This is a credit reward"

data.user.rewards.active.credit.reward.metadata

object

required

The metadata of the reward

Example:

{}

data.user.rewards.active.credit.reward.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.credit.reward.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.credit.credits

integer

required

The amount of the reward

Example:

100

data.user.rewards.active.credit.expires_at

string<date-time> | null

required

The expiration date of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.credit.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.credit.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.offer_code

object[]

required

The referral user offer code rewards

Show child attributes

data.user.rewards.active.offer_code.reward

object

required

The reward

Show child attributes

data.user.rewards.active.offer_code.reward.key

string

required

The key of the reward

Example:

"offer-code-reward"

data.user.rewards.active.offer_code.reward.offer_code_id

string

required

The offer code id

Example:

"123e4567-e89b-12d3-a456-426614174000"

data.user.rewards.active.offer_code.reward.offer_code_ref_name

string

required

The offer code reference name that is set in the App Store Connect

Example:

"Free Month"

data.user.rewards.active.offer_code.reward.subscription_product_id

string

required

The subscription product id of the offer code

Example:

"com.winwinkit.monthly"

data.user.rewards.active.offer_code.reward.name

string

required

The name of the reward

Example:

"Offer Code Reward"

data.user.rewards.active.offer_code.reward.description

string | null

required

The description of the reward

Example:

"This is an offer code reward"

data.user.rewards.active.offer_code.reward.metadata

object

required

The metadata of the reward

Example:

{}

data.user.rewards.active.offer_code.reward.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.offer_code.reward.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.offer_code.value

object

required

The offer code value

Show child attributes

data.user.rewards.active.offer_code.value.value

string

required

The offer code value

Example:

"ABCDEFGHIJKLMNOPQR"

data.user.rewards.active.offer_code.value.link

string

required

The offer code redeem link

Example:

"https://apps.apple.com/redeem?ctx=offercodes&id=1234567890&code=ABCDEFGHIJKLMNOPQR"

data.user.rewards.active.offer_code.value.expires_at

string<date-time>

required

The offer code value expiration date

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.offer_code.expires_at

string<date-time> | null

required

The expiration date of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.offer_code.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.offer_code.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

The referral user Google Play promo code rewards

Show child attributes

The reward

Show child attributes

The key of the reward

Example:

"promo-code-reward"

The name of the reward

Example:

"Promo Code Reward"

The description of the reward

Example:

"This is a promo code reward"

The metadata of the reward

Example:

{}

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

The promo code value

Show child attributes

The promo code value

Example:

"ABCDEFGHIJKLMNOPQR"

The promo code value expiration date

Example:

"2021-01-01T00:00:00.000Z"

The expiration date of the reward

Example:

"2021-01-01T00:00:00.000Z"

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.revenuecat_entitlement

object[]

required

The referral user RevenueCat entitlement rewards

Show child attributes

data.user.rewards.active.revenuecat_entitlement.reward

object

required

The reward

Show child attributes

data.user.rewards.active.revenuecat_entitlement.reward.key

string

required

The key of the reward

Example:

"premium-entitlement"

data.user.rewards.active.revenuecat_entitlement.reward.entitlement_id

string

required

The entitlement ID of the reward

Example:

"entl1234567890"

data.user.rewards.active.revenuecat_entitlement.reward.entitlement_key

string

required

The entitlement key of the reward

Example:

"premium"

data.user.rewards.active.revenuecat_entitlement.reward.name

string

required

The name of the reward

Example:

"Premium Access"

data.user.rewards.active.revenuecat_entitlement.reward.description

string | null

required

The description of the reward

Example:

"This is an RevenueCat entitlement reward"

data.user.rewards.active.revenuecat_entitlement.reward.metadata

object

required

The metadata of the reward

Example:

{}

data.user.rewards.active.revenuecat_entitlement.reward.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.revenuecat_entitlement.reward.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.revenuecat_entitlement.expires_at

string<date-time> | null

required

The expiration date of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.revenuecat_entitlement.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.revenuecat_entitlement.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.revenuecat_offering

object[]

required

The referral user RevenueCat offering rewards

Show child attributes

data.user.rewards.active.revenuecat_offering.reward

object

required

The reward

Show child attributes

data.user.rewards.active.revenuecat_offering.reward.key

string

required

The key of the reward

Example:

"discounted-offering"

data.user.rewards.active.revenuecat_offering.reward.offering_id

string

required

The offering ID of the reward

Example:

"ofrng1234567890"

data.user.rewards.active.revenuecat_offering.reward.offering_key

string

required

The offering key of the reward

Example:

"discounted"

data.user.rewards.active.revenuecat_offering.reward.name

string

required

The name of the reward

Example:

"Discounted Offering"

data.user.rewards.active.revenuecat_offering.reward.description

string | null

required

The description of the reward

Example:

"This is an RevenueCat offering reward"

data.user.rewards.active.revenuecat_offering.reward.metadata

object

required

The metadata of the reward

Example:

{}

data.user.rewards.active.revenuecat_offering.reward.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.revenuecat_offering.reward.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.revenuecat_offering.expires_at

string<date-time> | null

required

The expiration date of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.revenuecat_offering.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.active.revenuecat_offering.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired

object

required

The referral user expired rewards

Show child attributes

data.user.rewards.expired.basic

object[]

required

The referral user basic rewards

Show child attributes

data.user.rewards.expired.basic.reward

object

required

The reward

Show child attributes

data.user.rewards.expired.basic.reward.key

string

required

The key of the reward

Example:

"basic-reward"

data.user.rewards.expired.basic.reward.name

string

required

The name of the reward

Example:

"Basic Reward"

data.user.rewards.expired.basic.reward.description

string | null

required

The description of the reward

Example:

"This is a basic reward"

data.user.rewards.expired.basic.reward.metadata

object

required

The metadata of the reward

Example:

{}

data.user.rewards.expired.basic.reward.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.basic.reward.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.basic.expired_at

string<date-time>

required

The expiration date of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.basic.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.basic.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.credit

object[]

required

The referral user credit rewards

Show child attributes

data.user.rewards.expired.credit.reward

object

required

The reward

Show child attributes

data.user.rewards.expired.credit.reward.key

string

required

The key of the reward

Example:

"credit-reward"

data.user.rewards.expired.credit.reward.credits

integer

required

The credits of the reward

Example:

100

data.user.rewards.expired.credit.reward.name

string

required

The name of the reward

Example:

"Credit Reward"

data.user.rewards.expired.credit.reward.description

string | null

required

The description of the reward

Example:

"This is a credit reward"

data.user.rewards.expired.credit.reward.metadata

object

required

The metadata of the reward

Example:

{}

data.user.rewards.expired.credit.reward.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.credit.reward.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.credit.expired_at

string<date-time>

required

The expiration date of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.credit.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.credit.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.offer_code

object[]

required

The referral user offer code rewards

Show child attributes

data.user.rewards.expired.offer_code.reward

object

required

The reward

Show child attributes

data.user.rewards.expired.offer_code.reward.key

string

required

The key of the reward

Example:

"offer-code-reward"

data.user.rewards.expired.offer_code.reward.offer_code_id

string

required

The offer code id

Example:

"123e4567-e89b-12d3-a456-426614174000"

data.user.rewards.expired.offer_code.reward.offer_code_ref_name

string

required

The offer code reference name that is set in the App Store Connect

Example:

"Free Month"

data.user.rewards.expired.offer_code.reward.subscription_product_id

string

required

The subscription product id of the offer code

Example:

"com.winwinkit.monthly"

data.user.rewards.expired.offer_code.reward.name

string

required

The name of the reward

Example:

"Offer Code Reward"

data.user.rewards.expired.offer_code.reward.description

string | null

required

The description of the reward

Example:

"This is an offer code reward"

data.user.rewards.expired.offer_code.reward.metadata

object

required

The metadata of the reward

Example:

{}

data.user.rewards.expired.offer_code.reward.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.offer_code.reward.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.offer_code.expired_at

string<date-time>

required

The expiration date of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.offer_code.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.offer_code.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

The referral user Google Play promo code rewards

Show child attributes

The reward

Show child attributes

The key of the reward

Example:

"promo-code-reward"

The name of the reward

Example:

"Promo Code Reward"

The description of the reward

Example:

"This is a promo code reward"

The metadata of the reward

Example:

{}

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

The expiration date of the reward

Example:

"2021-01-01T00:00:00.000Z"

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.revenuecat_entitlement

object[]

required

The referral user RevenueCat entitlement rewards

Show child attributes

data.user.rewards.expired.revenuecat_entitlement.reward

object

required

The reward

Show child attributes

data.user.rewards.expired.revenuecat_entitlement.reward.key

string

required

The key of the reward

Example:

"premium-entitlement"

data.user.rewards.expired.revenuecat_entitlement.reward.entitlement_id

string

required

The entitlement ID of the reward

Example:

"entl1234567890"

data.user.rewards.expired.revenuecat_entitlement.reward.entitlement_key

string

required

The entitlement key of the reward

Example:

"premium"

data.user.rewards.expired.revenuecat_entitlement.reward.name

string

required

The name of the reward

Example:

"Premium Access"

data.user.rewards.expired.revenuecat_entitlement.reward.description

string | null

required

The description of the reward

Example:

"This is an RevenueCat entitlement reward"

data.user.rewards.expired.revenuecat_entitlement.reward.metadata

object

required

The metadata of the reward

Example:

{}

data.user.rewards.expired.revenuecat_entitlement.reward.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.revenuecat_entitlement.reward.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.revenuecat_entitlement.expired_at

string<date-time> | null

required

The expiration date of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.revenuecat_entitlement.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.revenuecat_entitlement.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.revenuecat_offering

object[]

required

The referral user RevenueCat offering rewards

Show child attributes

data.user.rewards.expired.revenuecat_offering.reward

object

required

The reward

Show child attributes

data.user.rewards.expired.revenuecat_offering.reward.key

string

required

The key of the reward

Example:

"discounted-offering"

data.user.rewards.expired.revenuecat_offering.reward.offering_id

string

required

The offering ID of the reward

Example:

"ofrng1234567890"

data.user.rewards.expired.revenuecat_offering.reward.offering_key

string

required

The offering key of the reward

Example:

"discounted"

data.user.rewards.expired.revenuecat_offering.reward.name

string

required

The name of the reward

Example:

"Discounted Offering"

data.user.rewards.expired.revenuecat_offering.reward.description

string | null

required

The description of the reward

Example:

"This is an RevenueCat offering reward"

data.user.rewards.expired.revenuecat_offering.reward.metadata

object

required

The metadata of the reward

Example:

{}

data.user.rewards.expired.revenuecat_offering.reward.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.revenuecat_offering.reward.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.revenuecat_offering.expired_at

string<date-time> | null

required

The expiration date of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.revenuecat_offering.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.rewards.expired.revenuecat_offering.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program

object

required

The program of the user.

Show child attributes

data.user.referral_program.id

string

required

The program id

Example:

"123e4567-e89b-12d3-a456-426614174000"

data.user.referral_program.name

string

required

The program name

Example:

"Referral Program #1"

data.user.referral_program.description

string | null

required

The program description

Example:

"This is a referral program"

data.user.referral_program.metadata

object

required

The program metadata

Example:

{}

data.user.referral_program.distribution_percentage

integer

required

The program distribution percentage

Example:

100

data.user.referral_program.limit

integer

required

The program limit

Example:

0

data.user.referral_program.rewards

object

required

The program rewards

Show child attributes

data.user.referral_program.rewards.sender

object

required

The program sender rewards

Show child attributes

data.user.referral_program.rewards.sender.basic

object[]

required

The program basic rewards

Show child attributes

data.user.referral_program.rewards.sender.basic.reward

object

required

The reward

Show child attributes

data.user.referral_program.rewards.sender.basic.reward.key

string

required

The key of the reward

Example:

"basic-reward"

data.user.referral_program.rewards.sender.basic.reward.name

string

required

The name of the reward

Example:

"Basic Reward"

data.user.referral_program.rewards.sender.basic.reward.description

string | null

required

The description of the reward

Example:

"This is a basic reward"

data.user.referral_program.rewards.sender.basic.reward.metadata

object

required

The metadata of the reward

Example:

{}

data.user.referral_program.rewards.sender.basic.reward.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.rewards.sender.basic.reward.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.rewards.sender.basic.activation

object

required

The activation configuration

Show child attributes

data.user.referral_program.rewards.sender.basic.activation.variant

enum<string>

required

The variant of the activation configuration

Available options:

claim,

conversion

Example:

"claim"

data.user.referral_program.rewards.sender.basic.activation.amount

integer

required

The amount of the activation configuration

Example:

1

data.user.referral_program.rewards.sender.basic.deactivation

object

required

The deactivation configuration

Option 1
Option 2

Show child attributes

data.user.referral_program.rewards.sender.basic.deactivation.variant

enum<string>

required

The variant of the deactivation configuration

Available options:

never

Example:

"never"

Example:

{ "variant": "never" }

data.user.referral_program.rewards.sender.credit

object[]

required

The program credit rewards

Show child attributes

data.user.referral_program.rewards.sender.credit.reward

object

required

The reward

Show child attributes

data.user.referral_program.rewards.sender.credit.reward.key

string

required

The key of the reward

Example:

"credit-reward"

data.user.referral_program.rewards.sender.credit.reward.credits

integer

required

The credits of the reward

Example:

100

data.user.referral_program.rewards.sender.credit.reward.name

string

required

The name of the reward

Example:

"Credit Reward"

data.user.referral_program.rewards.sender.credit.reward.description

string | null

required

The description of the reward

Example:

"This is a credit reward"

data.user.referral_program.rewards.sender.credit.reward.metadata

object

required

The metadata of the reward

Example:

{}

data.user.referral_program.rewards.sender.credit.reward.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.rewards.sender.credit.reward.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.rewards.sender.credit.activation

object

required

The activation configuration

Show child attributes

data.user.referral_program.rewards.sender.credit.activation.variant

enum<string>

required

The variant of the activation configuration

Available options:

claim,

conversion

Example:

"claim"

data.user.referral_program.rewards.sender.credit.activation.amount

integer

required

The amount of the activation configuration

Example:

1

data.user.referral_program.rewards.sender.credit.activation.limit

integer

required

The limit of the activation configuration

Example:

1

data.user.referral_program.rewards.sender.credit.deactivation

object

required

The deactivation configuration

Option 1
Option 2

Show child attributes

data.user.referral_program.rewards.sender.credit.deactivation.variant

enum<string>

required

The variant of the deactivation configuration

Available options:

never

Example:

"never"

Example:

{ "variant": "never" }

data.user.referral_program.rewards.sender.offer_code

object[]

required

The program offer code rewards

Show child attributes

data.user.referral_program.rewards.sender.offer_code.reward

object

required

The reward

Show child attributes

data.user.referral_program.rewards.sender.offer_code.reward.key

string

required

The key of the reward

Example:

"offer-code-reward"

data.user.referral_program.rewards.sender.offer_code.reward.offer_code_id

string

required

The offer code id

Example:

"123e4567-e89b-12d3-a456-426614174000"

data.user.referral_program.rewards.sender.offer_code.reward.offer_code_ref_name

string

required

The offer code reference name that is set in the App Store Connect

Example:

"Free Month"

data.user.referral_program.rewards.sender.offer_code.reward.subscription_product_id

string

required

The subscription product id of the offer code

Example:

"com.winwinkit.monthly"

data.user.referral_program.rewards.sender.offer_code.reward.name

string

required

The name of the reward

Example:

"Offer Code Reward"

data.user.referral_program.rewards.sender.offer_code.reward.description

string | null

required

The description of the reward

Example:

"This is an offer code reward"

data.user.referral_program.rewards.sender.offer_code.reward.metadata

object

required

The metadata of the reward

Example:

{}

data.user.referral_program.rewards.sender.offer_code.reward.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.rewards.sender.offer_code.reward.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.rewards.sender.offer_code.activation

object

required

The activation configuration

Show child attributes

data.user.referral_program.rewards.sender.offer_code.activation.variant

enum<string>

required

The variant of the activation configuration

Available options:

claim,

conversion

Example:

"claim"

data.user.referral_program.rewards.sender.offer_code.activation.amount

integer

required

The amount of the activation configuration

Example:

1

data.user.referral_program.rewards.sender.offer_code.activation.limit

integer

required

The limit of the activation configuration

Example:

1

data.user.referral_program.rewards.sender.offer_code.deactivation

object

required

The deactivation configuration

Option 1
Option 2

Show child attributes

data.user.referral_program.rewards.sender.offer_code.deactivation.variant

enum<string>

required

The variant of the deactivation configuration

Available options:

never

Example:

"never"

Example:

{ "variant": "never" }

The program Google Play promo code rewards

Show child attributes

The reward

Show child attributes

The key of the reward

Example:

"promo-code-reward"

The name of the reward

Example:

"Promo Code Reward"

The description of the reward

Example:

"This is a promo code reward"

The metadata of the reward

Example:

{}

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

The activation configuration

Show child attributes

The variant of the activation configuration

Available options:

claim,

conversion

Example:

"claim"

The amount of the activation configuration

Example:

1

The limit of the activation configuration

Example:

1

The deactivation configuration

Option 1
Option 2

Show child attributes

The variant of the deactivation configuration

Available options:

never

Example:

"never"

Example:

{ "variant": "never" }

data.user.referral_program.rewards.sender.revenuecat_entitlement

object[]

required

The program RevenueCat entitlement rewards

Show child attributes

data.user.referral_program.rewards.sender.revenuecat_entitlement.reward

object

required

The reward

Show child attributes

data.user.referral_program.rewards.sender.revenuecat_entitlement.reward.key

string

required

The key of the reward

Example:

"premium-entitlement"

data.user.referral_program.rewards.sender.revenuecat_entitlement.reward.entitlement_id

string

required

The entitlement ID of the reward

Example:

"entl1234567890"

data.user.referral_program.rewards.sender.revenuecat_entitlement.reward.entitlement_key

string

required

The entitlement key of the reward

Example:

"premium"

data.user.referral_program.rewards.sender.revenuecat_entitlement.reward.name

string

required

The name of the reward

Example:

"Premium Access"

data.user.referral_program.rewards.sender.revenuecat_entitlement.reward.description

string | null

required

The description of the reward

Example:

"This is an RevenueCat entitlement reward"

data.user.referral_program.rewards.sender.revenuecat_entitlement.reward.metadata

object

required

The metadata of the reward

Example:

{}

data.user.referral_program.rewards.sender.revenuecat_entitlement.reward.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.rewards.sender.revenuecat_entitlement.reward.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.rewards.sender.revenuecat_entitlement.activation

object

required

The activation configuration

Show child attributes

data.user.referral_program.rewards.sender.revenuecat_entitlement.activation.variant

enum<string>

required

The variant of the activation configuration

Available options:

claim,

conversion

Example:

"claim"

data.user.referral_program.rewards.sender.revenuecat_entitlement.activation.amount

integer

required

The amount of the activation configuration

Example:

1

data.user.referral_program.rewards.sender.revenuecat_entitlement.deactivation

object

required

The deactivation configuration

Option 1
Option 2

Show child attributes

data.user.referral_program.rewards.sender.revenuecat_entitlement.deactivation.variant

enum<string>

required

The variant of the deactivation configuration

Available options:

never

Example:

"never"

Example:

{ "variant": "never" }

data.user.referral_program.rewards.sender.revenuecat_offering

object[]

required

The program RevenueCat offering rewards

Show child attributes

data.user.referral_program.rewards.sender.revenuecat_offering.reward

object

required

The reward

Show child attributes

data.user.referral_program.rewards.sender.revenuecat_offering.reward.key

string

required

The key of the reward

Example:

"discounted-offering"

data.user.referral_program.rewards.sender.revenuecat_offering.reward.offering_id

string

required

The offering ID of the reward

Example:

"ofrng1234567890"

data.user.referral_program.rewards.sender.revenuecat_offering.reward.offering_key

string

required

The offering key of the reward

Example:

"discounted"

data.user.referral_program.rewards.sender.revenuecat_offering.reward.name

string

required

The name of the reward

Example:

"Discounted Offering"

data.user.referral_program.rewards.sender.revenuecat_offering.reward.description

string | null

required

The description of the reward

Example:

"This is an RevenueCat offering reward"

data.user.referral_program.rewards.sender.revenuecat_offering.reward.metadata

object

required

The metadata of the reward

Example:

{}

data.user.referral_program.rewards.sender.revenuecat_offering.reward.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.rewards.sender.revenuecat_offering.reward.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.rewards.sender.revenuecat_offering.activation

object

required

The activation configuration

Show child attributes

data.user.referral_program.rewards.sender.revenuecat_offering.activation.variant

enum<string>

required

The variant of the activation configuration

Available options:

claim,

conversion

Example:

"claim"

data.user.referral_program.rewards.sender.revenuecat_offering.activation.amount

integer

required

The amount of the activation configuration

Example:

1

data.user.referral_program.rewards.sender.revenuecat_offering.deactivation

object

required

The deactivation configuration

Option 1
Option 2

Show child attributes

data.user.referral_program.rewards.sender.revenuecat_offering.deactivation.variant

enum<string>

required

The variant of the deactivation configuration

Available options:

never

Example:

"never"

Example:

{ "variant": "never" }

data.user.referral_program.rewards.receiver

object

required

The program receiver rewards

Show child attributes

data.user.referral_program.rewards.receiver.basic

object[]

required

The program basic rewards

Show child attributes

data.user.referral_program.rewards.receiver.basic.reward

object

required

The reward

Show child attributes

data.user.referral_program.rewards.receiver.basic.reward.key

string

required

The key of the reward

Example:

"basic-reward"

data.user.referral_program.rewards.receiver.basic.reward.name

string

required

The name of the reward

Example:

"Basic Reward"

data.user.referral_program.rewards.receiver.basic.reward.description

string | null

required

The description of the reward

Example:

"This is a basic reward"

data.user.referral_program.rewards.receiver.basic.reward.metadata

object

required

The metadata of the reward

Example:

{}

data.user.referral_program.rewards.receiver.basic.reward.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.rewards.receiver.basic.reward.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.rewards.receiver.basic.activation

object

required

The activation configuration

Show child attributes

data.user.referral_program.rewards.receiver.basic.activation.variant

enum<string>

required

The variant of the activation configuration

Available options:

claim,

conversion

Example:

"claim"

data.user.referral_program.rewards.receiver.basic.deactivation

object

required

The deactivation configuration

Option 1
Option 2

Show child attributes

data.user.referral_program.rewards.receiver.basic.deactivation.variant

enum<string>

required

The variant of the deactivation configuration

Available options:

never

Example:

"never"

Example:

{ "variant": "never" }

data.user.referral_program.rewards.receiver.credit

object[]

required

The program credit rewards

Show child attributes

data.user.referral_program.rewards.receiver.credit.reward

object

required

The reward

Show child attributes

data.user.referral_program.rewards.receiver.credit.reward.key

string

required

The key of the reward

Example:

"credit-reward"

data.user.referral_program.rewards.receiver.credit.reward.credits

integer

required

The credits of the reward

Example:

100

data.user.referral_program.rewards.receiver.credit.reward.name

string

required

The name of the reward

Example:

"Credit Reward"

data.user.referral_program.rewards.receiver.credit.reward.description

string | null

required

The description of the reward

Example:

"This is a credit reward"

data.user.referral_program.rewards.receiver.credit.reward.metadata

object

required

The metadata of the reward

Example:

{}

data.user.referral_program.rewards.receiver.credit.reward.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.rewards.receiver.credit.reward.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.rewards.receiver.credit.activation

object

required

The activation configuration

Show child attributes

data.user.referral_program.rewards.receiver.credit.activation.variant

enum<string>

required

The variant of the activation configuration

Available options:

claim,

conversion

Example:

"claim"

data.user.referral_program.rewards.receiver.credit.deactivation

object

required

The deactivation configuration

Option 1
Option 2

Show child attributes

data.user.referral_program.rewards.receiver.credit.deactivation.variant

enum<string>

required

The variant of the deactivation configuration

Available options:

never

Example:

"never"

Example:

{ "variant": "never" }

data.user.referral_program.rewards.receiver.offer_code

object[]

required

The program offer code rewards

Show child attributes

data.user.referral_program.rewards.receiver.offer_code.reward

object

required

The reward

Show child attributes

data.user.referral_program.rewards.receiver.offer_code.reward.key

string

required

The key of the reward

Example:

"offer-code-reward"

data.user.referral_program.rewards.receiver.offer_code.reward.offer_code_id

string

required

The offer code id

Example:

"123e4567-e89b-12d3-a456-426614174000"

data.user.referral_program.rewards.receiver.offer_code.reward.offer_code_ref_name

string

required

The offer code reference name that is set in the App Store Connect

Example:

"Free Month"

data.user.referral_program.rewards.receiver.offer_code.reward.subscription_product_id

string

required

The subscription product id of the offer code

Example:

"com.winwinkit.monthly"

data.user.referral_program.rewards.receiver.offer_code.reward.name

string

required

The name of the reward

Example:

"Offer Code Reward"

data.user.referral_program.rewards.receiver.offer_code.reward.description

string | null

required

The description of the reward

Example:

"This is an offer code reward"

data.user.referral_program.rewards.receiver.offer_code.reward.metadata

object

required

The metadata of the reward

Example:

{}

data.user.referral_program.rewards.receiver.offer_code.reward.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.rewards.receiver.offer_code.reward.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.rewards.receiver.offer_code.activation

object

required

The activation configuration

Show child attributes

data.user.referral_program.rewards.receiver.offer_code.activation.variant

enum<string>

required

The variant of the activation configuration

Available options:

claim

Example:

"claim"

data.user.referral_program.rewards.receiver.offer_code.deactivation

object

required

The deactivation configuration

Option 1
Option 2

Show child attributes

data.user.referral_program.rewards.receiver.offer_code.deactivation.variant

enum<string>

required

The variant of the deactivation configuration

Available options:

never

Example:

"never"

Example:

{ "variant": "never" }

The program Google Play promo code rewards

Show child attributes

The reward

Show child attributes

The key of the reward

Example:

"promo-code-reward"

The name of the reward

Example:

"Promo Code Reward"

The description of the reward

Example:

"This is a promo code reward"

The metadata of the reward

Example:

{}

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

The activation configuration

Show child attributes

The variant of the activation configuration

Available options:

claim

Example:

"claim"

The deactivation configuration

Option 1
Option 2

Show child attributes

The variant of the deactivation configuration

Available options:

never

Example:

"never"

Example:

{ "variant": "never" }

data.user.referral_program.rewards.receiver.revenuecat_entitlement

object[]

required

The program RevenueCat entitlement rewards

Show child attributes

data.user.referral_program.rewards.receiver.revenuecat_entitlement.reward

object

required

The reward

Show child attributes

data.user.referral_program.rewards.receiver.revenuecat_entitlement.reward.key

string

required

The key of the reward

Example:

"premium-entitlement"

data.user.referral_program.rewards.receiver.revenuecat_entitlement.reward.entitlement_id

string

required

The entitlement ID of the reward

Example:

"entl1234567890"

data.user.referral_program.rewards.receiver.revenuecat_entitlement.reward.entitlement_key

string

required

The entitlement key of the reward

Example:

"premium"

data.user.referral_program.rewards.receiver.revenuecat_entitlement.reward.name

string

required

The name of the reward

Example:

"Premium Access"

data.user.referral_program.rewards.receiver.revenuecat_entitlement.reward.description

string | null

required

The description of the reward

Example:

"This is an RevenueCat entitlement reward"

data.user.referral_program.rewards.receiver.revenuecat_entitlement.reward.metadata

object

required

The metadata of the reward

Example:

{}

data.user.referral_program.rewards.receiver.revenuecat_entitlement.reward.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.rewards.receiver.revenuecat_entitlement.reward.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.rewards.receiver.revenuecat_entitlement.activation

object

required

The activation configuration

Show child attributes

data.user.referral_program.rewards.receiver.revenuecat_entitlement.activation.variant

enum<string>

required

The variant of the activation configuration

Available options:

claim,

conversion

Example:

"claim"

data.user.referral_program.rewards.receiver.revenuecat_entitlement.deactivation

object

required

The deactivation configuration

Option 1
Option 2

Show child attributes

data.user.referral_program.rewards.receiver.revenuecat_entitlement.deactivation.variant

enum<string>

required

The variant of the deactivation configuration

Available options:

never

Example:

"never"

Example:

{ "variant": "never" }

data.user.referral_program.rewards.receiver.revenuecat_offering

object[]

required

The program RevenueCat offering rewards

Show child attributes

data.user.referral_program.rewards.receiver.revenuecat_offering.reward

object

required

The reward

Show child attributes

data.user.referral_program.rewards.receiver.revenuecat_offering.reward.key

string

required

The key of the reward

Example:

"discounted-offering"

data.user.referral_program.rewards.receiver.revenuecat_offering.reward.offering_id

string

required

The offering ID of the reward

Example:

"ofrng1234567890"

data.user.referral_program.rewards.receiver.revenuecat_offering.reward.offering_key

string

required

The offering key of the reward

Example:

"discounted"

data.user.referral_program.rewards.receiver.revenuecat_offering.reward.name

string

required

The name of the reward

Example:

"Discounted Offering"

data.user.referral_program.rewards.receiver.revenuecat_offering.reward.description

string | null

required

The description of the reward

Example:

"This is an RevenueCat offering reward"

data.user.referral_program.rewards.receiver.revenuecat_offering.reward.metadata

object

required

The metadata of the reward

Example:

{}

data.user.referral_program.rewards.receiver.revenuecat_offering.reward.created_at

string<date-time>

required

The created at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.rewards.receiver.revenuecat_offering.reward.updated_at

string<date-time> | null

required

The updated at of the reward

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.rewards.receiver.revenuecat_offering.activation

object

required

The activation configuration

Show child attributes

data.user.referral_program.rewards.receiver.revenuecat_offering.activation.variant

enum<string>

required

The variant of the activation configuration

Available options:

claim

Example:

"claim"

data.user.referral_program.rewards.receiver.revenuecat_offering.deactivation

object

required

The deactivation configuration

Option 1
Option 2

Show child attributes

data.user.referral_program.rewards.receiver.revenuecat_offering.deactivation.variant

enum<string>

required

The variant of the deactivation configuration

Available options:

never

Example:

"never"

Example:

{ "variant": "never" }

data.user.referral_program.created_at

string<date-time>

required

The program created at

Example:

"2021-01-01T00:00:00.000Z"

data.user.referral_program.updated_at

string<date-time> | null

required

The program updated at

Example:

"2021-01-01T00:00:00.000Z"

API Documentation

App Store

Users

Rewards Actions

Claim Actions

Headers

Path Parameters

Body

Response