MediaConnect AS
Powered by Redocly

Subscription

List shared subscriptions

The user needs to be logged in to use this endpoint, click here to read more.

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

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

SecurityAuthorization_Code
Responses
200

OK

Response Schema: application/json
Array of objects
400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/subscription/shared
Request samples 
Response samples 
application/json
{
  • "sharedSubscriptions": [
    ]
}
List subscriptions
The user needs to be logged in to use this endpoint, 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.


SecurityAuthorization_Code 
Request 
query Parameters
subscriptionSourceFetchMode
string
 Default:  "ORDINARY"
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.
    • 



 
Responses 
200
OK


Response Schema: application/json
Array of objects
 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


get/v1/subscription
Request samples 
Response samples 
application/json
{
  • "subscriptions": [
    ]
}
Start subscription
The user needs to be logged in to use this endpoint, click here to read more.


Start a recurring product using the provided parameters.


SecurityAuthorization_Code 
Request 
Request Body schema: application/json
companyCode
string  <= 12 characters 
Company code for the product


 
product
required
string  <= 12 characters 
product code for the product


 
startTime
required
integer
The time the subscription should start.


Unix Epoch timestamps in milliseconds since 1st January
1970 UTC


 
endTime
integer
The time the subscription should end.


Unix Epoch timestamps in milliseconds since 1st January 1970 UTC


 
copies
required
integer
Number of copies (often 1)


 
couponCode
required
string  <= 12 characters 
Coupon code used to start the subscription


 
couponNumber
required
integer
Coupon number used to start the subscription.


 
customerReference
string  <= 37 characters 
Coustomer reference


 
Responses 
200
OK


Response Schema: application/json
status
string
Status inicating result of the operation.


 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


post/v1/subscription
Request samples 
application/json
{
  • "companyCode": "468979834",
  • "product": "CO27409",
  • "startTime": 1560336440000,
  • "endTime": 1591958840000,
  • "copies": "1",
  • "couponCode": "WMDigi",
  • "couponNumber": 5223,
  • "customerReference": "cvxgds"
}
Response samples 
application/json
{
  • "status": "OK"
}
List subscriptions - client mode
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.


SecurityClient_Credentials 
Request 
path Parameters
customerNumber
required
integer
Customer number


 
query Parameters
subscriptionSourceFetchMode
string
 Default:  "ORDINARY"
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.
    • 



 
Responses 
200
OK


Response Schema: application/json
Array of objects
 
400
Bad Request


404
Not Found


429
Too Many Requests


500
Internal Server Error


get/v1/client/subscription/{customerNumber}
Request samples 
Response samples 
application/json
{
  • "subscriptions": [
    ]
}
➔ Next to Recruitment