Skip to content

Update Peppol delivery preferences

PATCH /api/v2/me/preferences/peppol

Opts the account out of Peppol e-invoices or back in. It also turns automatic credit notes off or on. Send optedOut, creditNotesOptedOut or both. optedOut: true stops new invoices from going out as Peppol e-invoices. creditNotesOptedOut: true stops credit notes for refunded or cancelled invoices from being sent automatically. This only saves your choice. Whether the account can use Peppol at all is shown by GET /api/v2/me/preferences/peppol. billing.peppol on PATCH /api/v2/me/preferences changes the same settings. The response holds the saved state of both settings.

Authentication: An API key with the scope write:account. About keys and scopes

Request

Body

optedOutboolean
true stops new invoices from going out as Peppol e-invoices. false allows it again.
creditNotesOptedOutboolean
true stops credit notes from being sent automatically. Default false.

Example

PATCH /api/v2/me/preferences/peppol
curl -X PATCH "https://cloud.hostup.se/api/v2/me/preferences/peppol" \
-H "Authorization: Bearer $HOSTUP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"optedOut": true
}'

Responses

200 The saved Peppol choices after the change.

Response 200
{
"optedOut": true,
"creditNotesOptedOut": false,
"updatedAt": "2026-08-19T12:00:00.000Z"
}
Response fields
optedOutboolean
creditNotesOptedOutboolean
True when automatic credit notes are turned off for the account.
updatedAtstring

Errors

Errors are Problem Details with a stable code. Branch on the code, not on the text.

400invalid_request: the body has neither optedOut nor creditNotesOptedOut. Or one of them is not a boolean.
401Unauthorized. Authentication is required.
403Forbidden. The caller lacks a required scope or does not own the resource.
404Not found. The resource does not exist or is not owned by the caller.
429Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
500Internal error. Retry later or contact support if the issue persists.