Update Plan

PATCH/rpy/be-plan/v1/plans/{plan_id}

__Update a Plan__ This endpoint allows you to update the attributes of an existing recurrence plan. It is typically used to modify plan metadata such as the name, description, or floating installment data without altering its identity or subscription history. **Usage Scenarios:** _- Correcting or improving plan presentation on user-facing interfaces. - Adjusting installment options (e.g. adding or modifying floating amounts per installment)._ **Notes:** _- You can update attributes like the plan’s **name**, **description**, and **floating_data**, which contains customized **installment** options (**installment number** and corresponding **amount** in cents). - Only the fields included in the request body will be updated. Fields not present will remain unchanged._

Header Parameters

usernamestring

User who is registering. This information may be used for auditing purposes.

Path Parameters

plan_idstringrequired

Plan identifier.

Body application/json

namestringrequired

Plan name.

descriptionstring

Plan description.

amountintegerrequired

Purchase value in cents. It must be an integer.

currencystringrequired

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

payment_types"credit_card" | "debit_card"[]required

sales_taxinteger

Tax amount.

Identifier of the type of product sold among the options.

periodobjectrequired

Plan period.

Show period properties

Type of periodicity.

billing_cycleintegerrequired

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.

status"active" | "inactive"required

floating_dataobject[]

Show floating_data properties

installmentinteger<int32>required

amountinteger<int32>required

Response

seller_idstring<uuid>

plan_idstring<uuid>

namestring

descriptionstring

amountinteger<int32>

currencystring

sales_taxinteger<int32>

payment_types"credit_card" | "debit_card"[]

status"active" | "inactive"

create_datestring<date-time>

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

floating_dataobject[]

Show floating_data properties

installmentinteger<int32>

amountinteger<int32>

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 PATCH "https://api.pre.globalgetnet.com/rpy/be-plan/v1/plans/<plan_id>" \ -H "Content-Type: application/json" \ -H "username: <username>" \ -d '{ "name": "flex plan", "description": "flex plan", "amount": 8900, "currency": "BRL", "payment_types": [ "credit_card" ], "sales_tax": 0, "product_type": "cash_carry", "period": { "type": "monthly", "billing_cycle": 12, "specific_cycle_in_days": 0 }, "status": "active", "floating_data": [ { "installment": 0, "amount": 0 } ] }'

const response = await fetch(`https://api.pre.globalgetnet.com/rpy/be-plan/v1/plans/${plan_id}`, { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ "name": "flex plan", "description": "flex plan", "amount": 8900, "currency": "BRL", "payment_types": [ "credit_card" ], "sales_tax": 0, "product_type": "cash_carry", "period": { "type": "monthly", "billing_cycle": 12, "specific_cycle_in_days": 0 }, "status": "active", "floating_data": [ { "installment": 0, "amount": 0 } ] }) }); const data = await response.json();

import requests response = requests.request( "PATCH", "https://api.pre.globalgetnet.com/rpy/be-plan/v1/plans/{plan_id}", json={ "name": "flex plan", "description": "flex plan", "amount": 8900, "currency": "BRL", "payment_types": [ "credit_card" ], "sales_tax": 0, "product_type": "cash_carry", "period": { "type": "monthly", "billing_cycle": 12, "specific_cycle_in_days": 0 }, "status": "active", "floating_data": [ { "installment": 0, "amount": 0 } ] }, ) data = response.json()

<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://api.pre.globalgetnet.com/rpy/be-plan/v1/plans/<plan_id>"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH"); curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json"]); curl_setopt($ch, CURLOPT_POSTFIELDS, '{ "name": "flex plan", "description": "flex plan", "amount": 8900, "currency": "BRL", "payment_types": [ "credit_card" ], "sales_tax": 0, "product_type": "cash_carry", "period": { "type": "monthly", "billing_cycle": 12, "specific_cycle_in_days": 0 }, "status": "active", "floating_data": [ { "installment": 0, "amount": 0 } ] }'); $response = curl_exec($ch); curl_close($ch);

package main import ( "fmt" "io" "net/http" "strings" ) func main() { req, _ := http.NewRequest("PATCH", "https://api.pre.globalgetnet.com/rpy/be-plan/v1/plans/<plan_id>", strings.NewReader(`{ "name": "flex plan", "description": "flex plan", "amount": 8900, "currency": "BRL", "payment_types": [ "credit_card" ], "sales_tax": 0, "product_type": "cash_carry", "period": { "type": "monthly", "billing_cycle": 12, "specific_cycle_in_days": 0 }, "status": "active", "floating_data": [ { "installment": 0, "amount": 0 } ] }`)) 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-plan/v1/plans/<plan_id>")) .header("Content-Type", "application/json") .method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"name\": \"flex plan\",\n \"description\": \"flex plan\",\n \"amount\": 8900,\n \"currency\": \"BRL\",\n \"payment_types\": [\n \"credit_card\"\n ],\n \"sales_tax\": 0,\n \"product_type\": \"cash_carry\",\n \"period\": {\n \"type\": \"monthly\",\n \"billing_cycle\": 12,\n \"specific_cycle_in_days\": 0\n },\n \"status\": \"active\",\n \"floating_data\": [\n {\n \"installment\": 0,\n \"amount\": 0\n }\n ]\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-plan/v1/plans/<plan_id>") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = uri.scheme == "https" request = Net::HTTP::Patch.new(uri) request["Content-Type"] = "application/json" request.body = "{\n \"name\": \"flex plan\",\n \"description\": \"flex plan\",\n \"amount\": 8900,\n \"currency\": \"BRL\",\n \"payment_types\": [\n \"credit_card\"\n ],\n \"sales_tax\": 0,\n \"product_type\": \"cash_carry\",\n \"period\": {\n \"type\": \"monthly\",\n \"billing_cycle\": 12,\n \"specific_cycle_in_days\": 0\n },\n \"status\": \"active\",\n \"floating_data\": [\n {\n \"installment\": 0,\n \"amount\": 0\n }\n ]\n}" response = http.request(request) puts response.body

{ "seller_id": "00000000-0000-0000-0000-000000000000", "plan_id": "00000000-0000-0000-0000-000000000000", "name": "string", "description": "string", "amount": 0, "currency": "string", "sales_tax": 0, "product_type": "cash_carry", "payment_types": [ "credit_card" ], "status": "active", "create_date": "1970-01-01T00:00:00.000Z", "period": { "type": "monthly", "billing_cycle": 12, "specific_cycle_in_days": 0 }, "floating_data": [ { "installment": 0, "amount": 0 } ] }

{ "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" }