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": {
    "detail": {
      "reference": "<string>",
      "currency_code": "<string>",
      "note": "<string>",
      "terms_and_conditions": "<string>",
      "memo": "<string>",
      "attachments": [
        {
          "id": "<string>",
          "reference_url": "<string>",
          "content_type": "<string>",
          "create_time": "<string>",
          "size": "<string>"
        }
      ],
      "payment_term": {
        "term_type": "DUE_ON_RECEIPT"
      },
      "metadata": {}
    },
    "invoicer": {
      "business_name": "<string>",
      "name": {
        "prefix": "<string>",
        "given_name": "<string>",
        "surname": "<string>",
        "middle_name": "<string>",
        "suffix": "<string>",
        "alternate_full_name": "<string>",
        "full_name": "<string>"
      },
      "address": {
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "address_line_3": "<string>",
        "admin_area_4": "<string>",
        "admin_area_3": "<string>",
        "admin_area_2": "<string>",
        "admin_area_1": "<string>",
        "postal_code": "<string>",
        "country_code": "<string>",
        "address_details": {
          "street_number": "<any>",
          "street_name": "<any>",
          "street_type": "<any>",
          "delivery_service": "<any>",
          "building_name": "<any>",
          "sub_building": "<any>"
        }
      },
      "email_address": "<string>",
      "phones": [
        {
          "country_code": "<string>",
          "national_number": "<string>",
          "extension_number": "<string>",
          "phone_type": "FAX"
        }
      ],
      "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>"
          },
          "address": {
            "address_line_1": "<string>",
            "address_line_2": "<string>",
            "address_line_3": "<string>",
            "admin_area_4": "<string>",
            "admin_area_3": "<string>",
            "admin_area_2": "<string>",
            "admin_area_1": "<string>",
            "postal_code": "<string>",
            "country_code": "<string>",
            "address_details": {
              "street_number": "<any>",
              "street_name": "<any>",
              "street_type": "<any>",
              "delivery_service": "<any>",
              "building_name": "<any>",
              "sub_building": "<any>"
            }
          },
          "email_address": "<string>",
          "phones": [
            {
              "country_code": "<string>",
              "national_number": "<string>",
              "extension_number": "<string>",
              "phone_type": "FAX"
            }
          ],
          "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>"
          },
          "address": {
            "address_line_1": "<string>",
            "address_line_2": "<string>",
            "address_line_3": "<string>",
            "admin_area_4": "<string>",
            "admin_area_3": "<string>",
            "admin_area_2": "<string>",
            "admin_area_1": "<string>",
            "postal_code": "<string>",
            "country_code": "<string>",
            "address_details": {
              "street_number": "<any>",
              "street_name": "<any>",
              "street_type": "<any>",
              "delivery_service": "<any>",
              "building_name": "<any>",
              "sub_building": "<any>"
            }
          }
        }
      }
    ],
    "additional_recipients": [
      "<string>"
    ],
    "items": [
      {
        "name": "<string>",
        "description": "<string>",
        "quantity": "<string>",
        "unit_amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "tax": {
          "name": "<string>",
          "percent": "<string>",
          "tax_note": "<string>"
        },
        "item_date": "<string>",
        "discount": {
          "percent": "<string>",
          "amount": {
            "currency_code": "<string>",
            "value": "<string>"
          }
        },
        "unit_of_measure": "QUANTITY"
      }
    ],
    "configuration": {
      "tax_calculated_after_discount": true,
      "tax_inclusive": false,
      "allow_tip": false,
      "partial_payment": {
        "allow_partial_payment": false,
        "minimum_amount_due": {
          "currency_code": "<string>",
          "value": "<string>"
        }
      },
      "has_conditional_rule": false
    },
    "amount": {
      "currency_code": "<string>",
      "value": "<string>",
      "breakdown": {
        "item_total": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "discount": {
          "invoice_discount": {
            "percent": "<string>",
            "amount": {
              "currency_code": "<string>",
              "value": "<string>"
            }
          },
          "item_discount": {
            "currency_code": "<string>",
            "value": "<string>"
          }
        },
        "tax_total": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "shipping": {
          "amount": {
            "currency_code": "<string>",
            "value": "<string>"
          },
          "tax": {
            "name": "<string>",
            "percent": "<string>",
            "tax_note": "<string>"
          }
        },
        "custom": {
          "label": "<string>",
          "amount": {
            "currency_code": "<string>",
            "value": "<string>"
          }
        }
      }
    }
  },
  "settings": {
    "template_item_settings": [
      {
        "field_name": "ITEMS_QUANTITY",
        "display_preference": {
          "hidden": true
        }
      }
    ],
    "template_subtotal_settings": [
      {
        "field_name": "DISCOUNT",
        "display_preference": {
          "hidden": true
        }
      }
    ]
  },
  "unit_of_measure": "QUANTITY"
}'
{
  "id": "<string>",
  "name": "<string>",
  "default_template": true,
  "template_info": {
    "detail": {
      "reference": "<string>",
      "currency_code": "<string>",
      "note": "<string>",
      "terms_and_conditions": "<string>",
      "memo": "<string>",
      "attachments": [
        {
          "id": "<string>",
          "reference_url": "<string>",
          "content_type": "<string>",
          "create_time": "<string>",
          "size": "<string>"
        }
      ],
      "payment_term": {
        "term_type": "DUE_ON_RECEIPT"
      },
      "metadata": {
        "create_time": "<string>",
        "created_by": "<string>",
        "last_update_time": "<string>",
        "last_updated_by": "<string>"
      }
    },
    "invoicer": {
      "business_name": "<string>",
      "name": {
        "prefix": "<string>",
        "given_name": "<string>",
        "surname": "<string>",
        "middle_name": "<string>",
        "suffix": "<string>",
        "alternate_full_name": "<string>",
        "full_name": "<string>"
      },
      "address": {
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "address_line_3": "<string>",
        "admin_area_4": "<string>",
        "admin_area_3": "<string>",
        "admin_area_2": "<string>",
        "admin_area_1": "<string>",
        "postal_code": "<string>",
        "country_code": "<string>",
        "address_details": {
          "street_number": "<any>",
          "street_name": "<any>",
          "street_type": "<any>",
          "delivery_service": "<any>",
          "building_name": "<any>",
          "sub_building": "<any>"
        }
      },
      "email_address": "<string>",
      "phones": [
        {
          "country_code": "<string>",
          "national_number": "<string>",
          "extension_number": "<string>",
          "phone_type": "FAX"
        }
      ],
      "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>"
          },
          "address": {
            "address_line_1": "<string>",
            "address_line_2": "<string>",
            "address_line_3": "<string>",
            "admin_area_4": "<string>",
            "admin_area_3": "<string>",
            "admin_area_2": "<string>",
            "admin_area_1": "<string>",
            "postal_code": "<string>",
            "country_code": "<string>",
            "address_details": {
              "street_number": "<any>",
              "street_name": "<any>",
              "street_type": "<any>",
              "delivery_service": "<any>",
              "building_name": "<any>",
              "sub_building": "<any>"
            }
          },
          "email_address": "<string>",
          "phones": [
            {
              "country_code": "<string>",
              "national_number": "<string>",
              "extension_number": "<string>",
              "phone_type": "FAX"
            }
          ],
          "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>"
          },
          "address": {
            "address_line_1": "<string>",
            "address_line_2": "<string>",
            "address_line_3": "<string>",
            "admin_area_4": "<string>",
            "admin_area_3": "<string>",
            "admin_area_2": "<string>",
            "admin_area_1": "<string>",
            "postal_code": "<string>",
            "country_code": "<string>",
            "address_details": {
              "street_number": "<any>",
              "street_name": "<any>",
              "street_type": "<any>",
              "delivery_service": "<any>",
              "building_name": "<any>",
              "sub_building": "<any>"
            }
          }
        }
      }
    ],
    "additional_recipients": [
      "<string>"
    ],
    "items": [
      {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "quantity": "<string>",
        "unit_amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "tax": {
          "name": "<string>",
          "percent": "<string>",
          "amount": {
            "currency_code": "<string>",
            "value": "<string>"
          },
          "tax_note": "<string>"
        },
        "item_date": "<string>",
        "discount": {
          "percent": "<string>",
          "amount": {
            "currency_code": "<string>",
            "value": "<string>"
          }
        },
        "unit_of_measure": "QUANTITY"
      }
    ],
    "configuration": {
      "tax_calculated_after_discount": true,
      "tax_inclusive": false,
      "allow_tip": false,
      "partial_payment": {
        "allow_partial_payment": false,
        "minimum_amount_due": {
          "currency_code": "<string>",
          "value": "<string>"
        }
      },
      "has_conditional_rule": false
    },
    "amount": {
      "currency_code": "<string>",
      "value": "<string>",
      "breakdown": {
        "item_total": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "discount": {
          "invoice_discount": {
            "percent": "<string>",
            "amount": {
              "currency_code": "<string>",
              "value": "<string>"
            }
          },
          "item_discount": {
            "currency_code": "<string>",
            "value": "<string>"
          }
        },
        "tax_total": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "shipping": {
          "amount": {
            "currency_code": "<string>",
            "value": "<string>"
          },
          "tax": {
            "name": "<string>",
            "percent": "<string>",
            "amount": {
              "currency_code": "<string>",
              "value": "<string>"
            },
            "tax_note": "<string>"
          }
        },
        "custom": {
          "label": "<string>",
          "amount": {
            "currency_code": "<string>",
            "value": "<string>"
          }
        }
      }
    },
    "due_amount": {
      "currency_code": "<string>",
      "value": "<string>"
    }
  },
  "settings": {
    "template_item_settings": [
      {
        "field_name": "ITEMS_QUANTITY",
        "display_preference": {
          "hidden": true
        }
      }
    ],
    "template_subtotal_settings": [
      {
        "field_name": "DISCOUNT",
        "display_preference": {
          "hidden": true
        }
      }
    ]
  },
  "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.<blockquote><strong>Note:</strong> The template name must be unique.</blockquote>

Required string length: 1 - 500
​
default_template
boolean

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

​
template_info
object

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

​
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

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>.

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

​
id
string

The ID of the template.

Maximum length: 30
​
name
string

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

Required string length: 1 - 500
​
default_template
boolean

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

​
template_info
object

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

​
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
​
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 length: 2147483647
⌘I