Billing
billing

Update Contract Developer

Changed on

Update an existing billing contract (developer only).

put/billing/developer/contracts/{contract_id}

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/developer/contracts/{contract_id}
  • Auth: none declared

Path parameters

contract_idstring uuid required

Request body

start_datestring date-time nullable

Omit only when billing_start_pending is set

number_of_monthsinteger nullable

Contract length in months; omit for a month-to-month contract

billing_start_pendingboolean

Hold billing until the customer starts taking real calls; requires no start_date

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

    • 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 new optional request property

    • info

      the request property became optional

    • info

      the request property became optional

    • info

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

    • info

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

    • info

      added the optional property to the response with the status