Class PaymentDefinition

Class PaymentDefinition

Resource representing payment definition scheduling information.

PayPal\Common\PayPalModel

Extended by

PayPal\Api\PaymentDefinition

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

Methods summary

`public`	# `setId( string $id )` Identifier of the payment_definition. 128 characters max. Identifier of the payment_definition. 128 characters max. Parameters `$id` Returns $this
`public string`	# `getId( )` Identifier of the payment_definition. 128 characters max. Identifier of the payment_definition. 128 characters max. Returns string
`public`	# `setName( string $name )` Name of the payment definition. 128 characters max. Name of the payment definition. 128 characters max. Parameters `$name` Returns $this
`public string`	# `getName( )` Name of the payment definition. 128 characters max. Name of the payment definition. 128 characters max. Returns string
`public`	# `setType( string $type )` Type of the payment definition. Allowed values: `TRIAL`, `REGULAR`. Type of the payment definition. Allowed values: `TRIAL`, `REGULAR`. Parameters `$type` Returns $this
`public string`	# `getType( )` Type of the payment definition. Allowed values: `TRIAL`, `REGULAR`. Type of the payment definition. Allowed values: `TRIAL`, `REGULAR`. Returns string
`public`	# `setFrequencyInterval( string $frequency_interval )` How frequently the customer should be charged. How frequently the customer should be charged. Parameters `$frequency_interval` Returns $this
`public string`	# `getFrequencyInterval( )` How frequently the customer should be charged. How frequently the customer should be charged. Returns string
`public`	# `setFrequency( string $frequency )` Frequency of the payment definition offered. Allowed values: `WEEK`, `DAY`, `YEAR`, `MONTH`. Frequency of the payment definition offered. Allowed values: `WEEK`, `DAY`, `YEAR`, `MONTH`. Parameters `$frequency` Returns $this
`public string`	# `getFrequency( )` Frequency of the payment definition offered. Allowed values: `WEEK`, `DAY`, `YEAR`, `MONTH`. Frequency of the payment definition offered. Allowed values: `WEEK`, `DAY`, `YEAR`, `MONTH`. Returns string
`public`	# `setCycles( string $cycles )` Number of cycles in this payment definition. Number of cycles in this payment definition. Parameters `$cycles` Returns $this
`public string`	# `getCycles( )` Number of cycles in this payment definition. Number of cycles in this payment definition. Returns string
`public`	# `setAmount( PayPal\Api\Currency $amount )` Amount that will be charged at the end of each cycle for this payment definition. Amount that will be charged at the end of each cycle for this payment definition. Parameters `$amount` Returns $this
`public PayPal\Api\Currency`	# `getAmount( )` Amount that will be charged at the end of each cycle for this payment definition. Amount that will be charged at the end of each cycle for this payment definition. Returns `PayPal\Api\Currency`
`public`	# `setChargeModels( PayPal\Api\ChargeModel[] $charge_models )` Array of charge_models for this payment definition. Array of charge_models for this payment definition. Parameters `$charge_models` Returns $this
`public PayPal\Api\ChargeModel[]`	# `getChargeModels( )` Array of charge_models for this payment definition. Array of charge_models for this payment definition. Returns `PayPal\Api\ChargeModel[]`
`public`	# `addChargeModel( PayPal\Api\ChargeModel $chargeModel )` Append ChargeModels to the list. Append ChargeModels to the list. Parameters `$chargeModel` Returns $this
`public`	# `removeChargeModel( PayPal\Api\ChargeModel $chargeModel )` Remove ChargeModels from the list. Remove ChargeModels from the list. Parameters `$chargeModel` Returns $this

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