Update Billing Plan

cURL

curl --request PATCH \
  --url https://api.example.com/v2/billing-plans/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "is_active": true,
  "progressive_billing_threshold": "<string>",
  "grace_period_hours": -1,
  "late_ticket_grace_period_hours": -1,
  "progressive_grace_period_hours": -1,
  "payment_due_hours": -1,
  "effective_date": "2023-12-25",
  "payment_instructions": "<string>",
  "charges": [
    {
      "description": "<string>",
      "amount": "<string>",
      "id": 123,
      "filters": "<unknown>",
      "source_type": "<string>",
      "order": 1073741823,
      "display_aggregated_value": true,
      "display_rate_value": true
    }
  ]
}
'

import requests

url = "https://api.example.com/v2/billing-plans/{id}/"

payload = {
    "name": "<string>",
    "is_active": True,
    "progressive_billing_threshold": "<string>",
    "grace_period_hours": -1,
    "late_ticket_grace_period_hours": -1,
    "progressive_grace_period_hours": -1,
    "payment_due_hours": -1,
    "effective_date": "2023-12-25",
    "payment_instructions": "<string>",
    "charges": [
        {
            "description": "<string>",
            "amount": "<string>",
            "id": 123,
            "filters": "<unknown>",
            "source_type": "<string>",
            "order": 1073741823,
            "display_aggregated_value": True,
            "display_rate_value": True
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    is_active: true,
    progressive_billing_threshold: '<string>',
    grace_period_hours: -1,
    late_ticket_grace_period_hours: -1,
    progressive_grace_period_hours: -1,
    payment_due_hours: -1,
    effective_date: '2023-12-25',
    payment_instructions: '<string>',
    charges: [
      {
        description: '<string>',
        amount: '<string>',
        id: 123,
        filters: '<unknown>',
        source_type: '<string>',
        order: 1073741823,
        display_aggregated_value: true,
        display_rate_value: true
      }
    ]
  })
};

