Retrieve a booking's billing preferences

Returns a booking’s billing preferences under order.billing_preferences.

GET /booking/{booking_id}/billing_preferences

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/booking/BOOKING_ID/billing_preferences" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "order": {
    "billing_preferences": {
      "billing_period": "<string>",
      "communication_profile": "<string>",
      "consolidate_invoice": true,
      "fulfillment_mode": "<string>",
      "fulfillment_term": "<string>",
      "invoice_mode": "<string>",
      "invoice_term": "<string>",
      "payment_mode": "<string>",
      "payment_processor": "<string>",
      "payment_term": "<string>",
      "payment_term_alignment": "<string>",
      "proforma_properties": {
        "acceptance_date": null,
        "acceptance_required": true,
        "acceptance_term": null,
        "payment_required": true,
        "terms_and_conditions": null
      }
    },
    "object": "<string>"
  }
}

Returns the invoice, payment and fulfillment settings of one booking, such as invoice_mode, payment_term and billing_period, under order.billing_preferences.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

booking_id · string · required

The booking's id. Any order's id works here, whatever the order's type.

Response

200 - application/json

The billing preferences, under order.

order · object · required

Show child attributes