Get active products
/accounts/active_products
Target audience: Developers
Release version: 3.9.1
Get active products¶
Introduction¶
This endpoint returns the active product codes for an 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/accounts/active_products |
| Production | https://backend.worldoftulo.com/external/api/v1/accounts/active_products |
Requirements¶
| Identity | Scope |
|---|---|
| No | /external/account/r |
Parameters¶
| Name | Type | Description |
|---|---|---|
| account_id | String | The id of the account. |
| 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/accounts/active_products?account_id=1234567890 \
--header 'accept: application/json' \
--header 'authorization: Bearer <token>'
Response¶
Example response¶
HTTP 200
{
"item": {
"id": "585a4768edce2c5e6f000001",
"active_products": [
"aaa_digital",
"product_web",
"product_plus"
]
}
}
Example response with external plus¶
HTTP 200
{
"item": {
"id": "585a4768edce2c5e6f000001",
"active_products": [
"aaa_digital",
"product_web",
"product_plus"
],
"external_plus_products": [
"plus_adeprimo"
]
}
}
Example response 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