Promotions are special offers that users can redeem for various benefits, such as discounts or free trials. Outbound promotions are offers to third-party services, while inbound promotions are in-platform offers sponsored by third-party services.
Field Type Description id snowflake The ID of the promotion trial_id? snowflake The ID of the subscription trial associated with the promotion start_date ISO8601 timestamp When the promotion starts end_date ISO8601 timestamp When the promotion ends outbound_redemption_end_date? ISO8601 timestamp When the promotion's redemption period ends inbound_header_text? string The title of the inbound promotion inbound_body_text? string The description of the inbound promotion inbound_help_center_link? string The help center link of the inbound promotion outbound_title? string The title of the outbound promotion outbound_redemption_modal_body? string The description of the outbound promotion outbound_terms_and_conditions? string The terms and conditions of the promotion outbound_redemption_page_link? 1 string The redemption page to claim the outbound promotion outbound_redemption_url_format? 1 2 string The redemption page to claim the outbound promotion flags? integer The promotion's flags inbound_restricted_countries? array[string] The ISO 3166-1 alpha-2 codes of countries that the inbound promotion is not available in outbound_restricted_countries? array[string] The ISO 3166-1 alpha-2 codes of countries that the outbound promotion is not available in promotion_type integer The type of promotion partner_id? string The type of promotion partner marketing_components? array[promotion marketing component object] The components used in marketing
1 Only either or will be present.
2 This field is a formatted string. should be replaced with the claimed .
Value Name Description 1 << 5 IS_BLOCKED_IOS Promotion is not shown on iOS 1 << 6 IS_OUTBOUND_REDEEMABLE_BY_TRIAL_USERS Promotion is redeemable by trial user 1 << 7 SUPPRESS_NOTIFICATION Notifications about the promotion are suppressed
Value Name Description 0 THIRD_PARTY Third-party promotion 1 BOGO BOGO promotion 3 THIRD_PARTY_INBOUND Third-party inbound promotion 4 THIRD_PARTY_OUTBOUND Third-party outbound promotion 5 MARKETING_MOMENT Marketing moment 6 GIFT_PROMOTION Gift promotion
Value Name Description 0 ANNOUNCEMENT_MODAL Annonucement modal 1 PREMIUM_TAB Premium tab 2 MARKETING_PAGE_BANNER Marketing page banner 3 PAYMENT_MODAL_BANNER Payment modal banner 4 MOBILE_BOTTOM_SHEET Bottom sheet on mobile
Field Type Description code string The code of the claimed promotion user_id snowflake The ID of the user who claimed the promotion claimed_at ISO8601 timestamp When the promotion was claimed at promotion promotion objectThe promotion
GET/outbound-promotionsTest
Returns a list of promotion objects the current user is eligible for.
Field Type Description locale? string The language to return promotions in platform? integer The platform to get promotions for
Value Name Description 0 DESKTOP Desktop 1 MOBILE Mobile
Returns a list of promotion objects the current user is eligible for.
Field Type Description locale? string The language to return promotions in platform? integer The platform to get promotions for
Same as above, except only returns promotions of type
Field Type Description locale? string The language to return promotions in
GET/users/@me/outbound-promotions/codesTest
Returns a list of claimed promotion for the current user.
Field Type Description locale? string The language to return promotions in
POST/outbound-promotions/{promotion.id}/claimTest
Claims a promotion. Returns a claimed promotion object on success.