Skip to content

List Stripe invoices for the authenticated account, newest first.

GET
/account/invoices
curl --request GET \
  --url https://api.pingram.io/account/invoices \
  --header 'Authorization: Bearer <token>'

Authorizations

Parameters

Query Parameters

limit
number

Max invoices to return (1-100, default 10)

startingAfter
string

Pagination cursor (invoice id from a previous response)

status
string

Filter by status

createdAfter
string

Inclusive lower bound (YYYY-MM-DD or unix seconds)

createdBefore
string

Inclusive upper bound (YYYY-MM-DD or unix seconds)

Responses

200

Successful response

Media typeapplication/json

GET /account/invoices response.

object
invoices
required
Array<object>
object
id
required
string
number

Human-readable invoice number, when assigned.

string
status
string
Allowed values: draft open paid uncollectible void
currency
required
string
total
required

Total amount due on the invoice (cents).

number
amountDue
required
number
amountPaid
required
number
created
required

Unix timestamp (seconds) when the invoice was created.

number
hostedInvoiceUrl

Stripe-hosted invoice page (receipt / pay).

string
invoicePdf

Direct PDF download URL.

string
periodStart

Billing period start (unix seconds), when applicable.

number
periodEnd

Billing period end (unix seconds), when applicable.

number
hasMore
required

True when more invoices exist; pass the last invoice id as startingAfter.

boolean
Example
{
  "invoices": [
    {
      "status": "draft"
    }
  ]
}

400

Bad Request - validation errors, invalid input

Media typeapplication/json

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
Examplegenerated
{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

401

Unauthorized

402

Payment Required - usage limits exceeded

Media typeapplication/json

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
Examplegenerated
{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

500

Internal Server Error

502

Bad Gateway - provider error

Media typeapplication/json

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
Examplegenerated
{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}