Package com.stripe.service

Class PlanService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.PlanService

public final class PlanService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
PlanService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
Plan	create(PlanCreateParams params)	You can now model subscriptions more flexibly using the Prices API.
Plan	create(PlanCreateParams params, RequestOptions options)	You can now model subscriptions more flexibly using the Prices API.
Plan	delete(String plan)	Deleting plans means new subscribers can’t be added.
Plan	delete(String plan, RequestOptions options)	Deleting plans means new subscribers can’t be added.
StripeCollection<Plan>	list()	Returns a list of your plans.
StripeCollection<Plan>	list(RequestOptions options)	Returns a list of your plans.
StripeCollection<Plan>	list(PlanListParams params)	Returns a list of your plans.
StripeCollection<Plan>	list(PlanListParams params, RequestOptions options)	Returns a list of your plans.
Plan	retrieve(String plan)	Retrieves the plan with the given ID.
Plan	retrieve(String plan, RequestOptions options)	Retrieves the plan with the given ID.
Plan	retrieve(String plan, PlanRetrieveParams params)	Retrieves the plan with the given ID.
Plan	retrieve(String plan, PlanRetrieveParams params, RequestOptions options)	Retrieves the plan with the given ID.
Plan	update(String plan)	Updates the specified plan by setting the values of the parameters passed.
Plan	update(String plan, RequestOptions options)	Updates the specified plan by setting the values of the parameters passed.
Plan	update(String plan, PlanUpdateParams params)	Updates the specified plan by setting the values of the parameters passed.
Plan	update(String plan, PlanUpdateParams params, RequestOptions options)	Updates the specified plan by setting the values of the parameters passed.

Methods inherited from class com.stripe.net.ApiService

getResponseGetter, request, requestStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PlanService

public PlanService(StripeResponseGetter responseGetter)

Method Details

delete

public Plan delete(String plan)
            throws StripeException

Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.

Throws:

StripeException

delete

public Plan delete(String plan,
 RequestOptions options)
            throws StripeException

Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.

Throws:

StripeException

retrieve

public Plan retrieve(String plan,
 PlanRetrieveParams params)
              throws StripeException

Retrieves the plan with the given ID.

Throws:

StripeException

retrieve

public Plan retrieve(String plan,
 RequestOptions options)
              throws StripeException

Retrieves the plan with the given ID.

Throws:

StripeException

retrieve

public Plan retrieve(String plan)
              throws StripeException

Retrieves the plan with the given ID.

Throws:

StripeException

retrieve

public Plan retrieve(String plan,
 PlanRetrieveParams params,
 RequestOptions options)
              throws StripeException

Retrieves the plan with the given ID.

Throws:

StripeException

update

public Plan update(String plan,
 PlanUpdateParams params)
            throws StripeException

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.

Throws:

StripeException

update

public Plan update(String plan,
 RequestOptions options)
            throws StripeException

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.

Throws:

StripeException

update

public Plan update(String plan)
            throws StripeException

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.

Throws:

StripeException

update

public Plan update(String plan,
 PlanUpdateParams params,
 RequestOptions options)
            throws StripeException

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.

Throws:

StripeException

list

public StripeCollection<Plan> list(PlanListParams params)
                            throws StripeException

Returns a list of your plans.

Throws:

StripeException

list

public StripeCollection<Plan> list(RequestOptions options)
                            throws StripeException

Returns a list of your plans.

Throws:

StripeException

list

public StripeCollection<Plan> list()
                            throws StripeException

Returns a list of your plans.

Throws:

StripeException

list

public StripeCollection<Plan> list(PlanListParams params,
 RequestOptions options)
                            throws StripeException

Returns a list of your plans.

Throws:

StripeException

create

public Plan create(PlanCreateParams params)
            throws StripeException

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

Throws:

StripeException

create

public Plan create(PlanCreateParams params,
 RequestOptions options)
            throws StripeException

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

Throws:

StripeException