Getting started
A valid request URL is required to generate request examples{
"pricing": {
"total": 137.39,
"currency": "USD",
"calculatedAt": "2024-01-15T10:30:00Z",
"subtotal": 125.99,
"taxAmount": 10.08,
"fees": 1.32,
"taxIncluded": true,
"recurringCosts": {
"subtotal": 29.99,
"total": 32.39,
"taxAmount": 2.4,
"taxIncluded": true,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
}
},
"initialInvoice": {
"subtotal": 14.5,
"total": 15.66,
"taxAmount": 123,
"taxIncluded": true,
"period": {
"start": "2024-01-15",
"end": "2024-01-31"
}
},
"lineItemPricing": [
{
"lineItemId": "e47ac10b-58cc-4372-a567-0e02b2c3d479",
"amount": 999,
"recurringAmount": 29.99,
"description": "iPhone 15 Pro + Premium Plan",
"taxAmount": 79.92,
"taxIncluded": true,
"taxBreakdown": [
{
"description": "Sales Tax",
"amount": 2.4,
"rate": 8.25
}
],
"initialInvoiceAmount": 14.5
}
],
"lineItems": [
{
"lineItemId": "<string>",
"subtotal": 123,
"total": 123,
"taxBreakdown": [
{
"description": "Sales Tax",
"amount": 2.4,
"rate": 8.25
}
],
"taxAmount": 24.75,
"taxIncluded": true,
"fees": [
{
"name": "Activation fee",
"amount": 25
}
],
"totalFees": 25,
"discounts": [
{
"name": "First month free",
"amount": 50
}
],
"totalDiscounts": 50
}
]
}
}Calculate order price
Calculate the total price for an order including taxes, fees, and discounts.
Use this to preview the final price of an order before submission in regions where explicit tax calculation is required, such as the US.
Responses are cached, so if no change is made to the order, subsequent requests will return the same result.
Invalid orders cannot be priced. Fetch the order to see validation errors.
A valid request URL is required to generate request examples{
"pricing": {
"total": 137.39,
"currency": "USD",
"calculatedAt": "2024-01-15T10:30:00Z",
"subtotal": 125.99,
"taxAmount": 10.08,
"fees": 1.32,
"taxIncluded": true,
"recurringCosts": {
"subtotal": 29.99,
"total": 32.39,
"taxAmount": 2.4,
"taxIncluded": true,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
}
},
"initialInvoice": {
"subtotal": 14.5,
"total": 15.66,
"taxAmount": 123,
"taxIncluded": true,
"period": {
"start": "2024-01-15",
"end": "2024-01-31"
}
},
"lineItemPricing": [
{
"lineItemId": "e47ac10b-58cc-4372-a567-0e02b2c3d479",
"amount": 999,
"recurringAmount": 29.99,
"description": "iPhone 15 Pro + Premium Plan",
"taxAmount": 79.92,
"taxIncluded": true,
"taxBreakdown": [
{
"description": "Sales Tax",
"amount": 2.4,
"rate": 8.25
}
],
"initialInvoiceAmount": 14.5
}
],
"lineItems": [
{
"lineItemId": "<string>",
"subtotal": 123,
"total": 123,
"taxBreakdown": [
{
"description": "Sales Tax",
"amount": 2.4,
"rate": 8.25
}
],
"taxAmount": 24.75,
"taxIncluded": true,
"fees": [
{
"name": "Activation fee",
"amount": 25
}
],
"totalFees": 25,
"discounts": [
{
"name": "First month free",
"amount": 50
}
],
"totalDiscounts": 50
}
]
}
}Authorizations
An API key that grants access to the Connect API. You can create and manage API keys in the portal.
Headers
A unique key to ensure idempotency of requests. If a request with the same key has already been processed, the same result will be returned. The key must be unique for each distinct operation. Keys are expired after 24 hours, but we recommend using a new key for each request.
Modified requests with the same idempotency keys are rejected with a 409 Conflict status code.
256Path Parameters
The unique identifier of the order
Response
Price calculation completed successfully
Detailed pricing information for an order including taxes, fees, and discounts.
Show child attributes
Show child attributes
Total amount due for the order.
137.39
Currency for all pricing amounts.
"USD"
When the pricing was last calculated.
"2024-01-15T10:30:00Z"
Subtotal before taxes and fees.
125.99
Tax amount for the order. Set to 0 for orders that will be invoiced separately.
10.08
Setup fees, activation fees, processing fees, etc.
1.32
Whether taxes are included in the total.
true
Expected recurring costs after the initial period. Represents the typical monthly/billing cycle charges.
Show child attributes
Show child attributes
Recurring subtotal before taxes.
29.99
Total estimated recurring amount.
32.39
Estimated tax on recurring charges.
Only calculated in certain regions. In the US, taxes are calculated at the time of invoicing and are not estimated here.
2.4
Whether taxes are included in the total.
true
Optional breakdown for the first invoice when different from recurring. Used for prorated charges, first-month adjustments, etc.
Show child attributes
Show child attributes
First invoice subtotal (e.g., prorated amount, setup fees).
14.5
Total first invoice amount.
15.66
Estimated tax on initial invoice charges.
Only calculated in certain regions. In the US, taxes are calculated at the time of invoicing and are not estimated here.
Whether taxes are included in the total.
true
Per-line-item pricing breakdown.
Show child attributes
Show child attributes
Reference to the line item.
"e47ac10b-58cc-4372-a567-0e02b2c3d479"
Cost for this line item in the order.
999
Recurring cost for this line item.
29.99
Description of what this line item covers.
"iPhone 15 Pro + Premium Plan"
Tax amount for this line item.
79.92
Whether taxes are included in the amount.
true
Tax breakdown for this line item.
Show child attributes
Show child attributes
Description of this tax component.
"Sales Tax"
Tax amount for this component.
2.4
Tax rate as a percentage (optional).
8.25
Amount for this line item on the first invoice.
14.5
Pricing breakdown per line item.
Show child attributes
Show child attributes
The line item identifier.
Line item subtotal.
Line item total after taxes and fees.
Tax breakdown for this line item.
Show child attributes
Show child attributes
Description of this tax component.
"Sales Tax"
Tax amount for this component.
2.4
Tax rate as a percentage (optional).
8.25
Total taxes for this line item.
24.75
Whether taxes are included in the total.
true
Total fees for this line item.
25
Total discounts for this line item.
50