Skip to main content
GET
/
customer-subscriptions
List Customer Subscriptions
curl --request GET \
  --url https://api.mijnklantportaal.nl/v1/customer-subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "current_page": 1,
  "data": [
    {
      "id": "sub__abc12345def678",
      "customerId": "cst_abc12345def678",
      "description": "Website maintenance contract",
      "startsAt": "2024-04-29",
      "interval": "1 year",
      "renewsAt": "2025-04-29",
      "currency": "EUR",
      "amount": "12.95",
      "vatRate": 21,
      "status": "in_progress",
      "options": {
        "createInvoice": true,
        "createPayment": true,
        "invoiceDescription": "Extending subscription",
        "paymentIntegration": "mollie",
        "paymentIntegrationMandateId": "mdt_123abc",
        "followUpFailedPayment": true
      },
      "terminatedAt": "2024-04-29T21:00:00+02:00",
      "createdAt": "2024-04-29T21:00:00+02:00"
    }
  ],
  "first_page_url": "https://api.mijnklantportaal.nl/v1/customer-subscriptions?page=1",
  "from": 1,
  "next_page_url": "https://api.mijnklantportaal.nl/v1/customer-subscriptions?page=2,",
  "path": "https://api.mijnklantportaal.nl/v1/customer-subscriptions",
  "per_page": 15,
  "prev_page_url": null,
  "to": 15
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Paginated response with customer subscriptions

​
current_page
integer

Current page of the response

Example:

1

​
data
object[]

Array of Customer Subscription objects

​
first_page_url
string

Endpoint to go to the first page of objects

Example:

"https://api.mijnklantportaal.nl/v1/customer-subscriptions?page=1"

​
from
integer

Offset of the current page

Example:

1

​
next_page_url
string | null

Endpoint to get the next batch of objects, if available

Example:

"https://api.mijnklantportaal.nl/v1/customer-subscriptions?page=2,"

​
path
string

Current used endpoint

Example:

"https://api.mijnklantportaal.nl/v1/customer-subscriptions"

​
per_page
integer

Amount of object returned per page. Default is 15 objects

Example:

15

​
prev_page_url
string | null

Endpoint to get the previous batch of object, if available

Example:

null

​
to
integer

Next offset of objects

Example:

15

⌘I