Billing
Get plan
GET
/
public
/
api
/
v1
/
billing
/
plans
/
{planPublicId}
Get plan
curl --request GET \
--url https://api.gennia.ai/public/api/v1/billing/plans/{planPublicId} \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.gennia.ai/public/api/v1/billing/plans/{planPublicId}"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.gennia.ai/public/api/v1/billing/plans/{planPublicId}', 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.gennia.ai/public/api/v1/billing/plans/{planPublicId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gennia.ai/public/api/v1/billing/plans/{planPublicId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.gennia.ai/public/api/v1/billing/plans/{planPublicId}")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gennia.ai/public/api/v1/billing/plans/{planPublicId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"activeSubscriptions": 123,
"billingIntervalMonths": 123,
"checkoutUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"creditPackage": {
"creditValueCents": 123,
"creditsAmount": 123,
"extraCreditsAmount": 123,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"renewalIntervalMonths": 123
},
"currency": "<string>",
"description": "<string>",
"extraCreditsEnabled": true,
"extraCreditsPriceCents": 123,
"formattedPrice": "<string>",
"hubPackage": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seatsIncluded": 123,
"unlimitedCredits": true,
"visible": true,
"widgetCtaText": "<string>",
"widgetDescription": "<string>",
"widgetFeatures": [
{
"included": true,
"text": "<string>"
}
],
"widgetHighlighted": true,
"widgetTitle": "<string>"
}{
"activeSubscriptions": 123,
"billingIntervalMonths": 123,
"checkoutUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"creditPackage": {
"creditValueCents": 123,
"creditsAmount": 123,
"extraCreditsAmount": 123,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"renewalIntervalMonths": 123
},
"currency": "<string>",
"description": "<string>",
"extraCreditsEnabled": true,
"extraCreditsPriceCents": 123,
"formattedPrice": "<string>",
"hubPackage": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seatsIncluded": 123,
"unlimitedCredits": true,
"visible": true,
"widgetCtaText": "<string>",
"widgetDescription": "<string>",
"widgetFeatures": [
{
"included": true,
"text": "<string>"
}
],
"widgetHighlighted": true,
"widgetTitle": "<string>"
}{
"activeSubscriptions": 123,
"billingIntervalMonths": 123,
"checkoutUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"creditPackage": {
"creditValueCents": 123,
"creditsAmount": 123,
"extraCreditsAmount": 123,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"renewalIntervalMonths": 123
},
"currency": "<string>",
"description": "<string>",
"extraCreditsEnabled": true,
"extraCreditsPriceCents": 123,
"formattedPrice": "<string>",
"hubPackage": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seatsIncluded": 123,
"unlimitedCredits": true,
"visible": true,
"widgetCtaText": "<string>",
"widgetDescription": "<string>",
"widgetFeatures": [
{
"included": true,
"text": "<string>"
}
],
"widgetHighlighted": true,
"widgetTitle": "<string>"
}Autorizações
Parâmetros de caminho
Plan public ID
Resposta
OK
Opções disponíveis:
one_time, recurring Show child attributes
Show child attributes
Show child attributes
Show child attributes
Opções disponíveis:
active, inactive Show child attributes
Show child attributes
Esta página foi útil?
Anterior
Update planPartial update. Immutable fields not exposed: currency, billingType, billingIntervalMonths (Stripe doesn't allow changing a Price). Changing `priceCents` while the plan has active subscriptions fails with 400.
Próximo
⌘I
Get plan
curl --request GET \
--url https://api.gennia.ai/public/api/v1/billing/plans/{planPublicId} \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.gennia.ai/public/api/v1/billing/plans/{planPublicId}"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.gennia.ai/public/api/v1/billing/plans/{planPublicId}', 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.gennia.ai/public/api/v1/billing/plans/{planPublicId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gennia.ai/public/api/v1/billing/plans/{planPublicId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.gennia.ai/public/api/v1/billing/plans/{planPublicId}")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gennia.ai/public/api/v1/billing/plans/{planPublicId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"activeSubscriptions": 123,
"billingIntervalMonths": 123,
"checkoutUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"creditPackage": {
"creditValueCents": 123,
"creditsAmount": 123,
"extraCreditsAmount": 123,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"renewalIntervalMonths": 123
},
"currency": "<string>",
"description": "<string>",
"extraCreditsEnabled": true,
"extraCreditsPriceCents": 123,
"formattedPrice": "<string>",
"hubPackage": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seatsIncluded": 123,
"unlimitedCredits": true,
"visible": true,
"widgetCtaText": "<string>",
"widgetDescription": "<string>",
"widgetFeatures": [
{
"included": true,
"text": "<string>"
}
],
"widgetHighlighted": true,
"widgetTitle": "<string>"
}{
"activeSubscriptions": 123,
"billingIntervalMonths": 123,
"checkoutUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"creditPackage": {
"creditValueCents": 123,
"creditsAmount": 123,
"extraCreditsAmount": 123,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"renewalIntervalMonths": 123
},
"currency": "<string>",
"description": "<string>",
"extraCreditsEnabled": true,
"extraCreditsPriceCents": 123,
"formattedPrice": "<string>",
"hubPackage": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seatsIncluded": 123,
"unlimitedCredits": true,
"visible": true,
"widgetCtaText": "<string>",
"widgetDescription": "<string>",
"widgetFeatures": [
{
"included": true,
"text": "<string>"
}
],
"widgetHighlighted": true,
"widgetTitle": "<string>"
}{
"activeSubscriptions": 123,
"billingIntervalMonths": 123,
"checkoutUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"creditPackage": {
"creditValueCents": 123,
"creditsAmount": 123,
"extraCreditsAmount": 123,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"renewalIntervalMonths": 123
},
"currency": "<string>",
"description": "<string>",
"extraCreditsEnabled": true,
"extraCreditsPriceCents": 123,
"formattedPrice": "<string>",
"hubPackage": {
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seatsIncluded": 123,
"unlimitedCredits": true,
"visible": true,
"widgetCtaText": "<string>",
"widgetDescription": "<string>",
"widgetFeatures": [
{
"included": true,
"text": "<string>"
}
],
"widgetHighlighted": true,
"widgetTitle": "<string>"
}
