Get your agreement

The agreement revision that applies to companies you create now.

Use this endpoint to see the agreement revision currently applied to companies you create. For a company you already created, read agreement in Get onboarding status.

📘

Part of Agreement consent. For how agreements work, see Agreeing to terms.

FieldMeaning
idThe revision's ID. Send it as agreementId when you report a consent.
revisionYour own count of revisions: 1, 2, 3...
modeDIRECT when the customer signs the Subscription Agreement in the signing experience, UMBRELLA when they agree under your own agreement.
reference, legalVersionFor UMBRELLA: your agreement and its version, as Everee holds them.
effectiveFromWhen this revision took effect (UTC).

Pricing and other terms are not part of the response. Everee manages them.

Errors

StatusMeaning
401The API key is missing, malformed or expired.
404Your partner account has no agreement in effect. You can't create companies until Everee sets one up.
Responses

401

The API key is missing, malformed or expired.

404

Your partner account has no agreement in effect.

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json