Billing Schedules
Validate taxes on a billing schedule
Latest Live API
- Account
- Billing
- Collections
- Customer
- Invoices
- Notifications
- Product
- Quote
- Taxes
- Usage
Version 2024-07-30
- Account
- Billing
- Collections
- Customer
- Invoices
- Notifications
- Product
- Quote
- Taxes
- Usage
Billing Schedules
Validate taxes on a billing schedule
Validate the tax strategy that will apply to the given billing schedule before it’s created or updated.
POST
/
billing-schedules
/
validate-taxes
curl --request POST \
--url https://eu.sequencehq.com/api/billing-schedules/validate-taxes \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"customerId": "cca32597-b6b0-4499-9669-128aef8702e4",
"startDate": "2022-01-01",
"endDate": "2022-12-01",
"recurrenceDayOfMonth": 1,
"taxRates": [
{
"priceId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
"taxRateId": "50c0d53b-8460-41e6-b4e9-a4e157fc1a64"
}
],
"autoIssueInvoices": false,
"purchaseOrderNumber": "PO123",
"paymentProvider": "STRIPE",
"isDraft": false,
"rollUpBilling": false,
"phases": [
{
"name": "Trial Period",
"priceIds": [
"6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"
],
"startDate": "2022-01-01",
"endDate": "2022-06-30",
"discounts": [
{
"restrictToPrices": [
"6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"
],
"type": "PERCENTAGE",
"amount": 0.08,
"message": "8% Discount",
"separateLineItem": true,
"seatDiscountType": "ALL_SEATS"
}
],
"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"
}
]
},
{
"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
}'
Headers
Your API credentials. Eg. Basic {credentials}
.
Use this header to select an API version
Available options:
2024-07-30
Body
application/json
curl --request POST \
--url https://eu.sequencehq.com/api/billing-schedules/validate-taxes \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"customerId": "cca32597-b6b0-4499-9669-128aef8702e4",
"startDate": "2022-01-01",
"endDate": "2022-12-01",
"recurrenceDayOfMonth": 1,
"taxRates": [
{
"priceId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
"taxRateId": "50c0d53b-8460-41e6-b4e9-a4e157fc1a64"
}
],
"autoIssueInvoices": false,
"purchaseOrderNumber": "PO123",
"paymentProvider": "STRIPE",
"isDraft": false,
"rollUpBilling": false,
"phases": [
{
"name": "Trial Period",
"priceIds": [
"6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"
],
"startDate": "2022-01-01",
"endDate": "2022-06-30",
"discounts": [
{
"restrictToPrices": [
"6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"
],
"type": "PERCENTAGE",
"amount": 0.08,
"message": "8% Discount",
"separateLineItem": true,
"seatDiscountType": "ALL_SEATS"
}
],
"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"
}
]
},
{
"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
}'