paymentservice_cancel_subscription()

Cancel a subscription to a digital good.

Synopsis:

#include <bps/paymentservice.h>

BPS_API int paymentservice_cancel_subscription(const char *purchase_id,
                                               const char *group_id,
                                               unsigned *request_id)

Since:

BlackBerry 10.0.0

Arguments:

purchase_id: The purchase ID of the digital good to cancel the subscription to.

group_id: The window group ID of the application. This ID is required so that the Payment Service can properly display dialog boxes.

request_id: The Payment Service populates this argument upon successful completion of the request with the request ID. It can be used to correlate the response to the request.

Library:

libbps (For the qcc command, use the -l bps option to link against this library)

Description:

To cancel a subscription to a digital good, you need to provide the purchase ID from the initial purchase, which you can retrieve using the paymentservice_event_get_purchase_id() function. You cannot cancel a subscription using the purchase ID of a subscription renewal.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno value set otherwise.