https://api.vimeo.com/ondemand/pages/{ondemand_id}/promotions

Get all the promotions on an On Demand page

Use Application:

Add a promotion to an On Demand page

Name Value Description Required
access_type

The promotion access type, which is a purchase option that is not available on the container. VIP promotions always make the content free of charge. If you use this type, you must further define the promotion with the download or stream_period fields.

No
code

The promotion code. This field is ignored for batch promotions.

No
discount_type

The type of discount offered by the promo code. When access_type is vip, the value of this field must be free.

No
download

Whether the promotion grants download access to VOD content. This is necessary only when not previously defined in the On Demand container or when access_type is vip or product_type is buy.

Yes
end_time

The end of the promotion period. If you do not specify a value, the promotion will never expire.

No
label

The description of a batch promotion. This field is ignored for single promotions.

No
percent_off

The percentage of the discount by using this promo code. This field is applicable only when discount_type is percent.

No
product_type

The type of transaction to which the promotion applies. When access_type is default, the default value is any, but the default value is rent when access_type is vip. Also, when access_type is vip, the only valid product types are buy and rent.

No
start_time

The start of the promotion period. If you do not specify a value, the start time defaults to the time that the promotion was created.

No
stream_period

The amount of time that a user has access to the VOD content upon redeeming a promo code. This field is necessary only when not defined in the On Demand container or when creating promotions when access_type is vip or product_type is rent.

Yes
total

The number of promotions to generate when type is batch, or the number of uses of the promotion when type is single.

Yes
type

The type of promotion. When access_type is vip, the value for this field must be batch.

Yes
Use Application:


Send Feedback