Cancel Subscription

POST/rpy/be-subscription/v1/subscriptions/{subscription_id}/cancel

__Cancel an Existing Subscription__ This endpoint allows you to cancel an existing subscription using its unique identifier. It updates the subscription status to `CANCELED` and optionally logs a reason for audit and tracking purposes. **Usage Scenarios:** _- When a customer explicitly requests to stop their subscription. - As part of automated processes (e.g., failed payments, policy violations). - When a service or product is discontinued._ **Notes:** _- You can optionally provide a_ `status_details` _field to document the reason for cancellation (useful for audit or business insights). - Once canceled, the subscription will not generate further billing events or renewals._

Header Parameters

usernamestring

User who is registering. This information can be used for audit purposes.

Path Parameters

subscription_idstringrequired

Buyer identifier.

Body application/json

seller_idstring<uuid>required

ECommerce identification code

status_detailsstringrequired

Details of the recurrence subscription status.

Response

Request made successfully

seller_idstring<uuid>

order_idstring

installment_start_datestring<date>

create_datestring<date-time>

end_datestring<date-time>

payment_dateinteger<int32>

next_scheduled_datestring<date-time>

subscriptionobject

Show subscription properties

subscription_idstring<uuid>

payment_typeobject

Show payment_type properties

creditobject

Show credit properties

number_installmentsinteger<int32>

billing_addressany

Set of data referring to the buyer's address

soft_descriptorstring

transaction_type"FULL" | "INSTALL_WITH_INTEREST" | "INSTALL_NO_INTEREST"

tokenizationobject

Show tokenization properties

type"UCAF" | "TAVV" | "ELO"

cryptogramstring

ecistring

requestor_idstring

cardobject

Show card properties

binstring

expiration_monthstring

expiration_yearstring

cardholder_namestring

card_idstring

walletobject

Show wallet properties

typestring

idstring

debitobject

Show debit properties

seller_idstring<uuid>

order_idstring

payment_idstring<uuid>

amountinteger<int32>

currencystring

payment_received_timestampstring<date-time>

creditobject

Show credit properties

delayedboolean

authorization_codestring

authorization_timestampstring<date-time>

reason_codestring

reason_messagestring

acquirerstring

soft_descriptorstring

terminal_nsustring

acquirer_transaction_idstring

transaction_idstring

debitobject

Show debit properties

delayedboolean

authorization_codestring

authorization_timestampstring<date-time>

reason_codestring

reason_messagestring

acquirerstring

soft_descriptorstring

terminal_nsustring

acquirer_transaction_idstring

transaction_idstring

errorobject

Show error properties

status_codeinteger<int32>

namestring

messagestring

detailsobject[]

Show details properties

acquirer_transaction_idstring

descriptionstring

description_detailstring

error_codestring

payment_idstring

statusstring

terminal_nsustring

shippingsobject[]

Show shippings properties

first_namestring

last_namestring

emailstring

phone_numberstring

shipping_amountinteger<int32>

addressany

Set of data referring to the buyer's address

customerobject

Show customer properties

customer_idstring

first_namestring

last_namestring

document_type_namestring

document_numberstring

document_countrystring

phone_numberstring

celphone_numberstring

emailstring

status"active" | "inactive"

planobject

Show plan properties

seller_idstring<uuidv4>

E-commerce identification code.

plan_idstring<uuidv4>

Plan identifier.

namestring

Plan name.

descriptionstring

Description of the plan.

amountinteger

Plan value.

currencystring

Currency identification (See code in <a href="https://docs.globalgetnet.com/es/articles/currency-codes">this</a> section).

payment_types"credit_card" | "debit_card"

Types of payments accepted.

sales_taxinteger

Tax value.

Identifier of the type of product sold among the options.

create_datestring<YYYY-MM-DDTHH:MM:SSZ>

Plan creation date.

status"active" | "inactive"

Plan status.

periodobject

Plan period.

Show period properties

Type of periodicity.

billing_cycleinteger

Plan duration based on frequency type. For example, for a 12-month plan, where billing will be done monthly (type = monthly) the value to be assigned is 12.

specific_cycle_in_daysnumber

