Class Plan

Billing plan resource that will be used to create a billing agreement.

PayPal\Common\PayPalResourceModel implements PayPal\Rest\IResource

PayPal\Api\Plan

Namespace: PayPal\Api
Package: PayPal\Api
Located at PayPal/Api/Plan.php

Methods summary

`public`	# `setId( string $id )` Identifier of the billing plan. 128 characters max. Identifier of the billing plan. 128 characters max. Parameters `$id` Returns $this
`public string`	# `getId( )` Identifier of the billing plan. 128 characters max. Identifier of the billing plan. 128 characters max. Returns string
`public`	# `setName( string $name )` Name of the billing plan. 128 characters max. Name of the billing plan. 128 characters max. Parameters `$name` Returns $this
`public string`	# `getName( )` Name of the billing plan. 128 characters max. Name of the billing plan. 128 characters max. Returns string
`public`	# `setDescription( string $description )` Description of the billing plan. 128 characters max. Description of the billing plan. 128 characters max. Parameters `$description` Returns $this
`public string`	# `getDescription( )` Description of the billing plan. 128 characters max. Description of the billing plan. 128 characters max. Returns string
`public`	# `setType( string $type )` Type of the billing plan. Allowed values: `FIXED`, `INFINITE`. Type of the billing plan. Allowed values: `FIXED`, `INFINITE`. Parameters `$type` Returns $this
`public string`	# `getType( )` Type of the billing plan. Allowed values: `FIXED`, `INFINITE`. Type of the billing plan. Allowed values: `FIXED`, `INFINITE`. Returns string
`public`	# `setState( string $state )` Status of the billing plan. Allowed values: `CREATED`, `ACTIVE`, `INACTIVE`, and `DELETED`. Status of the billing plan. Allowed values: `CREATED`, `ACTIVE`, `INACTIVE`, and `DELETED`. Parameters `$state` Returns $this
`public string`	# `getState( )` Status of the billing plan. Allowed values: `CREATED`, `ACTIVE`, `INACTIVE`, and `DELETED`. Status of the billing plan. Allowed values: `CREATED`, `ACTIVE`, `INACTIVE`, and `DELETED`. Returns string
`public`	# `setCreateTime( string $create_time )` Time when the billing plan was created. Format YYYY-MM-DDTimeTimezone, as defined in ISO8601. Time when the billing plan was created. Format YYYY-MM-DDTimeTimezone, as defined in ISO8601. Parameters `$create_time` Returns $this
`public string`	# `getCreateTime( )` Time when the billing plan was created. Format YYYY-MM-DDTimeTimezone, as defined in ISO8601. Time when the billing plan was created. Format YYYY-MM-DDTimeTimezone, as defined in ISO8601. Returns string
`public`	# `setUpdateTime( string $update_time )` Time when this billing plan was updated. Format YYYY-MM-DDTimeTimezone, as defined in ISO8601. Time when this billing plan was updated. Format YYYY-MM-DDTimeTimezone, as defined in ISO8601. Parameters `$update_time` Returns $this
`public string`	# `getUpdateTime( )` Time when this billing plan was updated. Format YYYY-MM-DDTimeTimezone, as defined in ISO8601. Time when this billing plan was updated. Format YYYY-MM-DDTimeTimezone, as defined in ISO8601. Returns string
`public`	# `setPaymentDefinitions( PayPal\Api\PaymentDefinition[] $payment_definitions )` Array of payment definitions for this billing plan. Array of payment definitions for this billing plan. Parameters `$payment_definitions` Returns $this
`public PayPal\Api\PaymentDefinition[]`	# `getPaymentDefinitions( )` Array of payment definitions for this billing plan. Array of payment definitions for this billing plan. Returns `PayPal\Api\PaymentDefinition[]`
`public`	# `addPaymentDefinition( PayPal\Api\PaymentDefinition $paymentDefinition )` Append PaymentDefinitions to the list. Append PaymentDefinitions to the list. Parameters `$paymentDefinition` Returns $this
`public`	# `removePaymentDefinition( PayPal\Api\PaymentDefinition $paymentDefinition )` Remove PaymentDefinitions from the list. Remove PaymentDefinitions from the list. Parameters `$paymentDefinition` Returns $this
`public`	# `setTerms( PayPal\Api\Terms[] $terms )` Array of terms for this billing plan. Array of terms for this billing plan. Parameters `$terms` Returns $this
`public PayPal\Api\Terms[]`	# `getTerms( )` Array of terms for this billing plan. Array of terms for this billing plan. Returns `PayPal\Api\Terms[]`
`public`	# `addTerm( PayPal\Api\Terms $terms )` Append Terms to the list. Append Terms to the list. Parameters `$terms` Returns $this
`public`	# `removeTerm( PayPal\Api\Terms $terms )` Remove Terms from the list. Remove Terms from the list. Parameters `$terms` Returns $this
`public`	# `setMerchantPreferences( PayPal\Api\MerchantPreferences $merchant_preferences )` Specific preferences such as: set up fee, max fail attempts, autobill amount, and others that are configured for this billing plan. Specific preferences such as: set up fee, max fail attempts, autobill amount, and others that are configured for this billing plan. Parameters `$merchant_preferences` Returns $this
`public PayPal\Api\MerchantPreferences`	# `getMerchantPreferences( )` Specific preferences such as: set up fee, max fail attempts, autobill amount, and others that are configured for this billing plan. Specific preferences such as: set up fee, max fail attempts, autobill amount, and others that are configured for this billing plan. Returns `PayPal\Api\MerchantPreferences`
`public static PayPal\Api\Plan`	# `get( string $planId, PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` Retrieve the details for a particular billing plan by passing the billing plan ID to the request URI. Retrieve the details for a particular billing plan by passing the billing plan ID to the request URI. Parameters `$planId` `$apiContext` is the APIContext for this call. It can be used to pass dynamic configuration and credentials. `$restCall` is the Rest Call Service that is used to make rest calls Returns `PayPal\Api\Plan`
`public PayPal\Api\Plan`	# `create( PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` Create a new billing plan by passing the details for the plan, including the plan name, description, and type, to the request URI. Create a new billing plan by passing the details for the plan, including the plan name, description, and type, to the request URI. Parameters `$apiContext` is the APIContext for this call. It can be used to pass dynamic configuration and credentials. `$restCall` is the Rest Call Service that is used to make rest calls Returns `PayPal\Api\Plan`
`public boolean`	# `update( PayPal\Api\PatchRequest $patchRequest, PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` Replace specific fields within a billing plan by passing the ID of the billing plan to the request URI. In addition, pass a patch object in the request JSON that specifies the operation to perform, field to update, and new value for each update. Replace specific fields within a billing plan by passing the ID of the billing plan to the request URI. In addition, pass a patch object in the request JSON that specifies the operation to perform, field to update, and new value for each update. Parameters `$patchRequest` `$apiContext` is the APIContext for this call. It can be used to pass dynamic configuration and credentials. `$restCall` is the Rest Call Service that is used to make rest calls Returns boolean
`public boolean`	# `delete( PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` Delete a billing plan by passing the ID of the billing plan to the request URI. Delete a billing plan by passing the ID of the billing plan to the request URI. Parameters `$apiContext` is the APIContext for this call. It can be used to pass dynamic configuration and credentials. `$restCall` is the Rest Call Service that is used to make rest calls Returns boolean
`public static PayPal\Api\PlanList`	# `all( array $params, PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` List billing plans according to optional query string parameters specified. List billing plans according to optional query string parameters specified. Parameters `$params` `$apiContext` is the APIContext for this call. It can be used to pass dynamic configuration and credentials. `$restCall` is the Rest Call Service that is used to make rest calls Returns `PayPal\Api\PlanList`

Methods inherited from PayPal\Common\PayPalResourceModel

addLink(), executeCall(), getLink(), getLinks(), removeLink(), setLinks(), updateAccessToken()

Methods inherited from PayPal\Common\PayPalModel

__construct(), __get(), __isset(), __set(), __toString(), __unset(), fromArray(), fromJson(), getList(), setCredential(), toArray(), toJSON()

Properties summary

Properties inherited from PayPal\Common\PayPalModel

$credential

Namespaces

Classes

Class Plan

Methods summary

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Methods inherited from PayPal\Common\PayPalResourceModel

Methods inherited from PayPal\Common\PayPalModel

Properties summary

Properties inherited from PayPal\Common\PayPalModel