Prepare a payment

POST/v1/me/payments/prepare

Preview

Makes the hold for a quote and answers what the phone's payment sheet needs: the client secret, the publishable key of the mode and the organization's connected account. The hold is written before Stripe is called. Confirm on the phone, then start the charge once the payment reads authorized.

The request is signed by the app (X-Flowion-Device, X-Flowion-Assertion). Send an Idempotency-Key to make a retry the same hold; without one the quote's id is the key.

Authorization

Authorizationheader · stringrequired
Bearer <token>, with an ID token from a console sign-in or an API key (flw_ak_…). How authentication works

Parameters

Idempotency-Keyheader · string

Request body

application/json · required

quoteIdstringrequired
routestringrequired

Responses

201 Created

The hold and what the payment sheet needs.

amountMinorintegerrequired
currencystringrequired
holdIdstringrequired
publishableKeystringrequired
stripeAccountIdstringrequired
testModebooleanrequired
clientSecretstringnullable
windowEndsAtdate-timenullable

Headers

RateLimit-Limitheader · string
RateLimit-Remainingheader · string
RateLimit-Resetheader · string

400 Bad request

invalidRequest: the quote or the route is not valid.

errorenumrequired
A stable code for the error. Switch on this value: it doesn't change between releases.
One ofstepUpRequiredcoolingOffauthUnavailableavatarTooLargebelowPrivilegedMinimumtryAgainLaterhandoverFinishedintentionNotRemovableaddressAmbiguousaddressNotFoundgeocodingUnavailableinvalidCoordinateResolutionpublicCatalogueUnavailableaccessRevokedjobNotOpenvendorRateLimitedvendorUnavailablezaptecUnavailableincompleteMappinginstallationClaimedconsentInvalidrequestConflictstaleRevisionaccountHasOpenBalanceaccountNotReadyaccountsCollidealreadyStartedambiguousIdTokenambiguousReservationAddressassetServiceUnavailablelocationCoordinatesRequiredforecastTimeOutsideCoverageweatherServiceUnavailableassistantCardRequiredassistantDisabledassistantLimitReachedinstallerPhotoDayLimitinstallerPhotoConversationLimitassistantNotEnabledassistantRouteNotAllowedassistantUnavailableadditionsNotAllowedauthenticationRequiredauthorizationUnavailablebadRequestbatchTooLargebillingAccountClosedbillingAccountSuspendedbillingNotConfiguredbillingServiceUnavailablecapacityExceededcardAlreadyHeldcardBlockedcardOwnedByPrincipalcertificateAuthorityServiceUnavailablechargerUnsafeForHoldcircuitChosenTwicecircuitNotFoundcircuitNotOnJobLocationchargerNotRunningchargePointIdTakenchargerSplitAcrossLocationschargingStationNotAcceptedclaimNotEligibleclaimNotFoundcommandNotSupportedcommandTypeRemovedcommandsUnavailableconflictconfirmationInvalidconfirmationLockedconfirmationNotSentconfirmationRequiredconfirmEraseRequiredconsentMissingconversationClosedconversationBusyconnectionNotEligibleconnectorAlreadyOccupiedconnectorNotFoundconnectorNotOccupiedconfirmOverPlanRequiredcsmsManagedSettingdeclineddiagnosticsReceiverServiceUnavailablediagnosticsRequestOutstandingdiagnosticsUnsupportedProtocolVersiondisconnecteddismissedForSessionduplicateduplicateSlugdetachFirsteaseeCircuitUnmappedeaseeSiteClaimedElsewhereeaseeUnreachableeaseeWrongSerialOrPinemailNotVerifiedemptyEventTypesemptyLimitemptyTransactionLimitenergyControllerUnavailableenergyPricingServiceUnavailableeventTypeNotSubscribableexceedsCapabilityfileExpiredfileNotAvailablefirmwareIdentityUnknownfinishAccountSetupforbiddenhandoverNotReadyhandoverBegunhasChildCircuitshasInvertersholdAmountOutOfRangeholdNotAuthorizedidTokenNotAcceptedidTokenNotRecoverableidempotencyKeyConflictidempotencyKeyInFlightidempotencyKeyReplayedidempotencyStoreUnavailableidentityPlatformUnavailableintegrationEaseeServiceUnavailableintegrationUnavailableconnectionsServiceUnavailableinternalErrorinvalidinvalidAddressinvalidAppDestinationinvalidClientinvalidCoordinatesinvalidCountryinvalidCurrentTypeinvalidEvsesinvalidCursorinvalidErrorCodeinvalidIdTokeninvalidLineinvalidModeinvalidMonitorAssignmentinvalidMonitorConnectioninvalidNameinvalidPaginationinvalidRedirectUriinvalidReasoninvalidPhaseCountinverterBindingConflictinvalidRequestinvalidRegistrationliveUpdatesUnavailableinvalidImageimageTooLargeinvalidWindowmethodNotUsablenotAPaidChargernotCapturedoverRefundpaymentRequiredpricingUnavailableprojectsHaveNoDefaultrevisionConflictinvalidScheduleinvalidScopeinvalidSettingValueinvalidLocationTargetinvalidSluginvalidStartingSocinvalidTargetSocinvalidTargetinvalidTargetUrlinvalidTariffinvalidTariffConditioninvalidTariffIdinvalidTimeZoneinvalidUrlinvalidValueinstallerNotHeldinvitationAlreadyAcceptedinvitationExpiredjobsServiceUnavailableopenJobsservesCustomerGrantsnotAnInstallationsProjectnotAnOperationsProjectgrantNotActivelastCircuitOnLocationlastSignInlocationUnderInstallationlocationNotBuiltlocationAlreadyBuiltmetricsStoreErrormetricsStoreUnavailablemessageTooLongmissingIdTokenmissingIdempotencyKeymonitorConflictmonitorNotFoundmqttServiceUnavailablemissingOrMalformedHeaderinvalidTokenjwksUnavailableapiKeyServiceUnavailablenotConnectednotDispatchablenotEntitledassigneeCannotReadJobnotFoundlabelMistypedlabelNotFoundlabelStockLimitlabelHeldElsewherelabelRetiredlabelLinkedElsewhereoutletHasLabelsandboxOutletnotOfferednotReadynotSandboxModenoFirmwareCatalogednoOpenSessionnoSupportedTransferProtocolnoVehiclenothingToOffernotAdminOrOwnerocppUnavailableorganizationNotEmptyorganizationNumberMismatchownerCannotLeaveownsOrganizationspaymentMethodRequiredbinding.driver_policy_requires_access_permissionbinding.holder_outside_home_projectpermission_policy.deny_not_allowedpermission_policy.deny_on_owner_floorpermission_policy.in_usepermission_policy.invalid_documentpermission_policy.limit_exceededpermission_policy.managed_immutablepermission_policy.management_permission_for_non_memberpermission_policy.name_takenpermission_policy.not_grantablepermission_policy.unknown_permissionpermission_policy.would_remove_last_editorpaymentsAccountNotFoundpaymentsAccountSubmittedpaymentsOrganizationSyntheticpaymentsUnavailablepaymentModeUnknowndeviceAttestationRequiredlimitExceededattestationRejectedpaymentsNotEnabledamountOutOfRangecarNotPluggedInchargerNotReadyorganizationNotTestEligiblequoteExpiredquoteUsedphaseTopologyNotConfirmedprincipalErasedprincipalInactiveprincipalNotFoundprojectNotFoundproposalAlreadyDecidedprotocolErrorrateLimitErrorrateLimitedrecentSignInRequiredcardHeldElsewherecardNotReadablecardUidChangescardsNotEnabledcardsUnavailablelearnAlreadyOpenlearnAmbiguouslearnExpiredlearnNotOfferedratedCurrentNotPositivereferenceTakensandboxOrganizationChargerLimitReachedsandboxProjectChargerLimitReachedsandboxStationRefusedselfParentsellerUnavailablestaleCircuitserviceUnavailablesessionEndedsessionServiceUnavailablestationOfflinestationsNotDeprovisionedsigningSecretTooShortsignInClassMismatchsignInInUsesignInUnverifiedsiteClaimedElsewheresiteOwnedByAnotherEaseeOperatorslugChangeNotAcknowledgedslugTakenspotCurrencyMismatchtariffEnergyAndSpottimeZoneRequiredtimedOutscopeNotGrantedscopeTooLargewindowEndedwindowTooLongsessionCapExceededinvalidMonthmonthTooLargemixedCurrenciesmonthNotClosablemonthHasOpenHoldsmonthAlreadyClosedmonthNotClosedoutcomeFinalmonthClosednotCarriabletargetMonthClosedsettlementServiceUnavailabletransactionAlreadyOpentransactionNotOpentrackingUnavailableunauthorizedunavailableunintelligibleResponseunknownBiddingZoneunknownChargerModelunknownEventTypeunknownFallbackStatusunknownSerialunknownVariableunknownVehicleModelunprocessableunrecognisedApiKeyModeunrecognisedSessionModeunsupportedvendorManagedFirmwarevendorUnreachablevirtualChargerLimitReachedvirtualChargerOrganizationLimitReachedvirtualChargerServiceUnavailablevirtualChargerStateUnavailablewebhookServiceUnavailablewrongPinhomeVehiclePreferencesChangedhomeLimithomeHasMembersinvitationNotFoundhomeNotReadyinvalidPriceinvalidPriceAreagridFeeCurrencyUnsupportedpriceAreaRequirednotAvailableForHomepublicLocationlocationStepRequired
messagestringrequired
A description for people. Its wording may change, so don't parse it.
requestIdstring
This request's id, the same as the x-request-id response header. Quote it when you contact support.

401 Unauthorized

Your token is missing, has expired or isn't valid. Sign in again, or use a valid API key.

