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

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"
        ],
    }
}

Errors

Example error response

HTTP 400 Bad Request
{
    "code": "invalid_parameter",
    "field": "account_id",
    "message": "Parameter must match format (/^[a-f\d]{24}$/)"
}

HTTP 400 Bad Request

Name Type Description
unknown_parameter Object One or more of the fields in the request was not recognized

HTTP 404 Not Found

Name Type Description
not_found Object Indicates that no account could be found associated with the acces-token in use

HTTP 500 Internal Server Error

Name Type Description
internal_server_error Object Something unexpected happened server side