Skip to content

Download the invoice PDF of a patent event ​

GET /api/v2/external/patents/{patentId}/events/{eventId}/documents/invoice

Authentication: x-api-key header, with the patents:read scope. See Authentication and limits.

Returns the invoice PDF for a patent event, identified by the patent UUID and the event UUID. Responds 404 until the event has been invoiced.

Path parameters ​

NameTypeRequiredDescription
eventIdstringYesThe opaque, stable Renewr UUID of the patent event.
patentIdstringYesThe opaque, stable Renewr UUID of the patent.

Response ​

200 The invoice PDF file (attachment, RFC 6266 Content-Disposition).

The response is a binary PDF stream (application/pdf), delivered as an attachment with an RFC 6266 Content-Disposition filename. See Downloading documents.

Errors ​

Errors use the application/problem+json envelope with stable machine-readable codes. See the Errors guide.

StatusDescription
400Validation failed (validation_failed): carries per-field errors[] with RFC 6901 JSON Pointers.
401Missing or invalid API key (invalid_api_key), or expired key (api_key_expired).
403API key lacks the required scope (insufficient_scope, with requiredScope extension) or the operation is not enabled for this client (forbidden).
404The resource does not exist in your portfolio (not_found).
429Daily API call limit exceeded (rate_limit_exceeded): the Retry-After header gives the seconds until reset.

Example request ​

bash
curl "https://api.renewr.example/api/v2/external/patents/$PATENT_ID/events/$EVENT_ID/documents/invoice" \
  -H "x-api-key: $RENEWR_API_KEY"

Renewr External API v2. Access on invitation.