Business Platforms and marketplacesPlatforms Enterprise

Business Platforms and marketplaces Enterprise

Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

invoice_reminder_configurations

List of invoice reminder configurations.

configurationsobject<invoice_reminder_configuration>[]Optional

An array of invoice auto reminder configurations.

Items1 <= length <= 2

invoice_reminder_configuration properties

8 properties

idstringOptional

Represents the auto reminder configuration id.

Match^RC-[A-Z0-9]+$Length20 <= length <= 20

typeenum<reminder_type>Required

The type of the auto reminder configuration.

Allowed values

"BEFORE_DUE"
"AFTER_DUE"

statusenum<reminder_status>Optional

The status of the auto reminder configuration.

Allowed values

"ACTIVE"
"INACTIVE"

intervalobject<reminder_interval>Required

Defines the time interval used to determine when a reminder is sent relative to the invoice due date. The interval consists of a unit (for example, DAY) and a numeric value that specifies how many units before or after the due date the reminder is triggered.

reminder_interval properties

2 properties

unitenum<reminder_interval_unit>Required

Defines the recurrence unit of time for sending automatic reminders.

Allowed values

"DAY"

valueintegerRequired

The number of time units before or after the invoice due date when the reminder is sent. Minimum value is 1 and maximum value is 7.

Range1 <= value <= 7

repetitionintegerRequired

The repetition at which the auto reminder has to be set. Note: For `BEFORE_DUE` reminder type, repetition is always one.

Range1 <= value <= 7

notificationobject<reminder_notification>Optional

The email notification to send to the invoicer or payer on auto reminder configuration.

reminder_notification properties

1 property

send_to_invoicerbooleanOptional

Indicates whether to send a copy of the email to the merchant.

Defaultfalse

metadataobject<reminder_metadata>Optional

Invoice auto reminder configuration metadata.

reminder_metadata properties

2 properties

created_timestring<date_time>Optional

The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Length20 <= length <= 64

updated_timestring<date_time>Optional

The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Length20 <= length <= 64

linksobject<link_description>[]Optional

An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).

Items1 <= length <= 4

link_description properties

3 properties

hrefstringRequired

The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.

Match^.*$Length0 <= length <= 20000

relstringRequired

The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).

Match^.*$Length0 <= length <= 100

methodenumOptional

The HTTP method required to make the related call.

Allowed values

"CONNECT"
"DELETE"
"GET"
"HEAD"
"OPTIONS"
"PATCH"
"POST"
"PUT"

linksobject<link_description>[]Optional

An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).

Items1 <= length <= 4

link_description properties

3 properties

hrefstringRequired

Match^.*$Length0 <= length <= 20000

relstringRequired

Match^.*$Length0 <= length <= 100

methodenumOptional

The HTTP method required to make the related call.

Allowed values

"CONNECT"
"DELETE"
"GET"
"HEAD"
"OPTIONS"
"PATCH"
"POST"
"PUT"

Back to top

invoice_reminder_configurations

List of invoice reminder configurations.

configurationsobject<invoice_reminder_configuration>[]Optional

An array of invoice auto reminder configurations.

Items1 <= length <= 2

invoice_reminder_configuration properties

8 properties

idstringOptional

Represents the auto reminder configuration id.

Match^RC-[A-Z0-9]+$Length20 <= length <= 20

typeenum<reminder_type>Required

The type of the auto reminder configuration.

Allowed values

"BEFORE_DUE"
"AFTER_DUE"

statusenum<reminder_status>Optional

The status of the auto reminder configuration.

Allowed values

"ACTIVE"
"INACTIVE"

intervalobject<reminder_interval>Required

reminder_interval properties

2 properties

unitenum<reminder_interval_unit>Required

Defines the recurrence unit of time for sending automatic reminders.

Allowed values

"DAY"

valueintegerRequired

The number of time units before or after the invoice due date when the reminder is sent. Minimum value is 1 and maximum value is 7.

Range1 <= value <= 7

repetitionintegerRequired

The repetition at which the auto reminder has to be set. Note: For `BEFORE_DUE` reminder type, repetition is always one.

Range1 <= value <= 7

notificationobject<reminder_notification>Optional

The email notification to send to the invoicer or payer on auto reminder configuration.

reminder_notification properties

1 property

send_to_invoicerbooleanOptional

Indicates whether to send a copy of the email to the merchant.

Defaultfalse

metadataobject<reminder_metadata>Optional

Invoice auto reminder configuration metadata.

reminder_metadata properties

2 properties

created_timestring<date_time>Optional

The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Length20 <= length <= 64

updated_timestring<date_time>Optional

The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Length20 <= length <= 64

linksobject<link_description>[]Optional

An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).

Items1 <= length <= 4

link_description properties

3 properties

hrefstringRequired

Match^.*$Length0 <= length <= 20000

relstringRequired

Match^.*$Length0 <= length <= 100

methodenumOptional

The HTTP method required to make the related call.

Allowed values

"CONNECT"
"DELETE"
"GET"
"HEAD"
"OPTIONS"
"PATCH"
"POST"
"PUT"

linksobject<link_description>[]Optional

An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).

Items1 <= length <= 4

link_description properties

3 properties

hrefstringRequired

Match^.*$Length0 <= length <= 20000

relstringRequired

Match^.*$Length0 <= length <= 100

methodenumOptional

The HTTP method required to make the related call.

Allowed values

"CONNECT"
"DELETE"
"GET"
"HEAD"
"OPTIONS"
"PATCH"
"POST"
"PUT"

invoice_reminder_configurations

invoice_reminder_configuration properties

reminder_interval properties

reminder_notification properties

reminder_metadata properties

link_description properties

link_description properties

Back to top

On this page

On this page

invoice_reminder_configurations

invoice_reminder_configuration properties

reminder_interval properties

reminder_notification properties

reminder_metadata properties

link_description properties

link_description properties

Back to top

On this page

invoice_reminder_configurations

invoice_reminder_configuration properties

reminder_interval properties

reminder_notification properties

reminder_metadata properties

link_description properties

link_description properties

Back to top

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

invoice_reminder_configurations

invoice_reminder_configuration properties

reminder_interval properties

reminder_notification properties

reminder_metadata properties

link_description properties

link_description properties

Back to top

On this page