Redeem a guest's Guest Pass membership

Purpose: Use this API to redeem the benefits of the guest's Guest Pass membership.

You must specify the guest_id and guestpass_id, and invoice_id to redeem the benefits.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

error Object

ErrorMessageDescription
GP031Guest pass expiredWhen the guest's Guest Pass membership has expired.
GP001Guest pass is not enabledWhen the guest's Guest Pass is not enabled.
GP030Invalid UserWhen the guest's Guest Pass id is invalid.
Path Params
string
required

Unique identifier of the guest.

string
required

Unique identifier of the guest's guestpass membership.

Body Params
string
required

Unique identifier of the invoice to redeem the guest pass.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json