errorenumrequired
A stable code for the error. Switch on this value: it doesn't change between releases.
One ofstepUpRequiredcoolingOffauthUnavailableavatarTooLargebelowPrivilegedMinimumtryAgainLaterhandoverFinishedintentionNotRemovableaddressAmbiguousaddressNotFoundgeocodingUnavailableinvalidCoordinateResolutionpublicCatalogueUnavailableaccessRevokedjobNotOpenvendorRateLimitedvendorUnavailablezaptecUnavailableincompleteMappinginstallationClaimedconsentInvalidrequestConflictstaleRevisionaccountHasOpenBalanceaccountNotReadyaccountsCollidealreadyStartedambiguousIdTokenambiguousReservationAddressassetServiceUnavailablelocationCoordinatesRequiredforecastTimeOutsideCoverageweatherServiceUnavailableassistantCardRequiredassistantDisabledassistantLimitReachedinstallerPhotoDayLimitinstallerPhotoConversationLimitassistantNotEnabledassistantRouteNotAllowedassistantUnavailableadditionsNotAllowedauthenticationRequiredauthorizationUnavailablebadRequestbatchTooLargebillingAccountClosedbillingAccountSuspendedbillingNotConfiguredbillingServiceUnavailablecapacityExceededcardAlreadyHeldcardBlockedcardOwnedByPrincipalcertificateAuthorityServiceUnavailablechargerUnsafeForHoldcircuitChosenTwicecircuitNotFoundcircuitNotOnJobLocationchargerNotRunningchargePointIdTakenchargerSplitAcrossLocationschargingStationNotAcceptedclaimNotEligibleclaimNotFoundcommandNotSupportedcommandTypeRemovedcommandsUnavailableconflictconfirmationInvalidconfirmationLockedconfirmationNotSentconfirmationRequiredconfirmEraseRequiredconsentMissingconversationClosedconversationBusyconnectionNotEligibleconnectorAlreadyOccupiedconnectorNotFoundconnectorNotOccupiedconfirmOverPlanRequiredcsmsManagedSettingdeclineddiagnosticsReceiverServiceUnavailablediagnosticsRequestOutstandingdiagnosticsUnsupportedProtocolVersiondisconnecteddismissedForSessionduplicateduplicateSlugdetachFirsteaseeCircuitUnmappedeaseeSiteClaimedElsewhereeaseeUnreachableeaseeWrongSerialOrPinemailNotVerifiedemptyEventTypesemptyLimitemptyTransactionLimitenergyControllerUnavailableenergyPricingServiceUnavailableeventTypeNotSubscribableexceedsCapabilityfileExpiredfileNotAvailablefirmwareIdentityUnknownfinishAccountSetupforbiddenhandoverNotReadyhandoverBegunhasChildCircuitshasInvertersholdAmountOutOfRangeholdNotAuthorizedidTokenNotAcceptedidTokenNotRecoverableidempotencyKeyConflictidempotencyKeyInFlightidempotencyKeyReplayedidempotencyStoreUnavailableidentityPlatformUnavailableintegrationEaseeServiceUnavailableintegrationUnavailableconnectionsServiceUnavailableinternalErrorinvalidinvalidAddressinvalidAppDestinationinvalidClientinvalidCoordinatesinvalidCountryinvalidCurrentTypeinvalidEvsesinvalidCursorinvalidErrorCodeinvalidIdTokeninvalidLineinvalidModeinvalidMonitorAssignmentinvalidMonitorConnectioninvalidNameinvalidPaginationinvalidRedirectUriinvalidReasoninvalidPhaseCountinverterBindingConflictinvalidRequestinvalidRegistrationliveUpdatesUnavailableinvalidImageimageTooLargeinvalidWindowmethodNotUsablenotAPaidChargernotCapturedoverRefundpaymentRequiredpricingUnavailableprojectsHaveNoDefaultrevisionConflictinvalidScheduleinvalidScopeinvalidSettingValueinvalidLocationTargetinvalidSluginvalidStartingSocinvalidTargetSocinvalidTargetinvalidTargetUrlinvalidTariffinvalidTariffConditioninvalidTariffIdinvalidTimeZoneinvalidUrlinvalidValueinstallerNotHeldinvitationAlreadyAcceptedinvitationExpiredjobsServiceUnavailableopenJobsservesCustomerGrantsnotAnInstallationsProjectnotAnOperationsProjectgrantNotActivelastCircuitOnLocationlastSignInlocationUnderInstallationlocationNotBuiltlocationAlreadyBuiltmetricsStoreErrormetricsStoreUnavailablemessageTooLongmissingIdTokenmissingIdempotencyKeymonitorConflictmonitorNotFoundmqttServiceUnavailablemissingOrMalformedHeaderinvalidTokenjwksUnavailableapiKeyServiceUnavailablenotConnectednotDispatchablenotEntitledassigneeCannotReadJobnotFoundlabelMistypedlabelNotFoundlabelStockLimitlabelHeldElsewherelabelRetiredlabelLinkedElsewhereoutletHasLabelsandboxOutletnotOfferednotReadynotSandboxModenoFirmwareCatalogednoOpenSessionnoSupportedTransferProtocolnoVehiclenothingToOffernotAdminOrOwnerocppUnavailableorganizationNotEmptyorganizationNumberMismatchownerCannotLeaveownsOrganizationspaymentMethodRequiredbinding.driver_policy_requires_access_permissionbinding.holder_outside_home_projectpermission_policy.deny_not_allowedpermission_policy.deny_on_owner_floorpermission_policy.in_usepermission_policy.invalid_documentpermission_policy.limit_exceededpermission_policy.managed_immutablepermission_policy.management_permission_for_non_memberpermission_policy.name_takenpermission_policy.not_grantablepermission_policy.unknown_permissionpermission_policy.would_remove_last_editorpaymentsAccountNotFoundpaymentsAccountSubmittedpaymentsOrganizationSyntheticpaymentsUnavailablepaymentModeUnknowndeviceAttestationRequiredlimitExceededattestationRejectedpaymentsNotEnabledamountOutOfRangecarNotPluggedInchargerNotReadyorganizationNotTestEligiblequoteExpiredquoteUsedphaseTopologyNotConfirmedprincipalErasedprincipalInactiveprincipalNotFoundprojectNotFoundproposalAlreadyDecidedprotocolErrorrateLimitErrorrateLimitedrecentSignInRequiredcardHeldElsewherecardNotReadablecardUidChangescardsNotEnabledcardsUnavailablelearnAlreadyOpenlearnAmbiguouslearnExpiredlearnNotOfferedratedCurrentNotPositivereferenceTakensandboxOrganizationChargerLimitReachedsandboxProjectChargerLimitReachedsandboxStationRefusedselfParentsellerUnavailablestaleCircuitserviceUnavailablesessionEndedsessionServiceUnavailablestationOfflinestationsNotDeprovisionedsigningSecretTooShortsignInClassMismatchsignInInUsesignInUnverifiedsiteClaimedElsewheresiteOwnedByAnotherEaseeOperatorslugChangeNotAcknowledgedslugTakenspotCurrencyMismatchtariffEnergyAndSpottimeZoneRequiredtimedOutscopeNotGrantedscopeTooLargewindowEndedwindowTooLongsessionCapExceededinvalidMonthmonthTooLargemixedCurrenciesmonthNotClosablemonthHasOpenHoldsmonthAlreadyClosedmonthNotClosedoutcomeFinalmonthClosednotCarriabletargetMonthClosedsettlementServiceUnavailabletransactionAlreadyOpentransactionNotOpentrackingUnavailableunauthorizedunavailableunintelligibleResponseunknownBiddingZoneunknownChargerModelunknownEventTypeunknownFallbackStatusunknownSerialunknownVariableunknownVehicleModelunprocessableunrecognisedApiKeyModeunrecognisedSessionModeunsupportedvendorManagedFirmwarevendorUnreachablevirtualChargerLimitReachedvirtualChargerOrganizationLimitReachedvirtualChargerServiceUnavailablevirtualChargerStateUnavailablewebhookServiceUnavailablewrongPinhomeVehiclePreferencesChangedhomeLimithomeHasMembersinvitationNotFoundhomeNotReadyinvalidPriceinvalidPriceAreagridFeeCurrencyUnsupportedpriceAreaRequirednotAvailableForHomepublicLocationlocationStepRequired
messagestringrequired
A description for people. Its wording may change, so don't parse it.
requestIdstring
This request's id, the same as the x-request-id response header. Quote it when you contact support.

402 Payment required

declined: the card was not accepted.

