Skip to content

Commit 590b2af

Browse files
authored
Better wording for the amount attribute.
1 parent 7b9f34c commit 590b2af

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

source/includes/wp-api-v3/_order-refunds.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The refunds API allows you to create, view, and delete individual refunds.
99
| `id` | integer | Unique identifier for the resource. <i class="label label-info">read-only</i> |
1010
| `date_created` | date-time | The date the order refund was created, in the site's timezone. <i class="label label-info">read-only</i> |
1111
| `date_created_gmt` | date-time | The date the order refund was created, as GMT. <i class="label label-info">read-only</i> |
12-
| `amount` | string | Total refund amount. Optional on creation, if missing it will be calculated by adding up the `refund_amount` of each line item, including taxes. |
12+
| `amount` | string | Total refund amount. Optional. If this parameter is provided, it will take precedence over line item totals, even when total of line items does not matches with this amount. |
1313
| `reason` | string | Reason for refund. |
1414
| `refunded_by` | integer | User ID of user who created the refund. |
1515
| `refunded_payment` | boolean | If the payment was refunded via the API. See `api_refund`. <i class="label label-info">read-only</i> |
@@ -52,7 +52,7 @@ The refunds API allows you to create, view, and delete individual refunds.
5252
| `id` | integer | Tax rate ID. <i class="label label-info">read-only</i> |
5353
| `total` | string | Tax total. <i class="label label-info">read-only</i> |
5454
| `subtotal` | string | Tax subtotal. <i class="label label-info">read-only</i> |
55-
| `refund_total` | number | The amount to refund for this taxs. <i class="label label-info">write-only</i> |
55+
| `refund_total` | number | The amount to refund for this tax. <i class="label label-info">write-only</i> |
5656

5757
## Create a refund ##
5858

0 commit comments

Comments
 (0)