List payment receipts

Your organization’s payments with their Stripe receipts, for bookkeeping.

GET /api/v1/receipts. The fields, answers and errors below are rendered from the OpenAPI document.

List payment receipts

GET /api/v1/receipts

Your organization’s payments, newest first: credit purchases, auto-recharges and refunds, each with its Stripe receipt (receipt_url, downloadable as a PDF), for bookkeeping. Any API key of the organization can read them. A receipt link opens for anyone who has it and shows the buyer’s email, billing address and the card’s last four digits, so treat the links like the receipts themselves. amount_usd is the credit before tax; the receipt shows the tax paid. Free.

Parameters

  • from (query, optional)

    The earliest payment date (ISO date or date-time, inclusive).

    string

  • to (query, optional)

    The date the period ends (ISO date or date-time, exclusive).

    string

  • limit (query, optional)

    At most this many payments (default 100).

    integer

    Minimum
    1
    Maximum
    300

Responses

Response 200

The payments, newest first.

application/json

object

  • receipts (required)

    array

    Array items:

    object

    • id (required)

      number

    • created_at (required)

      string

    • kind (required)

      string

      Allowed values
      ["purchase","auto_recharge","refund"]
    • amount_usd (required)

      number

      The credit added in USD, before tax (negative for a refund).

    • description (required)

      string | null

    • receipt_url (required)

      string | null

      Stripe's receipt; null when Stripe gave none.

    Additional properties: not allowed.

Additional properties: not allowed.

Response 400

The request is invalid; the message says which field and why.

application/json

Error

object

  • error (required)

    object

    • type (required)

      string

      Allowed values
      ["invalid_request","authentication","insufficient_credit","model_unavailable","model_warming","free_capacity_busy","too_many_overlap_pairs","too_many_records","revision_conflict","rate_limited","server_error"]
    • message (required)

      string

Response 401

No valid API key.

application/json

Error

object

  • error (required)

    object

    • type (required)

      string

      Allowed values
      ["invalid_request","authentication","insufficient_credit","model_unavailable","model_warming","free_capacity_busy","too_many_overlap_pairs","too_many_records","revision_conflict","rate_limited","server_error"]
    • message (required)

      string

Response 402

No free decisions or credit left for the request.

application/json

Error

object

  • error (required)

    object

    • type (required)

      string

      Allowed values
      ["invalid_request","authentication","insufficient_credit","model_unavailable","model_warming","free_capacity_busy","too_many_overlap_pairs","too_many_records","revision_conflict","rate_limited","server_error"]
    • message (required)

      string

Response 403

Only the person who made the decision, or the API key it was made with, can change who sees it or publish it.

application/json

Error

object

  • error (required)

    object

    • type (required)

      string

      Allowed values
      ["invalid_request","authentication","insufficient_credit","model_unavailable","model_warming","free_capacity_busy","too_many_overlap_pairs","too_many_records","revision_conflict","rate_limited","server_error"]
    • message (required)

      string

Response 409

The model is not served yet, or the revised decision already has a newer revision.

application/json

Error

object

  • error (required)

    object

    • type (required)

      string

      Allowed values
      ["invalid_request","authentication","insufficient_credit","model_unavailable","model_warming","free_capacity_busy","too_many_overlap_pairs","too_many_records","revision_conflict","rate_limited","server_error"]
    • message (required)

      string

Response 410

No such decision that you can see: none in your organization, or one not shared with you.

application/json

Error

object

  • error (required)

    object

    • type (required)

      string

      Allowed values
      ["invalid_request","authentication","insufficient_credit","model_unavailable","model_warming","free_capacity_busy","too_many_overlap_pairs","too_many_records","revision_conflict","rate_limited","server_error"]
    • message (required)

      string

Response 429

Rate limit reached (see Retry-After), or your organization already has 3 Default mode decisions running; send it when one is done.

application/json

Error

object

  • error (required)

    object

    • type (required)

      string

      Allowed values
      ["invalid_request","authentication","insufficient_credit","model_unavailable","model_warming","free_capacity_busy","too_many_overlap_pairs","too_many_records","revision_conflict","rate_limited","server_error"]
    • message (required)

      string

Response 502

The model failed to answer, or the decision could not be completed. Nothing is billed.

application/json

Error

object

  • error (required)

    object

    • type (required)

      string

      Allowed values
      ["invalid_request","authentication","insufficient_credit","model_unavailable","model_warming","free_capacity_busy","too_many_overlap_pairs","too_many_records","revision_conflict","rate_limited","server_error"]
    • message (required)

      string

Response 503

The model is starting after being idle, or a request on free decisions found it busy (free_capacity_busy); retry after Retry-After seconds. Nothing is billed.

application/json

Error

object

  • error (required)

    object

    • type (required)

      string

      Allowed values
      ["invalid_request","authentication","insufficient_credit","model_unavailable","model_warming","free_capacity_busy","too_many_overlap_pairs","too_many_records","revision_conflict","rate_limited","server_error"]
    • message (required)

      string

List payment receipts: examples

Request example

curl -X GET 'https://eevo.io/api/v1/receipts' \
  -H "Authorization: Bearer $EEVO_API_KEY"

Response 200 example

{
  "receipts": [
    {
      "id": 0,
      "created_at": "string",
      "kind": "purchase",
      "amount_usd": 0,
      "description": "string",
      "receipt_url": "string"
    }
  ]
}