errorenumrequired
A stable code for the error. Switch on this value: it doesn't change between releases.
One ofstepUpRequiredcoolingOffauthUnavailableavatarTooLargebelowPrivilegedMinimumtryAgainLaterhandoverFinishedintentionNotRemovableaddressAmbiguousaddressNotFoundgeocodingUnavailableinvalidCoordinateResolutionpublicCatalogueUnavailableaccessRevokedjobNotOpenvendorRateLimitedvendorUnavailablezaptecUnavailableincompleteMappinginstallationClaimedconsentInvalidrequestConflictstaleRevisionaccountHasOpenBalanceaccountNotReadyaccountsCollidealreadyStartedambiguousIdTokenambiguousReservationAddressassetServiceUnavailablelocationCoordinatesRequiredforecastTimeOutsideCoverageweatherServiceUnavailableassistantCardRequiredassistantDisabledassistantLimitReachedinstallerPhotoDayLimitinstallerPhotoConversationLimitassistantNotEnabledassistantRouteNotAllowedassistantUnavailableadditionsNotAllowedauthenticationRequiredauthorizationUnavailablebadRequestbatchTooLargebillingAccountClosedbillingAccountSuspendedbillingNotConfiguredbillingServiceUnavailablecapacityExceededcardAlreadyHeldcardBlockedcardOwnedByPrincipalcertificateAuthorityServiceUnavailablechargerUnsafeForHoldcircuitChosenTwicecircuitNotFoundcircuitNotOnJobLocationchargerNotRunningchargePointIdTakenchargerSplitAcrossLocationschargingStationNotAcceptedclaimNotEligibleclaimNotFoundcommandNotSupportedcommandTypeRemovedcommandsUnavailableconflictconfirmationInvalidconfirmationLockedconfirmationNotSentconfirmationRequiredconfirmEraseRequiredconsentMissingconversationClosedconversationBusyconnectionNotEligibleconnectorAlreadyOccupiedconnectorNotFoundconnectorNotOccupiedconfirmOverPlanRequiredcsmsManagedSettingdeclineddiagnosticsReceiverServiceUnavailablediagnosticsRequestOutstandingdiagnosticsUnsupportedProtocolVersiondisconnecteddismissedForSessionduplicateduplicateSlugdetachFirsteaseeCircuitUnmappedeaseeSiteClaimedElsewhereeaseeUnreachableeaseeWrongSerialOrPinemailNotVerifiedemptyEventTypesemptyLimitemptyTransactionLimitenergyControllerUnavailableenergyPricingServiceUnavailableeventTypeNotSubscribableexceedsCapabilityfileExpiredfileNotAvailablefirmwareIdentityUnknownfinishAccountSetupforbiddenhandoverNotReadyhandoverBegunhasChildCircuitshasInvertersholdAmountOutOfRangeholdNotAuthorizedidTokenNotAcceptedidTokenNotRecoverableidempotencyKeyConflictidempotencyKeyInFlightidempotencyKeyReplayedidempotencyStoreUnavailableidentityPlatformUnavailableintegrationEaseeServiceUnavailableintegrationUnavailableconnectionsServiceUnavailableinternalErrorinvalidinvalidAddressinvalidAppDestinationinvalidClientinvalidCoordinatesinvalidCountryinvalidCurrentTypeinvalidEvsesinvalidCursorinvalidErrorCodeinvalidIdTokeninvalidLineinvalidModeinvalidMonitorAssignmentinvalidMonitorConnectioninvalidNameinvalidPaginationinvalidRedirectUriinvalidReasoninvalidPhaseCountinverterBindingConflictinvalidRequestinvalidRegistrationliveUpdatesUnavailableinvalidImageimageTooLargeinvalidWindowmethodNotUsablenotAPaidChargernotCapturedoverRefundpaymentRequiredpricingUnavailableprojectsHaveNoDefaultrevisionConflictinvalidScheduleinvalidScopeinvalidSettingValueinvalidLocationTargetinvalidSluginvalidStartingSocinvalidTargetSocinvalidTargetinvalidTargetUrlinvalidTariffinvalidTariffConditioninvalidTariffIdinvalidTimeZoneinvalidUrlinvalidValueinstallerNotHeldinvitationAlreadyAcceptedinvitationExpiredjobsServiceUnavailableopenJobsservesCustomerGrantsnotAnInstallationsProjectnotAnOperationsProjectgrantNotActivelastCircuitOnLocationlastSignInlocationUnderInstallationlocationNotBuiltlocationAlreadyBuiltmetricsStoreErrormetricsStoreUnavailablemessageTooLongmissingIdTokenmissingIdempotencyKeymonitorConflictmonitorNotFoundmqttServiceUnavailablemissingOrMalformedHeaderinvalidTokenjwksUnavailableapiKeyServiceUnavailablenotConnectednotDispatchablenotEntitledassigneeCannotReadJobnotFoundlabelMistypedlabelNotFoundlabelStockLimitlabelHeldElsewherelabelRetiredlabelLinkedElsewhereoutletHasLabelsandboxOutletnotOfferednotReadynotSandboxModenoFirmwareCatalogednoOpenSessionnoSupportedTransferProtocolnoVehiclenothingToOffernotAdminOrOwnerocppUnavailableorganizationNotEmptyorganizationNumberMismatchownerCannotLeaveownsOrganizationspaymentMethodRequiredbinding.driver_policy_requires_access_permissionbinding.holder_outside_home_projectpermission_policy.deny_not_allowedpermission_policy.deny_on_owner_floorpermission_policy.in_usepermission_policy.invalid_documentpermission_policy.limit_exceededpermission_policy.managed_immutablepermission_policy.management_permission_for_non_memberpermission_policy.name_takenpermission_policy.not_grantablepermission_policy.unknown_permissionpermission_policy.would_remove_last_editorpaymentsAccountNotFoundpaymentsAccountSubmittedpaymentsOrganizationSyntheticpaymentsUnavailablepaymentModeUnknowndeviceAttestationRequiredlimitExceededattestationRejectedpaymentsNotEnabledamountOutOfRangecarNotPluggedInchargerNotReadyorganizationNotTestEligiblequoteExpiredquoteUsedphaseTopologyNotConfirmedprincipalErasedprincipalInactiveprincipalNotFoundprojectNotFoundproposalAlreadyDecidedprotocolErrorrateLimitErrorrateLimitedrecentSignInRequiredcardHeldElsewherecardNotReadablecardUidChangescardsNotEnabledcardsUnavailablelearnAlreadyOpenlearnAmbiguouslearnExpiredlearnNotOfferedratedCurrentNotPositivereferenceTakensandboxOrganizationChargerLimitReachedsandboxProjectChargerLimitReachedsandboxStationRefusedselfParentsellerUnavailablestaleCircuitserviceUnavailablesessionEndedsessionServiceUnavailablestationOfflinestationsNotDeprovisionedsigningSecretTooShortsignInClassMismatchsignInInUsesignInUnverifiedsiteClaimedElsewheresiteOwnedByAnotherEaseeOperatorslugChangeNotAcknowledgedslugTakenspotCurrencyMismatchtariffEnergyAndSpottimeZoneRequiredtimedOutscopeNotGrantedscopeTooLargewindowEndedwindowTooLongsessionCapExceededinvalidMonthmonthTooLargemixedCurrenciesmonthNotClosablemonthHasOpenHoldsmonthAlreadyClosedmonthNotClosedoutcomeFinalmonthClosednotCarriabletargetMonthClosedsettlementServiceUnavailabletransactionAlreadyOpentransactionNotOpentrackingUnavailableunauthorizedunavailableunintelligibleResponseunknownBiddingZoneunknownChargerModelunknownEventTypeunknownFallbackStatusunknownSerialunknownVariableunknownVehicleModelunprocessableunrecognisedApiKeyModeunrecognisedSessionModeunsupportedvendorManagedFirmwarevendorUnreachablevirtualChargerLimitReachedvirtualChargerOrganizationLimitReachedvirtualChargerServiceUnavailablevirtualChargerStateUnavailablewebhookServiceUnavailablewrongPinhomeVehiclePreferencesChangedhomeLimithomeHasMembersinvitationNotFoundhomeNotReadyinvalidPriceinvalidPriceAreagridFeeCurrencyUnsupportedpriceAreaRequirednotAvailableForHomepublicLocationlocationStepRequired
messagestringrequired
A description for people. Its wording may change, so don't parse it.
requestIdstring
This request's id, the same as the x-request-id response header. Quote it when you contact support.

403 Forbidden

