Package mappings

/subscription_system/package_mappings

Target audience: Developers

Release version: 3.9.1

Get package mappings¶

Introduction¶

Gives external applications information on how packages are mapped between the external subscription system and Payway. If the external package id is not set for the package in Payway it is not considered mapped and not returned in the result. In the Payway domain the external_package_id is also referred to as integration code. The consumer is encouraged to cache the result.

URI¶

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

Requirements¶

Identity	Scope
No	`/external/subscription_system/r`

Curl Example¶

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

Response¶

Example response¶

HTTP 200
{
    "items": [
        {
            "payway_package_code": "one",
            "external_package_id": "external_one"
        },
        {
            "payway_package_code": "two",
            "external_package_id": "external_two"
        }
    ]
}

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
invalid_content_type_error	Object	The requests Content-Type header isn't set to application/json.

HTTP 500 Internal Server Error¶

Name	Type	Description
internal_server_error	Object	Something unexpected happened server side