Get Invoice
curl --request GET \
--url https://app.flowglad.com/api/v1/invoices/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://app.flowglad.com/api/v1/invoices/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://app.flowglad.com/api/v1/invoices/{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://app.flowglad.com/api/v1/invoices/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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://app.flowglad.com/api/v1/invoices/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<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://app.flowglad.com/api/v1/invoices/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.flowglad.com/api/v1/invoices/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"invoice": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"purchaseId": "<string>",
"invoiceNumber": "<string>",
"invoiceDate": 0,
"customerId": "<string>",
"organizationId": "<string>",
"billingRunId": "<string>",
"ownerMembershipId": "<string>",
"memo": "<string>",
"bankPaymentOnly": true,
"type": "<string>",
"taxAmount": -1,
"subtotal": -1,
"taxState": "<string>",
"taxRatePercentage": "<string>",
"applicationFee": -1,
"pricingModelId": "<string>",
"billingPeriodId": null,
"dueDate": 0,
"subscriptionId": null,
"billingPeriodStartDate": null,
"billingPeriodEndDate": null,
"pdfURL": "<string>",
"receiptPdfURL": "<string>"
},
"invoiceLineItems": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"invoiceId": "<string>",
"quantity": -1,
"priceId": "<string>",
"description": "<string>",
"price": -1,
"type": "<string>",
"pricingModelId": "<string>",
"ledgerAccountId": null,
"ledgerAccountCredit": null
}
]
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Invoices
Get Invoice
GET
/
api
/
v1
/
invoices
/
{id}
Get Invoice
curl --request GET \
--url https://app.flowglad.com/api/v1/invoices/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://app.flowglad.com/api/v1/invoices/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://app.flowglad.com/api/v1/invoices/{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://app.flowglad.com/api/v1/invoices/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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://app.flowglad.com/api/v1/invoices/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<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://app.flowglad.com/api/v1/invoices/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.flowglad.com/api/v1/invoices/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"invoice": {
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"purchaseId": "<string>",
"invoiceNumber": "<string>",
"invoiceDate": 0,
"customerId": "<string>",
"organizationId": "<string>",
"billingRunId": "<string>",
"ownerMembershipId": "<string>",
"memo": "<string>",
"bankPaymentOnly": true,
"type": "<string>",
"taxAmount": -1,
"subtotal": -1,
"taxState": "<string>",
"taxRatePercentage": "<string>",
"applicationFee": -1,
"pricingModelId": "<string>",
"billingPeriodId": null,
"dueDate": 0,
"subscriptionId": null,
"billingPeriodStartDate": null,
"billingPeriodEndDate": null,
"pdfURL": "<string>",
"receiptPdfURL": "<string>"
},
"invoiceLineItems": [
{
"id": "<string>",
"createdAt": 0,
"updatedAt": 0,
"livemode": true,
"invoiceId": "<string>",
"quantity": -1,
"priceId": "<string>",
"description": "<string>",
"price": -1,
"type": "<string>",
"pricingModelId": "<string>",
"ledgerAccountId": null,
"ledgerAccountCredit": null
}
]
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Authorizations
Path Parameters
Response
Successful response
An invoice record, which describes a bill that can be associated with a purchase, subscription, or stand alone. Each invoice has a specific type that determines its behavior and required fields.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Was this page helpful?
⌘I