UsagePattern (PayPal Server SDK 1.0.0 API)

java.lang.Object
- java.lang.Enum<UsagePattern>
- - com.paypal.sdk.models.UsagePattern

All Implemented Interfaces:

Serializable, Comparable<UsagePattern>
```
public enum UsagePattern
extends Enum<UsagePattern>
```
UsagePattern to be used.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`_UNKNOWN` Unknown values will be mapped by this enum member
`DEFERRED` Pay after use, non-recurring post-paid, variable amount, irregular frequency.
`IMMEDIATE` On-demand instant payments – non-recurring, pre-paid, variable amount, variable frequency.
`INSTALLMENT_POSTPAID` Merchant-managed installment plan when the "amount" to be paid and the "billing frequency" are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered.
`INSTALLMENT_PREPAID` Merchant-managed installment plan when the "amount" to be paid and the "billing frequency" are fixed, but there is a defined number of payments with the payment due before the good/service is delivered.
`RECURRING_POSTPAID` Pay on a fixed date based on usage or consumption after the goods/service is delivered.
`RECURRING_PREPAID` Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered.
`SUBSCRIPTION_POSTPAID` Subscription plan where the "amount due" and the "billing frequency" are fixed, and there is no defined duration with the payment due after the goods/services are delivered.
`SUBSCRIPTION_PREPAID` Subscription plan where the "amount due" and the "billing frequency" are fixed, and there is no defined duration with the payment due before the good/service is delivered.
`THRESHOLD_POSTPAID` Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after the goods/service is delivered.
`THRESHOLD_PREPAID` Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before the goods/service is delivered.
`UNSCHEDULED_POSTPAID` Unscheduled card on file plan where the merchant can bill buyer based on an agreed logic, but "amount due" and "frequency" can vary.
`UNSCHEDULED_PREPAID` Unscheduled card on file plan where the merchant can bill buyer upfront based on an agreed logic, but "amount due" and "frequency" can vary.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static UsagePattern`	`constructFromString(String toConvert)` Returns the enum member associated with the given string value.
`static UsagePattern`	`fromString(String toConvert)` Returns the enum member associated with the given string value.
`String`	`toString()` Get string representation of this enum.
`static List<String>`	`toValue(List<UsagePattern> toConvert)` Convert list of UsagePattern values to list of string values.
`String`	`value()` Returns the string value associated with the enum member.
`static UsagePattern`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static UsagePattern[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - IMMEDIATE
```
public static final UsagePattern IMMEDIATE
```
    On-demand instant payments – non-recurring, pre-paid, variable amount, variable frequency.
  - DEFERRED
```
public static final UsagePattern DEFERRED
```
    Pay after use, non-recurring post-paid, variable amount, irregular frequency.
  - RECURRING_PREPAID
```
public static final UsagePattern RECURRING_PREPAID
```
    Pay upfront fixed or variable amount on a fixed date before the goods/service is delivered.
  - RECURRING_POSTPAID
```
public static final UsagePattern RECURRING_POSTPAID
```
    Pay on a fixed date based on usage or consumption after the goods/service is delivered.
  - THRESHOLD_PREPAID
```
public static final UsagePattern THRESHOLD_PREPAID
```
    Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, before the goods/service is delivered.
  - THRESHOLD_POSTPAID
```
public static final UsagePattern THRESHOLD_POSTPAID
```
    Charge payer when the set amount is reached or monthly billing cycle, whichever comes first, after the goods/service is delivered.
  - SUBSCRIPTION_PREPAID
```
public static final UsagePattern SUBSCRIPTION_PREPAID
```
    Subscription plan where the "amount due" and the "billing frequency" are fixed, and there is no defined duration with the payment due before the good/service is delivered.
  - SUBSCRIPTION_POSTPAID
```
public static final UsagePattern SUBSCRIPTION_POSTPAID
```
    Subscription plan where the "amount due" and the "billing frequency" are fixed, and there is no defined duration with the payment due after the goods/services are delivered.
  - UNSCHEDULED_PREPAID
```
public static final UsagePattern UNSCHEDULED_PREPAID
```
    Unscheduled card on file plan where the merchant can bill buyer upfront based on an agreed logic, but "amount due" and "frequency" can vary. Inclusive of automatic reload plans.
  - UNSCHEDULED_POSTPAID
```
public static final UsagePattern UNSCHEDULED_POSTPAID
```
    Unscheduled card on file plan where the merchant can bill buyer based on an agreed logic, but "amount due" and "frequency" can vary. Inclusive of automatic reload plans.
  - INSTALLMENT_PREPAID
```
public static final UsagePattern INSTALLMENT_PREPAID
```
    Merchant-managed installment plan when the "amount" to be paid and the "billing frequency" are fixed, but there is a defined number of payments with the payment due before the good/service is delivered.
  - INSTALLMENT_POSTPAID
```
public static final UsagePattern INSTALLMENT_POSTPAID
```
    Merchant-managed installment plan when the "amount" to be paid and the "billing frequency" are fixed, but there is a defined number of payments with the payment due after the goods/services are delivered.
  - _UNKNOWN
```
public static final UsagePattern _UNKNOWN
```
    Unknown values will be mapped by this enum member
- Method Detail
  - values
```
public static UsagePattern[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (UsagePattern c : UsagePattern.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static UsagePattern valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - constructFromString
```
public static UsagePattern constructFromString(String toConvert)
                                        throws IOException
```
    Returns the enum member associated with the given string value.
    
    Parameters:
    
    toConvert - String value to get enum member.
    
    Returns:
    
    The enum member against the given string value.
    
    Throws:
    
    IOException - when provided value is not mapped to any enum member.
  - fromString
```
public static UsagePattern fromString(String toConvert)
```
    Returns the enum member associated with the given string value.
    
    Parameters:
    
    toConvert - String value to get enum member.
    
    Returns:
    
    The enum member against the given string value.
  - value
```
public String value()
```
    Returns the string value associated with the enum member.
    
    Returns:
    
    The string value against enum member.
  - toString
```
public String toString()
```
    Get string representation of this enum.
    
    Overrides:
    
    toString in class Enum<UsagePattern>
  - toValue
```
public static List<String> toValue(List<UsagePattern> toConvert)
```
    Convert list of UsagePattern values to list of string values.
    
    Parameters:
    
    toConvert - The list of UsagePattern values to convert.
    
    Returns:
    
    List of representative string values.

Enum UsagePattern

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

IMMEDIATE

DEFERRED

RECURRING_PREPAID

RECURRING_POSTPAID

THRESHOLD_PREPAID

THRESHOLD_POSTPAID

SUBSCRIPTION_PREPAID

SUBSCRIPTION_POSTPAID

UNSCHEDULED_PREPAID

UNSCHEDULED_POSTPAID

INSTALLMENT_PREPAID

INSTALLMENT_POSTPAID

_UNKNOWN

Method Detail

values

valueOf

constructFromString

fromString

value

toString

toValue