LOloopwork

Pause subscription

Changed on

This endpoint allows you to pause an active subscription, halting future billing and deliveries until it is resumed.

post/2023-10/subscription/{subscriptionId}/pause

Request

  • Base URL
    https://api.loopsubscriptions.com/storefront
  • URL
    https://api.loopsubscriptions.com/storefront/2023-10/subscription/{subscriptionId}/pause
  • Auth
    API key in header Authorization

Path parameters

subscriptionIdinteger required

The unique identifier of the subscription in Loop.

Request body

cancellationFlowIdinteger

This parameter is used to log the cancellation reason performance.

Response

200

successboolean
messagestring
codestring
pageInfounknown

Example response

{
  "success": true,
  "message": "Subscription paused successfully",
  "data": {
    "id": 801000,
    "shopifyId": 3760324761,
    "status": "PAUSED",
    "totalLineItemDiscountedPrice": 90,
    "currencyCode": "USD"
  },
  "code": "SUCCESS"
}

Changes

  • 1ff6a5700816Revision changes
    • breaking

      removed the enum value CUSTOM of the request property /

    • breaking

      removed the enum value DAY of the request property /

    • breaking

      removed the enum value MONTH of the request property /

    • breaking

      removed the enum value YEAR of the request property /

    • breaking

      the response's property type changed from no type to object for status

    • warning

      removed the request property /

    • info

      added the new optional request property

    • info

      for the path request parameter subscriptionId, the format was generalized from int32 to int64

    • info

      added the new "CUSTOM" enum value to the request property /

    • info

      added the new "DAY" enum value to the request property /

    • info

      added the new "MONTH" enum value to the request property /

    • info

      added the new "WEEK" enum value to the request property /

    • info

      added the new "YEAR" enum value to the request property /

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status