Plans

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

Get plans

GET 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

Path Parameters

NameTypeDescription

pageId

string

ID of the page that the plans belong to

Query Parameters

NameTypeDescription

rewardId

string

Filter the results by this Reward ID

limit

string

The number of plans to return

from

boolean

Offset the results after the plan with this ID

Headers

NameTypeDescription

Authorization

string

Access token using the Bearer method

{
    "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 plan detail

GET https://api.petje.af/v1/pages/:pageId/plans/:id

Scope: pages.read

Path Parameters

NameTypeDescription

pageId

string

The page ID

id

string

The plan ID

Headers

NameTypeDescription

Authorization

string

Access token using the Bearer method

{
    "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"
        }
    }
}

Last updated