Package com.stripe.service

Class CouponService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.CouponService

public final class CouponService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
CouponService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
Coupon	create()	You can create coupons easily via the coupon management page of the Stripe dashboard.
Coupon	create(RequestOptions options)	You can create coupons easily via the coupon management page of the Stripe dashboard.
Coupon	create(CouponCreateParams params)	You can create coupons easily via the coupon management page of the Stripe dashboard.
Coupon	create(CouponCreateParams params, RequestOptions options)	You can create coupons easily via the coupon management page of the Stripe dashboard.
Coupon	delete(String coupon)	You can delete coupons via the coupon management page of the Stripe dashboard.
Coupon	delete(String coupon, RequestOptions options)	You can delete coupons via the coupon management page of the Stripe dashboard.
StripeCollection<Coupon>	list()	Returns a list of your coupons.
StripeCollection<Coupon>	list(RequestOptions options)	Returns a list of your coupons.
StripeCollection<Coupon>	list(CouponListParams params)	Returns a list of your coupons.
StripeCollection<Coupon>	list(CouponListParams params, RequestOptions options)	Returns a list of your coupons.
Coupon	retrieve(String coupon)	Retrieves the coupon with the given ID.
Coupon	retrieve(String coupon, RequestOptions options)	Retrieves the coupon with the given ID.
Coupon	retrieve(String coupon, CouponRetrieveParams params)	Retrieves the coupon with the given ID.
Coupon	retrieve(String coupon, CouponRetrieveParams params, RequestOptions options)	Retrieves the coupon with the given ID.
Coupon	update(String coupon)	Updates the metadata of a coupon.
Coupon	update(String coupon, RequestOptions options)	Updates the metadata of a coupon.
Coupon	update(String coupon, CouponUpdateParams params)	Updates the metadata of a coupon.
Coupon	update(String coupon, CouponUpdateParams params, RequestOptions options)	Updates the metadata of a coupon.

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

CouponService

public CouponService(StripeResponseGetter responseGetter)

Method Details

delete

public Coupon delete(String coupon)
              throws StripeException

You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.

Throws:

StripeException

delete

public Coupon delete(String coupon,
 RequestOptions options)
              throws StripeException

You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.

Throws:

StripeException

retrieve

public Coupon retrieve(String coupon,
 CouponRetrieveParams params)
                throws StripeException

Retrieves the coupon with the given ID.

Throws:

StripeException

retrieve

public Coupon retrieve(String coupon,
 RequestOptions options)
                throws StripeException

Retrieves the coupon with the given ID.

Throws:

StripeException

retrieve

public Coupon retrieve(String coupon)
                throws StripeException

Retrieves the coupon with the given ID.

Throws:

StripeException

retrieve

public Coupon retrieve(String coupon,
 CouponRetrieveParams params,
 RequestOptions options)
                throws StripeException

Retrieves the coupon with the given ID.

Throws:

StripeException

update

public Coupon update(String coupon,
 CouponUpdateParams params)
              throws StripeException

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

Throws:

StripeException

update

public Coupon update(String coupon,
 RequestOptions options)
              throws StripeException

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

Throws:

StripeException

update

public Coupon update(String coupon)
              throws StripeException

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

Throws:

StripeException

update

public Coupon update(String coupon,
 CouponUpdateParams params,
 RequestOptions options)
              throws StripeException

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

Throws:

StripeException

list

public StripeCollection<Coupon> list(CouponListParams params)
                              throws StripeException

Returns a list of your coupons.

Throws:

StripeException

list

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

Returns a list of your coupons.

Throws:

StripeException

list

public StripeCollection<Coupon> list()
                              throws StripeException

Returns a list of your coupons.

Throws:

StripeException

list

public StripeCollection<Coupon> list(CouponListParams params,
 RequestOptions options)
                              throws StripeException

Returns a list of your coupons.

Throws:

StripeException

create

public Coupon create(CouponCreateParams params)
              throws StripeException

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.

Throws:

StripeException

create

public Coupon create(RequestOptions options)
              throws StripeException

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.

Throws:

StripeException

create

public Coupon create()
              throws StripeException

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.

Throws:

StripeException

create

public Coupon create(CouponCreateParams params,
 RequestOptions options)
              throws StripeException

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.

Throws:

StripeException