Saltar al contenido principal
PATCH
/
v1
/
billing-packages
/
{id}
Actualizar un paquete de billing
curl --request PATCH \
  --url https://fees.sandbox.lerian.net/v1/billing-packages/{id} \
  --header 'Content-Type: <content-type>' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '
{
  "label": "Updated Pix Billing",
  "description": "Updated description for Pix billing",
  "enable": false
}
'
import requests

url = "https://fees.sandbox.lerian.net/v1/billing-packages/{id}"

payload = {
"label": "Updated Pix Billing",
"description": "Updated description for Pix billing",
"enable": False
}
headers = {
"X-Organization-Id": "<x-organization-id>",
"Content-Type": "<content-type>"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {'X-Organization-Id': '<x-organization-id>', 'Content-Type': '<content-type>'},
body: JSON.stringify({
label: 'Updated Pix Billing',
description: 'Updated description for Pix billing',
enable: false
})
};

fetch('https://fees.sandbox.lerian.net/v1/billing-packages/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://fees.sandbox.lerian.net/v1/billing-packages/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'label' => 'Updated Pix Billing',
'description' => 'Updated description for Pix billing',
'enable' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: <content-type>",
"X-Organization-Id: <x-organization-id>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://fees.sandbox.lerian.net/v1/billing-packages/{id}"

payload := strings.NewReader("{\n \"label\": \"Updated Pix Billing\",\n \"description\": \"Updated description for Pix billing\",\n \"enable\": false\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("X-Organization-Id", "<x-organization-id>")
req.Header.Add("Content-Type", "<content-type>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://fees.sandbox.lerian.net/v1/billing-packages/{id}")
.header("X-Organization-Id", "<x-organization-id>")
.header("Content-Type", "<content-type>")
.body("{\n \"label\": \"Updated Pix Billing\",\n \"description\": \"Updated description for Pix billing\",\n \"enable\": false\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://fees.sandbox.lerian.net/v1/billing-packages/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-Organization-Id"] = '<x-organization-id>'
request["Content-Type"] = '<content-type>'
request.body = "{\n \"label\": \"Updated Pix Billing\",\n \"description\": \"Updated description for Pix billing\",\n \"enable\": false\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "label": "<string>",
  "description": "<string>",
  "enable": true,
  "organizationId": "<string>",
  "ledgerId": "<string>",
  "eventFilter": {
    "transactionRoute": "<string>",
    "status": "<string>"
  },
  "tiers": [
    {
      "minQuantity": 123,
      "maxQuantity": 123,
      "unitPrice": "<string>"
    }
  ],
  "freeQuota": 123,
  "discountTiers": [
    {
      "minQuantity": 123,
      "discountPercentage": "<string>"
    }
  ],
  "assetCode": "<string>",
  "debitAccountAlias": "<string>",
  "creditAccountAlias": "<string>",
  "feeAmount": "<string>",
  "maintenanceCreditAccount": "<string>",
  "accountTarget": {
    "segmentId": "<string>",
    "portfolioId": "<string>",
    "aliases": [
      "<string>"
    ]
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Encabezados

X-Organization-Id
string
requerido

Identificador único de la organización asociada a la solicitud.

Ejemplo:

"019c96a0-0a98-7287-9a31-786e0809c769"

Authorization
string

El token de autorización en formato 'Bearer '.

Importante: Este encabezado es obligatorio si su entorno tiene habilitado Access Manager. Para obtener más información, consulte la documentación de Access Manager.

Content-Type
string
requerido

Tipo de medio del recurso. Debe ser application/json.

Ejemplo:

"application/json"

Parámetros de ruta

id
string
requerido

Identificador único del paquete de billing.

Ejemplo:

"bpkg_01HZ..."

Cuerpo

application/json

Actualización parcial de un paquete de billing. Solo se pueden actualizar label, description y enable. Envía solo los campos que deseas cambiar.

label
string

Nombre actualizado del paquete de billing.

description
string

Descripción actualizada.

enable
boolean

Habilitar o deshabilitar el paquete de billing.

Respuesta

Paquete de billing actualizado exitosamente.

id
string

Identificador único del paquete de billing.

label
string
description
string
type
enum<string>
Opciones disponibles:
volume,
maintenance
enable
boolean
organizationId
string
ledgerId
string
eventFilter
object
pricingModel
enum<string>
Opciones disponibles:
tiered,
fixed
tiers
object[]
freeQuota
integer
discountTiers
object[]
countMode
enum<string>
Opciones disponibles:
perRoute,
perAccount
assetCode
string
debitAccountAlias
string
creditAccountAlias
string
feeAmount
string
maintenanceCreditAccount
string
accountTarget
object
createdAt
string<date-time>
updatedAt
string<date-time>
deletedAt
string<date-time> | null