Package com.stripe.service

Class MarginService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.MarginService

public final class MarginService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
MarginService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
Margin	create(MarginCreateParams params)	Create a margin object to be used with invoices, invoice items, and invoice line items for a customer to represent a partner discount.A margin has a percent_off which is the percent that will be taken off the subtotal after all items and other discounts and promotions) of any invoices for a customer.
Margin	create(MarginCreateParams params, RequestOptions options)	Create a margin object to be used with invoices, invoice items, and invoice line items for a customer to represent a partner discount.A margin has a percent_off which is the percent that will be taken off the subtotal after all items and other discounts and promotions) of any invoices for a customer.
StripeCollection<Margin>	list()	Retrieve a list of your margins.
StripeCollection<Margin>	list(RequestOptions options)	Retrieve a list of your margins.
StripeCollection<Margin>	list(MarginListParams params)	Retrieve a list of your margins.
StripeCollection<Margin>	list(MarginListParams params, RequestOptions options)	Retrieve a list of your margins.
Margin	retrieve(String margin)	Retrieve a margin object with the given ID.
Margin	retrieve(String margin, RequestOptions options)	Retrieve a margin object with the given ID.
Margin	retrieve(String margin, MarginRetrieveParams params)	Retrieve a margin object with the given ID.
Margin	retrieve(String margin, MarginRetrieveParams params, RequestOptions options)	Retrieve a margin object with the given ID.
Margin	update(String margin)	Update the specified margin object.
Margin	update(String margin, RequestOptions options)	Update the specified margin object.
Margin	update(String margin, MarginUpdateParams params)	Update the specified margin object.
Margin	update(String margin, MarginUpdateParams params, RequestOptions options)	Update the specified margin object.

Methods inherited from class com.stripe.net.ApiService

getResponseGetter

Methods inherited from class java.lang.Object

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

Constructor Details

MarginService

public MarginService(StripeResponseGetter responseGetter)

Method Details

list

public StripeCollection<Margin> list(MarginListParams params)
                              throws StripeException

Retrieve a list of your margins.

Throws:

StripeException

list

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

Retrieve a list of your margins.

Throws:

StripeException

list

public StripeCollection<Margin> list()
                              throws StripeException

Retrieve a list of your margins.

Throws:

StripeException

list

public StripeCollection<Margin> list(MarginListParams params,
 RequestOptions options)
                              throws StripeException

Retrieve a list of your margins.

Throws:

StripeException

create

public Margin create(MarginCreateParams params)
              throws StripeException

Create a margin object to be used with invoices, invoice items, and invoice line items for a customer to represent a partner discount.A margin has a percent_off which is the percent that will be taken off the subtotal after all items and other discounts and promotions) of any invoices for a customer. Calculation of prorations do not include any partner margins applied on the original invoice item.

Throws:

StripeException

create

public Margin create(MarginCreateParams params,
 RequestOptions options)
              throws StripeException

Create a margin object to be used with invoices, invoice items, and invoice line items for a customer to represent a partner discount.A margin has a percent_off which is the percent that will be taken off the subtotal after all items and other discounts and promotions) of any invoices for a customer. Calculation of prorations do not include any partner margins applied on the original invoice item.

Throws:

StripeException

retrieve

public Margin retrieve(String margin,
 MarginRetrieveParams params)
                throws StripeException

Retrieve a margin object with the given ID.

Throws:

StripeException

retrieve

public Margin retrieve(String margin,
 RequestOptions options)
                throws StripeException

Retrieve a margin object with the given ID.

Throws:

StripeException

retrieve

public Margin retrieve(String margin)
                throws StripeException

Retrieve a margin object with the given ID.

Throws:

StripeException

retrieve

public Margin retrieve(String margin,
 MarginRetrieveParams params,
 RequestOptions options)
                throws StripeException

Retrieve a margin object with the given ID.

Throws:

StripeException

update

public Margin update(String margin,
 MarginUpdateParams params)
              throws StripeException

Update the specified margin object. Certain fields of the margin object are not editable.

Throws:

StripeException

update

public Margin update(String margin,
 RequestOptions options)
              throws StripeException

Update the specified margin object. Certain fields of the margin object are not editable.

Throws:

StripeException

update

public Margin update(String margin)
              throws StripeException

Update the specified margin object. Certain fields of the margin object are not editable.

Throws:

StripeException

update

public Margin update(String margin,
 MarginUpdateParams params,
 RequestOptions options)
              throws StripeException

Update the specified margin object. Certain fields of the margin object are not editable.

Throws:

StripeException