v1

latestOpenAPI 3.1.02026-07-241080412.6 KB

Pause subscription

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

Path parameters

subscriptionIdinteger required

Subscription identifier in Cleeng.

Request body

pauseDatestring 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

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

offerIdstring

paymentCountrystring

ipAddressstring

inTrialboolean

couponCodestring

pendingSwitchIdstring

externalPropertiesobject

paymentMethodIdinteger

isExternallyManagedboolean

latestPaymentExternalIdstring

sourcestring

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

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