Skip to content

Get received subscriptions

/accounts/received_subscriptions

Target audience: Developers

Get received subscriptions

Introduction

This endpoint will return all received shared subscriptions for an account. The response contains information on who shared it and what was shared.

URI

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

Requirements

Identity Scope
No /external/account/w

Parameters

Name Required Type Description
id Required String The id of the account to get information about.
Size range: ..24
Allowed values: "/^[a-f\d]{24}$/i"

Curl Example

curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v1/accounts/received_subscriptions  \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'authorization: Bearer <token>' \
  --data '{
    "id": "585a4768edce2c5e6f000001"
    }'

Response

Example response

HTTP 200
{
  "items": [
    {
      "accepted": true,
      "shared_by": {
        "account_id": "5c6291d537c2ed78a11518b7",
        "name": "John Doe",
        "contact_email": "sharer@email.com"
      },
      "received_product": {
        "product_id": "5c6291d537c2ed78a1151349",
        "name": "product_name",
        "description": "short_description",
        "product_code": "package_code"
      }
    }
  ] 
}

Errors

Example error response

HTTP 404 Not Found

Name Type Description
not_found Object The account could not be found

HTTP 500 Internal Server Error

Name Type Description
internal_server_error Object Something unexpected happened server side