Cancel subscription

post

https://api.loopsubscriptions.com/admin/2023-10/subscription/{subscriptionId}/cancel

This endpoint allows you to cancel an active or paused subscription, stopping all future billing and deliveries permanently or until reactivated by the customer or merchant.

Path Params

subscriptionId

int32

required

The unique identifier of the subscription in Loop.

Body Params

cancellationFlowId

int32

Identifier for the cancellation flow selected by the customer or merchant. This is used to track the cancellation analytics.

comment

string

Optional text field used to capture additional notes or remarks provided by the customer during the cancellation of the subscription.

notifyCustomer

boolean

Defaults to true

Optional parameter that determines whether a cancellation email should be sent to the customer. Defaults to true if not specified.

markForCancellation

boolean

Applicable only for prepaid subscriptions. If set to true, the subscription will be marked for cancellation and will cancel after all orders in the current prepaid cycle are fulfilled. If set to false, the subscription will be cancelled immediately.

Response

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200