Skip to content

Membership Plan Created

The membership_plan.created event is triggered when a new membership plan is created in the system.

Event Properties

PropertyTypeDescription
idstringThe unique identifier of the membership plan
namestringThe name of the membership plan
descriptionstringThe description of the membership plan
currencystringThe currency code for the plan’s price (default: “TWD”)
amountnumberThe price amount of the plan
intervalstringThe billing interval (month, year)
interval_countintegerThe number of intervals between billings
activebooleanIndicates if the plan is active
created_atstringThe timestamp when the plan was created
updated_atstringThe timestamp when the plan was last updated
ended_atstringThe timestamp when the plan ends (if applicable)
plan_typestringThe type of plan (recurring, fixed_date, or specific_length)
quantityintegerThe quantity of items included in the plan
sold_items_countintegerThe number of items sold for this plan
slugstringThe URL-friendly identifier for the plan
max_interval_countintegerThe maximum number of intervals allowed
visiblebooleanIndicates if the plan is visible to users

Example Payload

{
"type": "membership_plan.created",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Premium Monthly Membership",
"description": "Access to all premium features with monthly billing",
"currency": "TWD",
"amount": 1500.0,
"interval": "month",
"interval_count": 1,
"active": true,
"created_at": "2023-05-15T14:30:00Z",
"updated_at": "2023-05-15T14:30:00Z",
"ended_at": null,
"plan_type": "recurring",
"quantity": null,
"sold_items_count": 0,
"slug": "premium-monthly-membership",
"max_interval_count": null,
"visible": true
}
}