errorenumrequired
A stable code for the error. Switch on this value: it doesn't change between releases.
One ofstepUpRequiredcoolingOffauthUnavailableavatarTooLargebelowPrivilegedMinimumtryAgainLaterhandoverFinishedintentionNotRemovableaddressAmbiguousaddressNotFoundgeocodingUnavailableinvalidCoordinateResolutionpublicCatalogueUnavailableaccessRevokedjobNotOpenvendorRateLimitedvendorUnavailablezaptecUnavailableincompleteMappinginstallationClaimedconsentInvalidrequestConflictstaleRevisionaccountHasOpenBalanceaccountNotReadyaccountsCollidealreadyStartedambiguousIdTokenambiguousReservationAddressassetServiceUnavailablelocationCoordinatesRequiredforecastTimeOutsideCoverageweatherServiceUnavailableassistantCardRequiredassistantDisabledassistantLimitReachedinstallerPhotoDayLimitinstallerPhotoConversationLimitassistantNotEnabledassistantRouteNotAllowedassistantUnavailableadditionsNotAllowedauthenticationRequiredauthorizationUnavailablebadRequestbatchTooLargebillingAccountClosedbillingAccountSuspendedbillingNotConfiguredbillingServiceUnavailablecapacityExceededcardAlreadyHeldcardBlockedcardOwnedByPrincipalcertificateAuthorityServiceUnavailablechargerUnsafeForHoldcircuitChosenTwicecircuitNotFoundcircuitNotOnJobLocationchargerNotRunningchargePointIdTakenchargerSplitAcrossLocationschargingStationNotAcceptedclaimNotEligibleclaimNotFoundcommandNotSupportedcommandTypeRemovedcommandsUnavailableconflictconfirmationInvalidconfirmationLockedconfirmationNotSentconfirmationRequiredconfirmEraseRequiredconsentMissingconversationClosedconversationBusyconnectionNotEligibleconnectorAlreadyOccupiedconnectorNotFoundconnectorNotOccupiedconfirmOverPlanRequiredcsmsManagedSettingdeclineddiagnosticsReceiverServiceUnavailablediagnosticsRequestOutstandingdiagnosticsUnsupportedProtocolVersiondisconnecteddismissedForSessionduplicateduplicateSlugdetachFirsteaseeCircuitUnmappedeaseeSiteClaimedElsewhereeaseeUnreachableeaseeWrongSerialOrPinemailNotVerifiedemptyEventTypesemptyLimitemptyTransactionLimitenergyControllerUnavailableenergyPricingServiceUnavailableeventTypeNotSubscribableexceedsCapabilityfileExpiredfileNotAvailablefirmwareIdentityUnknownfinishAccountSetupforbiddenhandoverNotReadyhandoverBegunhasChildCircuitshasInvertersholdAmountOutOfRangeholdNotAuthorizedidTokenNotAcceptedidTokenNotRecoverableidempotencyKeyConflictidempotencyKeyInFlightidempotencyKeyReplayedidempotencyStoreUnavailableidentityPlatformUnavailableintegrationEaseeServiceUnavailableintegrationUnavailableconnectionsServiceUnavailableinternalErrorinvalidinvalidAddressinvalidAppDestinationinvalidClientinvalidCoordinatesinvalidCountryinvalidCurrentTypeinvalidEvsesinvalidCursorinvalidErrorCodeinvalidIdTokeninvalidLineinvalidModeinvalidMonitorAssignmentinvalidMonitorConnectioninvalidNameinvalidPaginationinvalidRedirectUriinvalidReasoninvalidPhaseCountinverterBindingConflictinvalidRequestinvalidRegistrationliveUpdatesUnavailableinvalidImageimageTooLargeinvalidWindowmethodNotUsablenotAPaidChargernotCapturedoverRefundpaymentRequiredpricingUnavailableprojectsHaveNoDefaultrevisionConflictinvalidScheduleinvalidScopeinvalidSettingValueinvalidLocationTargetinvalidSluginvalidStartingSocinvalidTargetSocinvalidTargetinvalidTargetUrlinvalidTariffinvalidTariffConditioninvalidTariffIdinvalidTimeZoneinvalidUrlinvalidValueinstallerNotHeldinvitationAlreadyAcceptedinvitationExpiredjobsServiceUnavailableopenJobsservesCustomerGrantsnotAnInstallationsProjectnotAnOperationsProjectgrantNotActivelastCircuitOnLocationlastSignInlocationUnderInstallationlocationNotBuiltlocationAlreadyBuiltmetricsStoreErrormetricsStoreUnavailablemessageTooLongmissingIdTokenmissingIdempotencyKeymonitorConflictmonitorNotFoundmqttServiceUnavailablemissingOrMalformedHeaderinvalidTokenjwksUnavailableapiKeyServiceUnavailablenotConnectednotDispatchablenotEntitledassigneeCannotReadJobnotFoundlabelMistypedlabelNotFoundlabelStockLimitlabelHeldElsewherelabelRetiredlabelLinkedElsewhereoutletHasLabelsandboxOutletnotOfferednotReadynotSandboxModenoFirmwareCatalogednoOpenSessionnoSupportedTransferProtocolnoVehiclenothingToOffernotAdminOrOwnerocppUnavailableorganizationNotEmptyorganizationNumberMismatchownerCannotLeaveownsOrganizationspaymentMethodRequiredbinding.driver_policy_requires_access_permissionbinding.holder_outside_home_projectpermission_policy.deny_not_allowedpermission_policy.deny_on_owner_floorpermission_policy.in_usepermission_policy.invalid_documentpermission_policy.limit_exceededpermission_policy.managed_immutablepermission_policy.management_permission_for_non_memberpermission_policy.name_takenpermission_policy.not_grantablepermission_policy.unknown_permissionpermission_policy.would_remove_last_editorpaymentsAccountNotFoundpaymentsAccountSubmittedpaymentsOrganizationSyntheticpaymentsUnavailablepaymentModeUnknowndeviceAttestationRequiredlimitExceededattestationRejectedpaymentsNotEnabledamountOutOfRangecarNotPluggedInchargerNotReadyorganizationNotTestEligiblequoteExpiredquoteUsedphaseTopologyNotConfirmedprincipalErasedprincipalInactiveprincipalNotFoundprojectNotFoundproposalAlreadyDecidedprotocolErrorrateLimitErrorrateLimitedrecentSignInRequiredcardHeldElsewherecardNotReadablecardUidChangescardsNotEnabledcardsUnavailablelearnAlreadyOpenlearnAmbiguouslearnExpiredlearnNotOfferedratedCurrentNotPositivereferenceTakensandboxOrganizationChargerLimitReachedsandboxProjectChargerLimitReachedsandboxStationRefusedselfParentsellerUnavailablestaleCircuitserviceUnavailablesessionEndedsessionServiceUnavailablestationOfflinestationsNotDeprovisionedsigningSecretTooShortsignInClassMismatchsignInInUsesignInUnverifiedsiteClaimedElsewheresiteOwnedByAnotherEaseeOperatorslugChangeNotAcknowledgedslugTakenspotCurrencyMismatchtariffEnergyAndSpottimeZoneRequiredtimedOutscopeNotGrantedscopeTooLargewindowEndedwindowTooLongsessionCapExceededinvalidMonthmonthTooLargemixedCurrenciesmonthNotClosablemonthHasOpenHoldsmonthAlreadyClosedmonthNotClosedoutcomeFinalmonthClosednotCarriabletargetMonthClosedsettlementServiceUnavailabletransactionAlreadyOpentransactionNotOpentrackingUnavailableunauthorizedunavailableunintelligibleResponseunknownBiddingZoneunknownChargerModelunknownEventTypeunknownFallbackStatusunknownSerialunknownVariableunknownVehicleModelunprocessableunrecognisedApiKeyModeunrecognisedSessionModeunsupportedvendorManagedFirmwarevendorUnreachablevirtualChargerLimitReachedvirtualChargerOrganizationLimitReachedvirtualChargerServiceUnavailablevirtualChargerStateUnavailablewebhookServiceUnavailablewrongPinhomeVehiclePreferencesChangedhomeLimithomeHasMembersinvitationNotFoundhomeNotReadyinvalidPriceinvalidPriceAreagridFeeCurrencyUnsupportedpriceAreaRequirednotAvailableForHomepublicLocationlocationStepRequired
messagestringrequired
A description for people. Its wording may change, so don't parse it.
requestIdstring
This request's id, the same as the x-request-id response header. Quote it when you contact support.

404 Not found

No such quote among yours.

errorenumrequired
A stable code for the error. Switch on this value: it doesn't change between releases.
One ofstepUpRequiredcoolingOffauthUnavailableavatarTooLargebelowPrivilegedMinimumtryAgainLaterhandoverFinishedintentionNotRemovableaddressAmbiguousaddressNotFoundgeocodingUnavailableinvalidCoordinateResolutionpublicCatalogueUnavailableaccessRevokedjobNotOpenvendorRateLimitedvendorUnavailablezaptecUnavailableincompleteMappinginstallationClaimedconsentInvalidrequestConflictstaleRevisionaccountHasOpenBalanceaccountNotReadyaccountsCollidealreadyStartedambiguousIdTokenambiguousReservationAddressassetServiceUnavailablelocationCoordinatesRequiredforecastTimeOutsideCoverageweatherServiceUnavailableassistantCardRequiredassistantDisabledassistantLimitReachedinstallerPhotoDayLimitinstallerPhotoConversationLimitassistantNotEnabledassistantRouteNotAllowedassistantUnavailableadditionsNotAllowedauthenticationRequiredauthorizationUnavailablebadRequestbatchTooLargebillingAccountClosedbillingAccountSuspendedbillingNotConfiguredbillingServiceUnavailablecapacityExceededcardAlreadyHeldcardBlockedcardOwnedByPrincipalcertificateAuthorityServiceUnavailablechargerUnsafeForHoldcircuitChosenTwicecircuitNotFoundcircuitNotOnJobLocationchargerNotRunningchargePointIdTakenchargerSplitAcrossLocationschargingStationNotAcceptedclaimNotEligibleclaimNotFoundcommandNotSupportedcommandTypeRemovedcommandsUnavailableconflictconfirmationInvalidconfirmationLockedconfirmationNotSentconfirmationRequiredconfirmEraseRequiredconsentMissingconversationClosedconversationBusyconnectionNotEligibleconnectorAlreadyOccupiedconnectorNotFoundconnectorNotOccupiedconfirmOverPlanRequiredcsmsManagedSettingdeclineddiagnosticsReceiverServiceUnavailablediagnosticsRequestOutstandingdiagnosticsUnsupportedProtocolVersiondisconnecteddismissedForSessionduplicateduplicateSlugdetachFirsteaseeCircuitUnmappedeaseeSiteClaimedElsewhereeaseeUnreachableeaseeWrongSerialOrPinemailNotVerifiedemptyEventTypesemptyLimitemptyTransactionLimitenergyControllerUnavailableenergyPricingServiceUnavailableeventTypeNotSubscribableexceedsCapabilityfileExpiredfileNotAvailablefirmwareIdentityUnknownfinishAccountSetupforbiddenhandoverNotReadyhandoverBegunhasChildCircuitshasInvertersholdAmountOutOfRangeholdNotAuthorizedidTokenNotAcceptedidTokenNotRecoverableidempotencyKeyConflictidempotencyKeyInFlightidempotencyKeyReplayedidempotencyStoreUnavailableidentityPlatformUnavailableintegrationEaseeServiceUnavailableintegrationUnavailableconnectionsServiceUnavailableinternalErrorinvalidinvalidAddressinvalidAppDestinationinvalidClientinvalidCoordinatesinvalidCountryinvalidCurrentTypeinvalidEvsesinvalidCursorinvalidErrorCodeinvalidIdTokeninvalidLineinvalidModeinvalidMonitorAssignmentinvalidMonitorConnectioninvalidNameinvalidPaginationinvalidRedirectUriinvalidReasoninvalidPhaseCountinverterBindingConflictinvalidRequestinvalidRegistrationliveUpdatesUnavailableinvalidImageimageTooLargeinvalidWindowmethodNotUsablenotAPaidChargernotCapturedoverRefundpaymentRequiredpricingUnavailableprojectsHaveNoDefaultrevisionConflictinvalidScheduleinvalidScopeinvalidSettingValueinvalidLocationTargetinvalidSluginvalidStartingSocinvalidTargetSocinvalidTargetinvalidTargetUrlinvalidTariffinvalidTariffConditioninvalidTariffIdinvalidTimeZoneinvalidUrlinvalidValueinstallerNotHeldinvitationAlreadyAcceptedinvitationExpiredjobsServiceUnavailableopenJobsservesCustomerGrantsnotAnInstallationsProjectnotAnOperationsProjectgrantNotActivelastCircuitOnLocationlastSignInlocationUnderInstallationlocationNotBuiltlocationAlreadyBuiltmetricsStoreErrormetricsStoreUnavailablemessageTooLongmissingIdTokenmissingIdempotencyKeymonitorConflictmonitorNotFoundmqttServiceUnavailablemissingOrMalformedHeaderinvalidTokenjwksUnavailableapiKeyServiceUnavailablenotConnectednotDispatchablenotEntitledassigneeCannotReadJobnotFoundlabelMistypedlabelNotFoundlabelStockLimitlabelHeldElsewherelabelRetiredlabelLinkedElsewhereoutletHasLabelsandboxOutletnotOfferednotReadynotSandboxModenoFirmwareCatalogednoOpenSessionnoSupportedTransferProtocolnoVehiclenothingToOffernotAdminOrOwnerocppUnavailableorganizationNotEmptyorganizationNumberMismatchownerCannotLeaveownsOrganizationspaymentMethodRequiredbinding.driver_policy_requires_access_permissionbinding.holder_outside_home_projectpermission_policy.deny_not_allowedpermission_policy.deny_on_owner_floorpermission_policy.in_usepermission_policy.invalid_documentpermission_policy.limit_exceededpermission_policy.managed_immutablepermission_policy.management_permission_for_non_memberpermission_policy.name_takenpermission_policy.not_grantablepermission_policy.unknown_permissionpermission_policy.would_remove_last_editorpaymentsAccountNotFoundpaymentsAccountSubmittedpaymentsOrganizationSyntheticpaymentsUnavailablepaymentModeUnknowndeviceAttestationRequiredlimitExceededattestationRejectedpaymentsNotEnabledamountOutOfRangecarNotPluggedInchargerNotReadyorganizationNotTestEligiblequoteExpiredquoteUsedphaseTopologyNotConfirmedprincipalErasedprincipalInactiveprincipalNotFoundprojectNotFoundproposalAlreadyDecidedprotocolErrorrateLimitErrorrateLimitedrecentSignInRequiredcardHeldElsewherecardNotReadablecardUidChangescardsNotEnabledcardsUnavailablelearnAlreadyOpenlearnAmbiguouslearnExpiredlearnNotOfferedratedCurrentNotPositivereferenceTakensandboxOrganizationChargerLimitReachedsandboxProjectChargerLimitReachedsandboxStationRefusedselfParentsellerUnavailablestaleCircuitserviceUnavailablesessionEndedsessionServiceUnavailablestationOfflinestationsNotDeprovisionedsigningSecretTooShortsignInClassMismatchsignInInUsesignInUnverifiedsiteClaimedElsewheresiteOwnedByAnotherEaseeOperatorslugChangeNotAcknowledgedslugTakenspotCurrencyMismatchtariffEnergyAndSpottimeZoneRequiredtimedOutscopeNotGrantedscopeTooLargewindowEndedwindowTooLongsessionCapExceededinvalidMonthmonthTooLargemixedCurrenciesmonthNotClosablemonthHasOpenHoldsmonthAlreadyClosedmonthNotClosedoutcomeFinalmonthClosednotCarriabletargetMonthClosedsettlementServiceUnavailabletransactionAlreadyOpentransactionNotOpentrackingUnavailableunauthorizedunavailableunintelligibleResponseunknownBiddingZoneunknownChargerModelunknownEventTypeunknownFallbackStatusunknownSerialunknownVariableunknownVehicleModelunprocessableunrecognisedApiKeyModeunrecognisedSessionModeunsupportedvendorManagedFirmwarevendorUnreachablevirtualChargerLimitReachedvirtualChargerOrganizationLimitReachedvirtualChargerServiceUnavailablevirtualChargerStateUnavailablewebhookServiceUnavailablewrongPinhomeVehiclePreferencesChangedhomeLimithomeHasMembersinvitationNotFoundhomeNotReadyinvalidPriceinvalidPriceAreagridFeeCurrencyUnsupportedpriceAreaRequirednotAvailableForHomepublicLocationlocationStepRequired
messagestringrequired
A description for people. Its wording may change, so don't parse it.
requestIdstring
This request's id, the same as the x-request-id response header. Quote it when you contact support.

