Create Invoice

POST

api

invoices

curl --request POST \
  --url https://app.flowglad.com/api/v1/invoices \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "invoice": {
    "purchaseId": "<string>",
    "invoiceNumber": "<string>",
    "invoiceDate": "2023-11-07T05:31:56Z",
    "billingPeriodId": "null",
    "dueDate": "2023-11-07T05:31:56Z",
    "customerId": "<string>",
    "status": "draft",
    "billingInterval": "day",
    "subscriptionId": "null",
    "billingPeriodStartDate": "2023-11-07T05:31:56Z",
    "billingPeriodEndDate": "2023-11-07T05:31:56Z",
    "billingIntervalCount": 123,
    "billingAnchorDate": "2023-11-07T05:31:56Z",
    "ownerMembershipId": "<string>",
    "pdfURL": "<string>",
    "receiptPdfURL": "<string>",
    "memo": "<string>",
    "bankPaymentOnly": true,
    "type": "purchase",
    "currency": "USD",
    "subtotal": 123,
    "taxType": "amusement_tax",
    "taxCountry": "AF",
    "taxState": "<string>"
  },
  "invoiceLineItems": [
    {
      "invoiceId": "<string>",
      "quantity": 123,
      "priceId": "<string>",
      "description": "<string>",
      "price": 123
    }
  ],
  "autoSend": true
}'

{
  "invoice": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "livemode": true,
    "purchaseId": "<string>",
    "invoiceNumber": "<string>",
    "invoiceDate": "2023-11-07T05:31:56Z",
    "billingPeriodId": "null",
    "dueDate": "2023-11-07T05:31:56Z",
    "customerId": "<string>",
    "organizationId": "<string>",
    "status": "draft",
    "billingInterval": "day",
    "subscriptionId": "null",
    "billingPeriodStartDate": "2023-11-07T05:31:56Z",
    "billingPeriodEndDate": "2023-11-07T05:31:56Z",
    "billingIntervalCount": 123,
    "billingAnchorDate": "2023-11-07T05:31:56Z",
    "ownerMembershipId": "<string>",
    "pdfURL": "<string>",
    "receiptPdfURL": "<string>",
    "memo": "<string>",
    "bankPaymentOnly": true,
    "type": "purchase",
    "currency": "USD",
    "taxAmount": 123,
    "subtotal": 123,
    "taxType": "amusement_tax",
    "taxCountry": "AF",
    "taxState": "<string>",
    "taxRatePercentage": "<string>",
    "applicationFee": 123
  },
  "invoiceLineItems": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "livemode": true,
      "invoiceId": "<string>",
      "quantity": 123,
      "priceId": "<string>",
      "description": "<string>",
      "price": 123
    }
  ],
  "autoSend": true
}

Authorizations

Authorization

string

header

required

Body

application/json

invoice

object

required

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.

invoice.purchaseId

string

required

invoice.invoiceNumber

string

required

invoice.billingPeriodId

enum<string> | null

required

Available options:

null

invoice.customerId

string

required

invoice.subscriptionId

enum<string> | null

required

Available options:

null

invoice.type

enum<string>

required

Available options:

purchase

invoice.currency

enum<string>

required

Available options:

USD,

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLP,

CNY,

COP,

CRC,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HTG,

HUF,

IDR,

ILS,

INR,

ISK,

JMD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLE,

SOS,

SRD,

STD,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

invoice.invoiceDate

string

invoice.dueDate

string | null

invoice.status

enum<string>

Available options:

draft,

open,

paid,

uncollectible,

void,

refunded,

partially_refunded,

awaiting_payment_confirmation

invoice.billingInterval

enum<string> | null

Available options:

day,

week,

month,

year

invoice.billingPeriodStartDate

string | null

invoice.billingPeriodEndDate

string | null

invoice.billingIntervalCount

number | null

invoice.billingAnchorDate

string | null

invoice.ownerMembershipId

string | null

invoice.pdfURL

string | null

invoice.receiptPdfURL

string | null

invoice.memo

string | null

invoice.bankPaymentOnly

boolean | null

invoice.subtotal

number | null

invoice.taxType

enum<string> | null

Available options:

amusement_tax,

communications_tax,

gst,

hst,

igst,

jct,

lease_tax,

pst,

qst,

rst,

sales_tax,

vat,

none

invoice.taxCountry

enum<string> | null

Available options:

AF,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

CI,

HR,

CU,

CY,

CZ,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IL,

IT,

JM,

JP,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

ME,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RE,

RO,

RU,

RW,

SH,

KN,

LC,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SK,

SI,

SB,

SO,

ZA,

GS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW

invoice.taxState

string | null

invoiceLineItems

object[]

required

autoSend

boolean

Response

200

application/json

Successful response

invoice

object

required

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.

invoice.id

string

required

invoice.createdAt

string

required

invoice.updatedAt

string | null

required

invoice.livemode

boolean

required

invoice.purchaseId

string

required

invoice.invoiceNumber

string

required