Specific billing cycle in days. When the type of periodicity is specific (type = specific) the number of days must be assigned in which the billing cycle will be carried out. For example, if the durationthe one in the plan is 12 (billing_cycle = 12) and the specific cycle is 10 (specific_cycle_in_days = 10), This means that the charge will occur every 10 days in total of 12 charges.

floating_dataobject[]

Preconfigured list of installments that will have a different value when the Subscription is created. This functionality can be used to create tasting installments with zero value, one input value or discounted installments. The use of this functionality and its purpose expected will depend on the enablement of a specific product at Getnet.

Show floating_data properties

installmentinteger<int32>

Number of the installment to which the change will be applied.

amountinteger

New charge amount for a given portion of the plan. When a Subscription is created with this Plan it will have this characterstatic, for example for installment 2 apply the amount of R$ 10.00. That value can be zero, greater or less than the original value of the Plan.

deviceobject

Show device properties

ip_addressstring

device_idstring

floating_dataobject[]

Show floating_data properties

installmentinteger<int32>

Number of the installment to which the change will be applied.

new_amountinteger

New charge amount.

new_scheduled_datestring<YYYY-MM-DD>

New billing date

original_scheduled_datestring<YYYY-MM-DD>

Date the billing was originally scheduled, before it was changed, according to the plan associated with the subscription.

original_amountinteger

Original billing amount, before it was changed, according to the plan associated with the subscription.

status_detailsstring

paymentobject

Show payment properties

seller_idstring<uuid>

order_idstring

payment_idstring<uuid>

amountinteger<int32>

currencystring

payment_received_timestampstring<date-time>

creditobject

Show credit properties

delayedboolean

authorization_codestring

authorization_timestampstring<date-time>

reason_codestring

reason_messagestring

acquirerstring

soft_descriptorstring

terminal_nsustring

acquirer_transaction_idstring

transaction_idstring

debitobject

Show debit properties

delayedboolean

authorization_codestring

authorization_timestampstring<date-time>

reason_codestring

reason_messagestring

acquirerstring

soft_descriptorstring

terminal_nsustring

acquirer_transaction_idstring

transaction_idstring

errorobject

Show error properties

status_codeinteger<int32>

namestring

messagestring

detailsobject[]

Show details properties

acquirer_transaction_idstring

descriptionstring

description_detailstring

error_codestring

payment_idstring

statusstring

terminal_nsustring

Invalid Requisition

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties

statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties

canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

paymentsobject[]

Error details.

Show payments properties

statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties

canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

combined_idstring

combinedId.

order_idstring

orderId.

seller_idstring

sellerId.

Not Found

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties

statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties

canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

paymentsobject[]

Error details.

Show payments properties

statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties

canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

combined_idstring

combinedId.

order_idstring

orderId.

seller_idstring

sellerId.

Unprocessable Entity

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties

statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties

canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

paymentsobject[]

Error details.

Show payments properties

statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties

canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

combined_idstring

combinedId.

order_idstring

orderId.

seller_idstring

sellerId.

Internal server or service error

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties

statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties

canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

paymentsobject[]

Error details.

Show payments properties

statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

brandstring

Brand.

payment_idstring

payment_id.

seller_idstring

seller_id.

amountstring

amount.

currencystring

currency.

order_idstring

order_id.

credit_cancelobject

credit_cancel.

Show credit_cancel properties

canceled_atstring

canceledAt.

messagestring

message.

payment_tagstring

payment_tag.

status_codestring

statusCode.

messagestring

message.

namestring

name.

acquirer_transaction_idstring

acquirer_transaction_id.

authorization_codestring

authorization_code.

transaction_idstring

transaction_id.

reason_codestring

reason_code.

reason_messagestring

reason_message.

merchant_advice_codestring

merchant_advice_code.

combined_idstring

combinedId.

order_idstring

orderId.

seller_idstring

sellerId.

curl -X POST "https://api.pre.globalgetnet.com/rpy/be-subscription/v1/subscriptions/<subscription_id>/cancel" \ -H "Content-Type: application/json" \ -H "username: <username>" \ -d '{ "seller_id": "9406df6c-3100-49ba-b4df-d81c1ad8a62b", "status_details": "Subscription Plan flex successfully created" }'