409 Conflict

quoteExpired, quoteUsed, accountNotReady, chargerUnsafeForHold or organizationNotTestEligible.

errorenumrequired
A stable code for the error. Switch on this value: it doesn't change between releases.
One ofstepUpRequiredcoolingOffauthUnavailableavatarTooLargebelowPrivilegedMinimumtryAgainLaterhandoverFinishedintentionNotRemovableaddressAmbiguousaddressNotFoundgeocodingUnavailableinvalidCoordinateResolutionpublicCatalogueUnavailableaccessRevokedjobNotOpenvendorRateLimitedvendorUnavailablezaptecUnavailableincompleteMappinginstallationClaimedconsentInvalidrequestConflictstaleRevisionaccountHasOpenBalanceaccountNotReadyaccountsCollidealreadyStartedambiguousIdTokenambiguousReservationAddressassetServiceUnavailablelocationCoordinatesRequiredforecastTimeOutsideCoverageweatherServiceUnavailableassistantCardRequiredassistantDisabledassistantLimitReachedinstallerPhotoDayLimitinstallerPhotoConversationLimitassistantNotEnabledassistantRouteNotAllowedassistantUnavailableadditionsNotAllowedauthenticationRequiredauthorizationUnavailablebadRequestbatchTooLargebillingAccountClosedbillingAccountSuspendedbillingNotConfiguredbillingServiceUnavailablecapacityExceededcardAlreadyHeldcardBlockedcardOwnedByPrincipalcertificateAuthorityServiceUnavailablechargerUnsafeForHoldcircuitChosenTwicecircuitNotFoundcircuitNotOnJobLocationchargerNotRunningchargePointIdTakenchargerSplitAcrossLocationschargingStationNotAcceptedclaimNotEligibleclaimNotFoundcommandNotSupportedcommandTypeRemovedcommandsUnavailableconflictconfirmationInvalidconfirmationLockedconfirmationNotSentconfirmationRequiredconfirmEraseRequiredconsentMissingconversationClosedconversationBusyconnectionNotEligibleconnectorAlreadyOccupiedconnectorNotFoundconnectorNotOccupiedconfirmOverPlanRequiredcsmsManagedSettingdeclineddiagnosticsReceiverServiceUnavailablediagnosticsRequestOutstandingdiagnosticsUnsupportedProtocolVersiondisconnecteddismissedForSessionduplicateduplicateSlugdetachFirsteaseeCircuitUnmappedeaseeSiteClaimedElsewhereeaseeUnreachableeaseeWrongSerialOrPinemailNotVerifiedemptyEventTypesemptyLimitemptyTransactionLimitenergyControllerUnavailableenergyPricingServiceUnavailableeventTypeNotSubscribableexceedsCapabilityfileExpiredfileNotAvailablefirmwareIdentityUnknownfinishAccountSetupforbiddenhandoverNotReadyhandoverBegunhasChildCircuitshasInvertersholdAmountOutOfRangeholdNotAuthorizedidTokenNotAcceptedidTokenNotRecoverableidempotencyKeyConflictidempotencyKeyInFlightidempotencyKeyReplayedidempotencyStoreUnavailableidentityPlatformUnavailableintegrationEaseeServiceUnavailableintegrationUnavailableconnectionsServiceUnavailableinternalErrorinvalidinvalidAddressinvalidAppDestinationinvalidClientinvalidCoordinatesinvalidCountryinvalidCurrentTypeinvalidEvsesinvalidCursorinvalidErrorCodeinvalidIdTokeninvalidLineinvalidModeinvalidMonitorAssignmentinvalidMonitorConnectioninvalidNameinvalidPaginationinvalidRedirectUriinvalidReasoninvalidPhaseCountinverterBindingConflictinvalidRequestinvalidRegistrationliveUpdatesUnavailableinvalidImageimageTooLargeinvalidWindowmethodNotUsablenotAPaidChargernotCapturedoverRefundpaymentRequiredpricingUnavailableprojectsHaveNoDefaultrevisionConflictinvalidScheduleinvalidScopeinvalidSettingValueinvalidLocationTargetinvalidSluginvalidStartingSocinvalidTargetSocinvalidTargetinvalidTargetUrlinvalidTariffinvalidTariffConditioninvalidTariffIdinvalidTimeZoneinvalidUrlinvalidValueinstallerNotHeldinvitationAlreadyAcceptedinvitationExpiredjobsServiceUnavailableopenJobsservesCustomerGrantsnotAnInstallationsProjectnotAnOperationsProjectgrantNotActivelastCircuitOnLocationlastSignInlocationUnderInstallationlocationNotBuiltlocationAlreadyBuiltmetricsStoreErrormetricsStoreUnavailablemessageTooLongmissingIdTokenmissingIdempotencyKeymonitorConflictmonitorNotFoundmqttServiceUnavailablemissingOrMalformedHeaderinvalidTokenjwksUnavailableapiKeyServiceUnavailablenotConnectednotDispatchablenotEntitledassigneeCannotReadJobnotFoundlabelMistypedlabelNotFoundlabelStockLimitlabelHeldElsewherelabelRetiredlabelLinkedElsewhereoutletHasLabelsandboxOutletnotOfferednotReadynotSandboxModenoFirmwareCatalogednoOpenSessionnoSupportedTransferProtocolnoVehiclenothingToOffernotAdminOrOwnerocppUnavailableorganizationNotEmptyorganizationNumberMismatchownerCannotLeaveownsOrganizationspaymentMethodRequiredbinding.driver_policy_requires_access_permissionbinding.holder_outside_home_projectpermission_policy.deny_not_allowedpermission_policy.deny_on_owner_floorpermission_policy.in_usepermission_policy.invalid_documentpermission_policy.limit_exceededpermission_policy.managed_immutablepermission_policy.management_permission_for_non_memberpermission_policy.name_takenpermission_policy.not_grantablepermission_policy.unknown_permissionpermission_policy.would_remove_last_editorpaymentsAccountNotFoundpaymentsAccountSubmittedpaymentsOrganizationSyntheticpaymentsUnavailablepaymentModeUnknowndeviceAttestationRequiredlimitExceededattestationRejectedpaymentsNotEnabledamountOutOfRangecarNotPluggedInchargerNotReadyorganizationNotTestEligiblequoteExpiredquoteUsedphaseTopologyNotConfirmedprincipalErasedprincipalInactiveprincipalNotFoundprojectNotFoundproposalAlreadyDecidedprotocolErrorrateLimitErrorrateLimitedrecentSignInRequiredcardHeldElsewherecardNotReadablecardUidChangescardsNotEnabledcardsUnavailablelearnAlreadyOpenlearnAmbiguouslearnExpiredlearnNotOfferedratedCurrentNotPositivereferenceTakensandboxOrganizationChargerLimitReachedsandboxProjectChargerLimitReachedsandboxStationRefusedselfParentsellerUnavailablestaleCircuitserviceUnavailablesessionEndedsessionServiceUnavailablestationOfflinestationsNotDeprovisionedsigningSecretTooShortsignInClassMismatchsignInInUsesignInUnverifiedsiteClaimedElsewheresiteOwnedByAnotherEaseeOperatorslugChangeNotAcknowledgedslugTakenspotCurrencyMismatchtariffEnergyAndSpottimeZoneRequiredtimedOutscopeNotGrantedscopeTooLargewindowEndedwindowTooLongsessionCapExceededinvalidMonthmonthTooLargemixedCurrenciesmonthNotClosablemonthHasOpenHoldsmonthAlreadyClosedmonthNotClosedoutcomeFinalmonthClosednotCarriabletargetMonthClosedsettlementServiceUnavailabletransactionAlreadyOpentransactionNotOpentrackingUnavailableunauthorizedunavailableunintelligibleResponseunknownBiddingZoneunknownChargerModelunknownEventTypeunknownFallbackStatusunknownSerialunknownVariableunknownVehicleModelunprocessableunrecognisedApiKeyModeunrecognisedSessionModeunsupportedvendorManagedFirmwarevendorUnreachablevirtualChargerLimitReachedvirtualChargerOrganizationLimitReachedvirtualChargerServiceUnavailablevirtualChargerStateUnavailablewebhookServiceUnavailablewrongPinhomeVehiclePreferencesChangedhomeLimithomeHasMembersinvitationNotFoundhomeNotReadyinvalidPriceinvalidPriceAreagridFeeCurrencyUnsupportedpriceAreaRequirednotAvailableForHomepublicLocationlocationStepRequired
messagestringrequired
A description for people. Its wording may change, so don't parse it.
requestIdstring
This request's id, the same as the x-request-id response header. Quote it when you contact support.

