templates

Create template

Creates an invoice template. You can use details from this template to create an invoice. You can create up to 50 templates.<blockquote><strong>Note:</strong> Every merchant starts with three PayPal system templates that are optimized for the unit type billed. The template includes Quantity, Hours, and Amount.</blockquote>

post/v2/invoicing/templates

Request

  • Base URL
    https://api-m.paypal.com
  • Auth
    OAuth 2
    Client credentials
    Token URL/v1/oauth2/token
    Scopeshttps://uri.paypal.com/services/invoicing/invoices/readwrite

Request body

idstring

The ID of the template.

namestring

The template name.<blockquote><strong>Note:</strong> The template name must be unique.</blockquote>

default_templateboolean

Indicates whether this template is the default template. A invoicer can have one default template.

unit_of_measure'QUANTITY' | 'HOURS' | 'AMOUNT'

The unit of measure for the invoiced item.

standard_templateboolean

Indicates whether this template is a invoicer-created custom template. The system generates non-custom templates.

Response

A successful request returns the HTTP 201 Created status code. A JSON response body that shows template details is returned if you set <code>prefer=return=representation</code>.

idstring

The ID of the template.

namestring

The template name.<blockquote><strong>Note:</strong> The template name must be unique.</blockquote>

default_templateboolean

Indicates whether this template is the default template. A invoicer can have one default template.

unit_of_measure'QUANTITY' | 'HOURS' | 'AMOUNT'

The unit of measure for the invoiced item.

standard_templateboolean

Indicates whether this template is a invoicer-created custom template. The system generates non-custom templates.

Changes

No recorded changes to this operation across all 1 revision of this API.