What's new?
We've added a new grand_total_tax field to transaction totals that shows the proportional tax amount charged when credits are applied to a transaction.
Breakdown of the total for a transaction.
Net tax amount included in the grand total.
How it works
You can access the tax field in transaction.details.totals to see the tax amount for a transaction.
When a credit is applied to a transaction, the tax field shows the full tax amount calculated on the transaction total before any credits are applied.
We've added a new grand_total_tax field to show the tax amount that's charged after any credits are applied. This means you can better understand how credits affect transactions and more easily reconcile your payout breakdowns.
Where there are no credits applied, grand_total_tax is the same as tax. For transactions created before this change, grand_total_tax is the tax value to maintain consistency.
Example
Assuming a transaction for $100 with a 20% tax rate:
| Field | Description | Example |
|---|---|---|
| Subtotal | Subtotal before discount, tax, and deductions. | $100 |
| Tax | Total tax on the subtotal (20%). | $20 |
| Total | Total after discount and tax. | $120 |
| Credit | Total credit applied to this transaction. | $90 |
| Grand total | Total due on a transaction after credits but before any payments. | $30 |
| Grand total tax | Net tax amount included in the grand total. | $5 |
Next steps
This change is available in version 1 of the Paddle API.
It's a non-breaking change, meaning it doesn't impact existing integrations. For transactions created before this change rolled out, grand_total_tax is the tax value to maintain consistency.
You can list transactions or get a transaction using the API to see the new grand_total_tax field.
Summary of changes
| Entity | Field | Change | Type |
|---|---|---|---|
| Transaction | details.totals.grand_total_tax | + Added | Field |
| Net tax amount included in the grand total, after credits are applied. | |||
| Transaction | details.adjusted_totals.grand_total_tax | + Added | Field |
| Net tax amount included in the adjusted grand total, after credits are applied. | |||