CLcleeng

Get a subscription

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

get/subscriptions/{subscriptionId}

Request

  • Base URL
    https://api.sandbox.cleeng.com/3.1
  • URL
    https://api.sandbox.cleeng.com/3.1/subscriptions/{subscriptionId}
  • Auth
    API key in header X-Publisher-Token

Path parameters

subscriptionIdstring required

Subscription identifier at Cleeng.

Response

200

subscriptionIdinteger
paymentDetailsIdinteger
publisherIdinteger
customerIdinteger
statusstring
dateFrominteger
dateTointeger
nextPaymentActionstring
nextPaymentActionDateinteger
subscriptionExternalIdstring
offerIdstring
paymentCountrystring
ipAddressunknown
inTrialboolean
couponCodeunknown
pendingSwitchIdstring
inProgressSwitchIdunknown
paymentMethodIdinteger
isExternallyManagedboolean
sourcestring
terminationTypeunknown

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
  }
}

Changes

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