Sign in

v1

latestOpenAPI 3.1.02026-07-2631111195.5 KB
Promotions
Experimental

Retrieve promotion enrollment details by enrollment ID.

Endpoint available to Partners only. The request must be authenticated by a user access token that the user has granted to the Partner for the account.

OAuth

This endpoint requires the promotions:read OAuth scope.

get/v2/promotions/{enrollment_id}

Path parameters

enrollment_idstring required

Response

Succcessful retrieval of promotion details

promotion_idstring required

The unique identifier for the promotion

enrollment_datestring date-time nullable required

Date and time of enrollment

expiration_datestring date-time nullable required

Date and time when the promotion expires

task_limit_per_monthinteger nullable required

Maximum number of tasks allowed per monthly billing cycle

tasks_used_this_monthinteger required

Number of tasks already used this monthly billing cycle (may not align with calendar month)

statusstring required

Current status of the enrollment