invoice.invoiceDate

string

required

invoice.billingPeriodId

enum<string> | null

required

Available options:

null

invoice.dueDate

string | null

required

invoice.customerId

string

required

invoice.organizationId

string

required

invoice.status

enum<string>

required

Available options:

draft,

open,

paid,

uncollectible,

void,

refunded,

partially_refunded,

awaiting_payment_confirmation

invoice.billingInterval

enum<string> | null

required

Available options:

day,

week,

month,

year

invoice.subscriptionId

enum<string> | null

required

Available options:

null

invoice.billingPeriodStartDate

string | null

required

invoice.billingPeriodEndDate

string | null

required

invoice.billingIntervalCount

number | null

required

invoice.billingAnchorDate

string | null

required

invoice.ownerMembershipId

string | null

required

invoice.pdfURL

string | null

required

invoice.receiptPdfURL

string | null

required

invoice.memo

string | null

required

invoice.bankPaymentOnly

boolean | null

required

invoice.type

enum<string>

required

Available options:

purchase

invoice.currency

enum<string>

required

Available options:

USD,

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLP,

CNY,

COP,

CRC,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HTG,

HUF,

IDR,

ILS,

INR,

ISK,

JMD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLE,

SOS,

SRD,

STD,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

invoice.taxAmount

number | null

required

invoice.subtotal

number | null

required

invoice.taxType

enum<string> | null

required

Available options:

amusement_tax,

communications_tax,

gst,

hst,

igst,

jct,

lease_tax,

pst,

qst,

rst,

sales_tax,

vat,

none

invoice.taxCountry

enum<string> | null

required

Available options:

AF,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

CI,

HR,

CU,

CY,

CZ,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IL,

IT,

JM,

JP,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

ME,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RE,

RO,

RU,

RW,

SH,

KN,

LC,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SK,

SI,

SB,

SO,

ZA,

GS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW

invoice.taxState

string | null

required

invoice.taxRatePercentage

string | null

required

invoice.applicationFee

number | null

required

invoiceLineItems

object[]

required

autoSend

boolean

List Invoices Get Invoice

curl --request POST \
  --url https://app.flowglad.com/api/v1/invoices \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "invoice": {
    "purchaseId": "<string>",
    "invoiceNumber": "<string>",
    "invoiceDate": "2023-11-07T05:31:56Z",
    "billingPeriodId": "null",
    "dueDate": "2023-11-07T05:31:56Z",
    "customerId": "<string>",
    "status": "draft",
    "billingInterval": "day",
    "subscriptionId": "null",
    "billingPeriodStartDate": "2023-11-07T05:31:56Z",
    "billingPeriodEndDate": "2023-11-07T05:31:56Z",
    "billingIntervalCount": 123,
    "billingAnchorDate": "2023-11-07T05:31:56Z",
    "ownerMembershipId": "<string>",
    "pdfURL": "<string>",
    "receiptPdfURL": "<string>",
    "memo": "<string>",
    "bankPaymentOnly": true,
    "type": "purchase",
    "currency": "USD",
    "subtotal": 123,
    "taxType": "amusement_tax",
    "taxCountry": "AF",
    "taxState": "<string>"
  },
  "invoiceLineItems": [
    {
      "invoiceId": "<string>",
      "quantity": 123,
      "priceId": "<string>",
      "description": "<string>",
      "price": 123
    }
  ],
  "autoSend": true
}'

{
  "invoice": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "livemode": true,
    "purchaseId": "<string>",
    "invoiceNumber": "<string>",
    "invoiceDate": "2023-11-07T05:31:56Z",
    "billingPeriodId": "null",
    "dueDate": "2023-11-07T05:31:56Z",
    "customerId": "<string>",
    "organizationId": "<string>",
    "status": "draft",
    "billingInterval": "day",
    "subscriptionId": "null",
    "billingPeriodStartDate": "2023-11-07T05:31:56Z",
    "billingPeriodEndDate": "2023-11-07T05:31:56Z",
    "billingIntervalCount": 123,
    "billingAnchorDate": "2023-11-07T05:31:56Z",
    "ownerMembershipId": "<string>",
    "pdfURL": "<string>",
    "receiptPdfURL": "<string>",
    "memo": "<string>",
    "bankPaymentOnly": true,
    "type": "purchase",
    "currency": "USD",
    "taxAmount": 123,
    "subtotal": 123,
    "taxType": "amusement_tax",
    "taxCountry": "AF",
    "taxState": "<string>",
    "taxRatePercentage": "<string>",
    "applicationFee": 123
  },
  "invoiceLineItems": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "livemode": true,
      "invoiceId": "<string>",
      "quantity": 123,
      "priceId": "<string>",
      "description": "<string>",
      "price": 123
    }
  ],
  "autoSend": true
}

API Documentation

Payments

Checkout Sessions

Products

Prices

Customer

Discounts

Invoice Line Items

Invoices

Catalogs

Subscriptions

PaymentMethods

UsageEvents

Authorizations

Body

Response