Skip next order

Changed on

This endpoint allows you to skip the next upcoming order for a subscription while keeping future orders unchanged.

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

Request

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

Path parameters

subscriptionIdinteger required

The unique identifier for a 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": "Upcoming order skipped successfully",
  "data": {
    "id": 801000,
    "shopifyId": 3760324761,
    "status": "ACTIVE",
    "nextBillingDateEpoch": 1704670259,
    "totalLineItemDiscountedPrice": 90,
    "currencyCode": "USD"
  },
  "code": "SUCCESS"
}

Changes

    • breaking

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

    • info

      api operation id skip-next-order removed and replaced with skip-order

    • info

      added optional request body

    • info

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

    • 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