Dots home pagelight logo
  1. Invoices
  2. Retrieve an Invoice

All requests to the /v2/invoice/* endpoints must include both the client_id and api_key as detailed in the Authentication document.

Get an invoice by its ID

​
Method

Make a request to /v2/invoice/get/

​
Request Example

curl https://pls.senddotssandbox.com/invoice/get/8f246ca0-4ade-4296-bab4-5a6d37d9af10 \
-H "Authorization: Basic <TOKEN>"

response = {
    "success": true,
    "invoice": {
        "id": "8f246ca0-4ade-4296-bab4-5a6d37d9af10",
         "payer": null,
        "api_app": {
            "id": "b7a00ae2-e638-4d66-9d46-adf38d810cde",
            "name": "Zappy",
            "user_id": 2
        },
        "amount": 800,
        "expiry": "2020-12-09T00:40:51.107Z",
        "status": "created",
        "link": "https://www.senddotssandbox.com/invoice/8f246ca0-4ade-4296-bab4-5a6d37d9af10",
        "items": [
            {
            "name": "Pikachu Digital Pet",
            "unit_amount": 250,
            "quantity": 1,
            "description": "A little Pikachu for your desktop"
            },
            {
            "name": "Charmander Digital Pet",
            "unit_amount": 225,
            "quantity": 2,
            "description": "A ferocius Charmander for your desktop"
            }
        ],
        "breakdown": {
            "items_total": 700,
            "tax": 100,
            "shipping": 0
        },
        "requested_information": {
            "shipping_address": null
        },
        "metadata": {
            "zappy_user_id": "61f8c2f8263e340016f4d4e8"
        }
    }
}