Resume Subscription

Once a member's subscription has been paused, use this API to bring it back online, whether the member asks to resume early, a support agent does it on their behalf, or an automated process triggers it. This API resumes a customer's paused subscription to one or more supplementary partner programs, reactivating benefits under that program immediately. Use the Pause Subscription API to pause a subscription first.

An organization can resume up to 50 customers in a single request.

Example request

curl -X POST "https://eu.api.capillarytech.com/v2/partnerProgram/resumeSubscription" \
  -H "Authorization: Basic <base64-encoded-credentials>" \
  -H "Content-Type: application/json" \
  -d '{
    "resumeCustomers": [
      {
        "customer": {
          "id": 382741349
        },
        "resumePartnerPrograms": [
          {
            "partnerProgramName": "jotest08",
            "resumeType": "MEMBER"
          }
        ]
      }
    ]
  }'

Prerequisites

• Authentication: Basic or OAuth credentials
• Access group resource: Write access to the Partner Program resource. For more information, see the access group documentation.

Body parameters

API Quick Reference

resumeCustomers[] (array, required)
  customer (object, required)
    id (integer, conditional)
    mobile (string, conditional)
    email (string, conditional)
    externalId (string, conditional)
  resumePartnerPrograms[] (array, required)
    partnerProgramName (string, required)
    resumeType (enum, required)

Example response

{
  "resumeCustomers": [
    {
      "customer": {
        "id": 382741349,
        "mobile": "919876543210",
        "email": "[email protected]",
        "externalId": "X916215000000",
        "status": {
          "status": true,
          "message": "Customer successfully retrieved",
          "code": 1000
        }
      },
      "resumePartnerPrograms": [
        {
          "partnerProgramName": "jotest08",
          "resumeType": "MEMBER",
          "partnerResumeStatus": {
            "status": true,
            "message": "Success",
            "code": 200
          }
        }
      ]
    }
  ],
  "warnings": []
}

Response parameters

Error and warning codes

📘

ERR_SUBSCRIPTION_CURRENTLY_PAUSED (2037) is not returned by this API. Other partner-program APIs return it when a member's subscription is currently paused. Call this Resume Subscription API first to clear the pause.