PUT
/
billing-schedules
/
{billingScheduleId}
Update Billing Schedule
curl --request PUT \
  --url https://eu.sequencehq.com/api/billing-schedules/{billingScheduleId} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "startDate": "2022-01-01",
  "endDate": "2022-12-01",
  "recurrenceDayOfMonth": 1,
  "taxRates": [
    {
      "priceId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
      "taxRateId": "50c0d53b-8460-41e6-b4e9-a4e157fc1a64"
    }
  ],
  "autoIssueInvoices": true,
  "purchaseOrderNumber": "PO123",
  "rollUpBilling": false,
  "phases": [
    {
      "priceIds": [
        "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730"
      ],
      "startDate": "2022-01-01",
      "endDate": "2022-12-01",
      "discounts": [],
      "minimums": [],
      "listPriceIds": [
        "b4d7e884-e007-4183-8355-4771865c5100"
      ],
      "recurrencePreference": "CONTINUE_FROM_PREVIOUS_PHASE",
      "phasePriceMetadata": [
        {
          "priceId": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
          "arrCalculation": "INCLUDE"
        }
      ],
      "phaseListPriceMetadata": [
        {
          "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100",
          "arrCalculation": "INCLUDE"
        }
      ]
    }
  ],
  "attachmentAssetIds": [
    "5055cd17-d5e8-4286-bddf-79729ddabf51"
  ],
  "defaultDueDateDays": 30,
  "memo": "Example Billing Schedule"
}'
{
  "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": [],
      "customMetricParameters": [
        {
          "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
          "value": "10"
        }
      ],
      "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100",
      "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",
      "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"
        }
      ],
      "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",
      "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"
}

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

Body

application/json
​
startDate
string<date>
required

Start date

Example:

"2022-01-01"

​
taxRates
object[]
required

Tax Rate for each Product

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

Auto-issue invoices for this billing schedule

Example:

true

​
rollUpBilling
boolean
required

Toggles Roll-up billing

Example:

false

​
phases
object[]
required

Phases

Example:
[
  {
    "priceIds": ["bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730"],
    "startDate": "2022-01-01",
    "endDate": "2022-12-01",
    "discounts": [],
    "minimums": [],
    "listPriceIds": ["b4d7e884-e007-4183-8355-4771865c5100"],
    "recurrencePreference": "CONTINUE_FROM_PREVIOUS_PHASE",
    "phasePriceMetadata": [
      {
        "priceId": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
        "arrCalculation": "INCLUDE"
      }
    ],
    "phaseListPriceMetadata": [
      {
        "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100",
        "arrCalculation": "INCLUDE"
      }
    ]
  }
]
​
endDate
string<date>

End date

Example:

"2022-12-01"

​
recurrenceDayOfMonth
integer

Recurrence day of month

Example:

1

​
purchaseOrderNumber
string

Optional purchase order number to be added to invoices

Example:

"PO123"

​
attachmentAssetIds
string[]

IDs of assets that are attached to this schedule

Example:
["5055cd17-d5e8-4286-bddf-79729ddabf51"]
​
defaultDueDateDays
integer

Default number of days between invoice issue date and due date. Overrides any invoice level set default due date

Example:

30

​
memo
string

Billing schedule memo. Overrides any invoice level set memo

Example:

"Example Billing Schedule"

Response

OK

​
id
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<date>
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

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": [],
    "customMetricParameters": [
      {
        "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
        "value": "10"
      }
    ],
    "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100",
    "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

Example:
[
  {
    "id": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
    "name": "Onboarding",
    "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"
      }
    ],
    "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

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

Example:
[
  {
    "id": "e007e884-5100-4183-8355-4771865cb4dd",
    "createdBy": "94703530-1293-479b-bd37-ccad42fd9c8b",
    "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"
  }
]
​
endDate
string<date>

End date

Example:

"2022-12-01"

​
taxRates
object[]

Tax Rate for each Product

Example:
[
  {
    "priceId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
    "taxRateId": "50c0d53b-8460-41e6-b4e9-a4e157fc1a64"
  }
]
​
firstBillingDate
string<date>

First billing date

Example:

"2022-02-02"

​
purchaseOrderNumber
string

Optional purchase order number to be added to invoices

Example:

"PO123"

​
reference
string

Optional reference to be added to invoices

Example:

"ref"

​
label
string

Optional label

Example:

"label"

​
recurrenceDayOfMonth
integer

The day of the month on which billing recurs

Example:

1

​
lastInvoiceId
string

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

Example:

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

​
archivedAt
string

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

Example:

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

​
contractId
string

Optional ID of the contract used to create this billing schedule

Example:

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

​
defaultDueDateDays
integer

Default number of days between invoice issue date and due date

Example:

30

​
memo
string

Billing schedule memo

Example:

"Example Billing Schedule"