Download OpenAPI specification:Download
Part of the REST API v2 Reference.
Operations about invoices.
GET /projects/{project_id}/customers/{customer_id}/invoicesGET /projects/{project_id}/customers/{customer_id}/invoices/{invoice_id}/fileThis endpoint requires the following permission(s): customer_information:invoices:read. This endpoint belongs to the Customer Information domain, which has a default rate limit of 480 requests per minute.
| project_id required | string <= 255 characters Example: proj1ab2c3d4 ID of the project |
| customer_id required | string [ 1 .. 1500 ] characters Example: 19b8de26-77c1-49f1-aa18-019a391603e2 ID of the customer |
| starting_after | string Example: starting_after=ent12354 Pagination cursor. Pass the id of the last item from the previous page to fetch the next page; omit for the first page. |
| limit | integer Default: 20 Example: limit=10 Maximum number of items to return per page. Values below 1 or above 100 are clamped to that range rather than rejected. |
{- "object": "list",
- "items": [
- {
- "object": "invoice",
- "id": "rcbin1a2b3c4d5e",
- "total_amount": {
- "currency": "USD",
- "gross": 9.99,
- "commission": 2.99,
- "tax": 0.75,
- "proceeds": 6.25
}, - "line_items": [
- {
- "object": "invoice.line_item",
- "product_identifier": "rc_1w_199",
- "product_display_name": "Premium Monthly 2023",
- "product_duration": "P1M",
- "quantity": 1,
- "unit_amount": {
- "currency": "USD",
- "gross": 9.99,
- "commission": 2.99,
- "tax": 0.75,
- "proceeds": 6.25
}
}
], - "issued_at": 1658399423658,
- "paid_at": 1658399423658,
}
], - "next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/invoices?starting_after=rcbin1a2b3c4d5e",
- "url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/invoices"
}This endpoint requires the following permission(s): customer_information:invoices:read. This endpoint belongs to the Customer Information domain, which has a default rate limit of 480 requests per minute.
| project_id required | string <= 255 characters Example: proj1ab2c3d4 ID of the project |
| customer_id required | string [ 1 .. 1500 ] characters Example: 19b8de26-77c1-49f1-aa18-019a391603e2 ID of the customer |
| invoice_id required | string [ 1 .. 1500 ] characters Example: rcbin1a2b3c4d5e ID of the invoice |
{- "object": "error",
- "type": "parameter_error",
- "param": "customer_id",
- "message": "id is too long",
- "retryable": false,
}All API v2 resources, one page each. General concepts (authentication, pagination, rate limits, error handling) live on the API v2 overview.