Sell a product
curl --request POST \
--url https://api-sandbox.beinfi.com/billing/products/{productID}/invoices \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customer": {
"externalId": "<string>",
"email": "<string>",
"name": "<string>",
"taxId": "<string>"
},
"amount": "<string>",
"description": "<string>",
"currency": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"send": true,
"successUrl": "<string>",
"cancelUrl": "<string>"
}
'import requests
url = "https://api-sandbox.beinfi.com/billing/products/{productID}/invoices"
payload = {
"customer": {
"externalId": "<string>",
"email": "<string>",
"name": "<string>",
"taxId": "<string>"
},
"amount": "<string>",
"description": "<string>",
"currency": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"send": True,
"successUrl": "<string>",
"cancelUrl": "<string>"
}
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({
customer: {externalId: '<string>', email: '<string>', name: '<string>', taxId: '<string>'},
amount: '<string>',
description: '<string>',
currency: '<string>',
dueDate: '2023-11-07T05:31:56Z',
send: true,
successUrl: '<string>',
cancelUrl: '<string>'
})
};
fetch('https://api-sandbox.beinfi.com/billing/products/{productID}/invoices', 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/billing/products/{productID}/invoices",
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([
'customer' => [
'externalId' => '<string>',
'email' => '<string>',
'name' => '<string>',
'taxId' => '<string>'
],
'amount' => '<string>',
'description' => '<string>',
'currency' => '<string>',
'dueDate' => '2023-11-07T05:31:56Z',
'send' => true,
'successUrl' => '<string>',
'cancelUrl' => '<string>'
]),
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/billing/products/{productID}/invoices"
payload := strings.NewReader("{\n \"customer\": {\n \"externalId\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"taxId\": \"<string>\"\n },\n \"amount\": \"<string>\",\n \"description\": \"<string>\",\n \"currency\": \"<string>\",\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"send\": true,\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\"\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/billing/products/{productID}/invoices")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customer\": {\n \"externalId\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"taxId\": \"<string>\"\n },\n \"amount\": \"<string>\",\n \"description\": \"<string>\",\n \"currency\": \"<string>\",\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"send\": true,\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.beinfi.com/billing/products/{productID}/invoices")
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 \"customer\": {\n \"externalId\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"taxId\": \"<string>\"\n },\n \"amount\": \"<string>\",\n \"description\": \"<string>\",\n \"currency\": \"<string>\",\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"send\": true,\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "inv_6yi30EKotIwGHZdePSdsFc",
"status": "draft",
"currency": "<string>",
"subtotal": "<string>",
"tax": "<string>",
"total": "<string>",
"amountDue": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payerId": "cus_6Tq0Y2rGJ1aQ9zXk3LmPbV",
"subscriptionId": "sub_2Kp7rWqT0aLm4XcVb8NzJe",
"invoiceNumber": "<string>",
"periodStart": "2023-11-07T05:31:56Z",
"periodEnd": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"finalizedAt": "2023-11-07T05:31:56Z",
"paidAt": "2023-11-07T05:31:56Z",
"successUrl": "<string>",
"cancelUrl": "<string>",
"lineItems": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "usage",
"description": "<string>",
"quantity": "<string>",
"amount": "<string>",
"proration": true,
"meterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"priceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"unitPrice": "<string>"
}
]
}{
"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>",
"errors": [
{
"field": "<string>",
"value": "<string>",
"constraint": "<string>",
"description": "<string>"
}
]
}Invoices
Sell a product
Enrolls the customer in the product and opens an invoice for it, already open and ready to be paid. When the payment confirms, product delivery (email and download link) happens on its own.
The customer is identified by customer.externalId: calling again with the same externalId reuses the customer and enrollment instead of creating duplicates. The amount comes from the product’s published price unless you send amount.
POST
/
billing
/
products
/
{productID}
/
invoices
Sell a product
curl --request POST \
--url https://api-sandbox.beinfi.com/billing/products/{productID}/invoices \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customer": {
"externalId": "<string>",
"email": "<string>",
"name": "<string>",
"taxId": "<string>"
},
"amount": "<string>",
"description": "<string>",
"currency": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"send": true,
"successUrl": "<string>",
"cancelUrl": "<string>"
}
'import requests
url = "https://api-sandbox.beinfi.com/billing/products/{productID}/invoices"
payload = {
"customer": {
"externalId": "<string>",
"email": "<string>",
"name": "<string>",
"taxId": "<string>"
},
"amount": "<string>",
"description": "<string>",
"currency": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"send": True,
"successUrl": "<string>",
"cancelUrl": "<string>"
}
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({
customer: {externalId: '<string>', email: '<string>', name: '<string>', taxId: '<string>'},
amount: '<string>',
description: '<string>',
currency: '<string>',
dueDate: '2023-11-07T05:31:56Z',
send: true,
successUrl: '<string>',
cancelUrl: '<string>'
})
};
fetch('https://api-sandbox.beinfi.com/billing/products/{productID}/invoices', 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/billing/products/{productID}/invoices",
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([
'customer' => [
'externalId' => '<string>',
'email' => '<string>',
'name' => '<string>',
'taxId' => '<string>'
],
'amount' => '<string>',
'description' => '<string>',
'currency' => '<string>',
'dueDate' => '2023-11-07T05:31:56Z',
'send' => true,
'successUrl' => '<string>',
'cancelUrl' => '<string>'
]),
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/billing/products/{productID}/invoices"
payload := strings.NewReader("{\n \"customer\": {\n \"externalId\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"taxId\": \"<string>\"\n },\n \"amount\": \"<string>\",\n \"description\": \"<string>\",\n \"currency\": \"<string>\",\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"send\": true,\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\"\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/billing/products/{productID}/invoices")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customer\": {\n \"externalId\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"taxId\": \"<string>\"\n },\n \"amount\": \"<string>\",\n \"description\": \"<string>\",\n \"currency\": \"<string>\",\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"send\": true,\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.beinfi.com/billing/products/{productID}/invoices")
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 \"customer\": {\n \"externalId\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"taxId\": \"<string>\"\n },\n \"amount\": \"<string>\",\n \"description\": \"<string>\",\n \"currency\": \"<string>\",\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"send\": true,\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "inv_6yi30EKotIwGHZdePSdsFc",
"status": "draft",
"currency": "<string>",
"subtotal": "<string>",
"tax": "<string>",
"total": "<string>",
"amountDue": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payerId": "cus_6Tq0Y2rGJ1aQ9zXk3LmPbV",
"subscriptionId": "sub_2Kp7rWqT0aLm4XcVb8NzJe",
"invoiceNumber": "<string>",
"periodStart": "2023-11-07T05:31:56Z",
"periodEnd": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"finalizedAt": "2023-11-07T05:31:56Z",
"paidAt": "2023-11-07T05:31:56Z",
"successUrl": "<string>",
"cancelUrl": "<string>",
"lineItems": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "usage",
"description": "<string>",
"quantity": "<string>",
"amount": "<string>",
"proration": true,
"meterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"priceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"unitPrice": "<string>"
}
]
}{
"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>",
"errors": [
{
"field": "<string>",
"value": "<string>",
"constraint": "<string>",
"description": "<string>"
}
]
}Authorizations
Your account's secret key: Authorization: Bearer sk_test_… or sk_live_…. Server-side only.
Path Parameters
Product ID.
Pattern:
^prod_[0-9A-Za-z]{22}$Example:
"prod_1d4YogBuw00jAySh5mbUpk"
Body
application/json
The buyer. externalId is required and identifies the customer stably (their id in your system, or their email): the same key reuses the existing customer. email, name and taxId (CPF or CNPJ) are optional.
Show child attributes
Show child attributes
Amount to charge, as a decimal string. Defaults to the product's published price.
Line description on the invoice. Defaults to the product name.
Currency, as an ISO 4217 code. Defaults to BRL.
Due date.
true emails the invoice to the buyer as soon as it is created.
Where checkout sends the buyer after payment.
Where checkout sends the buyer if they back out.
Response
Created.
What a customer owes: line items, totals and status. Status: draft → open → paid, or void / uncollectible.
Pattern:
^inv_[0-9A-Za-z]{22}$Example:
"inv_6yi30EKotIwGHZdePSdsFc"
draft (being built), open (issued, awaiting payment), paid, void (canceled) or uncollectible (written off).
Available options:
draft, pending, open, paid, void, uncollectible Currency, as an ISO 4217 code (BRL).
Sum of line items before tax and discounts.
Tax on the invoice.
The invoice's final amount.
How much is still owed.
The customer's product enrollment id. Set on product, usage and subscription invoices.
The paying customer's id. Set on one-off invoices.
Pattern:
^cus_[0-9A-Za-z]{22}$Example:
"cus_6Tq0Y2rGJ1aQ9zXk3LmPbV"
The subscription that generated the invoice
Pattern:
^sub_[0-9A-Za-z]{22}$Example:
"sub_2Kp7rWqT0aLm4XcVb8NzJe"
Sequential invoice number
Start of the billed period
End of the billed period
Due date.
When the invoice was issued.
When the invoice was paid.
Where checkout sends the buyer after payment.
Where checkout sends the buyer if they back out.
Show child attributes
Show child attributes