Skip to main content
POST
/
customer-subscription-packages
Create Customer Subscription Package
curl --request POST \
  --url https://api.mijnklantportaal.nl/v1/customer-subscription-packages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Phone subscription",
  "interval": "1 year",
  "amount": "12.95",
  "vatRate": 21,
  "description": "1GB per month, 300min per month",
  "availableForSale": true
}
'
{
  "id": "spg_abc12345def678",
  "name": "Phone subscription",
  "description": "1GB per month, 300min per month",
  "interval": "1 year",
  "currency": "EUR",
  "amount": "12.95",
  "vatRate": 21,
  "availableForSale": true
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
required

Name of the subscription package

Example:

"Phone subscription"

​
interval
string
required

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"

​
amount
string
required

Amount to be charged in Euro (EUR), as string.

Example:

"12.95"

​
vatRate
integer
required

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

Example:

21

​
description
string

A description of the package, mainly meant for terms and conditions

Example:

"1GB per month, 300min per month"

​
availableForSale
boolean
Example:

true

Response

The created Customer Subscription Package

Customer Subscription Package

​
id
string

ID of the subscription package, always starting with spg_.

Example:

"spg_abc12345def678"

​
name
string

Name of the subscription package

Example:

"Phone subscription"

​
description
string

A description of the package, mainly meant for terms and conditions

Example:

"1GB per month, 300min per month"

​
interval
string

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

Example:

"1 year"

​
currency
string

Currency of the subscription price 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

​
availableForSale
boolean

Indicates if the package is available for sale in the portal and public page, if enabled

Example:

true