429 Too many requests

Too many requests. Wait the number of seconds in Retry-After, then try again.

errorenumrequired
A stable code for the error. Switch on this value: it doesn't change between releases.
One ofstepUpRequiredcoolingOffauthUnavailableavatarTooLargebelowPrivilegedMinimumtryAgainLaterhandoverFinishedintentionNotRemovableaddressAmbiguousaddressNotFoundgeocodingUnavailableinvalidCoordinateResolutionpublicCatalogueUnavailableaccessRevokedjobNotOpenvendorRateLimitedvendorUnavailablezaptecUnavailableincompleteMappinginstallationClaimedconsentInvalidrequestConflictstaleRevisionaccountHasOpenBalanceaccountNotReadyaccountsCollidealreadyStartedambiguousIdTokenambiguousReservationAddressassetServiceUnavailablelocationCoordinatesRequiredforecastTimeOutsideCoverageweatherServiceUnavailableassistantCardRequiredassistantDisabledassistantLimitReachedinstallerPhotoDayLimitinstallerPhotoConversationLimitassistantNotEnabledassistantRouteNotAllowedassistantUnavailableadditionsNotAllowedauthenticationRequiredauthorizationUnavailablebadRequestbatchTooLargebillingAccountClosedbillingAccountSuspendedbillingNotConfiguredbillingServiceUnavailablecapacityExceededcardAlreadyHeldcardBlockedcardOwnedByPrincipalcertificateAuthorityServiceUnavailablechargerUnsafeForHoldcircuitChosenTwicecircuitNotFoundcircuitNotOnJobLocationchargerNotRunningchargePointIdTakenchargerSplitAcrossLocationschargingStationNotAcceptedclaimNotEligibleclaimNotFoundcommandNotSupportedcommandTypeRemovedcommandsUnavailableconflictconfirmationInvalidconfirmationLockedconfirmationNotSentconfirmationRequiredconfirmEraseRequiredconsentMissingconversationClosedconversationBusyconnectionNotEligibleconnectorAlreadyOccupiedconnectorNotFoundconnectorNotOccupiedconfirmOverPlanRequiredcsmsManagedSettingdeclineddiagnosticsReceiverServiceUnavailablediagnosticsRequestOutstandingdiagnosticsUnsupportedProtocolVersiondisconnecteddismissedForSessionduplicateduplicateSlugdetachFirsteaseeCircuitUnmappedeaseeSiteClaimedElsewhereeaseeUnreachableeaseeWrongSerialOrPinemailNotVerifiedemptyEventTypesemptyLimitemptyTransactionLimitenergyControllerUnavailableenergyPricingServiceUnavailableeventTypeNotSubscribableexceedsCapabilityfileExpiredfileNotAvailablefirmwareIdentityUnknownfinishAccountSetupforbiddenhandoverNotReadyhandoverBegunhasChildCircuitshasInvertersholdAmountOutOfRangeholdNotAuthorizedidTokenNotAcceptedidTokenNotRecoverableidempotencyKeyConflictidempotencyKeyInFlightidempotencyKeyReplayedidempotencyStoreUnavailableidentityPlatformUnavailableintegrationEaseeServiceUnavailableintegrationUnavailableconnectionsServiceUnavailableinternalErrorinvalidinvalidAddressinvalidAppDestinationinvalidClientinvalidCoordinatesinvalidCountryinvalidCurrentTypeinvalidEvsesinvalidCursorinvalidErrorCodeinvalidIdTokeninvalidLineinvalidModeinvalidMonitorAssignmentinvalidMonitorConnectioninvalidNameinvalidPaginationinvalidRedirectUriinvalidReasoninvalidPhaseCountinverterBindingConflictinvalidRequestinvalidRegistrationliveUpdatesUnavailableinvalidImageimageTooLargeinvalidWindowmethodNotUsablenotAPaidChargernotCapturedoverRefundpaymentRequiredpricingUnavailableprojectsHaveNoDefaultrevisionConflictinvalidScheduleinvalidScopeinvalidSettingValueinvalidLocationTargetinvalidSluginvalidStartingSocinvalidTargetSocinvalidTargetinvalidTargetUrlinvalidTariffinvalidTariffConditioninvalidTariffIdinvalidTimeZoneinvalidUrlinvalidValueinstallerNotHeldinvitationAlreadyAcceptedinvitationExpiredjobsServiceUnavailableopenJobsservesCustomerGrantsnotAnInstallationsProjectnotAnOperationsProjectgrantNotActivelastCircuitOnLocationlastSignInlocationUnderInstallationlocationNotBuiltlocationAlreadyBuiltmetricsStoreErrormetricsStoreUnavailablemessageTooLongmissingIdTokenmissingIdempotencyKeymonitorConflictmonitorNotFoundmqttServiceUnavailablemissingOrMalformedHeaderinvalidTokenjwksUnavailableapiKeyServiceUnavailablenotConnectednotDispatchablenotEntitledassigneeCannotReadJobnotFoundlabelMistypedlabelNotFoundlabelStockLimitlabelHeldElsewherelabelRetiredlabelLinkedElsewhereoutletHasLabelsandboxOutletnotOfferednotReadynotSandboxModenoFirmwareCatalogednoOpenSessionnoSupportedTransferProtocolnoVehiclenothingToOffernotAdminOrOwnerocppUnavailableorganizationNotEmptyorganizationNumberMismatchownerCannotLeaveownsOrganizationspaymentMethodRequiredbinding.driver_policy_requires_access_permissionbinding.holder_outside_home_projectpermission_policy.deny_not_allowedpermission_policy.deny_on_owner_floorpermission_policy.in_usepermission_policy.invalid_documentpermission_policy.limit_exceededpermission_policy.managed_immutablepermission_policy.management_permission_for_non_memberpermission_policy.name_takenpermission_policy.not_grantablepermission_policy.unknown_permissionpermission_policy.would_remove_last_editorpaymentsAccountNotFoundpaymentsAccountSubmittedpaymentsOrganizationSyntheticpaymentsUnavailablepaymentModeUnknowndeviceAttestationRequiredlimitExceededattestationRejectedpaymentsNotEnabledamountOutOfRangecarNotPluggedInchargerNotReadyorganizationNotTestEligiblequoteExpiredquoteUsedphaseTopologyNotConfirmedprincipalErasedprincipalInactiveprincipalNotFoundprojectNotFoundproposalAlreadyDecidedprotocolErrorrateLimitErrorrateLimitedrecentSignInRequiredcardHeldElsewherecardNotReadablecardUidChangescardsNotEnabledcardsUnavailablelearnAlreadyOpenlearnAmbiguouslearnExpiredlearnNotOfferedratedCurrentNotPositivereferenceTakensandboxOrganizationChargerLimitReachedsandboxProjectChargerLimitReachedsandboxStationRefusedselfParentsellerUnavailablestaleCircuitserviceUnavailablesessionEndedsessionServiceUnavailablestationOfflinestationsNotDeprovisionedsigningSecretTooShortsignInClassMismatchsignInInUsesignInUnverifiedsiteClaimedElsewheresiteOwnedByAnotherEaseeOperatorslugChangeNotAcknowledgedslugTakenspotCurrencyMismatchtariffEnergyAndSpottimeZoneRequiredtimedOutscopeNotGrantedscopeTooLargewindowEndedwindowTooLongsessionCapExceededinvalidMonthmonthTooLargemixedCurrenciesmonthNotClosablemonthHasOpenHoldsmonthAlreadyClosedmonthNotClosedoutcomeFinalmonthClosednotCarriabletargetMonthClosedsettlementServiceUnavailabletransactionAlreadyOpentransactionNotOpentrackingUnavailableunauthorizedunavailableunintelligibleResponseunknownBiddingZoneunknownChargerModelunknownEventTypeunknownFallbackStatusunknownSerialunknownVariableunknownVehicleModelunprocessableunrecognisedApiKeyModeunrecognisedSessionModeunsupportedvendorManagedFirmwarevendorUnreachablevirtualChargerLimitReachedvirtualChargerOrganizationLimitReachedvirtualChargerServiceUnavailablevirtualChargerStateUnavailablewebhookServiceUnavailablewrongPinhomeVehiclePreferencesChangedhomeLimithomeHasMembersinvitationNotFoundhomeNotReadyinvalidPriceinvalidPriceAreagridFeeCurrencyUnsupportedpriceAreaRequirednotAvailableForHomepublicLocationlocationStepRequired
messagestringrequired
A description for people. Its wording may change, so don't parse it.
requestIdstring
This request's id, the same as the x-request-id response header. Quote it when you contact support.

