Plans

List the Billing Plans.

Table Specific Information

This view returns a list of subscription plans for the authenticated user.

The following filters are supported by the PayPal API:

SELECT * FROM Plans WHERE Id = '1234'
SELECT * FROM Plans WHERE ProductId = '1234'

The connector processes other filters client side within the connector.


Name	Type	References	Description
Id [KEY]	String		The unique PayPal-generated ID for the plan.
CreateTime	Datetime		The date and time when the plan was created.
Description	String		The detailed description of the plan.
BillingCyclesVersion	Integer		The active pricing scheme for this billing cycle.
BillingCyclesPricingModel	String		The active pricing scheme for this billing cycle.
BillingCyclesFrequency	String		The frequency details for this billing cycle.
BillingCyclesTenureType	String		The tenure type of the billing cycle. The allowed values are REGULAR, TRIAL.
BillingCyclesSequence	Integer		The order in which this cycle is to run among other billing cycles.
BillingCyclesTotalCycles	Integer		The number of times this billing cycle gets executed.
Links	String		Contains the link to the plan object.
Name	String		The plan name.
ProductId	String		The ID for the product.
QuantitySupported	Boolean		Indicates whether you can subscribe to this plan by providing a quantity for the goods or service.
Status	String		The plan status. The allowed values are CREATED, INACTIVE, ACTIVE.
TaxesInclusive	Boolean		Indicates whether the tax was already included in the billing amount.
TaxesPercentage	String		The tax percentage on the billing amount.
UpdateTime	Datetime		The date and time when the plan was last updated.