curl --request GET \
--url https://api-m.sandbox.paypal.com/v2/invoicing/templates \
--header 'Authorization: Bearer <token>'{
"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>",
"phone_type": "FAX",
"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": {
"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": {
"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>",
"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>"
},
"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>",
"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>"
},
"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>"
}
},
"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": 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"
}
]
}
],
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
]
}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.
curl --request GET \
--url https://api-m.sandbox.paypal.com/v2/invoicing/templates \
--header 'Authorization: Bearer <token>'{
"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>",
"phone_type": "FAX",
"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": {
"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": {
"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>",
"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>"
},
"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>",
"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>"
},
"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>"
}
},
"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": 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"
}
]
}
],
"links": [
{
"href": "<string>",
"rel": "<string>",
"method": "GET"
}
]
}Oauth 2.0 authentication
The fields to return in the response. Value is all or none. To return only the template name, ID, and default attributes, specify none.
2147483647The 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.
1 <= x <= 1000The maximum number of templates to return in the response.
1 <= x <= 100A 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.
An array of addresses in the user's PayPal profile.
2147483647Show child attributes
An array of emails in the user's PayPal profile.
3 - 254An array of phone numbers in the user's PayPal profile.
2147483647Show child attributes
An array of details for each template. If fields is none, returns only the template name, ID, and default status.
2147483647Show child attributes
Was this page helpful?