Billing Schedules

Validate taxes on a billing schedule

Changed on

Validate the tax strategy that will apply to the given billing schedule before it's created or updated.

post/billing-schedules/validate-taxes

Request

  • Base URL
    https://sandbox.sequencehq.com/api
  • URL
    https://sandbox.sequencehq.com/api/billing-schedules/validate-taxes
  • Auth
    none declared. Required headers: Authorization

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Request body

customerIdstring required

Customer ID

startDatestring required

Start date

endDatestring

End date. A null end date denotes an open-ended schedule.

recurrenceDayOfMonthinteger

Recurrence day of month

autoIssueInvoicesboolean required

Auto-issue invoices for this billing schedule

purchaseOrderNumberstring

Optional purchase order number to be added to invoices

referencestring

Optional reference to be added to invoices

labelstring

Optional label

paymentProvider'STRIPE' | 'GOCARDLESS' | 'NONE'
isDraftboolean required

Create in draft status

rollUpBillingboolean required

Toggles Roll-up billing

attachmentAssetIdsstring[]

IDs of assets that are attached to this schedule

autoChargeboolean

Automatically collect payments if payment details are available

defaultDueDateDaysinteger

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

memostring

Billing schedule memo. Overrides any invoice level set memo

customFieldsobject

Custom key-value fields for this billing schedule

Example request

{
  "customerId": "cca32597-b6b0-4499-9669-128aef8702e4",
  "startDate": "2022-01-01",
  "endDate": "2022-12-31",
  "recurrenceDayOfMonth": 1,
  "taxRates": [
    {
      "priceId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
      "taxRateId": "50c0d53b-8460-41e6-b4e9-a4e157fc1a64"
    }
  ],
  "autoIssueInvoices": false,
  "purchaseOrderNumber": "PO123",
  "reference": "Example reference",
  "label": "Example label",
  "paymentProvider": "STRIPE",
  "isDraft": true,
  "rollUpBilling": false,
  "phases": [
    {
      "name": "Trial Period",
      "externalContractRef": "ACME-2022-MSA",
      "priceIds": [
        "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"
      ],
      "startDate": "2022-01-01",
      "endDate": "2022-06-30",
      "discounts": [
        {
          "restrictToPrices": [
            "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"
          ],
          "type": "PERCENTAGE",
          "amount": 8,
          "message": "8% Discount",
          "separateLineItem": true,
          "seatDiscountType": "ALL_SEATS"
        }
      ],
      "minimums": [
        {
          "restrictToPrices": [
            "9fe9986b-e205-42b7-a58f-42845c91f03f"
          ],
          "amount": 100
        }
      ],
      "creditGrants": [
        {
          "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"
          ]
        }
      ],
      "listPriceIds": [
        "45e16eb7-2170-4632-b04f-9ecd90b85b1e"
      ],
      "recurrencePreference": "CONTINUE_FROM_PREVIOUS_PHASE",
      "phasePriceMetadata": [
        {
          "priceId": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
          "arrCalculation": "INCLUDE"
        }
      ],
      "phaseListPriceMetadata": [
        {
          "listPriceId": "45e16eb7-2170-4632-b04f-9ecd90b85b1e",
          "arrCalculation": "INCLUDE"
        }
      ]
    },
    {
      "priceIds": [],
      "startDate": "2022-07-01",
      "endDate": "2022-12-31",
      "discounts": [],
      "minimums": [
        {
          "restrictToPrices": [
            "9fe9986b-e205-42b7-a58f-42845c91f03f"
          ],
          "amount": 100
        }
      ],
      "listPriceIds": [
        "45e16eb7-2170-4632-b04f-9ecd90b85b1e"
      ],
      "recurrencePreference": "CONTINUE_FROM_PREVIOUS_PHASE",
      "phasePriceMetadata": [
        {
          "priceId": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
          "arrCalculation": "INCLUDE"
        }
      ],
      "phaseListPriceMetadata": [
        {
          "listPriceId": "45e16eb7-2170-4632-b04f-9ecd90b85b1e",
          "arrCalculation": "INCLUDE"
        }
      ]
    }
  ],
  "attachmentAssetIds": [
    "5055cd17-d5e8-4286-bddf-79729ddabf51"
  ],
  "autoCharge": true,
  "defaultDueDateDays": 30,
  "memo": "Example Billing Schedule",
  "customFields": {
    "key": "value"
  }
}

Response

OK

Changes

    • breaking

      the /// request property type changed from object to no type

    • breaking

      the /// request property type changed from object to no type

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the request property //

    • info

      added the new optional request property ////

    • breaking

      added the new required request property ////

    • breaking

      added the new required request property ////

    • breaking

      added the new required request property ////

    • breaking

      added the new required request property ////

    • breaking

      added the new required request property ////

    • breaking

      the /// request property type changed from no type to object

    • breaking

      the /// request property type changed from no type to object

    • warning

      removed the request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property //