HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference
Terms of Use
Start typing to search…

Subscription plan / Create

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

Create a new Subscription plans

Body Params
integer | null

The operator ID for this resource.
Required for global admin tokens.
Optional for operator-scoped tokens (defaults to token's operator).

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*
string
enum
required
Allowed:
integer | null

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

string
enum
required
Allowed:
float | null

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

boolean | null
Defaults to false

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

string
enum
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.

Allowed:
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.

string
enum

Applicable only for post-paid subscription plans when external billing is enabled. Controls the billing method used for this subscription plan.

Allowed:
string
enum
required
Allowed:
allowance
object
visibilityRestrictions
object

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

Responses

Updated about 2 months ago

Language
Credentials
Bearer
API Token
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 months ago