SubscriptionTransactions
Lists transactions for a subscription.
View-Specific Information
SELECT
This view returns a list of transactions with details for a specific subscription.
The following filters are supported by the PayPal API:
- SubscriptionId
- StartTime
- EndTime
SELECT * FROM SubscriptionTransactions WHERE SubscriptionId = '1234'
SELECT * FROM SubscriptionTransactions WHERE SubscriptionId = '1234' AND StartTime = '2018-01-21T07:50:20.940Z' AND EndTime = '2018-08-21T07:50:20.940Z'
Note:
- SubscriptionId, StartTime, and EndTime are required parameters for this view. If you do not specify StartTime and EndTime in the query, the provider assigns default values.
- You can obtain the SubscriptionId by creating a subscription with the CreateSubscription stored procedure.
The provider processes all other filters client-side.
Columns
| Name | Type | References | Description |
| Id [KEY] | String | The ID of the transaction. | |
| SubscriptionId | String | The ID of the subscription. | |
| AmountWithBreakdown_FeeAmountCurrencyCode | String | The fee details for the transaction. | |
| AmountWithBreakdown_FeeAmountValue | String | The fee details for the transaction. | |
| AmountWithBreakdown_GrossAmountCurrencyCode | String | The three-character ISO-4217 currency code that identifies the currency. | |
| AmountWithBreakdown_GrossAmountValue | String | The value of the currency. | |
| AmountWithBreakdown_NetAmountCurrencyCode | String | The currency code of the net amount that the payee receives for this transaction in their PayPal account. | |
| AmountWithBreakdown_NetAmountValue | String | The net amount that the payee receives for this transaction in their PayPal account. | |
| PayerEmail | String | The email ID of the customer. | |
| PayerNameGivenName | String | When the party is a person, the party's given, or first, name. | |
| PayerNameSurname | String | When the party is a person, the party's surname or family name. Also known as the last name. | |
| Status | String | The initial state of the plan.
The allowed values are COMPLETED, DECLINED, PARTIALLY_REFUNDED, PENDING, REFUNDED. | |
| Time | Datetime | The date and time when the transaction was processed. | |
| AmountWithBreakdown_TotalItemAmountCurrencyCode | String | The three-character ISO-4217 currency code that identifies the currency. | |
| AmountWithBreakdown_TotalItemAmountValue | Decimal | The item total for the transaction. | |
| AmountWithBreakdown_ShippingAmountCurrencyCode | String | The three-character ISO-4217 currency code that identifies the currency. | |
| AmountWithBreakdown_ShippingAmountValue | Decimal | The shipping amount for the transaction. | |
| AmountWithBreakdown_TaxAmountCurrencyCode | String | The three-character ISO-4217 currency code that identifies the currency. | |
| AmountWithBreakdown_TaxAmountValue | Decimal | The tax amount for the transaction. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| StartTime | Datetime | The start time of the range of transactions to list. | |
| EndTime | Datetime | The end time of the range of transactions to list. |