500 Internal error

Something went wrong on our side. Try again, and if it keeps happening, contact support with the response's requestId.

errorenumrequired
A stable code for the error. Switch on this value: it doesn't change between releases.
One ofstepUpRequiredcoolingOffauthUnavailableavatarTooLargebelowPrivilegedMinimumtryAgainLaterhandoverFinishedintentionNotRemovableaddressAmbiguousaddressNotFoundgeocodingUnavailableinvalidCoordinateResolutionpublicCatalogueUnavailableaccessRevokedjobNotOpenvendorRateLimitedvendorUnavailablezaptecUnavailableincompleteMappinginstallationClaimedconsentInvalidrequestConflictstaleRevisionaccountHasOpenBalanceaccountNotReadyaccountsCollidealreadyStartedambiguousIdTokenambiguousReservationAddressassetServiceUnavailablelocationCoordinatesRequiredforecastTimeOutsideCoverageweatherServiceUnavailableassistantCardRequiredassistantDisabledassistantLimitReachedinstallerPhotoDayLimitinstallerPhotoConversationLimitassistantNotEnabledassistantRouteNotAllowedassistantUnavailableadditionsNotAllowedauthenticationRequiredauthorizationUnavailablebadRequestbatchTooLargebillingAccountClosedbillingAccountSuspendedbillingNotConfiguredbillingServiceUnavailablecapacityExceededcardAlreadyHeldcardBlockedcardOwnedByPrincipalcertificateAuthorityServiceUnavailablechargerUnsafeForHoldcircuitChosenTwicecircuitNotFoundcircuitNotOnJobLocationchargerNotRunningchargePointIdTakenchargerSplitAcrossLocationschargingStationNotAcceptedclaimNotEligibleclaimNotFoundcommandNotSupportedcommandTypeRemovedcommandsUnavailableconflictconfirmationInvalidconfirmationLockedconfirmationNotSentconfirmationRequiredconfirmEraseRequiredconsentMissingconversationClosedconversationBusyconnectionNotEligibleconnectorAlreadyOccupiedconnectorNotFoundconnectorNotOccupiedconfirmOverPlanRequiredcsmsManagedSettingdeclineddiagnosticsReceiverServiceUnavailablediagnosticsRequestOutstandingdiagnosticsUnsupportedProtocolVersiondisconnecteddismissedForSessionduplicateduplicateSlugdetachFirsteaseeCircuitUnmappedeaseeSiteClaimedElsewhereeaseeUnreachableeaseeWrongSerialOrPinemailNotVerifiedemptyEventTypesemptyLimitemptyTransactionLimitenergyControllerUnavailableenergyPricingServiceUnavailableeventTypeNotSubscribableexceedsCapabilityfileExpiredfileNotAvailablefirmwareIdentityUnknownfinishAccountSetupforbiddenhandoverNotReadyhandoverBegunhasChildCircuitshasInvertersholdAmountOutOfRangeholdNotAuthorizedidTokenNotAcceptedidTokenNotRecoverableidempotencyKeyConflictidempotencyKeyInFlightidempotencyKeyReplayedidempotencyStoreUnavailableidentityPlatformUnavailableintegrationEaseeServiceUnavailableintegrationUnavailableconnectionsServiceUnavailableinternalErrorinvalidinvalidAddressinvalidAppDestinationinvalidClientinvalidCoordinatesinvalidCountryinvalidCurrentTypeinvalidEvsesinvalidCursorinvalidErrorCodeinvalidIdTokeninvalidLineinvalidModeinvalidMonitorAssignmentinvalidMonitorConnectioninvalidNameinvalidPaginationinvalidRedirectUriinvalidReasoninvalidPhaseCountinverterBindingConflictinvalidRequestinvalidRegistrationliveUpdatesUnavailableinvalidImageimageTooLargeinvalidWindowmethodNotUsablenotAPaidChargernotCapturedoverRefundpaymentRequiredpricingUnavailableprojectsHaveNoDefaultrevisionConflictinvalidScheduleinvalidScopeinvalidSettingValueinvalidLocationTargetinvalidSluginvalidStartingSocinvalidTargetSocinvalidTargetinvalidTargetUrlinvalidTariffinvalidTariffConditioninvalidTariffIdinvalidTimeZoneinvalidUrlinvalidValueinstallerNotHeldinvitationAlreadyAcceptedinvitationExpiredjobsServiceUnavailableopenJobsservesCustomerGrantsnotAnInstallationsProjectnotAnOperationsProjectgrantNotActivelastCircuitOnLocationlastSignInlocationUnderInstallationlocationNotBuiltlocationAlreadyBuiltmetricsStoreErrormetricsStoreUnavailablemessageTooLongmissingIdTokenmissingIdempotencyKeymonitorConflictmonitorNotFoundmqttServiceUnavailablemissingOrMalformedHeaderinvalidTokenjwksUnavailableapiKeyServiceUnavailablenotConnectednotDispatchablenotEntitledassigneeCannotReadJobnotFoundlabelMistypedlabelNotFoundlabelStockLimitlabelHeldElsewherelabelRetiredlabelLinkedElsewhereoutletHasLabelsandboxOutletnotOfferednotReadynotSandboxModenoFirmwareCatalogednoOpenSessionnoSupportedTransferProtocolnoVehiclenothingToOffernotAdminOrOwnerocppUnavailableorganizationNotEmptyorganizationNumberMismatchownerCannotLeaveownsOrganizationspaymentMethodRequiredbinding.driver_policy_requires_access_permissionbinding.holder_outside_home_projectpermission_policy.deny_not_allowedpermission_policy.deny_on_owner_floorpermission_policy.in_usepermission_policy.invalid_documentpermission_policy.limit_exceededpermission_policy.managed_immutablepermission_policy.management_permission_for_non_memberpermission_policy.name_takenpermission_policy.not_grantablepermission_policy.unknown_permissionpermission_policy.would_remove_last_editorpaymentsAccountNotFoundpaymentsAccountSubmittedpaymentsOrganizationSyntheticpaymentsUnavailablepaymentModeUnknowndeviceAttestationRequiredlimitExceededattestationRejectedpaymentsNotEnabledamountOutOfRangecarNotPluggedInchargerNotReadyorganizationNotTestEligiblequoteExpiredquoteUsedphaseTopologyNotConfirmedprincipalErasedprincipalInactiveprincipalNotFoundprojectNotFoundproposalAlreadyDecidedprotocolErrorrateLimitErrorrateLimitedrecentSignInRequiredcardHeldElsewherecardNotReadablecardUidChangescardsNotEnabledcardsUnavailablelearnAlreadyOpenlearnAmbiguouslearnExpiredlearnNotOfferedratedCurrentNotPositivereferenceTakensandboxOrganizationChargerLimitReachedsandboxProjectChargerLimitReachedsandboxStationRefusedselfParentsellerUnavailablestaleCircuitserviceUnavailablesessionEndedsessionServiceUnavailablestationOfflinestationsNotDeprovisionedsigningSecretTooShortsignInClassMismatchsignInInUsesignInUnverifiedsiteClaimedElsewheresiteOwnedByAnotherEaseeOperatorslugChangeNotAcknowledgedslugTakenspotCurrencyMismatchtariffEnergyAndSpottimeZoneRequiredtimedOutscopeNotGrantedscopeTooLargewindowEndedwindowTooLongsessionCapExceededinvalidMonthmonthTooLargemixedCurrenciesmonthNotClosablemonthHasOpenHoldsmonthAlreadyClosedmonthNotClosedoutcomeFinalmonthClosednotCarriabletargetMonthClosedsettlementServiceUnavailabletransactionAlreadyOpentransactionNotOpentrackingUnavailableunauthorizedunavailableunintelligibleResponseunknownBiddingZoneunknownChargerModelunknownEventTypeunknownFallbackStatusunknownSerialunknownVariableunknownVehicleModelunprocessableunrecognisedApiKeyModeunrecognisedSessionModeunsupportedvendorManagedFirmwarevendorUnreachablevirtualChargerLimitReachedvirtualChargerOrganizationLimitReachedvirtualChargerServiceUnavailablevirtualChargerStateUnavailablewebhookServiceUnavailablewrongPinhomeVehiclePreferencesChangedhomeLimithomeHasMembersinvitationNotFoundhomeNotReadyinvalidPriceinvalidPriceAreagridFeeCurrencyUnsupportedpriceAreaRequirednotAvailableForHomepublicLocationlocationStepRequired
messagestringrequired
A description for people. Its wording may change, so don't parse it.
requestIdstring
This request's id, the same as the x-request-id response header. Quote it when you contact support.

503 Unavailable

paymentsNotEnabled or paymentsUnavailable.

