Lifecycle API

Get bill delivery options

Read delivery choices for an existing bill.

GEThttps://app.mindbill.org/partner/v2/bills/{billId}/delivery-options

Read delivery choices for an existing bill. Returns the top-level delivery object; 404 when unavailable.

AuthenticationServer API key or browser session + Origin

Permissions by credentialServer: bills:read · Browser: bills:read

IdempotencyNot required

Use this URL with a server API key or a browser session and its exact allowed Origin. Both credentials use the same request and response contract. See the component API inventory for exact paths and SDK methods.

Path parameters

FieldTypeDescription

billIdRequired

string

Resource identifier.

Examples

curl 'https://app.mindbill.org/partner/v2/bills/{billId}/delivery-options' \
  --request GET \
  --header "Authorization: Bearer $MINDBILL_API_KEY"

curl 'https://app.mindbill.org/partner/v2/bills/{billId}/delivery-options' \
  --request GET \
  --header "Authorization: Bearer $MINDBILL_BROWSER_TOKEN" \
  --header 'Origin: https://your-app.example'

Response

200

Response fields are documented below.

FieldTypeDescription

payerNameRequired

string

payerName

recommended

object

recommended

optionsRequired

object[]

options

contacts

object

contacts