Create a pass [Beta]

Use this endpoint to create externally-managed passes.

The life cycle of externally-managed passes is managed outside of Cleeng so it is up to a broadcaster to notify Cleeng about pass status changes, e.g. the change of pass expiration date or pass termination if auto-termination is not enabled (if auto-termination is not enabled for the payment method, Cleeng platform will not terminate the pass when expiry date is reached, and the broadcaster will need to send the termination request to revoke access).


🚧

Beta

Please note that it is a Beta phase.

Response description

ResponseTypeDescription
passIdintegerPass identifier in Cleeng.
customerIdintegerThe identifier of Cleeng customer.
statusstringThe current status of a pass. One of: active, terminated.
offerIdstringThe identifier of Cleeng offer, e.g. S123123123_US.
expiresAtintegerExpiration time (in UNIX timestamp format).
externalIdstringThe external identifier of a pass.
paymentMethodIdintegerThe identifier of the payment method, provided by Cleeng.
externalPropertiesobjectExternal properties that can be used to store additional metadata from the external system, e.g. partnerID, externalProductId, partnerCode, etc.
isExternallyManagedbooleanWhether a pass is externally-managed or not.
Language
Authorization
Header
Click Try It! to start a request and see the response here!