Subscriptions
Get billing and subscription details.
View-Specific Information
SELECT
The only filter supported by the PayPal API is Id, which is required. The provider processes all other filters client-side.
SELECT * FROM Subscriptions WHERE Id = '1234'
Note: 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 PayPal-generated ID for the subscription. | |
| BillingInfocycle_executions | String | The trial and regular billing executions. | |
| BillingInfo_FailedPaymentsCount | Integer | The count of failed payments. | |
| BillingInfo_LastPaymentAmountCurrencyCode | String | The last payment amount currency code. | |
| BillingInfo_LastPaymentAmountValue | String | The last payment amount. | |
| BillingInfo_LastPaymentTime | Datetime | The date and time when the last payment was made. | |
| BillingInfo_NextBillingTime | Datetime | The next date and time for billing this subscription. | |
| BillingInfo_OutstandingBalanceCurrencyCode | String | The total pending bill amount, to be paid by the subscriber. | |
| BillingInfo_outstandingBalanceValue | String | The total pending bill amount, to be paid by the subscriber. | |
| CreateTime | Datetime | The date and time when the subscription was created. | |
| Links | String | Links for the subscription objects. | |
| PlanId | String | The ID of the plan. | |
| Quantity | Integer | The quantity of the product in the subscription. | |
| ShippingAmountCurrencyCode | String | The currency for a financial transaction, such as a balance or payment due. | |
| ShippingAmountValue | String | The amount for a financial transaction, such as a balance or payment due. | |
| StartTime | Datetime | The start date and time of the subscription. | |
| Status | String | The status of the subscription.
The allowed values are APPROVAL_PENDING, APPROVED, ACTIVE, SUSPENDED, CANCELLED, EXPIRED. | |
| StatusUpdateTime | Datetime | The date and time when the status was updated. | |
| SubscriberEmailAddress | String | The email address of the payer. | |
| SubscriberName_GivenName | String | The given name of the payer. | |
| SubscriberName_Surname | String | The surname of the payer. | |
| SubscriberPayerId | String | The PayPal-assigned ID for the payer. | |
| SubscriberShippingAddress_AddressAddressLine1 | String | Primary address of the payer. | |
| SubscriberShippingAddress_AddressAddressLine2 | String | Secondary address of the payer. | |
| SubscriberShippingAddress_AddressAdminArea1 | String | Primary address of the payer. | |
| SubscriberShippingAddress_AddressAdminArea2 | String | Secondary address of the payer. | |
| SubscriberShippingAddress_AddressCountryCode | String | Country code of the payer address. | |
| SubscriberShippingAddress_AddressPostalCode | String | Postal code of the payer address. | |
| SubscriberShippingAddress_NameFullName | String | Full name of the Payer. | |
| UpdateTime | Datetime | The date and time when the subscription was updated. | |
| SubscriberShippingAddress_Type | String | The method by which the payer wants to get their items from the payee, for example, shipping, in-person pickup. | |
| SubscriberPhoneType | String | The phone type. | |
| SubscriberPhoneNumber | String | The phone number, in its canonical international E.164 numbering plan format. | |
| StatusChangeNote | String | The reason or notes for the status of the subscription. | |
| CustomId | String | The custom id for the subscription. Can be invoice id. | |
| PlanOverridden | Boolean | Indicates whether the subscription has overridden any plan attributes. | |
| BillingInfo_LastPaymentStatus | String | The status of the captured payment. | |
| BillingInfo_FinalPaymentTime | Datetime | The date and time when the final billing cycle occurs, in Internet date and time format. |