Plans

The plans that belong to a page that belongs to the authenticated user.

get
Get plans

https://api.petje.af/v1/pages/:pageId/plans
This endpoint allows you to get the plans that belongs to the selected page. Scope: pages.read
Request
Response
Request
Path Parameters
pageId
optional
string
ID of the page that the plans belong to
Headers
Authorization
required
string
Access token using the Bearer method
Query Parameters
rewardId
optional
string
Filter the results by this Reward ID
limit
optional
string
The number of plans to return
from
optional
boolean
Offset the results after the plan with this ID
Response
200: OK
Cake successfully retrieved.
{
"count": 3,
"_embedded": {
"plans": [
{
"resource": "plans",
"id": "AUmpLHxzVEU3R57RtFxM",
"name": "Klein petje",
"amount": 3,
"interval": "month",
"intervalLabel": "publicatie",
"rewards": [
{
"id": "6JGhzAiPD7jqlbYkdrg8",
"name": "Dit is een beloning",
"type": "default"
},
{
"id": "8igf2PLGpYjLLJp3NaTB",
"name": "Instagram account",
"type": "instagram"
}
],
"status": "enabled",
"_links": {
"self": {
"href": "https://api.petje.af/pages/5SaEUOWD2b4dN7tJBKMB/plans/AUmpLHxzVEU3R57RtFxM",
"type": "application/hal+json"
},
"page": {
"href": "https://api.petje.af/pages/5SaEUOWD2b4dN7tJBKMB",
"type": "application/hal+json"
},
"rewards": {
"href": "https://api.petje.af/pages/5SaEUOWD2b4dN7tJBKMB/rewards?planId=AUmpLHxzVEU3R57RtFxM",
"type": "application/hal+json"
}
}
},
...
]
},
"_links": {
"self": {
"href": "https://api.petje.af/plans",
"type": "application/hal+json"
},
"next": null
}
}

‚Äč

get
Get plan detail

https://api.petje.af/v1/pages/:pageId/plans/:id
Scope: pages.read
Request
Response
Request
Path Parameters
pageId
optional
string
The page ID
id
optional
string
The plan ID
Headers
Authorization
required
string
Access token using the Bearer method
Response
200: OK
{
"resource": "plans",
"id": "AUmpLHxzVEU3R57RtFxM",
"name": "Klein petje",
"amount": 3,
"interval": "month",
"intervalLabel": "publicatie",
"status": "enabled",
"_links": {
"self": {
"href": "https://api.petje.af/pages/5SaEUOWD2b4dN7tJBKMB/plans/AUmpLHxzVEU3R57RtFxM",
"type": "application/hal+json"
},
"page": {
"href": "https://api.petje.af/pages/5SaEUOWD2b4dN7tJBKMB",
"type": "application/hal+json"
},
"rewards": {
"href": "https://api.petje.af/pages/5SaEUOWD2b4dN7tJBKMB/rewards?planId=AUmpLHxzVEU3R57RtFxM",
"type": "application/hal+json"
}
}
}
404: Not Found
{
"status": 404,
"title": "Not Found",
"detail": "Plan is not found",
"_links": {
"documentation": {
"href": "https://docs.petje.af",
"type": "text/html"
}
}
}