const response = await fetch(`https://api.pre.globalgetnet.com/rpy/be-subscription/v1/subscriptions/${subscription_id}/cancel`, { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ "seller_id": "9406df6c-3100-49ba-b4df-d81c1ad8a62b", "status_details": "Subscription Plan flex successfully created" }) }); const data = await response.json();

import requests response = requests.request( "POST", "https://api.pre.globalgetnet.com/rpy/be-subscription/v1/subscriptions/{subscription_id}/cancel", json={ "seller_id": "9406df6c-3100-49ba-b4df-d81c1ad8a62b", "status_details": "Subscription Plan flex successfully created" }, ) data = response.json()

<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://api.pre.globalgetnet.com/rpy/be-subscription/v1/subscriptions/<subscription_id>/cancel"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json"]); curl_setopt($ch, CURLOPT_POSTFIELDS, '{ "seller_id": "9406df6c-3100-49ba-b4df-d81c1ad8a62b", "status_details": "Subscription Plan flex successfully created" }'); $response = curl_exec($ch); curl_close($ch);

package main import ( "fmt" "io" "net/http" "strings" ) func main() { req, _ := http.NewRequest("POST", "https://api.pre.globalgetnet.com/rpy/be-subscription/v1/subscriptions/<subscription_id>/cancel", strings.NewReader(`{ "seller_id": "9406df6c-3100-49ba-b4df-d81c1ad8a62b", "status_details": "Subscription Plan flex successfully created" }`)) req.Header.Set("Content-Type", "application/json") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() data, _ := io.ReadAll(resp.Body) fmt.Println(string(data)) }

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.pre.globalgetnet.com/rpy/be-subscription/v1/subscriptions/<subscription_id>/cancel")) .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString("{\n \"seller_id\": \"9406df6c-3100-49ba-b4df-d81c1ad8a62b\",\n \"status_details\": \"Subscription Plan flex successfully created\"\n}")) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

require "net/http" require "uri" uri = URI("https://api.pre.globalgetnet.com/rpy/be-subscription/v1/subscriptions/<subscription_id>/cancel") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = uri.scheme == "https" request = Net::HTTP::Post.new(uri) request["Content-Type"] = "application/json" request.body = "{\n \"seller_id\": \"9406df6c-3100-49ba-b4df-d81c1ad8a62b\",\n \"status_details\": \"Subscription Plan flex successfully created\"\n}" response = http.request(request) puts response.body

