Billing Plans
No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.
No Road deviations in this section. Turn off the deviations filter in the sidebar to see all of its endpoints.
Billing Plans APIs
POST/1/billing-plans/search
Search billing plans
List billing plans and filter by certain attributes. If the user is not an admin, only plans marked as isPublic will be returned.
Authorization
User sessionAPI credentialPermissions
-
OAuth
-
Request
Request bodyapplication/json
accountIdstring
default
accountTierstring
accountTiersstring[]
currencystring
idstring
idsstring[]
includeCountboolean
default
falseisPrimaryboolean
isPublicboolean
limitnumber
default
50namestring
providerContextstring
providerIdstring
skipnumber
default
0sortobjectdefault {"field":"createdAt","order":"desc"}
sortobject
default
{"field":"createdAt","order":"desc"}fieldstringREQUIRED
orderstringREQUIRED
ascdesctypestring
account-tieradhoc-payment-feeconsumerroaming-feestationuuidsstring <uuid>[]
Responses
200OK application/json
dataBillingPlan[]
dataBillingPlan[]
accountCountnumber
accountTierIdstring
billingPeriodstringREQUIRED
monthyearcardCountnumber
createdAtstring <date-time>REQUIRED
deletedbooleanREQUIRED
deletedAtstring <date-time>REQUIRED
detailsobjectREQUIRED
detailsobjectREQUIRED
deBillingPlanDetail
deBillingPlanDetail
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
enBillingPlanDetailREQUIRED
enBillingPlanDetailREQUIRED
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
esBillingPlanDetail
esBillingPlanDetail
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
frBillingPlanDetail
frBillingPlanDetail
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
itBillingPlanDetail
itBillingPlanDetail
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
nlBillingPlanDetail
nlBillingPlanDetail
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
evseCountnumber
idstringREQUIRED
isCardOrderingOptionalboolean
isPrimaryboolean
isPublicboolean
logoUrlstringREQUIRED
mspUsageFeesEnabledboolean
namestringREQUIRED
pricesBillingPlanPrice[]REQUIRED
pricesBillingPlanPrice[]REQUIRED
currencystringREQUIRED
idstring
perAuthorizationAttemptFlatFeenumberREQUIRED
perCaptureFeePercentagenumberREQUIRED
perCardnumberREQUIRED
perDevicenumberREQUIRED
perKwhFixednumberREQUIRED
perKwhPercentagenumberREQUIRED
perPeriodnumberREQUIRED
perRoamingFeePercentagenumber
perSessionnumberREQUIRED
prioritynumberREQUIRED
processingFeeTargetBillingPlanProcessingFeeTarget[]REQUIRED
processingFeeTargetBillingPlanProcessingFeeTarget[]REQUIRED
targetstringREQUIRED
accountprovidertypestringREQUIRED
roamingproviderContextstringREQUIRED
cpomspproviderIdstringREQUIRED
roamingSurchargeTargetstring
cpomspsessionPaymentPolicystring
deferredimmediatesurchargeApplyToAllboolean
surchargeEnterpriseExcludedboolean
surchargeExcludedPartyIDsstring[]
surchargeExcludedProviderIDsstring[]
surchargeProviderExcludedboolean
tagsstring[]REQUIRED
tokenCountnumber
typestringREQUIRED
account-tieradhoc-payment-feeconsumerroaming-feestationupdatedAtstring <date-time>REQUIRED
uuidstring <uuid>
vatRuleVatRule
vatRuleVatRule
calculatedAtstring <date-time>
erpSystemstring
exactnetsuiteerpVatCodestring | number
ERP-facing counterpart of exactVatCode. Mixed in Mongo: existing documents hold both strings and numbers.
exactVatCodestring | number
isNotApplicableboolean
isReverseChargeboolean
lookupTablestring
matchedRuleIdstringREQUIRED
vatCalculatorVersionstring
vatImplementationstring
vatPercentagenumberREQUIRED
metaobject
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
GET/1/billing-plans/{billingPlan}
Retrieve specific billing plan
Authorization
User sessionAPI credentialPermissions
-
OAuth
-
Request
Path parameters1
billingPlanstringREQUIRED
Responses
200OK application/json
dataBillingPlan
dataBillingPlan
accountCountnumber
accountTierIdstring
billingPeriodstringREQUIRED
monthyearcardCountnumber
createdAtstring <date-time>REQUIRED
deletedbooleanREQUIRED
deletedAtstring <date-time>REQUIRED
detailsobjectREQUIRED
detailsobjectREQUIRED
deBillingPlanDetail
deBillingPlanDetail
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
enBillingPlanDetailREQUIRED
enBillingPlanDetailREQUIRED
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
esBillingPlanDetail
esBillingPlanDetail
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
frBillingPlanDetail
frBillingPlanDetail
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
itBillingPlanDetail
itBillingPlanDetail
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
nlBillingPlanDetail
nlBillingPlanDetail
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
evseCountnumber
idstringREQUIRED
isCardOrderingOptionalboolean
isPrimaryboolean
isPublicboolean
logoUrlstringREQUIRED
mspUsageFeesEnabledboolean
namestringREQUIRED
pricesBillingPlanPrice[]REQUIRED
pricesBillingPlanPrice[]REQUIRED
currencystringREQUIRED
idstring
perAuthorizationAttemptFlatFeenumberREQUIRED
perCaptureFeePercentagenumberREQUIRED
perCardnumberREQUIRED
perDevicenumberREQUIRED
perKwhFixednumberREQUIRED
perKwhPercentagenumberREQUIRED
perPeriodnumberREQUIRED
perRoamingFeePercentagenumber
perSessionnumberREQUIRED
prioritynumberREQUIRED
processingFeeTargetBillingPlanProcessingFeeTarget[]REQUIRED
processingFeeTargetBillingPlanProcessingFeeTarget[]REQUIRED
targetstringREQUIRED
accountprovidertypestringREQUIRED
roamingproviderContextstringREQUIRED
cpomspproviderIdstringREQUIRED
roamingSurchargeTargetstring
cpomspsessionPaymentPolicystring
deferredimmediatesurchargeApplyToAllboolean
surchargeEnterpriseExcludedboolean
surchargeExcludedPartyIDsstring[]
surchargeExcludedProviderIDsstring[]
surchargeProviderExcludedboolean
tagsstring[]REQUIRED
tokenCountnumber
typestringREQUIRED
account-tieradhoc-payment-feeconsumerroaming-feestationupdatedAtstring <date-time>REQUIRED
uuidstring <uuid>
vatRuleVatRule
vatRuleVatRule
calculatedAtstring <date-time>
erpSystemstring
exactnetsuiteerpVatCodestring | number
ERP-facing counterpart of exactVatCode. Mixed in Mongo: existing documents hold both strings and numbers.
exactVatCodestring | number
isNotApplicableboolean
isReverseChargeboolean
lookupTablestring
matchedRuleIdstringREQUIRED
vatCalculatorVersionstring
vatImplementationstring
vatPercentagenumberREQUIRED
metaobject
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED