Skip to content

Get Active products

/me/active_products

Target audience: Developers

Release version: 3.9.1

Get active products

Introduction

This endpoint returns the active product codes for the current account. This includes all products associated with the account, such as:

  • Subscriptions acquired from purchases
  • Third-party provisioned subscriptions
  • Subscriptions shared with the account
  • etc...

If external plus-products are enabled, this endpoint will also return these product codes if any.

URI

Environment URI
Stage https://payway-api.stage.adeprimo.se/external/api/v1/me/active_products
Production https://backend.worldoftulo.com/external/api/v1/me/active_products

Requirements

Identity Scope
Yes /external/me/w

Parameters

Name Type Description
include_articles Boolean Decides whether active Payway Articles (not just subscriptions) should be included in the response.

Curl Example

curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v1/me/active_products \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <access_token_with_identity>'

Response

HTTP 200 OK
{
    "item": {
        "id": "585a4768edce2c5e6f000001",
        "active_products": [
          "aaa_digital",
          "product_web",
          "product_plus"
        ]
    }
}

Example response: Active products with external plus products enabled

HTTP 200 OK
{
    "item": {
        "id": "585a4768edce2c5e6f000001",
        "active_products": [
            "aaa_digital",
            "product_web",
            "product_plus"
        ],
        "external_plus_products": [
            "plus_adeprimo"
        ],
    }
}

Example response: Active products with included articles

HTTP 200 OK
{
    "item": {
        "id": "585a4768edce2c5e6f000001",
        "active_products": [
            "aaa_digital",
            "product_web",
            "product_plus"
        ],
        "active_articles": [
          {
            "article_id": "foobar",
            "article_name": "My Example Article",
            "article_url": "https://adeprimo.se",
            "title_name": "Adeprimo News",
            "title_code": "AN",
            "order_id": "ORGANISATION-1",
            "purchase_date": "2026-01-01 12:00 +0200"
          }
        ],
    }
}

Errors

This API uses the common error conventions of the Payway API

See common error responses