Plandalf

Responses

Document API response structures and fields with Mintlify-compatible response components.

Use Responses to group the fields returned by an API call. It is the Mintlify-compatible container for ResponseField rows, nested response objects, and response examples.

Basic response field

responsestringrequired

A response field example.

<ResponseField name="response" type="string" required>
  A response field example.
</ResponseField>

Offer response

›totalsobject

Calculated totals returned for a checkout session.

totals.totalinteger

Final total in the smallest currency unit.

›offerobjectrequired

The offer returned by a catalog, checkout, or API call.

offer.idstringrequired

Stable offer identifier.

offer.slugstringoptional

Public slug when the offer has a hosted page.

Checkout blocks such as order bumps, add-ons, and save offers.

request_idstringoptional

Trace identifier returned for support and debugging.

<Responses title="Offer response" variant="list">
  <ResponseField name="totals" type="object" expandable defaultOpen>
    Calculated totals returned for a checkout session.
  </ResponseField>
  <ResponseField name="offer" type="object" required expandable defaultOpen>
    The offer returned by the API.
    <ResponseField name="offer.id" type="string" required>
      Stable offer identifier.
    </ResponseField>
  </ResponseField>
</Responses>

Response example

Request / response

200 offer

Response 
{ "offer": { "id": "off_123" }, "request_id": "req_abc" }
ResponseField props Document response object shapes, nested fields, and returned data.
API examples Pair request and response examples with endpoint-aware docs pages.

Feature detail