List invoices

GET

/v1/invoices

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://api.feitpay.com/v1/invoices?limit=25"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Gryphem-Environment", "test")
  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://api.feitpay.com/v1/invoices?limit=25';
const options = {
  method: 'GET',
  headers: {'Gryphem-Environment': 'test', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.feitpay.com/v1/invoices?limit=25' \
  --header 'Authorization: Bearer <token>' \
  --header 'Gryphem-Environment: test'

Authorizations

ApiKey
Session

Parameters

Header Parameters

Gryphem-Organization

string

Active organization for dashboard sessions. Ignored for API keys (the key determines the organization).

Gryphem-Environment

string

default: test

Allowed values: test live

test (default) or live for dashboard sessions. API keys determine the environment.

Query Parameters

limit

integer

default: 25 >= 1 <= 100

starting_after

string

Cursor — the id of the last item from the previous page.

store_id

string

search

string

Responses

200

Invoices.

application/json

object

object

required

string

Allowed value: list

data

required

Array<object>

object

required

string

object

required

string

Allowed value: invoice

livemode

required

boolean

number

required

string

store_id

required

string

status

required

string

Allowed values: open paid partially_paid expired void review

currency

required

string

subtotal

required

Decimal string. Never a float.

string

/^(0|[1-9][0-9]*)(\.[0-9]+)?$/

total

required

Decimal string. Never a float.

string

/^(0|[1-9][0-9]*)(\.[0-9]+)?$/

customer

required

object

name

required

string | null

email

required

string | null

reference

required

string | null

items

required

Array<object>

object

description

required

string

quantity

required

integer

unit_amount

required

Decimal string. Never a float.

string

/^(0|[1-9][0-9]*)(\.[0-9]+)?$/

amount

required

Decimal string. Never a float.

string

/^(0|[1-9][0-9]*)(\.[0-9]+)?$/

memo

required

string | null

due_at

required

string | null format: date-time

payment_intent_id

required

string | null

payment_status

required

One of:

string
null

string

Allowed values: created awaiting_payment detected confirming confirmed underpaid overpaid expired late_payment reorged manual_review resolved failed canceled

checkout_url

required

string | null

metadata

required

object

<= 20 properties

key

additional properties

string

<= 500 characters

created_at

required

string format: date-time

voided_at

required

string | null format: date-time

has_more

required

boolean

next_cursor

required

string | null

Example

{
  "object": "list",
  "data": [
    {
      "object": "invoice",
      "status": "open",
      "subtotal": "59.90",
      "total": "59.90",
      "items": [
        {
          "unit_amount": "59.90",
          "amount": "59.90"
        }
      ],
      "payment_status": "created"
    }
  ]
}

401

Missing or invalid credentials.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

403

Authenticated but not permitted.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

429

Too many requests. See Retry-After.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

Headers

Retry-After

integer