The identifier of the invoice.
GET
/user/v1/invoices/{invoiceId}Get an invoice
Retrieves specified invoice.
Returns
curl https://api.userhub.com/user/v1/invoices/in_4QPqKvtqkpJzP7 \
-H "UserHub-Api-Key: $USER_API_KEY" \
-H "Authorization: Bearer $USER_ACCESS_TOKEN"
const res = await userApi.invoices.get(
"in_4QPqKvtqkpJzP7",
);
res, err := userApi.Invoices().Get(
context.Background(),
"in_4QPqKvtqkpJzP7",
nil,
)
$res = $userApi->invoices->get(
invoiceId: 'in_4QPqKvtqkpJzP7',
);
res = user_api.invoices.get(
invoice_id="in_4QPqKvtqkpJzP7",
)
Response bodyJSON
{
"id": "in_4QPqKvtqkpJzP7",
"state": "OPEN",
"stateTime": null,
"number": "ACME-123",
"currencyCode": "USD",
"description": "This is a test.",
"account": {
"fullName": "Jane Doe",
"email": "[email protected]",
"phoneNumber": "+12125550123",
"address": {
"lines": [
"42 West St"
],
"city": "Brooklyn",
"state": "NY",
"postalCode": "11222",
"country": "US"
}
},
"effectiveTime": "2024-06-15T13:00:00Z",
"period": {
"startTime": "2024-06-15T13:00:00Z",
"endTime": "2024-06-15T13:00:00Z"
},
"subtotalAmount": "9",
"discountAmount": "1",
"balance": {
"startAmount": "100",
"endAmount": "200",
"appliedAmount": "-100"
},
"taxAmount": "2",
"dueAmount": "10",
"dueTime": "2024-06-15T13:00:00Z",
"paidAmount": "0",
"paymentIntent": null,
"items": [
{
"id": "ii_35kH3awC",
"product": null,
"price": null,
"quantity": 2,
"subtotalAmount": "10",
"discountAmount": "1",
"description": "This is a test item.",
"period": null
}
],
"changes": [],
"createTime": "2024-06-15T13:00:00Z",
"updateTime": "2024-06-15T13:00:00Z"
}