CLcleeng

Pause subscription [Beta]

Changed on

Use this endpoint to pause a subscription. You can only pause active and canceled subscriptions (you cannot pause in-trial or terminated subscriptions). <br><br> Transition from active state to pause is tied to subscription anniversary date (the pause will start with a new billing cycle).

post/subscriptions/{subscriptionId}/pause

Request

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

Path parameters

subscriptionIdinteger required

Subscription identifier in Cleeng.

Request body

pauseDate:string required

Currently only "anniversary-date" available.

resumesAfterBillingCyclesinteger required

The number of cycles after which the subscription resumes after a pause. Resume date is calculated based on this.

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"
  },
  "source": "string",
  "renewalCycle": {
    "unit": "month",
    "amount": 3
  },
  "pause": {
    "requestedAt": 1,
    "pauseDate": 1,
    "resumeDate": 1,
    "failedResumes": [
      1
    ]
  }
}

Changes

  • b4b65aa4f14cRevision changes
    • breaking

      added the new required request property

    • warning

      removed the request property

    • info

      api operation id pause-subscription removed and replaced with ms-pause-subscription