List templates

Lists merchant-created templates with associated details. The associated details include the emails, addresses, and phone numbers from the user’s PayPal profile.
The user can select which values to show in the business information section of their template.

GET /v2/invoicing/templates

List templates

cURL

curl --request GET \
  --url https://api-m.sandbox.paypal.com/v2/invoicing/templates \
  --header 'Authorization: Bearer <token>'

200

{
  "addresses": [
    {
      "country_code": "<string>",
      "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>",
      "address_details": {
        "street_number": "<string>",
        "street_name": "<string>",
        "street_type": "<string>",
        "delivery_service": "<string>",
        "building_name": "<string>",
        "sub_building": "<string>"
      }
    }
  ],
  "emails": "<string>",
  "phones": [
    {
      "country_code": "<string>",
      "national_number": "<string>",
      "extension_number": "<string>"
    }
  ],
  "templates": [
    {
      "id": "<string>",
      "name": "<string>",
      "default_template": true,
      "template_info": {
        "detail": {
          "currency_code": "<string>",
          "reference": "<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": {},
          "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": {
            "country_code": "<string>",
            "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>",
            "address_details": {
              "street_number": "<string>",
              "street_name": "<string>",
              "street_type": "<string>",
              "delivery_service": "<string>",
              "building_name": "<string>",
              "sub_building": "<string>"
            }
          },
          "email_address": "<string>",
          "phones": [
            {
              "country_code": "<string>",
              "national_number": "<string>",
              "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>"
              },
              "address": {
                "country_code": "<string>",
                "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>",
                "address_details": {
                  "street_number": "<string>",
                  "street_name": "<string>",
                  "street_type": "<string>",
                  "delivery_service": "<string>",
                  "building_name": "<string>",
                  "sub_building": "<string>"
                }
              },
              "email_address": "<string>",
              "phones": [
                {
                  "country_code": "<string>",
                  "national_number": "<string>",
                  "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>"
              },
              "address": {
                "country_code": "<string>",
                "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>",
                "address_details": {
                  "street_number": "<string>",
                  "street_name": "<string>",
                  "street_type": "<string>",
                  "delivery_service": "<string>",
                  "building_name": "<string>",
                  "sub_building": "<string>"
                }
              }
            }
          }
        ],
        "additional_recipients": [
          "<string>"
        ],
        "items": [
          {
            "name": "<string>",
            "quantity": "<string>",
            "unit_amount": {
              "currency_code": "<string>",
              "value": "<string>"
            },
            "id": "<string>",
            "description": "<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>"
              }
            }
          }
        ],
        "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": [
          {
            "display_preference": {
              "hidden": false
            }
          }
        ],
        "template_subtotal_settings": [
          {
            "display_preference": {
              "hidden": false
            }
          }
        ]
      },
      "standard_template": true,
      "links": [
        {
          "href": "<string>",
          "rel": "<string>"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "<string>",
      "rel": "<string>"
    }
  ]
}

{
  "name": "INVALID_REQUEST",
  "message": "Request is not well-formed, syntactically incorrect, or violates schema.",
  "details": [
    {
      "issue": "INVALID_INTEGER_MAX_VALUE",
      "field": "<string>",
      "value": "<string>",
      "location": "body",
      "description": "Value exceeds max value."
    }
  ],
  "debug_id": "<string>",
  "links": [
    {
      "href": "<string>",
      "rel": "<string>"
    }
  ]
}

{
  "name": "NOT_AUTHORIZED",
  "message": "Authorization failed due to insufficient permissions.",
  "details": [
    {
      "issue": "<string>",
      "field": "<string>",
      "value": "<string>",
      "location": "body",
      "description": "<string>"
    }
  ],
  "debug_id": "<string>",
  "links": [
    {
      "href": "<string>",
      "rel": "<string>"
    }
  ]
}

{
  "name": "INTERNAL_SERVER_ERROR",
  "message": "An internal server error occurred.",
  "debug_id": "90957fca61718",
  "links": [
    {
      "href": "https://developer.paypal.com/api/orders/v2/#error-INTERNAL_SERVER_ERROR",
      "rel": "information_link"
    }
  ]
}

{
  "name": "INVALID_REQUEST",
  "message": "Request is not well-formed, syntactically incorrect, or violates schema.",
  "details": [
    {
      "issue": "<string>",
      "field": "<string>",
      "value": "<string>",
      "location": "body",
      "description": "<string>"
    }
  ],
  "debug_id": "<string>",
  "links": [
    {
      "href": "<string>",
      "rel": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Oauth 2.0 authentication

Query Parameters

fields · string · default: all

The fields to return in the response. Value is all or none. To return only the template name, ID, and default attributes, specify none.

Maximum string length: 2147483647

Pattern: ^(all|none)$

page · integer · default: 1

The page number to be retrieved, for the list of templates. So, a combination of page=1 and page_size=20 returns the first 20 templates. A combination of page=2 and page_size=20 returns the next 20 templates.

Required range: 1 <= x <= 1000

page_size · integer · default: 20

The maximum number of templates to return in the response.

Required range: 1 <= x <= 100

Response

200

application/json

A successful request returns the HTTP 200 OK status code and a JSON response body that lists invoices.

An array of merchant-created templates with associated details that include the emails, addresses, and phone numbers from the user's PayPal profile.

addresses · Portable Postal Address (Medium-Grained) · object[] · read-only

An array of addresses in the user's PayPal profile.

Maximum array length: 2147483647

Show child attributes

emails · string<ppaas_common_email_address_v2> · read-only

An array of emails in the user's PayPal profile.

Required string length: 3 - 254

Pattern: ^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$

phones · Phone Detail · object[]

An array of phone numbers in the user's PayPal profile.

Maximum array length: 2147483647

Show child attributes

templates · Template · object[]

An array of details for each template. If fields is none, returns only the template name, ID, and default status.

Maximum array length: 2147483647

Show child attributes

links · Link Description · object[] · read-only

An array of request-related HATEOAS links.

Maximum array length: 2147483647

Show child attributes