{ "seller_id": "00000000-0000-0000-0000-000000000000", "order_id": "string", "installment_start_date": "2024-01-01", "create_date": "1970-01-01T00:00:00.000Z", "end_date": "1970-01-01T00:00:00.000Z", "payment_date": 0, "next_scheduled_date": "1970-01-01T00:00:00.000Z", "subscription": { "subscription_id": "00000000-0000-0000-0000-000000000000", "payment_type": { "credit": { "number_installments": 0, "billing_address": { "street": "Av. Brazil", "number": "1000", "complement": "Sala 1", "district": "Sao Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brazil", "postal_code": "90230060" }, "soft_descriptor": "string", "transaction_type": "FULL", "tokenization": { "type": "UCAF", "cryptogram": "string", "eci": "string", "requestor_id": "string" }, "card": { "brand": "Mastercard", "bin": "string", "expiration_month": "string", "expiration_year": "string", "cardholder_name": "string", "card_id": "string" }, "wallet": { "type": "string", "id": "string" } }, "debit": { "seller_id": "00000000-0000-0000-0000-000000000000", "order_id": "string", "payment_id": "00000000-0000-0000-0000-000000000000", "amount": 0, "currency": "string", "status": "pending", "payment_received_timestamp": "1970-01-01T00:00:00.000Z", "credit": { "delayed": true, "authorization_code": "string", "authorization_timestamp": "1970-01-01T00:00:00.000Z", "reason_code": "string", "reason_message": "string", "acquirer": "string", "soft_descriptor": "string", "brand": "Mastercard", "terminal_nsu": "string", "acquirer_transaction_id": "string", "transaction_id": "string" }, "debit": { "delayed": true, "authorization_code": "string", "authorization_timestamp": "1970-01-01T00:00:00.000Z", "reason_code": "string", "reason_message": "string", "acquirer": "string", "soft_descriptor": "string", "brand": "Mastercard", "terminal_nsu": "string", "acquirer_transaction_id": "string", "transaction_id": "string" }, "error": { "status_code": 0, "name": "string", "message": "string", "details": [ { "acquirer_transaction_id": null, "description": null, "description_detail": null, "error_code": null, "payment_id": null, "status": null, "terminal_nsu": null } ] } } }, "shippings": [ { "first_name": "string", "last_name": "string", "email": "string", "phone_number": "string", "shipping_amount": 0, "address": { "street": "Av. Brazil", "number": "1000", "complement": "Sala 1", "district": "Sao Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brazil", "postal_code": "90230060" } } ] }, "customer": { "customer_id": "string", "first_name": "string", "last_name": "string", "document_type": "CPF", "document_type_name": "string", "document_number": "string", "document_country": "string", "phone_number": "string", "celphone_number": "string", "email": "string", "status": "active" }, "plan": { "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "plan_id": "51995e24-b1ae-4826-8e15-2a568a87abdd", "name": "Plano flex", "description": "Flex plan", "amount": 19990, "currency": "BRL", "payment_types": "", "sales_tax": 0, "product_type": "service", "create_date": "2017-04-19T16:30:30Z", "status": "active", "period": { "type": "monthly", "billing_cycle": 12, "specific_cycle_in_days": 0 }, "floating_data": [ { "installment": 2, "amount": 19990 } ] }, "device": { "ip_address": "string", "device_id": "string" }, "floating_data": [ { "installment": 2, "new_amount": 19990, "new_scheduled_date": "2020-06-10", "original_scheduled_date": "2020-06-10", "original_amount": 19990 } ], "status": "processing", "status_details": "string", "payment": { "seller_id": "00000000-0000-0000-0000-000000000000", "order_id": "string", "payment_id": "00000000-0000-0000-0000-000000000000", "amount": 0, "currency": "string", "status": "pending", "payment_received_timestamp": "1970-01-01T00:00:00.000Z", "credit": { "delayed": true, "authorization_code": "string", "authorization_timestamp": "1970-01-01T00:00:00.000Z", "reason_code": "string", "reason_message": "string", "acquirer": "string", "soft_descriptor": "string", "brand": "Mastercard", "terminal_nsu": "string", "acquirer_transaction_id": "string", "transaction_id": "string" }, "debit": { "delayed": true, "authorization_code": "string", "authorization_timestamp": "1970-01-01T00:00:00.000Z", "reason_code": "string", "reason_message": "string", "acquirer": "string", "soft_descriptor": "string", "brand": "Mastercard", "terminal_nsu": "string", "acquirer_transaction_id": "string", "transaction_id": "string" }, "error": { "status_code": 0, "name": "string", "message": "string", "details": [ { "acquirer_transaction_id": "string", "description": "string", "description_detail": "string", "error_code": "string", "payment_id": "string", "status": "string", "terminal_nsu": "string" } ] } } }

{ "message": "string", "name": "string", "status_code": 0, "details": [ { "status": "string", "error_code": "string", "description": "string", "description_detail": "string", "brand": "string", "payment_id": "string", "seller_id": "string", "amount": "string", "currency": "string", "order_id": "string", "credit_cancel": { "canceled_at": "string", "message": "string" }, "payment_tag": "string", "status_code": "string", "message": "string", "name": "string", "acquirer_transaction_id": "string", "authorization_code": "string", "transaction_id": "string", "reason_code": "string", "reason_message": "string", "merchant_advice_code": "string" } ], "payments": [ { "status": "string", "error_code": "string", "description": "string", "description_detail": "string", "brand": "string", "payment_id": "string", "seller_id": "string", "amount": "string", "currency": "string", "order_id": "string", "credit_cancel": { "canceled_at": "string", "message": "string" }, "payment_tag": "string", "status_code": "string", "message": "string", "name": "string", "acquirer_transaction_id": "string", "authorization_code": "string", "transaction_id": "string", "reason_code": "string", "reason_message": "string", "merchant_advice_code": "string" } ], "combined_id": "string", "order_id": "string", "seller_id": "string" }