MOmollie
Organizations API

Get partner status

Retrieve partnership details about the currently authenticated organization. Only relevant for so-called partner accounts.

🔑 Access with

Advanced access token with organizations.read

OAuth access with organizations.read

get/v2/organizations/me/partner

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/organizations/me/partner
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: organizations.read

Response

The partner status object.

resourcestring required

Indicates the response contains a partner status object. Will always contain the string partner for this endpoint.

partnerTypestring nullable required

Indicates the type of partner. Will be null if the currently authenticated organization is not enrolled as a partner.

Possible values: oauth signuplink useragent

isCommissionPartnerboolean

Whether the current organization is receiving commissions.

partnerContractSignedAtstring nullable

The date the partner contract was signed, in ISO 8601 format. Omitted if no contract has been signed (yet).

partnerContractUpdateAvailableboolean

Whether an update to the partner contract is available and requiring the organization's agreement.

partnerContractExpiresAtstring

The expiration date of the signed partner contract, in ISO 8601 format. Omitted if contract has no expiration date (yet).

Example response

{
  "partnerType": "oauth",
  "isCommissionPartner": true,
  "userAgentTokens": [
    {
      "token": "...",
      "startsAt": "2024-01-01T00:00:00+00:00",
      "endsAt": "2024-12-31T23:59:59+00:00"
    }
  ],
  "partnerContractSignedAt": "2024-01-15T10:00:00+00:00",
  "partnerContractExpiresAt": "2025-01-15T10:00:00+00:00",
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "signuplink": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.