Subscription plans / Create

post https://{tenantUrl}/public-api/resources/subscription-plans/v2.0

Create a new Subscription plans

Body Params

name

array of objects

required

Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.

name*

description

array of objects

required

Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.

description*

renewalCycle

string

required

freeRenewalPeriods

integer | null

The number of renewal periods that are free of charge. This is only applicable for pre-paid plans.

type

string

required

baseFee

float | null

For pre-paid plans this is the price, for post-paid plans this is the base fee.

baseFeeAppliesPerEachHomeCharger

boolean | null

Defaults to false

Makes the base fee apply per each home charger owned by the subscriber.

postPaidChargingSessionsAccumulation

string

Defaults to none

Indicates if charging sessions at personal, commercial+personal charge points are included in the post-paid subscription and would be billed at the end of the billing cycle or when a threshold is met, if there is such.

billingUsageThreshold

integer | null

If this threshold is reached, the amount due for the subscription would be billed immediately instead of waiting for the end of the billing period.

status

string

required

allowance

object

visibilityRestrictions

object

Defines which users can view and subscribe to the plan via the app

Responses

422

The payload you provided is invalid

Language

Credentials

Bearer

API Token

URL


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://example.com/public-api/resources/subscription-plans/v2.0 \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "renewalCycle": "monthly",
8
  "type": "pre-paid",
9
  "status": "enabled"
10
}
11
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Success

401Access token is missing or invalid

403You do not have permission to perform the action