Payment Services

POST /user/{userId}/subscription

Requires authentication with server access token.

Create user subscription.

See also

Help us improve

Did you spot an error? Or maybe you just have a suggestion for how we can improve? Leave us a comment.

Request

POST /api/2/user/{userId}/subscription

userId

required path parameter

Create subscription for the user with this uuid or userId (not to be mistaken with the deprecated id).

productId

required

The product to subscribe the user to

startDate

optional

The date from when the subscription is valid

orderId

optional

OrderId of the order used to create the subscription.

expires

optional

The date/time (YYYY-MM-DD HH:MM:SS), or the number of seconds from now when the subscription expires

Example request

cURL
Minimal example
curl https://login.schibsted.com/api/2/user/42/subscription \
   -X POST \
   -d "oauth_token=[access token]" \
   -d "productId=1337"
With all parameters
curl https://login.schibsted.com/api/2/user/42/subscription \
   -X POST \
   -d "oauth_token=[access token]" \
   -d "productId=1337" \
   -d "startDate=2016-06-01" \
   -d "orderId=42" \
   -d "expires=2016-06-01"
Java
Minimal example
Map<String, String> params = new HashMap<>() {{
    put("productId", "1337");
}};

SpidOAuthToken token = spidClient.getServerToken();
String responseJSON = spidClient.
    POST(token, "/user/42/subscription", params).
    getResponseBody();
With all parameters
Map<String, String> params = new HashMap<>() {{
    put("productId", "1337");,
    put("startDate", "2016-06-01");,
    put("orderId", "42");,
    put("expires", "2016-06-01");
}};

SpidOAuthToken token = spidClient.getServerToken();
String responseJSON = spidClient.
    POST(token, "/user/42/subscription", params).
    getResponseBody();

This example is an excerpt, see a full example

PHP
Minimal example
<?php
$params = array(
    "productId" => "1337"
);

$client->auth();
echo var_dump($client->api("/user/42/subscription", "POST", $params));
With all parameters
<?php
$params = array(
    "productId" => "1337",
    "startDate" => "2016-06-01",
    "orderId" => "42",
    "expires" => "2016-06-01"
);

$client->auth();
echo var_dump($client->api("/user/42/subscription", "POST", $params));

This example is an excerpt, see a full example

Clojure
Minimal example
(ns example
  (:require [spid-client-clojure.core :as spid]))

(let [client (spid/create-client "[client-id]" "[secret]")
      token (spid/create-server-token client)]
  (spid/POST client token "/user/42/subscription" {"productId" "1337"}))
With all parameters
(ns example
  (:require [spid-client-clojure.core :as spid]))

(let [client (spid/create-client "[client-id]" "[secret]")
      token (spid/create-server-token client)]
  (spid/POST client token "/user/42/subscription" {"productId" "1337"
                                                   "startDate" "2016-06-01"
                                                   "orderId" "42"
                                                   "expires" "2016-06-01"}))

Response

This endpoint supports the JSON and JSON-P response formats.

Success: 200 OK

Returns the newly created subscription object

Subscription

subscriptionId ✓

string

Unique ID of the subscription

originalSubscriptionId ✓

string

Unique ID of the original subscription, if empty this is the first time user bought subscription for product

clientId ✓

string

Your client ID

userId ✓

string

User id who bought the subscription

productId ✓

string

Unique product ID

parentProductId

string

ID of the parent product, if any

identifierId ✓

string

ID of the payment identifier that will be used to renew the subscription

paymentType ✓

Payment type

0 for SPiD Platform, 1 for Payment Platform

orderId ✓

string

ID of the original order

startDate ✓

datetime

From when the subscription is/was active

originalPurchaseDate ✓

datetime

When the subscription was originally purchased

expires ✓

datetime

When the subscription expires

autoRenew ✓

string, "1" (true) or "0" (false)

If "1", the subscription will automatically renew on the expires date.

renewPrice ✓

price

The price of renewal, in cents

currency ✓

string

The renewal price currency

renewPeriod ✓

timestamp, in seconds

Renewal period

autoRenewLockPeriod ✓

timestamp, in seconds

Length of the initial period after activation during which it is not allowed to change the auto renew setting for the subscription.

stopRenewalAfterLock ✓

string, "1" (true) or "0" (false)

When "1", the subscription's auto renew will be stoped after the lock period is over.

autoRenewDisabled ✓

string, "1" (true) or "0" (false)

When "1", the subscription's auto renew cannot be changed.

gracePeriod

timestamp, in seconds

The length of the period the subscription stays active after charging for a renewal fails.

