Skip to main content
POST
/
v2
/
invoicing
/
templates
Create template
curl --request POST \
  --url https://api-m.sandbox.paypal.com/v2/invoicing/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "default_template": true,
  "template_info": {
    "invoicer": {
      "business_name": "<string>",
      "name": {
        "prefix": "<string>",
        "given_name": "<string>",
        "surname": "<string>",
        "middle_name": "<string>",
        "suffix": "<string>",
        "alternate_full_name": "<string>",
        "full_name": "<string>"
      },
      "email_address": "<string>",
      "phones": [
        {
          "country_code": "<string>",
          "national_number": "<string>",
          "phone_type": "FAX",
          "extension_number": "<string>"
        }
      ],
      "website": "<string>",
      "tax_id": "<string>",
      "additional_notes": "<string>",
      "logo_url": "<string>"
    },
    "primary_recipients": [
      {
        "billing_info": {
          "business_name": "<string>",
          "name": {
            "prefix": "<string>",
            "given_name": "<string>",
            "surname": "<string>",
            "middle_name": "<string>",
            "suffix": "<string>",
            "alternate_full_name": "<string>",
            "full_name": "<string>"
          },
          "email_address": "<string>",
          "phones": [
            {
              "country_code": "<string>",
              "national_number": "<string>",
              "phone_type": "FAX",
              "extension_number": "<string>"
            }
          ],
          "additional_info": "<string>",
          "language": "<string>"
        },
        "shipping_info": {
          "business_name": "<string>",
          "name": {
            "prefix": "<string>",
            "given_name": "<string>",
            "surname": "<string>",
            "middle_name": "<string>",
            "suffix": "<string>",
            "alternate_full_name": "<string>",
            "full_name": "<string>"
          }
        }
      }
    ],
    "additional_recipients": [
      "<string>"
    ],
    "items": [
      {
        "name": "<string>",
        "quantity": "<string>",
        "unit_amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "description": "<string>",
        "item_date": "<string>",
        "discount": {
          "percent": "<string>"
        },
        "unit_of_measure": "QUANTITY"
      }
    ],
    "configuration": {
      "tax_calculated_after_discount": true,
      "tax_inclusive": false,
      "allow_tip": false,
      "partial_payment": {
        "allow_partial_payment": false
      },
      "has_conditional_rule": false
    },
    "amount": {
      "currency_code": "<string>",
      "value": "<string>",
      "breakdown": {
        "discount": {
          "invoice_discount": {
            "percent": "<string>"
          }
        },
        "shipping": {}
      }
    }
  },
  "settings": {
    "template_item_settings": [
      {
        "field_name": "ITEMS_QUANTITY",
        "display_preference": {
          "hidden": false
        }
      }
    ],
    "template_subtotal_settings": [
      {
        "field_name": "DISCOUNT",
        "display_preference": {
          "hidden": false
        }
      }
    ]
  },
  "unit_of_measure": "QUANTITY"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "default_template": true,
  "template_info": {
    "invoicer": {
      "business_name": "<string>",
      "name": {
        "prefix": "<string>",
        "given_name": "<string>",
        "surname": "<string>",
        "middle_name": "<string>",
        "suffix": "<string>",
        "alternate_full_name": "<string>",
        "full_name": "<string>"
      },
      "email_address": "<string>",
      "phones": [
        {
          "country_code": "<string>",
          "national_number": "<string>",
          "phone_type": "FAX",
          "extension_number": "<string>"
        }
      ],
      "website": "<string>",
      "tax_id": "<string>",
      "additional_notes": "<string>",
      "logo_url": "<string>"
    },
    "primary_recipients": [
      {
        "billing_info": {
          "business_name": "<string>",
          "name": {
            "prefix": "<string>",
            "given_name": "<string>",
            "surname": "<string>",
            "middle_name": "<string>",
            "suffix": "<string>",
            "alternate_full_name": "<string>",
            "full_name": "<string>"
          },
          "email_address": "<string>",
          "phones": [
            {
              "country_code": "<string>",
              "national_number": "<string>",
              "phone_type": "FAX",
              "extension_number": "<string>"
            }
          ],
          "additional_info": "<string>",
          "language": "<string>"
        },
        "shipping_info": {
          "business_name": "<string>",
          "name": {
            "prefix": "<string>",
            "given_name": "<string>",
            "surname": "<string>",
            "middle_name": "<string>",
            "suffix": "<string>",
            "alternate_full_name": "<string>",
            "full_name": "<string>"
          }
        }
      }
    ],
    "additional_recipients": [
      "<string>"
    ],
    "items": [
      {
        "name": "<string>",
        "quantity": "<string>",
        "unit_amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "id": "<string>",
        "description": "<string>",
        "item_date": "<string>",
        "discount": {
          "percent": "<string>"
        },
        "unit_of_measure": "QUANTITY"
      }
    ],
    "configuration": {
      "tax_calculated_after_discount": true,
      "tax_inclusive": false,
      "allow_tip": false,
      "partial_payment": {
        "allow_partial_payment": false
      },
      "has_conditional_rule": false
    },
    "amount": {
      "currency_code": "<string>",
      "value": "<string>",
      "breakdown": {
        "discount": {
          "invoice_discount": {
            "percent": "<string>"
          }
        },
        "shipping": {}
      }
    }
  },
  "settings": {
    "template_item_settings": [
      {
        "field_name": "ITEMS_QUANTITY",
        "display_preference": {
          "hidden": false
        }
      }
    ],
    "template_subtotal_settings": [
      {
        "field_name": "DISCOUNT",
        "display_preference": {
          "hidden": false
        }
      }
    ]
  },
  "unit_of_measure": "QUANTITY",
  "standard_template": true,
  "links": [
    {
      "href": "<string>",
      "rel": "<string>",
      "method": "GET"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Oauth 2.0 authentication

Body

application/json

The template with invoice details to load with all captured fields.

​
name
string

The template name.

Note: The template name must be unique.

Required string length: 1 - 500
Pattern: ^[\S\s]*$
​
default_template
boolean

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

​
template_info
Template Information · object

The template details. Includes invoicer business information, invoice recipients, items, and configuration.

​
settings
Template Settings · object

The template settings. Describes which fields to show or hide when you create an invoice.

​
unit_of_measure
enum<string>

The unit of measure for the template. Value is quantity, hours, or amount.

Available options:
QUANTITY,
HOURS,
AMOUNT
Maximum string length: 2147483647
Pattern: ^[\S\s]*$

Response

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

The template with invoice details to load with all captured fields.

​
id
string

The ID of the template.

Maximum string length: 30
Pattern: ^[\S\s]*$
​
name
string

The template name.

Note: The template name must be unique.

Required string length: 1 - 500
Pattern: ^[\S\s]*$
​
default_template
boolean

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

​
template_info
Template Information · object

The template details. Includes invoicer business information, invoice recipients, items, and configuration.

​
settings
Template Settings · object

The template settings. Describes which fields to show or hide when you create an invoice.

​
unit_of_measure
enum<string>

The unit of measure for the template. Value is quantity, hours, or amount.

Available options:
QUANTITY,
HOURS,
AMOUNT
Maximum string length: 2147483647
Pattern: ^[\S\s]*$
​
standard_template
boolean

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

​
links
Link Description · object[]

An array of request-related HATEOAS links.

Maximum array length: 2147483647