GET
/
invoices
/
{id}
curl --request GET \
  --url https://sandbox-api.billingrails.com/v1/invoices/{id} \
  --header 'Authorization: Bearer <token>'
{
  "invoice": {
    "object": "invoice",
    "id": "inv_IhMUl3rrZ3",
    "created_at": "2025-02-14T17:33:40.843Z",
    "account_id": "acc_IhMUl3rrZ3",
    "subscription_id": "sub_IhMUl3rrZ3",
    "number": "INV-0001",
    "status": "draft",
    "currency": "NGN",
    "collection_method": "manual",
    "due_at": "2025-02-14T17:33:40.843Z",
    "issued_at": "2025-02-14T17:33:40.843Z",
    "credit_amount": 0,
    "subtotal_amount": 1000,
    "total_amount": 1000,
    "paid_amount": 0,
    "outstanding_amount": 1000,
    "billing_start": "2025-02-14T17:33:40.843Z",
    "billing_end": "2025-02-14T17:33:40.843Z",
    "pdf_url": "https://billingrails.com/invoices/INV-0001.pdf",
    "items": [
      {
        "object": "invoice_line_item",
        "entity_id": "fee_IhMUl3rrZ3",
        "id": "item_IhMUl3rrZ3",
        "description": "Basic Plan",
        "quantity": 1,
        "unit_amount": 1000,
        "subtotal_amount": 1000,
        "total_amount": 1000,
        "billing_start": "2025-02-14T17:33:40.843Z",
        "billing_end": "2025-02-14T17:33:40.843Z",
        "proration": null
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Response

200 - application/json

Success

The response is of type object.