Skip to main content
POST
/
invoices
Typescript (SDK)
import { Crevio } from "@crevio/sdk";

const crevio = new Crevio({
  apiKey: process.env["CREVIO_API_KEY"] ?? "",
});

async function run() {
  const result = await crevio.invoices.create({});

  console.log(result);
}

run();
curl --request POST \
--url https://api.crevio.co/v1/invoices \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"customer_name": "<string>",
"email_address": "<string>",
"description": "<string>",
"customer": "<string>",
"price_variant": "<string>",
"due_at": "2023-11-07T05:31:56Z"
}
'
import requests

url = "https://api.crevio.co/v1/invoices"

payload = {
"customer_name": "<string>",
"email_address": "<string>",
"description": "<string>",
"customer": "<string>",
"price_variant": "<string>",
"due_at": "2023-11-07T05:31:56Z"
}
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({
customer_name: '<string>',
email_address: '<string>',
description: '<string>',
customer: '<string>',
price_variant: '<string>',
due_at: '2023-11-07T05:31:56Z'
})
};

fetch('https://api.crevio.co/v1/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.crevio.co/v1/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_name' => '<string>',
'email_address' => '<string>',
'description' => '<string>',
'customer' => '<string>',
'price_variant' => '<string>',
'due_at' => '2023-11-07T05:31:56Z'
]),
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://api.crevio.co/v1/invoices"

payload := strings.NewReader("{\n \"customer_name\": \"<string>\",\n \"email_address\": \"<string>\",\n \"description\": \"<string>\",\n \"customer\": \"<string>\",\n \"price_variant\": \"<string>\",\n \"due_at\": \"2023-11-07T05:31:56Z\"\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://api.crevio.co/v1/invoices")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer_name\": \"<string>\",\n \"email_address\": \"<string>\",\n \"description\": \"<string>\",\n \"customer\": \"<string>\",\n \"price_variant\": \"<string>\",\n \"due_at\": \"2023-11-07T05:31:56Z\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.crevio.co/v1/invoices")

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 \"customer_name\": \"<string>\",\n \"email_address\": \"<string>\",\n \"description\": \"<string>\",\n \"customer\": \"<string>\",\n \"price_variant\": \"<string>\",\n \"due_at\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "object": "<string>",
  "number": "<string>",
  "description": "<string>",
  "customer_name": "<string>",
  "email_address": "<string>",
  "due_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "amount": 123,
  "currency": "<string>",
  "paid_at": "<string>",
  "price_variant": "<string>",
  "customer": "<string>",
  "order": "<string>"
}
{
"error": {
"type": "invalid_request_error",
"code": "bad_request",
"message": "The request was malformed or contained invalid parameters"
}
}
{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "You did not provide an API key."
}
}
{
"error": {
"type": "invalid_request_error",
"code": "forbidden",
"message": "You do not have permission to perform this action"
}
}
{
"error": {
"type": "validation_error",
"code": "validation_failed",
"message": "Email is required",
"errors": {
"email": [
"can't be blank"
]
}
}
}
{
"error": {
"type": "api_error",
"code": "internal_error",
"message": "An unexpected error occurred"
}
}

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Body

application/json
customer_name
string | null
email_address
string | null
description
string | null
customer
string | null

Customer ID

price_variant
string | null

Price variant ID

due_at
string<date-time>

Response

Invoice created

id
string
required
object
string
required
status
enum<string>
required
Available options:
open,
paid,
past_due,
void
number
string
required
description
string | null
required
customer_name
string | null
required
email_address
string | null
required
due_at
string<date-time>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
amount
number | null
required
currency
string | null
required
paid_at
string | null
required
price_variant
required

ID by default, full object when expanded

customer

ID by default, full object when expanded

order

ID by default, full object when expanded