Create a subscription

post

https://api.7digital.com/1.2/user/unlimitedStreaming

Create a user's subscription.You must notify us of new subscriptions. This is essential in granting streaming access for any given user, and in royalty and usage reporting back to the licensors.Subscriptions last for a maximum of a month, and must be renewed by the client if the user remains subscribed to the service for a longer duration. The OAuth 1.0 signature base string includes the parameters from the request entity-body when the body is single-part and application/x-www-form-urlencoded. Reference: here OAuth User token

Example request

POST https://api.7digital.com/1.2/user/unlimitedStreaming

userId=massivemusic-test-user&planCode=premium-unlimited-streaming&status=active&currency=GBP&recurringFee=10&country=GB&activatedAt=2021-06-08T16:03:06Z&currentPeriodStartDate=2021-06-08T16:03:06Z&expiryDate=2021-06-23T16:03:06Z

When creating subscriptions, it is essential to set the content type to application/x-www-form-urlencoded.

Key	Value
userId	massivemusic-test-user
planCode	premium-unlimited-streaming
status	active
currency	GBP
recurringFee	10
country	GB
activatedAt	2021-09-11T10:54:35Z
currentPeriodStartDate	2021-09-11T10:54:35Z
expiryDate	2021-10-11T10:54:35Z

Example response

{
    "streaming": {
        "level": "premium",
        "expiryDate": "2021-10-11T10:54:35Z"
    }
}

Form Data

userId

string

required

The unique identifier of the user. For information on creating users click here.

planCode

string

required

The current subscription type. Please contact your Client Success Manager for more details on how to supply the correct planCode.

status

string

required

The status of the subscription must be set as active.

currency

string

required

ISO 4217 currency code, relating to the currency in which the subscriber is paying.

recurringFee

int32

required

The amount in cents charged to the subscriber for the current subscription. If a voucher has been used then recurringFee should be 0.

postcode

string

The postcode of the subscriber if applicable.

country

string

required

ISO 2-character country code where the subscriber is located.

activatedAt

string

required

ISO 8601 UTC date-time format. The date and time when the user first activated any type of subscription. ActivatedAt must be now or earlier.

currentPeriodStartDate

string

required

ISO 8601 UTC date-time format. The date and time when the current subscription started.CurrentPeriodStartDate must be no more than 1 day from now, and the same as or later than activatedAt.

trialEndsAt

string

ISO 8601 UTC date-time format. This is the date and time of when a trial period ends. If planCode is equal to trial-unlimited-streaming, then this value must be populated. Otherwise this parameter must not be supplied. TrialEndsAt must be later than currentPeriodStartDate and no more than 100 days from currentPeriodStartDate.

expiryDate

string

required

ISO 8601 UTC date-time format. The date and time when the subscription is due to expire. ExpiryDate must be no more than 1 month from currentPeriodStartDate. If the subscription is a trial, expiryDate must also be the same as or later than trialEndsAt. In the exceptional case that trialEndsAt is more than 1 month from currentPeriodStartDate, expiryDate must be equal to trialEndsAt.