Paddle plans
Bookingmood subscription plans, billed through Paddle
Endpoints
The paddle plan object
Attributes
idtextUnique identifier
periodSubscriptionPeriodBilling period of the plan
tierTierSubscription tier of the plan
versionPaddleVersionVersion of Paddle the plan is active on
Related resources
Embed related resources in the response with the select parameter, for example select=*,paddle_subscriptions(*). Resources related through more than one column need the column as a hint, like table!column(*).
paddle_subscriptions(*)arrayThe paddle subscriptions referencing this paddle plan through paddle_subscriptions.plan_id.
The paddle plan object
JSON
{
"id": "",
"period": "monthly",
"tier": "free",
"version": "billing"
}Including related resources
curl -X GET "https://api.bookingmood.com/v1/paddle_plans?limit=10&select=*,paddle_subscriptions(*)" \
-H "Authorization: Bearer YOUR_API_KEY"List paddle plans
Filters
idFilter<text>Unique identifier
periodFilter<SubscriptionPeriod>Billing period of the plan
tierFilter<Tier>Subscription tier of the plan
versionFilter<PaddleVersion>Version of Paddle the plan is active on
Responses
200A list of paddle plans with the selected columns
206Partial Content
400The request is malformed, for example an unknown column or an invalid filter.
401The API key is missing or invalid.
Error responses have a JSON body with a
code, message, details and hint. See the introduction for more on errors.GET /paddle_planscurl -X GET "https://api.bookingmood.com/v1/paddle_plans?select=*&limit=10" \
-H "Authorization: Bearer YOUR_API_KEY"Example response
JSON
[
{
"id": "",
"period": "monthly",
"tier": "free",
"version": "billing"
}
]