HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference
Terms of Use

Energy coupon / Create

post
https://{tenantUrl}/public-api/resources/energy-coupons/v1.0

Create a single-use energy coupon, optionally assigned to a specific user. When userId is omitted, the coupon is created with "unredeemed" status.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer

The ID of the user to assign the coupon to. When omitted, the coupon is created without a user assignment (status will be "unredeemed").

integer

Operator ID. Required for global admin tokens. Defaults to the token's operator for operator-scoped tokens.

integer
required
1 to 4000000000

Energy amount in watt-hours

string
enum
required

Type of energy coupon to create. Only the following types can be created via the API:

  • support_grant: Created by an operator as a support grant
  • manual_single: Manually created single-use coupon
Allowed:
string
enum
deprecated

EVSE type restriction for the energy coupon:

  • ac: Coupon can only be used at AC charging stations
  • dc: Coupon can only be used at DC charging stations
  • any: Coupon can be used at any charging station type
Allowed:
date

Uses the YYYY-MM-DD date format.

date

Uses the YYYY-MM-DD date format.

string
length ≤ 255

An optional external identifier for integration purposes

restrictions
object

Restrictions that limit where and by whom coupons can be used. All sub-restrictions are always returned.

Responses

Updated 3 months ago

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

Updated 3 months ago