LogoLogo
SupportProduct Documentation
    • Introduction
    • URL Structure
    • API Key
    • Errors
    • Versioning
    • Pagination
    • Replication
    • Performance
    • Rate Limits
    • Webhooks
  • System Services
    • Companies
    • Hello World
  • Accounts
  • Ticketing
    • Getting started
    • Catalog
    • Capacity
    • Tickets
    • Reservations
    • Schedule
  • Memberships
    • Catalog
    • Membership
    • Member
    • Card
    • Payment Method
    • Lifecycle
    • Miscellaneous
    • Points
  • Speedgate
  • Attraction Wallet
  • POS
    • POS Sale
    • POS Unit
    • POS Store
    • Salesperson
    • External POS Sale
    • Global POS Entry
  • Inventory
    • Barcodes
    • Items
    • Item Ledger Entries
    • Item Categories
    • Item Variants
    • Item Translations
  • Coupon
  • Vouchers
    • Vouchers
  • Ecommerce
    • Sales Documents
  • Finance
    • General Ledger Account
    • General Ledger Entries
    • General Ledger Journal
SupportProduct Documentation
MembershipsWebhooks

Membership Period Regret

Event name `membershipPeriod_regret`<br><br> This webhook is triggered when a membership period is regretted - the valid until date is changed with intent to end the membership prematurely. Use the <a href="/api-reference/memberships/service-lifecycle/get-membership-history">Get Membership History</a> endpoint to retrieve full details about the membership’s validity periods.

Payload

The payload of this webhook request is an object.
valueslist of objectsRequired
An array of webhooks, be prepared to handle more than 1 in the same hook request.

Response

200
any
Return a 200 status to indicate that the data was received successfully.
Was this page helpful?
Previous

Membership Period Activated

Next
Built with
Payload
1{
2  "values": [
3    {
4      "appId": "992c2309-cca4-43cb-9e41-911f482ec088",
5      "clientState": "secret_value_from_subscription_creation_mirrored",
6      "companyId": "b56a418d-8205-4d3a-bdbb-25d94e42abbd",
7      "companyName": "CRONUS International Ltd.",
8      "eventName": "membershipPeriod_regret",
9      "eventVersion": "1.0",
10      "initiatingUserAADObjectId": "ef546153-4168-4bd5-9365-a3161608da72",
11      "payload": {
12        "membershipId": "cdef7890-abcd-0123-1234-567890abcdef",
13        "entryId": "22349999-bbbb-cccc-dddd-2234567890bc",
14        "lifecycleAction": "regret"
15      },
16      "timestamp": "2024-06-28T12:00:00Z"
17    }
18  ]
19}

Event name membershipPeriod_regret

This webhook is triggered when a membership period is regretted - the valid until date is changed with intent to end the membership prematurely. Use the Get Membership History endpoint to retrieve full details about the membership’s validity periods.