Plan (stripe-java 2.9.0 API)

java.lang.Object
- com.stripe.model.StripeObject
- - com.stripe.net.APIResource
  - - com.stripe.model.Plan

All Implemented Interfaces:: HasId, MetadataStore<Plan>

public class Plan
extends APIResource
implements MetadataStore<Plan>, HasId

Nested Class Summary
- Nested classes/interfaces inherited from class com.stripe.net.APIResource
  APIResource.RequestMethod, APIResource.RequestType

Field Summary
- Fields inherited from class com.stripe.net.APIResource
  CHARSET, GSON
- Fields inherited from class com.stripe.model.StripeObject
  PRETTY_PRINT_GSON

Constructor Summary

Constructors
Constructor and Description

Plan()

Constructors
Constructor and Description
`Plan()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static PlanCollection`	`all(Map<String,Object> params)` Deprecated.
`static PlanCollection`	`all(Map<String,Object> params, RequestOptions options)` Deprecated.
`static PlanCollection`	`all(Map<String,Object> params, String apiKey)` Deprecated.
`static Plan`	`create(Map<String,Object> params)`
`static Plan`	`create(Map<String,Object> params, RequestOptions options)`
`static Plan`	`create(Map<String,Object> params, String apiKey)` Deprecated.
`DeletedPlan`	`delete()`
`DeletedPlan`	`delete(RequestOptions options)`
`DeletedPlan`	`delete(String apiKey)` Deprecated.
`Integer`	`getAmount()`
`Long`	`getCreated()`
`String`	`getCurrency()`
`String`	`getId()`
`String`	`getInterval()`
`Integer`	`getIntervalCount()`
`Boolean`	`getLivemode()`
`Map<String,String>`	`getMetadata()`
`String`	`getName()`
`String`	`getStatementDescription()` Deprecated. Use `statement_descriptor` field (https://stripe.com/docs/upgrades#2014-12-17)
`String`	`getStatementDescriptor()`
`Integer`	`getTrialPeriodDays()`
`static PlanCollection`	`list(Map<String,Object> params)`
`static PlanCollection`	`list(Map<String,Object> params, RequestOptions options)`
`static Plan`	`retrieve(String id)`
`static Plan`	`retrieve(String id, RequestOptions options)`
`static Plan`	`retrieve(String id, String apiKey)` Deprecated.
`void`	`setAmount(Integer amount)`
`void`	`setCreated(Long created)`
`void`	`setCurrency(String currency)`
`void`	`setId(String id)`
`void`	`setInterval(String interval)`
`void`	`setIntervalCount(Integer intervalCount)`
`void`	`setLivemode(Boolean livemode)`
`void`	`setMetadata(Map<String,String> metadata)`
`void`	`setName(String name)`
`void`	`setStatementDescription(String statementDescription)` Deprecated. Use `statement_descriptor` field (https://stripe.com/docs/upgrades#2014-12-17)
`void`	`setStatementDescriptor(String statementDescriptor)`
`void`	`setTrialPeriodDays(Integer trialPeriodDays)`
`Plan`	`update(Map<String,Object> params)`
`Plan`	`update(Map<String,Object> params, RequestOptions options)`
`Plan`	`update(Map<String,Object> params, String apiKey)` Deprecated.

Methods inherited from class com.stripe.net.APIResource
classURL, classURL, instanceURL, instanceURL, multipartRequest, request, requestCollection, setStripeResponseGetter, singleClassURL, singleClassURL, urlEncode

Methods inherited from class com.stripe.model.StripeObject
equals, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail
- Plan
```
public Plan()
```

Method Detail

getId
```
public String getId()
```
Specified by:

getId in interface HasId

setId
```
public void setId(String id)
```

getAmount
```
public Integer getAmount()
```

setAmount

public void setAmount(Integer amount)

getCreated
```
public Long getCreated()
```

setCreated
```
public void setCreated(Long created)
```

getCurrency
```
public String getCurrency()
```

setCurrency

public void setCurrency(String currency)

getInterval
```
public String getInterval()
```

setInterval

public void setInterval(String interval)

getIntervalCount
```
public Integer getIntervalCount()
```

setIntervalCount

public void setIntervalCount(Integer intervalCount)

getLivemode
```
public Boolean getLivemode()
```

setLivemode

public void setLivemode(Boolean livemode)

getMetadata
```
public Map<String,String> getMetadata()
```
Specified by:

getMetadata in interface MetadataStore<Plan>

setMetadata

public void setMetadata(Map<String,String> metadata)

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getStatementDescriptor

public String getStatementDescriptor()

setStatementDescriptor

public void setStatementDescriptor(String statementDescriptor)

getTrialPeriodDays
```
public Integer getTrialPeriodDays()
```

setTrialPeriodDays

public void setTrialPeriodDays(Integer trialPeriodDays)

getStatementDescription
```
@Deprecated
public String getStatementDescription()
```
Deprecated. Use `statement_descriptor` field (https://stripe.com/docs/upgrades#2014-12-17)

setStatementDescription
```
@Deprecated
public void setStatementDescription(String statementDescription)
```
Deprecated. Use `statement_descriptor` field (https://stripe.com/docs/upgrades#2014-12-17)

create

public static Plan create(Map<String,Object> params)
                   throws AuthenticationException,
                          InvalidRequestException,
                          APIConnectionException,
                          CardException,
                          APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

retrieve

public static Plan retrieve(String id)
                     throws AuthenticationException,
                            InvalidRequestException,
                            APIConnectionException,
                            CardException,
                            APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

update

public Plan update(Map<String,Object> params)
            throws AuthenticationException,
                   InvalidRequestException,
                   APIConnectionException,
                   CardException,
                   APIException

Specified by:: update in interface MetadataStore<Plan>
Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

delete

public DeletedPlan delete()
                   throws AuthenticationException,
                          InvalidRequestException,
                          APIConnectionException,
                          CardException,
                          APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

create

@Deprecated
public static Plan create(Map<String,Object> params,
                                      String apiKey)
                               throws AuthenticationException,
                                      InvalidRequestException,
                                      APIConnectionException,
                                      CardException,
                                      APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

create

public static Plan create(Map<String,Object> params,
                          RequestOptions options)
                   throws AuthenticationException,
                          InvalidRequestException,
                          APIConnectionException,
                          CardException,
                          APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

retrieve

@Deprecated
public static Plan retrieve(String id,
                                        String apiKey)
                                 throws AuthenticationException,
                                        InvalidRequestException,
                                        APIConnectionException,
                                        CardException,
                                        APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

retrieve

public static Plan retrieve(String id,
                            RequestOptions options)
                     throws AuthenticationException,
                            InvalidRequestException,
                            APIConnectionException,
                            CardException,
                            APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

update

@Deprecated
public Plan update(Map<String,Object> params,
                               String apiKey)
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               CardException,
                               APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

update

public Plan update(Map<String,Object> params,
                   RequestOptions options)
            throws AuthenticationException,
                   InvalidRequestException,
                   APIConnectionException,
                   CardException,
                   APIException

Specified by:: update in interface MetadataStore<Plan>
Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

list

public static PlanCollection list(Map<String,Object> params)
                           throws AuthenticationException,
                                  InvalidRequestException,
                                  APIConnectionException,
                                  CardException,
                                  APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

list

public static PlanCollection list(Map<String,Object> params,
                                  RequestOptions options)
                           throws AuthenticationException,
                                  InvalidRequestException,
                                  APIConnectionException,
                                  CardException,
                                  APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

all

@Deprecated
public static PlanCollection all(Map<String,Object> params)
                                      throws AuthenticationException,
                                             InvalidRequestException,
                                             APIConnectionException,
                                             CardException,
                                             APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

all

@Deprecated
public static PlanCollection all(Map<String,Object> params,
                                             String apiKey)
                                      throws AuthenticationException,
                                             InvalidRequestException,
                                             APIConnectionException,
                                             CardException,
                                             APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

all

@Deprecated
public static PlanCollection all(Map<String,Object> params,
                                             RequestOptions options)
                                      throws AuthenticationException,
                                             InvalidRequestException,
                                             APIConnectionException,
                                             CardException,
                                             APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

delete

@Deprecated
public DeletedPlan delete(String apiKey)
                               throws AuthenticationException,
                                      InvalidRequestException,
                                      APIConnectionException,
                                      CardException,
                                      APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

delete

public DeletedPlan delete(RequestOptions options)
                   throws AuthenticationException,
                          InvalidRequestException,
                          APIConnectionException,
                          CardException,
                          APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

Class Plan

Nested Class Summary

Nested classes/interfaces inherited from class com.stripe.net.APIResource

Field Summary

Fields inherited from class com.stripe.net.APIResource

Fields inherited from class com.stripe.model.StripeObject

Constructor Summary

Method Summary

Methods inherited from class com.stripe.net.APIResource

Methods inherited from class com.stripe.model.StripeObject

Methods inherited from class java.lang.Object

Constructor Detail

Plan

Method Detail

getId

setId

getAmount

setAmount

getCreated

setCreated

getCurrency

setCurrency

getInterval

setInterval

getIntervalCount

setIntervalCount

getLivemode

setLivemode

getMetadata

setMetadata

getName

setName

getStatementDescriptor

setStatementDescriptor

getTrialPeriodDays

setTrialPeriodDays

getStatementDescription

setStatementDescription

create

retrieve

update

delete

create

create

retrieve

retrieve

update

update

list

list

all

all

all

delete

delete