Profile API

❗️Profile API was discontinued

Please update your code to remove any validation depending on the Profile API, as this API was discontinued on November 30th 2023.

Find more information related to the profile API. Note: the more accurate name for Profile API would be Package API, but due to internal history, the name Profile API is used instead.

Getting information about your package

Using this API you can get information about the client's current package.

Here's an example request:

		cURL

curl -X GET \
  https://api.olxgroup.com/profile/v1/packages \
  -H 'Accept: application/json' \
  -H "User-Agent: crm_name"
  -H 'Authorization: Bearer ' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: your-api-key'

Copied to clipboard

And this is the kind of response you'll get:

		JSON

{
    "transaction_id": "8702e7f5-184d-4b78-8b75-43fbed9c13a1",
    "message": "Profile found",
    "data": [
        {
            "type": "postpaid",
            "name": "za okres 2019-10-15 - 2019-11-13 (wystawień: 16) - przedział 1-20",
            "available": 4,
            "total": 20,
            "invoice_at": "2019-11-12T23:00:00.000+0000",
            "purchased_at": null,
            "starts_at": "2019-10-14T22:00:00.000+0000",
            "expires_at": null,
            "expired_at": null,
            "in_grace_period": false,
            "price": "306,27 zł"
        }
    ]
}

Copied to clipboard

Another example:

		JSON

{
    "transaction_id": "a5d89ffe-7d12-44ac-a9bb-63b42cc32e95",
    "message": "Profile found",
    "data": [
        {
            "type": "prepaid",
            "name": "Pacote L",
            "available": 9997,
            "total": 10000,
            "invoice_at": null,
            "purchased_at": "2020-03-05T11:43:05.000+0000",
            "starts_at": "2020-03-05T11:43:05.000+0000",
            "expires_at": "2020-04-05T10:43:05.000+0000",
            "expired_at": null,
            "in_grace_period": false,
            "price": "490.77€"
        }
    ]
}

Copied to clipboard

In resume, you will get the following details about the package:

Field	Description
type	Package Type Can be postpaid or prepaid
name	Package Name
available	Number of available insertions for the package/bundle (to consume during the billing cycle)
total	Total number of insertions for the package/bundle (total number of insertions to consume during the billing cycle)
invoice_at	Invoice expiration date/time
purchased_at	Invoice purchase at date/time
starts_at	Billing cycle starts at date/time
expires_at	Billing cycle expires at date/time
expired_at	Billing cycle already expired at date/time
in_grace_period	Grace Period, after a package expiration Can be true or false
price	Bundle/Package price (Paid VAS are not included in)

Each site has its own package and respective prices. If you want to know better about their package, consult the following links: