View invoices in your account
Unless otherwise specified, all routes return the following data structure in the data key.
| Name | Type | Description |
|---|---|---|
id |
Integer | Invoice ID |
status |
String | Invoice status: typically 'open', 'closed', or 'paid' |
amount |
String | Invoice amount, in USD |
due_date |
Datetime | Date invoice is due, or null |
resource_type |
String | 'Account' or 'Project' depending on billing setup |
resource_id |
String | ID of billable Account or Project |
resource_name |
String | Name of billable Account or Project |
created_at |
String | First invoice activity date |
updated_at |
String | Last invoice activity date |
paid_at |
String | If paid, date that the invoice was paid |
closed_at |
String | If closed or paid, date that the invoice was closed |
GET https://api.3playmedia.com/v3/admin/invoices/
| Parameter | Type | Description | Required | Default |
|---|---|---|---|---|
id |
Integer or Array<Integer> | Filter Invoices by id(s) | No | no default |
project_id |
Integer | (Project billing only) Project ID to view invoices within | No | no default |
billing_type |
String | Filter Invoices by billing type (useful if billling setup has recently changed) | No | no default |
status |
String or Array<String> | Filter Invoices by status | No | no default |
created_before |
Datetime(rfc3339) | Filter Invoices by created_at | No | no default |
created_after |
Datetime(rfc3339) | Filter Invoices by created_at | No | no default |
paid_before |
Datetime(rfc3339) | Filter Invoices by paid_at | No | no default |
paid_after |
Datetime(rfc3339) | Filter Invoices by paid_at | No | no default |
closed_before |
Datetime(rfc3339) | Filter Invoices closed_at | No | no default |
closed_after |
Datetime(rfc3339) | Filter Invoices by closed_at | No | no default |
GET https://api.3playmedia.com/v3/admin/invoices/current
GET https://api.3playmedia.com/v3/admin/invoices/:id
GET https://api.3playmedia.com/v3/admin/invoices/current/line_items
GET https://api.3playmedia.com/v3/admin/invoices/:id/line_items
This action is deprecated: see the Invoice Line Item resource instead