Package com.stripe.model

Class InvoiceRenderingTemplate

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.InvoiceRenderingTemplate

All Implemented Interfaces:

HasId, StripeActiveObject, StripeObjectInterface

public class InvoiceRenderingTemplate
extends ApiResource
implements HasId

Invoice Rendering Templates are used to configure how invoices are rendered on surfaces like the PDF. Invoice Rendering Templates can be created from within the Dashboard, and they can be used over the API when creating invoices.

Nested Class Summary

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

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
InvoiceRenderingTemplate()

Method Summary

Modifier and Type	Method	Description
InvoiceRenderingTemplate	archive()	Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it.
InvoiceRenderingTemplate	archive(RequestOptions options)	Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it.
InvoiceRenderingTemplate	archive(InvoiceRenderingTemplateArchiveParams params)	Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it.
InvoiceRenderingTemplate	archive(InvoiceRenderingTemplateArchiveParams params, RequestOptions options)	Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it.
InvoiceRenderingTemplate	archive(Map<String,Object> params)	Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it.
InvoiceRenderingTemplate	archive(Map<String,Object> params, RequestOptions options)	Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Long	getCreated()	Time at which the object was created.
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getNickname()	A brief description of the template, hidden from customers.
String	getObject()	String representing the object's type.
String	getStatus()	The status of the template, one of active or archived.
Long	getVersion()	Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering.
int	hashCode()
static InvoiceRenderingTemplateCollection	list(InvoiceRenderingTemplateListParams params)	List all templates, ordered by creation date, with the most recently created template appearing first.
static InvoiceRenderingTemplateCollection	list(InvoiceRenderingTemplateListParams params, RequestOptions options)	List all templates, ordered by creation date, with the most recently created template appearing first.
static InvoiceRenderingTemplateCollection	list(Map<String,Object> params)	List all templates, ordered by creation date, with the most recently created template appearing first.
static InvoiceRenderingTemplateCollection	list(Map<String,Object> params, RequestOptions options)	List all templates, ordered by creation date, with the most recently created template appearing first.
static InvoiceRenderingTemplate	retrieve(String template)	Retrieves an invoice rendering template with the given ID.
static InvoiceRenderingTemplate	retrieve(String template, RequestOptions options)	Retrieves an invoice rendering template with the given ID.
static InvoiceRenderingTemplate	retrieve(String template, InvoiceRenderingTemplateRetrieveParams params, RequestOptions options)	Retrieves an invoice rendering template with the given ID.
static InvoiceRenderingTemplate	retrieve(String template, Map<String,Object> params, RequestOptions options)	Retrieves an invoice rendering template with the given ID.
void	setCreated(Long created)	Time at which the object was created.
void	setId(String id)	Unique identifier for the object.
void	setLivemode(Boolean livemode)	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
void	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setNickname(String nickname)	A brief description of the template, hidden from customers.
void	setObject(String object)	String representing the object's type.
void	setStatus(String status)	The status of the template, one of active or archived.
void	setVersion(Long version)	Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering.
InvoiceRenderingTemplate	unarchive()	Unarchive an invoice rendering template so it can be used on new Stripe objects again.
InvoiceRenderingTemplate	unarchive(RequestOptions options)	Unarchive an invoice rendering template so it can be used on new Stripe objects again.
InvoiceRenderingTemplate	unarchive(InvoiceRenderingTemplateUnarchiveParams params)	Unarchive an invoice rendering template so it can be used on new Stripe objects again.
InvoiceRenderingTemplate	unarchive(InvoiceRenderingTemplateUnarchiveParams params, RequestOptions options)	Unarchive an invoice rendering template so it can be used on new Stripe objects again.
InvoiceRenderingTemplate	unarchive(Map<String,Object> params)	Unarchive an invoice rendering template so it can be used on new Stripe objects again.
InvoiceRenderingTemplate	unarchive(Map<String,Object> params, RequestOptions options)	Unarchive an invoice rendering template so it can be used on new Stripe objects again.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, setResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.stripe.model.StripeActiveObject

trySetResponseGetter

Constructor Details

InvoiceRenderingTemplate

public InvoiceRenderingTemplate()

Method Details

archive

public InvoiceRenderingTemplate archive()
                                 throws StripeException

Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.

Throws:

StripeException

archive

public InvoiceRenderingTemplate archive(RequestOptions options)
                                 throws StripeException

Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.

Throws:

StripeException

archive

public InvoiceRenderingTemplate archive(Map<String,Object> params)
                                 throws StripeException

Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.

Throws:

StripeException

archive