fetch('https://api.example.com/v2/billing-plans/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v2/billing-plans/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'is_active' => true,
    'progressive_billing_threshold' => '<string>',
    'grace_period_hours' => -1,
    'late_ticket_grace_period_hours' => -1,
    'progressive_grace_period_hours' => -1,
    'payment_due_hours' => -1,
    'effective_date' => '2023-12-25',
    'payment_instructions' => '<string>',
    'charges' => [
        [
                'description' => '<string>',
                'amount' => '<string>',
                'id' => 123,
                'filters' => '<unknown>',
                'source_type' => '<string>',
                'order' => 1073741823,
                'display_aggregated_value' => true,
                'display_rate_value' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v2/billing-plans/{id}/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"is_active\": true,\n  \"progressive_billing_threshold\": \"<string>\",\n  \"grace_period_hours\": -1,\n  \"late_ticket_grace_period_hours\": -1,\n  \"progressive_grace_period_hours\": -1,\n  \"payment_due_hours\": -1,\n  \"effective_date\": \"2023-12-25\",\n  \"payment_instructions\": \"<string>\",\n  \"charges\": [\n    {\n      \"description\": \"<string>\",\n      \"amount\": \"<string>\",\n      \"id\": 123,\n      \"filters\": \"<unknown>\",\n      \"source_type\": \"<string>\",\n      \"order\": 1073741823,\n      \"display_aggregated_value\": true,\n      \"display_rate_value\": true\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.example.com/v2/billing-plans/{id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"is_active\": true,\n  \"progressive_billing_threshold\": \"<string>\",\n  \"grace_period_hours\": -1,\n  \"late_ticket_grace_period_hours\": -1,\n  \"progressive_grace_period_hours\": -1,\n  \"payment_due_hours\": -1,\n  \"effective_date\": \"2023-12-25\",\n  \"payment_instructions\": \"<string>\",\n  \"charges\": [\n    {\n      \"description\": \"<string>\",\n      \"amount\": \"<string>\",\n      \"id\": 123,\n      \"filters\": \"<unknown>\",\n      \"source_type\": \"<string>\",\n      \"order\": 1073741823,\n      \"display_aggregated_value\": true,\n      \"display_rate_value\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/billing-plans/{id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"is_active\": true,\n  \"progressive_billing_threshold\": \"<string>\",\n  \"grace_period_hours\": -1,\n  \"late_ticket_grace_period_hours\": -1,\n  \"progressive_grace_period_hours\": -1,\n  \"payment_due_hours\": -1,\n  \"effective_date\": \"2023-12-25\",\n  \"payment_instructions\": \"<string>\",\n  \"charges\": [\n    {\n      \"description\": \"<string>\",\n      \"amount\": \"<string>\",\n      \"id\": 123,\n      \"filters\": \"<unknown>\",\n      \"source_type\": \"<string>\",\n      \"order\": 1073741823,\n      \"display_aggregated_value\": true,\n      \"display_rate_value\": true\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "fleet": 123,
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "is_active": true,
  "progressive_billing_threshold": "<string>",
  "grace_period_hours": -1,
  "late_ticket_grace_period_hours": -1,
  "progressive_grace_period_hours": -1,
  "payment_due_hours": -1,
  "effective_date": "2023-12-25",
  "payment_instructions": "<string>",
  "charges": [
    {
      "description": "<string>",
      "amount": "<string>",
      "id": 123,
      "filters": "<unknown>",
      "source_type": "<string>",
      "order": 1073741823,
      "display_aggregated_value": true,
      "display_rate_value": true
    }
  ]
}

PATCH

billing-plans

{id}

cURL

curl --request PATCH \
  --url https://api.example.com/v2/billing-plans/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "is_active": true,
  "progressive_billing_threshold": "<string>",
  "grace_period_hours": -1,
  "late_ticket_grace_period_hours": -1,
  "progressive_grace_period_hours": -1,
  "payment_due_hours": -1,
  "effective_date": "2023-12-25",
  "payment_instructions": "<string>",
  "charges": [
    {
      "description": "<string>",
      "amount": "<string>",
      "id": 123,
      "filters": "<unknown>",
      "source_type": "<string>",
      "order": 1073741823,
      "display_aggregated_value": true,
      "display_rate_value": true
    }
  ]
}
'

import requests

url = "https://api.example.com/v2/billing-plans/{id}/"

payload = {
    "name": "<string>",
    "is_active": True,
    "progressive_billing_threshold": "<string>",
    "grace_period_hours": -1,
    "late_ticket_grace_period_hours": -1,
    "progressive_grace_period_hours": -1,
    "payment_due_hours": -1,
    "effective_date": "2023-12-25",
    "payment_instructions": "<string>",
    "charges": [
        {
            "description": "<string>",
            "amount": "<string>",
            "id": 123,
            "filters": "<unknown>",
            "source_type": "<string>",
            "order": 1073741823,
            "display_aggregated_value": True,
            "display_rate_value": True
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    is_active: true,
    progressive_billing_threshold: '<string>',
    grace_period_hours: -1,
    late_ticket_grace_period_hours: -1,
    progressive_grace_period_hours: -1,
    payment_due_hours: -1,
    effective_date: '2023-12-25',
    payment_instructions: '<string>',
    charges: [
      {
        description: '<string>',
        amount: '<string>',
        id: 123,
        filters: '<unknown>',
        source_type: '<string>',
        order: 1073741823,
        display_aggregated_value: true,
        display_rate_value: true
      }
    ]
  })
};

fetch('https://api.example.com/v2/billing-plans/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v2/billing-plans/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'is_active' => true,
    'progressive_billing_threshold' => '<string>',
    'grace_period_hours' => -1,
    'late_ticket_grace_period_hours' => -1,
    'progressive_grace_period_hours' => -1,
    'payment_due_hours' => -1,
    'effective_date' => '2023-12-25',
    'payment_instructions' => '<string>',
    'charges' => [
        [
                'description' => '<string>',
                'amount' => '<string>',
                'id' => 123,
                'filters' => '<unknown>',
                'source_type' => '<string>',
                'order' => 1073741823,
                'display_aggregated_value' => true,
                'display_rate_value' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v2/billing-plans/{id}/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"is_active\": true,\n  \"progressive_billing_threshold\": \"<string>\",\n  \"grace_period_hours\": -1,\n  \"late_ticket_grace_period_hours\": -1,\n  \"progressive_grace_period_hours\": -1,\n  \"payment_due_hours\": -1,\n  \"effective_date\": \"2023-12-25\",\n  \"payment_instructions\": \"<string>\",\n  \"charges\": [\n    {\n      \"description\": \"<string>\",\n      \"amount\": \"<string>\",\n      \"id\": 123,\n      \"filters\": \"<unknown>\",\n      \"source_type\": \"<string>\",\n      \"order\": 1073741823,\n      \"display_aggregated_value\": true,\n      \"display_rate_value\": true\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.example.com/v2/billing-plans/{id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"is_active\": true,\n  \"progressive_billing_threshold\": \"<string>\",\n  \"grace_period_hours\": -1,\n  \"late_ticket_grace_period_hours\": -1,\n  \"progressive_grace_period_hours\": -1,\n  \"payment_due_hours\": -1,\n  \"effective_date\": \"2023-12-25\",\n  \"payment_instructions\": \"<string>\",\n  \"charges\": [\n    {\n      \"description\": \"<string>\",\n      \"amount\": \"<string>\",\n      \"id\": 123,\n      \"filters\": \"<unknown>\",\n      \"source_type\": \"<string>\",\n      \"order\": 1073741823,\n      \"display_aggregated_value\": true,\n      \"display_rate_value\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/billing-plans/{id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"is_active\": true,\n  \"progressive_billing_threshold\": \"<string>\",\n  \"grace_period_hours\": -1,\n  \"late_ticket_grace_period_hours\": -1,\n  \"progressive_grace_period_hours\": -1,\n  \"payment_due_hours\": -1,\n  \"effective_date\": \"2023-12-25\",\n  \"payment_instructions\": \"<string>\",\n  \"charges\": [\n    {\n      \"description\": \"<string>\",\n      \"amount\": \"<string>\",\n      \"id\": 123,\n      \"filters\": \"<unknown>\",\n      \"source_type\": \"<string>\",\n      \"order\": 1073741823,\n      \"display_aggregated_value\": true,\n      \"display_rate_value\": true\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "fleet": 123,
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "is_active": true,
  "progressive_billing_threshold": "<string>",
  "grace_period_hours": -1,
  "late_ticket_grace_period_hours": -1,
  "progressive_grace_period_hours": -1,
  "payment_due_hours": -1,
  "effective_date": "2023-12-25",
  "payment_instructions": "<string>",
  "charges": [
    {
      "description": "<string>",
      "amount": "<string>",
      "id": 123,
      "filters": "<unknown>",
      "source_type": "<string>",
      "order": 1073741823,
      "display_aggregated_value": true,
      "display_rate_value": true
    }
  ]
}

On PATCH, the charges array is a full replacement: charges omitted (by id) are deleted, charges with a known id are updated, and charges without an id are created.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Body

name

string

Maximum string length: 255

is_active

boolean

progressive_billing_threshold

string<decimal> | null

Cumulative unbilled usage that triggers a mid-agreement invoice. None = only bill on agreement end.

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$

grace_period_hours

integer

Hours after invoice creation before it may be finalized.

Required range: -2147483648 <= x <= 2147483647

late_ticket_grace_period_hours

integer

Hours a LATE_TICKET draft stays open to batch incoming late tickets before finalization.

Required range: -2147483648 <= x <= 2147483647

progressive_grace_period_hours

integer

Hours a PROGRESSIVE draft stays open before it may be finalized.

Required range: -2147483648 <= x <= 2147483647

payment_due_hours

integer

Number of hours when payment is due after finalizations.

Required range: -2147483648 <= x <= 2147483647

effective_date

string<date> | null

Agreements that ended before this date will not generate invoices. Null means no restriction.

payment_instructions

string | null

HTML rendered in the Payment Instructions section of driver invoice PDFs.

charges

object[]

Show child attributes

Response

200 - application/json

integer

required

read-only

fleet

integer

required

read-only

name

string

required

Maximum string length: 255

created_at

string<date-time>

required

read-only

is_active

boolean

progressive_billing_threshold

string<decimal> | null

Cumulative unbilled usage that triggers a mid-agreement invoice. None = only bill on agreement end.

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$

grace_period_hours

integer

Hours after invoice creation before it may be finalized.

Required range: -2147483648 <= x <= 2147483647

late_ticket_grace_period_hours

integer

Hours a LATE_TICKET draft stays open to batch incoming late tickets before finalization.

Required range: -2147483648 <= x <= 2147483647

progressive_grace_period_hours

integer

Hours a PROGRESSIVE draft stays open before it may be finalized.

Required range: -2147483648 <= x <= 2147483647

payment_due_hours

integer

Number of hours when payment is due after finalizations.

Required range: -2147483648 <= x <= 2147483647

effective_date

string<date> | null

Agreements that ended before this date will not generate invoices. Null means no restriction.

payment_instructions

string | null

HTML rendered in the Payment Instructions section of driver invoice PDFs.

charges

object[]

Show child attributes

Get Billing Plan

Delete Billing Plan

Introduction

Integration Guides

Driver Billing

Auth

Vehicles

Fleet

Parking

Transponders

Tolls

Documents

Integrations

Drivers

Billing

Support Tickets

Stats

Update Billing Plan

Authorizations

Path Parameters

Body

Response