Sign-up a customer for a Customer Subscription Package

curl --request POST \
  --url https://api.mijnklantportaal.nl/v1/customer-subscription-packages/{packageId}/sign-up \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "cst_abc12345def678",
  "startDate": "2024-05-04",
  "mandateId": "mdt_abc12345def678",
  "createInvoice": true,
  "invoiceText": null
}
'

import requests

url = "https://api.mijnklantportaal.nl/v1/customer-subscription-packages/{packageId}/sign-up"

payload = {
    "customerId": "cst_abc12345def678",
    "startDate": "2024-05-04",
    "mandateId": "mdt_abc12345def678",
    "createInvoice": True,
    "invoiceText": None
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customerId: 'cst_abc12345def678',
    startDate: '2024-05-04',
    mandateId: 'mdt_abc12345def678',
    createInvoice: true,
    invoiceText: null
  })
};

fetch('https://api.mijnklantportaal.nl/v1/customer-subscription-packages/{packageId}/sign-up', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mijnklantportaal.nl/v1/customer-subscription-packages/{packageId}/sign-up",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customerId' => 'cst_abc12345def678',
    'startDate' => '2024-05-04',
    'mandateId' => 'mdt_abc12345def678',
    'createInvoice' => true,
    'invoiceText' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mijnklantportaal.nl/v1/customer-subscription-packages/{packageId}/sign-up"

	payload := strings.NewReader("{\n  \"customerId\": \"cst_abc12345def678\",\n  \"startDate\": \"2024-05-04\",\n  \"mandateId\": \"mdt_abc12345def678\",\n  \"createInvoice\": true,\n  \"invoiceText\": null\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mijnklantportaal.nl/v1/customer-subscription-packages/{packageId}/sign-up")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"cst_abc12345def678\",\n  \"startDate\": \"2024-05-04\",\n  \"mandateId\": \"mdt_abc12345def678\",\n  \"createInvoice\": true,\n  \"invoiceText\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mijnklantportaal.nl/v1/customer-subscription-packages/{packageId}/sign-up")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customerId\": \"cst_abc12345def678\",\n  \"startDate\": \"2024-05-04\",\n  \"mandateId\": \"mdt_abc12345def678\",\n  \"createInvoice\": true,\n  \"invoiceText\": null\n}"

response = http.request(request)
puts response.read_body

{
  "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,
    "invoiceDescription": "Extending subscription"
  },
  "terminatedAt": "2024-04-29T21:00:00+02:00",
  "createdAt": "2024-04-29T21:00:00+02:00"
}

{
  "message": "<string>"
}

POST

customer-subscription-packages

{packageId}

sign-up

Sign-up a customer for a Customer Subscription Package

curl --request POST \
  --url https://api.mijnklantportaal.nl/v1/customer-subscription-packages/{packageId}/sign-up \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "cst_abc12345def678",
  "startDate": "2024-05-04",
  "mandateId": "mdt_abc12345def678",
  "createInvoice": true,
  "invoiceText": null
}
'

import requests

url = "https://api.mijnklantportaal.nl/v1/customer-subscription-packages/{packageId}/sign-up"

payload = {
    "customerId": "cst_abc12345def678",
    "startDate": "2024-05-04",
    "mandateId": "mdt_abc12345def678",
    "createInvoice": True,
    "invoiceText": None
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customerId: 'cst_abc12345def678',
    startDate: '2024-05-04',
    mandateId: 'mdt_abc12345def678',
    createInvoice: true,
    invoiceText: null
  })
};

fetch('https://api.mijnklantportaal.nl/v1/customer-subscription-packages/{packageId}/sign-up', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mijnklantportaal.nl/v1/customer-subscription-packages/{packageId}/sign-up",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customerId' => 'cst_abc12345def678',
    'startDate' => '2024-05-04',
    'mandateId' => 'mdt_abc12345def678',
    'createInvoice' => true,
    'invoiceText' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mijnklantportaal.nl/v1/customer-subscription-packages/{packageId}/sign-up"

	payload := strings.NewReader("{\n  \"customerId\": \"cst_abc12345def678\",\n  \"startDate\": \"2024-05-04\",\n  \"mandateId\": \"mdt_abc12345def678\",\n  \"createInvoice\": true,\n  \"invoiceText\": null\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mijnklantportaal.nl/v1/customer-subscription-packages/{packageId}/sign-up")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"cst_abc12345def678\",\n  \"startDate\": \"2024-05-04\",\n  \"mandateId\": \"mdt_abc12345def678\",\n  \"createInvoice\": true,\n  \"invoiceText\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mijnklantportaal.nl/v1/customer-subscription-packages/{packageId}/sign-up")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customerId\": \"cst_abc12345def678\",\n  \"startDate\": \"2024-05-04\",\n  \"mandateId\": \"mdt_abc12345def678\",\n  \"createInvoice\": true,\n  \"invoiceText\": null\n}"

response = http.request(request)
puts response.read_body

{
  "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,
    "invoiceDescription": "Extending subscription"
  },
  "terminatedAt": "2024-04-29T21:00:00+02:00",
  "createdAt": "2024-04-29T21:00:00+02:00"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

packageId

string

required

ID of the Customer Subscription Package to use for the sign-up

Body

application/json

customerId

string

required

ID of the customer you would like to create a subscription for with this package.

Example:

"cst_abc12345def678"

startDate

string

required

Date the subscription should or has started, as format YYYY-mm-dd.

Example:

"2024-05-04"

mandateId

string

ID of the mandate you would like to use to charge the subscription with. Omit if you want to start the process for a new customer, or not enable automatic charges for existing customers.

Example:

"mdt_abc12345def678"

createInvoice

boolean

Indicates if MijnKlantportaal should create an invoice for every charge.

Example:

true

invoiceText

string

Custom invoice text. Omit if you want to use the package's name.

Example:

null

Response

The created Customer Subscription

Customer Subscription

string

ID of the subscription, always starting with sub_.

Example:

"sub__abc12345def678"

customerId

string

ID of the customer which the subscription belongs to.

Example:

"cst_abc12345def678"

description

string

Description of the subscription

Example:

"Website maintenance contract"

startsAt

string

Start date of the subscription. Formatted as YYYY-mm-dd.

Example:

"2024-04-29"

interval

string

The interval of which the subscription will be extended. Can be 14 days, 1 month, 2 months, 6 months or 1 year.

Example:

"1 year"

renewsAt

string

Date of when the subscription will be renewed next. Formatted as YYYY-mm-dd.

Example:

"2025-04-29"

currency

string

Currency of the subscription amount.

Example:

"EUR"

amount

string

Amount value as string.

Example:

"12.95"

vatRate

integer

The VAT rate percentage as integer. Can be 0, 9 or 21.

Example:

21

status

string

The current status of the subscription. Can be planned, in_progress, terminated or ended.

Example:

"in_progress"

options

object

Settings of the subscription

Show child attributes

terminatedAt

string

Date and time when the subscription was terminated. Written in ATOM format.

Example:

"2024-04-29T21:00:00+02:00"

createdAt

string

Date and time when the subscription was added to MijnKlantportaal. Written in ATOM format.

Example:

"2024-04-29T21:00:00+02:00"

Change Customer Subscription Package

Sign-up a non-customer for a Customer Subscription Package