Activate Billing Schedule

curl --request PUT \
  --url https://eu.sequencehq.com/api/billing-schedules/{billingScheduleId}/activate \
  --header 'Authorization: <authorization>'

import requests

url = "https://eu.sequencehq.com/api/billing-schedules/{billingScheduleId}/activate"

headers = {"Authorization": "<authorization>"}

response = requests.put(url, headers=headers)

print(response.text)

const options = {method: 'PUT', headers: {Authorization: '<authorization>'}};

fetch('https://eu.sequencehq.com/api/billing-schedules/{billingScheduleId}/activate', 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://eu.sequencehq.com/api/billing-schedules/{billingScheduleId}/activate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://eu.sequencehq.com/api/billing-schedules/{billingScheduleId}/activate"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://eu.sequencehq.com/api/billing-schedules/{billingScheduleId}/activate")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<authorization>'

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

{
  "id": "b102e007-f5d7-4b1a-8a1d-9a51135ae73b",
  "customerId": "cca32597-b6b0-4499-9669-128aef8702e4",
  "status": "ACTIVE",
  "startDate": "2022-01-01",
  "endDate": "2022-12-01",
  "taxRates": [
    {
      "priceId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
      "taxRateId": "50c0d53b-8460-41e6-b4e9-a4e157fc1a64"
    }
  ],
  "firstBillingDate": "2022-02-02",
  "autoIssueInvoices": false,
  "purchaseOrderNumber": "PO123",
  "reference": "ref",
  "label": "label",
  "recurrenceDayOfMonth": 1,
  "prices": [
    {
      "id": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
      "productId": "f409d651-c475-4142-aafd-a5d2bd74d4f9",
      "name": "Demo Product",
      "currency": "GBP",
      "structure": {
        "pricePerUnit": "0.25",
        "usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
        "isPricePercentage": false,
        "pricingType": "LINEAR"
      },
      "billingFrequency": "MONTHLY",
      "billingType": "IN_ARREARS",
      "createdAt": "2022-06-28T16:47:00Z",
      "updatedAt": "2022-06-28T16:47:00Z",
      "integrationIds": [
        {
          "service": "Xero",
          "id": "123",
          "isPending": false
        }
      ],
      "customMetricParameters": [
        {
          "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
          "value": "10"
        }
      ],
      "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100",
      "usageCalculationPeriod": {
        "frequency": "MONTHLY",
        "interval": 1
      },
      "status": "ACTIVE"
    }
  ],
  "createdAt": "2022-06-28T16:47:00Z",
  "updatedAt": "2022-06-28T16:47:00Z",
  "lastInvoiceId": "bdbf78a5-b007-4d46-aa7d-d0417a649d64",
  "phases": [
    {
      "id": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
      "name": "Onboarding",
      "externalContractRef": "ACME-2022-MSA",
      "createdAt": "2022-06-28T16:47:00Z",
      "billingScheduleId": "b102e007-f5d7-4b1a-8a1d-9a51135ae73b",
      "priceIds": [
        "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"
      ],
      "startDate": "2022-01-01",
      "endDate": "2022-06-30",
      "discounts": [
        {
          "id": "4451f62c-0c1f-491c-aeb2-9eb41b28149c",
          "restrictToPrices": [
            "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"
          ],
          "type": "PERCENTAGE",
          "amount": 15,
          "message": "15% Discount",
          "separateLineItem": true,
          "seatDiscountType": "ALL_SEATS"
        }
      ],
      "minimums": [
        {
          "id": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
          "sequenceAccountId": "c4602d51-0fb4-4b48-b689-6ba28f540d1e",
          "billingScheduleId": "b102e007-f5d7-4b1a-8a1d-9a51135ae73b",
          "phaseId": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
          "amount": 100,
          "restrictToPrices": [
            "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"
          ],
          "createdAt": "2022-06-28T16:47:00Z",
          "updatedAt": "2022-06-28T16:47:00Z"
        }
      ],
      "creditGrants": [
        {
          "id": "0199ca8a-e7e8-73b3-bd69-a316a23231a0",
          "name": "Monthly usage credits",
          "creditUnitType": "CURRENCY",
          "currency": "GBP",
          "amount": 100,
          "costOfCredit": 0,
          "taxRateId": "179d1ab3-cc96-48e2-9310-067b0b42d47c",
          "grantRefreshFrequency": "MONTHLY",
          "billingFrequency": "MONTHLY",
          "rolloverMode": "NONE",
          "restrictToPrices": [
            "0199ca89-2d9e-7e3d-914c-7de86e8fc7ce"
          ],
          "integrationIds": [
            {
              "service": "NetSuite",
              "id": "1234",
              "isPending": false
            }
          ]
        }
      ],
      "integrationIds": [
        {
          "service": "NetSuite",
          "id": "SO-1024",
          "lastSynced": "2022-06-28T16:47:00Z",
          "url": "https://system.netsuite.com/app/accounting/transactions/salesord.nl?id=1024",
          "isPending": false
        }
      ],
      "recurrencePreference": "CONTINUE_FROM_PREVIOUS_PHASE",
      "phasePriceMetadata": [
        {
          "priceId": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
          "arrCalculation": "INCLUDE"
        }
      ]
    }
  ],
  "archivedAt": "2022-06-28T16:47:00Z",
  "rollUpBilling": false,
  "integrationIds": [
    {
      "service": "Salesforce",
      "id": "a0CQy00000Ipz5VMAR",
      "lastSynced": "2024-08-14T17:14:17Z",
      "url": "https://sequence-b-dev-ed.develop.my.salesforce.com/lightning/r/sequence__Billing_Schedule__c/a0CQy00000Ipz5VMAR/view",
      "isPending": false
    }
  ],
  "attachmentAssets": [
    {
      "id": "e007e884-5100-4183-8355-4771865cb4dd",
      "createdBy": "94703530-1293-479b-bd37-ccad42fd9c8b",
      "createdByType": "SEQUENCE_USER",
      "type": "IMAGE",
      "format": "PNG",
      "fileName": "my-image.png",
      "fileSizeBytes": 12345,
      "url": "https://assets.sequencehq.com/018f9ad5-4192-76d7-aea5-d80a9018eded/images/e007e884-5100-4183-8355-4771865cb4dd.png",
      "createdAt": "2022-06-28T16:47:00Z"
    }
  ],
  "contractId": "0194d091-f65b-7b98-b75f-a923aa0f5b1a",
  "defaultDueDateDays": 30,
  "memo": "Example Billing Schedule",
  "customFields": {
    "key": "value"
  },
  "paymentProvider": "STRIPE",
  "autoCharge": true,
  "lockedByQuoteId": "0199a1b2-3c4d-7e5f-8a6b-7c8d9e0f1a2b"
}

This response has no body data.

This response has no body data.

This response has no body data.

PUT

billing-schedules

{billingScheduleId}

activate

Activate Billing Schedule

curl --request PUT \
  --url https://eu.sequencehq.com/api/billing-schedules/{billingScheduleId}/activate \
  --header 'Authorization: <authorization>'

import requests

url = "https://eu.sequencehq.com/api/billing-schedules/{billingScheduleId}/activate"

headers = {"Authorization": "<authorization>"}

response = requests.put(url, headers=headers)

print(response.text)

const options = {method: 'PUT', headers: {Authorization: '<authorization>'}};

fetch('https://eu.sequencehq.com/api/billing-schedules/{billingScheduleId}/activate', 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://eu.sequencehq.com/api/billing-schedules/{billingScheduleId}/activate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://eu.sequencehq.com/api/billing-schedules/{billingScheduleId}/activate"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://eu.sequencehq.com/api/billing-schedules/{billingScheduleId}/activate")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<authorization>'

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

{
  "id": "b102e007-f5d7-4b1a-8a1d-9a51135ae73b",
  "customerId": "cca32597-b6b0-4499-9669-128aef8702e4",
  "status": "ACTIVE",
  "startDate": "2022-01-01",
  "endDate": "2022-12-01",
  "taxRates": [
    {
      "priceId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
      "taxRateId": "50c0d53b-8460-41e6-b4e9-a4e157fc1a64"
    }
  ],
  "firstBillingDate": "2022-02-02",
  "autoIssueInvoices": false,
  "purchaseOrderNumber": "PO123",
  "reference": "ref",
  "label": "label",
  "recurrenceDayOfMonth": 1,
  "prices": [
    {
      "id": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
      "productId": "f409d651-c475-4142-aafd-a5d2bd74d4f9",
      "name": "Demo Product",
      "currency": "GBP",
      "structure": {
        "pricePerUnit": "0.25",
        "usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
        "isPricePercentage": false,
        "pricingType": "LINEAR"
      },
      "billingFrequency": "MONTHLY",
      "billingType": "IN_ARREARS",
      "createdAt": "2022-06-28T16:47:00Z",
      "updatedAt": "2022-06-28T16:47:00Z",
      "integrationIds": [
        {
          "service": "Xero",
          "id": "123",
          "isPending": false
        }
      ],
      "customMetricParameters": [
        {
          "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
          "value": "10"
        }
      ],
      "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100",
      "usageCalculationPeriod": {
        "frequency": "MONTHLY",
        "interval": 1
      },
      "status": "ACTIVE"
    }
  ],
  "createdAt": "2022-06-28T16:47:00Z",
  "updatedAt": "2022-06-28T16:47:00Z",
  "lastInvoiceId": "bdbf78a5-b007-4d46-aa7d-d0417a649d64",
  "phases": [
    {
      "id": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
      "name": "Onboarding",
      "externalContractRef": "ACME-2022-MSA",
      "createdAt": "2022-06-28T16:47:00Z",
      "billingScheduleId": "b102e007-f5d7-4b1a-8a1d-9a51135ae73b",
      "priceIds": [
        "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"
      ],
      "startDate": "2022-01-01",
      "endDate": "2022-06-30",
      "discounts": [
        {
          "id": "4451f62c-0c1f-491c-aeb2-9eb41b28149c",
          "restrictToPrices": [
            "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"
          ],
          "type": "PERCENTAGE",
          "amount": 15,
          "message": "15% Discount",
          "separateLineItem": true,
          "seatDiscountType": "ALL_SEATS"
        }
      ],
      "minimums": [
        {
          "id": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
          "sequenceAccountId": "c4602d51-0fb4-4b48-b689-6ba28f540d1e",
          "billingScheduleId": "b102e007-f5d7-4b1a-8a1d-9a51135ae73b",
          "phaseId": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
          "amount": 100,
          "restrictToPrices": [
            "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"
          ],
          "createdAt": "2022-06-28T16:47:00Z",
          "updatedAt": "2022-06-28T16:47:00Z"
        }
      ],
      "creditGrants": [
        {
          "id": "0199ca8a-e7e8-73b3-bd69-a316a23231a0",
          "name": "Monthly usage credits",
          "creditUnitType": "CURRENCY",
          "currency": "GBP",
          "amount": 100,
          "costOfCredit": 0,
          "taxRateId": "179d1ab3-cc96-48e2-9310-067b0b42d47c",
          "grantRefreshFrequency": "MONTHLY",
          "billingFrequency": "MONTHLY",
          "rolloverMode": "NONE",
          "restrictToPrices": [
            "0199ca89-2d9e-7e3d-914c-7de86e8fc7ce"
          ],
          "integrationIds": [
            {
              "service": "NetSuite",
              "id": "1234",
              "isPending": false
            }
          ]
        }
      ],
      "integrationIds": [
        {
          "service": "NetSuite",
          "id": "SO-1024",
          "lastSynced": "2022-06-28T16:47:00Z",
          "url": "https://system.netsuite.com/app/accounting/transactions/salesord.nl?id=1024",
          "isPending": false
        }
      ],
      "recurrencePreference": "CONTINUE_FROM_PREVIOUS_PHASE",
      "phasePriceMetadata": [
        {
          "priceId": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
          "arrCalculation": "INCLUDE"
        }
      ]
    }
  ],
  "archivedAt": "2022-06-28T16:47:00Z",
  "rollUpBilling": false,
  "integrationIds": [
    {
      "service": "Salesforce",
      "id": "a0CQy00000Ipz5VMAR",
      "lastSynced": "2024-08-14T17:14:17Z",
      "url": "https://sequence-b-dev-ed.develop.my.salesforce.com/lightning/r/sequence__Billing_Schedule__c/a0CQy00000Ipz5VMAR/view",
      "isPending": false
    }
  ],
  "attachmentAssets": [
    {
      "id": "e007e884-5100-4183-8355-4771865cb4dd",
      "createdBy": "94703530-1293-479b-bd37-ccad42fd9c8b",
      "createdByType": "SEQUENCE_USER",
      "type": "IMAGE",
      "format": "PNG",
      "fileName": "my-image.png",
      "fileSizeBytes": 12345,
      "url": "https://assets.sequencehq.com/018f9ad5-4192-76d7-aea5-d80a9018eded/images/e007e884-5100-4183-8355-4771865cb4dd.png",
      "createdAt": "2022-06-28T16:47:00Z"
    }
  ],
  "contractId": "0194d091-f65b-7b98-b75f-a923aa0f5b1a",
  "defaultDueDateDays": 30,
  "memo": "Example Billing Schedule",
  "customFields": {
    "key": "value"
  },
  "paymentProvider": "STRIPE",
  "autoCharge": true,
  "lockedByQuoteId": "0199a1b2-3c4d-7e5f-8a6b-7c8d9e0f1a2b"
}

This response has no body data.

This response has no body data.

This response has no body data.

Headers

Authorization

string

required

Your API credentials. Eg. Basic {credentials}.

sequence-version

enum<string>

Use this header to select an API version

Available options:

2024-07-30

Path Parameters

billingScheduleId

string

required

Billing Schedule ID

Response

string

required

Billing Schedule ID

Example:

"b102e007-f5d7-4b1a-8a1d-9a51135ae73b"

customerId

string

required

Customer ID

Example:

"cca32597-b6b0-4499-9669-128aef8702e4"

status

enum<string>

required

Billing schedule status

Available options:

DRAFT,

PENDING,

ACTIVE,

SUSPENDED,

CANCELLED,

COMPLETED

Example:

"ACTIVE"

startDate

string

required

Start date

Example:

"2022-01-01"

autoIssueInvoices

boolean

required

If true, invoices will be automatically sent for this billing schedule

Example:

false

prices

object[]

required

Prices

Show child attributes

Example:

[
  {
    "id": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
    "productId": "f409d651-c475-4142-aafd-a5d2bd74d4f9",
    "name": "Demo Product",
    "currency": "GBP",
    "structure": {
      "pricePerUnit": "0.25",
      "usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
      "isPricePercentage": false,
      "pricingType": "LINEAR"
    },
    "billingFrequency": "MONTHLY",
    "billingType": "IN_ARREARS",
    "createdAt": "2022-06-28T16:47:00Z",
    "updatedAt": "2022-06-28T16:47:00Z",
    "integrationIds": [
      {
        "service": "Xero",
        "id": "123",
        "isPending": false
      }
    ],
    "customMetricParameters": [
      {
        "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
        "value": "10"
      }
    ],
    "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100",
    "usageCalculationPeriod": { "frequency": "MONTHLY", "interval": 1 },
    "status": "ACTIVE"
  }
]

createdAt

string

required

Time at which the schedule was initially created, in ISO 8601 format.

Example:

"2022-06-28T16:47:00Z"

updatedAt

string

required

Time at which the schedule was last updated, in ISO 8601 format.

Example:

"2022-06-28T16:47:00Z"

phases

object[]

required

Phases

Show child attributes

Example:

[
  {
    "id": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
    "name": "Onboarding",
    "externalContractRef": "ACME-2022-MSA",
    "createdAt": "2022-06-28T16:47:00Z",
    "billingScheduleId": "b102e007-f5d7-4b1a-8a1d-9a51135ae73b",
    "priceIds": ["6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"],
    "startDate": "2022-01-01",
    "endDate": "2022-06-30",
    "discounts": [
      {
        "id": "4451f62c-0c1f-491c-aeb2-9eb41b28149c",
        "restrictToPrices": ["6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"],
        "type": "PERCENTAGE",
        "amount": 15,
        "message": "15% Discount",
        "separateLineItem": true,
        "seatDiscountType": "ALL_SEATS"
      }
    ],
    "minimums": [
      {
        "id": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
        "sequenceAccountId": "c4602d51-0fb4-4b48-b689-6ba28f540d1e",
        "billingScheduleId": "b102e007-f5d7-4b1a-8a1d-9a51135ae73b",
        "phaseId": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
        "amount": 100,
        "restrictToPrices": ["6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"],
        "createdAt": "2022-06-28T16:47:00Z",
        "updatedAt": "2022-06-28T16:47:00Z"
      }
    ],
    "creditGrants": [
      {
        "id": "0199ca8a-e7e8-73b3-bd69-a316a23231a0",
        "name": "Monthly usage credits",
        "creditUnitType": "CURRENCY",
        "currency": "GBP",
        "amount": 100,
        "costOfCredit": 0,
        "taxRateId": "179d1ab3-cc96-48e2-9310-067b0b42d47c",
        "grantRefreshFrequency": "MONTHLY",
        "billingFrequency": "MONTHLY",
        "rolloverMode": "NONE",
        "restrictToPrices": ["0199ca89-2d9e-7e3d-914c-7de86e8fc7ce"],
        "integrationIds": [
          {
            "service": "NetSuite",
            "id": "1234",
            "isPending": false
          }
        ]
      }
    ],
    "integrationIds": [
      {
        "service": "NetSuite",
        "id": "SO-1024",
        "lastSynced": "2022-06-28T16:47:00Z",
        "url": "https://system.netsuite.com/app/accounting/transactions/salesord.nl?id=1024",
        "isPending": false
      }
    ],
    "recurrencePreference": "CONTINUE_FROM_PREVIOUS_PHASE",
    "phasePriceMetadata": [
      {
        "priceId": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
        "arrCalculation": "INCLUDE"
      }
    ]
  }
]

rollUpBilling

boolean

required

Roll up billing

Example:

false

integrationIds

object[]

required

External services which are linked to this customer

Show child attributes

Example:

[
  {
    "service": "Salesforce",
    "id": "a0CQy00000Ipz5VMAR",
    "lastSynced": "2024-08-14T17:14:17Z",
    "url": "https://sequence-b-dev-ed.develop.my.salesforce.com/lightning/r/sequence__Billing_Schedule__c/a0CQy00000Ipz5VMAR/view",
    "isPending": false
  }
]

attachmentAssets

object[]

required

Assets attached to this billing schedule

Show child attributes

Example:

[
  {
    "id": "e007e884-5100-4183-8355-4771865cb4dd",
    "createdBy": "94703530-1293-479b-bd37-ccad42fd9c8b",
    "createdByType": "SEQUENCE_USER",
    "type": "IMAGE",
    "format": "PNG",
    "fileName": "my-image.png",
    "fileSizeBytes": 12345,
    "url": "https://assets.sequencehq.com/018f9ad5-4192-76d7-aea5-d80a9018eded/images/e007e884-5100-4183-8355-4771865cb4dd.png",
    "createdAt": "2022-06-28T16:47:00Z"
  }
]

customFields

object

required

Custom key-value fields for this billing schedule

Show child attributes

Example:

{ "key": "value" }

endDate

string | null

End date

Example:

"2022-12-01"

taxRates

object[] | null

Tax Rate for each Product

Show child attributes

Example:

[
  {
    "priceId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
    "taxRateId": "50c0d53b-8460-41e6-b4e9-a4e157fc1a64"
  }
]

firstBillingDate

string | null

First billing date

Example:

"2022-02-02"

purchaseOrderNumber

string | null

Optional purchase order number to be added to invoices

Example:

"PO123"

reference

string | null

Optional reference to be added to invoices

Example:

"ref"

label

string | null

Optional label

Example:

"label"

recurrenceDayOfMonth

integer<int32> | null

The day of the month on which billing recurs

Example:

1

lastInvoiceId

string | null

ID of the last invoice (if there has been one)

Example:

"bdbf78a5-b007-4d46-aa7d-d0417a649d64"

archivedAt

string | null

Time at which the schedule was archived, in ISO 8601 format.

Example:

"2022-06-28T16:47:00Z"

contractId

string | null

Optional ID of the contract used to create this billing schedule

Example:

"0194d091-f65b-7b98-b75f-a923aa0f5b1a"

defaultDueDateDays

integer | null

Default number of days between invoice issue date and due date

Example:

30

memo

string | null

Billing schedule memo

Example:

"Example Billing Schedule"

paymentProvider

enum<string> | null

Payment provider configured for collecting invoices on this billing schedule

Available options:

STRIPE,

GOCARDLESS,

NONE

Example:

"STRIPE"

autoCharge

boolean | null

Whether invoices for this billing schedule are automatically charged

Example:

true

lockedByQuoteId

string | null

ID of the amendment quote that stops this billing schedule being edited, archived or deleted, or its overage frequency being changed. If more than one amendment quote is open, this is the one furthest along: accepted, then out for signature, then published, then draft, and the newest if two are equally far along. Cleared once no amendment quote holds the schedule, that is once each has been executed, archived or deleted, or another amendment to this schedule was executed after it was drafted

Example:

"0199a1b2-3c4d-7e5f-8a6b-7c8d9e0f1a2b"

API Reference

Latest Live API

Version 2024-07-30

Activate Billing Schedule

Headers

Path Parameters

Response