Subscriptions

Gets billing and subscription details.

View-Specific Information

SELECT

The only filter supported by the PayPal API is Id, which is required. The driver 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 driver 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 exact number of times a customer will be billed, during the course of an recurring subscription, including the trial period.
BillingInfo_FailedPaymentsCount	Integer		The number of failed payments that have occurred.
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 currency code for the total outstanding balance.
BillingInfo_outstandingBalanceValue	String		The total outstanding balance for the pending bill.
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 payer's surname (family name).
SubscriberPayerId	String		The PayPal-assigned ID for the payer.
SubscriberShippingAddress_AddressAddressLine1	String		The first line of the payer's address.
SubscriberShippingAddress_AddressAddressLine2	String		The second line of the payer's address.
SubscriberShippingAddress_AddressAdminArea1	String		The highest-level description of the payer's address's 'administrative area', such as its state or province.
SubscriberShippingAddress_AddressAdminArea2	String		The second highest-level description of the payer's address's 'administrative area', such as its city, town, or village.
SubscriberShippingAddress_AddressCountryCode	String		Country code of the payer address.
SubscriberShippingAddress_AddressPostalCode	String		The postal code of the payer address.
SubscriberShippingAddress_NameFullName	String		The payer's full name.
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 type of phone where the subscriber can be reached.
SubscriberPhoneNumber	String		The phone number, in its canonical international E.164 numbering plan format.
StatusChangeNote	String		Notes describing the reason for the subscription status change.
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.

ODBC Driver for PayPal

Subscriptions

View-Specific Information

SELECT

Columns