Package com.stripe.service

Class PromotionCodeService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.PromotionCodeService

public final class PromotionCodeService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
PromotionCodeService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
PromotionCode	create(PromotionCodeCreateParams params)	A promotion code points to a coupon.
PromotionCode	create(PromotionCodeCreateParams params, RequestOptions options)	A promotion code points to a coupon.
StripeCollection<PromotionCode>	list()	Returns a list of your promotion codes.
StripeCollection<PromotionCode>	list(RequestOptions options)	Returns a list of your promotion codes.
StripeCollection<PromotionCode>	list(PromotionCodeListParams params)	Returns a list of your promotion codes.
StripeCollection<PromotionCode>	list(PromotionCodeListParams params, RequestOptions options)	Returns a list of your promotion codes.
PromotionCode	retrieve(String promotionCode)	Retrieves the promotion code with the given ID.
PromotionCode	retrieve(String promotionCode, RequestOptions options)	Retrieves the promotion code with the given ID.
PromotionCode	retrieve(String promotionCode, PromotionCodeRetrieveParams params)	Retrieves the promotion code with the given ID.
PromotionCode	retrieve(String promotionCode, PromotionCodeRetrieveParams params, RequestOptions options)	Retrieves the promotion code with the given ID.
PromotionCode	update(String promotionCode)	Updates the specified promotion code by setting the values of the parameters passed.
PromotionCode	update(String promotionCode, RequestOptions options)	Updates the specified promotion code by setting the values of the parameters passed.
PromotionCode	update(String promotionCode, PromotionCodeUpdateParams params)	Updates the specified promotion code by setting the values of the parameters passed.
PromotionCode	update(String promotionCode, PromotionCodeUpdateParams params, RequestOptions options)	Updates the specified promotion code 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

PromotionCodeService

public PromotionCodeService(StripeResponseGetter responseGetter)

Method Details

list

public StripeCollection<PromotionCode> list(PromotionCodeListParams params)
                                     throws StripeException

Returns a list of your promotion codes.

Throws:

StripeException

list

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

Returns a list of your promotion codes.

Throws:

StripeException

list

public StripeCollection<PromotionCode> list()
                                     throws StripeException

Returns a list of your promotion codes.

Throws:

StripeException

list

public StripeCollection<PromotionCode> list(PromotionCodeListParams params,
 RequestOptions options)
                                     throws StripeException

Returns a list of your promotion codes.

Throws:

StripeException

create

public PromotionCode create(PromotionCodeCreateParams params)
                     throws StripeException

A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

Throws:

StripeException

create

public PromotionCode create(PromotionCodeCreateParams params,
 RequestOptions options)
                     throws StripeException

A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

Throws:

StripeException

retrieve

public PromotionCode retrieve(String promotionCode,
 PromotionCodeRetrieveParams params)
                       throws StripeException

Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use list with the desired code.

Throws:

StripeException

retrieve

public PromotionCode retrieve(String promotionCode,
 RequestOptions options)
                       throws StripeException

Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use list with the desired code.

Throws:

StripeException

retrieve

public PromotionCode retrieve(String promotionCode)
                       throws StripeException

Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use list with the desired code.

Throws:

StripeException

retrieve

public PromotionCode retrieve(String promotionCode,
 PromotionCodeRetrieveParams params,
 RequestOptions options)
                       throws StripeException

Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use list with the desired code.

Throws:

StripeException

update

public PromotionCode update(String promotionCode,
 PromotionCodeUpdateParams params)
                     throws StripeException

Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

Throws:

StripeException

update

public PromotionCode update(String promotionCode,
 RequestOptions options)
                     throws StripeException

Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

Throws:

StripeException

update

public PromotionCode update(String promotionCode)
                     throws StripeException

Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

Throws:

StripeException

update

public PromotionCode update(String promotionCode,
 PromotionCodeUpdateParams params,
 RequestOptions options)
                     throws StripeException

Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

Throws:

StripeException