List subscriptions - client mode

Production

https://api.mediaconnect.no/capi

GET

/v1/client/subscription/{customerNumber}

Subscription

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

This API will return a list of all products the user subscribes to with their status.

This list may be empty in cases where the user has no subcriptions in the system.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.mediaconnect.no/capi/v1/client/subscription/?subscriptionSourceFetchMode'

Response Example

200 - Success

{
    "subscriptions": [
        {
            "product": "CO27409",
            "stopped": false,
            "startTime": 1706009061640,
            "endTime": 1706009761640,
            "paid": true,
            "priceDetails": {
                "couponCode": "WMDigi",
                "couponNumber": 5223,
                "discountfromfullsm": 0,
                "promotion": "NC",
                "categoryType": ""
            },
            "shareable": true,
            "shareType": "Nets"
        }
    ]
}

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://connectid.no/user/oauth/token

Refresh URL: https://connectid.no/user/oauth/token

Scopes:

read-For all access

Path Params

customerNumber

integer

required

Customer number

Query Params

subscriptionSourceFetchMode

string

optional

Subscription source fetch mode allows you to specify which subscriptions to incude in the result:

ORDINARY: just ordinary subscriptions without B2B source(received)

B2B: just B2B source(received) without ordinary subscriptions

ALL: both ORDINARY and B2B.

Default:

ORDINARY

Responses

🟢200OK

application/json

Body

subscriptions

array [object {11}]

optional

product

string

optional

The product id- A unique id for the product.

<= 12 characters

stopped

boolean

optional

Informs if the subscription is stopped.

true: The subscription is stopped.

false: The subscription is not stopped.

startTime

integer

optional

Start of the current subscription period.

startTime is 00:00:00 on the subscription start date. If the user continues to pay for the subscription then startTime does not change. If the user stops paying for the subscription and later starts a new subscription on the same product (and some time has passed during which the user did not pay) then startTime will be 00:00:00 on the new start date.

Unix Epoch timestamps in milliseconds since 1st January 1970 UTC

endTime

integer

optional

End of the current subscription period.

endTime is 23:59:59 on the last date that the user has paid for or 23:59:59 on the publication date of the last issue that the user has received if that is a later date (relevant for free subscriptions).

End of the current subscription period.

Unix Epoch timestamps in milliseconds since 1st January 1970 UTC

paid

boolean

optional

Informs if the subscription period is paid.

true: The subscription period is paid.

false: The subscription period is unpaid.

priceDetails

object

optional

shareable

boolean

optional

Informs if the subscription can be shared.

true: The subscription can be shared

false: The subscription cannot be shared.

shareType

string

optional

Specifies share type when subscription can be shared.

USERS: Shareable with users

NETS: Shareable nets (per domain, IP range)

B2B: B2B shareable

salesPerson

string

optional

The sales person identifier on this subscription.

<= 12 characters

distributionLevel

string

optional

Distribution level. Mainly important for B2B source(received) subscription. Based on this value you can resolve whether it is paper distribution or not.

<= 1 characters

productDeliveryPlanId

integer

optional

The unique id for productdeliveryplan

🟠400Bad Request

🟠404Record Not Found

🟠429429

🔴500Server Error

Start subscription