HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Partner Contract / Update

Update a Partner Contract. While the contract's status is ended, a request that omits, clears or changes endDate is rejected with 409 and changes nothing; reactivate the contract first. The revenueSharing properties enableSessionFeeExpenses, enableSessionFeeExpensesWithoutTax and handlingFeeBasis keep their current value when omitted.

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

Indicates the business relationship model for the contract. revenueSharing means the operator is the supplier and remits a share to the partner. paymentFacilitation means the partner is the supplier and the operator acts as payment facilitator.

Allowed:
date-time
required

The contract is effective from the first of the selected month.

date-time | null

The last day of the contract, inclusive, ending at midnight in the operator's timezone. Informative only, unless disableChargePointsAtEndDate is true or the contract is disabled or offboarded. If not set, there is no end date. While status is ended, it can't be changed.

boolean
string | null

Used to store custom information, usually used for external references or metadata to the resource.

accessAndPermissions
object
boolean

When true, all charge points of the contract are set to Disabled once the end date has passed. Always false when endDate is not set or autoRenewal is true; a true value sent together with either is stored as false.

boolean

Charge points are billed only if they were Enabled or Out of order. When true, they must also have been online during the period. Defaults to true on create.

integer
required
revenueSharing
object
monthlyPlatformFees
object
reimbursementFees
object

Home-charging reimbursement fees configured on the contract itself and charged to the partner for reimbursed charging sessions and reimbursement periods. Only available when the home-charging reimbursement feature is enabled for the operator. All other home-charging reimbursement settings are managed on the partner resource.

Responses

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