emailReceiptCount ✓

integer (as string)

The number of receipts sent via email to the user

finalEndDate

datetime

If provided, this date denotes the time when the subscription will no longer be available for sale.

chargeRetryCount ✓

integer (as string)

The number of times the previous charge has been retried

chargeLastRetry

datetime

Time of the last charge retry

status ✓

Subscription status

The subscription's current status

statusChangeCode

Subscription status change code

A description of the last change to the subscription's status

statusChangeDate

datetime

The date of the last change to the subscription's status

updated ✓

datetime

Date and time of last update to the subscription

created ✓

datetime

Date and time when the subscription was created

product ✓

Product

The product this subscription belongs to

The check mark ✓ indicates that the field always contains a valid non-empty value.

Subscription status

An enum, with the following possible values:

"-1"

Expired

"0"

Inactive

"1"

Active

Subscription status change code

An enum, with the following possible values:

"100"

Subscription expired via multiple failed payment method charge attempts

"110"

Subscription expired via API

"120"

Subscription expired passively (auto_renew is off)

"130"

Subscription expired by force

"140"

Subscription expired because it is no longer for sale

"150"

Subscription expired because it was renewed (i.e., a new subscription has been created)

"160"

Subscription expired because the user deleted their account

"170"

Subscription was paused

"180"

Expiry date was changed

"190"

Subscription expired because the user disabled auto renewal

Failure cases

Some HTTP response codes are used for multiple error situations. There is no consistent way to tell these apart, but the error object will contain a textual explanation of the reason for the error. For explanation on OAuth related failures and errors see OAuth authentication failures.

  • 401 Unauthorized You don't have administration rights for this client.
  • 401 Unauthorized Your client doesn't have administration rights for this client.
  • 403 Forbidden Client is not authorized to access this API endpoint. Contact SPiD to request access.
  • 403 Forbidden Requesting IP is not whitelisted
  • 403 Forbidden Access token rejected
  • 404 Not Found Unknown client ID
  • 404 Not Found Client ID mismatch. The client making the request is no the owner of this resource, and does not have administrative privileges for it.
  • 420 Request Ratelimit exceeded

Sample response

JSON
{
  "subscriptionId": "1551",
  "status": "1",
  "originalPurchaseDate": "2014-08-05 15:27:43",
  "renewPeriod": "2592000",
  "clientId": "[Your client ID]",
  "userId": "020301",
  "currency": "NOK",
  "statusChangeDate": null,
  "chargeLastRetry": null,
  "parentProductId": "301696",
  "autoRenewLockPeriod": "0",
  "expires": "2014-09-04 15:27:43",
  "orderId": null,
  "renewPrice": null,
  "autoRenewChangeDate": null,
  "startDate": "2014-08-05 15:27:43",
  "autoRenewChangeBy": null,
  "productId": "301696",
  "created": "2014-08-05 15:27:43",
  "updated": "2014-08-05 15:27:43",
  "autoRenewDisabled": "0",
  "autoRenew": "0",
  "finalEndDate": null,
  "originalSubscriptionId": null,
  "statusChangeCode": null,
  "chargeRetryCount": "0",
  "emailReceiptCount": "0",
  "identifierId": null,
  "gracePeriod": "0"
}
JSON-P
callback({
  "subscriptionId": "1551",
  "status": "1",
  "originalPurchaseDate": "2014-08-05 15:27:43",
  "renewPeriod": "2592000",
  "clientId": "[Your client ID]",
  "userId": "020301",
  "currency": "NOK",
  "statusChangeDate": null,
  "chargeLastRetry": null,
  "parentProductId": "301696",
  "autoRenewLockPeriod": "0",
  "expires": "2014-09-04 15:27:43",
  "orderId": null,
  "renewPrice": null,
  "autoRenewChangeDate": null,
  "startDate": "2014-08-05 15:27:43",
  "autoRenewChangeBy": null,
  "productId": "301696",
  "created": "2014-08-05 15:27:43",
  "updated": "2014-08-05 15:27:43",
  "autoRenewDisabled": "0",
  "autoRenew": "0",
  "finalEndDate": null,
  "originalSubscriptionId": null,
  "statusChangeCode": null,
  "chargeRetryCount": "0",
  "emailReceiptCount": "0",
  "identifierId": null,
  "gracePeriod": "0"
});

Comments/feedback

Do you have questions, or just want to contribute some newly gained insight? Want to share an example? Please leave a comment. SPiD reads and responds to every question. Additionally, your experience can help others using SPiD, and it can help us continuously improve our documentation.