CLcleeng

Resume subscription [Beta]

Changed on

Use this endpoint to resume a subscription from a scheduled pause or to immediately resume from the pause that is ongoing. With immediate resume from the pause which is in progress, a payment attempt is made and the customer is charged.

post/subscriptions/{subscriptionId}/resume

Request

  • Base URL
    https://mediastoreapi-sandbox.cleeng.com
  • URL
    https://mediastoreapi-sandbox.cleeng.com/subscriptions/{subscriptionId}/resume
  • Auth
    API key in header Authorization

Path parameters

subscriptionIdinteger required

Subscription identifier in Cleeng.

Response

200

subscriptionIdinteger
paymentDetailsIdinteger
publisherIdinteger
customerIdinteger
statusstring
dateFrominteger
dateTointeger
nextPaymentActionstring
nextPaymentActionDateinteger
subscriptionExternalIdunknown
offerIdstring
paymentCountrystring
ipAddressstring
inTrialboolean
couponCodestring
pendingSwitchIdstring
externalPropertiesobject
paymentMethodIdinteger
isExternallyManagedboolean
latestPaymentExternalIdstring
sourcestring
terminationTypeunknown

Example response

{
  "subscriptionId": 1999999999,
  "paymentDetailsId": 999999999,
  "publisherId": 999999999,
  "customerId": 999999999,
  "status": "active",
  "dateFrom": 1,
  "dateTo": 1,
  "nextPaymentAction": "capture",
  "nextPaymentActionDate": 1,
  "offerId": "string",
  "paymentCountry": "string",
  "ipAddress": "string",
  "inTrial": true,
  "couponCode": "string",
  "pendingSwitchId": "1fa12f34-1234-1234-b1fc-1c123f12afa1",
  "isExternallyManaged": true,
  "latestPaymentExternalId": "string",
  "replacedBy": {
    "subscriptionId": 1999999999,
    "reason": "string"
  },
  "originatedFrom": {
    "subscriptionId": 1999999999,
    "reason": "string"
  },
  "renewalCycle": {
    "unit": "day",
    "amount": 1
  },
  "source": "string",
  "pause": {
    "requestedAt": 1,
    "pauseDate": 1,
    "resumeDate": 1,
    "failedResumes": [
      1
    ]
  }
}

Changes