Plano e Assinaturas
Cria um novo plano (admin de plataforma)
POST
/
billing
/
plans
Cria um novo plano (admin de plataforma)
curl --request POST \
--url https://golang-api-vgnqx.ondigitalocean.app/v1/billing/plans \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"slug": "<string>",
"created_for_user_id": "<string>",
"description": "<string>",
"limits": {
"dre_available": true,
"max_companies": 0,
"max_transactions_per_month": 0,
"max_users_per_company": 0
},
"sort_order": 1
}
'import requests
url = "https://golang-api-vgnqx.ondigitalocean.app/v1/billing/plans"
payload = {
"name": "<string>",
"slug": "<string>",
"created_for_user_id": "<string>",
"description": "<string>",
"limits": {
"dre_available": True,
"max_companies": 0,
"max_transactions_per_month": 0,
"max_users_per_company": 0
},
"sort_order": 1
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
slug: '<string>',
created_for_user_id: '<string>',
description: '<string>',
limits: {
dre_available: true,
max_companies: 0,
max_transactions_per_month: 0,
max_users_per_company: 0
},
sort_order: 1
})
};
fetch('https://golang-api-vgnqx.ondigitalocean.app/v1/billing/plans', 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://golang-api-vgnqx.ondigitalocean.app/v1/billing/plans",
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([
'name' => '<string>',
'slug' => '<string>',
'created_for_user_id' => '<string>',
'description' => '<string>',
'limits' => [
'dre_available' => true,
'max_companies' => 0,
'max_transactions_per_month' => 0,
'max_users_per_company' => 0
],
'sort_order' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://golang-api-vgnqx.ondigitalocean.app/v1/billing/plans"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"created_for_user_id\": \"<string>\",\n \"description\": \"<string>\",\n \"limits\": {\n \"dre_available\": true,\n \"max_companies\": 0,\n \"max_transactions_per_month\": 0,\n \"max_users_per_company\": 0\n },\n \"sort_order\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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://golang-api-vgnqx.ondigitalocean.app/v1/billing/plans")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"created_for_user_id\": \"<string>\",\n \"description\": \"<string>\",\n \"limits\": {\n \"dre_available\": true,\n \"max_companies\": 0,\n \"max_transactions_per_month\": 0,\n \"max_users_per_company\": 0\n },\n \"sort_order\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://golang-api-vgnqx.ondigitalocean.app/v1/billing/plans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"created_for_user_id\": \"<string>\",\n \"description\": \"<string>\",\n \"limits\": {\n \"dre_available\": true,\n \"max_companies\": 0,\n \"max_transactions_per_month\": 0,\n \"max_users_per_company\": 0\n },\n \"sort_order\": 1\n}"
response = http.request(request)
puts response.read_body{
"active": true,
"created_for_user_id": "<string>",
"description": "<string>",
"id": "<string>",
"kind": "<string>",
"limits": {
"dre_available": true,
"max_companies": 0,
"max_transactions_per_month": 0,
"max_users_per_company": 0
},
"name": "<string>",
"prices": [
{
"active": true,
"amount_cents": 123,
"currency": "<string>",
"id": "<string>",
"period": "<string>",
"saving": 123,
"stripe_price_id": "<string>"
}
],
"slug": "<string>",
"sort_order": 123
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
Token da sessão no cabeçalho Authorization, no formato Bearer (mesmo esquema ApiKeyAuth do contrato).
Body
application/json
plan payload
⌘I
Cria um novo plano (admin de plataforma)
curl --request POST \
--url https://golang-api-vgnqx.ondigitalocean.app/v1/billing/plans \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"slug": "<string>",
"created_for_user_id": "<string>",
"description": "<string>",
"limits": {
"dre_available": true,
"max_companies": 0,
"max_transactions_per_month": 0,
"max_users_per_company": 0
},
"sort_order": 1
}
'import requests
url = "https://golang-api-vgnqx.ondigitalocean.app/v1/billing/plans"
payload = {
"name": "<string>",
"slug": "<string>",
"created_for_user_id": "<string>",
"description": "<string>",
"limits": {
"dre_available": True,
"max_companies": 0,
"max_transactions_per_month": 0,
"max_users_per_company": 0
},
"sort_order": 1
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
slug: '<string>',
created_for_user_id: '<string>',
description: '<string>',
limits: {
dre_available: true,
max_companies: 0,
max_transactions_per_month: 0,
max_users_per_company: 0
},
sort_order: 1
})
};
fetch('https://golang-api-vgnqx.ondigitalocean.app/v1/billing/plans', 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://golang-api-vgnqx.ondigitalocean.app/v1/billing/plans",
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([
'name' => '<string>',
'slug' => '<string>',
'created_for_user_id' => '<string>',
'description' => '<string>',
'limits' => [
'dre_available' => true,
'max_companies' => 0,
'max_transactions_per_month' => 0,
'max_users_per_company' => 0
],
'sort_order' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://golang-api-vgnqx.ondigitalocean.app/v1/billing/plans"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"created_for_user_id\": \"<string>\",\n \"description\": \"<string>\",\n \"limits\": {\n \"dre_available\": true,\n \"max_companies\": 0,\n \"max_transactions_per_month\": 0,\n \"max_users_per_company\": 0\n },\n \"sort_order\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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://golang-api-vgnqx.ondigitalocean.app/v1/billing/plans")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"created_for_user_id\": \"<string>\",\n \"description\": \"<string>\",\n \"limits\": {\n \"dre_available\": true,\n \"max_companies\": 0,\n \"max_transactions_per_month\": 0,\n \"max_users_per_company\": 0\n },\n \"sort_order\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://golang-api-vgnqx.ondigitalocean.app/v1/billing/plans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"created_for_user_id\": \"<string>\",\n \"description\": \"<string>\",\n \"limits\": {\n \"dre_available\": true,\n \"max_companies\": 0,\n \"max_transactions_per_month\": 0,\n \"max_users_per_company\": 0\n },\n \"sort_order\": 1\n}"
response = http.request(request)
puts response.read_body{
"active": true,
"created_for_user_id": "<string>",
"description": "<string>",
"id": "<string>",
"kind": "<string>",
"limits": {
"dre_available": true,
"max_companies": 0,
"max_transactions_per_month": 0,
"max_users_per_company": 0
},
"name": "<string>",
"prices": [
{
"active": true,
"amount_cents": 123,
"currency": "<string>",
"id": "<string>",
"period": "<string>",
"saving": 123,
"stripe_price_id": "<string>"
}
],
"slug": "<string>",
"sort_order": 123
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}