SMsmallcase

Fetch smallcase subscriptions

The API provides details about all the smallcases a user has subscribed to from the partner platform along with payment details. The API provides subscription details like status, publisher, pending amount, start date, end date, plan type, duration etc.

<<apiUseCaseTerm>>: This API is ideal when you want to display the smallcase subscription details to the user.

get/{gatewayname}/engine/subscriptions

Request

  • Base URL
    https://gatewayapi.smallcase.com/v1
  • URL
    https://gatewayapi.smallcase.com/v1/{gatewayname}/engine/subscriptions
  • Auth
    none required

Path parameters

gatewaynamestring required

Headers

x-gateway-secretstring required

Required | apiSecret shared for authentication

x-gateway-authtokenstring required

Required | JWT signed with shared secret & payload for connected user

Response

200

successboolean
errorsunknown

Example response

{
  "success": true,
  "data": {
    "subscriptions": [
      {
        "status": "SUBSCRIBED",
        "publisher": "smartinvesting",
        "publisherName": "SmartInvesting",
        "pricingType": "USER",
        "scids": [
          {
            "scid": "GATEMO_0002",
            "smallcaseName": "Smartinvesting Private"
          }
        ],
        "date": "2021-07-15T10:20:43.376Z",
        "endDate": "2022-07-15T00:00:00.000Z",
        "amount": 12000,
        "planRenewal": "oneTime",
        "planType": "flatFee",
        "duration": "1y"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.