forked from LiveCarta/PayPal-PHP-Server-SDK
Automated commit message
This commit is contained in:
51
doc/models/subscription-amount-with-breakdown.md
Normal file
51
doc/models/subscription-amount-with-breakdown.md
Normal file
@@ -0,0 +1,51 @@
|
||||
|
||||
# Subscription Amount With Breakdown
|
||||
|
||||
The breakdown details for the amount. Includes the gross, tax, fee, and shipping amounts.
|
||||
|
||||
## Structure
|
||||
|
||||
`SubscriptionAmountWithBreakdown`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `grossAmount` | [`Money`](../../doc/models/money.md) | Required | The currency and amount for a financial transaction, such as a balance or payment due. | getGrossAmount(): Money | setGrossAmount(Money grossAmount): void |
|
||||
| `totalItemAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getTotalItemAmount(): ?Money | setTotalItemAmount(?Money totalItemAmount): void |
|
||||
| `feeAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getFeeAmount(): ?Money | setFeeAmount(?Money feeAmount): void |
|
||||
| `shippingAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getShippingAmount(): ?Money | setShippingAmount(?Money shippingAmount): void |
|
||||
| `taxAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getTaxAmount(): ?Money | setTaxAmount(?Money taxAmount): void |
|
||||
| `netAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getNetAmount(): ?Money | setNetAmount(?Money netAmount): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"gross_amount": {
|
||||
"currency_code": "currency_code4",
|
||||
"value": "value0"
|
||||
},
|
||||
"total_item_amount": {
|
||||
"currency_code": "currency_code8",
|
||||
"value": "value4"
|
||||
},
|
||||
"fee_amount": {
|
||||
"currency_code": "currency_code2",
|
||||
"value": "value4"
|
||||
},
|
||||
"shipping_amount": {
|
||||
"currency_code": "currency_code0",
|
||||
"value": "value6"
|
||||
},
|
||||
"tax_amount": {
|
||||
"currency_code": "currency_code2",
|
||||
"value": "value8"
|
||||
},
|
||||
"net_amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value2"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user