Skip to content

Get Invoice

Endpoint: https://api.youcan.shop/invoices/{id}

Method: GET

Required Scopes

  • read-invoices

URL Parameters

  • id: Invoice id

Response

[200]

json
{
    "id": "4ba03536-c86c-4fa8-af42-5f157e1aa726",
    "amount": 10,
    "paid_amount": 0,
    "status": "Pending",
    "payment_gateway": "Stripe",
    "description": "Bought credit $10",
    "created_at": "2024-08-26T10:25:14+00:00",
    "updated_at": "2024-08-26T10:25:14+00:00",
    "paid_at": null,
    "deleted_at": null,
    "links": {
        "pdf": "https://seller-area.youcan.shop/admin/invoices/4ba03536-c86c-4fa8-af42-5f157e1aa726/download"
    }
}

Errors

[404]

json
{
    "status": 404,
    "detail": "invoice not found",
    "meta": []
}

[500]

json
{
    "status": 500,
    "detail": "internal server error",
    "meta": []
}