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.

POST/1/billing-plans/search

Search billing plans

Authorization
User sessionAPI credential
Permissions
-
OAuth
-
Request
Request bodyapplication/json
accountIdstring
default
accountTierstring
accountTiersstring[]
currencystring
idstring
idsstring[]
includeCountboolean
default false
isPrimaryboolean
isPublicboolean
limitnumber
default 50
namestring
providerContextstring
providerIdstring
skipnumber
default 0
sortobject
default {"field":"createdAt","order":"desc"}
fieldstringREQUIRED
orderstringREQUIRED
ascdesc
typestring
account-tieradhoc-payment-feeconsumerroaming-feestation
uuidsstring <uuid>[]
Responses
200OK application/json
dataBillingPlan[]
accountCountnumber
accountTierIdstring
billingPeriodstringREQUIRED
monthyear
cardCountnumber
createdAtstring <date-time>REQUIRED
deletedbooleanREQUIRED
deletedAtstring <date-time>REQUIRED
detailsobjectREQUIRED
deBillingPlanDetail
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
enBillingPlanDetailREQUIRED
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
esBillingPlanDetail
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
frBillingPlanDetail
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
itBillingPlanDetail
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
nlBillingPlanDetail
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
evseCountnumber
idstringREQUIRED
isCardOrderingOptionalboolean
isPrimaryboolean
isPublicboolean
logoUrlstringREQUIRED
mspUsageFeesEnabledboolean
namestringREQUIRED
pricesBillingPlanPrice[]REQUIRED
currencystringREQUIRED
idstring
perAuthorizationAttemptFlatFeenumberREQUIRED
perCaptureFeePercentagenumberREQUIRED
perCardnumberREQUIRED
perDevicenumberREQUIRED
perKwhFixednumberREQUIRED
perKwhPercentagenumberREQUIRED
perPeriodnumberREQUIRED
perRoamingFeePercentagenumber
perSessionnumberREQUIRED
prioritynumberREQUIRED
processingFeeTargetBillingPlanProcessingFeeTarget[]REQUIRED
targetstringREQUIRED
accountprovider
typestringREQUIRED
roaming
providerContextstringREQUIRED
cpomsp
providerIdstringREQUIRED
roamingSurchargeTargetstring
cpomsp
sessionPaymentPolicystring
deferredimmediate
surchargeApplyToAllboolean
surchargeEnterpriseExcludedboolean
surchargeExcludedPartyIDsstring[]
surchargeExcludedProviderIDsstring[]
surchargeProviderExcludedboolean
tagsstring[]REQUIRED
tokenCountnumber
typestringREQUIRED
account-tieradhoc-payment-feeconsumerroaming-feestation
updatedAtstring <date-time>REQUIRED
uuidstring <uuid>
vatRuleVatRule
calculatedAtstring <date-time>
erpSystemstring
exactnetsuite
erpVatCodestring | number
exactVatCodestring | number
isNotApplicableboolean
isReverseChargeboolean
lookupTablestring
matchedRuleIdstringREQUIRED
vatCalculatorVersionstring
vatImplementationstring
vatPercentagenumberREQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
GET/1/billing-plans/{billingPlan}

Retrieve specific billing plan

Authorization
User sessionAPI credential
Permissions
-
OAuth
-
Request
Path parameters1
billingPlanstringREQUIRED
Responses
200OK application/json
dataBillingPlan
accountCountnumber
accountTierIdstring
billingPeriodstringREQUIRED
monthyear
cardCountnumber
createdAtstring <date-time>REQUIRED
deletedbooleanREQUIRED
deletedAtstring <date-time>REQUIRED
detailsobjectREQUIRED
deBillingPlanDetail
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
enBillingPlanDetailREQUIRED
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
esBillingPlanDetail
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
frBillingPlanDetail
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
itBillingPlanDetail
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
nlBillingPlanDetail
descriptionLongstringREQUIRED
descriptionShortstringREQUIRED
featuresstring[]REQUIRED
namestring
evseCountnumber
idstringREQUIRED
isCardOrderingOptionalboolean
isPrimaryboolean
isPublicboolean
logoUrlstringREQUIRED
mspUsageFeesEnabledboolean
namestringREQUIRED
pricesBillingPlanPrice[]REQUIRED
currencystringREQUIRED
idstring
perAuthorizationAttemptFlatFeenumberREQUIRED
perCaptureFeePercentagenumberREQUIRED
perCardnumberREQUIRED
perDevicenumberREQUIRED
perKwhFixednumberREQUIRED
perKwhPercentagenumberREQUIRED
perPeriodnumberREQUIRED
perRoamingFeePercentagenumber
perSessionnumberREQUIRED
prioritynumberREQUIRED
processingFeeTargetBillingPlanProcessingFeeTarget[]REQUIRED
targetstringREQUIRED
accountprovider
typestringREQUIRED
roaming
providerContextstringREQUIRED
cpomsp
providerIdstringREQUIRED
roamingSurchargeTargetstring
cpomsp
sessionPaymentPolicystring
deferredimmediate
surchargeApplyToAllboolean
surchargeEnterpriseExcludedboolean
surchargeExcludedPartyIDsstring[]
surchargeExcludedProviderIDsstring[]
surchargeProviderExcludedboolean
tagsstring[]REQUIRED
tokenCountnumber
typestringREQUIRED
account-tieradhoc-payment-feeconsumerroaming-feestation
updatedAtstring <date-time>REQUIRED
uuidstring <uuid>
vatRuleVatRule
calculatedAtstring <date-time>
erpSystemstring
exactnetsuite
erpVatCodestring | number
exactVatCodestring | number
isNotApplicableboolean
isReverseChargeboolean
lookupTablestring
matchedRuleIdstringREQUIRED
vatCalculatorVersionstring
vatImplementationstring
vatPercentagenumberREQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED