Cancel a subscription

POST

https://test-api.star-saas.com/v1/cancelsubscription

Cancels a customer's subscription immediately. The customer won't be charged again for the subscription.
The contract that you've created are still charged at the end of the period, unless manually canceled.

The canceled Subscription object. Its subscription status will be set to Inactived.

Request

Body Params application/json

Example

{
	"merchant_id": "1018001",
	"account_id": "1018001003",
    "recurring_id": "Recurring_123456778",
    "contract_name": "Recurring Order",
	"encryption_data": "dd7272885fd236dfb8962292b70cfa89e4f17cd509dc822d87de60bdc4e385f7"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://test-api.star-saas.com/v1/cancelsubscription' \
--header 'Content-Type: application/json' \
--data-raw '{
	"merchant_id": "1018001",
	"account_id": "1018001003",
    "recurring_id": "Recurring_123456778",
    "contract_name": "Recurring Order",
	"encryption_data": "dd7272885fd236dfb8962292b70cfa89e4f17cd509dc822d87de60bdc4e385f7"
}'

Responses

🟢200Success

application/json

Body

Example

{
    "merchant_id": "1018001",
    "account_id": "1018001003",
    "recurring_id": "Recurring_123456778",
    "contract_name": "Recurring Order",
    "cancel_status": "1",
    "error_message": "",
    "encryption_data": "dd7272885fd236dfb8962292b70cfa89e4f17cd509dc822d87de60bdc4e385f7"
}

Cancel a transaction

Refund a transaction