errorenumrequired
A stable code for the error. Switch on this value: it doesn't change between releases.
One ofstepUpRequiredcoolingOffauthUnavailableavatarTooLargebelowPrivilegedMinimumtryAgainLaterhandoverFinishedintentionNotRemovableaddressAmbiguousaddressNotFoundgeocodingUnavailableinvalidCoordinateResolutionpublicCatalogueUnavailableaccessRevokedjobNotOpenvendorRateLimitedvendorUnavailablezaptecUnavailableincompleteMappinginstallationClaimedconsentInvalidrequestConflictstaleRevisionaccountHasOpenBalanceaccountNotReadyaccountsCollidealreadyStartedambiguousIdTokenambiguousReservationAddressassetServiceUnavailablelocationCoordinatesRequiredforecastTimeOutsideCoverageweatherServiceUnavailableassistantCardRequiredassistantDisabledassistantLimitReachedinstallerPhotoDayLimitinstallerPhotoConversationLimitassistantNotEnabledassistantRouteNotAllowedassistantUnavailableadditionsNotAllowedauthenticationRequiredauthorizationUnavailablebadRequestbatchTooLargebillingAccountClosedbillingAccountSuspendedbillingNotConfiguredbillingServiceUnavailablecapacityExceededcardAlreadyHeldcardBlockedcardOwnedByPrincipalcertificateAuthorityServiceUnavailablechargerUnsafeForHoldcircuitChosenTwicecircuitNotFoundcircuitNotOnJobLocationchargerNotRunningchargePointIdTakenchargerSplitAcrossLocationschargingStationNotAcceptedclaimNotEligibleclaimNotFoundcommandNotSupportedcommandTypeRemovedcommandsUnavailableconflictconfirmationInvalidconfirmationLockedconfirmationNotSentconfirmationRequiredconfirmEraseRequiredconsentMissingconversationClosedconversationBusyconnectionNotEligibleconnectorAlreadyOccupiedconnectorNotFoundconnectorNotOccupiedconfirmOverPlanRequiredcsmsManagedSettingdeclineddiagnosticsReceiverServiceUnavailablediagnosticsRequestOutstandingdiagnosticsUnsupportedProtocolVersiondisconnecteddismissedForSessionduplicateduplicateSlugdetachFirsteaseeCircuitUnmappedeaseeSiteClaimedElsewhereeaseeUnreachableeaseeWrongSerialOrPinemailNotVerifiedemptyEventTypesemptyLimitemptyTransactionLimitenergyControllerUnavailableenergyPricingServiceUnavailableeventTypeNotSubscribableexceedsCapabilityfileExpiredfileNotAvailablefirmwareIdentityUnknownfinishAccountSetupforbiddenhandoverNotReadyhandoverBegunhasChildCircuitshasInvertersholdAmountOutOfRangeholdNotAuthorizedidTokenNotAcceptedidTokenNotRecoverableidempotencyKeyConflictidempotencyKeyInFlightidempotencyKeyReplayedidempotencyStoreUnavailableidentityPlatformUnavailableintegrationEaseeServiceUnavailableintegrationUnavailableconnectionsServiceUnavailableinternalErrorinvalidinvalidAddressinvalidAppDestinationinvalidClientinvalidCoordinatesinvalidCountryinvalidCurrentTypeinvalidEvsesinvalidCursorinvalidErrorCodeinvalidIdTokeninvalidLineinvalidModeinvalidMonitorAssignmentinvalidMonitorConnectioninvalidNameinvalidPaginationinvalidRedirectUriinvalidReasoninvalidPhaseCountinverterBindingConflictinvalidRequestinvalidRegistrationliveUpdatesUnavailableinvalidImageimageTooLargeinvalidWindowmethodNotUsablenotAPaidChargernotCapturedoverRefundpaymentRequiredpricingUnavailableprojectsHaveNoDefaultrevisionConflictinvalidScheduleinvalidScopeinvalidSettingValueinvalidLocationTargetinvalidSluginvalidStartingSocinvalidTargetSocinvalidTargetinvalidTargetUrlinvalidTariffinvalidTariffConditioninvalidTariffIdinvalidTimeZoneinvalidUrlinvalidValueinstallerNotHeldinvitationAlreadyAcceptedinvitationExpiredjobsServiceUnavailableopenJobsservesCustomerGrantsnotAnInstallationsProjectnotAnOperationsProjectgrantNotActivelastCircuitOnLocationlastSignInlocationUnderInstallationlocationNotBuiltlocationAlreadyBuiltmetricsStoreErrormetricsStoreUnavailablemessageTooLongmissingIdTokenmissingIdempotencyKeymonitorConflictmonitorNotFoundmqttServiceUnavailablemissingOrMalformedHeaderinvalidTokenjwksUnavailableapiKeyServiceUnavailablenotConnectednotDispatchablenotEntitledassigneeCannotReadJobnotFoundlabelMistypedlabelNotFoundlabelStockLimitlabelHeldElsewherelabelRetiredlabelLinkedElsewhereoutletHasLabelsandboxOutletnotOfferednotReadynotSandboxModenoFirmwareCatalogednoOpenSessionnoSupportedTransferProtocolnoVehiclenothingToOffernotAdminOrOwnerocppUnavailableorganizationNotEmptyorganizationNumberMismatchownerCannotLeaveownsOrganizationspaymentMethodRequiredbinding.driver_policy_requires_access_permissionbinding.holder_outside_home_projectpermission_policy.deny_not_allowedpermission_policy.deny_on_owner_floorpermission_policy.in_usepermission_policy.invalid_documentpermission_policy.limit_exceededpermission_policy.managed_immutablepermission_policy.management_permission_for_non_memberpermission_policy.name_takenpermission_policy.not_grantablepermission_policy.unknown_permissionpermission_policy.would_remove_last_editorpaymentsAccountNotFoundpaymentsAccountSubmittedpaymentsOrganizationSyntheticpaymentsUnavailablepaymentModeUnknowndeviceAttestationRequiredlimitExceededattestationRejectedpaymentsNotEnabledamountOutOfRangecarNotPluggedInchargerNotReadyorganizationNotTestEligiblequoteExpiredquoteUsedphaseTopologyNotConfirmedprincipalErasedprincipalInactiveprincipalNotFoundprojectNotFoundproposalAlreadyDecidedprotocolErrorrateLimitErrorrateLimitedrecentSignInRequiredcardHeldElsewherecardNotReadablecardUidChangescardsNotEnabledcardsUnavailablelearnAlreadyOpenlearnAmbiguouslearnExpiredlearnNotOfferedratedCurrentNotPositivereferenceTakensandboxOrganizationChargerLimitReachedsandboxProjectChargerLimitReachedsandboxStationRefusedselfParentsellerUnavailablestaleCircuitserviceUnavailablesessionEndedsessionServiceUnavailablestationOfflinestationsNotDeprovisionedsigningSecretTooShortsignInClassMismatchsignInInUsesignInUnverifiedsiteClaimedElsewheresiteOwnedByAnotherEaseeOperatorslugChangeNotAcknowledgedslugTakenspotCurrencyMismatchtariffEnergyAndSpottimeZoneRequiredtimedOutscopeNotGrantedscopeTooLargewindowEndedwindowTooLongsessionCapExceededinvalidMonthmonthTooLargemixedCurrenciesmonthNotClosablemonthHasOpenHoldsmonthAlreadyClosedmonthNotClosedoutcomeFinalmonthClosednotCarriabletargetMonthClosedsettlementServiceUnavailabletransactionAlreadyOpentransactionNotOpentrackingUnavailableunauthorizedunavailableunintelligibleResponseunknownBiddingZoneunknownChargerModelunknownEventTypeunknownFallbackStatusunknownSerialunknownVariableunknownVehicleModelunprocessableunrecognisedApiKeyModeunrecognisedSessionModeunsupportedvendorManagedFirmwarevendorUnreachablevirtualChargerLimitReachedvirtualChargerOrganizationLimitReachedvirtualChargerServiceUnavailablevirtualChargerStateUnavailablewebhookServiceUnavailablewrongPinhomeVehiclePreferencesChangedhomeLimithomeHasMembersinvitationNotFoundhomeNotReadyinvalidPriceinvalidPriceAreagridFeeCurrencyUnsupportedpriceAreaRequirednotAvailableForHomepublicLocationlocationStepRequired
messagestringrequired
A description for people. Its wording may change, so don't parse it.
requestIdstring
This request's id, the same as the x-request-id response header. Quote it when you contact support.

Headers

Retry-Afterheader · string

RequestcURL
bashcurl -X POST "$API/me/payments/prepare" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "quoteId": "3f7c2a90-1b4e-4d6f-8a21-9c0e5b7d4f12",
  "route": "string"
}'

Response

201 Created

json

{
  "amountMinor": 1,
  "clientSecret": "string",
  "currency": "SEK",
  "holdId": "3f7c2a90-1b4e-4d6f-8a21-9c0e5b7d4f12",
  "publishableKey": "string",
  "stripeAccountId": "3f7c2a90-1b4e-4d6f-8a21-9c0e5b7d4f12",
  "testMode": true,
  "windowEndsAt": "2026-09-29T08:14:02Z"
}

400 Bad request

json

{
  "error": "badRequest",
  "message": "invalidRequest: the quote or the route is not valid",
  "requestId": "3f7c2a90-1b4e-4d6f-8a21-9c0e5b7d4f12"
}

401 Unauthorized

json

{
  "error": "unauthorized",
  "message": "Your token is missing, has expired or isn't valid",
  "requestId": "3f7c2a90-1b4e-4d6f-8a21-9c0e5b7d4f12"
}

402 Payment required

json

{
  "error": "stepUpRequired",
  "message": "declined: the card was not accepted",
  "requestId": "3f7c2a90-1b4e-4d6f-8a21-9c0e5b7d4f12"
}

403 Forbidden

json

{
  "error": "forbidden",
  "message": "",
  "requestId": "3f7c2a90-1b4e-4d6f-8a21-9c0e5b7d4f12"
}

404 Not found

json

{
  "error": "notFound",
  "message": "No such quote among yours",
  "requestId": "3f7c2a90-1b4e-4d6f-8a21-9c0e5b7d4f12"
}

409 Conflict

json

{
  "error": "conflict",
  "message": "quoteExpired, quoteUsed, accountNotReady, chargerUnsafeForHold or organizationNotTestEligible",
  "requestId": "3f7c2a90-1b4e-4d6f-8a21-9c0e5b7d4f12"
}

429 Too many requests

json

{
  "error": "rateLimited",
  "message": "Too many requests",
  "requestId": "3f7c2a90-1b4e-4d6f-8a21-9c0e5b7d4f12"
}

500 Internal error

json

{
  "error": "internalError",
  "message": "Something went wrong on our side",
  "requestId": "3f7c2a90-1b4e-4d6f-8a21-9c0e5b7d4f12"
}

503 Unavailable

json

{
  "error": "serviceUnavailable",
  "message": "paymentsNotEnabled or paymentsUnavailable",
  "requestId": "3f7c2a90-1b4e-4d6f-8a21-9c0e5b7d4f12"
}