Billing
billing

Get Billing Contract

Changed on

Get the billing contract for the customer.

Admin only endpoint.

get/billing/contract

Request

  • Base URL: https://api.openintake.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.openintake.ai/billing/contract
  • Auth: none declared

Response

Successful Response

billing_contract_idstring uuid required
customer_idstring uuid required
start_datestring date-time nullable

NULL while billing_start_pending — billing has not started

number_of_monthsinteger nullable

NULL means month-to-month: no fixed term

billing_start_pendingboolean

Billing is on hold until the customer starts taking real calls; nothing is billed

created_atstring date-time required
updated_atstring date-time required
end_datestring date-time nullable

Computed: start_date + number_of_months; NULL when month-to-month or pending

is_activeboolean required

Changes

  • d443593f5f45Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      response property end_date list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property number_of_months list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property start_date list-of-types was widened by adding types null to media type application/json of response 200

    • info

      added the optional property to the response with the status