Set Receipt Email

curl --request POST \
  --url https://app.plugchoice.com/api/v3/public-charging/sessions/{token}/receipt-email \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>"
}
'

{
  "data": {
    "status": "<string>",
    "failure_reason": "<string>",
    "connector_id": 123,
    "connector_status": "<string>",
    "charger": {
      "public_code": "<string>",
      "name": "<string>",
      "online": true
    },
    "pricing": {
      "currency": "<string>",
      "price_per_kwh": 123,
      "start_fee": 123
    },
    "amount_authorized": 123,
    "energy_kwh": "<string>",
    "cost_amount": 123,
    "amount_captured": 123,
    "tax_amount": 123,
    "driver_email": "<string>",
    "created_at": "<string>",
    "authorized_at": "<string>",
    "charging_started_at": "<string>",
    "completed_at": "<string>",
    "captured_at": "<string>"
  }
}

POST

public-charging

sessions

{token}

receipt-email

Set Receipt Email

curl --request POST \
  --url https://app.plugchoice.com/api/v3/public-charging/sessions/{token}/receipt-email \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>"
}
'

{
  "data": {
    "status": "<string>",
    "failure_reason": "<string>",
    "connector_id": 123,
    "connector_status": "<string>",
    "charger": {
      "public_code": "<string>",
      "name": "<string>",
      "online": true
    },
    "pricing": {
      "currency": "<string>",
      "price_per_kwh": 123,
      "start_fee": 123
    },
    "amount_authorized": 123,
    "energy_kwh": "<string>",
    "cost_amount": 123,
    "amount_captured": 123,
    "tax_amount": 123,
    "driver_email": "<string>",
    "created_at": "<string>",
    "authorized_at": "<string>",
    "charging_started_at": "<string>",
    "completed_at": "<string>",
    "captured_at": "<string>"
  }
}

Sets the email address Stripe uses to send the receipt when the session is captured. Set it before capture. This endpoint does not require authentication and is rate limited to 10 requests per minute. The session token is the credential. Returns 404 if the token is unknown or has expired, and 422 if the session has reached a terminal state.

token

string

required

The session token returned when the session was started.

string

required

The driver’s receipt email address. Must be a valid email, maximum 255 characters.

Response

data

object

The updated session details.

Show session

status

string

The session status. One of created, authorized, starting, charging, stopping, settling, captured, no_charge, expired, failed, abandoned, capture_failed, requires_review, refunded, written_off.

failure_reason

string

The reason the session failed or was abandoned, if any. May be null.

connector_id

integer

The OCPP connector ID the session runs on.

connector_status

string

The current OCPP status of the connector. One of Available, Charging, Faulted, Finishing, Preparing, Reserved, SuspendedEV, SuspendedEVSE, Unavailable. May be null.

charger

object

The charger the session runs on.

Show charger

public_code

string

The public code of the charger.

name

string

The charger’s display name, falling back to the site name. May be null.

online

boolean

Whether the charger is currently online.

pricing

object

The pricing applied to this session.

Show pricing

currency

string

The three-letter currency code. May be null.

price_per_kwh

integer

The price per kWh in the currency’s minor units (e.g., cents). May be null.

start_fee

integer

The fixed session start fee in the currency’s minor units.

amount_authorized

integer

The pre-authorized hold amount in the currency’s minor units. May be null.

energy_kwh

string

The energy delivered in kWh, as a decimal string. While charging, this is an estimate from the latest meter value. May be null.

cost_amount

integer

The running cost in the currency’s minor units, capped at the authorized amount. May be null.

amount_captured

integer

The final amount captured in the currency’s minor units. May be null.

tax_amount

integer

The tax portion of the captured amount in the currency’s minor units. May be null.

driver_email

string

The driver’s receipt email. May be null.

created_at

string

ISO 8601 timestamp of when the session was created. May be null.

authorized_at

string

ISO 8601 timestamp of when the payment was authorized. May be null.

charging_started_at

string

ISO 8601 timestamp of when charging started. May be null.

completed_at

string

ISO 8601 timestamp of when charging completed. May be null.

captured_at

string

ISO 8601 timestamp of when the payment was captured. May be null.

Stop Public Charging Session

Cancel Public Charging Session

​Response

Response