curl --request POST \
--url https://api-sandbox.beinfi.com/products/{productID}/versions/{versionID}/publish \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"default": true
}
'import requests
url = "https://api-sandbox.beinfi.com/products/{productID}/versions/{versionID}/publish"
payload = { "default": True }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({default: true})
};
fetch('https://api-sandbox.beinfi.com/products/{productID}/versions/{versionID}/publish', 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://api-sandbox.beinfi.com/products/{productID}/versions/{versionID}/publish",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'default' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api-sandbox.beinfi.com/products/{productID}/versions/{versionID}/publish"
payload := strings.NewReader("{\n \"default\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.beinfi.com/products/{productID}/versions/{versionID}/publish")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"default\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.beinfi.com/products/{productID}/versions/{versionID}/publish")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"default\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"billingCycle": "weekly",
"basePrice": "<string>",
"status": "draft",
"isDefault": true,
"publishedAt": "2023-11-07T05:31:56Z",
"commitmentAmount": "<string>",
"commitmentResets": true,
"consumptionFloor": "<string>",
"grants": [
{
"meter": "<string>",
"amount": "<string>",
"on": "cycle"
}
]
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"resource": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"errors": [
{
"field": "<string>",
"value": "<string>",
"constraint": "<string>",
"description": "<string>"
}
]
}Publicar versão
Publica uma versão em draft. A partir daqui o preço dela é fixo e o produto pode ser vendido. Por padrão, a versão publicada vira a padrão do produto (a que o comprador recebe quando nada indica outra) e um primeiro link de pagamento é criado.
Envie {"default": false} para publicar uma oferta: a versão fica vendável, mas só por um link de pagamento criado com productVersionId. Serve para ter um preço promocional ao lado do preço normal sem que ele apareça na loja. Isso só vale depois que o produto já tem uma versão padrão; antes disso, a resposta é 422.
curl --request POST \
--url https://api-sandbox.beinfi.com/products/{productID}/versions/{versionID}/publish \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"default": true
}
'import requests
url = "https://api-sandbox.beinfi.com/products/{productID}/versions/{versionID}/publish"
payload = { "default": True }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({default: true})
};
fetch('https://api-sandbox.beinfi.com/products/{productID}/versions/{versionID}/publish', 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://api-sandbox.beinfi.com/products/{productID}/versions/{versionID}/publish",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'default' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api-sandbox.beinfi.com/products/{productID}/versions/{versionID}/publish"
payload := strings.NewReader("{\n \"default\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.beinfi.com/products/{productID}/versions/{versionID}/publish")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"default\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.beinfi.com/products/{productID}/versions/{versionID}/publish")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"default\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"billingCycle": "weekly",
"basePrice": "<string>",
"status": "draft",
"isDefault": true,
"publishedAt": "2023-11-07T05:31:56Z",
"commitmentAmount": "<string>",
"commitmentResets": true,
"consumptionFloor": "<string>",
"grants": [
{
"meter": "<string>",
"amount": "<string>",
"on": "cycle"
}
]
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"resource": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"errors": [
{
"field": "<string>",
"value": "<string>",
"constraint": "<string>",
"description": "<string>"
}
]
}Autorizações
Chave secreta da conta: Authorization: Bearer sk_test_… ou sk_live_…. Use só no servidor.
Cabeçalhos
Chave única por operação (um UUID serve). Repetir com a mesma chave devolve a resposta original.
Parâmetros de caminho
ID do produto.
ID da versão do produto.
Corpo
Opcional. Sem corpo, a versão é publicada como padrão.
true (ou omitido) torna esta a versão padrão do produto. false publica como oferta, vendida só por um link que a indique.
Resposta
A versão publicada.
Uma versão do produto: o retrato do preço. Uma versão publicada nunca muda; para mudar o preço, crie outra.
Número sequencial da versão (1, 2, 3…).
weekly, monthly ou annual; null em produtos sem recorrência.
weekly, monthly, annual, null Preço base em texto decimal; null em produto só de uso.
draft (editável), published (vendável, preço fixo) ou archived.
draft, published, archived Se esta é a versão que o comprador recebe quando nada indica outra. Uma versão publicada com isDefault: false é uma oferta: só é vendida por um link de pagamento criado com productVersionId.
Mínimo cobrado por ciclo, em texto decimal; null sem mínimo.
true: o mínimo não usado se perde no fim do ciclo. false: passa para o seguinte.
Saldo abaixo do qual o registro de uso é recusado. Veja VersionConsumption.floor.
Créditos de uso que a versão concede.
Show child attributes
Show child attributes