---
updatedAt: 2026-05-29T20:03:06.000Z
agentTools:
  projectIndex: https://docs.zype.com/llms.txt
---

# Create video entitlement

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Consumers",
    "version": "1.0.0",
    "description": ""
  },
  "servers": [
    {
      "url": "https://api.zype.com/"
    }
  ],
  "security": [
    {
      "api_key": []
    }
  ],
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "api_key",
        "in": "query"
      }
    }
  },
  "paths": {
    "/consumers": {
      "get": {
        "summary": "List Consumers",
        "tags": [
          "Consumers"
        ],
        "operationId": "listConsumers",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Filter by ID\nExample: `id=5992f328ce593000ef000008`"
          },
          {
            "name": "created_at",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter records by created date using times in ISO8601 format (Example: `2017-01-01T00:00:00-00:00`) or Unix timestamps (Example: `1483228800`) **Note**: Range filters can be applied by adding a suffix: ‘.gt’, ‘.gte’, ‘.lt’, ‘lte’ (Example: `created_at.gte`)"
          },
          {
            "name": "updated_at",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter records by updated at date using times in ISO8601 format (Example: `2017-01-01T00:00:00-00:00`) or Unix timestamps (Example: `1483228800`) **Note**: Range filters can be applied by adding a suffix: ‘.gt’, ‘.gte’, ‘.lt’, ‘lte’ (Example: `updated_at.gte`)"
          },
          {
            "name": "q",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Filter by keyword"
          },
          {
            "name": "order",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "asc",
                "desc"
              ]
            },
            "description": "Filter by ascending or descending order"
          },
          {
            "name": "sort",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Sort on the specified field"
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "description": "Page number to return, with per_page dictating page size"
          },
          {
            "name": "per_page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "description": "Number of records to return per page"
          },
          {
            "name": "braintree_id",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter by the consumer's Braintree ID"
          },
          {
            "name": "recurly_code",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter by the consumer's Recurly Code"
          },
          {
            "name": "stripe_id",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter by the consumer's Stripe ID"
          },
          {
            "name": "email",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter by the consumer's email"
          },
          {
            "name": "password_token",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter by the consumer's password token"
          },
          {
            "name": "rss_token",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter by the consumer's RSS token"
          },
          {
            "name": "pass_count",
            "in": "query",
            "schema": {
              "type": "integer"
            },
            "description": "Filter consumers by the number of pass plans that have been purchased or redeemed.\n*Note*: Range filters can be applied by adding a suffix: ‘.gt’, ‘.gte’, ‘.lt’, ‘lte’ (Example: pass_count.gte = 1)"
          },
          {
            "name": "playlist_count",
            "in": "query",
            "schema": {
              "type": "integer"
            },
            "description": "Filter consumers by the number of playlists they are entitled to watch via purchase or pass plan.\n*Note*: Range filters can be applied by adding a suffix: ‘.gt’, ‘.gte’, ‘.lt’, ‘lte’ (Example: playlist_count.gte = 1)"
          },
          {
            "name": "remember_token",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "The password token to use during remember login workflows"
          },
          {
            "name": "sign_in_count",
            "in": "query",
            "schema": {
              "type": "integer"
            },
            "description": "Filter consumers by the number of times they have signed in.\n*Note*: Range filters can be applied by adding a suffix: ‘.gt’, ‘.gte’, ‘.lt’, ‘lte’ (Example: sign_in_count.gte)"
          },
          {
            "name": "last_sign_in_at",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter records by last_sign_in_at using times in ISO8601 format (Example: `2017-01-01T00:00:00-00:00`) or Unix timestamps (Example: `1483228800`) **Note**: Range filters can be applied by adding a suffix: ‘.gt’, ‘.gte’, ‘.lt’, ‘lte’ (Example: `last_sign_in_at.gte`)"
          },
          {
            "name": "current_sign_in_at",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter records by current_sign_in_at using times in ISO8601 format (Example: `2017-01-01T00:00:00-00:00`) or Unix timestamps (Example: `1483228800`) **Note**: Range filters can be applied by adding a suffix: ‘.gt’, ‘.gte’, ‘.lt’, ‘lte’ (Example: `current_sign_in_at.gte`)"
          },
          {
            "name": "terms",
            "in": "query",
            "schema": {
              "type": "boolean"
            },
            "description": "Boolean field to indicate if the consumer has agreed to terms and conditions"
          },
          {
            "name": "updates",
            "in": "query",
            "schema": {
              "type": "boolean"
            },
            "description": "Boolean field to indicate if the consumer has agreed to receive updates"
          },
          {
            "name": "video_count",
            "in": "query",
            "schema": {
              "type": "integer"
            },
            "description": "Filter records by video count\n*Note*: Range filters can be applied by adding a suffix: ‘.gt’, ‘.gte’, ‘.lt’, ‘lte’ (Example: video_count.gte = 3)"
          },
          {
            "name": "transaction_count",
            "in": "query",
            "schema": {
              "type": "integer"
            },
            "description": "Filter consumers by their number of transactions.\n*Note*: Range filters can be applied by adding a suffix: ‘.gt’, ‘.gte’, ‘.lt’, ‘lte’ (Example: transaction.gte = 3)"
          },
          {
            "name": "payment_provider",
            "in": "query",
            "description": "Filter records by payment provider.",
            "schema": {
              "type": "string",
              "enum": [
                "stripe",
                "braintree",
                "recurly",
                "redemption",
                "third_party",
                "amazon_fire",
                "google_play",
                "itunes",
                "samsung",
                "tizen",
                "roku"
              ]
            }
          },
          {
            "name": "custom",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Filter records by custom attribues + Example: custom[weight]=100"
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "title": "ConsumersResponse",
                  "type": "object",
                  "properties": {
                    "response": {
                      "type": "array",
                      "items": {
                        "$ref": "#/paths/~1consumers/post/responses/201/content/application~1json/schema/properties/response"
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Unprocessable Entity",
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/pin/link": {
      "put": {
        "summary": "Link Device Pin",
        "description": "",
        "tags": [
          "Device Linking"
        ],
        "operationId": "linkDevicePin",
        "parameters": [
          {
            "name": "consumer_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "ID of consumer to link device to"
          },
          {
            "name": "pin",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "The value for the acquired device pin"
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "title": "DevicePinResponse",
                  "type": "object",
                  "properties": {
                    "response": {
                      "title": "DevicePin",
                      "type": "object",
                      "properties": {
                        "_id": {
                          "type": "string"
                        },
                        "consumer_id": {
                          "description": "",
                          "type": "string"
                        },
                        "created_at": {
                          "description": "",
                          "type": "string"
                        },
                        "deleted_at": {
                          "description": "",
                          "type": "string"
                        },
                        "linked_device_id": {
                          "description": "",
                          "type": "string"
                        },
                        "pin": {
                          "description": "",
                          "type": "string"
                        },
                        "pin_expiration": {
                          "description": "",
                          "type": "string"
                        },
                        "updated_at": {
                          "description": "",
                          "type": "string"
                        },
                        "linked true": {
                          "description": "",
                          "type": "boolean"
                        },
                        "subscription_count": {
                          "description": "",
                          "type": "number"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Device Pin not found",
            "content": {
              "application/json": {
                "schema": {
                  "title": "NotFound",
                  "type": "object",
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/consumers/{consumer_id}/videos": {
      "post": {
        "summary": "Create video entitlement",
        "description": "",
        "tags": [
          "Video Entitlements"
        ],
        "operationId": "createVideoEntitlement",
        "parameters": [
          {
            "name": "consumer_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": ""
          }
        ],
        "requestBody": {
          "description": "",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "title": "VideoEntitlementRequest",
                "type": "object",
                "properties": {
                  "entitlement": {
                    "required": [
                      "video_id"
                    ],
                    "type": "object",
                    "title": "VideoEntitlementProperties",
                    "properties": {
                      "video_id": {
                        "type": "string",
                        "description": "ID of the video you wish the consumer to have access to"
                      },
                      "transaction_id": {
                        "type": "string",
                        "description": "ID of the transaction that happened to allow the consumer to have access to the video"
                      },
                      "transaction_type": {
                        "type": "string",
                        "description": "Type of transaction (Example: purchase)"
                      },
                      "expires_at": {
                        "type": "string",
                        "description": "When the entitlement expires"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "title": "VideoEntitlementResponse",
                  "type": "object",
                  "properties": {
                    "response": {
                      "title": "VideoEntitlement",
                      "type": "object",
                      "properties": {
                        "_id": {
                          "type": "string"
                        },
                        "consumer_id": {
                          "type": "string"
                        },
                        "created_at": {
                          "type": "string"
                        },
                        "updated_at": {
                          "type": "string"
                        },
                        "expires_at": {
                          "type": "string"
                        },
                        "transaction_id": {
                          "type": "string"
                        },
                        "transaction_type": {
                          "type": "string"
                        },
                        "video_title": {
                          "type": "string"
                        },
                        "video_id": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Consumer not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1pin~1link/put/responses/404/content/application~1json/schema"
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1consumers/get/responses/422/content/application~1json/schema"
                }
              }
            }
          }
        }
      }
    }
  }
}
```