Class MerchantPreferences

Resource representing merchant preferences like max failed attempts, set up fee and others for a plan.

PayPal\Api\MerchantPreferences

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

Methods summary

`public`	# `setId( string $id )` Identifier of the merchant_preferences. 128 characters max. Identifier of the merchant_preferences. 128 characters max. Parameters `$id` Returns $this
`public string`	# `getId( )` Identifier of the merchant_preferences. 128 characters max. Identifier of the merchant_preferences. 128 characters max. Returns string
`public`	# `setSetupFee( PayPal\Api\Currency $setup_fee )` Setup fee amount. Default is 0. Setup fee amount. Default is 0. Parameters `$setup_fee` Returns $this
`public PayPal\Api\Currency`	# `getSetupFee( )` Setup fee amount. Default is 0. Setup fee amount. Default is 0. Returns `PayPal\Api\Currency`
`public`	# `setCancelUrl( string $cancel_url )` Redirect URL on cancellation of agreement request. 1000 characters max. Redirect URL on cancellation of agreement request. 1000 characters max. Parameters `$cancel_url` Returns $this Throws InvalidArgumentException
`public string`	# `getCancelUrl( )` Redirect URL on cancellation of agreement request. 1000 characters max. Redirect URL on cancellation of agreement request. 1000 characters max. Returns string
`public`	# `setReturnUrl( string $return_url )` Redirect URL on creation of agreement request. 1000 characters max. Redirect URL on creation of agreement request. 1000 characters max. Parameters `$return_url` Returns $this Throws InvalidArgumentException
`public string`	# `getReturnUrl( )` Redirect URL on creation of agreement request. 1000 characters max. Redirect URL on creation of agreement request. 1000 characters max. Returns string
`public`	# `setNotifyUrl( string $notify_url )` Notify URL on agreement creation. 1000 characters max. Notify URL on agreement creation. 1000 characters max. Parameters `$notify_url` Returns $this Throws InvalidArgumentException
`public string`	# `getNotifyUrl( )` Notify URL on agreement creation. 1000 characters max. Notify URL on agreement creation. 1000 characters max. Returns string
`public`	# `setMaxFailAttempts( string $max_fail_attempts )` Total number of failed attempts allowed. Default is 0, representing an infinite number of failed attempts. Total number of failed attempts allowed. Default is 0, representing an infinite number of failed attempts. Parameters `$max_fail_attempts` Returns $this
`public string`	# `getMaxFailAttempts( )` Total number of failed attempts allowed. Default is 0, representing an infinite number of failed attempts. Total number of failed attempts allowed. Default is 0, representing an infinite number of failed attempts. Returns string
`public`	# `setAutoBillAmount( string $auto_bill_amount )` Allow auto billing for the outstanding amount of the agreement in the next cycle. Allowed values: `YES`, `NO`. Default is `NO`. Allow auto billing for the outstanding amount of the agreement in the next cycle. Allowed values: `YES`, `NO`. Default is `NO`. Parameters `$auto_bill_amount` Returns $this
`public string`	# `getAutoBillAmount( )` Allow auto billing for the outstanding amount of the agreement in the next cycle. Allowed values: `YES`, `NO`. Default is `NO`. Allow auto billing for the outstanding amount of the agreement in the next cycle. Allowed values: `YES`, `NO`. Default is `NO`. Returns string
`public`	# `setInitialFailAmountAction( string $initial_fail_amount_action )` Action to take if a failure occurs during initial payment. Allowed values: `CONTINUE`, `CANCEL`. Default is continue. Action to take if a failure occurs during initial payment. Allowed values: `CONTINUE`, `CANCEL`. Default is continue. Parameters `$initial_fail_amount_action` Returns $this
`public string`	# `getInitialFailAmountAction( )` Action to take if a failure occurs during initial payment. Allowed values: `CONTINUE`, `CANCEL`. Default is continue. Action to take if a failure occurs during initial payment. Allowed values: `CONTINUE`, `CANCEL`. Default is continue. Returns string
`public`	# `setAcceptedPaymentType( string $accepted_payment_type )` Payment types that are accepted for this plan. Payment types that are accepted for this plan. Parameters `$accepted_payment_type` Returns $this
`public string`	# `getAcceptedPaymentType( )` Payment types that are accepted for this plan. Payment types that are accepted for this plan. Returns string
`public`	# `setCharSet( string $char_set )` char_set for this plan. char_set for this plan. Parameters `$char_set` Returns $this
`public string`	# `getCharSet( )` char_set for this plan. char_set for this plan. Returns string

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 MerchantPreferences

Methods summary

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Methods inherited from PayPal\Common\PayPalModel

Properties summary

Properties inherited from PayPal\Common\PayPalModel