Subscription info

In case you need to get information on a particular subscription you can use our subscription info API. To use subscription info API you will have to send a request to subscriptions-jwt.fortumo.io and include "Bearer" parameter in the request header as instructed here. Subscription info API request is in the following format: https://subscriptions-jwt.fortumo.io/subscriptions/info?merchant=your_merchant_id&subscription_uuid=your_subscription_uuid

Request parameters
Parameter Type Required Description
merchant String Mandatory Your merchant id. e.g: 93d9523134eee0f22716e49093af881a
subscription_uuid String Optional The uuid of the subscription you wish to get information for, e.g. fbc53c9a-0040-4303-9b91-eb3d305be0d7
operation_reference String Optional The operation_reference of the subscription you wish to get information for, e.g. d88d7cb0-f284-4279-b3d5-0b1233fc85a8
1
2
3
4
GET subscriptions/info?merchant=93d9523134eee0f22716e49093af881a&operation_reference=d88d7cb0-f284-4279-b3d5-0b1233fc85a8 HTTP/1.1
Host: subscriptions-jwt.fortumo.io
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9....CgVKRghGWI6-QjMv8JpJi1GarWaQ06CG9d0c1PDFek
Response parameters
Parameter Type Required Description
uuid String Mandatory Uuid of the subscription. e.g. fbc53c9a-0040-4303-9b91-eb3d305be0d7
charging_token String Mandatory Charging token for the subscription. e.g. 8c6799cf-e888-43s7-994e-1c328b8e8a6d:7fb7daba
merchant_uuid String Mandatory Your merchant id. e.g. 93d9523134eee0f22716e49093af881a
operation_reference String Mandatory Operation reference of the subscription e.g. unsubscribe_ref1
duration Integer Mandatory The duration of the subscription e.g. 1
duration_unit String Mandatory The duration unit of the subscription e.g. days
amount Float, 2 decimals Mandatory The price of the subscription e.g. 5.00
currency String Mandatory The currency of the subscription price. e.g. eur
merchant_callback_urls String Mandatory Lists the callbacks URLs you are using for the subscription/payment e.g. https://www.example.com/
subscription_status String Mandatory Current status of the subscription e.g. cancelled
billing_status String Mandatory Billing status of the subscription. e.g. charged
created_at String Mandatory The start date of the subscription event. e.g. 2018-04-23T09:52:43.086Z
modified_at String Mandatory The last date when the subscription event was updated. e.g. 2018-04-23T09:52:43.086Z
service_started_at String Mandatory The start date of the subscription. e.g. 2018-04-23T09:52:43.086Z
service_ends_at String Mandatory The end date of the subscription. e.g. 2018-07-02T09:52:43.086Z
description String Mandatory Item description e.g. Monthly subscription
next_charge_at String Mandatory Next charging date of the subscription. e.g. 2018-07-02T09:52:43.086Z
retry_counter Integer Mandatory How many retry attempts have been made in case of subscription failure e.g. 2018-04-23T09:52:43.086Z
cycle_first_attempted_at String Mandatory The date when first retry attempt was made. e.g. 2018-04-23T09:52:43.086Z
grace_period_duration_unit String Mandatory The unit of how long the retry attempts will be made e.g. hours
grace_period_duration Integer Mandatory The lenght of how many retry attempts will be made e.g. 48
unsubscribe_url String Mandatory Unsubscribe url for this subscription. e.g. https://fortumo.eu/u/wRB1dCwNWWmm
consumer_identity String Mandatory Unique consumer identity for the user. e.g. e1903198-6d03-32be-a3d8-374e3d87dd65
channel_code String Mandatory The channel code of the subscription. e.g. e1903198-6d03-32be-a3d8-374e3d87dd65
country_code String Mandatory The country code of the subscription e.g. 2015-08-18T06:36:40Z (ISO-8601)
error Object Optional Error code and description in case the request is not successful
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

{
  "uuid": "60dafeb2-f0d1-45fa-b5c9-331a7ded27c2",
  "charging_token": "4cb10d76-b386-4047-a710-943dda4bb97c:3e851b50",
  "merchant_uuid": "18f0d56af36d3a3837305ffb290f05c7",
  "operation_reference": "huhhu23rsswefwefsdhhh",
  "duration": 1,
  "duration_unit": "months",
  "amount": 1.00,
  "currency": "eur",
  "merchant_callback_urls": [
    "https://www.example.com/"
  ],
  "subscription_status": "active",
  "billing_status": "enqueued",
  "created_at": "2019-06-05T07:50:05.901Z",
  "modified_at": "2019-07-11T07:49:17.175Z",
  "service_started_at": "2019-06-05T07:50:06.257Z",
  "service_ends_at": "2019-07-12T07:50:06.257Z",
  "merchant_metadata": {
    "merchant_redirect_url": "https://www.example.com/",
    "token": "d285cac5-6cef-484c-8649-7ffc9efb2e85",
    "uuid": "33afcf9d-0973-44a5-a3df-646059298ba0"
  },
  "description": "Test payment",
  "charge_ahead_duration_unit": "minutes",
  "charge_ahead_duration": 1,
  "next_charge_at": "2019-07-12T07:49:06.257Z",
  "retry_counter": 0,
  "retry_schema_name": "submonthly_default",
  "cycle_first_attempted_at": "2019-07-11T07:49:16.948Z",
  "grace_period_duration_unit": "hours",
  "grace_period_duration": 48,
  "unsubscribe_url": "https://dcb.fortumo.com/subscription/?country_code\u003dee\u0026language_code\u003dee\u0026operation_reference\u003dhuhhu23rsswefwefsdhhh\u0026channel_code\u003dsandbox-ee\u0026merchant_uuid\u003d18f0d56af36d3a3837305ffb290f05c7\u0026token\u003dd285cac5-6cef-484c-8649-7ffc9efb2e85",
  "consumer_identity": "2da7beee-9f7c-3286-b2a1-e3810b256377",
  "channel_code": "sandbox-ee",
  "country_code": "EE"
}

Help us improve our Merchants Portal. Was this article helpful?