public InvoiceRenderingTemplate archive(Map<String,Object> params,
 RequestOptions options)
                                 throws StripeException

Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.

Throws:

StripeException

archive

public InvoiceRenderingTemplate archive(InvoiceRenderingTemplateArchiveParams params)
                                 throws StripeException

Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.

Throws:

StripeException

archive

public InvoiceRenderingTemplate archive(InvoiceRenderingTemplateArchiveParams params,
 RequestOptions options)
                                 throws StripeException

Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.

Throws:

StripeException

list

public static InvoiceRenderingTemplateCollection list(Map<String,Object> params)
                                               throws StripeException

List all templates, ordered by creation date, with the most recently created template appearing first.

Throws:

StripeException

list

public static InvoiceRenderingTemplateCollection list(Map<String,Object> params,
 RequestOptions options)
                                               throws StripeException

List all templates, ordered by creation date, with the most recently created template appearing first.

Throws:

StripeException

list

public static InvoiceRenderingTemplateCollection list(InvoiceRenderingTemplateListParams params)
                                               throws StripeException

List all templates, ordered by creation date, with the most recently created template appearing first.

Throws:

StripeException

list

public static InvoiceRenderingTemplateCollection list(InvoiceRenderingTemplateListParams params,
 RequestOptions options)
                                               throws StripeException

List all templates, ordered by creation date, with the most recently created template appearing first.

Throws:

StripeException

retrieve

public static InvoiceRenderingTemplate retrieve(String template)
                                         throws StripeException

Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.

Throws:

StripeException

retrieve

public static InvoiceRenderingTemplate retrieve(String template,
 RequestOptions options)
                                         throws StripeException

Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.

Throws:

StripeException

retrieve

public static InvoiceRenderingTemplate retrieve(String template,
 Map<String,Object> params,
 RequestOptions options)
                                         throws StripeException

Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.

Throws:

StripeException

retrieve

public static InvoiceRenderingTemplate retrieve(String template,
 InvoiceRenderingTemplateRetrieveParams params,
 RequestOptions options)
                                         throws StripeException

Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.

Throws:

StripeException

unarchive

public InvoiceRenderingTemplate unarchive()
                                   throws StripeException

Unarchive an invoice rendering template so it can be used on new Stripe objects again.

Throws:

StripeException

unarchive

public InvoiceRenderingTemplate unarchive(RequestOptions options)
                                   throws StripeException

Unarchive an invoice rendering template so it can be used on new Stripe objects again.

Throws:

StripeException

unarchive

public InvoiceRenderingTemplate unarchive(Map<String,Object> params)
                                   throws StripeException

Unarchive an invoice rendering template so it can be used on new Stripe objects again.

Throws:

StripeException

unarchive

public InvoiceRenderingTemplate unarchive(Map<String,Object> params,
 RequestOptions options)
                                   throws StripeException

Unarchive an invoice rendering template so it can be used on new Stripe objects again.

Throws:

StripeException

unarchive

public InvoiceRenderingTemplate unarchive(InvoiceRenderingTemplateUnarchiveParams params)
                                   throws StripeException

Unarchive an invoice rendering template so it can be used on new Stripe objects again.

Throws:

StripeException

unarchive

public InvoiceRenderingTemplate unarchive(InvoiceRenderingTemplateUnarchiveParams params,
 RequestOptions options)
                                   throws StripeException

Unarchive an invoice rendering template so it can be used on new Stripe objects again.

Throws:

StripeException

getCreated

public Long getCreated()

Time at which the object was created. Measured in seconds since the Unix epoch.

getLivemode

public Boolean getLivemode()

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

getMetadata

public Map<String,String> getMetadata()

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

getNickname

public String getNickname()

A brief description of the template, hidden from customers.

getObject

public String getObject()

String representing the object's type. Objects of the same type share the same value.

Equal to invoice_rendering_template.

getStatus

public String getStatus()

The status of the template, one of active or archived.

getVersion

public Long getVersion()

Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering.

setCreated

public void setCreated(Long created)

Time at which the object was created. Measured in seconds since the Unix epoch.

setId

public void setId(String id)

Unique identifier for the object.

setLivemode

public void setLivemode(Boolean livemode)

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

setMetadata

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

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

setNickname

public void setNickname(String nickname)

A brief description of the template, hidden from customers.

setObject

public void setObject(String object)

String representing the object's type. Objects of the same type share the same value.

Equal to invoice_rendering_template.

setStatus

public void setStatus(String status)

The status of the template, one of active or archived.

setVersion

public void setVersion(Long version)

Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId