Plans

List the Billing Plans.

Table-Specific Information

SELECT

The provider uses the PayPal API to process WHERE clause conditions built with the following columns and operators. All other filters are processed client-side.


Column	Supported Operators
Id	=
ProductId	=

For example, the provider processes the following queries server-side:

SELECT * FROM Plans WHERE Id = '1234'

SELECT * FROM Plans WHERE ProductId = '1234'

INSERT

To insert a plan, specify the ProductId, Name, and BillingCycles columns. You can optionally include other non-required columns. For example:

INSERT INTO Plans (ProductId, Name, BillingCycles) VALUES ('PROD-38M18689438500808', 'New Service Plan', '[{\"frequency\": {\"interval_unit\": \"MONTH\",\"interval_count\": 1},\"tenure_type\": \"REGULAR\",\"sequence\": 1,\"pricing_scheme\": {\"fixed_price\": {\"value\": \"100\",\n" +
              "                     \"currency_code\": \"USD\"\n" +
              "                    }\n" +
              "                  }\n" +
              "                }\n" +
              "              ]')

UPDATE

To update a plan, specify the Id in the WHERE clause. You can update any column that is not read-only. For example:

UPDATE Plans SET name = 'Updated Plan Name 01', Description = 'This is a sample billing plan 01'.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The unique identifier for the billing plan generated by PayPal.
CreateTime	Datetime	True		The date and time when the plan was created.
Description	String	False		The detailed description of the plan.
Links	String	True		Contains the link to the plan object.
Name	String	False		The plan name.
ProductId	String	False		The Id of the product associated with the billing plan.
QuantitySupported	Boolean	False		Indicates whether you can subscribe to this plan by providing a quantity for the goods or service.
Status	String	False		The plan status. The allowed values are CREATED, INACTIVE, ACTIVE.
TaxesInclusive	Boolean	False		Indicates whether the tax was already included in the billing amount.
TaxesPercentage	String	False		The tax percentage on the billing amount.
UpdateTime	Datetime	True		The date and time when the plan was last updated.
IsAutoBillOutstanding	Boolean	False		Indicates whether to automatically bill the outstanding amount in the next billing cycle. The default value is true.
SetupFeeFailureAction	String	False		The action to take on the subscription if the initial payment for the setup fails. The allowed values are CONTINUE, CANCEL. The default value is CANCEL.
PaymentFailureThreshold	Integer	False		The maximum number of payment failures before a subscription is suspended. The default value is 0.
SetupFeeValue	Decimal	False		The initial set-up fee value for the service.
SetupFeeCurrencyCode	String	False		The currency code for the initial setup fee.
BillingCycles	String	False		An array of billing cycles for trial billing and regular billing.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.

Build 26.0.9655