VIvimeo
On Demand\Promotions

Get a specific promotion on an On Demand page

Information about this method appears below.

get/ondemand/pages/{ondemand_id}/promotions/{promotion_id}

Request

Path parameters

ondemand_idnumber required
Example:61326

The ID of the On Demand.

promotion_idnumber required
Example:12345

The ID of the promotion.

Response

The promotion was returned.

access_type'default' | 'vip' required

The type of access that this promotion grants:

Option descriptions:

  • default - Grants discounts on existing product offerings.
  • vip - Grants free access either to VOD content before it is released or to access types that aren't part of the existing product offerings.
discount_type'dollars' | 'free' | 'percent' required

The type of discount for which this promotion can be used.

Option descriptions:

  • dollars - The discount is a certain fixed amount.
  • free - The discount is the full purchase price. VIP access promotions always use this discount type.
  • percent - The discount is a certain percentage of the full price.
downloadboolean required

Whether this promotion grants download access to On Demand content.

labelstring nullable required

The prefix string for batch codes, or the null value for single codes.

percent_offnumber required

The percentage amount that is deducted from the product price.

product_type'any' | 'buy' | 'buy_episode' | 'rent' | 'rent_episode' | 'subscribe' required

The type of product to which this promotion can be applied. Only buy and rent are available for the VIP access type:

Option descriptions:

  • any - The promotion can be applied to any product.
  • buy - The promotion can be applied to a buyable single video.
  • buy_episode - The promotion can be applied to a buyable single episode.
  • rent - The promotion can be applied to a rentable single video.
  • rent_episode - The promotion can be applied to a rentable single episode.
  • subscribe - The promotion can be applied to a subscription.
stream_period'1_week' | '1_year' | '24_hour' | '30_days' | '3_month' | '48_hour' | '6_month' | '72_hour' nullable required

The amount of time that the user has access to the VOD content after redeeming a promo code.

Option descriptions:

  • 1_week - Access lasts for one week.
  • 1_year - Access lasts for one year.
  • 24_hour - Access lasts for 24 hours.
  • 30_days - Access lasts for 30 days.
  • 3_month - Access lasts for 3 months.
  • 48_hour - Access lasts for 48 hours.
  • 6_month - Access lasts for 6 months.
  • 72_hour - Access lasts for 72 hours.
totalnumber required

The total amount of times that this promotion can be used.

type'batch' | 'batch_prefix' | 'single' required

The way in which this promotion can generate promo codes:

Option descriptions:

  • batch - Provides many unique promo codes that can only be used once each.
  • batch_prefix - Similar to batch, except that all codes have a similar prefix string. This mode is deprecated, yet it may still appear for some users.
  • single - Provides a single promo code with many uses.
uristring required

The promotion's canonical relative URI.

Example response

{
  "access_type": "default",
  "discount_type": "free",
  "download": true,
  "label": "8jgaieumbzstujhn8k304iwwezawkvwm",
  "metadata": {
    "connections": {
      "codes": {
        "total": 1,
        "uri": "/ondemand/pages/61326/promotion/12345/codes"
      }
    }
  },
  "product_type": "any",
  "stream_period": "1_week",
  "total": 1,
  "type": "batch",
  "uri": "/ondemand/pages/61326/promotions/12345"
}

Changes

No recorded changes to this operation across all 13 revisions of this API.