Skip to content
SolivioSolivioSolivio

Render a finalized offer as a PDF

GET
/api/offer-pdf/{offerId}
curl --request GET \
  --url 'https://example.com/api/offer-pdf/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?download=1' \
  --cookie better-auth.session_token=<better-auth.session_token>

Loads the offer by id and renders it. Available when this module is the bound offer channel.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
offerId
required
string format: uuid

Query Parameters

Section titled “ Query Parameters ”
download
string
Allowed values: 1

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

The rendered offer document.

Media typeapplication/pdf

401

Section titled “ 401 ”

No valid Better Auth session was present.

Media typeapplication/json

Returned when no valid Better Auth session is present.

object
error
required
string
Examplegenerated
{
  "error": "example"
}

404

Section titled “ 404 ”

The offer was not found.

Media typeapplication/json

Standard API error payload.

object
error
required
object
code
required
string
message
required
string
issues
Array<string>
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "issues": [
      "example"
    ]
  }
}