v1

latestOpenAPI 3.1.02026-07-241080412.6 KB

Get a subscription

Use this endpoint to get subscription details based on subscription ID.

get/subscriptions/{subscriptionId}

Path parameters

subscriptionIdstring required

Subscription identifier at Cleeng.

Response

200

subscriptionIdinteger

paymentDetailsIdinteger

publisherIdinteger

customerIdinteger

statusstring

dateFrominteger

dateTointeger

nextPaymentActionstring

nextPaymentActionDateinteger

subscriptionExternalIdstring

offerIdstring

paymentCountrystring

{"stackTrail":"paths:/subscriptions/{subscriptionId}:get:responses:200:content:application/json:schema:properties:ipAddress","oasType":"schema","type":"unknown"}

inTrialboolean

{"stackTrail":"paths:/subscriptions/{subscriptionId}:get:responses:200:content:application/json:schema:properties:couponCode","oasType":"schema","type":"unknown"}

pendingSwitchIdstring

{"stackTrail":"paths:/subscriptions/{subscriptionId}:get:responses:200:content:application/json:schema:properties:inProgressSwitchId","oasType":"schema","type":"unknown"}

paymentMethodIdinteger

isExternallyManagedboolean

sourcestring

{"stackTrail":"paths:/subscriptions/{subscriptionId}:get:responses:200:content:application/json:schema:properties:terminationType","oasType":"schema","type":"unknown"}

Example response

{
  "subscriptionId": 123456789,
  "paymentDetailsId": 123123123,
  "publisherId": 987654321,
  "customerId": 123456789,
  "status": "active",
  "dateFrom": 1688557910,
  "dateTo": 1691143200,
  "nextPaymentAction": "authorise",
  "nextPaymentActionDate": 1690884000,
  "subscriptionExternalId": "FGJYH2WF4GH3JT",
  "offerId": "S123456789_US",
  "paymentCountry": "US",
  "inTrial": true,
  "pendingSwitchId": "1ab12a12-1212-1212-a1ab-1a121a12aba1",
  "externalProperties": {
    "name1": "value1",
    "name2": "value2"
  },
  "paymentMethodId": 987654321,
  "isExternallyManaged": true,
  "replacedBy": {
    "subscriptionId": 321321321,
    "reason": "string"
  },
  "originatedFrom": {
    "subscriptionId": 123123123,
    "reason": "string"
  },
  "source": "samsung",
  "renewalCycle": {
    "unit": "month",
    "amount": 3
  }
}